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
|
/*********************************************************
* Copyright (C) 2011-2015 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
#ifndef _VMTOOLS_LOG_H_
#define _VMTOOLS_LOG_H_
/**
* @file log.h
*
* Some wrappers around glib log functions, expanding their functionality to
* support common usage patterns at VMware.
*
* @defgroup vmtools_logging Logging
* @{
*
* The Tools logging facility is built on top of glib's logging functions
* (http://developer.gnome.org/glib/stable/glib-Message-Logging.html). Some
* convenience macros built on top of glib's existing macros are also provided.
*
* Logging is configurable on a per-domain basis. The configuration options
* for each domain are:
*
* - level: minimum log level to log. Also used to declare specific log
* domain configurations.
* - Valid values: error, critical, warning, message, info, debug, none
* - This value is required when configuring a domain.
* - handler: the handler to use when logging.
* - Valid values: std, outputdebugstring (Win32-only), file, file+ (same as
* "file", but appends to existing log file), vmx, syslog.
* - Default: "syslog".
*
* For file handlers, the following extra configuration information can be
* provided:
*
* - data: path to the log file, required.
* - maxOldLogFiles: maximum number of rotated log files to keep around. By
* default, at most 10 backed up log files will be kept. Value should be >= 1.
* - maxLogSize: maximum size of each log file, defaults to 10 (MB). A value of
* 0 disables log rotation.
*
* When using syslog on Unix, the following options are available:
*
* - facility: either of "daemon", "user" or "local[0-7]". Controls whether to
* connect to syslog as LOG_DAEMON, LOG_USER or LOG_LOCAL[0-7], respectively
* (see syslog(3)). Defaults to "user". Any unknown value is mapped to
* LOG_USER. This option should be defined for the application's default
* log domain (it's ignored for all other domains).
*
* The "vmx" logger will log all messages to the host; it's not recommended
* for normal use, since writing to the host log is an expensive operation and
* can also affect other running applications that need to send messages to the
* host. Do not use this logger unless explicitly instructed to do so.
*
* Logging configuration should be under the "[logging]" group in the
* application's configuration file.
*
* Each application can specify a default log domain (which defaults to
* "vmtools"). If no handler is specified for a particular domain when
* logging, the default handler will be used. The default logging level
* for the default domain is "warning" in non-debug builds, and "message"
* in debug builds.
*
* Example of logging configuration in the config file:
*
* @verbatim
* [logging]
* # Turns on logging globally. It can still be disabled for each domain.
* log = true
*
* # Disables core dumps on fatal errors; they're enabled by default.
* enableCoreDump = false
*
* # Defines the "vmsvc" domain, logging to stdout/stderr.
* vmsvc.level = info
* vmsvc.handler = std
*
* # Defines the "unity" domain, logging to a file.
* unity.level = warning
* unity.handler = file
* unity.data = /tmp/unity.log
*
* # Defines the "vmtoolsd" domain, and disable logging for it.
* vmtoolsd.level = none
* @endverbatim
*
* Log file names can contain references to pre-defined variables. The following
* variables are expanded when determining the path of the log file:
*
* - @a ${USER}: expands to the current user's login name
* - @a ${PID}: expands to the current process's ID.
* - @a ${IDX}: expands to the log file index (for rolling logs).
*
* So, for example, @a log.${USER}.${PID}.txt would expand to "log.jdoe.1234.txt"
* for user "jdoe" if the process ID were 1234.
* */
#if !defined(G_LOG_DOMAIN)
# error "G_LOG_DOMAIN must be defined."
#endif
#include <glib.h>
#if defined(__GNUC__)
# define FUNC __func__
#else
# define FUNC __FUNCTION__
#endif
/*
*******************************************************************************
* g_info -- */ /**
*
* Log a message with G_LOG_LEVEL_INFO; this function is missing in glib < 2.39
* for whatever reason.
*
* @param[in] fmt Log message format.
* @param[in] ... Message arguments.
*
*******************************************************************************
*/
#if !defined(g_info)
# define g_info(fmt, ...) g_log(G_LOG_DOMAIN, G_LOG_LEVEL_INFO, fmt, ## __VA_ARGS__)
#endif
/*
*******************************************************************************
* vm_{critical,debug,error,info,message,warning} -- */ /**
*
* Wrapper around the corresponding glib function that automatically includes
* the calling function name in the log message. The "fmt" parameter must be
* a string constant.
*
* @param[in] fmt Log message format.
* @param[in] ... Message arguments.
*
*******************************************************************************
*/
#define vm_critical(fmt, ...) g_critical("%s: " fmt, FUNC, ## __VA_ARGS__)
/** @copydoc vm_critical */
#define vm_debug(fmt, ...) g_debug("%s: " fmt, FUNC, ## __VA_ARGS__)
/** @copydoc vm_critical */
#define vm_error(fmt, ...) g_error("%s: " fmt, FUNC, ## __VA_ARGS__)
/** @copydoc vm_critical */
#define vm_info(fmt, ...) g_info("%s: " fmt, FUNC, ## __VA_ARGS__)
/** @copydoc vm_critical */
#define vm_message(fmt, ...) g_message("%s: " fmt, FUNC, ## __VA_ARGS__)
/** @copydoc vm_critical */
#define vm_warning(fmt, ...) g_warning("%s: " fmt, FUNC, ## __VA_ARGS__)
G_BEGIN_DECLS
void
VMTools_ConfigLogging(const gchar *defaultDomain,
GKeyFile *cfg,
gboolean force,
gboolean reset);
G_END_DECLS
/** @} */
#endif /* _VMTOOLS_LOG_H_ */
|
