<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>kmem_cache_create</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="The Linux Kernel API" /><link rel="up" href="ch04.html#id2636427" title="The Slab Cache" /><link rel="prev" href="re132.html" title="kzalloc_node" /><link rel="next" href="re134.html" title="kmem_cache_shrink" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>kmem_cache_create</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re132.html">Prev</a> </td><th width="60%" align="center">The Slab Cache</th><td width="20%" align="right"> <a accesskey="n" href="re134.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="kmem_cache_create"><a id="API-kmem-cache-create"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kmem_cache_create —
Create a cache.
</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">struct kmem_cache * <b class="fsfunc">kmem_cache_create </b>(</code></td><td>const char * <var class="pdparam">name</var>, </td></tr><tr><td> </td><td>size_t <var class="pdparam">size</var>, </td></tr><tr><td> </td><td>size_t <var class="pdparam">align</var>, </td></tr><tr><td> </td><td>unsigned long <var class="pdparam">flags</var>, </td></tr><tr><td> </td><td>void (*<var class="pdparam">ctor</var>)
<code>(</code>void *<code>)</code><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id2637315"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
A string which is used in /proc/slabinfo to identify this cache.
</p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
The size of objects to be created in this cache.
</p></dd><dt><span class="term"><em class="parameter"><code>align</code></em></span></dt><dd><p>
The required alignment for the objects.
</p></dd><dt><span class="term"><em class="parameter"><code>flags</code></em></span></dt><dd><p>
SLAB flags
</p></dd><dt><span class="term"><em class="parameter"><code>ctor</code></em></span></dt><dd><p>
A constructor for the objects.
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id2637411"></a><h2>Description</h2><p>
Returns a ptr to the cache on success, NULL on failure.
Cannot be called within a int, but can be interrupted.
The <em class="parameter"><code>ctor</code></em> is run when new pages are allocated by the cache.
</p><p>
<em class="parameter"><code>name</code></em> must be valid until the cache is destroyed. This implies that
the module calling this has to destroy the cache before getting unloaded.
Note that <code class="function">kmem_cache_name</code> is not guaranteed to return the same pointer,
therefore applications must manage it themselves.
</p><p>
The flags are
</p><p>
<code class="constant">SLAB_POISON</code> - Poison the slab with a known test pattern (a5a5a5a5)
to catch references to uninitialised memory.
</p><p>
<code class="constant">SLAB_RED_ZONE</code> - Insert `Red' zones around the allocated memory to check
for buffer overruns.
</p><p>
<code class="constant">SLAB_HWCACHE_ALIGN</code> - Align the objects in this cache to a hardware
cacheline. This can be beneficial if you're counting cycles as closely
as davem.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re132.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch04.html#id2636427">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re134.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>kzalloc_node</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>kmem_cache_shrink</span></td></tr></table></div></body></html>
