trAvis - MANAGER
Edit File: apr__ring_8h_source.html
<!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.5"/> <title>Apache Portable Runtime: apr_ring.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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 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.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_ring.h</div> </div> </div><!--header--> <div class="contents"> <a href="apr__ring_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="comment">/*</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * This code draws heavily from the 4.4BSD <sys/queue.h> macros</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * and Dean Gaudet's "splim/ring.h".</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * <http://www.freebsd.org/cgi/cvsweb.cgi/src/sys/sys/queue.h></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * <http://www.arctic.org/~dean/splim/></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * We'd use Dean's code directly if we could guarantee the</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * availability of inline functions.</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> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef APR_RING_H</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define APR_RING_H</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/**</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @file apr_ring.h</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @brief APR Rings</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> */</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</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"> * for offsetof()</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="apr__general_8h.html">apr_general.h</a>"</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/**</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @defgroup apr_ring Ring Macro Implementations</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @ingroup APR </span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * A ring is a kind of doubly-linked list that can be manipulated</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * without knowing where its head is.</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @{</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/**</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * The Ring Element</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * A ring element struct is linked to the other elements in the ring</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * through its ring entry field, e.g.</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * <pre></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * struct my_element_t {</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * APR_RING_ENTRY(my_element_t) link;</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * int foo;</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * char *bar;</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"> * </pre></span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> *</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * An element struct may be put on more than one ring if it has more</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * than one APR_RING_ENTRY field. Each APR_RING_ENTRY has a corresponding</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * APR_RING_HEAD declaration.</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> *</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @warning For strict C standards compliance you should put the APR_RING_ENTRY</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * first in the element struct unless the head is always part of a larger</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * object with enough earlier fields to accommodate the offsetof() used</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * to compute the ring sentinel below. You can usually ignore this caveat.</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> */</span></div> <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga095edad4bcb6975014ed9584930f7819"> 70</a></span> <span class="preprocessor">#define APR_RING_ENTRY(elem) \</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> struct { \</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> struct elem * volatile next; \</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> struct elem * volatile prev; \</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> }</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/**</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * The Ring Head</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * Each ring is managed via its head, which is a struct declared like this:</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * <pre></span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * APR_RING_HEAD(my_ring_t, my_element_t);</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * struct my_ring_t ring, *ringp;</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * </pre></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"> * This struct looks just like the element link struct so that we can</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * be sure that the typecasting games will work as expected.</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"> * The first element in the ring is next after the head, and the last</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * element is just before the head.</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__ring.html#ga2953b8d4034077c4020616282e6c0b67"> 91</a></span> <span class="preprocessor">#define APR_RING_HEAD(head, elem) \</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> struct head { \</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> struct elem * volatile next; \</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> struct elem * volatile prev; \</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"> }</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"></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"> * The Ring Sentinel</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"> * This is the magic pointer value that occurs before the first and</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * after the last elements in the ring, computed from the address of</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * the ring's head. The head itself isn't an element, but in order to</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * get rid of all the special cases when dealing with the ends of the</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * ring, we play typecasting games to make it look like one.</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"> * Here is a diagram to illustrate the arrangements of the next and</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * prev pointers of each element in a single ring. Note that they point</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * to the start of each element, not to the APR_RING_ENTRY structure.</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * <pre></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"> * | |struct| | | |struct| | | |struct| |</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * / | elem | \/ | elem | \/ | elem | \</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * ... | | /\ | | /\ | | ...</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * +------+ | | +------+ | | +------+</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * ...--|prev | | +--|ring | | +--|prev |</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * | next|--+ | entry|--+ | next|--...</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"> * | etc. | | etc. | | etc. |</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * : : : : : :</span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * </pre></span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> *</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * The APR_RING_HEAD is nothing but a bare APR_RING_ENTRY. The prev</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * and next pointers in the first and last elements don't actually</span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * point to the head, they point to a phantom place called the</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * sentinel. Its value is such that last->next->next == first because</span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * the offset from the sentinel to the head's next pointer is the same</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * as the offset from the start of an element to its next pointer.</span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * This also works in the opposite direction.</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> *</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * <pre></span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * last first</span></div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * +->+------+<-+ +->sentinel<-+ +->+------+<-+</span></div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * | |struct| | | | | |struct| |</span></div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * / | elem | \/ \/ | elem | \</span></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * ... | | /\ /\ | | ...</span></div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * +------+ | | +------+ | | +------+</span></div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * ...--|prev | | +--|ring | | +--|prev |</span></div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * | next|--+ | head|--+ | next|--...</span></div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * +------+ +------+ +------+</span></div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * | etc. | | etc. |</span></div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * : : : :</span></div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * </pre></span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> *</span></div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * Note that the offset mentioned above is different for each kind of</span></div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * ring that the element may be on, and each kind of ring has a unique</span></div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * name for its APR_RING_ENTRY in each element, and has its own type</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * for its APR_RING_HEAD.</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> *</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * Note also that if the offset is non-zero (which is required if an</span></div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * element has more than one APR_RING_ENTRY), the unreality of the</span></div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * sentinel may have bad implications on very perverse implementations</span></div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * of C -- see the warning in APR_RING_ENTRY.</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"> * @param hp The head of the ring</span></div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</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"><a class="line" href="group__apr__ring.html#ga54210090292ebafcd0a0d75d9ff1563d"> 159</a></span> <span class="preprocessor">#define APR_RING_SENTINEL(hp, elem, link) \</span></div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor"> (struct elem *)((char *)(&(hp)->next) - APR_OFFSETOF(struct elem, link))</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/**</span></div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * The first element of the ring</span></div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @param hp The head of the ring</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"><a class="line" href="group__apr__ring.html#gacacd9cfca24feb7ff754d4008422efcb"> 166</a></span> <span class="preprocessor">#define APR_RING_FIRST(hp) (hp)->next</span></div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * The last element of the ring</span></div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @param hp The head of the ring</span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> */</span></div> <div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga8b927069ba9dc13defaf45a87267b5d3"> 171</a></span> <span class="preprocessor">#define APR_RING_LAST(hp) (hp)->prev</span></div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * The next element in the ring</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param ep The current element</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> */</span></div> <div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="group__apr__ring.html#gae42e4f7148719aa534bdbbc82be26a06"> 177</a></span> <span class="preprocessor">#define APR_RING_NEXT(ep, link) (ep)->link.next</span></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * The previous element in the ring</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @param ep The current element</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div> <div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga82d45623d505d59ea5619cf8f63d0ebb"> 183</a></span> <span class="preprocessor">#define APR_RING_PREV(ep, link) (ep)->link.prev</span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"></span></div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">/**</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * Initialize a ring</span></div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param hp The head of the ring</span></div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> */</span></div> <div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga245e1a73b162a4a68ebd54c84683729d"> 192</a></span> <span class="preprocessor">#define APR_RING_INIT(hp, elem, link) do { \</span></div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor"> APR_RING_FIRST((hp)) = APR_RING_SENTINEL((hp), elem, link); \</span></div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor"> APR_RING_LAST((hp)) = APR_RING_SENTINEL((hp), elem, link); \</span></div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/**</span></div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * Determine if a ring is empty</span></div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @param hp The head of the ring</span></div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * @return true or false</span></div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> */</span></div> <div class="line"><a name="l00204"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga9b64ad6eebea19f896d2aa90172b6b9a"> 204</a></span> <span class="preprocessor">#define APR_RING_EMPTY(hp, elem, link) \</span></div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor"> (APR_RING_FIRST((hp)) == APR_RING_SENTINEL((hp), elem, link))</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">/**</span></div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * Initialize a singleton element</span></div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * @param ep The element</span></div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> */</span></div> <div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="group__apr__ring.html#gae5048ecda4b26b012ee93c2c830058cb"> 212</a></span> <span class="preprocessor">#define APR_RING_ELEM_INIT(ep, link) do { \</span></div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="preprocessor"> APR_RING_NEXT((ep), link) = (ep); \</span></div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor"> APR_RING_PREV((ep), link) = (ep); \</span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"></span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/**</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * Splice the sequence ep1..epN into the ring before element lep</span></div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * (..lep.. becomes ..ep1..epN..lep..)</span></div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @warning This doesn't work for splicing before the first element or on</span></div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * empty rings... see APR_RING_SPLICE_HEAD for one that does</span></div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @param lep Element in the ring to splice before</span></div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @param ep1 First element in the sequence to splice in</span></div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * @param epN Last element in the sequence to splice in</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> */</span></div> <div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga438e7369e650ee07ac98ed0731589750"> 228</a></span> <span class="preprocessor">#define APR_RING_SPLICE_BEFORE(lep, ep1, epN, link) do { \</span></div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor"> APR_RING_NEXT((epN), link) = (lep); \</span></div> <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="preprocessor"> APR_RING_PREV((ep1), link) = APR_RING_PREV((lep), link); \</span></div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor"> APR_RING_NEXT(APR_RING_PREV((lep), link), link) = (ep1); \</span></div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="preprocessor"> APR_RING_PREV((lep), link) = (epN); \</span></div> <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">/**</span></div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * Splice the sequence ep1..epN into the ring after element lep</span></div> <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * (..lep.. becomes ..lep..ep1..epN..)</span></div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * @warning This doesn't work for splicing after the last element or on</span></div> <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * empty rings... see APR_RING_SPLICE_TAIL for one that does</span></div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @param lep Element in the ring to splice after</span></div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @param ep1 First element in the sequence to splice in</span></div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @param epN Last element in the sequence to splice in</span></div> <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> */</span></div> <div class="line"><a name="l00245"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga53e6564eba59d7e734a0ce03cb418a42"> 245</a></span> <span class="preprocessor">#define APR_RING_SPLICE_AFTER(lep, ep1, epN, link) do { \</span></div> <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="preprocessor"> APR_RING_PREV((ep1), link) = (lep); \</span></div> <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor"> APR_RING_NEXT((epN), link) = APR_RING_NEXT((lep), link); \</span></div> <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="preprocessor"> APR_RING_PREV(APR_RING_NEXT((lep), link), link) = (epN); \</span></div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor"> APR_RING_NEXT((lep), link) = (ep1); \</span></div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">/**</span></div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * Insert the element nep into the ring before element lep</span></div> <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * (..lep.. becomes ..nep..lep..)</span></div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * @warning This doesn't work for inserting before the first element or on</span></div> <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * empty rings... see APR_RING_INSERT_HEAD for one that does</span></div> <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @param lep Element in the ring to insert before</span></div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * @param nep Element to insert</span></div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</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"><a class="line" href="group__apr__ring.html#ga76f9a04f932b3377073fa4e30d745564"> 261</a></span> <span class="preprocessor">#define APR_RING_INSERT_BEFORE(lep, nep, link) \</span></div> <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="preprocessor"> APR_RING_SPLICE_BEFORE((lep), (nep), (nep), link)</span></div> <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">/**</span></div> <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * Insert the element nep into the ring after element lep</span></div> <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * (..lep.. becomes ..lep..nep..)</span></div> <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * @warning This doesn't work for inserting after the last element or on</span></div> <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * empty rings... see APR_RING_INSERT_TAIL for one that does</span></div> <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @param lep Element in the ring to insert after</span></div> <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * @param nep Element to insert</span></div> <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> */</span></div> <div class="line"><a name="l00273"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga40453637d00c853f3a212a30c1f2cb41"> 273</a></span> <span class="preprocessor">#define APR_RING_INSERT_AFTER(lep, nep, link) \</span></div> <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="preprocessor"> APR_RING_SPLICE_AFTER((lep), (nep), (nep), link)</span></div> <div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"></span></div> <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">/**</span></div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * Splice the sequence ep1..epN into the ring before the first element</span></div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * (..hp.. becomes ..hp..ep1..epN..)</span></div> <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * @param ep1 First element in the sequence to splice in</span></div> <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * @param epN Last element in the sequence to splice in</span></div> <div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> */</span></div> <div class="line"><a name="l00286"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga592e71a7cf219fc70f4fc47c60ef4c64"> 286</a></span> <span class="preprocessor">#define APR_RING_SPLICE_HEAD(hp, ep1, epN, elem, link) \</span></div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="preprocessor"> APR_RING_SPLICE_AFTER(APR_RING_SENTINEL((hp), elem, link), \</span></div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor"> (ep1), (epN), link)</span></div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment">/**</span></div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * Splice the sequence ep1..epN into the ring after the last element</span></div> <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * (..hp.. becomes ..ep1..epN..hp..)</span></div> <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> * @param ep1 First element in the sequence to splice in</span></div> <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * @param epN Last element in the sequence to splice in</span></div> <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> */</span></div> <div class="line"><a name="l00299"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga51e02e214fb6e218f45ff23cbd1f7abc"> 299</a></span> <span class="preprocessor">#define APR_RING_SPLICE_TAIL(hp, ep1, epN, elem, link) \</span></div> <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor"> APR_RING_SPLICE_BEFORE(APR_RING_SENTINEL((hp), elem, link), \</span></div> <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="preprocessor"> (ep1), (epN), link)</span></div> <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment">/**</span></div> <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * Insert the element nep into the ring before the first element</span></div> <div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * (..hp.. becomes ..hp..nep..)</span></div> <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * @param nep Element to insert</span></div> <div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> */</span></div> <div class="line"><a name="l00311"></a><span class="lineno"><a class="line" href="group__apr__ring.html#gad59352546dc9253c0057ad43cf728a63"> 311</a></span> <span class="preprocessor">#define APR_RING_INSERT_HEAD(hp, nep, elem, link) \</span></div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="preprocessor"> APR_RING_SPLICE_HEAD((hp), (nep), (nep), elem, link)</span></div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment">/**</span></div> <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * Insert the element nep into the ring after the last element</span></div> <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * (..hp.. becomes ..nep..hp..)</span></div> <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * @param nep Element to insert</span></div> <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> */</span></div> <div class="line"><a name="l00322"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga235311035184125d72ce0689c9949a3e"> 322</a></span> <span class="preprocessor">#define APR_RING_INSERT_TAIL(hp, nep, elem, link) \</span></div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="preprocessor"> APR_RING_SPLICE_TAIL((hp), (nep), (nep), elem, link)</span></div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">/**</span></div> <div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * Concatenate ring h2 onto the end of ring h1, leaving h2 empty.</span></div> <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * @param h1 Head of the ring to concatenate onto</span></div> <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * @param h2 Head of the ring to concatenate</span></div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> */</span></div> <div class="line"><a name="l00332"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga34ee7a0d6daa61117006bb74498ff5aa"> 332</a></span> <span class="preprocessor">#define APR_RING_CONCAT(h1, h2, elem, link) do { \</span></div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="preprocessor"> if (!APR_RING_EMPTY((h2), elem, link)) { \</span></div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor"> APR_RING_SPLICE_BEFORE(APR_RING_SENTINEL((h1), elem, link), \</span></div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="preprocessor"> APR_RING_FIRST((h2)), \</span></div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor"> APR_RING_LAST((h2)), link); \</span></div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor"> APR_RING_INIT((h2), elem, link); \</span></div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment">/**</span></div> <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * Prepend ring h2 onto the beginning of ring h1, leaving h2 empty.</span></div> <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @param h1 Head of the ring to prepend onto</span></div> <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * @param h2 Head of the ring to prepend</span></div> <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> */</span></div> <div class="line"><a name="l00348"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga4d5aaa9b6f02f96f98f234a0a428474d"> 348</a></span> <span class="preprocessor">#define APR_RING_PREPEND(h1, h2, elem, link) do { \</span></div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor"> if (!APR_RING_EMPTY((h2), elem, link)) { \</span></div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor"> APR_RING_SPLICE_AFTER(APR_RING_SENTINEL((h1), elem, link), \</span></div> <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="preprocessor"> APR_RING_FIRST((h2)), \</span></div> <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor"> APR_RING_LAST((h2)), link); \</span></div> <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="preprocessor"> APR_RING_INIT((h2), elem, link); \</span></div> <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="preprocessor"></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"> * Unsplice a sequence of elements from a ring</span></div> <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * @warning The unspliced sequence is left with dangling pointers at either end</span></div> <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * @param ep1 First element in the sequence to unsplice</span></div> <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * @param epN Last element in the sequence to unsplice</span></div> <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> */</span></div> <div class="line"><a name="l00364"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga1d725b0a9ea7ff88f771e37ec130c13b"> 364</a></span> <span class="preprocessor">#define APR_RING_UNSPLICE(ep1, epN, link) do { \</span></div> <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="preprocessor"> APR_RING_NEXT(APR_RING_PREV((ep1), link), link) = \</span></div> <div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="preprocessor"> APR_RING_NEXT((epN), link); \</span></div> <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor"> APR_RING_PREV(APR_RING_NEXT((epN), link), link) = \</span></div> <div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="preprocessor"> APR_RING_PREV((ep1), link); \</span></div> <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">/**</span></div> <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * Remove a single element from a ring</span></div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * @warning The unspliced element is left with dangling pointers at either end</span></div> <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * @param ep Element to remove</span></div> <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> */</span></div> <div class="line"><a name="l00377"></a><span class="lineno"><a class="line" href="group__apr__ring.html#gaab4a57544bdb660ec1e306137387d9d7"> 377</a></span> <span class="preprocessor">#define APR_RING_REMOVE(ep, link) \</span></div> <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="preprocessor"> APR_RING_UNSPLICE((ep), (ep), link)</span></div> <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment">/**</span></div> <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> * Iterate over a ring</span></div> <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * @param ep The current element</span></div> <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * @param head The head of the ring</span></div> <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> */</span></div> <div class="line"><a name="l00387"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga7dc7b26e72f836d27e8e0c87da14fb4a"> 387</a></span> <span class="preprocessor">#define APR_RING_FOREACH(ep, head, elem, link) \</span></div> <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="preprocessor"> for (ep = APR_RING_FIRST(head); \</span></div> <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor"> ep != APR_RING_SENTINEL(head, elem, link); \</span></div> <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"> ep = APR_RING_NEXT(ep, link))</span></div> <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment">/**</span></div> <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * Iterate over a ring safe against removal of the current element</span></div> <div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> * @param ep1 The current element</span></div> <div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> * @param ep2 Iteration cursor</span></div> <div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> * @param head The head of the ring</span></div> <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> */</span></div> <div class="line"><a name="l00400"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga9a1e91eef86d676d1622dc5b9ddd6f89"> 400</a></span> <span class="preprocessor">#define APR_RING_FOREACH_SAFE(ep1, ep2, head, elem, link) \</span></div> <div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="preprocessor"> for (ep1 = APR_RING_FIRST(head), ep2 = APR_RING_NEXT(ep1, link); \</span></div> <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="preprocessor"> ep1 != APR_RING_SENTINEL(head, elem, link); \</span></div> <div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="preprocessor"> ep1 = ep2, ep2 = APR_RING_NEXT(ep1, link))</span></div> <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment">/* Debugging tools: */</span></div> <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> </div> <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="preprocessor">#ifdef APR_RING_DEBUG</span></div> <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor"></span><span class="preprocessor">#include <stdio.h></span></div> <div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="preprocessor">#include <assert.h></span></div> <div class="line"><a name="l00410"></a><span class="lineno"> 410</span> </div> <div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor">#define APR_RING_CHECK_ONE(msg, ptr) \</span></div> <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="preprocessor"> fprintf(stderr, "*** %s %p\n", msg, ptr)</span></div> <div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="preprocessor">#define APR_RING_CHECK(hp, elem, link, msg) \</span></div> <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="preprocessor"> APR_RING_CHECK_ELEM(APR_RING_SENTINEL(hp, elem, link), elem, link, msg)</span></div> <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="preprocessor">#define APR_RING_CHECK_ELEM(ep, elem, link, msg) do { \</span></div> <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="preprocessor"> struct elem *start = (ep); \</span></div> <div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="preprocessor"> struct elem *here = start; \</span></div> <div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="preprocessor"> fprintf(stderr, "*** ring check start -- %s\n", msg); \</span></div> <div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="preprocessor"> do { \</span></div> <div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="preprocessor"> fprintf(stderr, "\telem %p\n", here); \</span></div> <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="preprocessor"> fprintf(stderr, "\telem->next %p\n", \</span></div> <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="preprocessor"> APR_RING_NEXT(here, link)); \</span></div> <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="preprocessor"> fprintf(stderr, "\telem->prev %p\n", \</span></div> <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="preprocessor"> APR_RING_PREV(here, link)); \</span></div> <div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="preprocessor"> fprintf(stderr, "\telem->next->prev %p\n", \</span></div> <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="preprocessor"> APR_RING_PREV(APR_RING_NEXT(here, link), link)); \</span></div> <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="preprocessor"> fprintf(stderr, "\telem->prev->next %p\n", \</span></div> <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="preprocessor"> APR_RING_NEXT(APR_RING_PREV(here, link), link)); \</span></div> <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="preprocessor"> if (APR_RING_PREV(APR_RING_NEXT(here, link), link) != here) { \</span></div> <div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="preprocessor"> fprintf(stderr, "\t*** elem->next->prev != elem\n"); \</span></div> <div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="preprocessor"> break; \</span></div> <div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="preprocessor"> if (APR_RING_NEXT(APR_RING_PREV(here, link), link) != here) { \</span></div> <div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="preprocessor"> fprintf(stderr, "\t*** elem->prev->next != elem\n"); \</span></div> <div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="preprocessor"> break; \</span></div> <div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor"> here = APR_RING_NEXT(here, link); \</span></div> <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="preprocessor"> } while (here != start); \</span></div> <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="preprocessor"> fprintf(stderr, "*** ring check end\n"); \</span></div> <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="preprocessor">#define APR_RING_CHECK_CONSISTENCY(hp, elem, link) \</span></div> <div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="preprocessor"> APR_RING_CHECK_ELEM_CONSISTENCY(APR_RING_SENTINEL(hp, elem, link),\</span></div> <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="preprocessor"> elem, link)</span></div> <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="preprocessor">#define APR_RING_CHECK_ELEM_CONSISTENCY(ep, elem, link) do { \</span></div> <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="preprocessor"> struct elem *start = (ep); \</span></div> <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="preprocessor"> struct elem *here = start; \</span></div> <div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor"> do { \</span></div> <div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor"> assert(APR_RING_PREV(APR_RING_NEXT(here, link), link) == here); \</span></div> <div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor"> assert(APR_RING_NEXT(APR_RING_PREV(here, link), link) == here); \</span></div> <div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor"> here = APR_RING_NEXT(here, link); \</span></div> <div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor"> } while (here != start); \</span></div> <div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="preprocessor">#else</span></div> <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * Print a single pointer value to STDERR</span></div> <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> * (This is a no-op unless APR_RING_DEBUG is defined.)</span></div> <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> * @param msg Descriptive message</span></div> <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> * @param ptr Pointer value to print</span></div> <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> */</span></div> <div class="line"><a name="l00465"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga33c7cfbea7c688c7bd0a3d36609f318b"> 465</a></span> <span class="preprocessor">#define APR_RING_CHECK_ONE(msg, ptr)</span></div> <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> * Dump all ring pointers to STDERR, starting with the head and looping all</span></div> <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> * the way around the ring back to the head. Aborts if an inconsistency</span></div> <div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> * is found.</span></div> <div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> * (This is a no-op unless APR_RING_DEBUG is defined.)</span></div> <div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> * @param msg Descriptive message</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"><a class="line" href="group__apr__ring.html#ga97bb4dcc313145496e6b05855f9c6e2b"> 476</a></span> <span class="preprocessor">#define APR_RING_CHECK(hp, elem, link, msg)</span></div> <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> * Loops around a ring and checks all the pointers for consistency. Pops</span></div> <div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> * an assertion if any inconsistency is found. Same idea as APR_RING_CHECK()</span></div> <div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> * except that it's silent if all is well.</span></div> <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * (This is a no-op unless APR_RING_DEBUG is defined.)</span></div> <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> * @param hp Head of the ring</span></div> <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> */</span></div> <div class="line"><a name="l00486"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga6b0f2091527ee9c7a1511cb6f172a0a7"> 486</a></span> <span class="preprocessor">#define APR_RING_CHECK_CONSISTENCY(hp, elem, link)</span></div> <div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> * Dump all ring pointers to STDERR, starting with the given element and</span></div> <div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> * looping all the way around the ring back to that element. Aborts if</span></div> <div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> * an inconsistency is found.</span></div> <div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> * (This is a no-op unless APR_RING_DEBUG is defined.)</span></div> <div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> * @param ep The element</span></div> <div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * @param msg Descriptive message</span></div> <div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> */</span></div> <div class="line"><a name="l00497"></a><span class="lineno"><a class="line" href="group__apr__ring.html#ga5500df0e96dea1a3258f1e92b28fea0a"> 497</a></span> <span class="preprocessor">#define APR_RING_CHECK_ELEM(ep, elem, link, msg)</span></div> <div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * Loops around a ring, starting with the given element, and checks all</span></div> <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * the pointers for consistency. Pops an assertion if any inconsistency</span></div> <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> * is found. Same idea as APR_RING_CHECK_ELEM() except that it's silent</span></div> <div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> * if all is well.</span></div> <div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * (This is a no-op unless APR_RING_DEBUG is defined.)</span></div> <div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> * @param ep The element</span></div> <div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * @param elem The name of the element struct</span></div> <div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * @param link The name of the APR_RING_ENTRY in the element struct</span></div> <div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> */</span></div> <div class="line"><a name="l00508"></a><span class="lineno"><a class="line" href="group__apr__ring.html#gab7070ae5cf69bf16178a0e0e397c5b38"> 508</a></span> <span class="preprocessor">#define APR_RING_CHECK_ELEM_CONSISTENCY(ep, elem, link)</span></div> <div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment">/** @} */</span> </div> <div class="line"><a name="l00512"></a><span class="lineno"> 512</span> </div> <div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="preprocessor">#endif </span><span class="comment">/* !APR_RING_H */</span><span class="preprocessor"></span></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><!-- 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.5 </small></address> </body> </html>