日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
MPOOL(3) FreeBSD ライブラリ関数マニュアル MPOOL(3)
名称
mpool -- 共有メモリバッファプール
書式
#include <db.h>
#include <mpool.h>
MPOOL *
mpool_open(void *key, int fd, pgno_t pagesize, pgno_t maxcache);
void
mpool_filter(MPOOL *mp, void (*pgin)(void *, pgno_t, void *),
void (*pgout)(void *, pgno_t, void *), void *pgcookie);
void *
mpool_new(MPOOL *mp, pgno_t *pgnoaddr, u_int flags);
int
mpool_delete(MPOOL *mp, void *page);
void *
mpool_get(MPOOL *mp, pgno_t pgno, u_int flags);
int
mpool_put(MPOOL *mp, void *pgaddr, u_int flags);
int
mpool_sync(MPOOL *mp);
int
mpool_close(MPOOL *mp);
解説
mpool ライブラリインタフェースは、ファイルのページ指向のバッファ管理を提
供することを目的としています。
mpool_open() 関数は、メモリプールを初期化します。key 引数は、今のところ無
視されます。fd 引数は、基礎ファイルのファイル記述子で、シーク可能でなけれ
ばなりません。
pagesize 引数は、ファイルが分割されるページのバイト単位のサイズです。
maxcache 引数は、基礎ファイルから一度にキャッシュするページの最大数です。
この値は、ファイルのバッファを共有するプロセスの数に関連していませんが、
ファイルを共有するプロセスのいずれかによって指定された最大の値となりま
す。
mpool_filter() 関数は、ページの透過的入出力処理を可能にするように意図され
ます。pgin 関数が指定されるなら、それは、バッファが裏打ちされた後ファイル
からメモリプールに読み込まれるごとに、呼び出されます。pgout 関数がが指定
されるなら、それは、バッファが裏打ちされたファイルに書き込まれるごとに、
呼び出されます。両方の関数は、pgcookie ポインタ、ページ番号と読み込まれて
いるか、または書き込まれているページへのポインタを付けて呼び出されます。
関数 mpool_new() は、引数として MPOOL ポインタ、アドレスと 1 組のフラグを
取ります。新しいページを割り付けることができるなら、ページへのポインタ
が、返され、ページ番号は、pgnoaddr アドレスに格納されます。そうでなけれ
ば、NULL が返され、errno が設定されます。フラグの値は、次の値を OR (論理
和) することによって形成されます:
MPOOL_PAGE_REQUEST
特有のページ番号で新しいページを割り付けます。
MPOOL_PAGE_NEXT
次のページ番号で新しいページを割り付けます。
関数 mpool_delete() は、プールから指定されたページを削除し、ページを解放
します。それは、引数として MPOOL ポインタと 1 つのページを取ります。ペー
ジは、mpool_new() によって生成されていなければなりません。
mpool_get() 関数は、引数として MPOOL ポインタとページ番号を取ります。ペー
ジが存在するなら、ページへのポインタが返されます。そうでなければ、NULL が
返され、errno が設定されます。flags の引数は、次の値のいずれかを OR (論理
和) することよって指定されます:
MPOOL_IGNOREPIN
返されたページは、割り付けられません。そうでなければ、ページは、
割り付けられます。
mpool_put() 関数は、pgaddr によって参照されるページを解放します。pgaddr
引数は、以前に mpool_get() または mpool_new() によって返されたアドレスで
なければなりません。flags の引数は、次の値のいずれかを OR (論理和) するこ
とよって指定されます:
MPOOL_DIRTY
ページは、修正されており、裏打ちされたファイルに書き込まれている
必要があります。
mpool_put() 関数は、成功すれば、0 を返し、エラーが生じたなら、-1 を返しま
す。
mpool_sync() 関数は、MPOOL ポインタに関連する変更されたすべてのページを裏
打ちされたファイルに書き込みます。mpool_sync() 関数は、成功すれば、0 を返
し、エラーが生じたなら、-1 を返します。
mpool_close() 関数は、メモリプールクッキーに関連した割り付けられたメモリ
をすべて解放します。修正されたページは、裏打ちされたファイルに書き込まれ
ません。mpool_close() 関数は、成功すれば、0 を返し、エラーが生じたなら、
-1 を返します。
エラー
mpool_open() 関数が失敗すると、ライブラリルーチン malloc(3) で明記された
エラーのいずれかが errno に設定されます。
mpool_get() 関数が失敗すると、次のものが、errno に設定されます。
[EINVAL] 要求されたレコードが存在しません。
mpool_new() と mpool_get() 関数が失敗すると、ライブラリルーチン read(2),
write(2) と malloc(3) で明記されたエラーのいずれかが errno に設定されま
す。
mpool_sync() 関数が失敗すると、ライブラリルーチン write(2) で明記されたエ
ラーのいずれかが errno に設定されます。
mpool_close() 関数が失敗すると、ライブラリルーチン free(3) で明記されたエ
ラーのいずれかが errno に設定されます。
関連項目
btree(3), dbopen(3), hash(3), recno(3)
FreeBSD 11.2 June 17, 2011 FreeBSD 11.2