release/man3/mpool.3

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mpool.3     8.1 (Berkeley) 6/4/93
  33 .\"
  34 .\"*******************************************************************
  35 .\"
  36 .\" This file was generated with po4a. Translate the source file.
  37 .\"
  38 .\"*******************************************************************
  39 .TH MPOOL 3 1993\-06\-04 "" "Linux Programmer's Manual"
  40 .UC 7
  41 .SH 名前
  42 mpool \- 共有メモリバッファプール
  43 .SH 書式
  44 .nf
  45 \fB#include <db.h>\fP
  46 \fB#include <mpool.h>\fP
  47 .sp
  48 \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
  49 .sp
  50 \fBvoid mpool_filter(MPOOL *\fP\fImp\fP\fB, void (*pgin)(void *, pgno_t, void *),\fP
  51 \fB                  void (*\fP\fIpgout\fP\fB)(void *, pgno_t, void *),\fP
  52 \fB                  void *\fP\fIpgcookie\fP\fB);\fP
  53 .sp
  54 \fBvoid *mpool_new(MPOOL *\fP\fImp\fP\fB, pgno_t *\fP\fIpgnoaddr\fP\fB);\fP
  55 .sp
  56 \fBvoid *mpool_get(MPOOL *\fP\fImp\fP\fB, pgno_t \fP\fIpgno\fP\fB, unsigned int \fP\fIflags\fP\fB);\fP
  57 .sp
  58 \fBint mpool_put(MPOOL *\fP\fImp\fP\fB, void *\fP\fIpgaddr\fP\fB, unsigned int \fP\fIflags\fP\fB);\fP
  59 .sp
  60 \fBint mpool_sync(MPOOL *\fP\fImp\fP\fB);\fP
  61 .sp
  62 \fBint mpool_close(MPOOL *\fP\fImp\fP\fB);\fP
  63 .fi
  64 .SH 説明
  65 \fImpool\fP は、ファイルに対するページ指向のバッファ管理を実装した ライブラリインターフェイスである。
  66 .PP
  67 関数 \fBmpool_open\fP()  はメモリプールを初期化する。 \fIkey\fP 引数はバイト文字列であり、バッファを共有したい複数プロセス間
  68 でのネゴシエーションに使われる。 ファイルバッファが共有メモリにマップされると、 同じキーを使うプロセスは全てバッファを共有する。 \fIkey\fP が
  69 NULL だと、バッファはプライベートなメモリに割り付けられる。 \fIfd\fP 引数はもとになるファイルのファイルデスクリプタである。
  70 このファイルデスクリプタはシーク可能でなくてはならない。 \fIkey\fP が NULL でなく、かつ既にマップされているファイルにマッチした場合、
  71 \fIfd\fP 引数は無視される。
  72 .PP
  73 \fIpagesize\fP 引数はバイト単位でのページサイズであり、ファイルはこのサイズに分割される。 \fImaxcache\fP
  74 引数は基ファイルをキャッシュするときに用いる最大ページ数である。 この値はファイルバッファを共有しているプロセスの数には関係ないが、
  75 ファイルを共有するプロセスが指定したうちの最大値が実際に用いられる。
  76 .PP
  77 関数 \fBmpool_filter\fP()  は透過的なページ入出力処理を可能にする。 関数 \fIpgin\fP が指定されていると、
  78 ファイルからメモリプールに読み込まれる度にこの関数が呼び出される。 関数 \fIpgout\fP が指定されていと、
  79 バッファからファイルに書き出される度にこの関数が呼び出される。 どちらの関数も、 \fIpgcookie\fP
  80 ポインタ、ページ数、読み書きされるページへのポインタを引数にとる。
  81 .PP
  82 関数 \fBmpool_new\fP()  は \fIMPOOL\fP ポインタとアドレスを引数にとる。
  83 新しいページが割り当て可能な場合、ページへのポインタが返され、 ページ数が \fIpgnoaddr\fP アドレスに納められる。 割り当てが不可能な場合は
  84 NULL が返され、 \fIerrno\fP がセットされる。
  85 .PP
  86 関数 \fBmpool_get\fP()  は \fIMPOOL\fP ポインタとページ数を引数にとる。ページが存在していると、 ページへのポインタが返される。
  87 存在していないと NULL が返され、 \fIerrno\fP がセットされる。 \fIflags\fP 引き数は現在使用されていない。
  88 .PP
  89 関数 \fBmpool_put\fP()  は \fIpgaddr\fP が参照するページを解放する。 \fIpgaddr\fP は以前に \fBmpool_get\fP()
  90 か \fBmpool_new\fP()  が返したアドレスでなければならない。 flag の値は以下の値の論理和で指定する。
  91 .TP
  92 \fBMPOOL_DIRTY\fP
  93 ページは変更されており、ファイルに書き出す必要がある。
  94 .PP
  95 \fBmpool_put\fP()  は成功すると 0 を、エラーがあると \-1 を返す。
  96 .PP
  97 関数 \fBmpool_sync\fP()  は \fIMPOOL\fP ポインタの示すページのうち、 変更されたものを全てファイルに書き出す。
  98 \fBmpool_sync\fP()  は成功すると 0 を、エラーがあると \-1 を返す。
  99 .PP
 100 関数 \fBmpool_close\fP()  はメモリプールクッキーの示す割り当て済みのメモリを解放する。
 101 変更されたページはファイルに\fB書き出されない\fP。 \fImpool_close ()\fP は成功すると 0 を、エラーがあると \-1 を返す。
 102 .SH エラー
 103 関数 \fBmpool_open\fP()  は失敗するとライブラリルーチン \fBmalloc\fP(3)  で指定されているエラーに応じた \fIerrno\fP
 104 をセットする。
 105 .PP
 106 関数 \fBmpool_get\fP()  は失敗すると次のような \fIerrno\fP をセットする。
 107 .TP  15
 108 \fBEINVAL\fP
 109 要求のあったレコードは存在しない。
 110 .PP
 111 関数 \fBmpool_new\fP()  と \fBmpool_get\fP()  は失敗するとライブラリルーチン \fBread\fP(2),
 112 \fBwrite\fP(2), \fBmalloc\fP(3)  で指定されているエラーに応じた \fIerrno\fP をセットする。
 113 .PP
 114 関数 \fBmpool_sync\fP()  は失敗するとライブラリルーチン \fBwrite\fP(2)  で指定されているエラーに応じた \fIerrno\fP
 115 をセットする。
 116 .PP
 117 関数 \fBmpool_close\fP()  は失敗するとライブラリルーチン \fBfree\fP(3)  で指定されているエラーに応じた \fIerrno\fP
 118 をセットする。
 119 .SH 準拠
 120 POSIX.1\-2001 にはない。 BSD 系に存在する。
 121 .SH 関連項目
 122 \fBbtree\fP(3), \fBdbopen\fP(3), \fBhash\fP(3), \fBrecno\fP(3)