/*
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 .
*/
#ifdef HAVE_CONFIG_H
#include
#endif
#include
#include
#include
#include
#ifndef _MSC_VER
#include
#endif
#include "log.h"
#include "backtrace.h"
static int glib_debug_level = 0;
static int abort_level = -1;
#ifndef SPICE_ABORT_LEVEL_DEFAULT
#ifdef SPICE_DISABLE_ABORT
#define SPICE_ABORT_LEVEL_DEFAULT -1
#else
#define SPICE_ABORT_LEVEL_DEFAULT SPICE_LOG_LEVEL_CRITICAL
#endif
#endif
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 == 0) {
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", SPICE_LOG_DOMAIN, FALSE);
} else {
debug_env = g_strconcat(debug_env, ":", SPICE_LOG_DOMAIN, NULL);
g_setenv("G_MESSAGES_DEBUG", SPICE_LOG_DOMAIN, FALSE);
g_free(debug_env);
}
}
}
}
static void spice_log_set_abort_level(void)
{
if (abort_level == -1) {
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");
abort_level = atoi(abort_str);
glib_abort_level = spice_log_level_to_glib(abort_level);
if (glib_abort_level != 0) {
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;
}
g_log_set_fatal_mask(SPICE_LOG_DOMAIN, fatal_mask);
}
} else {
abort_level = SPICE_ABORT_LEVEL_DEFAULT;
}
}
}
static void spice_logger(const gchar *log_domain,
GLogLevelFlags log_level,
const gchar *message,
gpointer user_data G_GNUC_UNUSED)
{
if (glib_debug_level != 0) {
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();
g_log_set_handler(SPICE_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,
SpiceLogLevel log_level,
const char *strloc,
const char *function,
const char *format,
va_list args)
{
GString *log_msg;
g_return_if_fail(spice_log_level_to_glib(log_level) != 0);
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, spice_log_level_to_glib(log_level), "%s", log_msg->str);
g_string_free(log_msg, TRUE);
if (abort_level != -1 && abort_level >= (int) log_level) {
spice_backtrace();
abort();
}
}
void spice_log(const char *log_domain,
SpiceLogLevel log_level,
const char *strloc,
const char *function,
const char *format,
...)
{
va_list args;
va_start (args, format);
spice_logv (log_domain, log_level, strloc, function, format, args);
va_end (args);
}