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 .\" Japanese Version Copyright (c) 1999 Shouichi Saito
  35 .\"     all rights reserved.
  36 .\" Translated Mon Jul 26 21:51:36 JST 1999
  37 .\"     by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
  38 .\" Proofed Tue Aug 19 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  39 .\"
  40 .\"WORD:        descriptor      ¥Ç¥¹¥¯¥ê¥×¥¿
  41 .TH MPOOL 3 1993-06-04 "" "Linux Programmer's Manual"
  42 .UC 7
  43 .SH Ì¾Á°
  44 mpool \- ¶¦Í¥á¥â¥ê¥Ð¥Ã¥Õ¥¡¥×¡¼¥ë
  45 .SH ½ñ¼°
  46 .nf
  47 .B #include <db.h>
  48 .B #include <mpool.h>
  49 .sp
  50 .BI "MPOOL *mpool_open(DBT *" key ", int " fd ", pgno_t " pagesize \
  51 ", pgno_t " maxcache );
  52 .sp
  53 .BI "void mpool_filter(MPOOL *" mp ", void (*pgin)(void *, pgno_t, void *),"
  54 .BI "                  void (*" pgout ")(void *, pgno_t, void *),"
  55 .BI "                  void *" pgcookie );
  56 .sp
  57 .BI "void *mpool_new(MPOOL *" mp ", pgno_t *" pgnoaddr );
  58 .sp
  59 .BI "void *mpool_get(MPOOL *" mp ", pgno_t " pgno ", unsigned int " flags );
  60 .sp
  61 .BI "int mpool_put(MPOOL *" mp ", void *" pgaddr ", unsigned int " flags );
  62 .sp
  63 .BI "int mpool_sync(MPOOL *" mp );
  64 .sp
  65 .BI "int mpool_close(MPOOL *" mp );
  66 .fi
  67 .SH ÀâÌÀ
  68 .I mpool
  69 ¤Ï¡¢¥Õ¥¡¥¤¥ë¤ËÂÐ¤¹¤ë¥Ú¡¼¥¸»Ø¸þ¤Î¥Ð¥Ã¥Õ¥¡´ÉÍý¤ò¼ÂÁõ¤·¤¿
  70 ¥é¥¤¥Ö¥é¥ê¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹¤Ç¤¢¤ë¡£
  71 .PP
  72 ´Ø¿ô
  73 .BR mpool_open ()
  74 ¤Ï¥á¥â¥ê¥×¡¼¥ë¤ò½é´ü²½¤¹¤ë¡£
  75 .I key
  76 °ú¿ô¤Ï¥Ð¥¤¥ÈÊ¸»úÎó¤Ç¤¢¤ê¡¢¥Ð¥Ã¥Õ¥¡¤ò¶¦Í¤·¤¿¤¤Ê£¿ô¥×¥í¥»¥¹´Ö
  77 ¤Ç¤Î¥Í¥´¥·¥¨¡¼¥·¥ç¥ó¤Ë»È¤ï¤ì¤ë¡£
  78 ¥Õ¥¡¥¤¥ë¥Ð¥Ã¥Õ¥¡¤¬¶¦Í¥á¥â¥ê¤Ë¥Þ¥Ã¥×¤µ¤ì¤ë¤È¡¢
  79 Æ±¤¸¥¡¼¤ò»È¤¦¥×¥í¥»¥¹¤ÏÁ´¤Æ¥Ð¥Ã¥Õ¥¡¤ò¶¦Í¤¹¤ë¡£
  80 .I key
  81 ¤¬ NULL ¤À¤È¡¢¥Ð¥Ã¥Õ¥¡¤Ï¥×¥é¥¤¥Ù¡¼¥È¤Ê¥á¥â¥ê¤Ë³ä¤êÉÕ¤±¤é¤ì¤ë¡£
  82 .I fd
  83 °ú¿ô¤Ï¤â¤È¤Ë¤Ê¤ë¥Õ¥¡¥¤¥ë¤Î¥Õ¥¡¥¤¥ë¥Ç¥¹¥¯¥ê¥×¥¿¤Ç¤¢¤ë¡£
  84 ¤³¤Î¥Õ¥¡¥¤¥ë¥Ç¥¹¥¯¥ê¥×¥¿¤Ï¥·¡¼¥¯²ÄÇ½¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
  85 .I key
  86 ¤¬ NULL ¤Ç¤Ê¤¯¡¢¤«¤Ä´û¤Ë¥Þ¥Ã¥×¤µ¤ì¤Æ¤¤¤ë¥Õ¥¡¥¤¥ë¤Ë¥Þ¥Ã¥Á¤·¤¿¾ì¹ç¡¢
  87 .I fd
  88 °ú¿ô¤ÏÌµ»ë¤µ¤ì¤ë¡£
  89 .PP
  90 .I pagesize
  91 °ú¿ô¤Ï¥Ð¥¤¥ÈÃ±°Ì¤Ç¤Î¥Ú¡¼¥¸¥µ¥¤¥º¤Ç¤¢¤ê¡¢¥Õ¥¡¥¤¥ë¤Ï¤³¤Î¥µ¥¤¥º¤ËÊ¬³ä¤µ¤ì¤ë¡£
  92 .I maxcache
  93 °ú¿ô¤Ï´ð¥Õ¥¡¥¤¥ë¤ò¥¥ã¥Ã¥·¥å¤¹¤ë¤È¤¤ËÍÑ¤¤¤ëºÇÂç¥Ú¡¼¥¸¿ô¤Ç¤¢¤ë¡£
  94 .\"NAKANO "at any one time" ¤Ï¡Ö¤É¤ó¤Ê½Ö´Ö¤Ë¤ª¤¤¤Æ¤â (ºÇÂç)¡×¤Ç¤¹¤¬¡¢
  95 .\"NAKANO ¾ÊÎ¬²ÄÇ½¤Ç¤·¤ç¤¦¡£
  96 ¤³¤ÎÃÍ¤Ï¥Õ¥¡¥¤¥ë¥Ð¥Ã¥Õ¥¡¤ò¶¦Í¤·¤Æ¤¤¤ë¥×¥í¥»¥¹¤Î¿ô¤Ë¤Ï´Ø·¸¤Ê¤¤¤¬¡¢
  97 ¥Õ¥¡¥¤¥ë¤ò¶¦Í¤¹¤ë¥×¥í¥»¥¹¤¬»ØÄê¤·¤¿¤¦¤Á¤ÎºÇÂçÃÍ¤¬¼ÂºÝ¤ËÍÑ¤¤¤é¤ì¤ë¡£
  98 .PP
  99 ´Ø¿ô
 100 .BR mpool_filter ()
 101 ¤ÏÆ©²áÅª¤Ê¥Ú¡¼¥¸Æþ½ÐÎÏ½èÍý¤ò²ÄÇ½¤Ë¤¹¤ë¡£
 102 ´Ø¿ô
 103 .I pgin
 104 ¤¬»ØÄê¤µ¤ì¤Æ¤¤¤ë¤È¡¢
 105 ¥Õ¥¡¥¤¥ë¤«¤é¥á¥â¥ê¥×¡¼¥ë¤ËÆÉ¤ß¹þ¤Þ¤ì¤ëÅÙ¤Ë¤³¤Î´Ø¿ô¤¬¸Æ¤Ó½Ð¤µ¤ì¤ë¡£
 106 ´Ø¿ô
 107 .I pgout
 108 ¤¬»ØÄê¤µ¤ì¤Æ¤¤¤È¡¢
 109 ¥Ð¥Ã¥Õ¥¡¤«¤é¥Õ¥¡¥¤¥ë¤Ë½ñ¤½Ð¤µ¤ì¤ëÅÙ¤Ë¤³¤Î´Ø¿ô¤¬¸Æ¤Ó½Ð¤µ¤ì¤ë¡£
 110 ¤É¤Á¤é¤Î´Ø¿ô¤â¡¢
 111 .I pgcookie
 112 ¥Ý¥¤¥ó¥¿¡¢¥Ú¡¼¥¸¿ô¡¢ÆÉ¤ß½ñ¤¤µ¤ì¤ë¥Ú¡¼¥¸¤Ø¤Î¥Ý¥¤¥ó¥¿¤ò°ú¿ô¤Ë¤È¤ë¡£
 113 .PP
 114 ´Ø¿ô
 115 .BR mpool_new ()
 116 ¤Ï
 117 .I MPOOL
 118 ¥Ý¥¤¥ó¥¿¤È¥¢¥É¥ì¥¹¤ò°ú¿ô¤Ë¤È¤ë¡£
 119 ¿·¤·¤¤¥Ú¡¼¥¸¤¬³ä¤êÅö¤Æ²ÄÇ½¤Ê¾ì¹ç¡¢¥Ú¡¼¥¸¤Ø¤Î¥Ý¥¤¥ó¥¿¤¬ÊÖ¤µ¤ì¡¢
 120 ¥Ú¡¼¥¸¿ô¤¬
 121 .I pgnoaddr
 122 ¥¢¥É¥ì¥¹¤ËÇ¼¤á¤é¤ì¤ë¡£
 123 ³ä¤êÅö¤Æ¤¬ÉÔ²ÄÇ½¤Ê¾ì¹ç¤Ï NULL ¤¬ÊÖ¤µ¤ì¡¢
 124 .I errno
 125 ¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
 126 .PP
 127 ´Ø¿ô
 128 .BR mpool_get ()
 129 ¤Ï
 130 .I MPOOL
 131 ¥Ý¥¤¥ó¥¿¤È¥Ú¡¼¥¸¿ô¤ò°ú¿ô¤Ë¤È¤ë¡£¥Ú¡¼¥¸¤¬Â¸ºß¤·¤Æ¤¤¤ë¤È¡¢
 132 ¥Ú¡¼¥¸¤Ø¤Î¥Ý¥¤¥ó¥¿¤¬ÊÖ¤µ¤ì¤ë¡£
 133 Â¸ºß¤·¤Æ¤¤¤Ê¤¤¤È NULL ¤¬ÊÖ¤µ¤ì¡¢
 134 .I errno
 135 ¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
 136 .I flags
 137 °ú¤¿ô¤Ï¸½ºß»ÈÍÑ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
 138 .PP
 139 ´Ø¿ô
 140 .BR mpool_put ()
 141 ¤Ï
 142 .I pgaddr
 143 ¤¬»²¾È¤¹¤ë¥Ú¡¼¥¸¤ò²òÊü¤¹¤ë¡£
 144 .I pgaddr
 145 ¤Ï°ÊÁ°¤Ë
 146 .BR mpool_get ()
 147 ¤«
 148 .BR mpool_new ()
 149 ¤¬ÊÖ¤·¤¿¥¢¥É¥ì¥¹¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
 150 flag ¤ÎÃÍ¤Ï°Ê²¼¤ÎÃÍ¤Î¤¤¤º¤ì¤«¤«¡¢¤³¤ì¤é¤ÎÏÀÍýÏÂ¤Ç¤¢¤ë¡£
 151 .TP
 152 .B MPOOL_DIRTY
 153 ¥Ú¡¼¥¸¤ÏÊÑ¹¹¤µ¤ì¤Æ¤ª¤ê¡¢¥Õ¥¡¥¤¥ë¤Ë½ñ¤½Ð¤¹É¬Í×¤¬¤¢¤ë¡£
 154 .PP
 155 .BR mpool_put ()
 156 ¤ÏÀ®¸ù¤¹¤ë¤È 0 ¤ò¡¢¥¨¥é¡¼¤¬¤¢¤ë¤È \-1 ¤òÊÖ¤¹¡£
 157 .PP
 158 ´Ø¿ô
 159 .BR mpool_sync ()
 160 ¤Ï
 161 .I MPOOL
 162 ¥Ý¥¤¥ó¥¿¤Î¼¨¤¹¥Ú¡¼¥¸¤Î¤¦¤Á¡¢
 163 ÊÑ¹¹¤µ¤ì¤¿¤â¤Î¤òÁ´¤Æ¥Õ¥¡¥¤¥ë¤Ë½ñ¤½Ð¤¹¡£
 164 .BR mpool_sync ()
 165 ¤ÏÀ®¸ù¤¹¤ë¤È 0 ¤ò¡¢¥¨¥é¡¼¤¬¤¢¤ë¤È \-1 ¤òÊÖ¤¹¡£
 166 .PP
 167 ´Ø¿ô
 168 .BR mpool_close ()
 169 ¤Ï¥á¥â¥ê¥×¡¼¥ë¥¯¥Ã¥¡¼¤Î¼¨¤¹³ä¤êÅö¤ÆºÑ¤ß¤Î¥á¥â¥ê¤ò²òÊü¤¹¤ë¡£
 170 ÊÑ¹¹¤µ¤ì¤¿¥Ú¡¼¥¸¤Ï¥Õ¥¡¥¤¥ë¤Ë\fB½ñ¤½Ð¤µ¤ì¤Ê¤¤\fP¡£
 171 .I mpool_close ()
 172 ¤ÏÀ®¸ù¤¹¤ë¤È 0 ¤ò¡¢¥¨¥é¡¼¤¬¤¢¤ë¤È \-1 ¤òÊÖ¤¹¡£
 173 .SH ¥¨¥é¡¼
 174 ´Ø¿ô
 175 .BR mpool_open ()
 176 ¤Ï¼ºÇÔ¤¹¤ë¤È¥é¥¤¥Ö¥é¥ê¥ë¡¼¥Á¥ó
 177 .BR malloc (3)
 178 ¤Ç»ØÄê¤µ¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ë±þ¤¸¤¿
 179 .I errno
 180 ¤ò¥»¥Ã¥È¤¹¤ë¡£
 181 .PP
 182 ´Ø¿ô
 183 .BR mpool_get ()
 184 ¤Ï¼ºÇÔ¤¹¤ë¤È¼¡¤Î¤è¤¦¤Ê
 185 .I errno
 186 ¤ò¥»¥Ã¥È¤¹¤ë¡£
 187 .TP 15
 188 .B EINVAL
 189 Í×µá¤Î¤¢¤Ã¤¿¥ì¥³¡¼¥É¤ÏÂ¸ºß¤·¤Ê¤¤¡£
 190 .PP
 191 ´Ø¿ô
 192 .BR mpool_new ()
 193 ¤È
 194 .BR mpool_get ()
 195 ¤Ï¼ºÇÔ¤¹¤ë¤È¥é¥¤¥Ö¥é¥ê¥ë¡¼¥Á¥ó
 196 .BR read (2),
 197 .BR write (2),
 198 .BR malloc (3)
 199 ¤Ç»ØÄê¤µ¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ë±þ¤¸¤¿
 200 .I errno
 201 ¤ò¥»¥Ã¥È¤¹¤ë¡£
 202 .PP
 203 ´Ø¿ô
 204 .BR mpool_sync ()
 205 ¤Ï¼ºÇÔ¤¹¤ë¤È¥é¥¤¥Ö¥é¥ê¥ë¡¼¥Á¥ó
 206 .BR write (2)
 207 ¤Ç»ØÄê¤µ¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ë±þ¤¸¤¿
 208 .I errno
 209 ¤ò¥»¥Ã¥È¤¹¤ë¡£
 210 .PP
 211 ´Ø¿ô
 212 .BR mpool_close ()
 213 ¤Ï¼ºÇÔ¤¹¤ë¤È¥é¥¤¥Ö¥é¥ê¥ë¡¼¥Á¥ó
 214 .BR free (3)
 215 ¤Ç»ØÄê¤µ¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ë±þ¤¸¤¿
 216 .I errno
 217 ¤ò¥»¥Ã¥È¤¹¤ë¡£
 218 .SH ½àµò
 219 POSIX.1-2001 ¤Ë¤Ï¤Ê¤¤¡£
 220 BSD ·Ï¤ËÂ¸ºß¤¹¤ë¡£
 221 .SH ´ØÏ¢¹àÌÜ
 222 .BR btree (3),
 223 .BR dbopen (3),
 224 .BR hash (3),
 225 .BR recno (3)