.\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#) mpool. 3 8.1 (Berkeley) 6/4/93 .\" %FreeBSD: src/lib/libc/db/man/mpool. 3, v 1.5. 2.4 2001/12/14 18:33:49 ru Exp % .\" $FreeBSD: doc/ja_JP.eucJP/man/man3/mpool. 3, v 1.5 2002/05/18 07:12:55 horikawa Exp $ .\" .Dd June 4, 1993 .Dt MPOOL 3 .Os .Sh 명칭 .Nm mpool .Nd 공유 메모리밧파프르 .Sh 서식 .In db.h .In mpool.h .Ft MPOOL * .Fn mpool_open "void *key" "int fd" "pgno_t pagesize" "pgno_t maxcache" .Ft void .Fo mpool_filter .Fa "MPOOL *mp" .Fa "void (*pgin)(void *, pgno_t, void *)" .Fa "void (*pgout)(void *, pgno_t, void *)" .Fa "void *pgcookie" .Fc .Ft void * .Fn mpool_new "MPOOL *mp" "pgno_t *pgnoaddr" .Ft void * .Fn mpool_get "MPOOL *mp" "pgno_t pgno" "u_int flags" .Ft int .Fn mpool_put "MPOOL *mp" "void *pgaddr" "u_int flags" .Ft int .Fn mpool_sync "MPOOL *mp" .Ft int .Fn mpool_close "MPOOL *mp" .Sh 해설 .Nm mpool (은)는, 페이지를 기준으로 한, 파일의 버퍼 관리를 행한다 프로그램 라이브러리 인터페이스입니다. 버퍼는 프로세스간에 공유할 수 있습니다. .Pp 함수 .Fn mpool_open (은)는 메모리프르를 초기화합니다. 인수 .Fa key (은)는, 버퍼 (을)를 공유하는 복수의 프로세스간에 네고시에이트 하기 위해서 사용된다 byte string입니다. 파일 버퍼가 공유 메모리에 MAP 되었을 경우는, 같은 키를 사용하고 있는 모든 프로세스가 버퍼를 공유합니다. .Fa key 하지만 .Dv NULL 인 경우, 버퍼는 프라이베이트메모리에 MAP 됩니다. 인수 .Fa fd (은)는, 기초가 된다 파일의 파일 기술자로, 검색 가능하게 되어 있을 필요가 있습니다. .Fa key 하지만 .Dv NULL (이)가 아니고, 벌써 MAP 되고 있는 파일과 일치하는 경우, 인수 .Fa fd (은)는 무시됩니다. .Pp 인수 .Fa pagesize (은)는, 파일을 분할하는 페이지의 사이즈 (바이트 단위)입니다. 인수 .Fa maxcache (은)는, 한 번에 캐쉬하는, 기초가 되는 파일의 최대 페이지수입니다. 이 값은, 파일의 버퍼를 공유하는 프로세스수란 관계 없습니다만, 파일을 공유하는 프로세스가 지정한 최대치가 됩니다. .Pp 함수 .Fn mpool_filter (은)는, 페이지의 투과적 입출력 처리를 행합니다. .Fa pgin 함수가 지정되면(자), 보존 파일로부터 메모리프르에 버퍼를 읽어들일 때마다 불려 갑니다. .Fa pgout 함수가 지정되면(자), 보존 파일에 버퍼가 기입해질 때마다 불려 갑니다. 어느 쪽의 함수도, .Fa pgcookie 포인터, 페이지 번호, 읽고 쓰기를 행하는 페이지의 포인터로 불려 갑니다. .Pp 함수 .Fn mpool_new (은)는, .Ft MPOOL 포인터와 주소를 인수로서 취합니다. 새로운 페이지를 할당할 수가 있는 경우는, 페이지의 포인터가 돌려주어 페이지 번호가 .Fa pgnoaddr 주소에 보존됩니다. 할당할 수가 없는 경우는 .Dv NULL 하지만 돌려주어 .Va errno 하지만 설정됩니다. .Pp 함수 .Fn mpool_get (은)는, .Ft MPOOL 포인터와 페이지 번호를 인수로서 취합니다. 페이지가 존재하는 경우는, 페이지의 포인터가 돌려주어집니다. 페이지가 존재하지 않는 경우는 .Dv NULL 하지만 돌려주어 .Va errno 하지만 세트 됩니다. .Fa flags 파라미터는, 현재 사용되고 있지 않습니다. .Pp 함수 .Fn mpool_put (은)는, .Fa pgaddr 하지만 참조하는 페이지를 해방합니다. .Fa pgaddr (은)는, 미리 .Fn mpool_get 또는 .Fn mpool_new 하지만 돌려준 주소가 아니면 안됩니다. .Fa flags 파라미터는 이하의 값의 논리합 ( .Em or )에 의해 지정됩니다. .Bl -tag -width indent .It Dv MPOOL_DIRTY 페이지가 수정되고 있어 보존 파일에 기입할 필요가 있습니다. .El .Pp 함수 .Fn mpool_put (은)는, 정상 종료시에는 0 을 돌려주어, 에러 때는 -1 을 돌려줍니다. .Pp 함수 .Fn mpool_sync (은)는, .Ft MPOOL 포인터에 대해서, 변경된 모든 페이지를 보존 파일에 기입합니다. .Fn mpool_sync (은)는, 정상 종료시에는 0 을 돌려주어, 에러 때는 -1 을 돌려줍니다. .Pp 함수 .Fn mpool_close (은)는, 메모리프르쿡키에 대해서 할당해진 메모리를 해방합니다. 수정된 페이지는, 보존 파일에 기입해지고 .Em 선 . .Fn mpool_close (은)는, 정상 종료시에는 0 을 돌려주어, 에러 때는 -1 을 돌려줍니다. .Sh 에러 함수 .Fn mpool_open 그리고 에러가 발생하면(자), 프로그램 라이브러리 routine .Xr malloc 3 그리고 지정된 에러의 .Va errno 하지만 세트 됩니다. .Pp 함수 .Fn mpool_get 그리고 에러가 발생하면(자), 이하의 .Va errno 하지만 세트 됩니다. .Bl -tag -width Er .It Bq Er EINVAL 요구된 레코드가 존재하지 않는다. .El .Pp 함수 .Fn mpool_new (와)과 .Fn mpool_get 그리고 에러가 발생하면(자), 프로그램 라이브러리 routine .Xr read 2 , .Xr write 2 , .Xr malloc 3 그리고 지정된 에러의 .Va errno 하지만 세트 됩니다. .Pp 함수 .Fn mpool_sync 그리고 에러가 발생하면(자), 프로그램 라이브러리 routine .Xr write 2 그리고 지정된 에러의 .Va errno 하지만 세트 됩니다. .Pp 함수 .Fn mpool_close 그리고 에러가 발생하면(자), 프로그램 라이브러리 routine .Xr free 3 그리고 지정한 에러의 .Va errno 하지만 세트 됩니다. .Sh 관련 항목 .Xr btree 3 , .Xr dbopen 3 , .Xr hash 3 , .Xr recno 3