<!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"/> <title>Apache Portable Runtime: apr_rmm.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>apr_rmm.h</h1> </div> </div> <div class="contents"> <a href="apr__rmm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span> <a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span> <a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span> <a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> <a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span> <a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span> <a name="l00007"></a>00007 <span class="comment"> *</span> <a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> <a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span> <a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span> <a name="l00015"></a>00015 <span class="comment"> */</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_RMM_H</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_RMM_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment">/** </span> <a name="l00020"></a>00020 <span class="comment"> * @file apr_rmm.h</span> <a name="l00021"></a>00021 <span class="comment"> * @brief APR-UTIL Relocatable Memory Management Routines</span> <a name="l00022"></a>00022 <span class="comment"> */</span><span class="comment"></span> <a name="l00023"></a>00023 <span class="comment">/**</span> <a name="l00024"></a>00024 <span class="comment"> * @defgroup APR_Util_RMM Relocatable Memory Management Routines</span> <a name="l00025"></a>00025 <span class="comment"> * @ingroup APR_Util</span> <a name="l00026"></a>00026 <span class="comment"> * @{</span> <a name="l00027"></a>00027 <span class="comment"> */</span> <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span> <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span> <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span> <a name="l00032"></a>00032 <span class="preprocessor">#include "apu.h"</span> <a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="apr__anylock_8h.html" title="APR-Util transparent any lock flavor wrapper.">apr_anylock.h</a>"</span> <a name="l00034"></a>00034 <a name="l00035"></a>00035 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00036"></a>00036 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { <a name="l00037"></a>00037 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> <a name="l00038"></a>00038 <span class="comment"></span> <a name="l00039"></a>00039 <span class="comment">/** Structure to access Relocatable, Managed Memory */</span> <a name="l00040"></a><a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">00040</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> <a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a>; <a name="l00041"></a>00041 <span class="comment"></span> <a name="l00042"></a>00042 <span class="comment">/** Fundamental allocation unit, within a specific apr_rmm_t */</span> <a name="l00043"></a><a class="code" href="group___a_p_r___util___r_m_m.html#ga70b508c81a0bc75350efdefb3410af12">00043</a> <span class="keyword">typedef</span> apr_size_t <a class="code" href="group___a_p_r___util___r_m_m.html#ga70b508c81a0bc75350efdefb3410af12">apr_rmm_off_t</a>; <a name="l00044"></a>00044 <span class="comment"></span> <a name="l00045"></a>00045 <span class="comment">/**</span> <a name="l00046"></a>00046 <span class="comment"> * Initialize a relocatable memory block to be managed by the apr_rmm API.</span> <a name="l00047"></a>00047 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00048"></a>00048 <span class="comment"> * @param lock An apr_anylock_t of the appropriate type of lock, or NULL</span> <a name="l00049"></a>00049 <span class="comment"> * if no locking is required.</span> <a name="l00050"></a>00050 <span class="comment"> * @param membuf The block of relocatable memory to be managed</span> <a name="l00051"></a>00051 <span class="comment"> * @param memsize The size of relocatable memory block to be managed</span> <a name="l00052"></a>00052 <span class="comment"> * @param cont The pool to use for local storage and management</span> <a name="l00053"></a>00053 <span class="comment"> * @remark Both @param membuf and @param memsize must be aligned</span> <a name="l00054"></a>00054 <span class="comment"> * (for instance using APR_ALIGN_DEFAULT).</span> <a name="l00055"></a>00055 <span class="comment"> */</span> <a name="l00056"></a>00056 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_m_m.html#ga65ebaca1a86f0667156592f40b81b681">apr_rmm_init</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> **rmm, <a class="code" href="structapr__anylock__t.html">apr_anylock_t</a> *lock, <a name="l00057"></a>00057 <span class="keywordtype">void</span> *membuf, apr_size_t memsize, <a name="l00058"></a>00058 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *cont); <a name="l00059"></a>00059 <span class="comment"></span> <a name="l00060"></a>00060 <span class="comment">/**</span> <a name="l00061"></a>00061 <span class="comment"> * Destroy a managed memory block.</span> <a name="l00062"></a>00062 <span class="comment"> * @param rmm The relocatable memory block to destroy</span> <a name="l00063"></a>00063 <span class="comment"> */</span> <a name="l00064"></a>00064 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_m_m.html#ga8ccae93038489f2acb7588292df5d80a">apr_rmm_destroy</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm); <a name="l00065"></a>00065 <span class="comment"></span> <a name="l00066"></a>00066 <span class="comment">/**</span> <a name="l00067"></a>00067 <span class="comment"> * Attach to a relocatable memory block already managed by the apr_rmm API.</span> <a name="l00068"></a>00068 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00069"></a>00069 <span class="comment"> * @param lock An apr_anylock_t of the appropriate type of lock</span> <a name="l00070"></a>00070 <span class="comment"> * @param membuf The block of relocatable memory already under management</span> <a name="l00071"></a>00071 <span class="comment"> * @param cont The pool to use for local storage and management</span> <a name="l00072"></a>00072 <span class="comment"> */</span> <a name="l00073"></a>00073 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_m_m.html#gadf144b4071c5c4d85cded37ca0e58dff">apr_rmm_attach</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> **rmm, <a class="code" href="structapr__anylock__t.html">apr_anylock_t</a> *lock, <a name="l00074"></a>00074 <span class="keywordtype">void</span> *membuf, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *cont); <a name="l00075"></a>00075 <span class="comment"></span> <a name="l00076"></a>00076 <span class="comment">/**</span> <a name="l00077"></a>00077 <span class="comment"> * Detach from the managed block of memory.</span> <a name="l00078"></a>00078 <span class="comment"> * @param rmm The relocatable memory block to detach from</span> <a name="l00079"></a>00079 <span class="comment"> */</span> <a name="l00080"></a>00080 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_m_m.html#ga2171746dcfa1e0f07717224ad106091e">apr_rmm_detach</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm); <a name="l00081"></a>00081 <span class="comment"></span> <a name="l00082"></a>00082 <span class="comment">/**</span> <a name="l00083"></a>00083 <span class="comment"> * Allocate memory from the block of relocatable memory.</span> <a name="l00084"></a>00084 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00085"></a>00085 <span class="comment"> * @param reqsize How much memory to allocate</span> <a name="l00086"></a>00086 <span class="comment"> */</span> <a name="l00087"></a>00087 APU_DECLARE(apr_rmm_off_t) <a class="code" href="group___a_p_r___util___r_m_m.html#ga31e42a7c40bbd3f7f132eaf347a79d32">apr_rmm_malloc</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, apr_size_t reqsize); <a name="l00088"></a>00088 <span class="comment"></span> <a name="l00089"></a>00089 <span class="comment">/**</span> <a name="l00090"></a>00090 <span class="comment"> * Realloc memory from the block of relocatable memory.</span> <a name="l00091"></a>00091 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00092"></a>00092 <span class="comment"> * @param entity The memory allocation to realloc</span> <a name="l00093"></a>00093 <span class="comment"> * @param reqsize The new size</span> <a name="l00094"></a>00094 <span class="comment"> */</span> <a name="l00095"></a>00095 APU_DECLARE(apr_rmm_off_t) <a class="code" href="group___a_p_r___util___r_m_m.html#ga78561452a8fb3fef18f1203efaa0b92f">apr_rmm_realloc</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, <span class="keywordtype">void</span> *entity, apr_size_t reqsize); <a name="l00096"></a>00096 <span class="comment"></span> <a name="l00097"></a>00097 <span class="comment">/**</span> <a name="l00098"></a>00098 <span class="comment"> * Allocate memory from the block of relocatable memory and initialize it to zero.</span> <a name="l00099"></a>00099 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00100"></a>00100 <span class="comment"> * @param reqsize How much memory to allocate</span> <a name="l00101"></a>00101 <span class="comment"> */</span> <a name="l00102"></a>00102 APU_DECLARE(apr_rmm_off_t) <a class="code" href="group___a_p_r___util___r_m_m.html#ga12ff2a4c23548e2f1616a17734defaf8">apr_rmm_calloc</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, apr_size_t reqsize); <a name="l00103"></a>00103 <span class="comment"></span> <a name="l00104"></a>00104 <span class="comment">/**</span> <a name="l00105"></a>00105 <span class="comment"> * Free allocation returned by apr_rmm_malloc or apr_rmm_calloc.</span> <a name="l00106"></a>00106 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00107"></a>00107 <span class="comment"> * @param entity The memory allocation to free</span> <a name="l00108"></a>00108 <span class="comment"> */</span> <a name="l00109"></a>00109 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_m_m.html#gad22b65c95d0964e37aecd4134294b016">apr_rmm_free</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, apr_rmm_off_t entity); <a name="l00110"></a>00110 <span class="comment"></span> <a name="l00111"></a>00111 <span class="comment">/**</span> <a name="l00112"></a>00112 <span class="comment"> * Retrieve the physical address of a relocatable allocation of memory</span> <a name="l00113"></a>00113 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00114"></a>00114 <span class="comment"> * @param entity The memory allocation to free</span> <a name="l00115"></a>00115 <span class="comment"> * @return address The address, aligned with APR_ALIGN_DEFAULT.</span> <a name="l00116"></a>00116 <span class="comment"> */</span> <a name="l00117"></a>00117 APU_DECLARE(<span class="keywordtype">void</span> *) <a class="code" href="group___a_p_r___util___r_m_m.html#ga6bf67e9f2d08f9f36d2c420648d8d3a0">apr_rmm_addr_get</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, apr_rmm_off_t entity); <a name="l00118"></a>00118 <span class="comment"></span> <a name="l00119"></a>00119 <span class="comment">/**</span> <a name="l00120"></a>00120 <span class="comment"> * Compute the offset of a relocatable allocation of memory</span> <a name="l00121"></a>00121 <span class="comment"> * @param rmm The relocatable memory block</span> <a name="l00122"></a>00122 <span class="comment"> * @param entity The physical address to convert to an offset</span> <a name="l00123"></a>00123 <span class="comment"> */</span> <a name="l00124"></a>00124 APU_DECLARE(apr_rmm_off_t) <a class="code" href="group___a_p_r___util___r_m_m.html#ga3ed2e880ebc695aa8dd241e21b5a666e">apr_rmm_offset_get</a>(<a class="code" href="group___a_p_r___util___r_m_m.html#gadb4d418c417ece33c4430ba9df59070a">apr_rmm_t</a> *rmm, <span class="keywordtype">void</span> *entity); <a name="l00125"></a>00125 <span class="comment"></span> <a name="l00126"></a>00126 <span class="comment">/**</span> <a name="l00127"></a>00127 <span class="comment"> * Compute the required overallocation of memory needed to fit n allocs</span> <a name="l00128"></a>00128 <span class="comment"> * @param n The number of alloc/calloc regions desired</span> <a name="l00129"></a>00129 <span class="comment"> */</span> <a name="l00130"></a>00130 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___r_m_m.html#gae638ec990cb1600f6f70a8b3a1e07ff8">apr_rmm_overhead_get</a>(<span class="keywordtype">int</span> n); <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00133"></a>00133 <span class="preprocessor"></span>} <a name="l00134"></a>00134 <span class="preprocessor">#endif</span> <a name="l00135"></a>00135 <span class="preprocessor"></span><span class="comment">/** @} */</span> <a name="l00136"></a>00136 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_RMM_H */</span> <a name="l00137"></a>00137 </pre></div></div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed May 25 2011 for Apache Portable Runtime by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>