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
34 * $DragonFly: src/sbin/hammer/hammer_util.h,v 1.8 2008/02/08 08:30:56 dillon Exp $
37 #include <sys/types.h>
39 #include <sys/queue.h>
41 #include <vfs/hammer/hammer_disk.h>
45 * Cache management - so the user code can keep its memory use under control
50 TAILQ_HEAD(volume_list, volume_info);
53 TAILQ_ENTRY(cache_info) entry;
55 struct volume_info *volume;
56 struct buffer_info *buffer;
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 */
65 * These structures are used by newfs_hammer to track the filesystem
66 * buffers it constructs while building the filesystem. No attempt
67 * is made to try to make this efficient.
70 struct cache_info cache;
71 TAILQ_ENTRY(volume_info) entry;
80 struct hammer_volume_ondisk *ondisk;
82 TAILQ_HEAD(, buffer_info) buffer_list;
86 struct cache_info cache;
87 TAILQ_ENTRY(buffer_info) entry;
88 hammer_off_t buf_offset; /* full hammer offset spec */
89 int64_t buf_disk_offset;/* relative to blkdev */
90 struct volume_info *volume;
94 extern uuid_t Hammer_FSType;
95 extern uuid_t Hammer_FSId;
96 extern int64_t BootAreaSize;
97 extern int64_t MemAreaSize;
98 extern int NumVolumes;
100 extern struct volume_list VolList;
102 uint32_t crc32(const void *buf, size_t size);
104 struct volume_info *setup_volume(int32_t vol_no, const char *filename,
105 int isnew, int oflags);
106 struct volume_info *get_volume(int32_t vol_no);
107 struct buffer_info *get_buffer(hammer_off_t buf_offset, int isnew);
108 hammer_node_ondisk_t get_node(hammer_off_t node_offset,
109 struct buffer_info **bufp);
111 void rel_volume(struct volume_info *volume);
112 void rel_buffer(struct buffer_info *buffer);
114 void *alloc_btree_element(hammer_off_t *offp);
115 hammer_record_ondisk_t alloc_record_element(hammer_off_t *offp,
116 u_int8_t rec_type, int32_t rec_len,
117 int32_t data_len, void **datap);
118 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
120 void flush_all_volumes(void);
121 void flush_volume(struct volume_info *vol);
122 void flush_buffer(struct buffer_info *buf);
124 void hammer_cache_add(struct cache_info *cache, enum cache_type type);
125 void hammer_cache_del(struct cache_info *cache);
126 void hammer_cache_flush(void);
128 void panic(const char *ctl, ...);