manual/LDP_man-pages/release/man3/hsearch.3

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\" Copyright 1993 Ulrich Drepper (drepper@karlsruhe.gmd.de)
   3 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   4 .\"     <mtk.manpages@gmail.com>
   5 .\"
   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, write to the Free
  23 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  24 .\" USA.
  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 .\" Japanese Version Copyright (c) 1998 George Momma,
  36 .\"     Copyright (c) 2001-2005 Yuichi SATO,
  37 .\"     and Copyright (c) 2008 Akihiro MOTOKI
  38 .\" Translated 1998-05-23, George Momma <momma@wakhok.ac.jp>
  39 .\" Updated & Modified 2001-10-15, Yuichi SATO <ysato@h4.dion.ne.jp>
  40 .\" Updated & Modified 2002-01-03, Yuichi SATO
  41 .\" Updated & Modified 2004-01-17, Yuichi SATO <ysato444@yahoo.co.jp>
  42 .\" Updated & Modified 2005-01-10, Yuichi SATO
  43 .\" Updated 2008-09-20, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  44 .\"
  45 .\"WORD:        hash table              ハッシュテーブル
  46 .\"WORD:        entry                   エントリー
  47 .\"WORD:        allocate                割り当て
  48 .\"WORD:        NUL-terminated          ヌル文字 \0 で終端された
  49 .\"WORD:        pointer                 ポインタ
  50 .\"WORD:        character               文字型
  51 .\"WORD:        item                    項目
  52 .\"
  53 .TH HSEARCH 3 2011-09-10 "GNU" "Linux Programmer's Manual"
  54 .SH 名前
  55 hcreate, hdestroy, hsearch, hcreate_r, hdestroy_r,
  56 hsearch_r \- ハッシュテーブルの管理
  57 .SH 書式
  58 .nf
  59 .B #include <search.h>
  60 .sp
  61 .BI "int hcreate(size_t " nel );
  62 .sp
  63 .BI "ENTRY *hsearch(ENTRY " item ", ACTION " action );
  64 .sp
  65 .B "void hdestroy(void);"
  66 .sp
  67 .BR "#define _GNU_SOURCE" "         /* feature_test_macros(7) 参照 */"
  68 .br
  69 .B #include <search.h>
  70 .sp
  71 .BI "int hcreate_r(size_t " nel ", struct hsearch_data *" htab );
  72 .sp
  73 .BI "int hsearch_r(ENTRY " item ", ACTION " action ", ENTRY **" retval ,
  74 .BI "              struct hsearch_data *" htab );
  75 .sp
  76 .BI "void hdestroy_r(struct hsearch_data *" htab );
  77 .fi
  78 .SH 説明
  79 .BR hcreate (),
  80 .BR hsearch (),
  81 .BR hdestroy ()
  82 の 3 つの関数を利用すると、キー (文字列) と対応するデータから構成される
  83 エントリを格納できるハッシュ検索テーブルを作成、管理することができる。
  84 これらの関数を使って、一度に使用できるのは一つのハッシュテーブルだけである。
  85
  86 .BR hcreate_r (),
  87 .BR hsearch_r (),
  88 .BR hdestroy_r ()
  89 の 3 つの関数はリエントラント版で、これらを利用すると、
  90 一つのプログラムで同時に複数のハッシュテーブルを使うことができる。
  91 最後の引き数
  92 .I htab
  93 は関数の操作対象となるテーブルを示す構造体へのポインタである。
  94 プログラマはこの構造体をブラックボックスとして扱うべきである
  95 (つまり、この構造体のフィールドに直接アクセスしたり変更したり
  96 しないこと)。
  97
  98 最初に、
  99 .BR hcreate ()
 100 関数によってハッシュテーブルを作成しなければならない。
 101 引き数 \fInel\fP でテーブルの最大エントリ数を指定する
 102 (この最大値は後で変更することはできないので、よく考えて選択すること)。
 103 作成されるハッシュテーブルの性能を向上させるために、
 104 関数内部の実装によりこの値は増やされる場合もある。
 105 .\" e.g., in glibc it is raised to the next higher prime number
 106
 107 .BR hcreate_r ()
 108 関数は
 109 .BR hcreate ()
 110 と同じ動作をするが、構造体
 111 .I *htab
 112 で示されるテーブルを対象として動作する。
 113 .I htab
 114 が指し示す構造体は、
 115 .BR hcreate_r ()
 116 を初めて呼び出す前に 0 で埋めておかなければならない。
 117
 118 .BR hdestroy ()
 119 関数は、
 120 .BR hcreate ()
 121 で作成されたハッシュテーブルが占有していたメモリを解放する。
 122 ハッシュテーブルによって占有されていたメモリを解放し、
 123 新しいテーブルを作成できるようにする。
 124 .BR hdestroy ()
 125 を呼び出すと、その後は
 126 .BR hcreate ()
 127 を使って新しいハッシュテーブルを作成することができる。
 128 .BR hdestroy_r ()
 129 関数は、同様の処理を、それ以前に
 130 .BR hcreate_r ()
 131 を使って作成した
 132 .I *htab
 133 で示されるハッシュテーブルに対して実行する。
 134
 135 .BR hsearch ()
 136 関数は、\fIitem\fP と同じキーを持つ項目をハッシュテーブルから
 137 検索し、項目が見つかった場合にはその項目へのポインタを返す
 138 (「同じ」かどうかは
 139 .BR strcmp (3)
 140 を使って判定する)。
 141
 142 引き数 \fIitem\fP は \fBENTRY\fP 型であり、\fI<search.h>\fP の中で
 143 以下のように定義されている。
 144 .in +4n
 145 .sp
 146 .nf
 147 typedef struct entry {
 148     char *key;
 149     void *data;
 150 } ENTRY;
 151 .in
 152 .fi
 153 .sp
 154 フィールド \fIkey\fP は検索キーとなる NULL 終端された文字列を指す。
 155 フィールド \fIdata\fP は、このキーに対応するデータを指す。
 156
 157 検索が失敗した後の動作は、引き数 \fIaction\fP により決まる。
 158 この引き数には
 159 .B ENTER
 160 か
 161 .B FIND
 162 のいずれかの値を指定しなければならない。
 163 .B ENTER
 164 は
 165 .I item
 166 のコピーを挿入することを
 167 (関数の結果として新しいハッシュテーブルエントリへのポインタを返す)、
 168 .B FIND
 169 は NULL を返すことを意味する
 170 .RI ( action
 171 が
 172 .B FIND
 173 の場合、
 174 .I data
 175 は無視される)。
 176
 177 .BR hsearch_r ()
 178 関数は
 179 .BR hsearch ()
 180 と同様だが、
 181 .I *htab
 182 で示されるハッシュテーブルに対して処理を行う。
 183 .BR hsearch_r ()
 184 関数が
 185 .BR hsearch ()
 186 と異なるのは、見つかった項目へのポインタを、
 187 関数の結果としてではなく、
 188 .I *retval
 189 に格納して返す点である。
 190 .SH 返り値
 191 .BR hcreate ()
 192 と
 193 .BR hcreate_r ()
 194 は、成功した場合 0 以外の値を返し、
 195 エラーの場合 0 を返す。
 196
 197 成功すると、
 198 .BR hsearch ()
 199 は、ハッシュテーブル内のエントリへのポインタを返す。
 200 エラーの場合、
 201 .BR hsearch ()
 202 は NULL を返す。
 203 エラーとなるのは、
 204 \fIaction\fP が \fBENTER\fP でハッシュテーブルがいっぱいの場合か、
 205 \fIaction\fP が \fBFIND\fP で \fIitem\fP がハッシュテーブル内に
 206 見つからない場合である。
 207 .BR hsearch_r ()
 208 は、成功すると 0 以外を返し、エラーの場合 0 を返す。
 209 .SH エラー
 210 .LP
 211 .BR hcreate_r ()
 212 と
 213 .BR hdestroy_r ()
 214 は以下の理由で失敗する可能性がある。
 215 .TP
 216 .B EINVAL
 217 .I htab
 218 が NULL である。
 219 .PP
 220 .BR hsearch ()
 221 と
 222 .BR hsearch_r ()
 223 は以下の理由で失敗する可能性がある。
 224 .TP
 225 .B ENOMEM
 226 .I action
 227 が
 228 .B ENTER
 229 で、
 230 .I key
 231 がテーブル内に見つからず、
 232 テーブルに新しいエントリを追加する余地がなかった。
 233 .TP
 234 .B ESRCH
 235 .I action
 236 が
 237 .B FIND
 238 で、
 239 .I key
 240 がテーブル内に見つからなかった。
 241 .PP
 242 POSIX.1-2001 が規定しているのは、エラー
 243 .B ENOMEM
 244 だけである。
 245 .SH 準拠
 246 関数
 247 .BR hcreate (),
 248 .BR hsearch (),
 249 .BR hdestroy ()
 250 は SVr4 から導入されたもので、POSIX.1-2001 に記述されている。
 251 関数
 252 .BR hcreate_r ,
 253 .BR hsearch_r ,
 254 .B hdestroy_r
 255 は GNU の拡張である。
 256 .SH 注意
 257 通常、ハッシュテーブルの実装は、衝突を最小限にするために
 258 テーブルに十分な空き領域がある場合に効率がよくなる。
 259 このため、普通は、
 260 .I nel
 261 を、呼び出し側がテーブルに格納しようと思っている
 262 エントリの最大数より少なくとも 25% は大きな値にすべきである。
 263
 264 .BR hdestroy ()
 265 と
 266 .BR hdestroy_r ()
 267 は、ハッシュテーブルのエントリの要素である
 268 .I key
 269 と
 270 .I data
 271 が指すバッファを解放しない
 272 (これができないのは、これらのバッファが動的に割り当てられたのかを
 273 知ることができないからである)。
 274 これらのバッファを解放する必要がある場合、
 275 プログラムでは、これらのバッファを解放できるように管理用のデータ構造を
 276 設けて、これを管理しなければならない
 277 (解放が必要となる理由は、たいていは、プログラム自身と生存期間が同じ
 278 ハッシュテーブルを一つだけ作成するのではなく、そのプログラムでは複数の
 279 ハッシュテーブルを繰り返して作成したり破棄したりするからであろう)。
 280 .SH バグ
 281 SVr4 と POSIX.1-2001 の規定では、
 282 \fIaction\fP は検索が失敗したときにだけ意味を持つとなっている。
 283 よって、検索が成功した場合、\fIaction\fP の値が \fBENTER\fP でも
 284 何もすべきではない。
 285 (バージョン 2.3 より前の) libc と glibc の実装はこの規格に違反しており、
 286 この状況で、指定された \fIkey\fP に対応する \fIdata\fP が更新される。
 287
 288 ハッシュテーブルエントリーの追加はできるが、削除ができない。
 289 .SH 例
 290 .PP
 291 次のプログラムは、ハッシュテーブルに 24 個の項目を挿入し、
 292 それからそのうちのいくつかを表示する。
 293 .nf
 294
 295 #include <stdio.h>
 296 #include <stdlib.h>
 297 #include <search.h>
 298
 299 char *data[] = { "alpha", "bravo", "charlie", "delta",
 300      "echo", "foxtrot", "golf", "hotel", "india", "juliet",
 301      "kilo", "lima", "mike", "november", "oscar", "papa",
 302      "quebec", "romeo", "sierra", "tango", "uniform",
 303      "victor", "whisky", "x\-ray", "yankee", "zulu"
 304 };
 305
 306 int main()
 307 {
 308     ENTRY e, *ep;
 309     int i;
 310
 311     hcreate(30);
 312
 313     for (i = 0; i < 24; i++) {
 314         e.key = data[i];
 315         /* データは、ポインタではなく、単なる整数値である。 */
 316         e.data = (void *) i;
 317         ep = hsearch(e, ENTER);
 318         /* エラーは起こらないはずである。 */
 319         if (ep == NULL) {
 320             fprintf(stderr, "entry failed\\n");
 321             exit(EXIT_FAILURE);
 322         }
 323     }
 324
 325     for (i = 22; i < 26; i++) {
 326         /* テーブルにある 2 つのエントリを表示し、
 327            あとの 2 つがテーブルにないことを示す。 */
 328         e.key = data[i];
 329         ep = hsearch(e, FIND);
 330         printf("%9.9s \-> %9.9s:%d\\n", e.key,
 331                ep ? ep\->key : "NULL", ep ? (int)(ep\->data) : 0);
 332     }
 333     hdestroy();
 334     exit(EXIT_SUCCESS);
 335 }
 336 .fi
 337 .SH 関連項目
 338 .BR bsearch (3),
 339 .BR lsearch (3),
 340 .BR malloc (3),
 341 .BR tsearch (3)