The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-08 11:20:42 +01:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
wut/group__coreinit__memheap.html
Ash Logan b225d3cb49 doxygen: rebuild against 1.0.0-beta9
2020-03-26 16:49:18 +11:00

630 lines
37 KiB
HTML
Raw Permalink Blame History

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: Common Memory Heap</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="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" />
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">wut
&#160;<span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Common Memory Heap<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<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:structMEMHeapHeader"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a></td></tr>
<tr class="separator:structMEMHeapHeader"><td class="memSeparator" colspan="2">&#160;</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:ga727913a40d765f66ebec5e9b0d762691"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga727913a40d765f66ebec5e9b0d762691">MEMHeapHeader</a></td></tr>
<tr class="separator:ga727913a40d765f66ebec5e9b0d762691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f18df06d1c3949e74a4b7bcb1c0b88c"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a></td></tr>
<tr class="separator:ga3f18df06d1c3949e74a4b7bcb1c0b88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c29cd3da05ed7cd3ecba2fd130df441"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga4c29cd3da05ed7cd3ecba2fd130df441">MEMBaseHeapType</a></td></tr>
<tr class="separator:ga4c29cd3da05ed7cd3ecba2fd130df441"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf683df86fa391aadd69e22c2bed8cd98"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gaf683df86fa391aadd69e22c2bed8cd98">MEMHeapFillType</a></td></tr>
<tr class="separator:gaf683df86fa391aadd69e22c2bed8cd98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8806aa24143fdf51e3837777f40438dc"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga8806aa24143fdf51e3837777f40438dc">MEMHeapTag</a></td></tr>
<tr class="separator:ga8806aa24143fdf51e3837777f40438dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa994657094f10628ea098ba004eb2414"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__memheap.html#ga5c832777be0c2cffa9c0f2eaf3c9a497">MEMHeapFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gaa994657094f10628ea098ba004eb2414">MEMHeapFlags</a></td></tr>
<tr class="separator:gaa994657094f10628ea098ba004eb2414"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga552d2fdd0b6f216c1bc8bad6a02e1ea4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga552d2fdd0b6f216c1bc8bad6a02e1ea4a540e199d1bc7fbc82846adb9afbc208f">MEM_BASE_HEAP_MEM1</a> = 0,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga552d2fdd0b6f216c1bc8bad6a02e1ea4afb95e153ee0ad2cbe78b717085e9d369">MEM_BASE_HEAP_MEM2</a> = 1,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga552d2fdd0b6f216c1bc8bad6a02e1ea4a5d870bd01e6cc7f0852f174b3c24abf0">MEM_BASE_HEAP_FG</a> = 8
<br />
}</td></tr>
<tr class="separator:ga552d2fdd0b6f216c1bc8bad6a02e1ea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a2254c26326745a098c8d8ec1d56442"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5a2254c26326745a098c8d8ec1d56442aab58d29ca838e67871a9c39230a66a1e">MEM_HEAP_FILL_TYPE_UNUSED</a> = 0,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5a2254c26326745a098c8d8ec1d56442af5678cb9a17bf1855df30c50e552fee3">MEM_HEAP_FILL_TYPE_ALLOCATED</a> = 1,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5a2254c26326745a098c8d8ec1d56442a303a7c6d5c68983625bd949e8a8a38ea">MEM_HEAP_FILL_TYPE_FREED</a> = 2
<br />
}</td></tr>
<tr class="separator:ga5a2254c26326745a098c8d8ec1d56442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4257a1288a2365e8c3600df369a83cb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#ggaf4257a1288a2365e8c3600df369a83cbaee676570c092ee1e6e421409a87d975f">MEM_BLOCK_HEAP_TAG</a> = 0x424C4B48u,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#ggaf4257a1288a2365e8c3600df369a83cba73cc6859292a3153a6dc5a8526f28353">MEM_EXPANDED_HEAP_TAG</a> = 0x45585048u,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#ggaf4257a1288a2365e8c3600df369a83cba9f996937542e05cf39a5905a70289f55">MEM_FRAME_HEAP_TAG</a> = 0x46524D48u,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#ggaf4257a1288a2365e8c3600df369a83cba4fbb605cdb05db8640ae6dc7187e8934">MEM_UNIT_HEAP_TAG</a> = 0x554E5448u,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#ggaf4257a1288a2365e8c3600df369a83cba5548a1522f91faebd0bd08201d8428c9">MEM_USER_HEAP_TAG</a> = 0x55535248u
<br />
}</td></tr>
<tr class="separator:gaf4257a1288a2365e8c3600df369a83cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5c832777be0c2cffa9c0f2eaf3c9a497"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga5c832777be0c2cffa9c0f2eaf3c9a497">MEMHeapFlags</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5c832777be0c2cffa9c0f2eaf3c9a497a6b36ac6cf03f489e90b525517e1e33e2">MEM_HEAP_FLAG_ZERO_ALLOCATED</a> = 1 &lt;&lt; 0,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5c832777be0c2cffa9c0f2eaf3c9a497a3cefa3627ca24ef278fe861c969a76cb">MEM_HEAP_FLAG_DEBUG_MODE</a> = 1 &lt;&lt; 1,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memheap.html#gga5c832777be0c2cffa9c0f2eaf3c9a497af49a821423e44a9e85218ce44f85d48b">MEM_HEAP_FLAG_USE_LOCK</a> = 1 &lt;&lt; 2
<br />
}</td></tr>
<tr class="separator:ga5c832777be0c2cffa9c0f2eaf3c9a497"><td class="memSeparator" colspan="2">&#160;</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:ga5d792599e24cd0651a722a7a073230c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga5d792599e24cd0651a722a7a073230c5">MEMGetArena</a> (<a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> handle)</td></tr>
<tr class="memdesc:ga5d792599e24cd0651a722a7a073230c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get which memory area a heap belongs to. <a href="group__coreinit__memheap.html#ga5d792599e24cd0651a722a7a073230c5">More...</a><br /></td></tr>
<tr class="separator:ga5d792599e24cd0651a722a7a073230c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4f377c8479a3ecc069b6e78d54ec977"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gac4f377c8479a3ecc069b6e78d54ec977">MEMGetBaseHeapHandle</a> (<a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a> type)</td></tr>
<tr class="memdesc:gac4f377c8479a3ecc069b6e78d54ec977"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get base heap for memory area. <a href="group__coreinit__memheap.html#gac4f377c8479a3ecc069b6e78d54ec977">More...</a><br /></td></tr>
<tr class="separator:gac4f377c8479a3ecc069b6e78d54ec977"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1563986ee5053c3fe16aba87eb797d55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga1563986ee5053c3fe16aba87eb797d55">MEMSetBaseHeapHandle</a> (<a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a> type, <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> handle)</td></tr>
<tr class="memdesc:ga1563986ee5053c3fe16aba87eb797d55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set base heap for memory area. <a href="group__coreinit__memheap.html#ga1563986ee5053c3fe16aba87eb797d55">More...</a><br /></td></tr>
<tr class="separator:ga1563986ee5053c3fe16aba87eb797d55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd58d0368269dbb0b4714f5a82724bb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gadd58d0368269dbb0b4714f5a82724bb8">MEMCreateUserHeapHandle</a> (void *heap, uint32_t size)</td></tr>
<tr class="memdesc:gadd58d0368269dbb0b4714f5a82724bb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a heap handle for a user defined heap. <a href="group__coreinit__memheap.html#gadd58d0368269dbb0b4714f5a82724bb8">More...</a><br /></td></tr>
<tr class="separator:gadd58d0368269dbb0b4714f5a82724bb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c947c0916b5ae236b558d62cf7f284d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga2c947c0916b5ae236b558d62cf7f284d">MEMDumpHeap</a> (<a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> heap)</td></tr>
<tr class="memdesc:ga2c947c0916b5ae236b558d62cf7f284d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print details about heap to COSWarn. <a href="group__coreinit__memheap.html#ga2c947c0916b5ae236b558d62cf7f284d">More...</a><br /></td></tr>
<tr class="separator:ga2c947c0916b5ae236b558d62cf7f284d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24a8efd33838634b25ed09465612b463"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga24a8efd33838634b25ed09465612b463">MEMFindContainHeap</a> (void *block)</td></tr>
<tr class="memdesc:ga24a8efd33838634b25ed09465612b463"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find heap which contains a memory block. <a href="group__coreinit__memheap.html#ga24a8efd33838634b25ed09465612b463">More...</a><br /></td></tr>
<tr class="separator:ga24a8efd33838634b25ed09465612b463"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7302b72170f5810d5abecd4cf4bd92c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga7302b72170f5810d5abecd4cf4bd92c5">MEMFindParentHeap</a> (<a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> handle)</td></tr>
<tr class="memdesc:ga7302b72170f5810d5abecd4cf4bd92c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the parent heap of a given heap. <a href="group__coreinit__memheap.html#ga7302b72170f5810d5abecd4cf4bd92c5">More...</a><br /></td></tr>
<tr class="separator:ga7302b72170f5810d5abecd4cf4bd92c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad9735e0622600c541ba26bb80dc4614a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#gad9735e0622600c541ba26bb80dc4614a">MEMGetFillValForHeap</a> (<a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a> type)</td></tr>
<tr class="memdesc:gad9735e0622600c541ba26bb80dc4614a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set. <a href="group__coreinit__memheap.html#gad9735e0622600c541ba26bb80dc4614a">More...</a><br /></td></tr>
<tr class="separator:gad9735e0622600c541ba26bb80dc4614a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga392788207fa9c65e8bf2ab5b67c252d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memheap.html#ga392788207fa9c65e8bf2ab5b67c252d9">MEMSetFillValForHeap</a> (<a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a> type, uint32_t value)</td></tr>
<tr class="memdesc:ga392788207fa9c65e8bf2ab5b67c252d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set. <a href="group__coreinit__memheap.html#ga392788207fa9c65e8bf2ab5b67c252d9">More...</a><br /></td></tr>
<tr class="separator:ga392788207fa9c65e8bf2ab5b67c252d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Common memory heap fucntions. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structMEMHeapHeader" id="structMEMHeapHeader"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structMEMHeapHeader">&#9670;&nbsp;</a></span>MEMHeapHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct MEMHeapHeader</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00051">51</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="aa5b371c77f26fd72d65074da3f814c8d"></a><a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a></td>
<td class="fieldname">
tag</td>
<td class="fielddoc">
Tag indicating which type of heap this is. </td></tr>
<tr><td class="fieldtype">
<a id="aad9bd11b4f59e92b6551361b5693960c"></a><a class="el" href="group__coreinit__memlist.html#structMEMMemoryLink">MEMMemoryLink</a></td>
<td class="fieldname">
link</td>
<td class="fielddoc">
Link for list this heap is in. </td></tr>
<tr><td class="fieldtype">
<a id="a9e168165b27e6d8c6a947314706ebdff"></a><a class="el" href="group__coreinit__memlist.html#structMEMMemoryList">MEMMemoryList</a></td>
<td class="fieldname">
list</td>
<td class="fielddoc">
List of all child heaps in this heap. </td></tr>
<tr><td class="fieldtype">
<a id="ab68a6425f2ca0d9e6af3c18ad6ab5524"></a>void *</td>
<td class="fieldname">
dataStart</td>
<td class="fielddoc">
Pointer to start of allocatable memory. </td></tr>
<tr><td class="fieldtype">
<a id="afd8d116d27671766707fa89f63e77535"></a>void *</td>
<td class="fieldname">
dataEnd</td>
<td class="fielddoc">
Pointer to end of allocatable memory. </td></tr>
<tr><td class="fieldtype">
<a id="acda02b2450f7b21940084ed1114d5bb2"></a><a class="el" href="group__coreinit__spinlock.html#gae8be4af7c8a7c9932e945f98e8a6b3e9">OSSpinLock</a></td>
<td class="fieldname">
lock</td>
<td class="fielddoc">
Lock used when MEM_HEAP_FLAG_USE_LOCK is set. </td></tr>
<tr><td class="fieldtype">
<a id="a773b39d480759f67926cb18ae2219281"></a>uint32_t</td>
<td class="fieldname">
flags</td>
<td class="fielddoc">
Flags set during heap creation. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga727913a40d765f66ebec5e9b0d762691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga727913a40d765f66ebec5e9b0d762691">&#9670;&nbsp;</a></span>MEMHeapHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a> <a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00018">18</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<a id="ga3f18df06d1c3949e74a4b7bcb1c0b88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f18df06d1c3949e74a4b7bcb1c0b88c">&#9670;&nbsp;</a></span>MEMHeapHandle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a>* <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00019">19</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<a id="ga4c29cd3da05ed7cd3ecba2fd130df441"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c29cd3da05ed7cd3ecba2fd130df441">&#9670;&nbsp;</a></span>MEMBaseHeapType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a> <a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaf683df86fa391aadd69e22c2bed8cd98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf683df86fa391aadd69e22c2bed8cd98">&#9670;&nbsp;</a></span>MEMHeapFillType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a> <a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga8806aa24143fdf51e3837777f40438dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8806aa24143fdf51e3837777f40438dc">&#9670;&nbsp;</a></span>MEMHeapTag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a> <a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaa994657094f10628ea098ba004eb2414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa994657094f10628ea098ba004eb2414">&#9670;&nbsp;</a></span>MEMHeapFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__memheap.html#ga5c832777be0c2cffa9c0f2eaf3c9a497">MEMHeapFlags</a> <a class="el" href="group__coreinit__memheap.html#ga5c832777be0c2cffa9c0f2eaf3c9a497">MEMHeapFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga552d2fdd0b6f216c1bc8bad6a02e1ea4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">&#9670;&nbsp;</a></span>MEMBaseHeapType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga552d2fdd0b6f216c1bc8bad6a02e1ea4a540e199d1bc7fbc82846adb9afbc208f"></a>MEM_BASE_HEAP_MEM1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga552d2fdd0b6f216c1bc8bad6a02e1ea4afb95e153ee0ad2cbe78b717085e9d369"></a>MEM_BASE_HEAP_MEM2&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga552d2fdd0b6f216c1bc8bad6a02e1ea4a5d870bd01e6cc7f0852f174b3c24abf0"></a>MEM_BASE_HEAP_FG&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00021">21</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<a id="ga5a2254c26326745a098c8d8ec1d56442"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a2254c26326745a098c8d8ec1d56442">&#9670;&nbsp;</a></span>MEMHeapFillType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5a2254c26326745a098c8d8ec1d56442aab58d29ca838e67871a9c39230a66a1e"></a>MEM_HEAP_FILL_TYPE_UNUSED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5a2254c26326745a098c8d8ec1d56442af5678cb9a17bf1855df30c50e552fee3"></a>MEM_HEAP_FILL_TYPE_ALLOCATED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5a2254c26326745a098c8d8ec1d56442a303a7c6d5c68983625bd949e8a8a38ea"></a>MEM_HEAP_FILL_TYPE_FREED&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00028">28</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<a id="gaf4257a1288a2365e8c3600df369a83cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4257a1288a2365e8c3600df369a83cb">&#9670;&nbsp;</a></span>MEMHeapTag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__memheap.html#gaf4257a1288a2365e8c3600df369a83cb">MEMHeapTag</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaf4257a1288a2365e8c3600df369a83cbaee676570c092ee1e6e421409a87d975f"></a>MEM_BLOCK_HEAP_TAG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggaf4257a1288a2365e8c3600df369a83cba73cc6859292a3153a6dc5a8526f28353"></a>MEM_EXPANDED_HEAP_TAG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggaf4257a1288a2365e8c3600df369a83cba9f996937542e05cf39a5905a70289f55"></a>MEM_FRAME_HEAP_TAG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggaf4257a1288a2365e8c3600df369a83cba4fbb605cdb05db8640ae6dc7187e8934"></a>MEM_UNIT_HEAP_TAG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggaf4257a1288a2365e8c3600df369a83cba5548a1522f91faebd0bd08201d8428c9"></a>MEM_USER_HEAP_TAG&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00035">35</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<a id="ga5c832777be0c2cffa9c0f2eaf3c9a497"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c832777be0c2cffa9c0f2eaf3c9a497">&#9670;&nbsp;</a></span>MEMHeapFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__memheap.html#ga5c832777be0c2cffa9c0f2eaf3c9a497">MEMHeapFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5c832777be0c2cffa9c0f2eaf3c9a497a6b36ac6cf03f489e90b525517e1e33e2"></a>MEM_HEAP_FLAG_ZERO_ALLOCATED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5c832777be0c2cffa9c0f2eaf3c9a497a3cefa3627ca24ef278fe861c969a76cb"></a>MEM_HEAP_FLAG_DEBUG_MODE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5c832777be0c2cffa9c0f2eaf3c9a497af49a821423e44a9e85218ce44f85d48b"></a>MEM_HEAP_FLAG_USE_LOCK&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="memheap_8h_source.html#l00044">44</a> of file <a class="el" href="memheap_8h_source.html">memheap.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5d792599e24cd0651a722a7a073230c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d792599e24cd0651a722a7a073230c5">&#9670;&nbsp;</a></span>MEMGetArena()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a> MEMGetArena </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get which memory area a heap belongs to. </p>
</div>
</div>
<a id="gac4f377c8479a3ecc069b6e78d54ec977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4f377c8479a3ecc069b6e78d54ec977">&#9670;&nbsp;</a></span>MEMGetBaseHeapHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> MEMGetBaseHeapHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get base heap for memory area. </p>
</div>
</div>
<a id="ga1563986ee5053c3fe16aba87eb797d55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1563986ee5053c3fe16aba87eb797d55">&#9670;&nbsp;</a></span>MEMSetBaseHeapHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> MEMSetBaseHeapHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga552d2fdd0b6f216c1bc8bad6a02e1ea4">MEMBaseHeapType</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>handle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set base heap for memory area. </p>
</div>
</div>
<a id="gadd58d0368269dbb0b4714f5a82724bb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd58d0368269dbb0b4714f5a82724bb8">&#9670;&nbsp;</a></span>MEMCreateUserHeapHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> MEMCreateUserHeapHandle </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>heap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a heap handle for a user defined heap. </p>
</div>
</div>
<a id="ga2c947c0916b5ae236b558d62cf7f284d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c947c0916b5ae236b558d62cf7f284d">&#9670;&nbsp;</a></span>MEMDumpHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMDumpHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>heap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print details about heap to COSWarn. </p>
</div>
</div>
<a id="ga24a8efd33838634b25ed09465612b463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24a8efd33838634b25ed09465612b463">&#9670;&nbsp;</a></span>MEMFindContainHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#structMEMHeapHeader">MEMHeapHeader</a>* MEMFindContainHeap </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>block</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find heap which contains a memory block. </p>
</div>
</div>
<a id="ga7302b72170f5810d5abecd4cf4bd92c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7302b72170f5810d5abecd4cf4bd92c5">&#9670;&nbsp;</a></span>MEMFindParentHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> MEMFindParentHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the parent heap of a given heap. </p>
<p>Return NULL if no parent was found. </p>
</div>
</div>
<a id="gad9735e0622600c541ba26bb80dc4614a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9735e0622600c541ba26bb80dc4614a">&#9670;&nbsp;</a></span>MEMGetFillValForHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t MEMGetFillValForHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set. </p>
</div>
</div>
<a id="ga392788207fa9c65e8bf2ab5b67c252d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga392788207fa9c65e8bf2ab5b67c252d9">&#9670;&nbsp;</a></span>MEMSetFillValForHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMSetFillValForHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga5a2254c26326745a098c8d8ec1d56442">MEMHeapFillType</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink