File: group__PROBEAUXAPI.html

package info (click to toggle)
openscap 1.0.9-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 129,588 kB
  • ctags: 26,325
  • sloc: xml: 611,156; ansic: 90,367; sh: 26,693; makefile: 2,463; python: 804; perl: 445; cpp: 123
file content (270 lines) | stat: -rw-r--r-- 17,041 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<!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.3.1"/>
<title>Open SCAP Library: Auxilirary functions for probes</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.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Auxilirary functions for probes<div class="ingroups"><a class="el" href="group__PROBES.html">System checking mechanism - probes</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdev__t.html">fsdev_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filesystem device structure.  <a href="structfsdev__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga83ab84061594e187331ebda6a59740f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga83ab84061594e187331ebda6a59740f8"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MTAB_PATH</b>&#160;&#160;&#160;&quot;/etc/mtab&quot;</td></tr>
<tr class="separator:ga83ab84061594e187331ebda6a59740f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga194d45ac936ad2434ad25f6d8f28b112"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>LOCAL_FILESYSTEMS</b></td></tr>
<tr class="separator:ga194d45ac936ad2434ad25f6d8f28b112"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga643f34eaa696e430debd134ac0d631c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga643f34eaa696e430debd134ac0d631c0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FSDEV_H</b></td></tr>
<tr class="separator:ga643f34eaa696e430debd134ac0d631c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa43d5f3529a4fc279edd70f92c5a5e76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa43d5f3529a4fc279edd70f92c5a5e76"></a>
<a class="el" href="structfsdev__t.html">fsdev_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#gaa43d5f3529a4fc279edd70f92c5a5e76">fsdev_init</a> (const char **fs, size_t fs_cnt)</td></tr>
<tr class="memdesc:gaa43d5f3529a4fc279edd70f92c5a5e76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure from an array of filesystem names. <br/></td></tr>
<tr class="separator:gaa43d5f3529a4fc279edd70f92c5a5e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed7a61d80478c533525165239dfc409f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaed7a61d80478c533525165239dfc409f"></a>
<a class="el" href="structfsdev__t.html">fsdev_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#gaed7a61d80478c533525165239dfc409f">fsdev_strinit</a> (const char *fs_names)</td></tr>
<tr class="memdesc:gaed7a61d80478c533525165239dfc409f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure from a string containing filesystem names. <br/></td></tr>
<tr class="separator:gaed7a61d80478c533525165239dfc409f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7e2b275c4b002fb669678a07b9619d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7e2b275c4b002fb669678a07b9619d5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#gae7e2b275c4b002fb669678a07b9619d5">fsdev_free</a> (<a class="el" href="structfsdev__t.html">fsdev_t</a> *lfs)</td></tr>
<tr class="memdesc:gae7e2b275c4b002fb669678a07b9619d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure. <br/></td></tr>
<tr class="separator:gae7e2b275c4b002fb669678a07b9619d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga744338d0cacfb13cf5c9f22281489e1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga744338d0cacfb13cf5c9f22281489e1f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#ga744338d0cacfb13cf5c9f22281489e1f">fsdev_search</a> (<a class="el" href="structfsdev__t.html">fsdev_t</a> *lfs, void *id)</td></tr>
<tr class="memdesc:ga744338d0cacfb13cf5c9f22281489e1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search an id in the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure. <br/></td></tr>
<tr class="separator:ga744338d0cacfb13cf5c9f22281489e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5563f3287c7639d1a36af3323e2b1aaa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#ga5563f3287c7639d1a36af3323e2b1aaa">fsdev_path</a> (<a class="el" href="structfsdev__t.html">fsdev_t</a> *lfs, const char *path)</td></tr>
<tr class="memdesc:ga5563f3287c7639d1a36af3323e2b1aaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a path points points to a place on any of the devices in the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure.  <a href="#ga5563f3287c7639d1a36af3323e2b1aaa">More...</a><br/></td></tr>
<tr class="separator:ga5563f3287c7639d1a36af3323e2b1aaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga297efe1d9f22008581daabefb000ea32"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#ga297efe1d9f22008581daabefb000ea32">fsdev_fd</a> (<a class="el" href="structfsdev__t.html">fsdev_t</a> *lfs, int fd)</td></tr>
<tr class="memdesc:ga297efe1d9f22008581daabefb000ea32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a file descriptor is associated with a file that resides on any of the devices in the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure.  <a href="#ga297efe1d9f22008581daabefb000ea32">More...</a><br/></td></tr>
<tr class="separator:ga297efe1d9f22008581daabefb000ea32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63f29a3a7e705e9ffeef0b6592b29a8e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEAUXAPI.html#ga63f29a3a7e705e9ffeef0b6592b29a8e">find_files</a> (<a class="el" href="structSEXP.html">SEXP_t</a> *spath, <a class="el" href="structSEXP.html">SEXP_t</a> *sfilename, <a class="el" href="structSEXP.html">SEXP_t</a> *behaviors, int(*cb)(const char *, const char *, void *), void *arg)</td></tr>
<tr class="memdesc:ga63f29a3a7e705e9ffeef0b6592b29a8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search the filesystem according to the specified path, filename and behaviors.  <a href="#ga63f29a3a7e705e9ffeef0b6592b29a8e">More...</a><br/></td></tr>
<tr class="separator:ga63f29a3a7e705e9ffeef0b6592b29a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga194d45ac936ad2434ad25f6d8f28b112"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define LOCAL_FILESYSTEMS</td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ <span class="stringliteral">&quot;btrfs&quot;</span>,            \</div>
<div class="line">                        <span class="stringliteral">&quot;ext2&quot;</span>, <span class="stringliteral">&quot;ext3&quot;</span>, <span class="stringliteral">&quot;ext4&quot;</span>, \</div>
<div class="line">                        <span class="stringliteral">&quot;ffs&quot;</span>,                  \</div>
<div class="line">                        <span class="stringliteral">&quot;gfs&quot;</span>,                  \</div>
<div class="line">                        <span class="stringliteral">&quot;hpfs&quot;</span>,                 \</div>
<div class="line">                        <span class="stringliteral">&quot;jfs&quot;</span>,                  \</div>
<div class="line">                        <span class="stringliteral">&quot;reiser4&quot;</span>, <span class="stringliteral">&quot;reiserfs&quot;</span>,  \</div>
<div class="line">                        <span class="stringliteral">&quot;ufs&quot;</span>,                  \</div>
<div class="line">                        <span class="stringliteral">&quot;xfs&quot;</span>,                  \</div>
<div class="line">                        <span class="stringliteral">&quot;zfs&quot;</span>, NULL}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga63f29a3a7e705e9ffeef0b6592b29a8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int find_files </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSEXP.html">SEXP_t</a> *&#160;</td>
          <td class="paramname"><em>spath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structSEXP.html">SEXP_t</a> *&#160;</td>
          <td class="paramname"><em>sfilename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structSEXP.html">SEXP_t</a> *&#160;</td>
          <td class="paramname"><em>behaviors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int(*)(const char *, const char *, void *)&#160;</td>
          <td class="paramname"><em>cb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Search the filesystem according to the specified path, filename and behaviors. </p>
<p>For all paths and files that satisfy these requirements call the provided callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>the requested path in a sexp form, which may specify the matching operation or a var_ref </td></tr>
    <tr><td class="paramname">filenam</td><td>the requested filename in a sexp form, which may specify the matching operation or a var_ref </td></tr>
    <tr><td class="paramname">behaviors</td><td>the behaviors may specify the recursion depth or direction </td></tr>
    <tr><td class="paramname">cb</td><td>for each match, the callback function cb is called with first argument being the matched path and the second being the matched filename </td></tr>
    <tr><td class="paramname">arg</td><td>an optional argument to the callback function </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga297efe1d9f22008581daabefb000ea32"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fsdev_fd </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfsdev__t.html">fsdev_t</a> *&#160;</td>
          <td class="paramname"><em>lfs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>fd</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check whether a file descriptor is associated with a file that resides on any of the devices in the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">lfs</td><td>pointer to the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure </td></tr>
    <tr><td class="paramname">fd</td><td>file descriptor </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">1</td><td>if found </td></tr>
    <tr><td class="paramname">0</td><td>otherwise </td></tr>
    <tr><td class="paramname">-1</td><td>error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga5563f3287c7639d1a36af3323e2b1aaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fsdev_path </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfsdev__t.html">fsdev_t</a> *&#160;</td>
          <td class="paramname"><em>lfs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>path</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check whether a path points points to a place on any of the devices in the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">lfs</td><td>pointer to the <a class="el" href="structfsdev__t.html" title="Filesystem device structure.">fsdev_t</a> structure </td></tr>
    <tr><td class="paramname">path</td><td>path </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">1</td><td>if found </td></tr>
    <tr><td class="paramname">0</td><td>otherwise </td></tr>
    <tr><td class="paramname">-1</td><td>error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>