vey-mimalloc-sys 0.3.2+3.7.0

Rust FFI binding to mimalloc
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mi-malloc: Allocation with Block Sizes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="mimalloc-doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="mimalloc-logo.svg"/></td>
  <td id="projectalign">
   <div id="projectname">mi-malloc<span id="projectnumber">&#160;3.6/2.5/1.15</span>
   </div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('group__sized.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">Allocation with Block Sizes </div></div>
</div><!--header-->
<div class="contents">

<p><b>v3</b>: Allocate or free memory while reporting the allocator's block size in bytes.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gada2639c52f265186a12429435739627b" id="r_gada2639c52f265186a12429435739627b"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gada2639c52f265186a12429435739627b">mi_umalloc</a> (size_t size, size_t *block_size)</td></tr>
<tr class="memdesc:gada2639c52f265186a12429435739627b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate <em class="arg">size</em> bytes and report the block size through <em class="arg">block_size</em>.  <br /></td></tr>
<tr class="memitem:ga30d62ba1eb4c207590b7d7be011c9d56" id="r_ga30d62ba1eb4c207590b7d7be011c9d56"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga30d62ba1eb4c207590b7d7be011c9d56">mi_ucalloc</a> (size_t count, size_t size, size_t *block_size)</td></tr>
<tr class="memdesc:ga30d62ba1eb4c207590b7d7be011c9d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate <em class="arg">count</em> zero-initialized elements of <em class="arg">size</em> bytes and report the block size.  <br /></td></tr>
<tr class="memitem:ga93fd303998578e6cb0914d79c25efd4f" id="r_ga93fd303998578e6cb0914d79c25efd4f"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga93fd303998578e6cb0914d79c25efd4f">mi_urealloc</a> (void *p, size_t newsize, size_t *block_size_pre, size_t *block_size_post)</td></tr>
<tr class="memdesc:ga93fd303998578e6cb0914d79c25efd4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reallocate <em class="arg">p</em> to <em class="arg">newsize</em> bytes and report the old and new block sizes.  <br /></td></tr>
<tr class="memitem:ga2dfaf5d485ce83c7230ee6cb868f299e" id="r_ga2dfaf5d485ce83c7230ee6cb868f299e"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ga2dfaf5d485ce83c7230ee6cb868f299e">mi_ufree</a> (void *p, size_t *block_size)</td></tr>
<tr class="memdesc:ga2dfaf5d485ce83c7230ee6cb868f299e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free <em class="arg">p</em> and report its block size, or 0 if <em class="arg">p</em> is <em class="arg">NULL</em>.  <br /></td></tr>
<tr class="memitem:ga46f2c3c334f83cd933671a392934053f" id="r_ga46f2c3c334f83cd933671a392934053f"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga46f2c3c334f83cd933671a392934053f">mi_umalloc_aligned</a> (size_t size, size_t alignment, size_t *block_size)</td></tr>
<tr class="memdesc:ga46f2c3c334f83cd933671a392934053f"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__aligned.html#ga69578ff1a98ca16e1dcd02c0995cd65c" title="Allocate size bytes aligned by alignment.">mi_malloc_aligned()</a>, additionally reporting the block size on success.  <br /></td></tr>
<tr class="memitem:ga822081073810a5e033b771625ab518ca" id="r_ga822081073810a5e033b771625ab518ca"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga822081073810a5e033b771625ab518ca">mi_uzalloc_aligned</a> (size_t size, size_t alignment, size_t *block_size)</td></tr>
<tr class="memdesc:ga822081073810a5e033b771625ab518ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__aligned.html#gaac7d0beb782f9b9ac31f47492b130f82">mi_zalloc_aligned()</a>, additionally reporting the block size on success.  <br /></td></tr>
<tr class="memitem:ga7e82d9c99fa8feaee9f1306732fba15d" id="r_ga7e82d9c99fa8feaee9f1306732fba15d"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga7e82d9c99fa8feaee9f1306732fba15d">mi_umalloc_small</a> (size_t size, size_t *block_size)</td></tr>
<tr class="memdesc:ga7e82d9c99fa8feaee9f1306732fba15d"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__extended.html#ga7f050bc6b897da82692174f5fce59cde" title="Allocate a small object.">mi_malloc_small()</a>, additionally reporting the block size on success.  <br /></td></tr>
<tr class="memitem:gafe63673cd80308a142b454ec023ca22e" id="r_gafe63673cd80308a142b454ec023ca22e"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gafe63673cd80308a142b454ec023ca22e">mi_uzalloc_small</a> (size_t size, size_t *block_size)</td></tr>
<tr class="memdesc:gafe63673cd80308a142b454ec023ca22e"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__extended.html#ga51c47637e81df0e2f13a2d7a2dec123e" title="Allocate a zero initialized small object.">mi_zalloc_small()</a>, additionally reporting the block size on success.  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p><b>v3</b>: Allocate or free memory while reporting the allocator's block size in bytes. </p>
<p>Reported sizes may include padding or alignment overhead and are not a guarantee of writable capacity. Size output pointers may be <em class="arg">NULL</em>. Allocation size outputs are only valid on success; they need not be cleared on failure. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ga30d62ba1eb4c207590b7d7be011c9d56" name="ga30d62ba1eb4c207590b7d7be011c9d56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30d62ba1eb4c207590b7d7be011c9d56">&#9670;&#160;</a></span>mi_ucalloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_ucalloc </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>count</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate <em class="arg">count</em> zero-initialized elements of <em class="arg">size</em> bytes and report the block size. </p>
<dl class="section return"><dt>Returns</dt><dd>The allocation, or <em class="arg">NULL</em> on failure or multiplication overflow. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#ga6686568014b54d1e6c7ac64a076e4f56" title="Allocate zero-initialized count elements of size bytes.">mi_calloc()</a> </dd></dl>

</div>
</div>
<a id="ga2dfaf5d485ce83c7230ee6cb868f299e" name="ga2dfaf5d485ce83c7230ee6cb868f299e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2dfaf5d485ce83c7230ee6cb868f299e">&#9670;&#160;</a></span>mi_ufree()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_ufree </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Free <em class="arg">p</em> and report its block size, or 0 if <em class="arg">p</em> is <em class="arg">NULL</em>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#gaf2c7b89c327d1f60f59e68b9ea644d95" title="Free previously allocated memory.">mi_free()</a> </dd></dl>

</div>
</div>
<a id="gada2639c52f265186a12429435739627b" name="gada2639c52f265186a12429435739627b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gada2639c52f265186a12429435739627b">&#9670;&#160;</a></span>mi_umalloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_umalloc </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate <em class="arg">size</em> bytes and report the block size through <em class="arg">block_size</em>. </p>
<dl class="section return"><dt>Returns</dt><dd>The allocation, or <em class="arg">NULL</em> on failure. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> </dd></dl>

</div>
</div>
<a id="ga46f2c3c334f83cd933671a392934053f" name="ga46f2c3c334f83cd933671a392934053f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46f2c3c334f83cd933671a392934053f">&#9670;&#160;</a></span>mi_umalloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_umalloc_aligned </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>alignment</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__aligned.html#ga69578ff1a98ca16e1dcd02c0995cd65c" title="Allocate size bytes aligned by alignment.">mi_malloc_aligned()</a>, additionally reporting the block size on success. </p>

</div>
</div>
<a id="ga7e82d9c99fa8feaee9f1306732fba15d" name="ga7e82d9c99fa8feaee9f1306732fba15d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e82d9c99fa8feaee9f1306732fba15d">&#9670;&#160;</a></span>mi_umalloc_small()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_umalloc_small </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__extended.html#ga7f050bc6b897da82692174f5fce59cde" title="Allocate a small object.">mi_malloc_small()</a>, additionally reporting the block size on success. </p>
<p><em class="arg">size</em> must not exceed <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size in bytes allowed for small allocations in mi_malloc_small, mi_zalloc_small,...">MI_SMALL_SIZE_MAX</a>. </p>

</div>
</div>
<a id="ga93fd303998578e6cb0914d79c25efd4f" name="ga93fd303998578e6cb0914d79c25efd4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93fd303998578e6cb0914d79c25efd4f">&#9670;&#160;</a></span>mi_urealloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_urealloc </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>newsize</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size_pre</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size_post</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reallocate <em class="arg">p</em> to <em class="arg">newsize</em> bytes and report the old and new block sizes. </p>
<p><em class="arg">block_size_pre</em> is 0 for <em class="arg">NULL</em> input; <em class="arg">block_size_post</em> is valid on success. </p><dl class="section return"><dt>Returns</dt><dd>The reallocated block, or <em class="arg">NULL</em> on failure without freeing <em class="arg">p</em>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#ga0621af6a5e3aa384e6a1b548958bf583" title="Re-allocate memory to newsize bytes.">mi_realloc()</a> </dd></dl>

</div>
</div>
<a id="ga822081073810a5e033b771625ab518ca" name="ga822081073810a5e033b771625ab518ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga822081073810a5e033b771625ab518ca">&#9670;&#160;</a></span>mi_uzalloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_uzalloc_aligned </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>alignment</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__aligned.html#gaac7d0beb782f9b9ac31f47492b130f82">mi_zalloc_aligned()</a>, additionally reporting the block size on success. </p>

</div>
</div>
<a id="gafe63673cd80308a142b454ec023ca22e" name="gafe63673cd80308a142b454ec023ca22e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe63673cd80308a142b454ec023ca22e">&#9670;&#160;</a></span>mi_uzalloc_small()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_uzalloc_small </td>
          <td>(</td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>block_size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__extended.html#ga51c47637e81df0e2f13a2d7a2dec123e" title="Allocate a zero initialized small object.">mi_zalloc_small()</a>, additionally reporting the block size on success. </p>
<p><em class="arg">size</em> must not exceed <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size in bytes allowed for small allocations in mi_malloc_small, mi_zalloc_small,...">MI_SMALL_SIZE_MAX</a>. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
  </ul>
</div>
</body>
</html>