File: include_2fuse__log_8h.html

package info (click to toggle)
fuse3 3.18.1-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 58,496 kB
  • sloc: ansic: 25,055; perl: 6,044; cpp: 3,960; python: 1,201; sh: 416; javascript: 313; makefile: 59
file content (268 lines) | stat: -rw-r--r-- 14,259 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfuse: include/fuse_log.h File Reference</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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">libfuse
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></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="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">fuse_log.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br />
</div>
<p><a href="include_2fuse__log_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a76d80f5bae796dddb1d6b6a121968666" id="r_a76d80f5bae796dddb1d6b6a121968666"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#a76d80f5bae796dddb1d6b6a121968666">fuse_log_func_t</a>) (enum <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a> level, const char *fmt, va_list ap)</td></tr>
<tr class="separator:a76d80f5bae796dddb1d6b6a121968666"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad2c3b50473593e65865abaad574bd039" id="r_ad2c3b50473593e65865abaad574bd039"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a> </td></tr>
<tr class="separator:ad2c3b50473593e65865abaad574bd039"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af19307887778edec299c02c1e858addd" id="r_af19307887778edec299c02c1e858addd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#af19307887778edec299c02c1e858addd">fuse_set_log_func</a> (<a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#a76d80f5bae796dddb1d6b6a121968666">fuse_log_func_t</a> func)</td></tr>
<tr class="separator:af19307887778edec299c02c1e858addd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71cb594537921f3ff2ef0ca28173c198" id="r_a71cb594537921f3ff2ef0ca28173c198"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#a71cb594537921f3ff2ef0ca28173c198">fuse_log</a> (enum <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a> level, const char *fmt,...) __attribute__((format(printf</td></tr>
<tr class="separator:a71cb594537921f3ff2ef0ca28173c198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6ec263c62b5a34be03c381942b3554e" id="r_ab6ec263c62b5a34be03c381942b3554e"><td class="memItemLeft" align="right" valign="top">void void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#ab6ec263c62b5a34be03c381942b3554e">fuse_log_enable_syslog</a> (const char *ident, int option, int facility)</td></tr>
<tr class="separator:ab6ec263c62b5a34be03c381942b3554e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18631fd738519af89db82de2ea7c0034" id="r_a18631fd738519af89db82de2ea7c0034"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__log_8h.html#a18631fd738519af89db82de2ea7c0034">fuse_log_close_syslog</a> (void)</td></tr>
<tr class="separator:a18631fd738519af89db82de2ea7c0034"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the logging interface of FUSE </p>

<p class="definition">Definition in file <a class="el" href="include_2fuse__log_8h_source.html">fuse_log.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a76d80f5bae796dddb1d6b6a121968666" name="a76d80f5bae796dddb1d6b6a121968666"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76d80f5bae796dddb1d6b6a121968666">&#9670;&#160;</a></span>fuse_log_func_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* fuse_log_func_t) (enum <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a> level, const char *fmt, va_list ap)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Log message handler function.</p>
<p>This function must be thread-safe. It may be called from any libfuse function, including fuse_parse_cmdline() and other functions invoked before a FUSE filesystem is created.</p>
<p>Install a custom log message handler function using <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#af19307887778edec299c02c1e858addd">fuse_set_log_func()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">level</td><td>log severity level </td></tr>
    <tr><td class="paramname">fmt</td><td>sprintf-style format string including newline </td></tr>
    <tr><td class="paramname">ap</td><td>format string arguments </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="include_2fuse__log_8h_source.html#l00052">52</a> of file <a class="el" href="include_2fuse__log_8h_source.html">fuse_log.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ad2c3b50473593e65865abaad574bd039" name="ad2c3b50473593e65865abaad574bd039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2c3b50473593e65865abaad574bd039">&#9670;&#160;</a></span>fuse_log_level</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Log severity level</p>
<p>These levels correspond to syslog(2) log levels since they are widely used. </p>

<p class="definition">Definition at line <a class="el" href="include_2fuse__log_8h_source.html#l00028">28</a> of file <a class="el" href="include_2fuse__log_8h_source.html">fuse_log.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a71cb594537921f3ff2ef0ca28173c198" name="a71cb594537921f3ff2ef0ca28173c198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71cb594537921f3ff2ef0ca28173c198">&#9670;&#160;</a></span>fuse_log()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fuse_log </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#ad2c3b50473593e65865abaad574bd039">fuse_log_level</a>&#160;</td>
          <td class="paramname"><em>level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>fmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Emit a log message</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">level</td><td>severity level (FUSE_LOG_ERR, FUSE_LOG_DEBUG, etc) </td></tr>
    <tr><td class="paramname">fmt</td><td>sprintf-style format string including newline </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html#l00076">76</a> of file <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html">fuse_log.c</a>.</p>

</div>
</div>
<a id="a18631fd738519af89db82de2ea7c0034" name="a18631fd738519af89db82de2ea7c0034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18631fd738519af89db82de2ea7c0034">&#9670;&#160;</a></span>fuse_log_close_syslog()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fuse_log_close_syslog </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>To be called at teardown to close syslog. </p>

<p class="definition">Definition at line <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html#l00093">93</a> of file <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html">fuse_log.c</a>.</p>

</div>
</div>
<a id="ab6ec263c62b5a34be03c381942b3554e" name="ab6ec263c62b5a34be03c381942b3554e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6ec263c62b5a34be03c381942b3554e">&#9670;&#160;</a></span>fuse_log_enable_syslog()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void void fuse_log_enable_syslog </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ident</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>option</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>facility</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Switch default log handler from stderr to syslog</p>
<p>Passed options are according to 'man 3 openlog' </p>

<p class="definition">Definition at line <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html#l00086">86</a> of file <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html">fuse_log.c</a>.</p>

</div>
</div>
<a id="af19307887778edec299c02c1e858addd" name="af19307887778edec299c02c1e858addd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af19307887778edec299c02c1e858addd">&#9670;&#160;</a></span>fuse_set_log_func()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fuse_set_log_func </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fuse-3_817_83_2include_2fuse__log_8h.html#a76d80f5bae796dddb1d6b6a121968666">fuse_log_func_t</a>&#160;</td>
          <td class="paramname"><em>func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Install a custom log handler function.</p>
<p>Log messages are emitted by libfuse functions to report errors and debug information. Messages are printed to stderr by default but this can be overridden by installing a custom log message handler function.</p>
<p>The log message handler function is global and affects all FUSE filesystems created within this process.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">func</td><td>a custom log message handler function or NULL to revert to the default </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html#l00069">69</a> of file <a class="el" href="fuse-3_817_83_2lib_2fuse__log_8c_source.html">fuse_log.c</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>