Home | History | Annotate | Download | only in man9
History log of /src/share/man/man9/pool.9
RevisionDateAuthorComments
 1.50  22-Dec-2021  thorpej Document PR_PSERIALIZE. Remove documentation for pool_cache_setpredestruct().
 1.49  13-Apr-2020  wiz Remove superfluous whitespace & macros.
 1.48  13-Apr-2020  chs slightly change and fix the semantics of pool_set*wat(), pool_sethardlimit()
and pool_prime() (and their pool_cache_* counterparts):

- the pool_set*wat() APIs are supposed to specify thresholds for the count of
free items in the pool before pool pages are automatically allocated or freed
during pool_get() / pool_put(), whereas pool_sethardlimit() and pool_prime()
are supposed to specify minimum and maximum numbers of total items
in the pool (both free and allocated). these were somewhat conflated
in the existing code, so separate them as they were intended.

- change pool_prime() to take an absolute number of items to preallocate
rather than an increment over whatever was done before, and wait for
any memory allocations to succeed. since pool_prime() can no longer fail
after this, change its return value to void and adjust all callers.

- pool_setlowat() is documented as not immediately attempting to allocate
any memory, but it was changed some time ago to immediately try to allocate
up to the lowat level, so just fix the manpage to describe the current
behaviour.

- add a pool_cache_prime() to complete the API set.
 1.47  10-Feb-2019  christos document PR_ZERO
 1.46  24-Dec-2016  abhinav branches: 1.46.14;
Add a missing .El, which is causing the rest of the text being
rendered indented. Patch provided by fox on IRC.

While there, remove a .Pp before .Bl.
 1.45  15-Aug-2015  maxv branches: 1.45.2;
Remove POOL_INIT() (does not exist).
 1.44  14-Nov-2011  jym Document pool_sethardlimit.
 1.43  30-Apr-2008  martin branches: 1.43.22;
Convert TNF licenses to new 2 clause variant
 1.42  25-Jul-2007  pooka branches: 1.42.10; 1.42.12; 1.42.14;
pool_init: wchan is const
 1.41  15-Mar-2007  ad Document the ipl argument to pool_init.
 1.40  16-Feb-2007  rmind - Add link to memoryallocators(9) in kmem_*(9), vmem(9), uvm(9), malloc(9),
pool(9) and pool_cache(9) manuals.
- Sort uvm(9) "SEE ALSO" section.
 1.39  03-Oct-2005  wiz Use full month names in Dd.
 1.38  02-Oct-2005  bouyer Xref pool_cache(9) and bump date.
 1.37  02-Jun-2005  wiz Update pool_prime description to match change in v1.55 of kern/subr_pool.c
(from 2001).
Noted by go@, no comment to diff for over a month from thorpej@.
 1.36  02-Feb-2005  wiz branches: 1.36.2;
Remove a superfluous .El. Noted by Nicolas Joly in PR 29186.
 1.35  01-Jan-2005  yamt document PR_NOTOUCH and bump date.
 1.34  25-Apr-2004  simonb Document the POOL_INIT macro.
 1.33  24-Mar-2004  pooka attempt to clarify bit about flags usage:
* remove mention to PR_URGENT, since it was removed from the code
two years ago
* mention PR_NOWAIT
 1.32  08-Mar-2004  wiz Bump date for previous.
 1.31  08-Mar-2004  dbj note that pool_init and pool_destroy should never be called
in interrupt context.
if this is not a desired restriction, then those functions
should be reviewed for safety, at least protecting pool_head_slock
with splvm()
 1.30  21-Dec-2003  simonb Dump date for previous.
 1.29  21-Dec-2003  simonb Note that the fifth argument to pool_init() is "flags" and not "nitems".
 1.28  01-May-2003  uebayasi Typos, mostly a -> an.

Reviewed by: grant
 1.27  16-Apr-2003  wiz Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.
 1.26  12-Nov-2002  minoura Typo.
- missing argument
- s/of of/of/
 1.25  14-Oct-2002  wiz New sentence, new line.
 1.24  20-Aug-2002  wiz Drop .Pp before .Ss.
 1.23  11-Aug-2002  soren Sync with reality.
 1.22  11-Aug-2002  soren POOL_STORAGE_SIZE no longer exists.
 1.21  13-Feb-2002  ross branches: 1.21.2;
Generate <>& symbolically. I'm avoiding .../dist/... directories for now.
 1.20  26-Dec-2001  wiz Fix SEE ALSO section.
 1.19  19-Jul-2001  gmcgarry Bring up to date. pool_create() doesn't exist any longer. Include
missing description of pool_destroy(). Fix some minor nits.

It isn't clear from the source whether pool_reclaim() and pool_drain()
should belong to the exported API. At least it seems they aren't used.
No descriptions for these functions exist in this manpage.
 1.18  21-Jun-2001  wiz Fix typos, punctuation and whitespace.
 1.17  06-Apr-2001  wiz Double typo.
 1.16  04-Apr-2001  wiz Xref uvm(9), not UVM(9).
XXX: perhaps we should have a link to UVM(9), too?
 1.15  31-May-2000  pk branches: 1.15.2;
Document pool_init(9) and generally Sync with Reality.
 1.14  05-Aug-1999  sommerfeld branches: 1.14.6;
Create new pool flag PR_LIMITFAIL, indicating that even PR_WAIT
allocations should fail if the pool is at its hard limit.
Document flag in pool(9).
Use it in mbuf.h for the first allocate call for M_GET, M_GETHDR, and
MCLGET, so that m_reclaim gets called even for blocking allocations.
 1.13  03-Apr-1999  msaitoh add MLINKS for pool(9).
fix some bugs.
 1.12  16-Mar-1999  garbled branches: 1.12.2;
More .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Many more to
come.
 1.11  03-Sep-1998  msaitoh Eliminate extra comma in SEE ALSO section
 1.10  03-Sep-1998  jeremy Corrected my incorrect usage of hyphens, en-dashes, and em-dashes.
 1.9  03-Sep-1998  jeremy Added subsections for easier reading and some explanatory paragraphs.
Used special groff characters where applicable.
 1.8  02-Sep-1998  jeremy Changed references to filesystem paths to use the mdoc filesystem path
macro (.Pa).
 1.7  17-Aug-1998  pk Fix date.
 1.6  29-Jul-1998  pk The new memory resource pool scheme.
 1.5  22-Apr-1998  ross Add David Brownlee's new intro pages, with editing. (PR #534[23])
Also, while here, expand apparently incorrectly .Dd month abbreviations.
(I thought about doing this in tmac/doc-common...heh...that would have
allowed a possible reverse map back to abbreviations.)
 1.4  20-Feb-1998  pk Describe the client-provided storage option.
 1.3  06-Feb-1998  perry macroize BSD, NetBSD, FreeBSD and misc cleanup
 1.2  10-Jan-1998  lukem use Nx 1.4 not Nx 1.3a
 1.1  13-Dec-1997  pk Pool resource utility docs.
 1.12.2.1  15-Apr-1999  msaitoh pullup 1.12-1.13 (fix entries for pool_prime, pool_sethiwat and pool_setlowat)
 1.14.6.1  22-Jun-2000  minoura Sync w/ netbsd-1-5-base.
 1.15.2.1  26-Apr-2001  he Pull up revision 1.16 (requested by wiz):
Correct uvm(9) reference.
 1.21.2.1  24-Dec-2003  jmc Pullup rev 1.29 (requested by simon in ticket #1581)

Note that the fifth argument to pool_init() is "flags" and not "nitems".
 1.36.2.2  05-Oct-2005  tron Pull up following revision(s) (requested by bouyer in ticket #856):
share/man/man9/pool.9: revision 1.38
Xref pool_cache(9) and bump date.
 1.36.2.1  05-Oct-2005  tron Pull up following revision(s) (requested by bouyer in ticket #855):
share/man/man9/pool.9: revision 1.37
Update pool_prime description to match change in v1.55 of kern/subr_pool.c
(from 2001).
Noted by go@, no comment to diff for over a month from thorpej@.
 1.42.14.2  25-Jul-2007  pooka pool_init: wchan is const
 1.42.14.1  25-Jul-2007  pooka file pool.9 was added on branch matt-mips64 on 2007-07-25 09:14:19 +0000
 1.42.12.1  18-May-2008  yamt sync with head.
 1.42.10.1  02-Jun-2008  mjf Sync with HEAD.
 1.43.22.1  17-Apr-2012  yamt sync with head
 1.45.2.1  07-Jan-2017  pgoyette Sync with HEAD. (Note that most of these changes are simply $NetBSD$
tag issues.)
 1.46.14.2  21-Apr-2020  martin Sync with HEAD
 1.46.14.1  10-Jun-2019  christos Sync with HEAD

RSS XML Feed