lib/libc/citrus/citrus_db_file.h

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