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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2007-2008 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU General Public License Version 2
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/**
* SECTION:egg-debug
* @short_description: Debugging functions
*
* This file contains functions that can be used for debugging.
*/
#include <glib.h>
#include <glib/gi18n.h>
#include <glib/gprintf.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include <stdlib.h>
#include <signal.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <time.h>
#include <execinfo.h>
#include "egg-debug.h"
#define CONSOLE_RESET 0
#define CONSOLE_BLACK 30
#define CONSOLE_RED 31
#define CONSOLE_GREEN 32
#define CONSOLE_YELLOW 33
#define CONSOLE_BLUE 34
#define CONSOLE_MAGENTA 35
#define CONSOLE_CYAN 36
#define CONSOLE_WHITE 37
static gint fd = -1;
/**
* pk_set_console_mode:
**/
static void
pk_set_console_mode (guint console_code)
{
gchar command[13];
/* don't put extra commands into logs */
if (!egg_debug_is_console ())
return;
/* Command is the control command to the terminal */
g_snprintf (command, 13, "%c[%dm", 0x1B, console_code);
printf ("%s", command);
}
/**
* egg_debug_backtrace:
**/
void
egg_debug_backtrace (void)
{
void *call_stack[512];
int call_stack_size;
char **symbols;
int i = 1;
call_stack_size = backtrace (call_stack, G_N_ELEMENTS (call_stack));
symbols = backtrace_symbols (call_stack, call_stack_size);
if (symbols != NULL) {
pk_set_console_mode (CONSOLE_RED);
g_print ("Traceback:\n");
while (i < call_stack_size) {
g_print ("\t%s\n", symbols[i]);
i++;
}
pk_set_console_mode (CONSOLE_RESET);
free (symbols);
}
}
/**
* pk_log_line:
**/
static void
pk_log_line (const gchar *buffer)
{
ssize_t count;
/* open a file */
if (fd == -1) {
/* ITS4: ignore, /var/log/foo is owned by root, and this is just debug text */
fd = open (EGG_LOG_FILE, O_WRONLY|O_APPEND|O_CREAT, 0777);
if (fd == -1)
g_error ("could not open log: '%s'", EGG_LOG_FILE);
}
/* ITS4: ignore, debug text always NULL terminated */
count = write (fd, buffer, strlen (buffer));
if (count == -1)
g_warning ("could not write %s", buffer);
/* newline */
count = write (fd, "\n", 1);
if (count == -1)
g_warning ("could not write newline");
}
/**
* pk_print_line:
**/
static void
pk_print_line (const gchar *func, const gchar *file, const int line, const gchar *buffer, guint color)
{
gchar *str_time;
gchar *header;
time_t the_time;
GThread *thread;
time (&the_time);
str_time = g_new0 (gchar, 255);
strftime (str_time, 254, "%H:%M:%S", localtime (&the_time));
thread = g_thread_self ();
/* generate header text */
header = g_strdup_printf ("TI:%s\tTH:%p\tFI:%s\tFN:%s,%d", str_time, thread, file, func, line);
g_free (str_time);
/* always in light green */
pk_set_console_mode (CONSOLE_GREEN);
printf ("%s\n", header);
/* different colors according to the severity */
pk_set_console_mode (color);
printf (" - %s\n", buffer);
pk_set_console_mode (CONSOLE_RESET);
/* log to a file */
if (egg_debug_is_logging ()) {
pk_log_line (header);
pk_log_line (buffer);
}
/* flush this output, as we need to debug */
fflush (stdout);
g_free (header);
}
/**
* egg_debug_real:
**/
void
egg_debug_real (const gchar *func, const gchar *file, const int line, const gchar *format, ...)
{
va_list args;
gchar *buffer = NULL;
if (!egg_debug_enabled ())
return;
va_start (args, format);
g_vasprintf (&buffer, format, args);
va_end (args);
pk_print_line (func, file, line, buffer, CONSOLE_BLUE);
g_free(buffer);
}
/**
* egg_warning_real:
**/
void
egg_warning_real (const gchar *func, const gchar *file, const int line, const gchar *format, ...)
{
va_list args;
gchar *buffer = NULL;
if (!egg_debug_enabled ())
return;
va_start (args, format);
g_vasprintf (&buffer, format, args);
va_end (args);
/* do extra stuff for a warning */
if (!egg_debug_is_console ())
printf ("*** WARNING ***\n");
pk_print_line (func, file, line, buffer, CONSOLE_RED);
g_free(buffer);
}
/**
* egg_error_real:
**/
void
egg_error_real (const gchar *func, const gchar *file, const int line, const gchar *format, ...)
{
va_list args;
gchar *buffer = NULL;
va_start (args, format);
g_vasprintf (&buffer, format, args);
va_end (args);
/* do extra stuff for a warning */
if (!egg_debug_is_console ())
printf ("*** ERROR ***\n");
pk_print_line (func, file, line, buffer, CONSOLE_RED);
g_free(buffer);
/* we want to fix this! */
egg_debug_backtrace ();
exit (1);
}
/**
* egg_debug_enabled:
*
* Returns: TRUE if we have debugging enabled
**/
gboolean
egg_debug_enabled (void)
{
const gchar *env;
env = g_getenv (EGG_VERBOSE);
return (g_strcmp0 (env, "1") == 0);
}
/**
* egg_debug_is_logging:
*
* Returns: TRUE if we have logging enabled
**/
gboolean
egg_debug_is_logging (void)
{
const gchar *env;
env = g_getenv (EGG_LOGGING);
return (g_strcmp0 (env, "1") == 0);
}
/**
* egg_debug_is_console:
*
* Returns: TRUE if we have debugging enabled
**/
gboolean
egg_debug_is_console (void)
{
const gchar *env;
env = g_getenv (EGG_CONSOLE);
return (g_strcmp0 (env, "1") == 0);
}
/**
* egg_debug_set_logging:
**/
void
egg_debug_set_logging (gboolean enabled)
{
if (enabled)
g_setenv (EGG_LOGGING, "1", TRUE);
else
g_setenv (EGG_LOGGING, "0", TRUE);
if (egg_debug_is_logging ())
egg_debug ("logging to %s", EGG_LOG_FILE);
}
/**
* egg_debug_init:
* @debug: If we should print out verbose logging
**/
void
egg_debug_init (gboolean debug)
{
/* check if we are on console */
if (isatty (fileno (stdout)) == 1)
g_setenv (EGG_CONSOLE, "1", FALSE);
else
g_setenv (EGG_CONSOLE, "0", FALSE);
if (debug)
g_setenv (EGG_VERBOSE, "1", FALSE);
else
g_setenv (EGG_VERBOSE, "0", FALSE);
egg_debug ("Verbose debugging %i (on console %i)%s", egg_debug_enabled (), egg_debug_is_console (), EGG_VERBOSE);
}
|