update to v1.8.8

This commit is contained in:
Daan Leijen 2025-01-03 17:56:15 -08:00
parent a0a6ad3cf9
commit 98699c983a
36 changed files with 694 additions and 433 deletions

View file

@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mi-malloc: Heap Introspection</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@ -54,7 +54,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@ -111,6 +111,9 @@ $(function(){initNavTree('group__analysis.html',''); initResizable(true); });
<div class="headertitle"><div class="title">Heap Introspection</div></div>
</div><!--header-->
<div class="contents">
<p>Inspect the heap at runtime.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
@ -189,7 +192,7 @@ size in bytes of a full block including padding and metadata. </td></tr>
<td class="fieldname">
heap_tag</td>
<td class="fielddoc">
heap tag associated with this area (see <em>mi_heap_new_ex</em>) </td></tr>
heap tag associated with this area (see <em class="arg">mi_heap_new_ex</em>) </td></tr>
<tr><td class="fieldtype">
<a id="ae848a3e6840414891035423948ca0383" name="ae848a3e6840414891035423948ca0383"></a>size_t</td>
<td class="fieldname">
@ -220,8 +223,8 @@ bytes in use by allocated blocks </td></tr>
</div><div class="memdoc">
<p>Visitor function passed to <a class="el" href="#ga70c46687dc6e9dc98b232b02646f8bed" title="Visit all areas and blocks in a heap.">mi_heap_visit_blocks()</a> </p>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if ok, <em>false</em> to stop visiting (i.e. break)</dd></dl>
<p>This function is always first called for every <em>area</em> with <em>block</em> as a <em>NULL</em> pointer. If <em>visit_all_blocks</em> was <em>true</em>, the function is then called for every allocated block in that area. </p>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if ok, <em class="arg">false</em> to stop visiting (i.e. break)</dd></dl>
<p>This function is always first called for every <em class="arg">area</em> with <em class="arg">block</em> as a <em class="arg">NULL</em> pointer. If <em class="arg">visit_all_blocks</em> was <em class="arg">true</em>, the function is then called for every allocated block in that area. </p>
</div>
</div>
@ -263,15 +266,15 @@ bytes in use by allocated blocks </td></tr>
<p>Visit all areas and blocks in abandoned heaps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subproc_id</td><td>The sub-process id associated with the abandonded heaps. </td></tr>
<tr><td class="paramname">subproc_id</td><td>The sub-process id associated with the abandoned heaps. </td></tr>
<tr><td class="paramname">heap_tag</td><td>Visit only abandoned memory with the specified heap tag, use -1 to visit all abandoned memory. </td></tr>
<tr><td class="paramname">visit_blocks</td><td>If <em>true</em> visits all allocated blocks, otherwise <em>visitor</em> is only called for every heap area. </td></tr>
<tr><td class="paramname">visitor</td><td>This function is called for every area in the heap (with <em>block</em> as <em>NULL</em>). If <em>visit_all_blocks</em> is <em>true</em>, <em>visitor</em> is also called for every allocated block in every area (with <code>block!=NULL</code>). return <em>false</em> from this function to stop visiting early. </td></tr>
<tr><td class="paramname">arg</td><td>extra argument passed to the <em>visitor</em>. </td></tr>
<tr><td class="paramname">visit_blocks</td><td>If <em class="arg">true</em> visits all allocated blocks, otherwise <em class="arg">visitor</em> is only called for every heap area. </td></tr>
<tr><td class="paramname">visitor</td><td>This function is called for every area in the heap (with <em class="arg">block</em> as <em class="arg">NULL</em>). If <em class="arg">visit_all_blocks</em> is <em class="arg">true</em>, <em class="arg">visitor</em> is also called for every allocated block in every area (with <code>block!=NULL</code>). return <em class="arg">false</em> from this function to stop visiting early. </td></tr>
<tr><td class="paramname">arg</td><td>extra argument passed to the <em class="arg">visitor</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if all areas and blocks were visited.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if all areas and blocks were visited.</dd></dl>
<p>Note: requires the option <code>mi_option_visit_abandoned</code> to be set at the start of the program. </p>
</div>
@ -298,7 +301,7 @@ bytes in use by allocated blocks </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if <em>p</em> points to a block in default heap of this thread.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if <em class="arg">p</em> points to a block in default heap of this thread.</dd></dl>
<p>Note: expensive function, linear in the pages in the heap. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="#gaa862aa8ed8d57d84cae41fc1022d71af" title="Does a heap contain a pointer to a previously allocated block?">mi_heap_contains_block()</a> </dd>
<dd>
<a class="el" href="group__heap.html#ga14c667a6e2c5d28762d8cb7d4e057909" title="Get the default heap that is used for mi_malloc() et al.">mi_heap_get_default()</a> </dd></dl>
@ -332,7 +335,7 @@ bytes in use by allocated blocks </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if <em>p</em> points to a block in <em>heap</em>.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if <em class="arg">p</em> points to a block in <em class="arg">heap</em>.</dd></dl>
<p>Note: expensive function, linear in the pages in the heap. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="#gaa862aa8ed8d57d84cae41fc1022d71af" title="Does a heap contain a pointer to a previously allocated block?">mi_heap_contains_block()</a> </dd>
<dd>
<a class="el" href="group__heap.html#ga14c667a6e2c5d28762d8cb7d4e057909" title="Get the default heap that is used for mi_malloc() et al.">mi_heap_get_default()</a> </dd></dl>
@ -366,7 +369,7 @@ bytes in use by allocated blocks </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if the block pointed to by <em>p</em> is in the <em>heap</em>. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if the block pointed to by <em class="arg">p</em> is in the <em class="arg">heap</em>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga0d67c1789faaa15ff366c024fcaf6377" title="Check safely if any pointer is part of a heap.">mi_heap_check_owned()</a> </dd></dl>
</div>
@ -404,13 +407,13 @@ bytes in use by allocated blocks </td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">heap</td><td>The heap to visit. </td></tr>
<tr><td class="paramname">visit_all_blocks</td><td>If <em>true</em> visits all allocated blocks, otherwise <em>visitor</em> is only called for every heap area. </td></tr>
<tr><td class="paramname">visitor</td><td>This function is called for every area in the heap (with <em>block</em> as <em>NULL</em>). If <em>visit_all_blocks</em> is <em>true</em>, <em>visitor</em> is also called for every allocated block in every area (with <code>block!=NULL</code>). return <em>false</em> from this function to stop visiting early. </td></tr>
<tr><td class="paramname">arg</td><td>Extra argument passed to <em>visitor</em>. </td></tr>
<tr><td class="paramname">visit_all_blocks</td><td>If <em class="arg">true</em> visits all allocated blocks, otherwise <em class="arg">visitor</em> is only called for every heap area. </td></tr>
<tr><td class="paramname">visitor</td><td>This function is called for every area in the heap (with <em class="arg">block</em> as <em class="arg">NULL</em>). If <em class="arg">visit_all_blocks</em> is <em class="arg">true</em>, <em class="arg">visitor</em> is also called for every allocated block in every area (with <code>block!=NULL</code>). return <em class="arg">false</em> from this function to stop visiting early. </td></tr>
<tr><td class="paramname">arg</td><td>Extra argument passed to <em class="arg">visitor</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if all areas and blocks were visited. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if all areas and blocks were visited. </dd></dl>
</div>
</div>
@ -419,7 +422,7 @@ bytes in use by allocated blocks </td></tr>
<!-- 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>
<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.13.1 </li>
</ul>
</div>
</body>