carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
							<!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>GRPC Core: include/grpc/support/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="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">GRPC Core
   &#160;<span id="projectnumber">6.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 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_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_cad3142e04109052413f2d2a2d1813b0.html">support</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">alloc.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="support_2port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
</div>
<p><a href="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="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="structgpr__allocation__functions.html">gpr_allocation_functions</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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a54bbd527f303da4b618adb37ae44efd7"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#a54bbd527f303da4b618adb37ae44efd7">gpr_allocation_functions</a></td></tr>
<tr class="separator:a54bbd527f303da4b618adb37ae44efd7"><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:aa15f6aa58f356420b0d955fc6e506a60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#aa15f6aa58f356420b0d955fc6e506a60">gpr_malloc</a> (size_t size)</td></tr>
<tr class="memdesc:aa15f6aa58f356420b0d955fc6e506a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">malloc.  <a href="#aa15f6aa58f356420b0d955fc6e506a60">More...</a><br /></td></tr>
<tr class="separator:aa15f6aa58f356420b0d955fc6e506a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9a7a782f4f00cad27d64d27ebbd1a72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#ad9a7a782f4f00cad27d64d27ebbd1a72">gpr_zalloc</a> (size_t size)</td></tr>
<tr class="memdesc:ad9a7a782f4f00cad27d64d27ebbd1a72"><td class="mdescLeft">&#160;</td><td class="mdescRight">like malloc, but zero all bytes before returning them  <a href="#ad9a7a782f4f00cad27d64d27ebbd1a72">More...</a><br /></td></tr>
<tr class="separator:ad9a7a782f4f00cad27d64d27ebbd1a72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f8641de6e80a37dd003d3100cc94bd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#a7f8641de6e80a37dd003d3100cc94bd7">gpr_free</a> (void *ptr)</td></tr>
<tr class="memdesc:a7f8641de6e80a37dd003d3100cc94bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">free  <a href="#a7f8641de6e80a37dd003d3100cc94bd7">More...</a><br /></td></tr>
<tr class="separator:a7f8641de6e80a37dd003d3100cc94bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4282437d10bb2b1a2c44d665a97984f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#a4282437d10bb2b1a2c44d665a97984f4">gpr_realloc</a> (void *p, size_t size)</td></tr>
<tr class="memdesc:a4282437d10bb2b1a2c44d665a97984f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">realloc, never returns NULL  <a href="#a4282437d10bb2b1a2c44d665a97984f4">More...</a><br /></td></tr>
<tr class="separator:a4282437d10bb2b1a2c44d665a97984f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29ae1ca65e84c7df8626d0a6de2a581a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#a29ae1ca65e84c7df8626d0a6de2a581a">gpr_malloc_aligned</a> (size_t size, size_t alignment)</td></tr>
<tr class="memdesc:a29ae1ca65e84c7df8626d0a6de2a581a"><td class="mdescLeft">&#160;</td><td class="mdescRight">aligned malloc, never returns NULL, will align to alignment, which must be a power of 2.  <a href="#a29ae1ca65e84c7df8626d0a6de2a581a">More...</a><br /></td></tr>
<tr class="separator:a29ae1ca65e84c7df8626d0a6de2a581a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafbdc542e56bcd24fcb80a9cd55afef1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#aafbdc542e56bcd24fcb80a9cd55afef1">gpr_free_aligned</a> (void *ptr)</td></tr>
<tr class="memdesc:aafbdc542e56bcd24fcb80a9cd55afef1"><td class="mdescLeft">&#160;</td><td class="mdescRight">free memory allocated by gpr_malloc_aligned  <a href="#aafbdc542e56bcd24fcb80a9cd55afef1">More...</a><br /></td></tr>
<tr class="separator:aafbdc542e56bcd24fcb80a9cd55afef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a32fcafdda423e2a11b4130d55951b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#a2a32fcafdda423e2a11b4130d55951b4">gpr_set_allocation_functions</a> (<a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a> functions)</td></tr>
<tr class="memdesc:a2a32fcafdda423e2a11b4130d55951b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the family of allocation functions in <em>functions</em> be used.  <a href="#a2a32fcafdda423e2a11b4130d55951b4">More...</a><br /></td></tr>
<tr class="separator:a2a32fcafdda423e2a11b4130d55951b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa96aa61deb3f72c6e5d8f57d08942602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alloc_8h.html#aa96aa61deb3f72c6e5d8f57d08942602">gpr_get_allocation_functions</a> (void)</td></tr>
<tr class="memdesc:aa96aa61deb3f72c6e5d8f57d08942602"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the family of allocation functions currently in effect.  <a href="#aa96aa61deb3f72c6e5d8f57d08942602">More...</a><br /></td></tr>
<tr class="separator:aa96aa61deb3f72c6e5d8f57d08942602"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a54bbd527f303da4b618adb37ae44efd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54bbd527f303da4b618adb37ae44efd7">&#9670;&nbsp;</a></span>gpr_allocation_functions</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a>  <a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7f8641de6e80a37dd003d3100cc94bd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f8641de6e80a37dd003d3100cc94bd7">&#9670;&nbsp;</a></span>gpr_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_free </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>ptr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>free </p>

</div>
</div>
<a id="aafbdc542e56bcd24fcb80a9cd55afef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafbdc542e56bcd24fcb80a9cd55afef1">&#9670;&nbsp;</a></span>gpr_free_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_free_aligned </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>ptr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>free memory allocated by gpr_malloc_aligned </p>

</div>
</div>
<a id="aa96aa61deb3f72c6e5d8f57d08942602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96aa61deb3f72c6e5d8f57d08942602">&#9670;&nbsp;</a></span>gpr_get_allocation_functions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a> gpr_get_allocation_functions </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the family of allocation functions currently in effect. </p>

</div>
</div>
<a id="aa15f6aa58f356420b0d955fc6e506a60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa15f6aa58f356420b0d955fc6e506a60">&#9670;&nbsp;</a></span>gpr_malloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_malloc </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>malloc. </p>
<p>If size==0, always returns NULL. Otherwise this function never returns NULL. The pointer returned is suitably aligned for any kind of variable it could contain. </p>

</div>
</div>
<a id="a29ae1ca65e84c7df8626d0a6de2a581a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29ae1ca65e84c7df8626d0a6de2a581a">&#9670;&nbsp;</a></span>gpr_malloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_malloc_aligned </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>aligned malloc, never returns NULL, will align to alignment, which must be a power of 2. </p>

</div>
</div>
<a id="a4282437d10bb2b1a2c44d665a97984f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4282437d10bb2b1a2c44d665a97984f4">&#9670;&nbsp;</a></span>gpr_realloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_realloc </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_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>realloc, never returns NULL </p>

</div>
</div>
<a id="a2a32fcafdda423e2a11b4130d55951b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a32fcafdda423e2a11b4130d55951b4">&#9670;&nbsp;</a></span>gpr_set_allocation_functions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_allocation_functions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgpr__allocation__functions.html">gpr_allocation_functions</a>&#160;</td>
          <td class="paramname"><em>functions</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Request the family of allocation functions in <em>functions</em> be used. </p>
<p>NOTE that this request will be honored in a <em>best effort</em> basis and that no guarantees are made about the default functions (eg, malloc) being called. The functions.free_fn implementation must be a no-op for NULL input. </p>

</div>
</div>
<a id="ad9a7a782f4f00cad27d64d27ebbd1a72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a7a782f4f00cad27d64d27ebbd1a72">&#9670;&nbsp;</a></span>gpr_zalloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_zalloc </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>like malloc, but zero all bytes before returning them </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 13 2018 15:03:52 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>