MPOOL(3) BSD Library Functions Manual MPOOL(3)

NAME
     mmppooooll - shared memory buffer pool

SYNOPSIS
     ##iinncclluuddee <>
     ##iinncclluuddee <>

     MPOOL *
     mmppoooollooppeenn(void *key, int fd, pgnot pagesize, pgnot maxcache);

     void
     mmppoooollffiilltteerr(MPOOL *mp, void (*pgin)(void *, pgnot, void *),
         void (*pgout)(void *, pgnot, void *), void *pgcookie);

     void *
     mmppoooollnneeww(MPOOL *mp, pgnot *pgnoaddr);

     void *
     mmppoooollggeett(MPOOL *mp, pgnot pgno, uint flags);

     int
     mmppoooollppuutt(MPOOL *mp, void *pgaddr, uint flags);

     int
     mmppoooollssyynncc(MPOOL *mp);

     int
     mmppoooollcclloossee(MPOOL *mp);

DESCRIPTION
     The mmppooooll library interface is intended to provide page oriented buffer
     management of files.

     The mmppoooollooppeenn() function initializes a memory pool.  The key argument is
     currently ignored.  The fd argument is a file descriptor for the underly-
     ing file, which must be seekable.

     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 mmppoooollffiilltteerr() function is intended to make transparent input and
     output processing of the pages possible.  If the pgin function is speci-
     fied, 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 mmppoooollnneeww() function takes an MPOOL pointer and an address as argu-
     ments.  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 mmppoooollggeett() function takes a MPOOL pointer and a page number as argu-
     ments.  If the page exists, a pointer to the page is returned.  Other-
     wise, NULL is returned and errno is set.  The flags argument is not cur-
     rently used.

     The mmppoooollppuutt() function unpins the page referenced by pgaddr.  The
     pgaddr argument must be an address previously returned by mmppoooollggeett() or
     mmppoooollnneeww().  The flags argument is specified by or'ing any of the fol-
     lowing values:

     MPOOLDIRTY
             The page has been modified and needs to be written to the backing
             file.

     The mmppoooollppuutt() function returns 0 on success and -1 if an error occurs.

     The mmppoooollssyynncc() function writes all modified pages associated with the
     MPOOL pointer to the backing file.  The mmppoooollssyynncc() function returns 0
     on success and -1 if an error occurs.

     The mmppoooollcclloossee() function free's up any allocated memory associated with
     the memory pool cookie.  Modified pages are not written to the backing
     file.  The mmppoooollcclloossee() function returns 0 on success and -1 if an error
     occurs.

EERRRROORRSS
     The mmppoooollooppeenn() function may fail and set errno for any of the errors
     specified for the library routine malloc(3).

     The mmppoooollggeett() function may fail and set errno for the following:

     [EINVAL]           The requested record doesn't exist.

     The mmppoooollnneeww() and mmppoooollggeett() functions may fail and set errno for any
     of the errors specified for the library routines read(2), write(2), and
     malloc(3).

     The mmppoooollssyynncc() function may fail and set errno for any of the errors
     specified for the library routine write(2).

     The mmppoooollcclloossee() function may fail and set errno for any of the errors
     specified for the library routine free(3).

SEE ALSO
     btree(3), dbopen(3), hash(3), recno(3)

BSD                              June 4, 1993                              BSD