libmimalloc-sys2 0.1.53

Sys crate wrapping the mimalloc allocator
Documentation
<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mi-malloc: Subprocesses</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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="resize.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(function() { init_search(); });
/* @license-end */
</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;1.8/2.1</span>
   </div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</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" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('group__subproc.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Subprocesses</div></div>
</div><!--header-->
<div class="contents">

<p>A sub-process contains its own arena's and heaps that are fully separate from the main (sub) process.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8c0bcd1fee27c7641e9c3c0d991b3b7d" id="r_ga8c0bcd1fee27c7641e9c3c0d991b3b7d"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td></tr>
<tr class="memdesc:ga8c0bcd1fee27c7641e9c3c0d991b3b7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A process can associate threads with sub-processes.  <br /></td></tr>
<tr class="separator:ga8c0bcd1fee27c7641e9c3c0d991b3b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7dcbc5863df9989b45e7051999448a4a" id="r_ga7dcbc5863df9989b45e7051999448a4a"><td class="memItemLeft" align="right" valign="top">typedef bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7dcbc5863df9989b45e7051999448a4a">mi_heap_visit_fun</a>(<a class="el" href="group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2">mi_heap_t</a> *heap, void *arg)</td></tr>
<tr class="memdesc:ga7dcbc5863df9989b45e7051999448a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of a heap visitor function.  <br /></td></tr>
<tr class="separator:ga7dcbc5863df9989b45e7051999448a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga2ecba0d7ebdc99e71bb985c4a1609806" id="r_ga2ecba0d7ebdc99e71bb985c4a1609806"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2ecba0d7ebdc99e71bb985c4a1609806">mi_subproc_main</a> (void)</td></tr>
<tr class="memdesc:ga2ecba0d7ebdc99e71bb985c4a1609806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the main sub-process identifier.  <br /></td></tr>
<tr class="separator:ga2ecba0d7ebdc99e71bb985c4a1609806"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabc4db6585bf16099e43e60d64364950" id="r_gaabc4db6585bf16099e43e60d64364950"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaabc4db6585bf16099e43e60d64364950">mi_subproc_current</a> (void)</td></tr>
<tr class="memdesc:gaabc4db6585bf16099e43e60d64364950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current sub-process identifier of this thread.  <br /></td></tr>
<tr class="separator:gaabc4db6585bf16099e43e60d64364950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8068cac328e41fa2170faef707315243" id="r_ga8068cac328e41fa2170faef707315243"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8068cac328e41fa2170faef707315243">mi_subproc_new</a> (void)</td></tr>
<tr class="memdesc:ga8068cac328e41fa2170faef707315243"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a fresh sub-process (with no associated threads yet).  <br /></td></tr>
<tr class="separator:ga8068cac328e41fa2170faef707315243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada12e4d9bd382935c398ec324d0391f9" id="r_gada12e4d9bd382935c398ec324d0391f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gada12e4d9bd382935c398ec324d0391f9">mi_subproc_destroy</a> (<a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> subproc)</td></tr>
<tr class="memdesc:gada12e4d9bd382935c398ec324d0391f9"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>v3</b>: Destroy a previously created sub-process.  <br /></td></tr>
<tr class="separator:gada12e4d9bd382935c398ec324d0391f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7d263e9429bac9ac8345c9d25de610e" id="r_gaa7d263e9429bac9ac8345c9d25de610e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa7d263e9429bac9ac8345c9d25de610e">mi_subproc_delete</a> (<a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> subproc)</td></tr>
<tr class="memdesc:gaa7d263e9429bac9ac8345c9d25de610e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>v1</b>,<b>v2</b>: Delete a previously created sub-process.  <br /></td></tr>
<tr class="separator:gaa7d263e9429bac9ac8345c9d25de610e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbc53414eb68b275588ec001ce1ddc7c" id="r_gadbc53414eb68b275588ec001ce1ddc7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gadbc53414eb68b275588ec001ce1ddc7c">mi_subproc_add_current_thread</a> (<a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> subproc)</td></tr>
<tr class="memdesc:gadbc53414eb68b275588ec001ce1ddc7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the current thread to the given sub-process.  <br /></td></tr>
<tr class="separator:gadbc53414eb68b275588ec001ce1ddc7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd2136e7f167b5cd02b6ab00bed0ac93" id="r_gafd2136e7f167b5cd02b6ab00bed0ac93"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gafd2136e7f167b5cd02b6ab00bed0ac93">mi_subproc_visit_heaps</a> (<a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> subproc, <a class="el" href="#ga7dcbc5863df9989b45e7051999448a4a">mi_heap_visit_fun</a> *visitor, void *arg)</td></tr>
<tr class="memdesc:gafd2136e7f167b5cd02b6ab00bed0ac93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit all heaps belonging to a subprocess.  <br /></td></tr>
<tr class="separator:gafd2136e7f167b5cd02b6ab00bed0ac93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A sub-process contains its own arena's and heaps that are fully separate from the main (sub) process. </p>
<p>A thread can belong to only one subprocess at a time. This can be used to separate out logically separate parts of a program (like running multiple interpreter instances in CPython). </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga7dcbc5863df9989b45e7051999448a4a" name="ga7dcbc5863df9989b45e7051999448a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7dcbc5863df9989b45e7051999448a4a">&#9670;&#160;</a></span>mi_heap_visit_fun</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool mi_heap_visit_fun(<a class="el" href="group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2">mi_heap_t</a> *heap, void *arg)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The type of a heap visitor function. </p>
<dl class="section return"><dt>Returns</dt><dd>Return <code>true</code> to keep visiting. Returning <code>false</code> will stop visiting further heaps. </dd></dl>

</div>
</div>
<a id="ga8c0bcd1fee27c7641e9c3c0d991b3b7d" name="ga8c0bcd1fee27c7641e9c3c0d991b3b7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">&#9670;&#160;</a></span>mi_subproc_id_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void* <a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A process can associate threads with sub-processes. </p>
<p>Sub-processes are isolated and will not reclaim or visit memory from other sub-processes. Each subprocess always has an associated main heap. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gadbc53414eb68b275588ec001ce1ddc7c" name="gadbc53414eb68b275588ec001ce1ddc7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbc53414eb68b275588ec001ce1ddc7c">&#9670;&#160;</a></span>mi_subproc_add_current_thread()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_subproc_add_current_thread </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td>          <td class="paramname"><span class="paramname"><em>subproc</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add the current thread to the given sub-process. </p>
<p>This should be called right after a thread is created (and no allocation has taken place yet). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> mi_subproc_current </td>
          <td>(</td>
          <td class="paramtype">void</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the current sub-process identifier of this thread. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_subproc_delete </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td>          <td class="paramname"><span class="paramname"><em>subproc</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><b>v1</b>,<b>v2</b>: Delete a previously created sub-process. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">subproc</td><td>The sub-process identifier. Only delete sub-processes if all associated threads have terminated. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#gada12e4d9bd382935c398ec324d0391f9" title="v3: Destroy a previously created sub-process.">mi_subproc_destroy()</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_subproc_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td>          <td class="paramname"><span class="paramname"><em>subproc</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><b>v3</b>: Destroy a previously created sub-process. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">subproc</td><td>The sub-process identifier. Only destroy sub-processes if all associated threads have terminated. </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> mi_subproc_main </td>
          <td>(</td>
          <td class="paramtype">void</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the main sub-process identifier. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a> mi_subproc_new </td>
          <td>(</td>
          <td class="paramtype">void</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a fresh sub-process (with no associated threads yet). </p>
<dl class="section return"><dt>Returns</dt><dd>The new sub-process identifier. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool mi_subproc_visit_heaps </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8c0bcd1fee27c7641e9c3c0d991b3b7d">mi_subproc_id_t</a></td>          <td class="paramname"><span class="paramname"><em>subproc</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="#ga7dcbc5863df9989b45e7051999448a4a">mi_heap_visit_fun</a> *</td>          <td class="paramname"><span class="paramname"><em>visitor</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>arg</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Visit all heaps belonging to a subprocess. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">subproc</td><td>The subprocess that the heaps should belong to </td></tr>
    <tr><td class="paramname">visitor</td><td>The visitor function is called with each heap in <code>subproc</code> </td></tr>
    <tr><td class="paramname">arg</td><td>A user argument that is passed to each visitor function call. Return <code>true</code> if all heaps are visited (and false otherwise). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- 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.11.0 </li>
  </ul>
</div>
</body>
</html>