<!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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS V2: C:/Dev/git/UbixOS/sys/include/net/mem.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">UbixOS V2
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('mem_8h.html','');});
/* @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="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mem.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="opt_8h_source.html">net/opt.h</a>></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for mem.h:</div>
<div class="dyncontent">
<div class="center"><img src="mem_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2mem_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="mem_8h__dep__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2mem_8hdep" alt=""/></div>
</div>
</div>
<p><a href="mem_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2cf923436027f37ef24b3abd898120a7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a2cf923436027f37ef24b3abd898120a7">MEM_SIZE_F</a>   <a class="el" href="group__compiler__abstraction.html#gaa9d7f6eb2ee9fcc5eda3545dbb1886e0">U16_F</a></td></tr>
<tr class="separator:a2cf923436027f37ef24b3abd898120a7"><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:a49bff6e5dd4cb95fe6dc0670962bbf54"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a></td></tr>
<tr class="separator:a49bff6e5dd4cb95fe6dc0670962bbf54"><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:ab0bdc525971701883f2065e7fb257a24"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#ab0bdc525971701883f2065e7fb257a24">mem_calloc</a> (<a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> count, <a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> size)</td></tr>
<tr class="separator:ab0bdc525971701883f2065e7fb257a24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fd7aa1adf6e394d3be7c7734e7df41a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a2fd7aa1adf6e394d3be7c7734e7df41a">mem_free</a> (void *<a class="el" href="structmem.html">mem</a>)</td></tr>
<tr class="separator:a2fd7aa1adf6e394d3be7c7734e7df41a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a136e3b70c36abb6f8dc060c778113"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a44a136e3b70c36abb6f8dc060c778113">mem_init</a> (void)</td></tr>
<tr class="separator:a44a136e3b70c36abb6f8dc060c778113"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a932aa40d85b14cb7331625e012d12335"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a932aa40d85b14cb7331625e012d12335">mem_malloc</a> (<a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> size)</td></tr>
<tr class="separator:a932aa40d85b14cb7331625e012d12335"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e39a108c44d8a72df0b30a117cb62e4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mem_8h.html#a5e39a108c44d8a72df0b30a117cb62e4">mem_trim</a> (void *<a class="el" href="structmem.html">mem</a>, <a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> size)</td></tr>
<tr class="separator:a5e39a108c44d8a72df0b30a117cb62e4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Heap API </p>
<p class="definition">Definition in file <a class="el" href="mem_8h_source.html">mem.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a2cf923436027f37ef24b3abd898120a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cf923436027f37ef24b3abd898120a7">◆ </a></span>MEM_SIZE_F</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEM_SIZE_F   <a class="el" href="group__compiler__abstraction.html#gaa9d7f6eb2ee9fcc5eda3545dbb1886e0">U16_F</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="mem_8h_source.html#l00068">68</a> of file <a class="el" href="mem_8h_source.html">mem.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a49bff6e5dd4cb95fe6dc0670962bbf54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49bff6e5dd4cb95fe6dc0670962bbf54">◆ </a></span>mem_size_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="mem_8h_source.html#l00067">67</a> of file <a class="el" href="mem_8h_source.html">mem.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab0bdc525971701883f2065e7fb257a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0bdc525971701883f2065e7fb257a24">◆ </a></span>mem_calloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mem_calloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Contiguously allocates enough space for count objects that are size bytes of memory each and returns a pointer to the allocated memory.</p>
<p>The allocated memory is filled with bytes of value zero.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>number of objects to allocate </td></tr>
<tr><td class="paramname">size</td><td>size of the objects to allocate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to allocated memory / NULL pointer if there is an error </dd></dl>
<p class="definition">Definition at line <a class="el" href="mem_8c_source.html#l00765">765</a> of file <a class="el" href="mem_8c_source.html">mem.c</a>.</p>
<p class="reference">References <a class="el" href="mem_8c_source.html#l00603">mem_malloc()</a>, and <a class="el" href="string_8h.html#ace4b911463887af5e748326323e99a23">memset()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="mem_8h_ab0bdc525971701883f2065e7fb257a24_cgraph.png" border="0" usemap="#mem_8h_ab0bdc525971701883f2065e7fb257a24_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a2fd7aa1adf6e394d3be7c7734e7df41a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fd7aa1adf6e394d3be7c7734e7df41a">◆ </a></span>mem_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mem_free </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>rmem</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Put a struct mem back on the heap</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rmem</td><td>is the data portion of a struct mem as returned by a previous call to <a class="el" href="mem_8c.html#a932aa40d85b14cb7331625e012d12335">mem_malloc()</a> </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="mem_8c_source.html#l00419">419</a> of file <a class="el" href="mem_8c_source.html">mem.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="debug_8h_source.html#l00057">LWIP_DBG_LEVEL_SERIOUS</a>, <a class="el" href="debug_8h_source.html#l00083">LWIP_DBG_TRACE</a>, <a class="el" href="debug_8h_source.html#l00164">LWIP_DEBUGF</a>, <a class="el" href="mem_8c_source.html#l00321">LWIP_MEM_FREE_DECL_PROTECT</a>, <a class="el" href="lwipopts_8h_source.html#l00054">MEM_ALIGNMENT</a>, <a class="el" href="lwipopts_8h_source.html#l00455">MEM_DEBUG</a>, and <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>.</p>
<p class="reference">Referenced by <a class="el" href="tcpip_8c_source.html#l00491">mem_free_callback()</a>, and <a class="el" href="pbuf_8c_source.html#l00715">pbuf_free()</a>.</p>
</div>
</div>
<a id="a44a136e3b70c36abb6f8dc060c778113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a136e3b70c36abb6f8dc060c778113">◆ </a></span>mem_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mem_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Zero the heap and initialize start, end and lowest-free </p>
<p class="definition">Definition at line <a class="el" href="mem_8c_source.html#l00382">382</a> of file <a class="el" href="mem_8c_source.html">mem.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="lwipopts_8h_source.html#l00054">MEM_ALIGNMENT</a>, and <a class="el" href="mem_8c_source.html#l00281">SIZEOF_STRUCT_MEM</a>.</p>
<p class="reference">Referenced by <a class="el" href="core_2init_8c_source.html#l00333">lwip_init()</a>.</p>
</div>
</div>
<a id="a932aa40d85b14cb7331625e012d12335"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a932aa40d85b14cb7331625e012d12335">◆ </a></span>mem_malloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mem_malloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a block of memory with a minimum of 'size' bytes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>is the minimum size of the requested block in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to allocated memory or NULL if no free memory was found.</dd></dl>
<p>Note that the returned value will always be aligned (as defined by MEM_ALIGNMENT). </p>
<p class="definition">Definition at line <a class="el" href="mem_8c_source.html#l00603">603</a> of file <a class="el" href="mem_8c_source.html">mem.c</a>.</p>
<p class="reference">References <a class="el" href="arch_8h_source.html#l00221">LWIP_MEM_ALIGN_SIZE</a>, <a class="el" href="mem_8c_source.html#l00325">LWIP_MEM_ALLOC_DECL_PROTECT</a>, <a class="el" href="mem_8c_source.html#l00282">MEM_SIZE_ALIGNED</a>, <a class="el" href="mem_8c_source.html#l00280">MIN_SIZE_ALIGNED</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, and <a class="el" href="sys__arch_8c_source.html#l00153">sys_mutex_lock()</a>.</p>
<p class="reference">Referenced by <a class="el" href="ethernetif_8c_source.html#l00302">ethernetif_init()</a>, <a class="el" href="mem_8c_source.html#l00765">mem_calloc()</a>, and <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="mem_8h_a932aa40d85b14cb7331625e012d12335_cgraph.png" border="0" usemap="#mem_8h_a932aa40d85b14cb7331625e012d12335_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a5e39a108c44d8a72df0b30a117cb62e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e39a108c44d8a72df0b30a117cb62e4">◆ </a></span>mem_trim()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mem_trim </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>rmem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mem_8h.html#a49bff6e5dd4cb95fe6dc0670962bbf54">mem_size_t</a> </td>
<td class="paramname"><em>newsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shrink memory returned by <a class="el" href="mem_8c.html#a932aa40d85b14cb7331625e012d12335">mem_malloc()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rmem</td><td>pointer to memory allocated by mem_malloc the is to be shrinked </td></tr>
<tr><td class="paramname">newsize</td><td>required size after shrinking (needs to be smaller than or equal to the previous size) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>for compatibility reasons: is always == rmem, at the moment or NULL if newsize is > old size, in which case rmem is NOT touched or freed! </dd></dl>
<p class="definition">Definition at line <a class="el" href="mem_8c_source.html#l00478">478</a> of file <a class="el" href="mem_8c_source.html">mem.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="arch_8h_source.html#l00221">LWIP_MEM_ALIGN_SIZE</a>, <a class="el" href="mem_8c_source.html#l00321">LWIP_MEM_FREE_DECL_PROTECT</a>, <a class="el" href="mem_8c_source.html#l00282">MEM_SIZE_ALIGNED</a>, <a class="el" href="mem_8c_source.html#l00280">MIN_SIZE_ALIGNED</a>, and <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>.</p>
<p class="reference">Referenced by <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>.</p>
</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="navelem"><a class="el" href="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="mem_8h.html">mem.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
