Sat, 16 Apr 2022 09:10:10 +0200
test uncovered branch in cxReallocate()
universe@390 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
universe@390 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
universe@390 | 3 | <head> |
universe@390 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
universe@390 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
universe@390 | 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
universe@390 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
universe@390 | 8 | <title>ucx: /home/mike/workspace/c/ucx/src/ucx/mempool.h File Reference</title> |
universe@390 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
universe@390 | 10 | <script type="text/javascript" src="jquery.js"></script> |
universe@390 | 11 | <script type="text/javascript" src="dynsections.js"></script> |
universe@390 | 12 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
universe@390 | 13 | <script type="text/javascript" src="search/searchdata.js"></script> |
universe@390 | 14 | <script type="text/javascript" src="search/search.js"></script> |
universe@390 | 15 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
universe@390 | 16 | </head> |
universe@390 | 17 | <body> |
universe@390 | 18 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
universe@390 | 19 | <div id="titlearea"> |
universe@390 | 20 | <table cellspacing="0" cellpadding="0"> |
universe@390 | 21 | <tbody> |
universe@390 | 22 | <tr style="height: 56px;"> |
universe@390 | 23 | <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td> |
universe@390 | 24 | <td id="projectalign" style="padding-left: 0.5em;"> |
universe@390 | 25 | <div id="projectname">ucx |
universe@390 | 26 | </div> |
universe@390 | 27 | <div id="projectbrief">UAP Common Extensions</div> |
universe@390 | 28 | </td> |
universe@390 | 29 | </tr> |
universe@390 | 30 | </tbody> |
universe@390 | 31 | </table> |
universe@390 | 32 | </div> |
universe@390 | 33 | <!-- end header part --> |
universe@390 | 34 | <!-- Generated by Doxygen 1.8.13 --> |
universe@390 | 35 | <script type="text/javascript"> |
universe@390 | 36 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
universe@390 | 37 | </script> |
universe@390 | 38 | <script type="text/javascript" src="menudata.js"></script> |
universe@390 | 39 | <script type="text/javascript" src="menu.js"></script> |
universe@390 | 40 | <script type="text/javascript"> |
universe@390 | 41 | $(function() { |
universe@390 | 42 | initMenu('',true,false,'search.php','Search'); |
universe@390 | 43 | $(document).ready(function() { init_search(); }); |
universe@390 | 44 | }); |
universe@390 | 45 | </script> |
universe@390 | 46 | <div id="main-nav"></div> |
universe@390 | 47 | <!-- window showing the filter options --> |
universe@390 | 48 | <div id="MSearchSelectWindow" |
universe@390 | 49 | onmouseover="return searchBox.OnSearchSelectShow()" |
universe@390 | 50 | onmouseout="return searchBox.OnSearchSelectHide()" |
universe@390 | 51 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
universe@390 | 52 | </div> |
universe@390 | 53 | |
universe@390 | 54 | <!-- iframe showing the search results (closed by default) --> |
universe@390 | 55 | <div id="MSearchResultsWindow"> |
universe@390 | 56 | <iframe src="javascript:void(0)" frameborder="0" |
universe@390 | 57 | name="MSearchResults" id="MSearchResults"> |
universe@390 | 58 | </iframe> |
universe@390 | 59 | </div> |
universe@390 | 60 | |
universe@390 | 61 | <div id="nav-path" class="navpath"> |
universe@390 | 62 | <ul> |
universe@390 | 63 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_69f4ea29401808fe6229564976cde3ce.html">ucx</a></li> </ul> |
universe@390 | 64 | </div> |
universe@390 | 65 | </div><!-- top --> |
universe@390 | 66 | <div class="header"> |
universe@390 | 67 | <div class="summary"> |
universe@390 | 68 | <a href="#nested-classes">Data Structures</a> | |
universe@390 | 69 | <a href="#define-members">Macros</a> | |
universe@390 | 70 | <a href="#func-members">Functions</a> </div> |
universe@390 | 71 | <div class="headertitle"> |
universe@390 | 72 | <div class="title">mempool.h File Reference</div> </div> |
universe@390 | 73 | </div><!--header--> |
universe@390 | 74 | <div class="contents"> |
universe@390 | 75 | |
universe@390 | 76 | <p>Memory pool implementation. |
universe@390 | 77 | <a href="#details">More...</a></p> |
universe@390 | 78 | <div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br /> |
universe@390 | 79 | <code>#include "<a class="el" href="allocator_8h_source.html">allocator.h</a>"</code><br /> |
universe@390 | 80 | <code>#include <stddef.h></code><br /> |
universe@390 | 81 | </div> |
universe@390 | 82 | <p><a href="mempool_8h_source.html">Go to the source code of this file.</a></p> |
universe@390 | 83 | <table class="memberdecls"> |
universe@390 | 84 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
universe@390 | 85 | Data Structures</h2></td></tr> |
universe@390 | 86 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxMempool.html">UcxMempool</a></td></tr> |
universe@390 | 87 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UCX mempool structure. <a href="structUcxMempool.html#details">More...</a><br /></td></tr> |
universe@390 | 88 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 89 | </table><table class="memberdecls"> |
universe@390 | 90 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
universe@390 | 91 | Macros</h2></td></tr> |
universe@390 | 92 | <tr class="memitem:a49f7bd1da5ac201d0cf54dc0f0d82dd2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#a49f7bd1da5ac201d0cf54dc0f0d82dd2">ucx_mempool_new_default</a>()   <a class="el" href="mempool_8h.html#ad71cb8c3b6fdb30360376a8b372ef22a">ucx_mempool_new</a>(16)</td></tr> |
universe@390 | 93 | <tr class="memdesc:a49f7bd1da5ac201d0cf54dc0f0d82dd2"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for a new default memory pool with a capacity of 16 elements. <a href="#a49f7bd1da5ac201d0cf54dc0f0d82dd2">More...</a><br /></td></tr> |
universe@390 | 94 | <tr class="separator:a49f7bd1da5ac201d0cf54dc0f0d82dd2"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 95 | </table><table class="memberdecls"> |
universe@390 | 96 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
universe@390 | 97 | Functions</h2></td></tr> |
universe@390 | 98 | <tr class="memitem:ad71cb8c3b6fdb30360376a8b372ef22a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#ad71cb8c3b6fdb30360376a8b372ef22a">ucx_mempool_new</a> (size_t n)</td></tr> |
universe@390 | 99 | <tr class="memdesc:ad71cb8c3b6fdb30360376a8b372ef22a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a memory pool with the specified initial size. <a href="#ad71cb8c3b6fdb30360376a8b372ef22a">More...</a><br /></td></tr> |
universe@390 | 100 | <tr class="separator:ad71cb8c3b6fdb30360376a8b372ef22a"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 101 | <tr class="memitem:aaf75b5016098723a9280531ccc3a6d77"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#aaf75b5016098723a9280531ccc3a6d77">ucx_mempool_chcap</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, size_t newcap)</td></tr> |
universe@390 | 102 | <tr class="memdesc:aaf75b5016098723a9280531ccc3a6d77"><td class="mdescLeft"> </td><td class="mdescRight">Resizes a memory pool. <a href="#aaf75b5016098723a9280531ccc3a6d77">More...</a><br /></td></tr> |
universe@390 | 103 | <tr class="separator:aaf75b5016098723a9280531ccc3a6d77"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 104 | <tr class="memitem:a2ae492b8f2878ccc9837ac213dced11e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#a2ae492b8f2878ccc9837ac213dced11e">ucx_mempool_malloc</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, size_t n)</td></tr> |
universe@390 | 105 | <tr class="memdesc:a2ae492b8f2878ccc9837ac213dced11e"><td class="mdescLeft"> </td><td class="mdescRight">Allocates pooled memory. <a href="#a2ae492b8f2878ccc9837ac213dced11e">More...</a><br /></td></tr> |
universe@390 | 106 | <tr class="separator:a2ae492b8f2878ccc9837ac213dced11e"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 107 | <tr class="memitem:a4b9142011824ae24f00fabe128417d69"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#a4b9142011824ae24f00fabe128417d69">ucx_mempool_calloc</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, size_t nelem, size_t elsize)</td></tr> |
universe@390 | 108 | <tr class="memdesc:a4b9142011824ae24f00fabe128417d69"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a pooled memory array. <a href="#a4b9142011824ae24f00fabe128417d69">More...</a><br /></td></tr> |
universe@390 | 109 | <tr class="separator:a4b9142011824ae24f00fabe128417d69"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 110 | <tr class="memitem:a660ef42520ed6737c2e77aae18e3a7a4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#a660ef42520ed6737c2e77aae18e3a7a4">ucx_mempool_realloc</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, void *ptr, size_t n)</td></tr> |
universe@390 | 111 | <tr class="memdesc:a660ef42520ed6737c2e77aae18e3a7a4"><td class="mdescLeft"> </td><td class="mdescRight">Reallocates pooled memory. <a href="#a660ef42520ed6737c2e77aae18e3a7a4">More...</a><br /></td></tr> |
universe@390 | 112 | <tr class="separator:a660ef42520ed6737c2e77aae18e3a7a4"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 113 | <tr class="memitem:aefa26e3015f5aefadbfc74221bd246ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#aefa26e3015f5aefadbfc74221bd246ac">ucx_mempool_free</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, void *ptr)</td></tr> |
universe@390 | 114 | <tr class="memdesc:aefa26e3015f5aefadbfc74221bd246ac"><td class="mdescLeft"> </td><td class="mdescRight">Frees pooled memory. <a href="#aefa26e3015f5aefadbfc74221bd246ac">More...</a><br /></td></tr> |
universe@390 | 115 | <tr class="separator:aefa26e3015f5aefadbfc74221bd246ac"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 116 | <tr class="memitem:af096378da7e9bfbed3088497cf4c15bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#af096378da7e9bfbed3088497cf4c15bf">ucx_mempool_destroy</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool)</td></tr> |
universe@390 | 117 | <tr class="memdesc:af096378da7e9bfbed3088497cf4c15bf"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a memory pool. <a href="#af096378da7e9bfbed3088497cf4c15bf">More...</a><br /></td></tr> |
universe@390 | 118 | <tr class="separator:af096378da7e9bfbed3088497cf4c15bf"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 119 | <tr class="memitem:adb788e7ec24cd7dbdea6381539c549f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#adb788e7ec24cd7dbdea6381539c549f2">ucx_mempool_set_destr</a> (void *ptr, <a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> func)</td></tr> |
universe@390 | 120 | <tr class="memdesc:adb788e7ec24cd7dbdea6381539c549f2"><td class="mdescLeft"> </td><td class="mdescRight">Sets a destructor function for the specified memory. <a href="#adb788e7ec24cd7dbdea6381539c549f2">More...</a><br /></td></tr> |
universe@390 | 121 | <tr class="separator:adb788e7ec24cd7dbdea6381539c549f2"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 122 | <tr class="memitem:af47b6b7c40f8f263dc28cc9a4e77b27c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mempool_8h.html#af47b6b7c40f8f263dc28cc9a4e77b27c">ucx_mempool_reg_destr</a> (<a class="el" href="structUcxMempool.html">UcxMempool</a> *pool, void *ptr, <a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> destr)</td></tr> |
universe@390 | 123 | <tr class="memdesc:af47b6b7c40f8f263dc28cc9a4e77b27c"><td class="mdescLeft"> </td><td class="mdescRight">Registers a destructor function for the specified (non-pooled) memory. <a href="#af47b6b7c40f8f263dc28cc9a4e77b27c">More...</a><br /></td></tr> |
universe@390 | 124 | <tr class="separator:af47b6b7c40f8f263dc28cc9a4e77b27c"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 125 | </table> |
universe@390 | 126 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
universe@390 | 127 | <div class="textblock"><p>Memory pool implementation. </p> |
universe@390 | 128 | <dl class="section author"><dt>Author</dt><dd>Mike Becker </dd> |
universe@390 | 129 | <dd> |
universe@390 | 130 | Olaf Wintermann </dd></dl> |
universe@390 | 131 | </div><h2 class="groupheader">Macro Definition Documentation</h2> |
universe@390 | 132 | <a id="a49f7bd1da5ac201d0cf54dc0f0d82dd2"></a> |
universe@390 | 133 | <h2 class="memtitle"><span class="permalink"><a href="#a49f7bd1da5ac201d0cf54dc0f0d82dd2">◆ </a></span>ucx_mempool_new_default</h2> |
universe@390 | 134 | |
universe@390 | 135 | <div class="memitem"> |
universe@390 | 136 | <div class="memproto"> |
universe@390 | 137 | <table class="memname"> |
universe@390 | 138 | <tr> |
universe@390 | 139 | <td class="memname">#define ucx_mempool_new_default</td> |
universe@390 | 140 | <td>(</td> |
universe@390 | 141 | <td class="paramname"></td><td>)</td> |
universe@390 | 142 | <td>   <a class="el" href="mempool_8h.html#ad71cb8c3b6fdb30360376a8b372ef22a">ucx_mempool_new</a>(16)</td> |
universe@390 | 143 | </tr> |
universe@390 | 144 | </table> |
universe@390 | 145 | </div><div class="memdoc"> |
universe@390 | 146 | |
universe@390 | 147 | <p>Shorthand for a new default memory pool with a capacity of 16 elements. </p> |
universe@390 | 148 | |
universe@390 | 149 | </div> |
universe@390 | 150 | </div> |
universe@390 | 151 | <h2 class="groupheader">Function Documentation</h2> |
universe@390 | 152 | <a id="a4b9142011824ae24f00fabe128417d69"></a> |
universe@390 | 153 | <h2 class="memtitle"><span class="permalink"><a href="#a4b9142011824ae24f00fabe128417d69">◆ </a></span>ucx_mempool_calloc()</h2> |
universe@390 | 154 | |
universe@390 | 155 | <div class="memitem"> |
universe@390 | 156 | <div class="memproto"> |
universe@390 | 157 | <table class="memname"> |
universe@390 | 158 | <tr> |
universe@390 | 159 | <td class="memname">void* ucx_mempool_calloc </td> |
universe@390 | 160 | <td>(</td> |
universe@390 | 161 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 162 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 163 | </tr> |
universe@390 | 164 | <tr> |
universe@390 | 165 | <td class="paramkey"></td> |
universe@390 | 166 | <td></td> |
universe@390 | 167 | <td class="paramtype">size_t </td> |
universe@390 | 168 | <td class="paramname"><em>nelem</em>, </td> |
universe@390 | 169 | </tr> |
universe@390 | 170 | <tr> |
universe@390 | 171 | <td class="paramkey"></td> |
universe@390 | 172 | <td></td> |
universe@390 | 173 | <td class="paramtype">size_t </td> |
universe@390 | 174 | <td class="paramname"><em>elsize</em> </td> |
universe@390 | 175 | </tr> |
universe@390 | 176 | <tr> |
universe@390 | 177 | <td></td> |
universe@390 | 178 | <td>)</td> |
universe@390 | 179 | <td></td><td></td> |
universe@390 | 180 | </tr> |
universe@390 | 181 | </table> |
universe@390 | 182 | </div><div class="memdoc"> |
universe@390 | 183 | |
universe@390 | 184 | <p>Allocates a pooled memory array. </p> |
universe@390 | 185 | <p>The content of the allocated memory is set to zero.</p> |
universe@390 | 186 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 187 | <table class="params"> |
universe@390 | 188 | <tr><td class="paramname">pool</td><td>the memory pool </td></tr> |
universe@390 | 189 | <tr><td class="paramname">nelem</td><td>amount of elements to allocate </td></tr> |
universe@390 | 190 | <tr><td class="paramname">elsize</td><td>amount of memory per element </td></tr> |
universe@390 | 191 | </table> |
universe@390 | 192 | </dd> |
universe@390 | 193 | </dl> |
universe@390 | 194 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory </dd></dl> |
universe@390 | 195 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12" title="A function pointer to the allocators calloc() function. ">ucx_allocator_calloc()</a> </dd></dl> |
universe@390 | 196 | |
universe@390 | 197 | </div> |
universe@390 | 198 | </div> |
universe@390 | 199 | <a id="aaf75b5016098723a9280531ccc3a6d77"></a> |
universe@390 | 200 | <h2 class="memtitle"><span class="permalink"><a href="#aaf75b5016098723a9280531ccc3a6d77">◆ </a></span>ucx_mempool_chcap()</h2> |
universe@390 | 201 | |
universe@390 | 202 | <div class="memitem"> |
universe@390 | 203 | <div class="memproto"> |
universe@390 | 204 | <table class="memname"> |
universe@390 | 205 | <tr> |
universe@390 | 206 | <td class="memname">int ucx_mempool_chcap </td> |
universe@390 | 207 | <td>(</td> |
universe@390 | 208 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 209 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 210 | </tr> |
universe@390 | 211 | <tr> |
universe@390 | 212 | <td class="paramkey"></td> |
universe@390 | 213 | <td></td> |
universe@390 | 214 | <td class="paramtype">size_t </td> |
universe@390 | 215 | <td class="paramname"><em>newcap</em> </td> |
universe@390 | 216 | </tr> |
universe@390 | 217 | <tr> |
universe@390 | 218 | <td></td> |
universe@390 | 219 | <td>)</td> |
universe@390 | 220 | <td></td><td></td> |
universe@390 | 221 | </tr> |
universe@390 | 222 | </table> |
universe@390 | 223 | </div><div class="memdoc"> |
universe@390 | 224 | |
universe@390 | 225 | <p>Resizes a memory pool. </p> |
universe@390 | 226 | <p>This function will fail if the new capacity is not sufficient for the present data.</p> |
universe@390 | 227 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 228 | <table class="params"> |
universe@390 | 229 | <tr><td class="paramname">pool</td><td>the pool to resize </td></tr> |
universe@390 | 230 | <tr><td class="paramname">newcap</td><td>the new capacity </td></tr> |
universe@390 | 231 | </table> |
universe@390 | 232 | </dd> |
universe@390 | 233 | </dl> |
universe@390 | 234 | <dl class="section return"><dt>Returns</dt><dd>zero on success or non-zero on failure </dd></dl> |
universe@390 | 235 | |
universe@390 | 236 | </div> |
universe@390 | 237 | </div> |
universe@390 | 238 | <a id="af096378da7e9bfbed3088497cf4c15bf"></a> |
universe@390 | 239 | <h2 class="memtitle"><span class="permalink"><a href="#af096378da7e9bfbed3088497cf4c15bf">◆ </a></span>ucx_mempool_destroy()</h2> |
universe@390 | 240 | |
universe@390 | 241 | <div class="memitem"> |
universe@390 | 242 | <div class="memproto"> |
universe@390 | 243 | <table class="memname"> |
universe@390 | 244 | <tr> |
universe@390 | 245 | <td class="memname">void ucx_mempool_destroy </td> |
universe@390 | 246 | <td>(</td> |
universe@390 | 247 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 248 | <td class="paramname"><em>pool</em></td><td>)</td> |
universe@390 | 249 | <td></td> |
universe@390 | 250 | </tr> |
universe@390 | 251 | </table> |
universe@390 | 252 | </div><div class="memdoc"> |
universe@390 | 253 | |
universe@390 | 254 | <p>Destroys a memory pool. </p> |
universe@390 | 255 | <p>For each element the destructor function (if any) is called and the element is freed.</p> |
universe@390 | 256 | <p>Each of the registered destructor function that has no corresponding element within the pool (namely those registered by ucx_mempool_reg_destr) is called interleaving with the element destruction, but with guarantee to the order in which they were registered (FIFO order).</p> |
universe@390 | 257 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 258 | <table class="params"> |
universe@390 | 259 | <tr><td class="paramname">pool</td><td>the mempool to destroy </td></tr> |
universe@390 | 260 | </table> |
universe@390 | 261 | </dd> |
universe@390 | 262 | </dl> |
universe@390 | 263 | |
universe@390 | 264 | </div> |
universe@390 | 265 | </div> |
universe@390 | 266 | <a id="aefa26e3015f5aefadbfc74221bd246ac"></a> |
universe@390 | 267 | <h2 class="memtitle"><span class="permalink"><a href="#aefa26e3015f5aefadbfc74221bd246ac">◆ </a></span>ucx_mempool_free()</h2> |
universe@390 | 268 | |
universe@390 | 269 | <div class="memitem"> |
universe@390 | 270 | <div class="memproto"> |
universe@390 | 271 | <table class="memname"> |
universe@390 | 272 | <tr> |
universe@390 | 273 | <td class="memname">void ucx_mempool_free </td> |
universe@390 | 274 | <td>(</td> |
universe@390 | 275 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 276 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 277 | </tr> |
universe@390 | 278 | <tr> |
universe@390 | 279 | <td class="paramkey"></td> |
universe@390 | 280 | <td></td> |
universe@390 | 281 | <td class="paramtype">void * </td> |
universe@390 | 282 | <td class="paramname"><em>ptr</em> </td> |
universe@390 | 283 | </tr> |
universe@390 | 284 | <tr> |
universe@390 | 285 | <td></td> |
universe@390 | 286 | <td>)</td> |
universe@390 | 287 | <td></td><td></td> |
universe@390 | 288 | </tr> |
universe@390 | 289 | </table> |
universe@390 | 290 | </div><div class="memdoc"> |
universe@390 | 291 | |
universe@390 | 292 | <p>Frees pooled memory. </p> |
universe@390 | 293 | <p>Before freeing the memory, the specified destructor function (if any) is called.</p> |
universe@390 | 294 | <p>If you specify memory, that is not pooled by the specified memory pool, the program will terminate with a call to <code>abort()</code>.</p> |
universe@390 | 295 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 296 | <table class="params"> |
universe@390 | 297 | <tr><td class="paramname">pool</td><td>the memory pool </td></tr> |
universe@390 | 298 | <tr><td class="paramname">ptr</td><td>a pointer to the memory that shall be freed </td></tr> |
universe@390 | 299 | </table> |
universe@390 | 300 | </dd> |
universe@390 | 301 | </dl> |
universe@390 | 302 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="mempool_8h.html#adb788e7ec24cd7dbdea6381539c549f2" title="Sets a destructor function for the specified memory. ">ucx_mempool_set_destr()</a> </dd></dl> |
universe@390 | 303 | |
universe@390 | 304 | </div> |
universe@390 | 305 | </div> |
universe@390 | 306 | <a id="a2ae492b8f2878ccc9837ac213dced11e"></a> |
universe@390 | 307 | <h2 class="memtitle"><span class="permalink"><a href="#a2ae492b8f2878ccc9837ac213dced11e">◆ </a></span>ucx_mempool_malloc()</h2> |
universe@390 | 308 | |
universe@390 | 309 | <div class="memitem"> |
universe@390 | 310 | <div class="memproto"> |
universe@390 | 311 | <table class="memname"> |
universe@390 | 312 | <tr> |
universe@390 | 313 | <td class="memname">void* ucx_mempool_malloc </td> |
universe@390 | 314 | <td>(</td> |
universe@390 | 315 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 316 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 317 | </tr> |
universe@390 | 318 | <tr> |
universe@390 | 319 | <td class="paramkey"></td> |
universe@390 | 320 | <td></td> |
universe@390 | 321 | <td class="paramtype">size_t </td> |
universe@390 | 322 | <td class="paramname"><em>n</em> </td> |
universe@390 | 323 | </tr> |
universe@390 | 324 | <tr> |
universe@390 | 325 | <td></td> |
universe@390 | 326 | <td>)</td> |
universe@390 | 327 | <td></td><td></td> |
universe@390 | 328 | </tr> |
universe@390 | 329 | </table> |
universe@390 | 330 | </div><div class="memdoc"> |
universe@390 | 331 | |
universe@390 | 332 | <p>Allocates pooled memory. </p> |
universe@390 | 333 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 334 | <table class="params"> |
universe@390 | 335 | <tr><td class="paramname">pool</td><td>the memory pool </td></tr> |
universe@390 | 336 | <tr><td class="paramname">n</td><td>amount of memory to allocate </td></tr> |
universe@390 | 337 | </table> |
universe@390 | 338 | </dd> |
universe@390 | 339 | </dl> |
universe@390 | 340 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory </dd></dl> |
universe@390 | 341 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473" title="A function pointer to the allocators malloc() function. ">ucx_allocator_malloc()</a> </dd></dl> |
universe@390 | 342 | |
universe@390 | 343 | </div> |
universe@390 | 344 | </div> |
universe@390 | 345 | <a id="ad71cb8c3b6fdb30360376a8b372ef22a"></a> |
universe@390 | 346 | <h2 class="memtitle"><span class="permalink"><a href="#ad71cb8c3b6fdb30360376a8b372ef22a">◆ </a></span>ucx_mempool_new()</h2> |
universe@390 | 347 | |
universe@390 | 348 | <div class="memitem"> |
universe@390 | 349 | <div class="memproto"> |
universe@390 | 350 | <table class="memname"> |
universe@390 | 351 | <tr> |
universe@390 | 352 | <td class="memname"><a class="el" href="structUcxMempool.html">UcxMempool</a>* ucx_mempool_new </td> |
universe@390 | 353 | <td>(</td> |
universe@390 | 354 | <td class="paramtype">size_t </td> |
universe@390 | 355 | <td class="paramname"><em>n</em></td><td>)</td> |
universe@390 | 356 | <td></td> |
universe@390 | 357 | </tr> |
universe@390 | 358 | </table> |
universe@390 | 359 | </div><div class="memdoc"> |
universe@390 | 360 | |
universe@390 | 361 | <p>Creates a memory pool with the specified initial size. </p> |
universe@390 | 362 | <p>As the created memory pool automatically grows in size by factor two when trying to allocate memory on a full pool, it is recommended that you use a power of two for the initial size.</p> |
universe@390 | 363 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 364 | <table class="params"> |
universe@390 | 365 | <tr><td class="paramname">n</td><td>initial pool size (should be a power of two, e.g. 16) </td></tr> |
universe@390 | 366 | </table> |
universe@390 | 367 | </dd> |
universe@390 | 368 | </dl> |
universe@390 | 369 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the new memory pool </dd></dl> |
universe@390 | 370 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="mempool_8h.html#a49f7bd1da5ac201d0cf54dc0f0d82dd2" title="Shorthand for a new default memory pool with a capacity of 16 elements. ">ucx_mempool_new_default()</a> </dd></dl> |
universe@390 | 371 | |
universe@390 | 372 | </div> |
universe@390 | 373 | </div> |
universe@390 | 374 | <a id="a660ef42520ed6737c2e77aae18e3a7a4"></a> |
universe@390 | 375 | <h2 class="memtitle"><span class="permalink"><a href="#a660ef42520ed6737c2e77aae18e3a7a4">◆ </a></span>ucx_mempool_realloc()</h2> |
universe@390 | 376 | |
universe@390 | 377 | <div class="memitem"> |
universe@390 | 378 | <div class="memproto"> |
universe@390 | 379 | <table class="memname"> |
universe@390 | 380 | <tr> |
universe@390 | 381 | <td class="memname">void* ucx_mempool_realloc </td> |
universe@390 | 382 | <td>(</td> |
universe@390 | 383 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 384 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 385 | </tr> |
universe@390 | 386 | <tr> |
universe@390 | 387 | <td class="paramkey"></td> |
universe@390 | 388 | <td></td> |
universe@390 | 389 | <td class="paramtype">void * </td> |
universe@390 | 390 | <td class="paramname"><em>ptr</em>, </td> |
universe@390 | 391 | </tr> |
universe@390 | 392 | <tr> |
universe@390 | 393 | <td class="paramkey"></td> |
universe@390 | 394 | <td></td> |
universe@390 | 395 | <td class="paramtype">size_t </td> |
universe@390 | 396 | <td class="paramname"><em>n</em> </td> |
universe@390 | 397 | </tr> |
universe@390 | 398 | <tr> |
universe@390 | 399 | <td></td> |
universe@390 | 400 | <td>)</td> |
universe@390 | 401 | <td></td><td></td> |
universe@390 | 402 | </tr> |
universe@390 | 403 | </table> |
universe@390 | 404 | </div><div class="memdoc"> |
universe@390 | 405 | |
universe@390 | 406 | <p>Reallocates pooled memory. </p> |
universe@390 | 407 | <p>If the memory to be reallocated is not contained by the specified pool, the behavior is undefined.</p> |
universe@390 | 408 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 409 | <table class="params"> |
universe@390 | 410 | <tr><td class="paramname">pool</td><td>the memory pool </td></tr> |
universe@390 | 411 | <tr><td class="paramname">ptr</td><td>a pointer to the memory that shall be reallocated </td></tr> |
universe@390 | 412 | <tr><td class="paramname">n</td><td>the new size of the memory </td></tr> |
universe@390 | 413 | </table> |
universe@390 | 414 | </dd> |
universe@390 | 415 | </dl> |
universe@390 | 416 | <dl class="section return"><dt>Returns</dt><dd>a pointer to the new location of the memory </dd></dl> |
universe@390 | 417 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426" title="A function pointer to the allocators realloc() function. ">ucx_allocator_realloc()</a> </dd></dl> |
universe@390 | 418 | |
universe@390 | 419 | </div> |
universe@390 | 420 | </div> |
universe@390 | 421 | <a id="af47b6b7c40f8f263dc28cc9a4e77b27c"></a> |
universe@390 | 422 | <h2 class="memtitle"><span class="permalink"><a href="#af47b6b7c40f8f263dc28cc9a4e77b27c">◆ </a></span>ucx_mempool_reg_destr()</h2> |
universe@390 | 423 | |
universe@390 | 424 | <div class="memitem"> |
universe@390 | 425 | <div class="memproto"> |
universe@390 | 426 | <table class="memname"> |
universe@390 | 427 | <tr> |
universe@390 | 428 | <td class="memname">void ucx_mempool_reg_destr </td> |
universe@390 | 429 | <td>(</td> |
universe@390 | 430 | <td class="paramtype"><a class="el" href="structUcxMempool.html">UcxMempool</a> * </td> |
universe@390 | 431 | <td class="paramname"><em>pool</em>, </td> |
universe@390 | 432 | </tr> |
universe@390 | 433 | <tr> |
universe@390 | 434 | <td class="paramkey"></td> |
universe@390 | 435 | <td></td> |
universe@390 | 436 | <td class="paramtype">void * </td> |
universe@390 | 437 | <td class="paramname"><em>ptr</em>, </td> |
universe@390 | 438 | </tr> |
universe@390 | 439 | <tr> |
universe@390 | 440 | <td class="paramkey"></td> |
universe@390 | 441 | <td></td> |
universe@390 | 442 | <td class="paramtype"><a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> </td> |
universe@390 | 443 | <td class="paramname"><em>destr</em> </td> |
universe@390 | 444 | </tr> |
universe@390 | 445 | <tr> |
universe@390 | 446 | <td></td> |
universe@390 | 447 | <td>)</td> |
universe@390 | 448 | <td></td><td></td> |
universe@390 | 449 | </tr> |
universe@390 | 450 | </table> |
universe@390 | 451 | </div><div class="memdoc"> |
universe@390 | 452 | |
universe@390 | 453 | <p>Registers a destructor function for the specified (non-pooled) memory. </p> |
universe@390 | 454 | <p>This is useful, if you have memory that has not been allocated by a mempool, but shall be managed by a mempool.</p> |
universe@390 | 455 | <p>This function creates an entry in the specified mempool and the memory will therefore (logically) convert to pooled memory. <b>However, this does not cause the memory to be freed automatically!</b>. If you want to use this function, make the memory pool free non-pooled memory, the specified destructor function must call <code>free()</code> by itself. But keep in mind, that you then MUST NOT use this destructor function with pooled memory (e.g. in <a class="el" href="mempool_8h.html#adb788e7ec24cd7dbdea6381539c549f2" title="Sets a destructor function for the specified memory. ">ucx_mempool_set_destr()</a>), as it would cause a double-free.</p> |
universe@390 | 456 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 457 | <table class="params"> |
universe@390 | 458 | <tr><td class="paramname">pool</td><td>the memory pool </td></tr> |
universe@390 | 459 | <tr><td class="paramname">ptr</td><td>data the destructor is registered for </td></tr> |
universe@390 | 460 | <tr><td class="paramname">destr</td><td>a pointer to the destructor function </td></tr> |
universe@390 | 461 | </table> |
universe@390 | 462 | </dd> |
universe@390 | 463 | </dl> |
universe@390 | 464 | |
universe@390 | 465 | </div> |
universe@390 | 466 | </div> |
universe@390 | 467 | <a id="adb788e7ec24cd7dbdea6381539c549f2"></a> |
universe@390 | 468 | <h2 class="memtitle"><span class="permalink"><a href="#adb788e7ec24cd7dbdea6381539c549f2">◆ </a></span>ucx_mempool_set_destr()</h2> |
universe@390 | 469 | |
universe@390 | 470 | <div class="memitem"> |
universe@390 | 471 | <div class="memproto"> |
universe@390 | 472 | <table class="memname"> |
universe@390 | 473 | <tr> |
universe@390 | 474 | <td class="memname">void ucx_mempool_set_destr </td> |
universe@390 | 475 | <td>(</td> |
universe@390 | 476 | <td class="paramtype">void * </td> |
universe@390 | 477 | <td class="paramname"><em>ptr</em>, </td> |
universe@390 | 478 | </tr> |
universe@390 | 479 | <tr> |
universe@390 | 480 | <td class="paramkey"></td> |
universe@390 | 481 | <td></td> |
universe@390 | 482 | <td class="paramtype"><a class="el" href="ucx_8h.html#ad2b370c2809914c8b7fedab163c266b3">ucx_destructor</a> </td> |
universe@390 | 483 | <td class="paramname"><em>func</em> </td> |
universe@390 | 484 | </tr> |
universe@390 | 485 | <tr> |
universe@390 | 486 | <td></td> |
universe@390 | 487 | <td>)</td> |
universe@390 | 488 | <td></td><td></td> |
universe@390 | 489 | </tr> |
universe@390 | 490 | </table> |
universe@390 | 491 | </div><div class="memdoc"> |
universe@390 | 492 | |
universe@390 | 493 | <p>Sets a destructor function for the specified memory. </p> |
universe@390 | 494 | <p>The destructor is automatically called when the memory is freed or the pool is destroyed. A destructor for pooled memory <b>MUST NOT</b> free the memory itself, as this is done by the pool. Use a destructor to free any resources managed by the pooled object.</p> |
universe@390 | 495 | <p>The only requirement for the specified memory is, that it <b>MUST</b> be pooled memory by a <a class="el" href="structUcxMempool.html" title="UCX mempool structure. ">UcxMempool</a> or an element-compatible mempool. The pointer to the destructor function is saved in a reserved area before the actual memory.</p> |
universe@390 | 496 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 497 | <table class="params"> |
universe@390 | 498 | <tr><td class="paramname">ptr</td><td>pooled memory </td></tr> |
universe@390 | 499 | <tr><td class="paramname">func</td><td>a pointer to the destructor function </td></tr> |
universe@390 | 500 | </table> |
universe@390 | 501 | </dd> |
universe@390 | 502 | </dl> |
universe@390 | 503 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="mempool_8h.html#aefa26e3015f5aefadbfc74221bd246ac" title="Frees pooled memory. ">ucx_mempool_free()</a> </dd> |
universe@390 | 504 | <dd> |
universe@390 | 505 | <a class="el" href="mempool_8h.html#af096378da7e9bfbed3088497cf4c15bf" title="Destroys a memory pool. ">ucx_mempool_destroy()</a> </dd></dl> |
universe@390 | 506 | |
universe@390 | 507 | </div> |
universe@390 | 508 | </div> |
universe@390 | 509 | </div><!-- contents --> |
universe@390 | 510 | <!-- start footer part --> |
universe@390 | 511 | <hr class="footer"/><address class="footer"><small> |
universe@390 | 512 | Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html"> |
universe@390 | 513 | <img class="footer" src="doxygen.png" alt="doxygen"/> |
universe@390 | 514 | </a> 1.8.13 |
universe@390 | 515 | </small></address> |
universe@390 | 516 | </body> |
universe@390 | 517 | </html> |