2019-07-08 17:15:34 -07:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2019-06-22 10:30:09 -07:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2021-12-18 16:36:37 -08:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2019-06-22 10:30:09 -07:00
< 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" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.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:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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 style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "mimalloc-logo.svg" / > < / td >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > mi-malloc
2021-12-18 16:36:37 -08:00
  < span id = "projectnumber" > 1.7/2.0< / span >
2019-06-22 10:30:09 -07:00
< / div >
< / td >
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
2021-12-18 16:36:37 -08:00
< img id = "MSearchSelect" src = "search/mag_sel.svg"
2019-06-22 10:30:09 -07:00
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
2022-12-03 00:23:43 +01:00
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
2019-06-22 10:30:09 -07:00
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
2021-12-18 16:36:37 -08:00
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.svg" alt = "" / > < / a >
2019-06-22 10:30:09 -07:00
< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-12-18 16:36:37 -08:00
<!-- Generated by Doxygen 1.9.1 -->
2019-06-22 10:30:09 -07:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-12-18 16:36:37 -08:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2019-06-22 10:30:09 -07:00
/* @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 >
2022-12-03 00:23:43 +01:00
< div id = "splitbar" style = "-moz-user-select:none;"
2019-06-22 10:30:09 -07:00
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-12-18 16:36:37 -08:00
$(document).ready(function(){initNavTree('group__analysis.html',''); initResizable(); });
2019-06-22 10:30:09 -07:00
/* @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" >
2022-12-03 00:23:43 +01:00
< iframe src = "javascript:void(0)" frameborder = "0"
2019-06-22 10:30:09 -07:00
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Heap Introspection< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2022-12-03 00:23:43 +01:00
< p > Inspect the heap at runtime.
2019-06-22 10:30:09 -07:00
< a href = "#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
< tr class = "memitem:structmi__heap__area__t" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#structmi__heap__area__t" > mi_heap_area_t< / a > < / td > < / tr >
< tr class = "memdesc:structmi__heap__area__t" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > An area of heap space contains blocks of a single size. < a href = "group__analysis.html#structmi__heap__area__t" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:structmi__heap__area__t" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
< tr class = "memitem:gadfa01e2900f0e5d515ad5506b26f6d65" > < td class = "memItemLeft" align = "right" valign = "top" > typedef bool()  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#gadfa01e2900f0e5d515ad5506b26f6d65" > mi_block_visit_fun< / a > (const < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *heap, const < a class = "el" href = "group__analysis.html#structmi__heap__area__t" > mi_heap_area_t< / a > *area, void *block, size_t block_size, void *arg)< / td > < / tr >
2021-12-18 16:36:37 -08:00
< tr class = "memdesc:gadfa01e2900f0e5d515ad5506b26f6d65" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Visitor function passed to < a class = "el" href = "group__analysis.html#ga70c46687dc6e9dc98b232b02646f8bed" title = "Visit all areas and blocks in a heap." > mi_heap_visit_blocks()< / a > < a href = "group__analysis.html#gadfa01e2900f0e5d515ad5506b26f6d65" > More...< / a > < br / > < / td > < / tr >
2019-06-22 10:30:09 -07:00
< tr class = "separator:gadfa01e2900f0e5d515ad5506b26f6d65" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:gaa862aa8ed8d57d84cae41fc1022d71af" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#gaa862aa8ed8d57d84cae41fc1022d71af" > mi_heap_contains_block< / a > (< a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *heap, const void *p)< / td > < / tr >
2021-12-18 16:36:37 -08:00
< tr class = "memdesc:gaa862aa8ed8d57d84cae41fc1022d71af" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Does a heap contain a pointer to a previously allocated block? < a href = "group__analysis.html#gaa862aa8ed8d57d84cae41fc1022d71af" > More...< / a > < br / > < / td > < / tr >
2019-06-22 10:30:09 -07:00
< tr class = "separator:gaa862aa8ed8d57d84cae41fc1022d71af" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga0d67c1789faaa15ff366c024fcaf6377" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#ga0d67c1789faaa15ff366c024fcaf6377" > mi_heap_check_owned< / a > (< a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *heap, const void *p)< / td > < / tr >
2021-12-18 16:36:37 -08:00
< tr class = "memdesc:ga0d67c1789faaa15ff366c024fcaf6377" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check safely if any pointer is part of a heap. < a href = "group__analysis.html#ga0d67c1789faaa15ff366c024fcaf6377" > More...< / a > < br / > < / td > < / tr >
2019-06-22 10:30:09 -07:00
< tr class = "separator:ga0d67c1789faaa15ff366c024fcaf6377" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga628c237489c2679af84a4d0d143b3dd5" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#ga628c237489c2679af84a4d0d143b3dd5" > mi_check_owned< / a > (const void *p)< / td > < / tr >
2021-12-18 16:36:37 -08:00
< tr class = "memdesc:ga628c237489c2679af84a4d0d143b3dd5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check safely if any pointer is part of the default heap of this thread. < a href = "group__analysis.html#ga628c237489c2679af84a4d0d143b3dd5" > More...< / a > < br / > < / td > < / tr >
2019-06-22 10:30:09 -07:00
< tr class = "separator:ga628c237489c2679af84a4d0d143b3dd5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga70c46687dc6e9dc98b232b02646f8bed" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__analysis.html#ga70c46687dc6e9dc98b232b02646f8bed" > mi_heap_visit_blocks< / a > (const < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *heap, bool visit_all_blocks, < a class = "el" href = "group__analysis.html#gadfa01e2900f0e5d515ad5506b26f6d65" > mi_block_visit_fun< / a > *visitor, void *arg)< / td > < / tr >
2021-12-18 16:36:37 -08:00
< tr class = "memdesc:ga70c46687dc6e9dc98b232b02646f8bed" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Visit all areas and blocks in a heap. < a href = "group__analysis.html#ga70c46687dc6e9dc98b232b02646f8bed" > More...< / a > < br / > < / td > < / tr >
2019-06-22 10:30:09 -07:00
< tr class = "separator:ga70c46687dc6e9dc98b232b02646f8bed" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< p > Inspect the heap at runtime. < / p >
< hr / > < h2 class = "groupheader" > Data Structure Documentation< / h2 >
< a name = "structmi__heap__area__t" id = "structmi__heap__area__t" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#structmi__heap__area__t" > ◆ < / a > < / span > mi_heap_area_t< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > struct mi_heap_area_t< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< div class = "textblock" > < p > An area of heap space contains blocks of a single size. < / p >
< p > The bytes in freed blocks are < code > committed - used< / code > . < / p >
< / div > < table class = "fieldtable" >
< tr > < th colspan = "3" > Data Fields< / th > < / tr >
< tr > < td class = "fieldtype" >
< a id = "a332a6c14d736a99699d5453a1cb04b41" > < / a > size_t< / td >
< td class = "fieldname" >
block_size< / td >
< td class = "fielddoc" >
size in bytes of one block < / td > < / tr >
< tr > < td class = "fieldtype" >
< a id = "ae0085e6e1cf059a4eb7767e30e9991b8" > < / a > void *< / td >
< td class = "fieldname" >
blocks< / td >
< td class = "fielddoc" >
start of the area containing heap blocks < / td > < / tr >
< tr > < td class = "fieldtype" >
< a id = "ab47526df656d8837ec3e97f11b83f835" > < / a > size_t< / td >
< td class = "fieldname" >
committed< / td >
< td class = "fielddoc" >
current committed bytes of this area < / td > < / tr >
< tr > < td class = "fieldtype" >
< a id = "ae848a3e6840414891035423948ca0383" > < / a > size_t< / td >
< td class = "fieldname" >
reserved< / td >
< td class = "fielddoc" >
bytes reserved for this area < / td > < / tr >
< tr > < td class = "fieldtype" >
< a id = "ab820302c5cd0df133eb8e51650a008b4" > < / a > size_t< / td >
< td class = "fieldname" >
used< / td >
< td class = "fielddoc" >
bytes in use by allocated blocks < / td > < / tr >
< / table >
< / div >
< / div >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a id = "gadfa01e2900f0e5d515ad5506b26f6d65" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gadfa01e2900f0e5d515ad5506b26f6d65" > ◆ < / a > < / span > mi_block_visit_fun< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef bool() mi_block_visit_fun(const < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *heap, const < a class = "el" href = "group__analysis.html#structmi__heap__area__t" > mi_heap_area_t< / a > *area, void *block, size_t block_size, void *arg)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-07-08 17:15:34 -07:00
< p > Visitor function passed to < a class = "el" href = "group__analysis.html#ga70c46687dc6e9dc98b232b02646f8bed" title = "Visit all areas and blocks in a heap." > mi_heap_visit_blocks()< / a > < / p >
2019-06-22 10:30:09 -07:00
< 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 >
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "ga628c237489c2679af84a4d0d143b3dd5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga628c237489c2679af84a4d0d143b3dd5" > ◆ < / a > < / span > mi_check_owned()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool mi_check_owned < / td >
< td > (< / td >
< td class = "paramtype" > const void *  < / td >
< td class = "paramname" > < em > p< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Check safely if any pointer is part of the default heap of this thread. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > p< / td > < td > Any pointer – not required to be previously allocated by us. < / 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 >
2019-07-08 17:15:34 -07:00
< 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 = "group__analysis.html#gaa862aa8ed8d57d84cae41fc1022d71af" title = "Does a heap contain a pointer to a previously allocated block?" > mi_heap_contains_block()< / a > < / dd >
2019-06-22 10:30:09 -07:00
< dd >
2019-07-08 17:15:34 -07:00
< a class = "el" href = "group__heap.html#ga8db4cbb87314a989a9a187464d6b5e05" title = "Get the default heap that is used for mi_malloc() et al." > mi_heap_get_default()< / a > < / dd > < / dl >
2019-06-22 10:30:09 -07:00
< / div >
< / div >
< a id = "ga0d67c1789faaa15ff366c024fcaf6377" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga0d67c1789faaa15ff366c024fcaf6377" > ◆ < / a > < / span > mi_heap_check_owned()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool mi_heap_check_owned < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *  < / td >
< td class = "paramname" > < em > heap< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const void *  < / td >
< td class = "paramname" > < em > p< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Check safely if any pointer is part of a heap. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > heap< / td > < td > The heap. < / td > < / tr >
< tr > < td class = "paramname" > p< / td > < td > Any pointer – not required to be previously allocated by us. < / 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 >
2019-07-08 17:15:34 -07:00
< 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 = "group__analysis.html#gaa862aa8ed8d57d84cae41fc1022d71af" title = "Does a heap contain a pointer to a previously allocated block?" > mi_heap_contains_block()< / a > < / dd >
2019-06-22 10:30:09 -07:00
< dd >
2019-07-08 17:15:34 -07:00
< a class = "el" href = "group__heap.html#ga8db4cbb87314a989a9a187464d6b5e05" title = "Get the default heap that is used for mi_malloc() et al." > mi_heap_get_default()< / a > < / dd > < / dl >
2019-06-22 10:30:09 -07:00
< / div >
< / div >
< a id = "gaa862aa8ed8d57d84cae41fc1022d71af" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa862aa8ed8d57d84cae41fc1022d71af" > ◆ < / a > < / span > mi_heap_contains_block()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool mi_heap_contains_block < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *  < / td >
< td class = "paramname" > < em > heap< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const void *  < / td >
< td class = "paramname" > < em > p< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Does a heap contain a pointer to a previously allocated block? < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > heap< / td > < td > The heap. < / td > < / tr >
< tr > < td class = "paramname" > p< / td > < td > Pointer to a previously allocated block (in any heap)– cannot be some random pointer! < / 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 >
2019-07-08 17:15:34 -07:00
< dl class = "section see" > < dt > See also< / dt > < dd > < a class = "el" href = "group__analysis.html#ga0d67c1789faaa15ff366c024fcaf6377" title = "Check safely if any pointer is part of a heap." > mi_heap_check_owned()< / a > < / dd > < / dl >
2019-06-22 10:30:09 -07:00
< / div >
< / div >
< a id = "ga70c46687dc6e9dc98b232b02646f8bed" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga70c46687dc6e9dc98b232b02646f8bed" > ◆ < / a > < / span > mi_heap_visit_blocks()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool mi_heap_visit_blocks < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" > mi_heap_t< / a > *  < / td >
< td class = "paramname" > < em > heap< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > visit_all_blocks< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__analysis.html#gadfa01e2900f0e5d515ad5506b26f6d65" > mi_block_visit_fun< / a > *  < / td >
< td class = "paramname" > < em > visitor< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > arg< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Visit all areas and blocks in a heap. < / p >
< 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 >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > < em > true< / em > if all areas and blocks were visited. < / 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 >
2021-12-18 16:36:37 -08:00
< 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.9.1 < / li >
2019-06-22 10:30:09 -07:00
< / ul >
< / div >
< / body >
< / html >
