mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
185 lines
18 KiB
HTML
185 lines
18 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.c 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.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<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="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>chmempools.c</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chmempools_8c.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.c</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Memory Pools code.</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"> * @details Memory Pools related APIs and services.</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * <h2>Operation mode</h2></span>
|
|
<a name="l00034"></a>00034 <span class="comment"> * The Memory Pools APIs allow to allocate/free fixed size objects in</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * <b>constant time</b> and reliably without memory fragmentation</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * problems.<br></span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * In order to use the memory pools APIs the @p CH_USE_MEMPOOLS option</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * must be enabled in @p chconf.h.</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * @{</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> */</span>
|
|
<a name="l00041"></a>00041
|
|
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
|
<a name="l00043"></a>00043
|
|
<a name="l00044"></a>00044 <span class="preprocessor">#if CH_USE_MEMPOOLS</span>
|
|
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> * @brief Initializes an empty memory pool.</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * @note The size is internally aligned to be a multiple of the @p align_t</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> * type size.</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> *</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> * @param[out] mp pointer to a @p MemoryPool structure</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> * @param[in] size the size of the objects contained in this memory pool,</span>
|
|
<a name="l00052"></a>00052 <span class="comment"> * the minimum accepted size is the size of a pointer to</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * void.</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * @param[in] provider memory provider function for the memory pool or</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * @p NULL if the pool is not allowed to grow</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * automatically</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> */</span>
|
|
<a name="l00058"></a><a class="code" href="group__pools.html#ga9c53c25a5ae60930534cde8620775781">00058</a> <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="l00059"></a>00059
|
|
<a name="l00060"></a>00060 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((mp != NULL) && (size >= <span class="keyword">sizeof</span>(<span class="keywordtype">void</span> *)), <span class="stringliteral">"chPoolInit"</span>);
|
|
<a name="l00061"></a>00061
|
|
<a name="l00062"></a>00062 mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a> = NULL;
|
|
<a name="l00063"></a>00063 mp-><a class="code" href="struct_memory_pool.html#a962ca1e05036d54213b3a0eeaebb0ec6" title="Memory pool objects size.">mp_object_size</a> = <a class="code" href="group__memcore.html#ga216a7738be23e0caa9d18e510eb795eb" title="Alignment helper macro.">MEM_ALIGN_SIZE</a>(size);
|
|
<a name="l00064"></a>00064 mp-><a class="code" href="struct_memory_pool.html#aa4b7af734cdd6976445d3502d6914428" title="Memory blocks provider for this pool.">mp_provider</a> = provider;
|
|
<a name="l00065"></a>00065 }
|
|
<a name="l00066"></a>00066 <span class="comment"></span>
|
|
<a name="l00067"></a>00067 <span class="comment">/**</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @brief Allocates an object from a memory pool.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> *</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * @param[in] mp pointer to a @p MemoryPool structure</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> * @return The pointer to the allocated object.</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> * @retval NULL if pool is empty.</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> */</span>
|
|
<a name="l00074"></a><a class="code" href="group__pools.html#ga152fb3460d6b7426f0b6803bb38a0070">00074</a> <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="l00075"></a>00075 <span class="keywordtype">void</span> *objp;
|
|
<a name="l00076"></a>00076
|
|
<a name="l00077"></a>00077 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(mp != NULL, <span class="stringliteral">"chPoolAllocI"</span>);
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a>00079 <span class="keywordflow">if</span> ((objp = mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a>) != NULL)
|
|
<a name="l00080"></a>00080 mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a> = mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a>-><a class="code" href="structpool__header.html#aac699414c648388563597a56e34adeb4" title="Pointer to the next pool header in the list.">ph_next</a>;
|
|
<a name="l00081"></a>00081 <span class="preprocessor">#if CH_USE_MEMCORE</span>
|
|
<a name="l00082"></a>00082 <span class="preprocessor"></span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (mp-><a class="code" href="struct_memory_pool.html#aa4b7af734cdd6976445d3502d6914428" title="Memory blocks provider for this pool.">mp_provider</a> != NULL)
|
|
<a name="l00083"></a>00083 objp = mp-><a class="code" href="struct_memory_pool.html#aa4b7af734cdd6976445d3502d6914428" title="Memory blocks provider for this pool.">mp_provider</a>(mp-><a class="code" href="struct_memory_pool.html#a962ca1e05036d54213b3a0eeaebb0ec6" title="Memory pool objects size.">mp_object_size</a>);
|
|
<a name="l00084"></a>00084 <span class="preprocessor">#endif</span>
|
|
<a name="l00085"></a>00085 <span class="preprocessor"></span> <span class="keywordflow">return</span> objp;
|
|
<a name="l00086"></a>00086 }
|
|
<a name="l00087"></a>00087 <span class="comment"></span>
|
|
<a name="l00088"></a>00088 <span class="comment">/**</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * @brief Allocates an object from a memory pool.</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> *</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> * @param[in] mp pointer to a @p MemoryPool structure</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> * @return The pointer to the allocated object.</span>
|
|
<a name="l00093"></a>00093 <span class="comment"> * @retval NULL if pool is empty.</span>
|
|
<a name="l00094"></a>00094 <span class="comment"> */</span>
|
|
<a name="l00095"></a><a class="code" href="group__pools.html#gab86190d70893fe708c75570af6720bd5">00095</a> <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="l00096"></a>00096 <span class="keywordtype">void</span> *objp;
|
|
<a name="l00097"></a>00097
|
|
<a name="l00098"></a>00098 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00099"></a>00099 objp = <a class="code" href="group__pools.html#ga152fb3460d6b7426f0b6803bb38a0070" title="Allocates an object from a memory pool.">chPoolAllocI</a>(mp);
|
|
<a name="l00100"></a>00100 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00101"></a>00101 <span class="keywordflow">return</span> objp;
|
|
<a name="l00102"></a>00102 }
|
|
<a name="l00103"></a>00103 <span class="comment"></span>
|
|
<a name="l00104"></a>00104 <span class="comment">/**</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> * @brief Releases (or adds) an object into (to) a memory pool.</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> * @note The object is assumed to be of the right size for the specified</span>
|
|
<a name="l00107"></a>00107 <span class="comment"> * memory pool.</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> * @note The object is assumed to be memory aligned to the size of @p align_t</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> * type.</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> *</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * @param[in] mp pointer to a @p MemoryPool structure</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * @param[in] objp the pointer to the object to be released or added</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> */</span>
|
|
<a name="l00114"></a><a class="code" href="group__pools.html#gab5c6c04fd14fbeee2183ca955371c515">00114</a> <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="l00115"></a>00115 <span class="keyword">struct </span><a class="code" href="structpool__header.html" title="Memory pool free object header.">pool_header</a> *php = objp;
|
|
<a name="l00116"></a>00116
|
|
<a name="l00117"></a>00117 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((mp != NULL) && (objp != NULL) && <a class="code" href="group__memcore.html#gac38a64d9001b24d62f1c9ab79fbc328b" title="Returns whatever a pointer or memory size is aligned to the type align_t.">MEM_IS_ALIGNED</a>(objp),
|
|
<a name="l00118"></a>00118 <span class="stringliteral">"chPoolFreeI"</span>);
|
|
<a name="l00119"></a>00119
|
|
<a name="l00120"></a>00120 php-><a class="code" href="structpool__header.html#aac699414c648388563597a56e34adeb4" title="Pointer to the next pool header in the list.">ph_next</a> = mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a>;
|
|
<a name="l00121"></a>00121 mp-><a class="code" href="struct_memory_pool.html#ac1cf32748cc712049b503c2b00f99167" title="Pointer to the header.">mp_next</a> = php;
|
|
<a name="l00122"></a>00122 }
|
|
<a name="l00123"></a>00123 <span class="comment"></span>
|
|
<a name="l00124"></a>00124 <span class="comment">/**</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> * @brief Releases (or adds) an object into (to) a memory pool.</span>
|
|
<a name="l00126"></a>00126 <span class="comment"> * @note The object is assumed to be of the right size for the specified</span>
|
|
<a name="l00127"></a>00127 <span class="comment"> * memory pool.</span>
|
|
<a name="l00128"></a>00128 <span class="comment"> *</span>
|
|
<a name="l00129"></a>00129 <span class="comment"> * @param[in] mp pointer to a @p MemoryPool structure</span>
|
|
<a name="l00130"></a>00130 <span class="comment"> * @param[in] objp the pointer to the object to be released or added</span>
|
|
<a name="l00131"></a>00131 <span class="comment"> */</span>
|
|
<a name="l00132"></a><a class="code" href="group__pools.html#ga978f8d038e8e981bf9e5a104b81c6cb6">00132</a> <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="l00133"></a>00133
|
|
<a name="l00134"></a>00134 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00135"></a>00135 <a class="code" href="group__pools.html#gab5c6c04fd14fbeee2183ca955371c515" title="Releases (or adds) an object into (to) a memory pool.">chPoolFreeI</a>(mp, objp);
|
|
<a name="l00136"></a>00136 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00137"></a>00137 }
|
|
<a name="l00138"></a>00138 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_MEMPOOLS */</span>
|
|
<a name="l00139"></a>00139 <span class="comment"></span>
|
|
<a name="l00140"></a>00140 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|