Mirrors/gbdk-2020
2
0
Fork 0
mirror of https://github.com/gbdk-2020/gbdk-2020.git synced 2026-03-10 01:07:46 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
5ce20c7740a76cf378c080ecd919eb464d6a6a22
gbdk-2020/docs/api/malloc_8h.html
Toxa 340ecd6304 update docs
2021-02-08 11:50:39 +03:00

318 lines
15 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GBDK 2020 Docs: gb/malloc.h File Reference</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen_extra.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">GBDK 2020 Docs
</div>
<div id="projectbrief">API Documentation for GBDK 2020</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('malloc_8h.html',''); initResizable(); });
/* @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">
<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="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">malloc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;types.h&gt;</code><br />
</div>
<p><a href="malloc_8h_source.html">Go to the source code of this file.</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:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmalloc__hunk.html">smalloc_hunk</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a12ca68b5ad70e18b1bb705bb83181148"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#a12ca68b5ad70e18b1bb705bb83181148">MALLOC_FREE</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a12ca68b5ad70e18b1bb705bb83181148"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad799c724ea5f66caf6eee3f6401cf9f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#ad799c724ea5f66caf6eee3f6401cf9f2">MALLOC_USED</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ad799c724ea5f66caf6eee3f6401cf9f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa516296171f3e24c0bd2c224c0221a1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#aaa516296171f3e24c0bd2c224c0221a1">MALLOC_MAGIC</a>&#160;&#160;&#160;123</td></tr>
<tr class="separator:aaa516296171f3e24c0bd2c224c0221a1"><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:a0ac9e31945f09f01e6b33e74d39f83ab"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsmalloc__hunk.html">smalloc_hunk</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#a0ac9e31945f09f01e6b33e74d39f83ab">mmalloc_hunk</a></td></tr>
<tr class="separator:a0ac9e31945f09f01e6b33e74d39f83ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad521838368171a2564658d4e129d7922"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsmalloc__hunk.html">smalloc_hunk</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#ad521838368171a2564658d4e129d7922">pmmalloc_hunk</a></td></tr>
<tr class="separator:ad521838368171a2564658d4e129d7922"><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:a5381c84316659ee9aee28b781ea72043"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#a5381c84316659ee9aee28b781ea72043">malloc_gc</a> (void) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a5381c84316659ee9aee28b781ea72043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d4cef44ecf687909f2c744d8420f7f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#a0d4cef44ecf687909f2c744d8420f7f0">debug</a> (char *routine, char *msg) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a0d4cef44ecf687909f2c744d8420f7f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1f0de2ad46e0870a290a0541c9181054"><td class="memItemLeft" align="right" valign="top"><a class="el" href="asm_2types_8h.html#a280213815420791851f7e59bdc8a3c95">UBYTE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#a1f0de2ad46e0870a290a0541c9181054">malloc_heap_start</a></td></tr>
<tr class="separator:a1f0de2ad46e0870a290a0541c9181054"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af62987d0746c3fd2078e3b76d67a485d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="malloc_8h.html#ad521838368171a2564658d4e129d7922">pmmalloc_hunk</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="malloc_8h.html#af62987d0746c3fd2078e3b76d67a485d">malloc_first</a></td></tr>
<tr class="separator:af62987d0746c3fd2078e3b76d67a485d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header for a simple implementation of <a class="el" href="stdlib_8h.html#a7ac38fce3243a7dcf448301ee9ffd392">malloc()</a>.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>: This library may currently be broken. </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a12ca68b5ad70e18b1bb705bb83181148"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12ca68b5ad70e18b1bb705bb83181148">&#9670;&nbsp;</a></span>MALLOC_FREE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MALLOC_FREE&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The malloc hunk flags Note: Cound have used a negative size a'la TI </p>
</div>
</div>
<a id="ad799c724ea5f66caf6eee3f6401cf9f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad799c724ea5f66caf6eee3f6401cf9f2">&#9670;&nbsp;</a></span>MALLOC_USED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MALLOC_USED&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaa516296171f3e24c0bd2c224c0221a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa516296171f3e24c0bd2c224c0221a1">&#9670;&nbsp;</a></span>MALLOC_MAGIC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MALLOC_MAGIC&#160;&#160;&#160;123</td>
</tr>
</table>
</div><div class="memdoc">
<p>Magic number of a header. Gives us some chance of surviving if the list is corrupted </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a0ac9e31945f09f01e6b33e74d39f83ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ac9e31945f09f01e6b33e74d39f83ab">&#9670;&nbsp;</a></span>mmalloc_hunk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsmalloc__hunk.html">smalloc_hunk</a> <a class="el" href="malloc_8h.html#a0ac9e31945f09f01e6b33e74d39f83ab">mmalloc_hunk</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad521838368171a2564658d4e129d7922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad521838368171a2564658d4e129d7922">&#9670;&nbsp;</a></span>pmmalloc_hunk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsmalloc__hunk.html">smalloc_hunk</a>* <a class="el" href="malloc_8h.html#ad521838368171a2564658d4e129d7922">pmmalloc_hunk</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a5381c84316659ee9aee28b781ea72043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5381c84316659ee9aee28b781ea72043">&#9670;&nbsp;</a></span>malloc_gc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void malloc_gc </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Garbage collect (join free hunks) </p>
</div>
</div>
<a id="a0d4cef44ecf687909f2c744d8420f7f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d4cef44ecf687909f2c744d8420f7f0">&#9670;&nbsp;</a></span>debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void debug </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>routine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>msg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>debug message logger </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1f0de2ad46e0870a290a0541c9181054"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f0de2ad46e0870a290a0541c9181054">&#9670;&nbsp;</a></span>malloc_heap_start</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="asm_2types_8h.html#a280213815420791851f7e59bdc8a3c95">UBYTE</a> malloc_heap_start</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start of free memory, as defined by the linker </p>
</div>
</div>
<a id="af62987d0746c3fd2078e3b76d67a485d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af62987d0746c3fd2078e3b76d67a485d">&#9670;&nbsp;</a></span>malloc_first</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="malloc_8h.html#ad521838368171a2564658d4e129d7922">pmmalloc_hunk</a> malloc_first</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>First hunk </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink