release/man3/hsearch.3

   1 .\" Copyright 1993 Ulrich Drepper (drepper@karlsruhe.gmd.de)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   6 .\" This is free documentation; you can redistribute it and/or
   7 .\" modify it under the terms of the GNU General Public License as
   8 .\" published by the Free Software Foundation; either version 2 of
   9 .\" the License, or (at your option) any later version.
  10 .\"
  11 .\" The GNU General Public License's references to "object code"
  12 .\" and "executables" are to be interpreted as the output of any
  13 .\" document formatting or typesetting system, including
  14 .\" intermediate and printed output.
  15 .\"
  16 .\" This manual is distributed in the hope that it will be useful,
  17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 .\" GNU General Public License for more details.
  20 .\"
  21 .\" You should have received a copy of the GNU General Public
  22 .\" License along with this manual; if not, see
  23 .\" <http://www.gnu.org/licenses/>.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" References consulted:
  27 .\"     SunOS 4.1.1 man pages
  28 .\" Modified Sat Sep 30 21:52:01 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
  29 .\" Remarks from dhw@gamgee.acad.emich.edu Fri Jun 19 06:46:31 1998
  30 .\" Modified 2001-12-26, 2003-11-28, 2004-05-20, aeb
  31 .\" 2008-09-02, mtk: various additions and rewrites
  32 .\" 2008-09-03, mtk, restructured somewhat, in part after suggestions from
  33 .\"     Timothy S. Nelson <wayland@wayland.id.au>
  34 .\"
  35 .\"*******************************************************************
  36 .\"
  37 .\" This file was generated with po4a. Translate the source file.
  38 .\"
  39 .\"*******************************************************************
  40 .TH HSEARCH 3 2013\-04\-19 GNU "Linux Programmer's Manual"
  41 .SH 名前
  42 hcreate, hdestroy, hsearch, hcreate_r, hdestroy_r, hsearch_r \- ハッシュテーブルの管理
  43 .SH 書式
  44 .nf
  45 \fB#include <search.h>\fP
  46 .sp
  47 \fBint hcreate(size_t \fP\fInel\fP\fB);\fP
  48 .sp
  49 \fBENTRY *hsearch(ENTRY \fP\fIitem\fP\fB, ACTION \fP\fIaction\fP\fB);\fP
  50 .sp
  51 \fBvoid hdestroy(void);\fP
  52 .sp
  53 \fB#define _GNU_SOURCE\fP         /* feature_test_macros(7) 参照 */
  54 .br
  55 \fB#include <search.h>\fP
  56 .sp
  57 \fBint hcreate_r(size_t \fP\fInel\fP\fB, struct hsearch_data *\fP\fIhtab\fP\fB);\fP
  58 .sp
  59 \fBint hsearch_r(ENTRY \fP\fIitem\fP\fB, ACTION \fP\fIaction\fP\fB, ENTRY **\fP\fIretval\fP\fB,\fP
  60 \fB              struct hsearch_data *\fP\fIhtab\fP\fB);\fP
  61 .sp
  62 \fBvoid hdestroy_r(struct hsearch_data *\fP\fIhtab\fP\fB);\fP
  63 .fi
  64 .SH 説明
  65 \fBhcreate\fP(), \fBhsearch\fP(), \fBhdestroy\fP()  の 3 つの関数を利用すると、キー (文字列)
  66 と対応するデータから構成される エントリを格納できるハッシュ検索テーブルを作成、管理することができる。
  67 これらの関数を使って、一度に使用できるのは一つのハッシュテーブルだけである。
  68
  69 \fBhcreate_r\fP(), \fBhsearch_r\fP(), \fBhdestroy_r\fP()  の 3
  70 つの関数はリエントラント版で、これらを利用すると、 一つのプログラムで同時に複数のハッシュテーブルを使うことができる。 最後の引き数 \fIhtab\fP
  71 は関数の操作対象となるテーブルを示す構造体へのポインタである。 プログラマはこの構造体をブラックボックスとして扱うべきである
  72 (つまり、この構造体のフィールドに直接アクセスしたり変更したり しないこと)。
  73
  74 .\" e.g., in glibc it is raised to the next higher prime number
  75 最初に、 \fBhcreate\fP()  関数によってハッシュテーブルを作成しなければならない。 引き数 \fInel\fP でテーブルの最大エントリ数を指定する
  76 (この最大値は後で変更することはできないので、よく考えて選択すること)。 作成されるハッシュテーブルの性能を向上させるために、
  77 関数内部の実装によりこの値は増やされる場合もある。
  78
  79 \fBhcreate_r\fP()  関数は \fBhcreate\fP()  と同じ動作をするが、構造体 \fI*htab\fP
  80 で示されるテーブルを対象として動作する。 \fIhtab\fP が指し示す構造体は、 \fBhcreate_r\fP()  を初めて呼び出す前に 0
  81 で埋めておかなければならない。
  82
  83 \fBhdestroy\fP()  関数は、 \fBhcreate\fP()  で作成されたハッシュテーブルが占有していたメモリを解放する。
  84 ハッシュテーブルによって占有されていたメモリを解放し、 新しいテーブルを作成できるようにする。 \fBhdestroy\fP()  を呼び出すと、その後は
  85 \fBhcreate\fP()  を使って新しいハッシュテーブルを作成することができる。 \fBhdestroy_r\fP()  関数は、同様の処理を、それ以前に
  86 \fBhcreate_r\fP()  を使って作成した \fI*htab\fP で示されるハッシュテーブルに対して実行する。
  87
  88 \fBhsearch\fP()  関数は、\fIitem\fP と同じキーを持つ項目をハッシュテーブルから
  89 検索し、項目が見つかった場合にはその項目へのポインタを返す (「同じ」かどうかは \fBstrcmp\fP(3)  を使って判定する)。
  90
  91 引き数 \fIitem\fP は \fBENTRY\fP 型であり、\fI<search.h>\fP の中で 以下のように定義されている。
  92 .in +4n
  93 .sp
  94 .nf
  95 typedef struct entry {
  96     char *key;
  97     void *data;
  98 } ENTRY;
  99 .in
 100 .fi
 101 .sp
 102 フィールド \fIkey\fP は検索キーとなる NULL 終端された文字列を指す。 フィールド \fIdata\fP は、このキーに対応するデータを指す。
 103
 104 検索が失敗した後の動作は、引き数 \fIaction\fP により決まる。 この引き数には \fBENTER\fP か \fBFIND\fP
 105 のいずれかの値を指定しなければならない。 \fBENTER\fP は \fIitem\fP のコピーを挿入することを
 106 (関数の結果として新しいハッシュテーブルエントリへのポインタを返す)、 \fBFIND\fP は NULL を返すことを意味する (\fIaction\fP が
 107 \fBFIND\fP の場合、 \fIdata\fP は無視される)。
 108
 109 \fBhsearch_r\fP()  関数は \fBhsearch\fP()  と同様だが、 \fI*htab\fP で示されるハッシュテーブルに対して処理を行う。
 110 \fBhsearch_r\fP()  関数が \fBhsearch\fP()  と異なるのは、見つかった項目へのポインタを、 関数の結果としてではなく、
 111 \fI*retval\fP に格納して返す点である。
 112 .SH 返り値
 113 \fBhcreate\fP()  and \fBhcreate_r\fP()  return nonzero on success.  They return 0
 114 on error, with \fIerrno\fP set to indicate the cause of the error.
 115
 116 On success, \fBhsearch\fP()  returns a pointer to an entry in the hash table.
 117 \fBhsearch\fP()  returns NULL on error, that is, if \fIaction\fP is \fBENTER\fP and
 118 the hash table is full, or \fIaction\fP is \fBFIND\fP and \fIitem\fP cannot be found
 119 in the hash table.  \fBhsearch_r\fP()  returns nonzero on success, and 0 on
 120 error.  In the event of an error, these two functions set \fIerrno\fP to
 121 indicate the cause of the error.
 122 .SH エラー
 123 .LP
 124 \fBhcreate_r\fP()  と \fBhdestroy_r\fP()  は以下の理由で失敗する可能性がある。
 125 .TP
 126 \fBEINVAL\fP
 127 \fIhtab\fP が NULL である。
 128 .PP
 129 \fBhsearch\fP()  と \fBhsearch_r\fP()  は以下の理由で失敗する可能性がある。
 130 .TP
 131 \fBENOMEM\fP
 132 \fIaction\fP が \fBENTER\fP で、 \fIkey\fP がテーブル内に見つからず、 テーブルに新しいエントリを追加する余地がなかった。
 133 .TP
 134 \fBESRCH\fP
 135 \fIaction\fP が \fBFIND\fP で、 \fIkey\fP がテーブル内に見つからなかった。
 136 .PP
 137 POSIX.1\-2001 が規定しているのは、エラー \fBENOMEM\fP だけである。
 138 .SH ATTRIBUTES
 139 .SS "Multithreading (see pthreads(7))"
 140 The functions \fBhcreate\fP(), \fBhsearch\fP(), and \fBhdestroy\fP()  use a global
 141 space for storing the table, so they are not thread\-safe.
 142 .LP
 143 The functions \fBhcreate_r\fP(), \fBhsearch_r\fP(), and \fBhdestroy_r\fP()  are
 144 thread\-safe.
 145 .SH 準拠
 146 関数 \fBhcreate\fP(), \fBhsearch\fP(), \fBhdestroy\fP()  は SVr4 から導入されたもので、POSIX.1\-2001
 147 に記述されている。 関数 \fBhcreate_r\fP, \fBhsearch_r\fP, \fBhdestroy_r\fP は GNU の拡張である。
 148 .SH 注意
 149 通常、ハッシュテーブルの実装は、衝突を最小限にするために テーブルに十分な空き領域がある場合に効率がよくなる。 このため、普通は、 \fInel\fP
 150 を、呼び出し側がテーブルに格納しようと思っている エントリの最大数より少なくとも 25% は大きな値にすべきである。
 151
 152 \fBhdestroy\fP()  と \fBhdestroy_r\fP()  は、ハッシュテーブルのエントリの要素である \fIkey\fP と \fIdata\fP
 153 が指すバッファを解放しない (これができないのは、これらのバッファが動的に割り当てられたのかを 知ることができないからである)。
 154 これらのバッファを解放する必要がある場合、 プログラムでは、これらのバッファを解放できるように管理用のデータ構造を 設けて、これを管理しなければならない
 155 (解放が必要となる理由は、たいていは、プログラム自身と生存期間が同じ ハッシュテーブルを一つだけ作成するのではなく、そのプログラムでは複数の
 156 ハッシュテーブルを繰り返して作成したり破棄したりするからであろう)。
 157 .SH バグ
 158 SVr4 と POSIX.1\-2001 の規定では、 \fIaction\fP は検索が失敗したときにだけ意味を持つとなっている。
 159 よって、検索が成功した場合、\fIaction\fP の値が \fBENTER\fP でも 何もすべきではない。 (バージョン 2.3 より前の) libc と
 160 glibc の実装はこの規格に違反しており、 この状況で、指定された \fIkey\fP に対応する \fIdata\fP が更新される。
 161
 162 ハッシュテーブルエントリーの追加はできるが、削除ができない。
 163 .SH 例
 164 .PP
 165 次のプログラムは、ハッシュテーブルに 24 個の項目を挿入し、 それからそのうちのいくつかを表示する。
 166 .nf
 167
 168 #include <stdio.h>
 169 #include <stdlib.h>
 170 #include <search.h>
 171
 172 char *data[] = { "alpha", "bravo", "charlie", "delta",
 173      "echo", "foxtrot", "golf", "hotel", "india", "juliet",
 174      "kilo", "lima", "mike", "november", "oscar", "papa",
 175      "quebec", "romeo", "sierra", "tango", "uniform",
 176      "victor", "whisky", "x\-ray", "yankee", "zulu"
 177 };
 178
 179 int main()
 180 {
 181     ENTRY e, *ep;
 182     int i;
 183
 184     hcreate(30);
 185
 186     for (i = 0; i < 24; i++) {
 187         e.key = data[i];
 188         /* データは、ポインタではなく、単なる整数値である。 */
 189         e.data = (void *) i;
 190         ep = hsearch(e, ENTER);
 191         /* エラーは起こらないはずである。 */
 192         if (ep == NULL) {
 193             fprintf(stderr, "entry failed\en");
 194             exit(EXIT_FAILURE);
 195         }
 196     }
 197
 198     for (i = 22; i < 26; i++) {
 199         /* テーブルにある 2 つのエントリを表示し、
 200            あとの 2 つがテーブルにないことを示す。 */
 201         e.key = data[i];
 202         ep = hsearch(e, FIND);
 203         printf("%9.9s \-> %9.9s:%d\en", e.key,
 204                ep ? ep\->key : "NULL", ep ? (int)(ep\->data) : 0);
 205     }
 206     hdestroy();
 207     exit(EXIT_SUCCESS);
 208 }
 209 .fi
 210 .SH 関連項目
 211 \fBbsearch\fP(3), \fBlsearch\fP(3), \fBmalloc\fP(3), \fBtsearch\fP(3)
 212 .SH この文書について
 213 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 214 である。プロジェクトの説明とバグ報告に関する情報は
 215 http://www.kernel.org/doc/man\-pages/ に書かれている。