|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | ERRORS | STANDARDS | SEE ALSO | COLOPHON |
|
|
|
mpool(3) Library Functions Manual mpool(3)
mpool - shared memory buffer pool
Standard C library (libc, -lc)
#include <db.h>
#include <mpool.h>
MPOOL *mpool_open(DBT *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);
void *mpool_get(MPOOL *mp, pgno_t pgno, unsigned int flags);
int mpool_put(MPOOL *mp, void *pgaddr, unsigned int flags);
int mpool_sync(MPOOL *mp);
int mpool_close(MPOOL *mp);
Note well: This page documents interfaces provided up until glibc
2.1. Since glibc 2.2, glibc no longer provides these interfaces.
Probably, you are looking for the APIs provided by the libdb
library instead.
Mpool is the library interface intended to provide page oriented
buffer management of files. The buffers may be shared between
processes.
The function mpool_open() initializes a memory pool. The key
argument is the byte string used to negotiate between multiple
processes wishing to share buffers. If the file buffers are
mapped in shared memory, all processes using the same key will
share the buffers. If key is NULL, the buffers are mapped into
private memory. The fd argument is a file descriptor for the
underlying file, which must be seekable. If key is non-NULL and
matches a file already being mapped, the fd argument is ignored.
The pagesize argument is the size, in bytes, of the pages into
which the file is broken up. The maxcache argument is the
maximum number of pages from the underlying file to cache at any
one time. This value is not relative to the number of processes
which share a file's buffers, but will be the largest value
specified by any of the processes sharing the file.
The mpool_filter() function is intended to make transparent input
and output processing of the pages possible. If the pgin
function is specified, it is called each time a buffer is read
into the memory pool from the backing file. If the pgout
function is specified, it is called each time a buffer is written
into the backing file. Both functions are called with the
pgcookie pointer, the page number and a pointer to the page to
being read or written.
The function mpool_new() takes an MPOOL pointer and an address as
arguments. If a new page can be allocated, a pointer to the page
is returned and the page number is stored into the pgnoaddr
address. Otherwise, NULL is returned and errno is set.
The function mpool_get() takes an MPOOL pointer and a page number
as arguments. If the page exists, a pointer to the page is
returned. Otherwise, NULL is returned and errno is set. The
flags argument is not currently used.
The function mpool_put() unpins the page referenced by pgaddr.
pgaddr must be an address previously returned by mpool_get() or
mpool_new(). The flag value is specified by ORing any of the
following values:
MPOOL_DIRTY
The page has been modified and needs to be written to the
backing file.
mpool_put() returns 0 on success and -1 if an error occurs.
The function mpool_sync() writes all modified pages associated
with the MPOOL pointer to the backing file. mpool_sync() returns
0 on success and -1 if an error occurs.
The mpool_close() function free's up any allocated memory
associated with the memory pool cookie. Modified pages are not
written to the backing file. mpool_close() returns 0 on success
and -1 if an error occurs.
The mpool_open() function may fail and set errno for any of the
errors specified for the library routine malloc(3).
The mpool_get() function may fail and set errno for the
following:
EINVAL The requested record doesn't exist.
The mpool_new() and mpool_get() functions may fail and set errno
for any of the errors specified for the library routines read(2),
write(2), and malloc(3).
The mpool_sync() function may fail and set errno for any of the
errors specified for the library routine write(2).
The mpool_close() function may fail and set errno for any of the
errors specified for the library routine free(3).
BSD.
btree(3), dbopen(3), hash(3), recno(3)
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
[email protected]
4.4 Berkeley Distribution 2024-05-02 mpool(3)
Pages that refer to this page: btree(3), dbopen(3), hash(3), recno(3)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|