lib/libc/iconv/citrus_db_file.h

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