<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: memory_buffer_alloc.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="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">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">memory_buffer_alloc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Buffer-based memory allocator.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br />
<code>#include <stddef.h></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for memory_buffer_alloc.h:</div>
<div class="dyncontent">
<div class="center"><img src="memory__buffer__alloc_8h__incl.png" border="0" usemap="#memory__buffer__alloc_8h" alt=""/></div>
<map name="memory__buffer__alloc_8h" id="memory__buffer__alloc_8h">
</map>
</div>
</div>
<p><a href="memory__buffer__alloc_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:a2b9fd1ef7a128cf7680e6c9c377134d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a2b9fd1ef7a128cf7680e6c9c377134d4">MBEDTLS_MEMORY_VERIFY_NONE</a>   0</td></tr>
<tr class="separator:a2b9fd1ef7a128cf7680e6c9c377134d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3fb815b3f3b7cfce7c5ddd6f2a33b80d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a3fb815b3f3b7cfce7c5ddd6f2a33b80d">MBEDTLS_MEMORY_VERIFY_ALLOC</a>   (1 << 0)</td></tr>
<tr class="separator:a3fb815b3f3b7cfce7c5ddd6f2a33b80d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c7f2d8956e95373dcb4fe24154b6650"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a1c7f2d8956e95373dcb4fe24154b6650">MBEDTLS_MEMORY_VERIFY_FREE</a>   (1 << 1)</td></tr>
<tr class="separator:a1c7f2d8956e95373dcb4fe24154b6650"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a581a709e67d33b34d3c8a7dfb4b3df00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a581a709e67d33b34d3c8a7dfb4b3df00">MBEDTLS_MEMORY_VERIFY_ALWAYS</a>   (<a class="el" href="memory__buffer__alloc_8h.html#a3fb815b3f3b7cfce7c5ddd6f2a33b80d">MBEDTLS_MEMORY_VERIFY_ALLOC</a> | <a class="el" href="memory__buffer__alloc_8h.html#a1c7f2d8956e95373dcb4fe24154b6650">MBEDTLS_MEMORY_VERIFY_FREE</a>)</td></tr>
<tr class="separator:a581a709e67d33b34d3c8a7dfb4b3df00"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">SECTION: Module settings</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The configuration options you can set for this module are in this section. Either change them in <a class="el" href="config_8h.html" title="Configuration options (set of defines) ">config.h</a> or define them on the compiler command line. </p>
</div></td></tr>
<tr class="memitem:a1fa1e20d4ff40eb6c2a740d7d26b2749"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a1fa1e20d4ff40eb6c2a740d7d26b2749">MBEDTLS_MEMORY_ALIGN_MULTIPLE</a>   4</td></tr>
<tr class="separator:a1fa1e20d4ff40eb6c2a740d7d26b2749"><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:ac70d134be54133c272d8eab2cb85dfbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#ac70d134be54133c272d8eab2cb85dfbf">mbedtls_memory_buffer_alloc_init</a> (unsigned char *buf, size_t len)</td></tr>
<tr class="memdesc:ac70d134be54133c272d8eab2cb85dfbf"><td class="mdescLeft"> </td><td class="mdescRight">Initialize use of stack-based memory allocator. The stack-based allocator does memory management inside the presented buffer and does not call calloc() and free(). It sets the global <a class="el" href="platform_8h.html#aa7fa389b6ec8a6c33f594f8c3f5c76ef">mbedtls_calloc()</a> and <a class="el" href="platform_8h.html#a4f80030b2d10f956f8ac00b57eebfbe8">mbedtls_free()</a> pointers to its own functions. (Provided <a class="el" href="platform_8h.html#aa7fa389b6ec8a6c33f594f8c3f5c76ef">mbedtls_calloc()</a> and <a class="el" href="platform_8h.html#a4f80030b2d10f956f8ac00b57eebfbe8">mbedtls_free()</a> are thread-safe if MBEDTLS_THREADING_C is defined) <a href="#ac70d134be54133c272d8eab2cb85dfbf">More...</a><br /></td></tr>
<tr class="separator:ac70d134be54133c272d8eab2cb85dfbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9d7316a19b72776f34ba74720a06325"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#ae9d7316a19b72776f34ba74720a06325">mbedtls_memory_buffer_alloc_free</a> (void)</td></tr>
<tr class="memdesc:ae9d7316a19b72776f34ba74720a06325"><td class="mdescLeft"> </td><td class="mdescRight">Free the mutex for thread-safety and clear remaining memory. <a href="#ae9d7316a19b72776f34ba74720a06325">More...</a><br /></td></tr>
<tr class="separator:ae9d7316a19b72776f34ba74720a06325"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa50603bb2f2f1fe8d97d6953589b832"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#aaa50603bb2f2f1fe8d97d6953589b832">mbedtls_memory_buffer_set_verify</a> (int verify)</td></tr>
<tr class="memdesc:aaa50603bb2f2f1fe8d97d6953589b832"><td class="mdescLeft"> </td><td class="mdescRight">Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data. (Default: MBEDTLS_MEMORY_VERIFY_NONE) <a href="#aaa50603bb2f2f1fe8d97d6953589b832">More...</a><br /></td></tr>
<tr class="separator:aaa50603bb2f2f1fe8d97d6953589b832"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7aae8a0cd61f08dd6734ebc8a8a3ba38"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#a7aae8a0cd61f08dd6734ebc8a8a3ba38">mbedtls_memory_buffer_alloc_verify</a> (void)</td></tr>
<tr class="memdesc:a7aae8a0cd61f08dd6734ebc8a8a3ba38"><td class="mdescLeft"> </td><td class="mdescRight">Verifies that all headers in the memory buffer are correct and contain sane values. Helps debug buffer-overflow errors. <a href="#a7aae8a0cd61f08dd6734ebc8a8a3ba38">More...</a><br /></td></tr>
<tr class="separator:a7aae8a0cd61f08dd6734ebc8a8a3ba38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1304c317468fb66c21ee52c79efe084"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="memory__buffer__alloc_8h.html#ab1304c317468fb66c21ee52c79efe084">mbedtls_memory_buffer_alloc_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:ab1304c317468fb66c21ee52c79efe084"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#ab1304c317468fb66c21ee52c79efe084">More...</a><br /></td></tr>
<tr class="separator:ab1304c317468fb66c21ee52c79efe084"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Buffer-based memory allocator. </p>
<p class="definition">Definition in file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1fa1e20d4ff40eb6c2a740d7d26b2749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fa1e20d4ff40eb6c2a740d7d26b2749">◆ </a></span>MBEDTLS_MEMORY_ALIGN_MULTIPLE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_MEMORY_ALIGN_MULTIPLE   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Align on multiples of this value </p>
<p class="definition">Definition at line <a class="el" href="memory__buffer__alloc_8h_source.html#l00044">44</a> of file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div>
</div>
<a id="a3fb815b3f3b7cfce7c5ddd6f2a33b80d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fb815b3f3b7cfce7c5ddd6f2a33b80d">◆ </a></span>MBEDTLS_MEMORY_VERIFY_ALLOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_MEMORY_VERIFY_ALLOC   (1 << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memory__buffer__alloc_8h_source.html#l00050">50</a> of file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div>
</div>
<a id="a581a709e67d33b34d3c8a7dfb4b3df00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a581a709e67d33b34d3c8a7dfb4b3df00">◆ </a></span>MBEDTLS_MEMORY_VERIFY_ALWAYS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_MEMORY_VERIFY_ALWAYS   (<a class="el" href="memory__buffer__alloc_8h.html#a3fb815b3f3b7cfce7c5ddd6f2a33b80d">MBEDTLS_MEMORY_VERIFY_ALLOC</a> | <a class="el" href="memory__buffer__alloc_8h.html#a1c7f2d8956e95373dcb4fe24154b6650">MBEDTLS_MEMORY_VERIFY_FREE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memory__buffer__alloc_8h_source.html#l00052">52</a> of file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div>
</div>
<a id="a1c7f2d8956e95373dcb4fe24154b6650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c7f2d8956e95373dcb4fe24154b6650">◆ </a></span>MBEDTLS_MEMORY_VERIFY_FREE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_MEMORY_VERIFY_FREE   (1 << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memory__buffer__alloc_8h_source.html#l00051">51</a> of file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div>
</div>
<a id="a2b9fd1ef7a128cf7680e6c9c377134d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b9fd1ef7a128cf7680e6c9c377134d4">◆ </a></span>MBEDTLS_MEMORY_VERIFY_NONE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_MEMORY_VERIFY_NONE   0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memory__buffer__alloc_8h_source.html#l00049">49</a> of file <a class="el" href="memory__buffer__alloc_8h_source.html">memory_buffer_alloc.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae9d7316a19b72776f34ba74720a06325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9d7316a19b72776f34ba74720a06325">◆ </a></span>mbedtls_memory_buffer_alloc_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_memory_buffer_alloc_free </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the mutex for thread-safety and clear remaining memory. </p>
</div>
</div>
<a id="ac70d134be54133c272d8eab2cb85dfbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac70d134be54133c272d8eab2cb85dfbf">◆ </a></span>mbedtls_memory_buffer_alloc_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_memory_buffer_alloc_init </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize use of stack-based memory allocator. The stack-based allocator does memory management inside the presented buffer and does not call calloc() and free(). It sets the global <a class="el" href="platform_8h.html#aa7fa389b6ec8a6c33f594f8c3f5c76ef">mbedtls_calloc()</a> and <a class="el" href="platform_8h.html#a4f80030b2d10f956f8ac00b57eebfbe8">mbedtls_free()</a> pointers to its own functions. (Provided <a class="el" href="platform_8h.html#aa7fa389b6ec8a6c33f594f8c3f5c76ef">mbedtls_calloc()</a> and <a class="el" href="platform_8h.html#a4f80030b2d10f956f8ac00b57eebfbe8">mbedtls_free()</a> are thread-safe if MBEDTLS_THREADING_C is defined) </p>
<dl class="section note"><dt>Note</dt><dd>This code is not optimized and provides a straight-forward implementation of a stack-based memory allocator.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>buffer to use as heap </td></tr>
<tr><td class="paramname">len</td><td>size of the buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab1304c317468fb66c21ee52c79efe084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1304c317468fb66c21ee52c79efe084">◆ </a></span>mbedtls_memory_buffer_alloc_self_test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_memory_buffer_alloc_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checkup routine. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if a test failed </dd></dl>
</div>
</div>
<a id="a7aae8a0cd61f08dd6734ebc8a8a3ba38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7aae8a0cd61f08dd6734ebc8a8a3ba38">◆ </a></span>mbedtls_memory_buffer_alloc_verify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_memory_buffer_alloc_verify </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Verifies that all headers in the memory buffer are correct and contain sane values. Helps debug buffer-overflow errors. </p>
<p>Prints out first failure if MBEDTLS_MEMORY_DEBUG is defined. Prints out full header information if MBEDTLS_MEMORY_DEBUG is defined. (Includes stack trace information for each block if MBEDTLS_MEMORY_BACKTRACE is defined as well).</p>
<dl class="section return"><dt>Returns</dt><dd>0 if verified, 1 otherwise </dd></dl>
</div>
</div>
<a id="aaa50603bb2f2f1fe8d97d6953589b832"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa50603bb2f2f1fe8d97d6953589b832">◆ </a></span>mbedtls_memory_buffer_set_verify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_memory_buffer_set_verify </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verify</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data. (Default: MBEDTLS_MEMORY_VERIFY_NONE) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">verify</td><td>One of MBEDTLS_MEMORY_VERIFY_NONE, MBEDTLS_MEMORY_VERIFY_ALLOC, MBEDTLS_MEMORY_VERIFY_FREE or MBEDTLS_MEMORY_VERIFY_ALWAYS </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
