<!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>open-vm-tools 9.4.0: libvmtools/vmtoolsLog.c 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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">open-vm-tools 9.4.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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_59aef2c812dcd59b537445af3d6f308d.html">libvmtools</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">vmtoolsLog.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="vmtoolsInt_8h_source.html">vmtoolsInt.h</a>"</code><br/>
<code>#include <stdio.h></code><br/>
<code>#include <stdlib.h></code><br/>
<code>#include <glib/gstdio.h></code><br/>
<code>#include <unistd.h></code><br/>
<code>#include <sys/resource.h></code><br/>
<code>#include <sys/time.h></code><br/>
<code>#include "glibUtils.h"</code><br/>
<code>#include "log.h"</code><br/>
<code>#include "str.h"</code><br/>
<code>#include "system.h"</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad35f7c2a326520646c093391efd20432"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad35f7c2a326520646c093391efd20432"></a>
#define </td><td class="memItemRight" valign="bottom"><b>LOGGING_GROUP</b>   "logging"</td></tr>
<tr class="separator:ad35f7c2a326520646c093391efd20432"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eef923fb6ea320eed1db1fb23f96ff6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3eef923fb6ea320eed1db1fb23f96ff6"></a>
#define </td><td class="memItemRight" valign="bottom"><b>MAX_DOMAIN_LEN</b>   64</td></tr>
<tr class="separator:a3eef923fb6ea320eed1db1fb23f96ff6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ee2a2e473ab6fc8bba750c1ca6026bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a8ee2a2e473ab6fc8bba750c1ca6026bd">DEFAULT_HANDLER</a>   "syslog"</td></tr>
<tr class="separator:a8ee2a2e473ab6fc8bba750c1ca6026bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0a510af53cfd4bccf23fc4f302b9188"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#ab0a510af53cfd4bccf23fc4f302b9188">SAFE_HANDLER</a>   "std"</td></tr>
<tr class="separator:ab0a510af53cfd4bccf23fc4f302b9188"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43eae04a9cebdfcd119ffa1bc7a1fff8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a43eae04a9cebdfcd119ffa1bc7a1fff8">IS_FATAL</a>(level)   ((level) & G_LOG_FLAG_FATAL)</td></tr>
<tr class="separator:a43eae04a9cebdfcd119ffa1bc7a1fff8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa80d788afe27e0bd35841ca14ee872cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#aa80d788afe27e0bd35841ca14ee872cd">SHOULD_LOG</a>(level, data)</td></tr>
<tr class="separator:aa80d788afe27e0bd35841ca14ee872cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abff41364a1fd7d83b3ab6eca9e5dd256"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#abff41364a1fd7d83b3ab6eca9e5dd256">CLEAR_LOG_HANDLER</a>(handler)</td></tr>
<tr class="separator:abff41364a1fd7d83b3ab6eca9e5dd256"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aeb92d7ebc99cb1f16000428642d6e34a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb92d7ebc99cb1f16000428642d6e34a"></a>
typedef struct LogHandler </td><td class="memItemRight" valign="bottom"><b>LogHandler</b></td></tr>
<tr class="separator:aeb92d7ebc99cb1f16000428642d6e34a"><td class="memSeparator" colspan="2"> </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:a423e9027b7f0044096afecb324b963d7"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a423e9027b7f0044096afecb324b963d7">VMToolsAsprintf</a> (gchar **string, gchar const *format,...)</td></tr>
<tr class="separator:a423e9027b7f0044096afecb324b963d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadde2056a5a855f11ab1577a7373b81e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__logging.html#gadde2056a5a855f11ab1577a7373b81e1">VMTools_ConfigLogging</a> (const gchar *defaultDomain, GKeyFile *cfg, gboolean force, gboolean reset)</td></tr>
<tr class="separator:gadde2056a5a855f11ab1577a7373b81e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4350ac25d9ac3e66ff9c1f9f4063d9ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a4350ac25d9ac3e66ff9c1f9f4063d9ce">Debug</a> (const char *fmt,...)</td></tr>
<tr class="separator:a4350ac25d9ac3e66ff9c1f9f4063d9ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11a1cb4ce9e509c587e0dae3842f0973"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a11a1cb4ce9e509c587e0dae3842f0973">Log</a> (const char *fmt,...)</td></tr>
<tr class="separator:a11a1cb4ce9e509c587e0dae3842f0973"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a60c61f244fe22a73ab493bba07dea6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a4a60c61f244fe22a73ab493bba07dea6">LogV</a> (uint32 routing, const char *fmt, va_list args)</td></tr>
<tr class="separator:a4a60c61f244fe22a73ab493bba07dea6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e786ff2fcf95a5eac6d0d8514c16f5c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a2e786ff2fcf95a5eac6d0d8514c16f5c">Panic</a> (const char *fmt,...)</td></tr>
<tr class="separator:a2e786ff2fcf95a5eac6d0d8514c16f5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35d1dac76ff69b37f992a7c9678f179c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vmtoolsLog_8c.html#a35d1dac76ff69b37f992a7c9678f179c">Warning</a> (const char *fmt,...)</td></tr>
<tr class="separator:a35d1dac76ff69b37f992a7c9678f179c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Defines a logging infrastructure for the vmtools library based on glib's logging facilities. Wrap the commonly used logging functions (Log/Warning/Debug), and provides configurability for where logs should go to.</p>
<p>To choose the logging domain for your source file, define G_LOG_DOMAIN before including glib.h. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="abff41364a1fd7d83b3ab6eca9e5dd256"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLEAR_LOG_HANDLER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">handler</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
<div class="line"> if ((handler) != NULL) { \</div>
<div class="line"> if (handler->logger != NULL) { \</div>
<div class="line"> handler->logger->dtor(handler->logger); \</div>
<div class="line"> } \</div>
<div class="line"> g_free((handler)->domain); \</div>
<div class="line"> g_free((handler)->type); \</div>
<div class="line"> g_free(handler); \</div>
<div class="line"> } \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment --><p>Clean up the contents of a log handler. </p>
</div>
</div>
<a class="anchor" id="a8ee2a2e473ab6fc8bba750c1ca6026bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFAULT_HANDLER   "syslog"</td>
</tr>
</table>
</div><div class="memdoc">
<p>The default handler to use if none is specified by the config data. </p>
</div>
</div>
<a class="anchor" id="a43eae04a9cebdfcd119ffa1bc7a1fff8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IS_FATAL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">level</td><td>)</td>
<td>   ((level) & G_LOG_FLAG_FATAL)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells whether the given log level is a fatal error. </p>
</div>
</div>
<a class="anchor" id="ab0a510af53cfd4bccf23fc4f302b9188"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SAFE_HANDLER   "std"</td>
</tr>
</table>
</div><div class="memdoc">
<p>The "failsafe" handler. </p>
</div>
</div>
<a class="anchor" id="aa80d788afe27e0bd35841ca14ee872cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHOULD_LOG</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">level, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">data </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="vmtoolsLog_8c.html#a43eae04a9cebdfcd119ffa1bc7a1fff8">IS_FATAL</a>(level) || \</div>
<div class="line"> (gLogEnabled && ((data)->mask & (level))))</div>
<div class="ttc" id="vmtoolsLog_8c_html_a43eae04a9cebdfcd119ffa1bc7a1fff8"><div class="ttname"><a href="vmtoolsLog_8c.html#a43eae04a9cebdfcd119ffa1bc7a1fff8">IS_FATAL</a></div><div class="ttdeci">#define IS_FATAL(level)</div><div class="ttdef"><b>Definition:</b> vmtoolsLog.c:67</div></div>
</div><!-- fragment --><p>Tells whether a message should be logged. All fatal messages are logged, regardless of what the configuration says. Otherwise, the log domain's configuration is respected. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4350ac25d9ac3e66ff9c1f9f4063d9ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Debug </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message using the G_LOG_LEVEL_DEBUG level.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Log message format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a11a1cb4ce9e509c587e0dae3842f0973"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Log </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message using the G_LOG_LEVEL_INFO level.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Log message format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4a60c61f244fe22a73ab493bba07dea6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LogV </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"><em>routing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message with the given log level.</p>
<p>Translates lib/log levels into glib levels, and sends the message to the log implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>Log level. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Log message format. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">args</td><td>Log message arguments. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2e786ff2fcf95a5eac6d0d8514c16f5c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Panic </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message using the G_LOG_LEVEL_ERROR level. In the default configuration, this will cause the application to terminate and, if enabled, to dump core.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Log message format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a423e9027b7f0044096afecb324b963d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gint VMToolsAsprintf </td>
<td>(</td>
<td class="paramtype">gchar ** </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gchar const * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>glib-based version of Str_Asprintf().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">string</td><td>Where to store the result. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>String format. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>String arguments.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes printed. </dd></dl>
</div>
</div>
<a class="anchor" id="a35d1dac76ff69b37f992a7c9678f179c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Warning </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message using the G_LOG_LEVEL_WARNING level.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Log message format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 13 2013 17:04:41 for open-vm-tools 9.4.0 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>
