1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/allocator_8h.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,600 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
1.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/allocator.h File Reference</title>
1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
1.13 +<script type="text/javascript" src="jquery.js"></script>
1.14 +<script type="text/javascript" src="dynsections.js"></script>
1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
1.17 +<script type="text/javascript" src="search/search.js"></script>
1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
1.19 +</head>
1.20 +<body>
1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
1.22 +<div id="titlearea">
1.23 +<table cellspacing="0" cellpadding="0">
1.24 + <tbody>
1.25 + <tr style="height: 56px;">
1.26 + <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
1.27 + <td id="projectalign" style="padding-left: 0.5em;">
1.28 + <div id="projectname">ucx
1.29 + </div>
1.30 + <div id="projectbrief">UAP Common Extensions</div>
1.31 + </td>
1.32 + </tr>
1.33 + </tbody>
1.34 +</table>
1.35 +</div>
1.36 +<!-- end header part -->
1.37 +<!-- Generated by Doxygen 1.8.13 -->
1.38 +<script type="text/javascript">
1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
1.40 +</script>
1.41 +<script type="text/javascript" src="menudata.js"></script>
1.42 +<script type="text/javascript" src="menu.js"></script>
1.43 +<script type="text/javascript">
1.44 +$(function() {
1.45 + initMenu('',true,false,'search.php','Search');
1.46 + $(document).ready(function() { init_search(); });
1.47 +});
1.48 +</script>
1.49 +<div id="main-nav"></div>
1.50 +<!-- window showing the filter options -->
1.51 +<div id="MSearchSelectWindow"
1.52 + onmouseover="return searchBox.OnSearchSelectShow()"
1.53 + onmouseout="return searchBox.OnSearchSelectHide()"
1.54 + onkeydown="return searchBox.OnSearchSelectKey(event)">
1.55 +</div>
1.56 +
1.57 +<!-- iframe showing the search results (closed by default) -->
1.58 +<div id="MSearchResultsWindow">
1.59 +<iframe src="javascript:void(0)" frameborder="0"
1.60 + name="MSearchResults" id="MSearchResults">
1.61 +</iframe>
1.62 +</div>
1.63 +
1.64 +<div id="nav-path" class="navpath">
1.65 + <ul>
1.66 +<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>
1.67 +</div>
1.68 +</div><!-- top -->
1.69 +<div class="header">
1.70 + <div class="summary">
1.71 +<a href="#nested-classes">Data Structures</a> |
1.72 +<a href="#define-members">Macros</a> |
1.73 +<a href="#typedef-members">Typedefs</a> |
1.74 +<a href="#func-members">Functions</a> </div>
1.75 + <div class="headertitle">
1.76 +<div class="title">allocator.h File Reference</div> </div>
1.77 +</div><!--header-->
1.78 +<div class="contents">
1.79 +
1.80 +<p>Allocator for custom memory management.
1.81 +<a href="#details">More...</a></p>
1.82 +<div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br />
1.83 +</div>
1.84 +<p><a href="allocator_8h_source.html">Go to the source code of this file.</a></p>
1.85 +<table class="memberdecls">
1.86 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
1.87 +Data Structures</h2></td></tr>
1.88 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxAllocator.html">UcxAllocator</a></td></tr>
1.89 +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UCX allocator data structure containing memory management functions. <a href="structUcxAllocator.html#details">More...</a><br /></td></tr>
1.90 +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
1.91 +</table><table class="memberdecls">
1.92 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
1.93 +Macros</h2></td></tr>
1.94 +<tr class="memitem:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#ae1bc218fea8a35f4a3706f0beefcfb19">almalloc</a>(allocator, n)   ((allocator)->malloc((allocator)->pool, n))</td></tr>
1.95 +<tr class="memdesc:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for calling an allocators malloc function. <a href="#ae1bc218fea8a35f4a3706f0beefcfb19">More...</a><br /></td></tr>
1.96 +<tr class="separator:ae1bc218fea8a35f4a3706f0beefcfb19"><td class="memSeparator" colspan="2"> </td></tr>
1.97 +<tr class="memitem:a8d71470816f88f78cb9a9686c57e1b10"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a8d71470816f88f78cb9a9686c57e1b10">alcalloc</a>(allocator, n, size)   ((allocator)->calloc((allocator)->pool, n, size))</td></tr>
1.98 +<tr class="memdesc:a8d71470816f88f78cb9a9686c57e1b10"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for calling an allocators calloc function. <a href="#a8d71470816f88f78cb9a9686c57e1b10">More...</a><br /></td></tr>
1.99 +<tr class="separator:a8d71470816f88f78cb9a9686c57e1b10"><td class="memSeparator" colspan="2"> </td></tr>
1.100 +<tr class="memitem:a029ee5c9bcbb3f873571553f788c5820"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a029ee5c9bcbb3f873571553f788c5820">alrealloc</a>(allocator, ptr, n)   ((allocator)->realloc((allocator)->pool, ptr, n))</td></tr>
1.101 +<tr class="memdesc:a029ee5c9bcbb3f873571553f788c5820"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for calling an allocators realloc function. <a href="#a029ee5c9bcbb3f873571553f788c5820">More...</a><br /></td></tr>
1.102 +<tr class="separator:a029ee5c9bcbb3f873571553f788c5820"><td class="memSeparator" colspan="2"> </td></tr>
1.103 +<tr class="memitem:acd775785b54e97dc2b33a432c12c8fb2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#acd775785b54e97dc2b33a432c12c8fb2">alfree</a>(allocator, ptr)   ((allocator)->free((allocator)->pool, ptr))</td></tr>
1.104 +<tr class="memdesc:acd775785b54e97dc2b33a432c12c8fb2"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for calling an allocators free function. <a href="#acd775785b54e97dc2b33a432c12c8fb2">More...</a><br /></td></tr>
1.105 +<tr class="separator:acd775785b54e97dc2b33a432c12c8fb2"><td class="memSeparator" colspan="2"> </td></tr>
1.106 +<tr class="memitem:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f">UCX_ALLOCATOR_DEFAULT</a></td></tr>
1.107 +<tr class="memdesc:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="mdescLeft"> </td><td class="mdescRight">Convenient macro for a default allocator <code>struct</code> definition. <a href="#a1283a8f875f90a7af3aba5e031fc2e3f">More...</a><br /></td></tr>
1.108 +<tr class="separator:a1283a8f875f90a7af3aba5e031fc2e3f"><td class="memSeparator" colspan="2"> </td></tr>
1.109 +</table><table class="memberdecls">
1.110 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
1.111 +Typedefs</h2></td></tr>
1.112 +<tr class="memitem:a29f0f6a23a70db3b60635cd6dc384473"><td class="memItemLeft" align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a29f0f6a23a70db3b60635cd6dc384473">ucx_allocator_malloc</a>) (void *pool, size_t n)</td></tr>
1.113 +<tr class="memdesc:a29f0f6a23a70db3b60635cd6dc384473"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer to the allocators <code>malloc()</code> function. <a href="#a29f0f6a23a70db3b60635cd6dc384473">More...</a><br /></td></tr>
1.114 +<tr class="separator:a29f0f6a23a70db3b60635cd6dc384473"><td class="memSeparator" colspan="2"> </td></tr>
1.115 +<tr class="memitem:a2c0aba4221c1ac6801f03ed799f15b12"><td class="memItemLeft" align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a2c0aba4221c1ac6801f03ed799f15b12">ucx_allocator_calloc</a>) (void *pool, size_t n, size_t size)</td></tr>
1.116 +<tr class="memdesc:a2c0aba4221c1ac6801f03ed799f15b12"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer to the allocators <code>calloc()</code> function. <a href="#a2c0aba4221c1ac6801f03ed799f15b12">More...</a><br /></td></tr>
1.117 +<tr class="separator:a2c0aba4221c1ac6801f03ed799f15b12"><td class="memSeparator" colspan="2"> </td></tr>
1.118 +<tr class="memitem:a6d7cf038a806e327c5da37321d04e426"><td class="memItemLeft" align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a6d7cf038a806e327c5da37321d04e426">ucx_allocator_realloc</a>) (void *pool, void *data, size_t n)</td></tr>
1.119 +<tr class="memdesc:a6d7cf038a806e327c5da37321d04e426"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer to the allocators <code>realloc()</code> function. <a href="#a6d7cf038a806e327c5da37321d04e426">More...</a><br /></td></tr>
1.120 +<tr class="separator:a6d7cf038a806e327c5da37321d04e426"><td class="memSeparator" colspan="2"> </td></tr>
1.121 +<tr class="memitem:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#aaf2387ddaddd8ab4b267e6b00e5d6f7e">ucx_allocator_free</a>) (void *pool, void *data)</td></tr>
1.122 +<tr class="memdesc:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer to the allocators <code>free()</code> function. <a href="#aaf2387ddaddd8ab4b267e6b00e5d6f7e">More...</a><br /></td></tr>
1.123 +<tr class="separator:aaf2387ddaddd8ab4b267e6b00e5d6f7e"><td class="memSeparator" colspan="2"> </td></tr>
1.124 +</table><table class="memberdecls">
1.125 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
1.126 +Functions</h2></td></tr>
1.127 +<tr class="memitem:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxAllocator.html">UcxAllocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a98d2f1b341118b7a0e341fda5d8b2ebf">ucx_default_allocator</a> ()</td></tr>
1.128 +<tr class="memdesc:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the default allocator. <a href="#a98d2f1b341118b7a0e341fda5d8b2ebf">More...</a><br /></td></tr>
1.129 +<tr class="separator:a98d2f1b341118b7a0e341fda5d8b2ebf"><td class="memSeparator" colspan="2"> </td></tr>
1.130 +<tr class="memitem:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a96403ebf3d2312d95f2fe7627a1cdbc0">ucx_default_malloc</a> (void *ignore, size_t n)</td></tr>
1.131 +<tr class="memdesc:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for the standard libc <code>malloc()</code> function. <a href="#a96403ebf3d2312d95f2fe7627a1cdbc0">More...</a><br /></td></tr>
1.132 +<tr class="separator:a96403ebf3d2312d95f2fe7627a1cdbc0"><td class="memSeparator" colspan="2"> </td></tr>
1.133 +<tr class="memitem:a3a0bfdd13d887012309c459b339f338f"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a> (void *ignore, size_t n, size_t size)</td></tr>
1.134 +<tr class="memdesc:a3a0bfdd13d887012309c459b339f338f"><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for the standard libc <code>calloc()</code> function. <a href="#a3a0bfdd13d887012309c459b339f338f">More...</a><br /></td></tr>
1.135 +<tr class="separator:a3a0bfdd13d887012309c459b339f338f"><td class="memSeparator" colspan="2"> </td></tr>
1.136 +<tr class="memitem:a47cfc8af626a86fcb93a2b14b90498ed"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a> (void *ignore, void *data, size_t n)</td></tr>
1.137 +<tr class="memdesc:a47cfc8af626a86fcb93a2b14b90498ed"><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for the standard libc <code>realloc()</code> function. <a href="#a47cfc8af626a86fcb93a2b14b90498ed">More...</a><br /></td></tr>
1.138 +<tr class="separator:a47cfc8af626a86fcb93a2b14b90498ed"><td class="memSeparator" colspan="2"> </td></tr>
1.139 +<tr class="memitem:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="allocator_8h.html#a646d83aaaadfe33ae414c0fad8bfc52a">ucx_default_free</a> (void *ignore, void *data)</td></tr>
1.140 +<tr class="memdesc:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for the standard libc <code>free()</code> function. <a href="#a646d83aaaadfe33ae414c0fad8bfc52a">More...</a><br /></td></tr>
1.141 +<tr class="separator:a646d83aaaadfe33ae414c0fad8bfc52a"><td class="memSeparator" colspan="2"> </td></tr>
1.142 +</table>
1.143 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.144 +<div class="textblock"><p>Allocator for custom memory management. </p>
1.145 +<p>A UCX allocator consists of a pointer to the memory area / pool and four function pointers to memory management functions operating on this memory area / pool. These functions shall behave equivalent to the standard libc functions <code>malloc(), calloc(), realloc()</code> and <code>free()</code>.</p>
1.146 +<p>The signature of the memory management functions is based on the signature of the respective libc function but each of them takes the pointer to the memory area / pool as first argument.</p>
1.147 +<p>As the pointer to the memory area / pool can be arbitrarily chosen, any data can be provided to the memory management functions. A <a class="el" href="structUcxMempool.html" title="UCX mempool structure. ">UcxMempool</a> is just one example.</p>
1.148 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="mempool_8h.html" title="Memory pool implementation. ">mempool.h</a> </dd>
1.149 +<dd>
1.150 +<a class="el" href="structUcxMap.html" title="Structure for the UCX map. ">UcxMap</a></dd></dl>
1.151 +<dl class="section author"><dt>Author</dt><dd>Mike Becker </dd>
1.152 +<dd>
1.153 +Olaf Wintermann </dd></dl>
1.154 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
1.155 +<a id="a8d71470816f88f78cb9a9686c57e1b10"></a>
1.156 +<h2 class="memtitle"><span class="permalink"><a href="#a8d71470816f88f78cb9a9686c57e1b10">◆ </a></span>alcalloc</h2>
1.157 +
1.158 +<div class="memitem">
1.159 +<div class="memproto">
1.160 + <table class="memname">
1.161 + <tr>
1.162 + <td class="memname">#define alcalloc</td>
1.163 + <td>(</td>
1.164 + <td class="paramtype"> </td>
1.165 + <td class="paramname">allocator, </td>
1.166 + </tr>
1.167 + <tr>
1.168 + <td class="paramkey"></td>
1.169 + <td></td>
1.170 + <td class="paramtype"> </td>
1.171 + <td class="paramname">n, </td>
1.172 + </tr>
1.173 + <tr>
1.174 + <td class="paramkey"></td>
1.175 + <td></td>
1.176 + <td class="paramtype"> </td>
1.177 + <td class="paramname">size </td>
1.178 + </tr>
1.179 + <tr>
1.180 + <td></td>
1.181 + <td>)</td>
1.182 + <td></td><td>   ((allocator)->calloc((allocator)->pool, n, size))</td>
1.183 + </tr>
1.184 + </table>
1.185 +</div><div class="memdoc">
1.186 +
1.187 +<p>Shorthand for calling an allocators calloc function. </p>
1.188 +<dl class="params"><dt>Parameters</dt><dd>
1.189 + <table class="params">
1.190 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.191 + <tr><td class="paramname">n</td><td>the count of elements the space should be allocated for </td></tr>
1.192 + <tr><td class="paramname">size</td><td>the size of each element </td></tr>
1.193 + </table>
1.194 + </dd>
1.195 +</dl>
1.196 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory area </dd></dl>
1.197 +
1.198 +</div>
1.199 +</div>
1.200 +<a id="acd775785b54e97dc2b33a432c12c8fb2"></a>
1.201 +<h2 class="memtitle"><span class="permalink"><a href="#acd775785b54e97dc2b33a432c12c8fb2">◆ </a></span>alfree</h2>
1.202 +
1.203 +<div class="memitem">
1.204 +<div class="memproto">
1.205 + <table class="memname">
1.206 + <tr>
1.207 + <td class="memname">#define alfree</td>
1.208 + <td>(</td>
1.209 + <td class="paramtype"> </td>
1.210 + <td class="paramname">allocator, </td>
1.211 + </tr>
1.212 + <tr>
1.213 + <td class="paramkey"></td>
1.214 + <td></td>
1.215 + <td class="paramtype"> </td>
1.216 + <td class="paramname">ptr </td>
1.217 + </tr>
1.218 + <tr>
1.219 + <td></td>
1.220 + <td>)</td>
1.221 + <td></td><td>   ((allocator)->free((allocator)->pool, ptr))</td>
1.222 + </tr>
1.223 + </table>
1.224 +</div><div class="memdoc">
1.225 +
1.226 +<p>Shorthand for calling an allocators free function. </p>
1.227 +<dl class="params"><dt>Parameters</dt><dd>
1.228 + <table class="params">
1.229 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.230 + <tr><td class="paramname">ptr</td><td>the pointer to the memory area that shall be freed </td></tr>
1.231 + </table>
1.232 + </dd>
1.233 +</dl>
1.234 +
1.235 +</div>
1.236 +</div>
1.237 +<a id="ae1bc218fea8a35f4a3706f0beefcfb19"></a>
1.238 +<h2 class="memtitle"><span class="permalink"><a href="#ae1bc218fea8a35f4a3706f0beefcfb19">◆ </a></span>almalloc</h2>
1.239 +
1.240 +<div class="memitem">
1.241 +<div class="memproto">
1.242 + <table class="memname">
1.243 + <tr>
1.244 + <td class="memname">#define almalloc</td>
1.245 + <td>(</td>
1.246 + <td class="paramtype"> </td>
1.247 + <td class="paramname">allocator, </td>
1.248 + </tr>
1.249 + <tr>
1.250 + <td class="paramkey"></td>
1.251 + <td></td>
1.252 + <td class="paramtype"> </td>
1.253 + <td class="paramname">n </td>
1.254 + </tr>
1.255 + <tr>
1.256 + <td></td>
1.257 + <td>)</td>
1.258 + <td></td><td>   ((allocator)->malloc((allocator)->pool, n))</td>
1.259 + </tr>
1.260 + </table>
1.261 +</div><div class="memdoc">
1.262 +
1.263 +<p>Shorthand for calling an allocators malloc function. </p>
1.264 +<dl class="params"><dt>Parameters</dt><dd>
1.265 + <table class="params">
1.266 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.267 + <tr><td class="paramname">n</td><td>size of space to allocate </td></tr>
1.268 + </table>
1.269 + </dd>
1.270 +</dl>
1.271 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory area </dd></dl>
1.272 +
1.273 +</div>
1.274 +</div>
1.275 +<a id="a029ee5c9bcbb3f873571553f788c5820"></a>
1.276 +<h2 class="memtitle"><span class="permalink"><a href="#a029ee5c9bcbb3f873571553f788c5820">◆ </a></span>alrealloc</h2>
1.277 +
1.278 +<div class="memitem">
1.279 +<div class="memproto">
1.280 + <table class="memname">
1.281 + <tr>
1.282 + <td class="memname">#define alrealloc</td>
1.283 + <td>(</td>
1.284 + <td class="paramtype"> </td>
1.285 + <td class="paramname">allocator, </td>
1.286 + </tr>
1.287 + <tr>
1.288 + <td class="paramkey"></td>
1.289 + <td></td>
1.290 + <td class="paramtype"> </td>
1.291 + <td class="paramname">ptr, </td>
1.292 + </tr>
1.293 + <tr>
1.294 + <td class="paramkey"></td>
1.295 + <td></td>
1.296 + <td class="paramtype"> </td>
1.297 + <td class="paramname">n </td>
1.298 + </tr>
1.299 + <tr>
1.300 + <td></td>
1.301 + <td>)</td>
1.302 + <td></td><td>   ((allocator)->realloc((allocator)->pool, ptr, n))</td>
1.303 + </tr>
1.304 + </table>
1.305 +</div><div class="memdoc">
1.306 +
1.307 +<p>Shorthand for calling an allocators realloc function. </p>
1.308 +<dl class="params"><dt>Parameters</dt><dd>
1.309 + <table class="params">
1.310 + <tr><td class="paramname">allocator</td><td>the allocator to use </td></tr>
1.311 + <tr><td class="paramname">ptr</td><td>the pointer to the memory area that shall be reallocated </td></tr>
1.312 + <tr><td class="paramname">n</td><td>the new size of the allocated memory area </td></tr>
1.313 + </table>
1.314 + </dd>
1.315 +</dl>
1.316 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the reallocated memory area </dd></dl>
1.317 +
1.318 +</div>
1.319 +</div>
1.320 +<a id="a1283a8f875f90a7af3aba5e031fc2e3f"></a>
1.321 +<h2 class="memtitle"><span class="permalink"><a href="#a1283a8f875f90a7af3aba5e031fc2e3f">◆ </a></span>UCX_ALLOCATOR_DEFAULT</h2>
1.322 +
1.323 +<div class="memitem">
1.324 +<div class="memproto">
1.325 + <table class="memname">
1.326 + <tr>
1.327 + <td class="memname">#define UCX_ALLOCATOR_DEFAULT</td>
1.328 + </tr>
1.329 + </table>
1.330 +</div><div class="memdoc">
1.331 +<b>Value:</b><div class="fragment"><div class="line">{NULL, \</div><div class="line"> ucx_default_malloc, <a class="code" href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a>, <a class="code" href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a>, \</div><div class="line"> ucx_default_free }</div><div class="ttc" id="allocator_8h_html_a3a0bfdd13d887012309c459b339f338f"><div class="ttname"><a href="allocator_8h.html#a3a0bfdd13d887012309c459b339f338f">ucx_default_calloc</a></div><div class="ttdeci">void * ucx_default_calloc(void *ignore, size_t n, size_t size)</div><div class="ttdoc">A wrapper for the standard libc calloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:50</div></div>
1.332 +<div class="ttc" id="allocator_8h_html_a47cfc8af626a86fcb93a2b14b90498ed"><div class="ttname"><a href="allocator_8h.html#a47cfc8af626a86fcb93a2b14b90498ed">ucx_default_realloc</a></div><div class="ttdeci">void * ucx_default_realloc(void *ignore, void *data, size_t n)</div><div class="ttdoc">A wrapper for the standard libc realloc() function. </div><div class="ttdef"><b>Definition:</b> allocator.c:54</div></div>
1.333 +</div><!-- fragment -->
1.334 +<p>Convenient macro for a default allocator <code>struct</code> definition. </p>
1.335 +
1.336 +</div>
1.337 +</div>
1.338 +<h2 class="groupheader">Typedef Documentation</h2>
1.339 +<a id="a2c0aba4221c1ac6801f03ed799f15b12"></a>
1.340 +<h2 class="memtitle"><span class="permalink"><a href="#a2c0aba4221c1ac6801f03ed799f15b12">◆ </a></span>ucx_allocator_calloc</h2>
1.341 +
1.342 +<div class="memitem">
1.343 +<div class="memproto">
1.344 + <table class="memname">
1.345 + <tr>
1.346 + <td class="memname">typedef void*(* ucx_allocator_calloc) (void *pool, size_t n, size_t size)</td>
1.347 + </tr>
1.348 + </table>
1.349 +</div><div class="memdoc">
1.350 +
1.351 +<p>A function pointer to the allocators <code>calloc()</code> function. </p>
1.352 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
1.353 +
1.354 +</div>
1.355 +</div>
1.356 +<a id="aaf2387ddaddd8ab4b267e6b00e5d6f7e"></a>
1.357 +<h2 class="memtitle"><span class="permalink"><a href="#aaf2387ddaddd8ab4b267e6b00e5d6f7e">◆ </a></span>ucx_allocator_free</h2>
1.358 +
1.359 +<div class="memitem">
1.360 +<div class="memproto">
1.361 + <table class="memname">
1.362 + <tr>
1.363 + <td class="memname">typedef void(* ucx_allocator_free) (void *pool, void *data)</td>
1.364 + </tr>
1.365 + </table>
1.366 +</div><div class="memdoc">
1.367 +
1.368 +<p>A function pointer to the allocators <code>free()</code> function. </p>
1.369 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
1.370 +
1.371 +</div>
1.372 +</div>
1.373 +<a id="a29f0f6a23a70db3b60635cd6dc384473"></a>
1.374 +<h2 class="memtitle"><span class="permalink"><a href="#a29f0f6a23a70db3b60635cd6dc384473">◆ </a></span>ucx_allocator_malloc</h2>
1.375 +
1.376 +<div class="memitem">
1.377 +<div class="memproto">
1.378 + <table class="memname">
1.379 + <tr>
1.380 + <td class="memname">typedef void*(* ucx_allocator_malloc) (void *pool, size_t n)</td>
1.381 + </tr>
1.382 + </table>
1.383 +</div><div class="memdoc">
1.384 +
1.385 +<p>A function pointer to the allocators <code>malloc()</code> function. </p>
1.386 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
1.387 +
1.388 +</div>
1.389 +</div>
1.390 +<a id="a6d7cf038a806e327c5da37321d04e426"></a>
1.391 +<h2 class="memtitle"><span class="permalink"><a href="#a6d7cf038a806e327c5da37321d04e426">◆ </a></span>ucx_allocator_realloc</h2>
1.392 +
1.393 +<div class="memitem">
1.394 +<div class="memproto">
1.395 + <table class="memname">
1.396 + <tr>
1.397 + <td class="memname">typedef void*(* ucx_allocator_realloc) (void *pool, void *data, size_t n)</td>
1.398 + </tr>
1.399 + </table>
1.400 +</div><div class="memdoc">
1.401 +
1.402 +<p>A function pointer to the allocators <code>realloc()</code> function. </p>
1.403 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> </dd></dl>
1.404 +
1.405 +</div>
1.406 +</div>
1.407 +<h2 class="groupheader">Function Documentation</h2>
1.408 +<a id="a98d2f1b341118b7a0e341fda5d8b2ebf"></a>
1.409 +<h2 class="memtitle"><span class="permalink"><a href="#a98d2f1b341118b7a0e341fda5d8b2ebf">◆ </a></span>ucx_default_allocator()</h2>
1.410 +
1.411 +<div class="memitem">
1.412 +<div class="memproto">
1.413 + <table class="memname">
1.414 + <tr>
1.415 + <td class="memname"><a class="el" href="structUcxAllocator.html">UcxAllocator</a>* ucx_default_allocator </td>
1.416 + <td>(</td>
1.417 + <td class="paramname"></td><td>)</td>
1.418 + <td></td>
1.419 + </tr>
1.420 + </table>
1.421 +</div><div class="memdoc">
1.422 +
1.423 +<p>Returns a pointer to the default allocator. </p>
1.424 +<p>The default allocator contains wrappers to the standard libc memory management functions. Use this function to get a pointer to a globally available allocator. You may also define an own <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> by assigning <a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f" title="Convenient macro for a default allocator struct definition. ">UCX_ALLOCATOR_DEFAULT</a> to a variable and pass the address of this variable to any function that takes a <a class="el" href="structUcxAllocator.html" title="UCX allocator data structure containing memory management functions. ">UcxAllocator</a> as argument. Note that using this function is the recommended way of passing a default allocator, thus it never runs out of scope.</p>
1.425 +<dl class="section return"><dt>Returns</dt><dd>a pointer to the default allocator</dd></dl>
1.426 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="allocator_8h.html#a1283a8f875f90a7af3aba5e031fc2e3f" title="Convenient macro for a default allocator struct definition. ">UCX_ALLOCATOR_DEFAULT</a> </dd></dl>
1.427 +
1.428 +</div>
1.429 +</div>
1.430 +<a id="a3a0bfdd13d887012309c459b339f338f"></a>
1.431 +<h2 class="memtitle"><span class="permalink"><a href="#a3a0bfdd13d887012309c459b339f338f">◆ </a></span>ucx_default_calloc()</h2>
1.432 +
1.433 +<div class="memitem">
1.434 +<div class="memproto">
1.435 + <table class="memname">
1.436 + <tr>
1.437 + <td class="memname">void* ucx_default_calloc </td>
1.438 + <td>(</td>
1.439 + <td class="paramtype">void * </td>
1.440 + <td class="paramname"><em>ignore</em>, </td>
1.441 + </tr>
1.442 + <tr>
1.443 + <td class="paramkey"></td>
1.444 + <td></td>
1.445 + <td class="paramtype">size_t </td>
1.446 + <td class="paramname"><em>n</em>, </td>
1.447 + </tr>
1.448 + <tr>
1.449 + <td class="paramkey"></td>
1.450 + <td></td>
1.451 + <td class="paramtype">size_t </td>
1.452 + <td class="paramname"><em>size</em> </td>
1.453 + </tr>
1.454 + <tr>
1.455 + <td></td>
1.456 + <td>)</td>
1.457 + <td></td><td></td>
1.458 + </tr>
1.459 + </table>
1.460 +</div><div class="memdoc">
1.461 +
1.462 +<p>A wrapper for the standard libc <code>calloc()</code> function. </p>
1.463 +<dl class="params"><dt>Parameters</dt><dd>
1.464 + <table class="params">
1.465 + <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
1.466 + <tr><td class="paramname">n</td><td>argument passed to <code>calloc()</code> </td></tr>
1.467 + <tr><td class="paramname">size</td><td>argument passed to <code>calloc()</code> </td></tr>
1.468 + </table>
1.469 + </dd>
1.470 +</dl>
1.471 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>calloc()</code> </dd></dl>
1.472 +
1.473 +</div>
1.474 +</div>
1.475 +<a id="a646d83aaaadfe33ae414c0fad8bfc52a"></a>
1.476 +<h2 class="memtitle"><span class="permalink"><a href="#a646d83aaaadfe33ae414c0fad8bfc52a">◆ </a></span>ucx_default_free()</h2>
1.477 +
1.478 +<div class="memitem">
1.479 +<div class="memproto">
1.480 + <table class="memname">
1.481 + <tr>
1.482 + <td class="memname">void ucx_default_free </td>
1.483 + <td>(</td>
1.484 + <td class="paramtype">void * </td>
1.485 + <td class="paramname"><em>ignore</em>, </td>
1.486 + </tr>
1.487 + <tr>
1.488 + <td class="paramkey"></td>
1.489 + <td></td>
1.490 + <td class="paramtype">void * </td>
1.491 + <td class="paramname"><em>data</em> </td>
1.492 + </tr>
1.493 + <tr>
1.494 + <td></td>
1.495 + <td>)</td>
1.496 + <td></td><td></td>
1.497 + </tr>
1.498 + </table>
1.499 +</div><div class="memdoc">
1.500 +
1.501 +<p>A wrapper for the standard libc <code>free()</code> function. </p>
1.502 +<dl class="params"><dt>Parameters</dt><dd>
1.503 + <table class="params">
1.504 + <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
1.505 + <tr><td class="paramname">data</td><td>argument passed to <code>free()</code> </td></tr>
1.506 + </table>
1.507 + </dd>
1.508 +</dl>
1.509 +
1.510 +</div>
1.511 +</div>
1.512 +<a id="a96403ebf3d2312d95f2fe7627a1cdbc0"></a>
1.513 +<h2 class="memtitle"><span class="permalink"><a href="#a96403ebf3d2312d95f2fe7627a1cdbc0">◆ </a></span>ucx_default_malloc()</h2>
1.514 +
1.515 +<div class="memitem">
1.516 +<div class="memproto">
1.517 + <table class="memname">
1.518 + <tr>
1.519 + <td class="memname">void* ucx_default_malloc </td>
1.520 + <td>(</td>
1.521 + <td class="paramtype">void * </td>
1.522 + <td class="paramname"><em>ignore</em>, </td>
1.523 + </tr>
1.524 + <tr>
1.525 + <td class="paramkey"></td>
1.526 + <td></td>
1.527 + <td class="paramtype">size_t </td>
1.528 + <td class="paramname"><em>n</em> </td>
1.529 + </tr>
1.530 + <tr>
1.531 + <td></td>
1.532 + <td>)</td>
1.533 + <td></td><td></td>
1.534 + </tr>
1.535 + </table>
1.536 +</div><div class="memdoc">
1.537 +
1.538 +<p>A wrapper for the standard libc <code>malloc()</code> function. </p>
1.539 +<dl class="params"><dt>Parameters</dt><dd>
1.540 + <table class="params">
1.541 + <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
1.542 + <tr><td class="paramname">n</td><td>argument passed to <code>malloc()</code> </td></tr>
1.543 + </table>
1.544 + </dd>
1.545 +</dl>
1.546 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>malloc()</code> </dd></dl>
1.547 +
1.548 +</div>
1.549 +</div>
1.550 +<a id="a47cfc8af626a86fcb93a2b14b90498ed"></a>
1.551 +<h2 class="memtitle"><span class="permalink"><a href="#a47cfc8af626a86fcb93a2b14b90498ed">◆ </a></span>ucx_default_realloc()</h2>
1.552 +
1.553 +<div class="memitem">
1.554 +<div class="memproto">
1.555 + <table class="memname">
1.556 + <tr>
1.557 + <td class="memname">void* ucx_default_realloc </td>
1.558 + <td>(</td>
1.559 + <td class="paramtype">void * </td>
1.560 + <td class="paramname"><em>ignore</em>, </td>
1.561 + </tr>
1.562 + <tr>
1.563 + <td class="paramkey"></td>
1.564 + <td></td>
1.565 + <td class="paramtype">void * </td>
1.566 + <td class="paramname"><em>data</em>, </td>
1.567 + </tr>
1.568 + <tr>
1.569 + <td class="paramkey"></td>
1.570 + <td></td>
1.571 + <td class="paramtype">size_t </td>
1.572 + <td class="paramname"><em>n</em> </td>
1.573 + </tr>
1.574 + <tr>
1.575 + <td></td>
1.576 + <td>)</td>
1.577 + <td></td><td></td>
1.578 + </tr>
1.579 + </table>
1.580 +</div><div class="memdoc">
1.581 +
1.582 +<p>A wrapper for the standard libc <code>realloc()</code> function. </p>
1.583 +<dl class="params"><dt>Parameters</dt><dd>
1.584 + <table class="params">
1.585 + <tr><td class="paramname">ignore</td><td>ignored (may be used by allocators for pooled memory) </td></tr>
1.586 + <tr><td class="paramname">data</td><td>argumend passed to <code>realloc()</code> </td></tr>
1.587 + <tr><td class="paramname">n</td><td>argument passed to <code>realloc()</code> </td></tr>
1.588 + </table>
1.589 + </dd>
1.590 +</dl>
1.591 +<dl class="section return"><dt>Returns</dt><dd>return value of <code>realloc()</code> </dd></dl>
1.592 +
1.593 +</div>
1.594 +</div>
1.595 +</div><!-- contents -->
1.596 +<!-- start footer part -->
1.597 +<hr class="footer"/><address class="footer"><small>
1.598 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.599 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.600 +</a> 1.8.13
1.601 +</small></address>
1.602 +</body>
1.603 +</html>
