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
|
/*
Copyright (C) 2012-2015 Red Hat, Inc.
This library 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; either
version 2.1 of the License, or (at your option) any later version.
This library 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 GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <glib.h>
#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#ifndef _MSC_VER
#include <unistd.h>
#endif
#include "log.h"
#include "backtrace.h"
static int glib_debug_level = INT_MAX;
static int abort_mask = 0;
#ifndef SPICE_ABORT_MASK_DEFAULT
#define SPICE_ABORT_MASK_DEFAULT (G_LOG_LEVEL_CRITICAL|G_LOG_LEVEL_ERROR)
#endif
#define G_LOG_DOMAIN "Spice"
typedef enum {
SPICE_LOG_LEVEL_ERROR,
SPICE_LOG_LEVEL_CRITICAL,
SPICE_LOG_LEVEL_WARNING,
SPICE_LOG_LEVEL_INFO,
SPICE_LOG_LEVEL_DEBUG,
} SpiceLogLevel;
static GLogLevelFlags spice_log_level_to_glib(SpiceLogLevel level)
{
static const GLogLevelFlags glib_levels[] = {
[ SPICE_LOG_LEVEL_ERROR ] = G_LOG_LEVEL_ERROR,
[ SPICE_LOG_LEVEL_CRITICAL ] = G_LOG_LEVEL_CRITICAL,
[ SPICE_LOG_LEVEL_WARNING ] = G_LOG_LEVEL_WARNING,
[ SPICE_LOG_LEVEL_INFO ] = G_LOG_LEVEL_INFO,
[ SPICE_LOG_LEVEL_DEBUG ] = G_LOG_LEVEL_DEBUG,
};
g_return_val_if_fail (level >= 0, G_LOG_LEVEL_ERROR);
g_return_val_if_fail (level < G_N_ELEMENTS(glib_levels), G_LOG_LEVEL_DEBUG);
return glib_levels[level];
}
static void spice_log_set_debug_level(void)
{
if (glib_debug_level == INT_MAX) {
const char *debug_str = g_getenv("SPICE_DEBUG_LEVEL");
if (debug_str != NULL) {
int debug_level;
char *debug_env;
/* FIXME: To be removed after enough deprecation time */
g_warning("Setting SPICE_DEBUG_LEVEL is deprecated, use G_MESSAGES_DEBUG instead");
debug_level = atoi(debug_str);
if (debug_level > SPICE_LOG_LEVEL_DEBUG) {
debug_level = SPICE_LOG_LEVEL_DEBUG;
}
glib_debug_level = spice_log_level_to_glib(debug_level);
/* If the debug level is too high, make sure we don't try to enable
* display of glib debug logs */
if (debug_level < SPICE_LOG_LEVEL_INFO)
return;
/* Make sure GLib default log handler will show the debug messages. Messing with
* environment variables like this is ugly, but this only happens when the legacy
* SPICE_DEBUG_LEVEL is used
*/
debug_env = (char *)g_getenv("G_MESSAGES_DEBUG");
if (debug_env == NULL) {
g_setenv("G_MESSAGES_DEBUG", G_LOG_DOMAIN, FALSE);
} else {
debug_env = g_strconcat(debug_env, " ", G_LOG_DOMAIN, NULL);
g_setenv("G_MESSAGES_DEBUG", G_LOG_DOMAIN, FALSE);
g_free(debug_env);
}
}
}
}
static void spice_log_set_abort_level(void)
{
if (abort_mask == 0) {
const char *abort_str = g_getenv("SPICE_ABORT_LEVEL");
if (abort_str != NULL) {
GLogLevelFlags glib_abort_level;
/* FIXME: To be removed after enough deprecation time */
g_warning("Setting SPICE_ABORT_LEVEL is deprecated, use G_DEBUG instead");
glib_abort_level = spice_log_level_to_glib(atoi(abort_str));
unsigned int fatal_mask = G_LOG_FATAL_MASK;
while (glib_abort_level >= G_LOG_LEVEL_ERROR) {
fatal_mask |= glib_abort_level;
glib_abort_level >>= 1;
}
abort_mask = fatal_mask;
g_log_set_fatal_mask(G_LOG_DOMAIN, fatal_mask);
} else {
abort_mask = SPICE_ABORT_MASK_DEFAULT;
}
}
}
static void spice_logger(const gchar *log_domain,
GLogLevelFlags log_level,
const gchar *message,
gpointer user_data G_GNUC_UNUSED)
{
if ((log_level & G_LOG_LEVEL_MASK) > glib_debug_level) {
return; // do not print anything
}
g_log_default_handler(log_domain, log_level, message, NULL);
}
SPICE_CONSTRUCTOR_FUNC(spice_log_init)
{
spice_log_set_debug_level();
spice_log_set_abort_level();
if (glib_debug_level != INT_MAX) {
/* If SPICE_DEBUG_LEVEL is set, we need a custom handler, which is
* going to break use of g_log_set_default_handler() by apps
*/
g_log_set_handler(G_LOG_DOMAIN,
G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION,
spice_logger, NULL);
}
/* Threading is always enabled from 2.31.0 onwards */
/* Our logging is potentially used from different threads.
* Older glibs require that g_thread_init() is called when
* doing that. */
#if !GLIB_CHECK_VERSION(2, 31, 0)
if (!g_thread_supported())
g_thread_init(NULL);
#endif
}
static void spice_logv(const char *log_domain,
GLogLevelFlags log_level,
const char *strloc,
const char *function,
const char *format,
va_list args)
{
GString *log_msg;
if ((log_level & G_LOG_LEVEL_MASK) > glib_debug_level) {
return; // do not print anything
}
log_msg = g_string_new(NULL);
if (strloc && function) {
g_string_append_printf(log_msg, "%s:%s: ", strloc, function);
}
if (format) {
g_string_append_vprintf(log_msg, format, args);
}
g_log(log_domain, log_level, "%s", log_msg->str);
g_string_free(log_msg, TRUE);
if ((abort_mask & log_level) != 0) {
spice_backtrace();
abort();
}
}
void spice_log(GLogLevelFlags log_level,
const char *strloc,
const char *function,
const char *format,
...)
{
va_list args;
va_start (args, format);
spice_logv (G_LOG_DOMAIN, log_level, strloc, function, format, args);
va_end (args);
}
|
