release/man3/hash.3

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)hash.3      8.6 (Berkeley) 8/18/94
  35 .\"
  36 .\"*******************************************************************
  37 .\"
  38 .\" This file was generated with po4a. Translate the source file.
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" Japanese Version Copyright (c) 1999 Shouichi Saito
  43 .\"     all rights reserved.
  44 .\" Translated Mon Jul 26 14:22:49 JST 1999
  45 .\"     by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
  46 .\" Proofed Tue Aug 17 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  47 .\" Updated 2008-02-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.77
  48 .\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  49 .\"
  50 .TH HASH 3 2012\-04\-23 "" "Linux Programmer's Manual"
  51 .UC 7
  52 .SH 名前
  53 hash \- hash データベースへのアクセスメソッド
  54 .SH 書式
  55 .nf
  56 \fB#include <sys/types.h>
  57 #include <db.h>\fP
  58 .fi
  59 .SH 説明
  60 \fI大事な注意\fP:
  61 このページは、バージョン 2.1 までの glibc が提供するインターフェースに
  62 ついて説明している。バージョン 2.2 以降の glibc では、もはやこれらの
  63 インターフェースは提供されていない。おそらく、このページではなく、
  64 \fIlibdb\fP ライブラリが提供する API をお探しなのだろう。
  65
  66 ルーチン \fBdbopen\fP(3)  はデータベースファイルに対するライブラリインターフェースである。 サポートされているファイルフォーマットのひとつに
  67 hash ファイルがある。 データベースへのアクセスメソッドに関する一般的な記述は \fBdbopen\fP(3)  に書かれている。
  68 このマニュアルページでは hash 特有の情報についてのみ記述する。
  69 .PP
  70 hash データ構造は、拡張可能な動的ハッシュスキームである。
  71 .PP
  72 \fBdbopen\fP(3)  に渡される hash アクセスメソッドに特有のデータ構造体は、 \fI<db.h>\fP
  73 インクルードファイルで以下のように定義されている。
  74 .in +4n
  75 .nf
  76
  77 typedef struct {
  78     unsigned int       bsize;
  79     unsigned int       ffactor;
  80     unsigned int       nelem;
  81     unsigned int       cachesize;
  82     uint32_t         (*hash)(const void *, size_t);
  83     int         lorder;
  84 } HASHINFO;
  85 .fi
  86 .in
  87 .PP
  88 この構造体の要素を以下に示す。
  89 .TP  10
  90 \fIbsize\fP
  91 hash テーブルバケット (table bucket) のサイズを定義する。 デフォルトは 256 バイトである。
  92 ディスクに置かれるテーブルやデータアイテムが大きいテーブルでは ページサイズを大きくするほうが良いだろう。
  93 .TP
  94 \fIffactor\fP
  95 ユーザが望む hash テーブル中の密度である。 これはそれぞれのバケットに格納できるキーの概数であり、 hash テーブルを拡大・縮小を作用する。
  96 デフォルトは 8 である。
  97 .TP
  98 \fInelem\fP
  99 hash テーブルの最終サイズを大まかに見積もった値である。 この値がセットされていなかったり、あまりに低くセットされていると、 hash
 100 テーブルはキーが入ってくるに応じて拡張される。 しかし少しパフォーマンスが (おそらく気付く程度に) 落ちる。 デフォルト値は 1 である。
 101 .TP
 102 \fIcachesize\fP
 103 メモリキャッシュの最大値 (バイト単位) の参考値。 この値は \fBあくまで参考であり\fP、
 104 アクセスメソッドはこの値を越えたメモリの割り当てに成功することもある。
 105 .TP
 106 \fIhash\fP
 107 はユーザー定義の hash 関数である。 全てのデータに対してうまく作用する hash 関数と言うのはないから、 特定のデータセットに対しては組み込みの
 108 hash 関数では パフォーマンスが低いこともあるかもしれない。 ユーザー定義の hash 関数は二つの引数をとらなくてはならない (バイト文字
 109 列へのポインタと、長さ)。 そして hash 値として使われる 32ビットの値を返さなくてはならない。
 110 .TP
 111 \fIlorder\fP
 112 データベースに格納されているメタデータの整数値のバイトオーダー。 この数字は、順序を整数で表したものである。 例えばビッグエンディアンなら、この数値は
 113 4,321 となる。 \fIlorder\fP が 0 (指定されていない)場合、現在のホスト で使われている並び順が使われる。
 114 ファイルが既に存在する場合、指定した値は無視されツリーが作られ た時に指定されていた値が使われる。
 115 .PP
 116 ファイルが既に存在している (または \fBO_TRUNC\fP フラグが指定されていない) と、 \fIbsize\fP, \fIffactor\fP,
 117 \fIlorder\fP, \fInelem\fP に指定された値は無視され、 ハッシュが作られた時に使った値が使われる。
 118 .PP
 119 hash 関数が指定されると、 \fIhash_open\fP はデータベースが作られた時に指定されていた hash 関数と今回指定された hash
 120 関数が同じかどうかを調べ、 同じでない場合には失敗する。
 121 .PP
 122 \fBdbm\fP(3), と \fBndbm\fP(3)  に記述されているルーチンへの過去互換を取るためのインターフェイスが
 123 存在する。しかしこれらのインターフェイスは以前のファイルフォー マットとは互換性がない。
 124 .SH エラー
 125 \fIhash\fP アクセスメソッドルーチンは、失敗するとライブラリルーチン \fBdbopen\fP(3)  で指定されているエラーに応じた \fIerrno\fP
 126 をセットする。
 127 .SH バグ
 128 バイトオーダーとしてはビッグエンディアンとリトルエンディアンのみが サポートされている。
 129 .SH 関連項目
 130 \fBbtree\fP(3), \fBdbopen\fP(3), \fBmpool\fP(3), \fBrecno\fP(3)
 131
 132 \fIDynamic Hash Tables\fP, Per\-Ake Larson, Communications of the ACM, April
 133 1988.
 134
 135 \fIA New Hash Package for UNIX\fP, Margo Seltzer, USENIX Proceedings, Winter
 136 1991.
 137 .SH この文書について
 138 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.67 の一部
 139 である。プロジェクトの説明とバグ報告に関する情報は
 140 http://www.kernel.org/doc/man\-pages/ に書かれている。