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