<!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.6"/> <title>Open SCAP Library: spb.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="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">Open SCAP Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_dec16e0beb5f79ab6b40e328203e2e32.html">OVAL</a></li><li class="navelem"><a class="el" href="dir_d57a52ee0ad0cdc1d71df7a41be84a06.html">probes</a></li><li class="navelem"><a class="el" href="dir_e44ea870b871257418c4b8816dbb35e8.html">SEAP</a></li><li class="navelem"><a class="el" href="dir_3bbee5d1fd00ea842e36d8d254e96971.html">generic</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">spb.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2009 Red Hat Inc., Durham, North Carolina.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</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"> * This library is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Authors:</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * "Daniel Kopecek" <dkopecek@redhat.com></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#pragma once</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef SPB_H</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define SPB_H</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <stddef.h></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <inttypes.h></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <common/util.h></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define __XC(a, b) OSCAP_CONCAT(a, b)</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#define _sym(n) __XC(__XC(_sym, __LINE__), n)</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">typedef</span> uint32_t spb_flags_t;</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define SPB_FLAG_FREE 0x00000001</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#define SPB_FLAG_JOIN 0x00000002</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#define SPB_FLAG_FILE 0x00000004</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">typedef</span> uint64_t spb_size_t;</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define SPB_SZ_FMT "%"PRIo64</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structspb__item__t.html"> 43</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> *base; <span class="comment">/* buffer base address */</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  spb_size_t gend; <span class="comment">/* sparse buffer index of the last byte of this buffer */</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> } <a class="code" href="structspb__item__t.html">spb_item_t</a>;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structspb__t.html"> 48</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structspb__item__t.html">spb_item_t</a> *buffer; <span class="comment">/* array of buffers representing the sparse buffer */</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint32_t btotal; <span class="comment">/* number of buffer */</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint32_t balloc; <span class="comment">/* number of allocated slots */</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  uint32_t bflags; <span class="comment">/* flags - not used at the moment */</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <a class="code" href="structspb__t.html">spb_t</a>;</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define SPB_DEFAULT_BALLOC 32 </span><span class="comment">/* default number of pre-allocated slots */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span><span class="preprocessor">#define SPB_BALLOC_HIGHTRESH 512 </span><span class="comment">/* the number of new slots is doubled until this limit is reached */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span><span class="preprocessor">#define SPB_BALLOC_ADD 32 </span><span class="comment">/* number of slot to add when we reached the high threshold */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="structspb__t.html">spb_t</a> *spb_new (<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> buflen, uint32_t balloc);</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">void</span> spb_free (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_flags_t flags);</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> uint32_t spb_bindex (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t index);</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> spb_size_t spb_size (<a class="code" href="structspb__t.html">spb_t</a> *spb);</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define spb_iterate_oct(spb, start, end, name) </span><span class="comment">/* TODO */</span><span class="preprocessor"> while(0)</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define spb_iterate(spb, start, name, icode) \</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"> do { \</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> spb_size_t _sym(istart) = (start); \</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"> spb_t *_sym(ispb) = (spb); \</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"> uint32_t _sym(idx) = spb_bindex(_sym(ispb), _sym(istart)); \</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"> size_t _sym(l_off) = (size_t)(_sym(idx) > 0 ? start - _sym(ispb)->buffer[_sym(idx) - 1].gend - 1 : start); \</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor"> for (; _sym(idx) < _sym(ispb)->btotal; ++_sym(idx)) { \</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> register size_t _sym(l); \</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"> register uint8_t *_sym(b); \</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> _sym(l) = (size_t)(_sym(idx) > 0 ? \</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> _sym(ispb)->buffer[_sym(idx)].gend - _sym(ispb)->buffer[_sym(idx) - 1].gend : \</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> _sym(ispb)->buffer[_sym(idx)].gend + 1) - _sym(l_off); \</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"> _sym(b) = ((uint8_t *)(_sym(ispb)->buffer[_sym(idx)].base)) + _sym(l_off); \</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"> for (; _sym(l) > 0; --_sym(l), ++_sym(b)) { \</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"> (name) = *_sym(b); \</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"> icode; \</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"> if (_sym(l) > 0) \</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor"> break; \</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor"> _sym(l_off) = 0; \</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"> } while (0)</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">int</span> spb_add (<a class="code" href="structspb__t.html">spb_t</a> *spb, <span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> buflen);</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">int</span> spb_pick (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t start, spb_size_t size, <span class="keywordtype">void</span> *dst);</div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="keywordtype">int</span> spb_pick_raw (<a class="code" href="structspb__t.html">spb_t</a> *spb, uint32_t bindex, spb_size_t start, spb_size_t size, <span class="keywordtype">void</span> *dst);</div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keywordtype">int</span> spb_pick_cb (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t start, spb_size_t size, <span class="keywordtype">void</span> *cb (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>), <span class="keywordtype">void</span> *cbarg);</div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> spb_size_t spb_drop_head (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t size, spb_flags_t flags);</div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> uint8_t spb_octet (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t idx);</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">const</span> uint8_t *spb_direct (<a class="code" href="structspb__t.html">spb_t</a> *spb, spb_size_t start, spb_size_t size);</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#endif </span><span class="comment">/* SPB_H */</span><span class="preprocessor"></span></div> <div class="ttc" id="structspb__item__t_html"><div class="ttname"><a href="structspb__item__t.html">spb_item_t</a></div><div class="ttdef"><b>Definition:</b> spb.h:43</div></div> <div class="ttc" id="structspb__t_html"><div class="ttname"><a href="structspb__t.html">spb_t</a></div><div class="ttdef"><b>Definition:</b> spb.h:48</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.6 </small></address> </body> </html>