<!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>Apache Portable Runtime: apr_pools.h Source File</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">Apache Portable Runtime
</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">apr_pools.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="apr__pools_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef APR_POOLS_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define APR_POOLS_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/**</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @file apr_pools.h</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief APR memory allocation</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Resource allocation routines...</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * designed so that we don't have to keep track of EVERYTHING so that</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * it can be explicitly freed later (a fundamentally unsound strategy ---</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * particularly in the presence of die()).</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> *</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * Instead, we maintain pools, and allocate items (both memory and I/O</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * handlers) from the pools --- currently there are two, one for</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * per-transaction info, and one for config info. When a transaction is</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * over, we can delete everything in the per-transaction apr_pool_t without</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * fear, and without thinking too hard about it either.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Note that most operations on pools are not thread-safe: a single pool</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * should only be accessed by a single thread at any given time. The one</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * exception to this rule is creating a subpool of a given pool: one or more</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * threads can safely create subpools at the same time that another thread</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * accesses the parent pool.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include "<a class="code" href="apr__general_8h.html">apr_general.h</a>"</span> <span class="comment">/* for APR_STRINGIFY */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="apr__pools_8h.html#a26faf43e3f61783d8b7aa928c0a41a11"> 46</a></span> <span class="preprocessor">#define APR_WANT_MEMFUNC </span><span class="comment">/**< for no good reason? */</span><span class="preprocessor"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "<a class="code" href="apr__want_8h.html">apr_want.h</a>"</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/**</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @defgroup apr_pools Memory Pool Functions</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @ingroup APR </span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/** The fundamental pool type */</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb"> 60</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/**</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Declaration helper macro to construct apr_foo_pool_get()s.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * This standardized macro is used by opaque (APR) data types to return</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * the apr_pool_t that is associated with the data type.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> *</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * APR_POOL_DECLARE_ACCESSOR() is used in a header file to declare the</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * accessor function. A typical usage and result would be:</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * <pre></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * APR_POOL_DECLARE_ACCESSOR(file);</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * becomes:</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * APR_DECLARE(apr_pool_t *) apr_file_pool_get(const apr_file_t *thefile);</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * </pre></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @remark Doxygen unwraps this macro (via doxygen.conf) to provide </span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * actual help for each specific occurrence of apr_foo_pool_get.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @remark the linkage is specified for APR. It would be possible to expand</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * the macros to support other linkages.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394"> 81</a></span> <span class="preprocessor">#define APR_POOL_DECLARE_ACCESSOR(type) \</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"> APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> (const apr_##type##_t *the##type)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/** </span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * Implementation helper macro to provide apr_foo_pool_get()s.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * In the implementation, the APR_POOL_IMPLEMENT_ACCESSOR() is used to</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * actually define the function. It assumes the field is named "pool".</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__apr__pools.html#ga43a8a52f68f8b7d3b7694c254da4a074"> 91</a></span> <span class="preprocessor">#define APR_POOL_IMPLEMENT_ACCESSOR(type) \</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> (const apr_##type##_t *the##type) \</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> { return the##type->pool; }</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/**</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * Pool debug levels</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> *</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * <pre></span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * ---------------------------------</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * | | | | | | | | x | General debug code enabled (useful in</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * combination with --with-efence).</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * | | | | | | | x | | Verbose output on stderr (report</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * CREATE, CLEAR, DESTROY).</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> *</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * | | | | x | | | | | Verbose output on stderr (report</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * PALLOC, PCALLOC).</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * | | | | | | x | | | Lifetime checking. On each use of a</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * pool, check its lifetime. If the pool</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * is out of scope, abort().</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * In combination with the verbose flag</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * above, it will output LIFE in such an</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * event prior to aborting.</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> *</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * | | | | | x | | | | Pool owner checking. On each use of a</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * pool, check if the current thread is the</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * pool's owner. If not, abort(). In</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * combination with the verbose flag above,</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * it will output OWNER in such an event</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * prior to aborting. Use the debug</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * function apr_pool_owner_set() to switch</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * a pool's ownership.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> *</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * When no debug level was specified, assume general debug mode.</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * If level 0 was specified, debugging is switched off.</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * </pre></span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#if defined(APR_POOL_DEBUG)</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/* If APR_POOL_DEBUG is blank, we get 1; if it is a number, we get -1. */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#if (APR_POOL_DEBUG - APR_POOL_DEBUG -1 == 1)</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#undef APR_POOL_DEBUG</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#define APR_POOL_DEBUG 1</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#define APR_POOL_DEBUG 0</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/** the place in the code where the particular function was called */</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="group__apr__pools.html#gac81cff34d0ff4be52fa924663478eade"> 143</a></span> <span class="preprocessor">#define APR_POOL__FILE_LINE__ __FILE__ ":" APR_STRINGIFY(__LINE__)</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/** A function that is called when allocation fails. */</span></div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd"> 148</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a>)(<span class="keywordtype">int</span> retcode);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/*</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * APR memory structure manipulators (pools, tables, and arrays).</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> */</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/*</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * Initialization</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> */</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">/**</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * Setup all of the internal structures required to use pools</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @remark Programs do NOT need to call this directly. APR will call this</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * automatically from apr_initialize.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @internal</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> */</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gad64a6a29515621bc13f8a8da50366d67">apr_pool_initialize</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">/**</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * Tear down all of the internal structures required to use pools</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @remark Programs do NOT need to call this directly. APR will call this</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * automatically from apr_terminate.</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @internal</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> */</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#ga3728aacec227318cef973b8a33f3b430">apr_pool_terminate</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">/*</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * Pool creation/destruction</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor">#include "<a class="code" href="apr__allocator_8h.html">apr_allocator.h</a>"</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">/**</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * Create a new pool.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @param newpool The pool we have just created.</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @param parent The parent pool. If this is NULL, the new pool is a root</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * pool. If it is non-NULL, the new pool will inherit all</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * of its parent pool's attributes, except the apr_pool_t will</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * be a sub-pool.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param abort_fn A function to use if the pool cannot allocate more memory.</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param allocator The allocator to use with the new pool. If NULL the</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * allocator of the parent pool will be used.</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @remark This function is thread-safe, in the sense that multiple threads</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * can safely create subpools of the same parent pool concurrently.</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * Similarly, a subpool can be created by one thread at the same</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * time that another thread accesses the parent pool.</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> */</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gab274bd29e4e4d4944b4618403148074f">apr_pool_create_ex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent,</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator)</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"></span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">/**</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * Create a new pool.</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @deprecated @see apr_pool_create_unmanaged_ex.</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#ga20e514c83555398acddc30c4dfa0c540">apr_pool_create_core_ex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator);</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"></span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/**</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * Create a new unmanaged pool.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * @param newpool The pool we have just created.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @param abort_fn A function to use if the pool cannot allocate more memory.</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param allocator The allocator to use with the new pool. If NULL a</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * new allocator will be created with the new pool as owner.</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @remark An unmanaged pool is a special pool without a parent; it will</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * NOT be destroyed upon apr_terminate. It must be explicitly</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * destroyed by calling apr_pool_destroy, to prevent memory leaks.</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * Use of this function is discouraged, think twice about whether</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * you really really need it.</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @warning Any child cleanups registered against the new pool, or</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * against sub-pools thereof, will not be executed during an</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * invocation of apr_proc_create(), so resources created in an</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * "unmanaged" pool hierarchy will leak to child processes.</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> */</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gaae7212db77bb57f86419cd594f73a92f">apr_pool_create_unmanaged_ex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator)</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"></span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">/**</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * Debug version of apr_pool_create_ex.</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * @param newpool @see apr_pool_create.</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param parent @see apr_pool_create.</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * @param abort_fn @see apr_pool_create.</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * @param allocator @see apr_pool_create.</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @remark Only available when APR_POOL_DEBUG is defined.</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * Call this directly if you have your apr_pool_create_ex</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * calls in a wrapper function and wish to override</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * the file_line argument to reflect the caller of</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * your wrapper function. If you do not have</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * apr_pool_create_ex in a wrapper, trust the macro</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * and don't call apr_pool_create_ex_debug directly.</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> */</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gacbea97ae5c0c861f6b7c147d46ac1d0c">apr_pool_create_ex_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent,</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator,</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="preprocessor">#define apr_pool_create_ex(newpool, parent, abort_fn, allocator) \</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor"> apr_pool_create_ex_debug(newpool, parent, abort_fn, allocator, \</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"></span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">/**</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * Debug version of apr_pool_create_core_ex.</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * @deprecated @see apr_pool_create_unmanaged_ex_debug.</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> */</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gaa1c5bfc44188884bb439670f81448c20">apr_pool_create_core_ex_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator,</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line);</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"></span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">/**</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * Debug version of apr_pool_create_unmanaged_ex.</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * @param newpool @see apr_pool_create_unmanaged.</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * @param abort_fn @see apr_pool_create_unmanaged.</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * @param allocator @see apr_pool_create_unmanaged.</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * @remark Only available when APR_POOL_DEBUG is defined.</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * Call this directly if you have your apr_pool_create_unmanaged_ex</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * calls in a wrapper function and wish to override</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * the file_line argument to reflect the caller of</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * your wrapper function. If you do not have</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * apr_pool_create_core_ex in a wrapper, trust the macro</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * and don't call apr_pool_create_core_ex_debug directly.</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> */</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gae220e572b14355f1aa7b21c8fb022524">apr_pool_create_unmanaged_ex_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn,</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator,</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="preprocessor">#define apr_pool_create_core_ex(newpool, abort_fn, allocator) \</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> </div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor">#define apr_pool_create_unmanaged_ex(newpool, abort_fn, allocator) \</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> </div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"></span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment">/**</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * Create a new pool.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * @param newpool The pool we have just created.</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * @param parent The parent pool. If this is NULL, the new pool is a root</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * pool. If it is non-NULL, the new pool will inherit all</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * of its parent pool's attributes, except the apr_pool_t will</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * be a sub-pool.</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * @remark This function is thread-safe, in the sense that multiple threads</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * can safely create subpools of the same parent pool concurrently.</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * Similarly, a subpool can be created by one thread at the same</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * time that another thread accesses the parent pool.</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> */</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool,</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent);</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="preprocessor">#define apr_pool_create(newpool, parent) \</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="preprocessor"> apr_pool_create_ex_debug(newpool, parent, NULL, NULL, \</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="preprocessor">#define apr_pool_create(newpool, parent) \</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="preprocessor"> apr_pool_create_ex(newpool, parent, NULL, NULL)</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"></span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">/**</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * Create a new unmanaged pool.</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * @param newpool The pool we have just created.</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> */</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gad3675378924bc9d98e46258c049f1761">apr_pool_create_core</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool);</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_pool_create_unmanaged(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool);</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor">#define apr_pool_create_core(newpool) \</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="preprocessor">#define apr_pool_create_unmanaged(newpool) \</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor"> APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor">#define apr_pool_create_core(newpool) \</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex(newpool, NULL, NULL)</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="preprocessor">#define apr_pool_create_unmanaged(newpool) \</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="preprocessor"> apr_pool_create_unmanaged_ex(newpool, NULL, NULL)</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"></span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment">/**</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * Find the pool's allocator</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * @param pool The pool to get the allocator from.</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> */</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *) <a class="code" href="group__apr__pools.html#gaf446fcf5da1fcd62d3f802a4c0c10f97">apr_pool_allocator_get</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"></span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment">/**</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * Clear all memory in the pool and run all the cleanups. This also destroys all</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * subpools.</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * @param p The pool to clear</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * @remark This does not actually free the memory, it just allows the pool</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * to re-use this memory for the next allocation.</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * @see apr_pool_destroy()</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> */</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#gafa8a998cd660e82b62aecec09e239d0d">apr_pool_clear</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p) __attribute__((nonnull(1)));</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"></span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment">/**</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * Debug version of apr_pool_clear.</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * @param p See: apr_pool_clear.</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * @remark Only available when APR_POOL_DEBUG is defined.</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * Call this directly if you have your apr_pool_clear</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * calls in a wrapper function and wish to override</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * the file_line argument to reflect the caller of</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * your wrapper function. If you do not have</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * apr_pool_clear in a wrapper, trust the macro</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * and don't call apr_pool_destroy_clear directly.</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> */</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#ga9521870e42ec4395a0bf8388706a57b9">apr_pool_clear_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="preprocessor">#define apr_pool_clear(p) \</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="preprocessor"> apr_pool_clear_debug(p, APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"></span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment">/**</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * Destroy the pool. This takes similar action as apr_pool_clear() and then</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * frees all the memory.</span></div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * @param p The pool to destroy</span></div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * @remark This will actually free the memory</span></div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> */</span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#ga54759954d2cba7cb649ab5680a33f9e3">apr_pool_destroy</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p) __attribute__((nonnull(1)));</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"></span></div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment">/**</span></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * Debug version of apr_pool_destroy.</span></div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * @param p See: apr_pool_destroy.</span></div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * @remark Only available when APR_POOL_DEBUG is defined.</span></div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * Call this directly if you have your apr_pool_destroy</span></div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * calls in a wrapper function and wish to override</span></div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * the file_line argument to reflect the caller of</span></div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * your wrapper function. If you do not have</span></div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * apr_pool_destroy in a wrapper, trust the macro</span></div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * and don't call apr_pool_destroy_debug directly.</span></div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> */</span></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#ga7efe64dfcce883d7fad9df813d9259fc">apr_pool_destroy_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,</div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span> </div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="preprocessor">#define apr_pool_destroy(p) \</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="preprocessor"> apr_pool_destroy_debug(p, APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span> </div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span> </div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">/*</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * Memory allocation</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> */</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"></span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">/**</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * Allocate a block of memory from a pool</span></div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * @param p The pool to allocate from</span></div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * @param size The amount of memory to allocate</span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * @return The allocated memory</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> */</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__pools.html#ga85f1e193c31d109affda72f9a92c6915">apr_palloc</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size)</div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="preprocessor">#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))</span></div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>  __attribute__((alloc_size(2)))</div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"></span></div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment">/**</span></div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * Debug version of apr_palloc</span></div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * @param p See: apr_palloc</span></div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * @param size See: apr_palloc</span></div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * @return See: apr_palloc</span></div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> */</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__pools.html#ga0ac211ac89be868b107776b4183a8174">apr_palloc_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size,</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="preprocessor">#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))</span></div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  __attribute__((alloc_size(2)))</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span> </div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor">#define apr_palloc(p, size) \</span></div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor"> apr_palloc_debug(p, size, APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"></span></div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment">/**</span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> * Allocate a block of memory from a pool and set all of the memory to 0</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> * @param p The pool to allocate from</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * @param size The amount of memory to allocate</span></div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * @return The allocated memory</span></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> */</span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__pools.html#gaf61c098ad258069d64cdf8c0a9369f9e">apr_pcalloc</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size);</div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="preprocessor">#elif !APR_POOL_DEBUG</span></div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor">#define apr_pcalloc(p, size) memset(apr_palloc(p, size), 0, size)</span></div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"></span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment">/**</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> * Debug version of apr_pcalloc</span></div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> * @param p See: apr_pcalloc</span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> * @param size See: apr_pcalloc</span></div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> * @param file_line Where the function is called from.</span></div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> * This is usually APR_POOL__FILE_LINE__.</span></div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> * @return See: apr_pcalloc</span></div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> */</span></div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__pools.html#ga7b43035318ffdc57a6eddab07dc57cb2">apr_pcalloc_debug</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size,</div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file_line)</div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span> </div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="preprocessor">#if APR_POOL_DEBUG</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="preprocessor">#define apr_pcalloc(p, size) \</span></div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="preprocessor"> apr_pcalloc_debug(p, size, APR_POOL__FILE_LINE__)</span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span> </div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span> </div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment">/*</span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * Pool Properties</span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> */</span></div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"></span></div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment">/**</span></div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> * Set the function to be called when an allocation failure occurs.</span></div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> * @remark If the program wants APR to exit on a memory allocation error,</span></div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> * then this function can be called to set the callback to use (for</span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> * performing cleanup and then exiting). If this function is not called,</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * then APR will return an error and expect the calling program to</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * deal with the error accordingly.</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> */</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#gaa658b1f10dd13967eaa7c4156d4c2174">apr_pool_abort_set</a>(<a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abortfunc,</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  __attribute__((nonnull(2)));</div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"></span></div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment">/**</span></div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * Get the abort function associated with the specified pool.</span></div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> * @param pool The pool for retrieving the abort function.</span></div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * @return The abort function for the given pool.</span></div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> */</span></div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a>) <a class="code" href="group__apr__pools.html#gaf7610c30ef5f84a8742c0b3e63fdd7b0">apr_pool_abort_get</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"></span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment">/**</span></div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * Get the parent pool of the specified pool.</span></div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * @param pool The pool for retrieving the parent pool.</span></div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> * @return The parent of the given pool.</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> */</span></div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *) <a class="code" href="group__apr__pools.html#ga94db31f40609b15b592ff47f989ca9ec">apr_pool_parent_get</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"></span></div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment">/**</span></div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> * Determine if pool a is an ancestor of pool b.</span></div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> * @param a The pool to search</span></div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> * @param b The pool to search for</span></div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> * @return True if a is an ancestor of b, NULL is considered an ancestor</span></div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> * of all pools.</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> * @remark if compiled with APR_POOL_DEBUG, this function will also</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> * return true if A is a pool which has been guaranteed by the caller</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> * (using apr_pool_join) to have a lifetime at least as long as some</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * ancestor of pool B.</span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> */</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__pools.html#ga05d299f778659d1e0806140d8a7fea79">apr_pool_is_ancestor</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *a, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *b);</div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"></span></div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment">/**</span></div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> * Tag a pool (give it a name)</span></div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> * @param pool The pool to tag</span></div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> * @param tag The tag</span></div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> */</span></div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__pools.html#gaeaa872f7999740a60803e95429890518">apr_pool_tag</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <span class="keyword">const</span> <span class="keywordtype">char</span> *tag)</div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span> </div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span> </div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment">/*</span></div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> * User data management</span></div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> */</span></div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"></span></div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment">/**</span></div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> * Set the data associated with the current pool</span></div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> * @param data The user data associated with the pool.</span></div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> * @param key The key to use for association</span></div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> * @param cleanup The cleanup program to use to cleanup the data (NULL if none)</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> * @param pool The current pool</span></div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> * @warning The data to be attached to the pool should have a life span</span></div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> * at least as long as the pool it is being attached to.</span></div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> *</span></div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> * Users of APR must take EXTREME care when choosing a key to</span></div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> * use for their data. It is possible to accidentally overwrite</span></div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> * data by choosing a key that another part of the program is using.</span></div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> * Therefore it is advised that steps are taken to ensure that unique</span></div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> * keys are used for all of the userdata objects in a particular pool</span></div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> * (the same key in two different pools or a pool and one of its</span></div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> * subpools is okay) at all times. Careful namespace prefixing of</span></div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> * key names is a typical way to help ensure this uniqueness.</span></div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> *</span></div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> */</span></div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">apr_pool_userdata_set</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *key,</div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *),</div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  __attribute__((nonnull(2,4)));</div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"></span></div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment">/**</span></div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * Set the data associated with the current pool</span></div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> * @param data The user data associated with the pool.</span></div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * @param key The key to use for association</span></div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * @param cleanup The cleanup program to use to cleanup the data (NULL if none)</span></div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> * @param pool The current pool</span></div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> * @note same as apr_pool_userdata_set(), except that this version doesn't</span></div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * make a copy of the key (this function is useful, for example, when</span></div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> * the key is a string literal)</span></div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> * @warning This should NOT be used if the key could change addresses by</span></div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> * any means between the apr_pool_userdata_setn() call and a</span></div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> * subsequent apr_pool_userdata_get() on that key, such as if a</span></div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> * static string is used as a userdata key in a DSO and the DSO could</span></div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> * be unloaded and reloaded between the _setn() and the _get(). You</span></div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> * MUST use apr_pool_userdata_set() in such cases.</span></div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> * @warning More generally, the key and the data to be attached to the</span></div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> * pool should have a life span at least as long as the pool itself.</span></div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> *</span></div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> */</span></div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#ga435644c493dc5b10d80c4b99b8cd4589">apr_pool_userdata_setn</a>(</div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keyword">const</span> <span class="keywordtype">char</span> *key,</div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *),</div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  __attribute__((nonnull(2,4)));</div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"></span></div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment">/**</span></div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * Return the data associated with the current pool.</span></div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> * @param data The user data associated with the pool.</span></div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> * @param key The key for the data to retrieve</span></div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> * @param pool The current pool.</span></div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> */</span></div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__pools.html#gaf930f1fad2cf92a2432c0814c8a0b86f">apr_pool_userdata_get</a>(<span class="keywordtype">void</span> **data, <span class="keyword">const</span> <span class="keywordtype">char</span> *key,</div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  __attribute__((nonnull(1,2,3)));</div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span> </div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"></span></div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment">/**</span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> * @defgroup PoolCleanup Pool Cleanup Functions</span></div><div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> *</span></div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> * Cleanups are performed in the reverse order they were registered. That is:</span></div><div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> * Last In, First Out. A cleanup function can safely allocate memory from</span></div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> * the pool that is being cleaned up. It can also safely register additional</span></div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> * cleanups which will be run LIFO, directly after the current cleanup</span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> * terminates. Cleanups have to take caution in calling functions that</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> * create subpools. Subpools, created during cleanup will NOT automatically</span></div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> * be cleaned up. In other words, cleanups are to clean up after themselves.</span></div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> *</span></div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> */</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"></span></div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment">/**</span></div><div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> * Register a function to be called when a pool is cleared or destroyed</span></div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> * @param p The pool to register the cleanup with</span></div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> * @param data The data to pass to the cleanup function.</span></div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * @param plain_cleanup The function to call when the pool is cleared</span></div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> * or destroyed</span></div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * @param child_cleanup The function to call when a child process is about</span></div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> * to exec - this function is called in the child, obviously!</span></div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> */</span></div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_cleanup.html#ga6bdb28224dfe08160cbe3ba6b22dcbd7">apr_pool_cleanup_register</a>(</div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*plain_cleanup)(<span class="keywordtype">void</span> *),</div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*child_cleanup)(<span class="keywordtype">void</span> *))</div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  __attribute__((nonnull(3,4)));</div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"></span></div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment">/**</span></div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> * Register a function to be called when a pool is cleared or destroyed.</span></div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> *</span></div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> * Unlike apr_pool_cleanup_register which registers a cleanup</span></div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> * that is called AFTER all subpools are destroyed, this function registers</span></div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> * a function that will be called before any of the subpools are destroyed.</span></div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> *</span></div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> * @param p The pool to register the cleanup with</span></div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> * @param data The data to pass to the cleanup function.</span></div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> * @param plain_cleanup The function to call when the pool is cleared</span></div><div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"> * or destroyed</span></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> */</span></div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_cleanup.html#ga64114542989d8872c7fd3c62f2a68678">apr_pool_pre_cleanup_register</a>(</div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*plain_cleanup)(<span class="keywordtype">void</span> *))</div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  __attribute__((nonnull(3)));</div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"></span></div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment">/**</span></div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> * Remove a previously registered cleanup function.</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> * </span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> * The cleanup most recently registered with @a p having the same values of</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> * @a data and @a cleanup will be removed.</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> *</span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> * @param p The pool to remove the cleanup from</span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> * @param data The data of the registered cleanup</span></div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> * @param cleanup The function to remove from cleanup</span></div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> * @remarks For some strange reason only the plain_cleanup is handled by this</span></div><div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> * function</span></div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> */</span></div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_cleanup.html#gadc59bf32a0302e34fa0a2663f6e48a44">apr_pool_cleanup_kill</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *))</div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span>  __attribute__((nonnull(3)));</div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"></span></div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment">/**</span></div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> * Replace the child cleanup function of a previously registered cleanup.</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> * </span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> * The cleanup most recently registered with @a p having the same values of</span></div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * @a data and @a plain_cleanup will have the registered child cleanup</span></div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> * function replaced with @a child_cleanup.</span></div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> *</span></div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * @param p The pool of the registered cleanup</span></div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * @param data The data of the registered cleanup</span></div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> * @param plain_cleanup The plain cleanup function of the registered cleanup</span></div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> * @param child_cleanup The function to register as the child cleanup</span></div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> */</span></div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_cleanup.html#ga7197fa6b43d9c5e99de17e0e900989ea">apr_pool_child_cleanup_set</a>(</div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*plain_cleanup)(<span class="keywordtype">void</span> *),</div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*child_cleanup)(<span class="keywordtype">void</span> *))</div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span>  __attribute__((nonnull(3,4)));</div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment"></span></div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment">/**</span></div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> * Run the specified cleanup function immediately and unregister it.</span></div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> *</span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> * The cleanup most recently registered with @a p having the same values of</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * @a data and @a cleanup will be removed and @a cleanup will be called</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> * with @a data as the argument.</span></div><div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> *</span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * @param p The pool to remove the cleanup from</span></div><div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> * @param data The data to remove from cleanup</span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> * @param cleanup The function to remove from cleanup</span></div><div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> */</span></div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___pool_cleanup.html#gabf3913823af6015895a726ab738eaac5">apr_pool_cleanup_run</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keywordtype">void</span> *data,</div><div class="line"><a name="l00697"></a><span class="lineno"> 697</span>  <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *))</div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span>  __attribute__((nonnull(3)));</div><div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment"></span></div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment">/**</span></div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> * An empty cleanup function.</span></div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> * </span></div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"> * Passed to apr_pool_cleanup_register() when no cleanup is required.</span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> *</span></div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> * @param data The data to cleanup, will not be used by this function.</span></div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> */</span></div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <a class="code" href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___pool_cleanup.html#gaa211acee585df08f396a50b0ea489b02">apr_pool_cleanup_null</a>(<span class="keywordtype">void</span> *data);</div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"></span></div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment">/**</span></div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> * Run all registered child cleanups, in preparation for an exec()</span></div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> * call in a forked child -- close files, etc., but *don't* flush I/O</span></div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> * buffers, *don't* wait for subprocesses, and *don't* free any</span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> * memory.</span></div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> */</span></div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_cleanup.html#ga1726cc585bda8997fcb0828f884be55b">apr_pool_cleanup_for_exec</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"></span></div><div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"></span></div><div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment">/**</span></div><div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> * @defgroup PoolDebug Pool Debugging functions.</span></div><div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"> *</span></div><div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"> * pools have nested lifetimes -- sub_pools are destroyed when the</span></div><div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> * parent pool is cleared. We allow certain liberties with operations</span></div><div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> * on things such as tables (and on other structures in a more general</span></div><div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> * sense) where we allow the caller to insert values into a table which</span></div><div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> * were not allocated from the table's pool. The table's data will</span></div><div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> * remain valid as long as all the pools from which its values are</span></div><div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> * allocated remain valid.</span></div><div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment"> *</span></div><div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"> * For example, if B is a sub pool of A, and you build a table T in</span></div><div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment"> * pool B, then it's safe to insert data allocated in A or B into T</span></div><div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"> * (because B lives at most as long as A does, and T is destroyed when</span></div><div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment"> * B is cleared/destroyed). On the other hand, if S is a table in</span></div><div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> * pool A, it is safe to insert data allocated in A into S, but it</span></div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"> * is *not safe* to insert data allocated from B into S... because</span></div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> * B can be cleared/destroyed before A is (which would leave dangling</span></div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment"> * pointers in T's data structures).</span></div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="comment"> *</span></div><div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="comment"> * In general we say that it is safe to insert data into a table T</span></div><div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment"> * if the data is allocated in any ancestor of T's pool. This is the</span></div><div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="comment"> * basis on which the APR_POOL_DEBUG code works -- it tests these ancestor</span></div><div class="line"><a name="l00742"></a><span class="lineno"> 742</span> <span class="comment"> * relationships for all data inserted into tables. APR_POOL_DEBUG also</span></div><div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment"> * provides tools (apr_pool_find, and apr_pool_is_ancestor) for other</span></div><div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment"> * folks to implement similar restrictions for their own data</span></div><div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment"> * structures.</span></div><div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> *</span></div><div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> * However, sometimes this ancestor requirement is inconvenient --</span></div><div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> * sometimes it's necessary to create a sub pool where the sub pool is</span></div><div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> * guaranteed to have the same lifetime as the parent pool. This is a</span></div><div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> * guarantee implemented by the *caller*, not by the pool code. That</span></div><div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> * is, the caller guarantees they won't destroy the sub pool</span></div><div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> * individually prior to destroying the parent pool.</span></div><div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment"> *</span></div><div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment"> * In this case the caller must call apr_pool_join() to indicate this</span></div><div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment"> * guarantee to the APR_POOL_DEBUG code.</span></div><div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment"> *</span></div><div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment"> * These functions are only implemented when #APR_POOL_DEBUG is set.</span></div><div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> *</span></div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> */</span></div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="preprocessor">#if APR_POOL_DEBUG || defined(DOXYGEN)</span></div><div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment">/**</span></div><div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"> * Guarantee that a subpool has the same lifetime as the parent.</span></div><div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"> * @param p The parent pool</span></div><div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> * @param sub The subpool</span></div><div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> */</span></div><div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_debug.html#gaecd956092f81c70117507ad8cbca8ea7">apr_pool_join</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *sub)</div><div class="line"><a name="l00768"></a><span class="lineno"> 768</span>  __attribute__((nonnull(2)));</div><div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"></span></div><div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment">/**</span></div><div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> * Find a pool from something allocated in it.</span></div><div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> * @param mem The thing allocated in the pool</span></div><div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> * @return The pool it is allocated in</span></div><div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> */</span></div><div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *) <a class="code" href="group___pool_debug.html#ga0bc40d9069709020e3643492dae2ccb0">apr_pool_find</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *mem);</div><div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment"></span></div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment">/**</span></div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"> * Report the number of bytes currently in the pool</span></div><div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment"> * @param p The pool to inspect</span></div><div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> * @param recurse Recurse/include the subpools' sizes</span></div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span> <span class="comment"> * @return The number of bytes</span></div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment"> */</span></div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_size_t) <a class="code" href="group___pool_debug.html#ga22462da23d70dfde389a370b131cd351">apr_pool_num_bytes</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keywordtype">int</span> recurse)</div><div class="line"><a name="l00784"></a><span class="lineno"> 784</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"></span></div><div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment">/**</span></div><div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> * Lock a pool</span></div><div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> * @param pool The pool to lock</span></div><div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> * @param flag The flag</span></div><div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment"> */</span></div><div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group___pool_debug.html#ga24f8f0287478fa71f77d0ce4ec035e4a">apr_pool_lock</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <span class="keywordtype">int</span> flag);</div><div class="line"><a name="l00792"></a><span class="lineno"> 792</span> </div><div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment">/* @} */</span></div><div class="line"><a name="l00794"></a><span class="lineno"> 794</span> </div><div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="preprocessor">#else </span><span class="comment">/* APR_POOL_DEBUG or DOXYGEN */</span><span class="preprocessor"></span></div><div class="line"><a name="l00796"></a><span class="lineno"> 796</span> </div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="preprocessor">#ifdef apr_pool_join</span></div><div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="preprocessor">#undef apr_pool_join</span></div><div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="preprocessor">#define apr_pool_join(a,b)</span></div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span> </div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="preprocessor">#ifdef apr_pool_lock</span></div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="preprocessor">#undef apr_pool_lock</span></div><div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="preprocessor">#define apr_pool_lock(pool, lock)</span></div><div class="line"><a name="l00806"></a><span class="lineno"> 806</span> </div><div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="preprocessor">#endif </span><span class="comment">/* APR_POOL_DEBUG or DOXYGEN */</span><span class="preprocessor"></span></div><div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment"></span></div><div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00810"></a><span class="lineno"> 810</span> </div><div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00812"></a><span class="lineno"> 812</span> }</div><div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00814"></a><span class="lineno"> 814</span> </div><div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="preprocessor">#endif </span><span class="comment">/* !APR_POOLS_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group__apr__pools_html_ga7b43035318ffdc57a6eddab07dc57cb2"><div class="ttname"><a href="group__apr__pools.html#ga7b43035318ffdc57a6eddab07dc57cb2">apr_pcalloc_debug</a></div><div class="ttdeci">void * apr_pcalloc_debug(apr_pool_t *p, apr_size_t size, const char *file_line)</div></div>
<div class="ttc" id="group__apr__pools_html_ga20e514c83555398acddc30c4dfa0c540"><div class="ttname"><a href="group__apr__pools.html#ga20e514c83555398acddc30c4dfa0c540">apr_pool_create_core_ex</a></div><div class="ttdeci">apr_status_t apr_pool_create_core_ex(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator)</div></div>
<div class="ttc" id="group__apr__pools_html_ga54759954d2cba7cb649ab5680a33f9e3"><div class="ttname"><a href="group__apr__pools.html#ga54759954d2cba7cb649ab5680a33f9e3">apr_pool_destroy</a></div><div class="ttdeci">void apr_pool_destroy(apr_pool_t *p)</div></div>
<div class="ttc" id="group__apr__pools_html_ga94db31f40609b15b592ff47f989ca9ec"><div class="ttname"><a href="group__apr__pools.html#ga94db31f40609b15b592ff47f989ca9ec">apr_pool_parent_get</a></div><div class="ttdeci">apr_pool_t * apr_pool_parent_get(apr_pool_t *pool)</div></div>
<div class="ttc" id="group___pool_cleanup_html_ga1726cc585bda8997fcb0828f884be55b"><div class="ttname"><a href="group___pool_cleanup.html#ga1726cc585bda8997fcb0828f884be55b">apr_pool_cleanup_for_exec</a></div><div class="ttdeci">void apr_pool_cleanup_for_exec(void)</div></div>
<div class="ttc" id="group__apr__pools_html_gaeaa872f7999740a60803e95429890518"><div class="ttname"><a href="group__apr__pools.html#gaeaa872f7999740a60803e95429890518">apr_pool_tag</a></div><div class="ttdeci">void apr_pool_tag(apr_pool_t *pool, const char *tag)</div></div>
<div class="ttc" id="group__apr__pools_html_ga78d1aa2d9fa842d83eaffccb0f0c0c5c"><div class="ttname"><a href="group__apr__pools.html#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">apr_pool_userdata_set</a></div><div class="ttdeci">apr_status_t apr_pool_userdata_set(const void *data, const char *key, apr_status_t(*cleanup)(void *), apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__platform_html_ga3ad5e45fabbda0ec5f106c334f1a0ae5"><div class="ttname"><a href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a></div><div class="ttdeci">#define APR_DECLARE_NONSTD(type)</div><div class="ttdef"><b>Definition:</b> apr.h:492</div></div>
<div class="ttc" id="group__apr__pools_html_ga3728aacec227318cef973b8a33f3b430"><div class="ttname"><a href="group__apr__pools.html#ga3728aacec227318cef973b8a33f3b430">apr_pool_terminate</a></div><div class="ttdeci">void apr_pool_terminate(void)</div></div>
<div class="ttc" id="group__apr__pools_html_gaa1c5bfc44188884bb439670f81448c20"><div class="ttname"><a href="group__apr__pools.html#gaa1c5bfc44188884bb439670f81448c20">apr_pool_create_core_ex_debug</a></div><div class="ttdeci">apr_status_t apr_pool_create_core_ex_debug(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator, const char *file_line)</div></div>
<div class="ttc" id="group__apr__pools_html_gacbea97ae5c0c861f6b7c147d46ac1d0c"><div class="ttname"><a href="group__apr__pools.html#gacbea97ae5c0c861f6b7c147d46ac1d0c">apr_pool_create_ex_debug</a></div><div class="ttdeci">apr_status_t apr_pool_create_ex_debug(apr_pool_t **newpool, apr_pool_t *parent, apr_abortfunc_t abort_fn, apr_allocator_t *allocator, const char *file_line)</div></div>
<div class="ttc" id="group___pool_debug_html_ga24f8f0287478fa71f77d0ce4ec035e4a"><div class="ttname"><a href="group___pool_debug.html#ga24f8f0287478fa71f77d0ce4ec035e4a">apr_pool_lock</a></div><div class="ttdeci">void apr_pool_lock(apr_pool_t *pool, int flag)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf61c098ad258069d64cdf8c0a9369f9e"><div class="ttname"><a href="group__apr__pools.html#gaf61c098ad258069d64cdf8c0a9369f9e">apr_pcalloc</a></div><div class="ttdeci">void * apr_pcalloc(apr_pool_t *p, apr_size_t size)</div></div>
<div class="ttc" id="group__apr__allocator_html_ga1ceabfd30fcfc455e47d052d2a24244b"><div class="ttname"><a href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a></div><div class="ttdeci">struct apr_allocator_t apr_allocator_t</div><div class="ttdef"><b>Definition:</b> apr_allocator.h:41</div></div>
<div class="ttc" id="apr__want_8h_html"><div class="ttname"><a href="apr__want_8h.html">apr_want.h</a></div><div class="ttdoc">APR Standard Headers Support. </div></div>
<div class="ttc" id="group___pool_debug_html_ga22462da23d70dfde389a370b131cd351"><div class="ttname"><a href="group___pool_debug.html#ga22462da23d70dfde389a370b131cd351">apr_pool_num_bytes</a></div><div class="ttdeci">apr_size_t apr_pool_num_bytes(apr_pool_t *p, int recurse)</div></div>
<div class="ttc" id="apr__general_8h_html"><div class="ttname"><a href="apr__general_8h.html">apr_general.h</a></div><div class="ttdoc">APR Miscellaneous library routines. </div></div>
<div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:479</div></div>
<div class="ttc" id="group__apr__pools_html_ga370a939349adf6d1438068e2fc69a0dd"><div class="ttname"><a href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a></div><div class="ttdeci">int(* apr_abortfunc_t)(int retcode)</div><div class="ttdef"><b>Definition:</b> apr_pools.h:148</div></div>
<div class="ttc" id="group___pool_cleanup_html_gabf3913823af6015895a726ab738eaac5"><div class="ttname"><a href="group___pool_cleanup.html#gabf3913823af6015895a726ab738eaac5">apr_pool_cleanup_run</a></div><div class="ttdeci">apr_status_t apr_pool_cleanup_run(apr_pool_t *p, void *data, apr_status_t(*cleanup)(void *))</div></div>
<div class="ttc" id="group___pool_cleanup_html_gadc59bf32a0302e34fa0a2663f6e48a44"><div class="ttname"><a href="group___pool_cleanup.html#gadc59bf32a0302e34fa0a2663f6e48a44">apr_pool_cleanup_kill</a></div><div class="ttdeci">void apr_pool_cleanup_kill(apr_pool_t *p, const void *data, apr_status_t(*cleanup)(void *))</div></div>
<div class="ttc" id="group___pool_cleanup_html_ga64114542989d8872c7fd3c62f2a68678"><div class="ttname"><a href="group___pool_cleanup.html#ga64114542989d8872c7fd3c62f2a68678">apr_pool_pre_cleanup_register</a></div><div class="ttdeci">void apr_pool_pre_cleanup_register(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *))</div></div>
<div class="ttc" id="group__apr__pools_html_ga85f1e193c31d109affda72f9a92c6915"><div class="ttname"><a href="group__apr__pools.html#ga85f1e193c31d109affda72f9a92c6915">apr_palloc</a></div><div class="ttdeci">void * apr_palloc(apr_pool_t *p, apr_size_t size)</div></div>
<div class="ttc" id="group__apr__pools_html_gab274bd29e4e4d4944b4618403148074f"><div class="ttname"><a href="group__apr__pools.html#gab274bd29e4e4d4944b4618403148074f">apr_pool_create_ex</a></div><div class="ttdeci">apr_status_t apr_pool_create_ex(apr_pool_t **newpool, apr_pool_t *parent, apr_abortfunc_t abort_fn, apr_allocator_t *allocator)</div></div>
<div class="ttc" id="group__apr__pools_html_gad3675378924bc9d98e46258c049f1761"><div class="ttname"><a href="group__apr__pools.html#gad3675378924bc9d98e46258c049f1761">apr_pool_create_core</a></div><div class="ttdeci">apr_status_t apr_pool_create_core(apr_pool_t **newpool)</div></div>
<div class="ttc" id="apr__allocator_8h_html"><div class="ttname"><a href="apr__allocator_8h.html">apr_allocator.h</a></div><div class="ttdoc">APR Internal Memory Allocation. </div></div>
<div class="ttc" id="apr__errno_8h_html"><div class="ttname"><a href="apr__errno_8h.html">apr_errno.h</a></div><div class="ttdoc">APR Error Codes. </div></div>
<div class="ttc" id="apr_8h_html"><div class="ttname"><a href="apr_8h.html">apr.h</a></div><div class="ttdoc">APR Platform Definitions. </div></div>
<div class="ttc" id="group__apr__pools_html_gafa8a998cd660e82b62aecec09e239d0d"><div class="ttname"><a href="group__apr__pools.html#gafa8a998cd660e82b62aecec09e239d0d">apr_pool_clear</a></div><div class="ttdeci">void apr_pool_clear(apr_pool_t *p)</div></div>
<div class="ttc" id="group__apr__pools_html_ga435644c493dc5b10d80c4b99b8cd4589"><div class="ttname"><a href="group__apr__pools.html#ga435644c493dc5b10d80c4b99b8cd4589">apr_pool_userdata_setn</a></div><div class="ttdeci">apr_status_t apr_pool_userdata_setn(const void *data, const char *key, apr_status_t(*cleanup)(void *), apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__pools_html_ga7efe64dfcce883d7fad9df813d9259fc"><div class="ttname"><a href="group__apr__pools.html#ga7efe64dfcce883d7fad9df813d9259fc">apr_pool_destroy_debug</a></div><div class="ttdeci">void apr_pool_destroy_debug(apr_pool_t *p, const char *file_line)</div></div>
<div class="ttc" id="group__apr__pools_html_gaa658b1f10dd13967eaa7c4156d4c2174"><div class="ttname"><a href="group__apr__pools.html#gaa658b1f10dd13967eaa7c4156d4c2174">apr_pool_abort_set</a></div><div class="ttdeci">void apr_pool_abort_set(apr_abortfunc_t abortfunc, apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__pools_html_ga9521870e42ec4395a0bf8388706a57b9"><div class="ttname"><a href="group__apr__pools.html#ga9521870e42ec4395a0bf8388706a57b9">apr_pool_clear_debug</a></div><div class="ttdeci">void apr_pool_clear_debug(apr_pool_t *p, const char *file_line)</div></div>
<div class="ttc" id="group__apr__pools_html_gaae7212db77bb57f86419cd594f73a92f"><div class="ttname"><a href="group__apr__pools.html#gaae7212db77bb57f86419cd594f73a92f">apr_pool_create_unmanaged_ex</a></div><div class="ttdeci">apr_status_t apr_pool_create_unmanaged_ex(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator)</div></div>
<div class="ttc" id="group___pool_cleanup_html_ga7197fa6b43d9c5e99de17e0e900989ea"><div class="ttname"><a href="group___pool_cleanup.html#ga7197fa6b43d9c5e99de17e0e900989ea">apr_pool_child_cleanup_set</a></div><div class="ttdeci">void apr_pool_child_cleanup_set(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *), apr_status_t(*child_cleanup)(void *))</div></div>
<div class="ttc" id="group___pool_debug_html_ga0bc40d9069709020e3643492dae2ccb0"><div class="ttname"><a href="group___pool_debug.html#ga0bc40d9069709020e3643492dae2ccb0">apr_pool_find</a></div><div class="ttdeci">apr_pool_t * apr_pool_find(const void *mem)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf446fcf5da1fcd62d3f802a4c0c10f97"><div class="ttname"><a href="group__apr__pools.html#gaf446fcf5da1fcd62d3f802a4c0c10f97">apr_pool_allocator_get</a></div><div class="ttdeci">apr_allocator_t * apr_pool_allocator_get(apr_pool_t *pool)</div></div>
<div class="ttc" id="group___pool_cleanup_html_gaa211acee585df08f396a50b0ea489b02"><div class="ttname"><a href="group___pool_cleanup.html#gaa211acee585df08f396a50b0ea489b02">apr_pool_cleanup_null</a></div><div class="ttdeci">apr_status_t apr_pool_cleanup_null(void *data)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div>
<div class="ttc" id="group___pool_cleanup_html_ga6bdb28224dfe08160cbe3ba6b22dcbd7"><div class="ttname"><a href="group___pool_cleanup.html#ga6bdb28224dfe08160cbe3ba6b22dcbd7">apr_pool_cleanup_register</a></div><div class="ttdeci">void apr_pool_cleanup_register(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *), apr_status_t(*child_cleanup)(void *))</div></div>
<div class="ttc" id="group__apr__errno_html_gaf76ee4543247e9fb3f3546203e590a6c"><div class="ttname"><a href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></div><div class="ttdeci">int apr_status_t</div><div class="ttdef"><b>Definition:</b> apr_errno.h:44</div></div>
<div class="ttc" id="group__apr__pools_html_gaf930f1fad2cf92a2432c0814c8a0b86f"><div class="ttname"><a href="group__apr__pools.html#gaf930f1fad2cf92a2432c0814c8a0b86f">apr_pool_userdata_get</a></div><div class="ttdeci">apr_status_t apr_pool_userdata_get(void **data, const char *key, apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__pools_html_gad64a6a29515621bc13f8a8da50366d67"><div class="ttname"><a href="group__apr__pools.html#gad64a6a29515621bc13f8a8da50366d67">apr_pool_initialize</a></div><div class="ttdeci">apr_status_t apr_pool_initialize(void)</div></div>
<div class="ttc" id="group___pool_debug_html_gaecd956092f81c70117507ad8cbca8ea7"><div class="ttname"><a href="group___pool_debug.html#gaecd956092f81c70117507ad8cbca8ea7">apr_pool_join</a></div><div class="ttdeci">void apr_pool_join(apr_pool_t *p, apr_pool_t *sub)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf7610c30ef5f84a8742c0b3e63fdd7b0"><div class="ttname"><a href="group__apr__pools.html#gaf7610c30ef5f84a8742c0b3e63fdd7b0">apr_pool_abort_get</a></div><div class="ttdeci">apr_abortfunc_t apr_pool_abort_get(apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__pools_html_ga05d299f778659d1e0806140d8a7fea79"><div class="ttname"><a href="group__apr__pools.html#ga05d299f778659d1e0806140d8a7fea79">apr_pool_is_ancestor</a></div><div class="ttdeci">int apr_pool_is_ancestor(apr_pool_t *a, apr_pool_t *b)</div></div>
<div class="ttc" id="group__apr__pools_html_ga0ac211ac89be868b107776b4183a8174"><div class="ttname"><a href="group__apr__pools.html#ga0ac211ac89be868b107776b4183a8174">apr_palloc_debug</a></div><div class="ttdeci">void * apr_palloc_debug(apr_pool_t *p, apr_size_t size, const char *file_line)</div></div>
<div class="ttc" id="group__apr__pools_html_ga918adf3026c894efeae254a0446aed3b"><div class="ttname"><a href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a></div><div class="ttdeci">apr_status_t apr_pool_create(apr_pool_t **newpool, apr_pool_t *parent)</div></div>
<div class="ttc" id="group__apr__pools_html_gae220e572b14355f1aa7b21c8fb022524"><div class="ttname"><a href="group__apr__pools.html#gae220e572b14355f1aa7b21c8fb022524">apr_pool_create_unmanaged_ex_debug</a></div><div class="ttdeci">apr_status_t apr_pool_create_unmanaged_ex_debug(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator, const char *file_line)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>
