mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
139 lines
13 KiB
HTML
139 lines
13 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
||
|
|
<title>ChibiOS/RT: chmempools.h Source File</title>
|
||
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||
|
|
</head><body>
|
||
|
|
<table style="text-align: center; width: 100%;" border="0"
|
||
|
|
cellpadding="2" cellspacing="2">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
||
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
||
|
|
<td style="width: 80px;"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<hr size="1">
|
||
|
|
<!-- Generated by Doxygen 1.6.3 -->
|
||
|
|
<div class="navigation" id="top">
|
||
|
|
<div class="tabs">
|
||
|
|
<ul>
|
||
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="tabs">
|
||
|
|
<ul>
|
||
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
||
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<h1>chmempools.h</h1><a href="chmempools_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
||
|
|
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
||
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
||
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
||
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
||
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
||
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
||
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
||
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
||
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
||
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
||
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
||
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
||
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
||
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
||
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
||
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
||
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
||
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
||
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
||
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
||
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
||
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
||
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
||
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
||
|
|
<a name="l00026"></a>00026 <span class="comment"></span>
|
||
|
|
<a name="l00027"></a>00027 <span class="comment">/**</span>
|
||
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file chmempools.h</span>
|
||
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Memory Pools macros and structures.</span>
|
||
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
||
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup pools</span>
|
||
|
|
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
|
||
|
|
<a name="l00033"></a>00033 <span class="comment"> */</span>
|
||
|
|
<a name="l00034"></a>00034
|
||
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _CHMEMPOOLS_H_</span>
|
||
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHMEMPOOLS_H_</span>
|
||
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
||
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_USE_MEMPOOLS</span>
|
||
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="comment"></span>
|
||
|
|
<a name="l00040"></a>00040 <span class="comment">/**</span>
|
||
|
|
<a name="l00041"></a>00041 <span class="comment"> * @brief Memory pool free object header.</span>
|
||
|
|
<a name="l00042"></a>00042 <span class="comment"> */</span>
|
||
|
|
<a name="l00043"></a><a class="code" href="structpool__header.html">00043</a> <span class="keyword">struct </span><a class="code" href="structpool__header.html" title="Memory pool free object header.">pool_header</a> {
|
||
|
|
<a name="l00044"></a><a class="code" href="structpool__header.html#aac699414c648388563597a56e34adeb4">00044</a> <span class="keyword">struct </span><a class="code" href="structpool__header.html" title="Memory pool free object header.">pool_header</a> *<a class="code" href="structpool__header.html#aac699414c648388563597a56e34adeb4" title="Pointer to the next pool header in the list.">ph_next</a>; <span class="comment">/**< @brief Pointer to the next pool</span>
|
||
|
|
<a name="l00045"></a>00045 <span class="comment"> header in the list. */</span>
|
||
|
|
<a name="l00046"></a>00046 };
|
||
|
|
<a name="l00047"></a>00047 <span class="comment"></span>
|
||
|
|
<a name="l00048"></a>00048 <span class="comment">/**</span>
|
||
|
|
<a name="l00049"></a>00049 <span class="comment"> * @brief Memory pool descriptor.</span>
|
||
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
||
|
|
<a name="l00051"></a><a class="code" href="struct_memory_pool.html">00051</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
||
|
|
<a name="l00052"></a><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167">00052</a> <span class="keyword">struct </span><a class="code" href="structpool__header.html" title="Memory pool free object header.">pool_header</a> *mp_next; <span class="comment">/**< @brief Pointer to the header. */</span>
|
||
|
|
<a name="l00053"></a><a class="code" href="struct_memory_pool.html#a962ca1e05036d54213b3a0eeaebb0ec6">00053</a> <span class="keywordtype">size_t</span> mp_object_size; <span class="comment">/**< @brief Memory pool objects</span>
|
||
|
|
<a name="l00054"></a>00054 <span class="comment"> size. */</span>
|
||
|
|
<a name="l00055"></a><a class="code" href="struct_memory_pool.html#aa4b7af734cdd6976445d3502d6914428">00055</a> <a class="code" href="group__memcore.html#ga4fb77ad6b1053341257948231799b4ad" title="Memory get function.">memgetfunc_t</a> mp_provider; <span class="comment">/**< @brief Memory blocks provider for</span>
|
||
|
|
<a name="l00056"></a>00056 <span class="comment"> this pool. */</span>
|
||
|
|
<a name="l00057"></a>00057 } <a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a>;
|
||
|
|
<a name="l00058"></a>00058 <span class="comment"></span>
|
||
|
|
<a name="l00059"></a>00059 <span class="comment">/**</span>
|
||
|
|
<a name="l00060"></a>00060 <span class="comment"> * @brief Data part of a static memory pool initializer.</span>
|
||
|
|
<a name="l00061"></a>00061 <span class="comment"> * @details This macro should be used when statically initializing a</span>
|
||
|
|
<a name="l00062"></a>00062 <span class="comment"> * memory pool that is part of a bigger structure.</span>
|
||
|
|
<a name="l00063"></a>00063 <span class="comment"> *</span>
|
||
|
|
<a name="l00064"></a>00064 <span class="comment"> * @param[in] name the name of the memory pool variable</span>
|
||
|
|
<a name="l00065"></a>00065 <span class="comment"> * @param[in] size size of the memory pool contained objects</span>
|
||
|
|
<a name="l00066"></a>00066 <span class="comment"> * @param[in] provider memory provider function for the memory pool</span>
|
||
|
|
<a name="l00067"></a>00067 <span class="comment"> */</span>
|
||
|
|
<a name="l00068"></a><a class="code" href="group__pools.html#gac180dea0bb5ebc413ff8c8cfdab7369f">00068</a> <span class="preprocessor">#define _MEMORYPOOL_DATA(name, size, provider) \</span>
|
||
|
|
<a name="l00069"></a>00069 <span class="preprocessor"> {NULL, MEM_ALIGN_SIZE(size), provider}</span>
|
||
|
|
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="comment"></span>
|
||
|
|
<a name="l00071"></a>00071 <span class="comment">/**</span>
|
||
|
|
<a name="l00072"></a>00072 <span class="comment"> * @brief Static memory pool initializer in hungry mode.</span>
|
||
|
|
<a name="l00073"></a>00073 <span class="comment"> * @details Statically initialized memory pools require no explicit</span>
|
||
|
|
<a name="l00074"></a>00074 <span class="comment"> * initialization using @p chPoolInit().</span>
|
||
|
|
<a name="l00075"></a>00075 <span class="comment"> *</span>
|
||
|
|
<a name="l00076"></a>00076 <span class="comment"> * @param[in] name the name of the memory pool variable</span>
|
||
|
|
<a name="l00077"></a>00077 <span class="comment"> * @param[in] size size of the memory pool contained objects</span>
|
||
|
|
<a name="l00078"></a>00078 <span class="comment"> * @param[in] provider memory provider function for the memory pool or @p NULL</span>
|
||
|
|
<a name="l00079"></a>00079 <span class="comment"> * if the pool is not allowed to grow automatically</span>
|
||
|
|
<a name="l00080"></a>00080 <span class="comment"> */</span>
|
||
|
|
<a name="l00081"></a><a class="code" href="group__pools.html#ga498d53232821de6ce2e3e150c76202f2">00081</a> <span class="preprocessor">#define MEMORYPOOL_DECL(name, size, provider) \</span>
|
||
|
|
<a name="l00082"></a>00082 <span class="preprocessor"> MemoryPool name = _MEMORYPOOL_DATA(name, size, provider)</span>
|
||
|
|
<a name="l00083"></a>00083 <span class="preprocessor"></span>
|
||
|
|
<a name="l00084"></a>00084 <span class="preprocessor">#ifdef __cplusplus</span>
|
||
|
|
<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
||
|
|
<a name="l00086"></a>00086 <span class="preprocessor">#endif</span>
|
||
|
|
<a name="l00087"></a>00087 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__pools.html#ga9c53c25a5ae60930534cde8620775781" title="Initializes an empty memory pool.">chPoolInit</a>(<a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a> *mp, <span class="keywordtype">size_t</span> size, <a class="code" href="group__memcore.html#ga4fb77ad6b1053341257948231799b4ad" title="Memory get function.">memgetfunc_t</a> provider);
|
||
|
|
<a name="l00088"></a>00088 <span class="keywordtype">void</span> *<a class="code" href="group__pools.html#ga152fb3460d6b7426f0b6803bb38a0070" title="Allocates an object from a memory pool.">chPoolAllocI</a>(<a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a> *mp);
|
||
|
|
<a name="l00089"></a>00089 <span class="keywordtype">void</span> *<a class="code" href="group__pools.html#gab86190d70893fe708c75570af6720bd5" title="Allocates an object from a memory pool.">chPoolAlloc</a>(<a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a> *mp);
|
||
|
|
<a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="group__pools.html#gab5c6c04fd14fbeee2183ca955371c515" title="Releases (or adds) an object into (to) a memory pool.">chPoolFreeI</a>(<a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a> *mp, <span class="keywordtype">void</span> *objp);
|
||
|
|
<a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="group__pools.html#ga978f8d038e8e981bf9e5a104b81c6cb6" title="Releases (or adds) an object into (to) a memory pool.">chPoolFree</a>(<a class="code" href="struct_memory_pool.html" title="Memory pool descriptor.">MemoryPool</a> *mp, <span class="keywordtype">void</span> *objp);
|
||
|
|
<a name="l00092"></a>00092 <span class="preprocessor">#ifdef __cplusplus</span>
|
||
|
|
<a name="l00093"></a>00093 <span class="preprocessor"></span>}
|
||
|
|
<a name="l00094"></a>00094 <span class="preprocessor">#endif</span>
|
||
|
|
<a name="l00095"></a>00095 <span class="preprocessor"></span>
|
||
|
|
<a name="l00096"></a>00096 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_MEMPOOLS */</span>
|
||
|
|
<a name="l00097"></a>00097
|
||
|
|
<a name="l00098"></a>00098 <span class="preprocessor">#endif </span><span class="comment">/* _CHMEMPOOLS_H_ */</span>
|
||
|
|
<a name="l00099"></a>00099 <span class="comment"></span>
|
||
|
|
<a name="l00100"></a>00100 <span class="comment">/** @} */</span>
|
||
|
|
</pre></div></div>
|
||
|
|
<hr size="1"><address style="text-align: right;"><small>
|
||
|
|
Generated on Sun Jul 11 13:13:01 2010 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|