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 * pidfile management - common definitions so code is more robust
46 #define PIDFILE_BUFSIZE 64
47 static const char pidfile_loc
[] = "/var/run";
50 * Cache management - so the user code can keep its memory use under control
55 TAILQ_HEAD(volume_list
, volume_info
);
58 TAILQ_ENTRY(cache_info
) entry
;
60 struct volume_info
*volume
;
61 struct buffer_info
*buffer
;
63 enum cache_type
{ ISVOLUME
, ISBUFFER
} type
;
64 int refs
; /* structural references */
65 int modified
; /* ondisk modified flag */
66 int delete; /* delete flag - delete on last ref */
69 #define HAMMER_BUFLISTS 64
70 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1)
73 * These structures are used by newfs_hammer to track the filesystem
74 * buffers it constructs while building the filesystem. No attempt
75 * is made to try to make this efficient.
78 struct cache_info cache
;
79 TAILQ_ENTRY(volume_info
) entry
;
81 hammer_off_t vol_alloc
; /* volume-relative offset */
82 hammer_off_t vol_free_off
; /* zone-2 offset */
83 hammer_off_t vol_free_end
; /* zone-2 offset */
91 struct hammer_volume_ondisk
*ondisk
;
93 TAILQ_HEAD(, buffer_info
) buffer_lists
[HAMMER_BUFLISTS
];
97 struct cache_info cache
;
98 TAILQ_ENTRY(buffer_info
) entry
;
99 hammer_off_t buf_offset
; /* full hammer offset spec */
100 int64_t raw_offset
; /* physical offset */
101 int flags
; /* origination flags */
102 int use_count
; /* read count */
103 struct volume_info
*volume
;
107 extern uuid_t Hammer_FSType
;
108 extern uuid_t Hammer_FSId
;
109 extern int64_t BootAreaSize
;
110 extern int64_t MemAreaSize
;
111 extern int64_t UndoBufferSize
;
113 extern const char *ScoreBoardFile
;
114 extern const char *RestrictTarget
;
115 extern int NumVolumes
;
116 extern int RootVolNo
;
117 extern struct volume_list VolList
;
118 extern int UseReadBehind
;
119 extern int UseReadAhead
;
120 extern int AssertOnFailure
;
122 uint32_t crc32(const void *buf
, size_t size
);
123 uint32_t crc32_ext(const void *buf
, size_t size
, uint32_t ocrc
);
125 struct volume_info
*setup_volume(int32_t vol_no
, const char *filename
,
126 int isnew
, int oflags
);
127 struct volume_info
*get_volume(int32_t vol_no
);
128 struct volume_info
*test_volume(int32_t vol_no
);
129 struct buffer_info
*get_buffer(hammer_off_t buf_offset
, int isnew
);
130 void *get_buffer_data(hammer_off_t buf_offset
, struct buffer_info
**bufferp
,
132 hammer_node_ondisk_t
get_node(hammer_off_t node_offset
,
133 struct buffer_info
**bufp
);
135 void rel_volume(struct volume_info
*volume
);
136 void rel_buffer(struct buffer_info
*buffer
);
138 hammer_off_t
blockmap_lookup(hammer_off_t bmap_off
,
139 struct hammer_blockmap_layer1
*layer1
,
140 struct hammer_blockmap_layer2
*layer2
,
142 void format_blockmap(hammer_blockmap_t blockmap
, hammer_off_t zone_base
);
143 void format_undomap(hammer_volume_ondisk_t ondisk
);
145 void *alloc_btree_element(hammer_off_t
*offp
,
146 struct buffer_info
**data_bufferp
);
147 void *alloc_meta_element(hammer_off_t
*offp
, int32_t data_len
,
148 struct buffer_info
**data_bufferp
);
149 void *alloc_data_element(hammer_off_t
*offp
, int32_t data_len
,
150 struct buffer_info
**data_bufferp
);
152 int hammer_btree_cmp(hammer_base_elm_t key1
, hammer_base_elm_t key2
);
153 void hammer_key_beg_init(hammer_base_elm_t base
);
154 void hammer_key_end_init(hammer_base_elm_t base
);
155 int hammer_crc_test_leaf(void *data
, hammer_btree_leaf_elm_t leaf
);
157 void format_freemap(struct volume_info
*root_vol
, hammer_blockmap_t blockmap
);
158 int64_t initialize_freemap(struct volume_info
*vol
);
160 void flush_all_volumes(void);
161 void flush_volume(struct volume_info
*vol
);
162 void flush_buffer(struct buffer_info
*buf
);
164 void hammer_cache_set(int bytes
);
165 void hammer_cache_add(struct cache_info
*cache
, enum cache_type type
);
166 void hammer_cache_del(struct cache_info
*cache
);
167 void hammer_cache_used(struct cache_info
*cache
);
168 void hammer_cache_flush(void);
170 void score_printf(size_t i
, size_t w
, const char *ctl
, ...) __printflike(3, 4);
172 void panic(const char *ctl
, ...) __printflike(1, 2);