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