File: group__PROBEAUXAPI.tex

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (160 lines) | stat: -rw-r--r-- 9,789 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
\hypertarget{group__PROBEAUXAPI}{
\section{PROBEAUXAPI}
\label{group__PROBEAUXAPI}\index{PROBEAUXAPI@{PROBEAUXAPI}}
}
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structsetting__t}{setting\_\-t}
\item 
struct \hyperlink{structrglob__t}{rglob\_\-t}
\item 
struct \hyperlink{structfsdev__t}{fsdev\_\-t}
\begin{DoxyCompactList}\small\item\em Filesystem device structure. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Defines}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__PROBEAUXAPI_ga83ab84061594e187331ebda6a59740f8}{
\#define {\bfseries MTAB\_\-PATH}~\char`\"{}/etc/mtab\char`\"{}}
\label{group__PROBEAUXAPI_ga83ab84061594e187331ebda6a59740f8}

\item 
\#define {\bfseries LOCAL\_\-FILESYSTEMS}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
int \hyperlink{group__PROBEAUXAPI_ga63f29a3a7e705e9ffeef0b6592b29a8e}{find\_\-files} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$spath, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$sfilename, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$behaviors, int($\ast$cb)(const char $\ast$, const char $\ast$, void $\ast$), void $\ast$arg)
\begin{DoxyCompactList}\small\item\em Search the filesystem according to the specified path, filename and behaviors. \item\end{DoxyCompactList}\item 
\hypertarget{group__PROBEAUXAPI_gaa43d5f3529a4fc279edd70f92c5a5e76}{
\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$ \hyperlink{group__PROBEAUXAPI_gaa43d5f3529a4fc279edd70f92c5a5e76}{fsdev\_\-init} (const char $\ast$$\ast$fs, size\_\-t fs\_\-cnt)}
\label{group__PROBEAUXAPI_gaa43d5f3529a4fc279edd70f92c5a5e76}

\begin{DoxyCompactList}\small\item\em Initialize the \hyperlink{structfsdev__t}{fsdev\_\-t} structure from an array of filesystem names. \item\end{DoxyCompactList}\item 
\hypertarget{group__PROBEAUXAPI_gaed7a61d80478c533525165239dfc409f}{
\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$ \hyperlink{group__PROBEAUXAPI_gaed7a61d80478c533525165239dfc409f}{fsdev\_\-strinit} (const char $\ast$fs\_\-names)}
\label{group__PROBEAUXAPI_gaed7a61d80478c533525165239dfc409f}

\begin{DoxyCompactList}\small\item\em Initialize the \hyperlink{structfsdev__t}{fsdev\_\-t} structure from a string containing filesystem names. \item\end{DoxyCompactList}\item 
\hypertarget{group__PROBEAUXAPI_gae7e2b275c4b002fb669678a07b9619d5}{
void \hyperlink{group__PROBEAUXAPI_gae7e2b275c4b002fb669678a07b9619d5}{fsdev\_\-free} (\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$lfs)}
\label{group__PROBEAUXAPI_gae7e2b275c4b002fb669678a07b9619d5}

\begin{DoxyCompactList}\small\item\em Free the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. \item\end{DoxyCompactList}\item 
\hypertarget{group__PROBEAUXAPI_ga744338d0cacfb13cf5c9f22281489e1f}{
int \hyperlink{group__PROBEAUXAPI_ga744338d0cacfb13cf5c9f22281489e1f}{fsdev\_\-search} (\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$lfs, void $\ast$id)}
\label{group__PROBEAUXAPI_ga744338d0cacfb13cf5c9f22281489e1f}

\begin{DoxyCompactList}\small\item\em Search an id in the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. \item\end{DoxyCompactList}\item 
int \hyperlink{group__PROBEAUXAPI_ga5563f3287c7639d1a36af3323e2b1aaa}{fsdev\_\-path} (\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$lfs, const char $\ast$path)
\begin{DoxyCompactList}\small\item\em Check whether a path points points to a place on any of the devices in the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. \item\end{DoxyCompactList}\item 
int \hyperlink{group__PROBEAUXAPI_ga297efe1d9f22008581daabefb000ea32}{fsdev\_\-fd} (\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$lfs, int fd)
\begin{DoxyCompactList}\small\item\em Check whether a file descriptor is associated with a file that resides on any of the devices in the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__PROBEAUXAPI_gaa6ad1ec0b607d7249f5a3df42e70ac49}{
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ {\bfseries setting\_\-t::sfilename}}
\label{group__PROBEAUXAPI_gaa6ad1ec0b607d7249f5a3df42e70ac49}

\item 
\hypertarget{group__PROBEAUXAPI_ga163fee224f735e641e0cb3ad84f58f9e}{
bool {\bfseries setting\_\-t::filename\_\-is\_\-nil}}
\label{group__PROBEAUXAPI_ga163fee224f735e641e0cb3ad84f58f9e}

\item 
\hypertarget{group__PROBEAUXAPI_ga44091935753f870407726f7d1a1fdd02}{
char $\ast$ {\bfseries setting\_\-t::direction}}
\label{group__PROBEAUXAPI_ga44091935753f870407726f7d1a1fdd02}

\item 
\hypertarget{group__PROBEAUXAPI_gaf5ce27d9f4a054dcd40adc38ee9fb49d}{
char $\ast$ {\bfseries setting\_\-t::follow}}
\label{group__PROBEAUXAPI_gaf5ce27d9f4a054dcd40adc38ee9fb49d}

\item 
\hypertarget{group__PROBEAUXAPI_ga41753e0877b8e0437816a651eeb089f9}{
\hyperlink{structfsdev__t}{fsdev\_\-t} $\ast$ {\bfseries setting\_\-t::dev\_\-list}}
\label{group__PROBEAUXAPI_ga41753e0877b8e0437816a651eeb089f9}

\item 
\hypertarget{group__PROBEAUXAPI_ga387297c46e7bad07b8e6283501360450}{
int($\ast$ {\bfseries setting\_\-t::cb} )(const char $\ast$pathname, const char $\ast$filename, void $\ast$arg)}
\label{group__PROBEAUXAPI_ga387297c46e7bad07b8e6283501360450}

\item 
\hypertarget{group__PROBEAUXAPI_ga8e75392486a8d4d2002fcc37d9e392ab}{
char $\ast$$\ast$ {\bfseries rglob\_\-t::pathv}}
\label{group__PROBEAUXAPI_ga8e75392486a8d4d2002fcc37d9e392ab}

\item 
\hypertarget{group__PROBEAUXAPI_ga28fc5f352bc3b52eaa5897819ae3b450}{
int {\bfseries rglob\_\-t::offs}}
\label{group__PROBEAUXAPI_ga28fc5f352bc3b52eaa5897819ae3b450}

\item 
\hypertarget{group__PROBEAUXAPI_ga5274125aa9a3f209a21cdf6d3e309d1f}{
uint16\_\-t \hyperlink{group__PROBEAUXAPI_ga5274125aa9a3f209a21cdf6d3e309d1f}{fsdev\_\-t::cnt}}
\label{group__PROBEAUXAPI_ga5274125aa9a3f209a21cdf6d3e309d1f}

\begin{DoxyCompactList}\small\item\em Number of items in the array. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Define Documentation}
\hypertarget{group__PROBEAUXAPI_ga194d45ac936ad2434ad25f6d8f28b112}{
\index{PROBEAUXAPI@{PROBEAUXAPI}!LOCAL\_\-FILESYSTEMS@{LOCAL\_\-FILESYSTEMS}}
\index{LOCAL\_\-FILESYSTEMS@{LOCAL\_\-FILESYSTEMS}!PROBEAUXAPI@{PROBEAUXAPI}}
\subsubsection[{LOCAL\_\-FILESYSTEMS}]{\setlength{\rightskip}{0pt plus 5cm}\#define LOCAL\_\-FILESYSTEMS}}
\label{group__PROBEAUXAPI_ga194d45ac936ad2434ad25f6d8f28b112}
{\bfseries Value:}
\begin{DoxyCode}
{ "btrfs",            \
                        "ext2", "ext3", "ext4", \
                        "ffs",                  \
                        "gfs",                  \
                        "hpfs",                 \
                        "jfs",                  \
                        "reiser4", "reiserfs",  \
                        "ufs",                  \
                        "xfs",                  \
                        "zfs", NULL}
\end{DoxyCode}


\subsection{Function Documentation}
\hypertarget{group__PROBEAUXAPI_ga63f29a3a7e705e9ffeef0b6592b29a8e}{
\index{PROBEAUXAPI@{PROBEAUXAPI}!find\_\-files@{find\_\-files}}
\index{find\_\-files@{find\_\-files}!PROBEAUXAPI@{PROBEAUXAPI}}
\subsubsection[{find\_\-files}]{\setlength{\rightskip}{0pt plus 5cm}int find\_\-files ({\bf SEXP\_\-t} $\ast$ {\em spath}, \/  {\bf SEXP\_\-t} $\ast$ {\em sfilename}, \/  {\bf SEXP\_\-t} $\ast$ {\em behaviors}, \/  int($\ast$)(const char $\ast$, const char $\ast$, void $\ast$) {\em cb}, \/  void $\ast$ {\em arg})}}
\label{group__PROBEAUXAPI_ga63f29a3a7e705e9ffeef0b6592b29a8e}


Search the filesystem according to the specified path, filename and behaviors. For all paths and files that satisfy these requirements call the provided callback function. 
\begin{DoxyParams}{Parameters}
\item[{\em path}]the requested path in a sexp form, which may specify the matching operation or a var\_\-ref \item[{\em filenam}]the requested filename in a sexp form, which may specify the matching operation or a var\_\-ref \item[{\em behaviors}]the behaviors may specify the recursion depth or direction \item[{\em cb}]for each match, the callback function cb is called with first argument being the matched path and the second being the matched filename \item[{\em arg}]an optional argument to the callback function \end{DoxyParams}
\hypertarget{group__PROBEAUXAPI_ga297efe1d9f22008581daabefb000ea32}{
\index{PROBEAUXAPI@{PROBEAUXAPI}!fsdev\_\-fd@{fsdev\_\-fd}}
\index{fsdev\_\-fd@{fsdev\_\-fd}!PROBEAUXAPI@{PROBEAUXAPI}}
\subsubsection[{fsdev\_\-fd}]{\setlength{\rightskip}{0pt plus 5cm}int fsdev\_\-fd ({\bf fsdev\_\-t} $\ast$ {\em lfs}, \/  int {\em fd})}}
\label{group__PROBEAUXAPI_ga297efe1d9f22008581daabefb000ea32}


Check whether a file descriptor is associated with a file that resides on any of the devices in the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. 
\begin{DoxyParams}{Parameters}
\item[{\em lfs}]pointer to the \hyperlink{structfsdev__t}{fsdev\_\-t} structure \item[{\em fd}]file descriptor \end{DoxyParams}

\begin{DoxyRetVals}{Return values}
\item[{\em 1}]if found \item[{\em 0}]otherwise \item[{\em -\/1}]error \end{DoxyRetVals}
\hypertarget{group__PROBEAUXAPI_ga5563f3287c7639d1a36af3323e2b1aaa}{
\index{PROBEAUXAPI@{PROBEAUXAPI}!fsdev\_\-path@{fsdev\_\-path}}
\index{fsdev\_\-path@{fsdev\_\-path}!PROBEAUXAPI@{PROBEAUXAPI}}
\subsubsection[{fsdev\_\-path}]{\setlength{\rightskip}{0pt plus 5cm}int fsdev\_\-path ({\bf fsdev\_\-t} $\ast$ {\em lfs}, \/  const char $\ast$ {\em path})}}
\label{group__PROBEAUXAPI_ga5563f3287c7639d1a36af3323e2b1aaa}


Check whether a path points points to a place on any of the devices in the \hyperlink{structfsdev__t}{fsdev\_\-t} structure. 
\begin{DoxyParams}{Parameters}
\item[{\em lfs}]pointer to the \hyperlink{structfsdev__t}{fsdev\_\-t} structure \item[{\em path}]path \end{DoxyParams}

\begin{DoxyRetVals}{Return values}
\item[{\em 1}]if found \item[{\em 0}]otherwise \item[{\em -\/1}]error \end{DoxyRetVals}