5c5845f59ed539c90aa74337c6f95e16431b55ce
[dragonfly.git] / sbin / hammer / hammer_util.h
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  * $DragonFly: src/sbin/hammer/hammer_util.h,v 1.19 2008/07/10 04:44:58 dillon Exp $
35  */
36
37 #include <sys/types.h>
38 #include <sys/tree.h>
39 #include <sys/queue.h>
40
41 #include <vfs/hammer/hammer_disk.h>
42 #include <uuid.h>
43
44 /*
45  * Cache management - so the user code can keep its memory use under control
46  */
47 struct volume_info;
48 struct buffer_info;
49
50 TAILQ_HEAD(volume_list, volume_info);
51
52 struct cache_info {
53         TAILQ_ENTRY(cache_info) entry;
54         union {
55                 struct volume_info *volume;
56                 struct buffer_info *buffer;
57         } u;
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 */
62 };
63
64 #define HAMMER_BUFLISTS         64
65 #define HAMMER_BUFLISTMASK      (HAMMER_BUFLISTS - 1)
66
67 /*
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.
71  */
72 struct volume_info {
73         struct cache_info       cache;
74         TAILQ_ENTRY(volume_info) entry;
75         int                     vol_no;
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 */
79
80         char                    *name;
81         int                     fd;
82         off_t                   size;
83         const char              *type;
84
85         struct hammer_volume_ondisk *ondisk;
86
87         TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
88 };
89
90 struct buffer_info {
91         struct cache_info       cache;
92         TAILQ_ENTRY(buffer_info) entry;
93         hammer_off_t            buf_offset;     /* full hammer offset spec */
94         int64_t                 raw_offset;     /* physical offset */
95         int                     flags;          /* origination flags */
96         int                     use_count;      /* read count */
97         struct volume_info      *volume;
98         void                    *ondisk;
99 };
100
101 #define HAMMER_BUFINFO_READAHEAD        0x0001
102
103 extern uuid_t Hammer_FSType;
104 extern uuid_t Hammer_FSId;
105 extern int64_t BootAreaSize;
106 extern int64_t MemAreaSize;
107 extern int64_t UndoBufferSize;
108 extern int DebugOpt;
109 extern int NumVolumes;
110 extern int RootVolNo;
111 extern struct volume_list VolList;
112 extern int UseReadBehind;
113 extern int UseReadAhead;
114 extern int AssertOnFailure;
115
116 uint32_t crc32(const void *buf, size_t size);
117 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
118
119 struct volume_info *setup_volume(int32_t vol_no, const char *filename,
120                                 int isnew, int oflags);
121 struct volume_info *get_volume(int32_t vol_no);
122 struct volume_info *test_volume(int32_t vol_no);
123 struct buffer_info *get_buffer(hammer_off_t buf_offset, int isnew);
124 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
125                                 int isnew);
126 hammer_node_ondisk_t get_node(hammer_off_t node_offset,
127                                 struct buffer_info **bufp);
128
129 void rel_volume(struct volume_info *volume);
130 void rel_buffer(struct buffer_info *buffer);
131
132 hammer_off_t blockmap_lookup(hammer_off_t bmap_off,
133                                 struct hammer_blockmap_layer1 *layer1,
134                                 struct hammer_blockmap_layer2 *layer2,
135                                 int *errorp);
136 void format_blockmap(hammer_blockmap_t blockmap, hammer_off_t zone_base);
137 void format_undomap(hammer_volume_ondisk_t ondisk);
138
139 void *alloc_btree_element(hammer_off_t *offp);
140 void *alloc_data_element(hammer_off_t *offp, int32_t data_len,
141                          struct buffer_info **data_bufferp);
142
143 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
144 void hammer_key_beg_init(hammer_base_elm_t base);
145 void hammer_key_end_init(hammer_base_elm_t base);
146 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
147
148 void format_freemap(struct volume_info *root_vol, hammer_blockmap_t blockmap);
149 int64_t initialize_freemap(struct volume_info *vol);
150
151 void flush_all_volumes(void);
152 void flush_volume(struct volume_info *vol);
153 void flush_buffer(struct buffer_info *buf);
154
155 void hammer_cache_set(int bytes);
156 void hammer_cache_add(struct cache_info *cache, enum cache_type type);
157 void hammer_cache_del(struct cache_info *cache);
158 void hammer_cache_used(struct cache_info *cache);
159 void hammer_cache_flush(void);
160
161 void panic(const char *ctl, ...) __printflike(1, 2);
162