.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "KMEM_CACHE_CREATE" "9" "17 July 2003" "" ""

.SH NAME
kmem_cache_create \- Create a cache.
.SH SYNOPSIS
.sp
\fB
.sp
kmem_cache_t * kmem_cache_create  (const char * \fIname\fB, size_t \fIsize\fB, size_t \fIoffset\fB, unsigned long \fIflags\fB, void (*\fIctor\fB)
void*, kmem_cache_t *, unsigned long, void (*\fIdtor\fB)
void*, kmem_cache_t *, unsigned long);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIname\fB\fR
A string which is used in /proc/slabinfo to identify this cache.
.TP
\fB\fIsize\fB\fR
The size of objects to be created in this cache.
.TP
\fB\fIoffset\fB\fR
The offset to use within the page.
.TP
\fB\fIflags\fB\fR
SLAB flags
.TP
\fB\fIctor\fB\fR
A constructor for the objects.
.TP
\fB\fIdtor\fB\fR
A destructor for the objects.
.SH "DESCRIPTION"
.PP
Returns a ptr to the cache on success, NULL on failure.
Cannot be called within a int, but can be interrupted.
The \fIctor\fR is run when new pages are allocated by the cache
and the \fIdtor\fR is run before the pages are handed back.
.PP
\fIname\fR must be valid until the cache is destroyed. This implies that
the module calling this has to destroy the cache before getting 
unloaded.
.PP
The flags are
.PP
SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
to catch references to uninitialised memory.
.PP
SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
for buffer overruns.
.PP
SLAB_NO_REAP - Don't automatically reap this cache when we're under
memory pressure.
.PP
SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
cacheline.  This can be beneficial if you're counting cycles as closely
as davem.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
.PP
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
.PP
For more details see the file COPYING in the source
distribution of Linux.
.PP
If you have comments on the formatting of this manpage, then please contact
Michael Still (mikal@stillhq.com).
.PP
This documentation was generated with kernel version 2.5.74.