release/man3/mpool.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 .\"     @(#)mpool.3     8.1 (Berkeley) 6/4/93
  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 21:51:36 JST 1999
  45 .\"     by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
  46 .\" Proofed Tue Aug 19 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  47 .\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  48 .\"
  49 .TH MPOOL 3 2012\-04\-26 "" "Linux Programmer's Manual"
  50 .UC 7
  51 .SH 名前
  52 mpool \- 共有メモリーバッファープール
  53 .SH 書式
  54 .nf
  55 \fB#include <db.h>\fP
  56 \fB#include <mpool.h>\fP
  57 .sp
  58 \fBMPOOL *mpool_open(DBT *\fP\fIkey\fP\fB, int \fP\fIfd\fP\fB, pgno_t \fP\fIpagesize\fP\fB, pgno_t \fP\fImaxcache\fP\fB);\fP
  59 .sp
  60 \fBvoid mpool_filter(MPOOL *\fP\fImp\fP\fB, void (*pgin)(void *, pgno_t, void *),\fP
  61 \fB                  void (*\fP\fIpgout\fP\fB)(void *, pgno_t, void *),\fP
  62 \fB                  void *\fP\fIpgcookie\fP\fB);\fP
  63 .sp
  64 \fBvoid *mpool_new(MPOOL *\fP\fImp\fP\fB, pgno_t *\fP\fIpgnoaddr\fP\fB);\fP
  65 .sp
  66 \fBvoid *mpool_get(MPOOL *\fP\fImp\fP\fB, pgno_t \fP\fIpgno\fP\fB, unsigned int \fP\fIflags\fP\fB);\fP
  67 .sp
  68 \fBint mpool_put(MPOOL *\fP\fImp\fP\fB, void *\fP\fIpgaddr\fP\fB, unsigned int \fP\fIflags\fP\fB);\fP
  69 .sp
  70 \fBint mpool_sync(MPOOL *\fP\fImp\fP\fB);\fP
  71 .sp
  72 \fBint mpool_close(MPOOL *\fP\fImp\fP\fB);\fP
  73 .fi
  74 .SH 説明
  75 \fI大事な注意\fP:
  76 このページは、バージョン 2.1 までの glibc が提供するインターフェースに
  77 ついて説明している。バージョン 2.2 以降の glibc では、もはやこれらの
  78 インターフェースは提供されていない。おそらく、このページではなく、
  79 \fIlibdb\fP ライブラリが提供する API をお探しなのだろう。
  80
  81 \fImpool\fP は、ファイルに対するページ指向のバッファー管理を実装した ライブラリインターフェイスである。
  82 .PP
  83 関数 \fBmpool_open\fP()  はメモリープールを初期化する。 \fIkey\fP 引数はバイト文字列であり、バッファーを共有したい複数プロセス間
  84 でのネゴシエーションに使われる。 ファイルバッファーが共有メモリーにマップされると、 同じキーを使うプロセスは全てバッファーを共有する。 \fIkey\fP
  85 が NULL だと、バッファーはプライベートなメモリーに割り付けられる。 \fIfd\fP 引数はもとになるファイルのファイルディスクリプターである。
  86 このファイルディスクリプターはシーク可能でなくてはならない。 \fIkey\fP が NULL でなく、かつ既にマップされているファイルにマッチした場合、
  87 \fIfd\fP 引数は無視される。
  88 .PP
  89 \fIpagesize\fP 引数はバイト単位でのページサイズであり、ファイルはこのサイズに分割される。 \fImaxcache\fP
  90 引数は基ファイルをキャッシュするときに用いる最大ページ数である。 この値はファイルバッファーを共有しているプロセスの数には関係ないが、
  91 ファイルを共有するプロセスが指定したうちの最大値が実際に用いられる。
  92 .PP
  93 関数 \fBmpool_filter\fP()  は透過的なページ入出力処理を可能にする。 関数 \fIpgin\fP が指定されていると、
  94 ファイルからメモリープールに読み込まれる度にこの関数が呼び出される。 関数 \fIpgout\fP が指定されていと、
  95 バッファーからファイルに書き出される度にこの関数が呼び出される。 どちらの関数も、 \fIpgcookie\fP
  96 ポインター、ページ数、読み書きされるページへのポインターを引数にとる。
  97 .PP
  98 関数 \fBmpool_new\fP()  は \fIMPOOL\fP ポインターとアドレスを引数にとる。
  99 新しいページが割り当て可能な場合、ページへのポインターが返され、 ページ数が \fIpgnoaddr\fP アドレスに納められる。 割り当てが不可能な場合は
 100 NULL が返され、 \fIerrno\fP がセットされる。
 101 .PP
 102 関数 \fBmpool_get\fP()  は \fIMPOOL\fP ポインターとページ数を引数にとる。ページが存在していると、 ページへのポインターが返される。
 103 存在していないと NULL が返され、 \fIerrno\fP がセットされる。 \fIflags\fP 引き数は現在使用されていない。
 104 .PP
 105 関数 \fBmpool_put\fP()  は \fIpgaddr\fP が参照するページを解放する。 \fIpgaddr\fP は以前に \fBmpool_get\fP()
 106 か \fBmpool_new\fP()  が返したアドレスでなければならない。 flag の値は以下の値の論理和で指定する。
 107 .TP
 108 \fBMPOOL_DIRTY\fP
 109 ページは変更されており、ファイルに書き出す必要がある。
 110 .PP
 111 \fBmpool_put\fP()  は成功すると 0 を、エラーがあると \-1 を返す。
 112 .PP
 113 関数 \fBmpool_sync\fP()  は \fIMPOOL\fP ポインターの示すページのうち、 変更されたものを全てファイルに書き出す。
 114 \fBmpool_sync\fP()  は成功すると 0 を、エラーがあると \-1 を返す。
 115 .PP
 116 関数 \fBmpool_close\fP()  はメモリープールクッキーの示す割り当て済みのメモリーを解放する。
 117 変更されたページはファイルに\fB書き出されない\fP。 \fImpool_close ()\fP は成功すると 0 を、エラーがあると \-1 を返す。
 118 .SH エラー
 119 関数 \fBmpool_open\fP()  は失敗するとライブラリルーチン \fBmalloc\fP(3)  で指定されているエラーに応じた \fIerrno\fP
 120 をセットする。
 121 .PP
 122 関数 \fBmpool_get\fP()  は失敗すると次のような \fIerrno\fP をセットする。
 123 .TP  15
 124 \fBEINVAL\fP
 125 要求のあったレコードは存在しない。
 126 .PP
 127 関数 \fBmpool_new\fP()  と \fBmpool_get\fP()  は失敗するとライブラリルーチン \fBread\fP(2),
 128 \fBwrite\fP(2), \fBmalloc\fP(3)  で指定されているエラーに応じた \fIerrno\fP をセットする。
 129 .PP
 130 関数 \fBmpool_sync\fP()  は失敗するとライブラリルーチン \fBwrite\fP(2)  で指定されているエラーに応じた \fIerrno\fP
 131 をセットする。
 132 .PP
 133 関数 \fBmpool_close\fP()  は失敗するとライブラリルーチン \fBfree\fP(3)  で指定されているエラーに応じた \fIerrno\fP
 134 をセットする。
 135 .SH 準拠
 136 POSIX.1\-2001 にはない。 BSD 系に存在する。
 137 .SH 関連項目
 138 \fBbtree\fP(3), \fBdbopen\fP(3), \fBhash\fP(3), \fBrecno\fP(3)
 139 .SH この文書について
 140 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
 141 である。プロジェクトの説明とバグ報告に関する情報は
 142 http://www.kernel.org/doc/man\-pages/ に書かれている。