xref: /netbsd/lib/libc/citrus/citrus_db_file.h (revision a81d5c25)
1 /*	$NetBSD: citrus_db_file.h,v 1.4 2008/02/10 05:58:22 junyoung Exp $	*/
2 
3 /*-
4  * Copyright (c)2003 Citrus Project,
5  * All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _CITRUS_DB_FILE_H_
30 #define _CITRUS_DB_FILE_H_
31 
32 /*
33  * db format:
34  *  +---
35  *  | header
36  *  |  - magic
37  *  |  - num entries
38  *  +---
39  *  | entry directory
40  *  |  +------------
41  *  |  | entry0
42  *  |  |  - hash value
43  *  |  |  - next entry
44  *  |  |  - key offset
45  *  |  |  - key len
46  *  |  |  - data offset
47  *  |  |  - data size
48  *  |  |---
49  *  |  | entry1
50  *  |  | ..
51  *  |  | entryN
52  *  |  +---
53  *  +---
54  *  | key table
55  *  |  - key0
56  *  |   ...
57  *  |  - keyN
58  *  +---
59  *  | data table
60  *  |  - data0
61  *  |   ...
62  *  |  - dataN
63  *  +---
64  */
65 
66 #define _CITRUS_DB_MAGIC_SIZE	8
67 #define _CITRUS_DB_HEADER_SIZE	16
68 struct _citrus_db_header_x {
69 	char		dhx_magic[_CITRUS_DB_MAGIC_SIZE];
70 	uint32_t	dhx_num_entries;
71 	uint32_t	dhx_entry_offset;
72 } __packed;
73 
74 struct _citrus_db_entry_x {
75 	uint32_t	dex_hash_value;
76 	uint32_t	dex_next_offset;
77 	uint32_t	dex_key_offset;
78 	uint32_t	dex_key_size;
79 	uint32_t	dex_data_offset;
80 	uint32_t	dex_data_size;
81 } __packed;
82 #define _CITRUS_DB_ENTRY_SIZE	24
83 
84 #endif
85