2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
6 * gstinfo.c: debugging functions
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 * @short_description: Debugging and logging facilities
27 * @see_also: #GstConfig, #Gst for command line parameters
28 * and environment variables that affect the debugging output.
30 * GStreamer's debugging subsystem is an easy way to get information about what
31 * the application is doing. It is not meant for programming errors. Use GLib
32 * methods (g_warning and friends) for that.
34 * The debugging subsystem works only after GStreamer has been initialized
35 * - for example by calling gst_init().
37 * The debugging subsystem is used to log informational messages while the
38 * application runs. Each messages has some properties attached to it. Among
39 * these properties are the debugging category, the severity (called "level"
40 * here) and an optional #GObject it belongs to. Each of these messages is sent
41 * to all registered debugging handlers, which then handle the messages.
42 * GStreamer attaches a default handler on startup, which outputs requested
45 * Messages are output by using shortcut macros like #GST_DEBUG,
46 * #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()
47 * with the right parameters.
48 * The only thing a developer will probably want to do is define his own
49 * categories. This is easily done with 3 lines. At the top of your code,
51 * the variables and set the default category.
54 * GST_DEBUG_CATEGORY_STATIC (my_category); // define category (statically)
55 * &hash;define GST_CAT_DEFAULT my_category // set as default
58 * After that you only need to initialize the category.
61 * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
62 * 0, "This is my very own");
65 * Initialization must be done before the category is used first.
67 * in their plugin_init function, libraries and applications should do that
68 * during their initialization.
70 * The whole debugging subsystem can be disabled at build time with passing the
71 * --disable-gst-debug switch to configure. If this is done, every function,
72 * macro and even structs described in this file evaluate to default values or
74 * So don't take addresses of these functions or use other tricks.
75 * If you must do that for some reason, there is still an option.
77 * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
79 * so you can check that before doing your trick.
80 * Disabling the debugging subsystem will give you a slight (read: unnoticeable)
81 * speed increase and will reduce the size of your compiled code. The GStreamer
82 * library itself becomes around 10% smaller.
84 * Please note that there are naming conventions for the names of debugging
85 * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
88 #include "gst_private.h"
91 #ifndef GST_DISABLE_GST_DEBUG
96 #ifdef HAVE_PRINTF_EXTENSION
99 #include <stdio.h> /* fprintf */
101 # include <unistd.h> /* getpid on UNIX */
103 #ifdef HAVE_PROCESS_H
104 # include <process.h> /* getpid on win32 */
106 #include <string.h> /* G_VA_COPY */
108 #include "gst_private.h"
109 #include "gstutils.h"
110 #include "gstsegment.h"
112 # include <valgrind/valgrind.h>
114 #include <glib/gprintf.h> /* g_sprintf */
116 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
117 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
119 /* time of initialization, so we get useful debugging output times
120 * FIXME: we use this in gstdebugutils.c, what about a function + macro to
121 * get the running time: GST_DEBUG_RUNNING_TIME
123 GstClockTime _gst_info_start_time;
127 #include <rld_interface.h>
128 typedef struct DL_INFO
130 const char *dli_fname;
132 const char *dli_sname;
136 long dli_reserved[4];
140 #define _RLD_DLADDR 14
141 int dladdr (void *address, Dl_info * dl);
144 dladdr (void *address, Dl_info * dl)
148 v = _rld_new_interface (_RLD_DLADDR, address, dl);
154 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
155 static void gst_debug_reset_all_thresholds (void);
157 #ifdef HAVE_PRINTF_EXTENSION
158 static int _gst_info_printf_extension_ptr (FILE * stream,
159 const struct printf_info *info, const void *const *args);
160 static int _gst_info_printf_extension_segment (FILE * stream,
161 const struct printf_info *info, const void *const *args);
162 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
163 size_t n, int *argtypes);
166 struct _GstDebugMessage
173 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
174 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
175 static GSList *__level_name = NULL;
183 /* list of all categories */
184 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
185 static GSList *__categories = NULL;
187 /* all registered debug handlers */
194 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
195 static GSList *__log_functions = NULL;
197 static gint __default_level;
198 static gint __use_color;
200 /* disabled by default, as soon as some threshold is set > NONE,
201 * it becomes enabled. */
202 gboolean __gst_debug_enabled = FALSE;
203 GstDebugLevel __gst_debug_min = GST_LEVEL_NONE;
205 GstDebugCategory *GST_CAT_DEFAULT = NULL;
207 GstDebugCategory *GST_CAT_GST_INIT = NULL;
208 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
209 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
210 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
211 GstDebugCategory *GST_CAT_STATES = NULL;
212 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
214 GstDebugCategory *GST_CAT_BUFFER = NULL;
215 GstDebugCategory *GST_CAT_BUS = NULL;
216 GstDebugCategory *GST_CAT_CAPS = NULL;
217 GstDebugCategory *GST_CAT_CLOCK = NULL;
218 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
219 GstDebugCategory *GST_CAT_PADS = NULL;
220 GstDebugCategory *GST_CAT_PIPELINE = NULL;
221 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
222 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
223 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
224 GstDebugCategory *GST_CAT_TYPES = NULL;
225 GstDebugCategory *GST_CAT_XML = NULL;
226 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
227 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
228 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
229 GstDebugCategory *GST_CAT_EVENT = NULL;
230 GstDebugCategory *GST_CAT_MESSAGE = NULL;
231 GstDebugCategory *GST_CAT_PARAMS = NULL;
232 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
233 GstDebugCategory *GST_CAT_SIGNAL = NULL;
234 GstDebugCategory *GST_CAT_PROBE = NULL;
235 GstDebugCategory *GST_CAT_REGISTRY = NULL;
236 GstDebugCategory *GST_CAT_QOS = NULL;
238 /* FIXME: export this? */
240 __gst_in_valgrind (void)
248 in_valgrind = GST_VG_UNCHECKED;
250 if (in_valgrind == GST_VG_UNCHECKED) {
252 if (RUNNING_ON_VALGRIND) {
253 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
254 printf ("GStreamer has detected that it is running inside valgrind.\n");
255 printf ("It might now take different code paths to ease debugging.\n");
256 printf ("Of course, this may also lead to different bugs.\n");
257 in_valgrind = GST_VG_INSIDE;
259 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
260 in_valgrind = GST_VG_NO_VALGRIND;
263 in_valgrind = GST_VG_NO_VALGRIND;
265 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
266 in_valgrind == GST_VG_INSIDE);
268 return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
274 * Initializes the debugging system.
275 * Normally you don't want to call this, because gst_init() does it for you.
278 _gst_debug_init (void)
282 gst_atomic_int_set (&__default_level, GST_LEVEL_DEFAULT);
283 gst_atomic_int_set (&__use_color, 1);
285 /* get time we started for debugging messages */
286 g_get_current_time (¤t);
287 _gst_info_start_time = GST_TIMEVAL_TO_TIME (current);
289 #ifdef HAVE_PRINTF_EXTENSION
290 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
291 _gst_info_printf_extension_arginfo);
292 register_printf_function (GST_SEGMENT_FORMAT[0],
293 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
296 /* do NOT use a single debug function before this line has been run */
297 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
298 GST_DEBUG_UNDERLINE, NULL);
299 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
300 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
302 gst_debug_add_log_function (gst_debug_log_default, NULL);
304 /* FIXME: add descriptions here */
305 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
306 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
307 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
308 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
309 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
310 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
311 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
312 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
313 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
314 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
315 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
316 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
317 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
318 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
319 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
320 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
321 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
322 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
323 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
324 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
325 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
326 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
327 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
328 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
329 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
330 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
331 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
332 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
333 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
334 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
335 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
336 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
337 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
338 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
339 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
340 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
341 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
342 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
343 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
344 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
345 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
347 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
348 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
349 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
350 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
351 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
352 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
353 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
354 GST_DEBUG_BOLD, NULL);
355 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
356 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
357 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
358 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
359 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
360 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
363 /* print out the valgrind message if we're in valgrind */
364 __gst_in_valgrind ();
367 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
368 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
372 * @category: category to log
373 * @level: level of the message is in
374 * @file: the file that emitted the message, usually the __FILE__ identifier
375 * @function: the function that emitted the message
376 * @line: the line from that the message was emitted, usually __LINE__
377 * @object: the object this message relates to or NULL if none
378 * @format: a printf style format string
379 * @...: optional arguments for the format
381 * Logs the given message using the currently registered debugging handlers.
384 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
385 const gchar * file, const gchar * function, gint line,
386 GObject * object, const gchar * format, ...)
390 va_start (var_args, format);
391 gst_debug_log_valist (category, level, file, function, line, object, format,
397 * gst_debug_log_valist:
398 * @category: category to log
399 * @level: level of the message is in
400 * @file: the file that emitted the message, usually the __FILE__ identifier
401 * @function: the function that emitted the message
402 * @line: the line from that the message was emitted, usually __LINE__
403 * @object: the object this message relates to or NULL if none
404 * @format: a printf style format string
405 * @args: optional arguments for the format
407 * Logs the given message using the currently registered debugging handlers.
410 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
411 const gchar * file, const gchar * function, gint line,
412 GObject * object, const gchar * format, va_list args)
414 GstDebugMessage message;
418 g_return_if_fail (category != NULL);
419 g_return_if_fail (file != NULL);
420 g_return_if_fail (function != NULL);
421 g_return_if_fail (format != NULL);
423 message.message = NULL;
424 message.format = format;
425 G_VA_COPY (message.arguments, args);
427 handler = __log_functions;
429 entry = handler->data;
430 handler = g_slist_next (handler);
431 entry->func (category, level, file, function, line, object, &message,
434 g_free (message.message);
435 va_end (message.arguments);
439 * gst_debug_message_get:
440 * @message: a debug message
442 * Gets the string representation of a #GstDebugMessage. This function is used
443 * in debug handlers to extract the message.
445 * Returns: the string representation of a #GstDebugMessage.
448 gst_debug_message_get (GstDebugMessage * message)
450 if (message->message == NULL) {
451 message->message = g_strdup_vprintf (message->format, message->arguments);
453 return message->message;
458 gst_debug_print_object (gpointer ptr)
460 GObject *object = (GObject *) ptr;
463 /* This is a cute trick to detect unmapped memory, but is unportable,
464 * slow, screws around with madvise, and not actually that useful. */
468 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
469 if (ret == -1 && errno == ENOMEM) {
470 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
475 /* nicely printed object */
476 if (object == NULL) {
477 return g_strdup ("(NULL)");
479 if (*(GType *) ptr == GST_TYPE_CAPS) {
480 return gst_caps_to_string ((GstCaps *) ptr);
482 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
483 return gst_structure_to_string ((GstStructure *) ptr);
486 if (*(guint32 *) ptr == 0xffffffff) {
487 return g_strdup_printf ("<poisoned@%p>", ptr);
490 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
491 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
493 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
494 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
496 if (G_IS_OBJECT (object)) {
497 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
499 if (GST_IS_MESSAGE (object)) {
500 GstMessage *msg = GST_MESSAGE_CAST (object);
503 if (msg->structure) {
504 s = gst_structure_to_string (msg->structure);
506 s = g_strdup ("(NULL)");
509 ret = g_strdup_printf ("%s message from element '%s': %s",
510 GST_MESSAGE_TYPE_NAME (msg), (msg->src != NULL) ?
511 GST_ELEMENT_NAME (msg->src) : "(NULL)", s);
516 return g_strdup_printf ("%p", ptr);
519 #ifdef HAVE_PRINTF_EXTENSION
522 gst_debug_print_segment (gpointer ptr)
524 GstSegment *segment = (GstSegment *) ptr;
526 /* nicely printed segment */
527 if (segment == NULL) {
528 return g_strdup ("(NULL)");
531 switch (segment->format) {
532 case GST_FORMAT_UNDEFINED:{
533 return g_strdup_printf ("UNDEFINED segment");
535 case GST_FORMAT_TIME:{
536 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
537 ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
538 ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
539 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
540 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
541 GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
542 segment->rate, segment->applied_rate, (guint) segment->flags,
543 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
546 const gchar *format_name;
548 format_name = gst_format_get_name (segment->format);
549 if (G_UNLIKELY (format_name == NULL))
550 format_name = "(UNKNOWN FORMAT)";
551 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
552 ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
553 ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
554 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
555 format_name, segment->start, segment->stop, segment->last_stop,
556 segment->duration, segment->rate, segment->applied_rate,
557 (guint) segment->flags, GST_TIME_ARGS (segment->time),
558 GST_TIME_ARGS (segment->accum));
563 #endif /* HAVE_PRINTF_EXTENSION */
566 * gst_debug_construct_term_color:
567 * @colorinfo: the color info
569 * Constructs a string that can be used for getting the desired color in color
571 * You need to free the string after use.
573 * Returns: a string containing the color definition
576 gst_debug_construct_term_color (guint colorinfo)
581 color = g_string_new ("\033[00");
583 if (colorinfo & GST_DEBUG_BOLD) {
584 g_string_append (color, ";01");
586 if (colorinfo & GST_DEBUG_UNDERLINE) {
587 g_string_append (color, ";04");
589 if (colorinfo & GST_DEBUG_FG_MASK) {
590 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
592 if (colorinfo & GST_DEBUG_BG_MASK) {
593 g_string_append_printf (color, ";4%1d",
594 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
596 g_string_append (color, "m");
599 g_string_free (color, FALSE);
604 * gst_debug_log_default:
605 * @category: category to log
606 * @level: level of the message
607 * @file: the file that emitted the message, usually the __FILE__ identifier
608 * @function: the function that emitted the message
609 * @line: the line from that the message was emitted, usually __LINE__
610 * @message: the actual message
611 * @object: the object this message relates to or NULL if none
612 * @unused: an unused variable, reserved for some user_data.
614 * The default logging handler used by GStreamer. Logging functions get called
615 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
616 * message and additional info using the glib error handler.
617 * You can add other handlers by using gst_debug_add_log_function().
618 * And you can remove this handler by calling
619 * gst_debug_remove_log_function(gst_debug_log_default);
622 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
623 const gchar * file, const gchar * function, gint line,
624 GObject * object, GstDebugMessage * message, gpointer unused)
630 const gchar *levelcolor;
633 GstClockTime elapsed;
634 gboolean free_color = TRUE;
635 gboolean free_obj = TRUE;
636 static const gchar *levelcolormap[] = {
637 "\033[37m", /* GST_LEVEL_NONE */
638 "\033[31;01m", /* GST_LEVEL_ERROR */
639 "\033[33;01m", /* GST_LEVEL_WARNING */
640 "\033[32;01m", /* GST_LEVEL_INFO */
641 "\033[36m", /* GST_LEVEL_DEBUG */
642 "\033[37m" /* GST_LEVEL_LOG */
645 if (level > gst_debug_category_get_threshold (category))
651 if (gst_debug_is_colored ()) {
652 color = gst_debug_construct_term_color (gst_debug_category_get_color
655 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
656 levelcolor = levelcolormap[level];
666 obj = gst_debug_print_object (object);
672 g_get_current_time (&now);
673 elapsed = GST_TIMEVAL_TO_TIME (now) - _gst_info_start_time;
676 g_printerr ("%s (%p - %" GST_TIME_FORMAT ") %s%20s%s(%s%5d%s) %s%s(%d):%s:%s%s %s\n",
677 gst_debug_level_get_name (level), g_thread_self (),
678 GST_TIME_ARGS (elapsed), color,
679 gst_debug_category_get_name (category), clear, pidcolor, pid, clear,
680 color, file, line, function, obj, clear, gst_debug_message_get (message));
683 g_printerr ("%" GST_TIME_FORMAT
684 " %s%5d%s %p %s%s%s %s%20s %s:%d:%s:%s%s %s\n", GST_TIME_ARGS (elapsed),
685 pidcolor, pid, clear, g_thread_self (), levelcolor,
686 gst_debug_level_get_name (level), clear, color,
687 gst_debug_category_get_name (category), file, line, function, obj, clear,
688 gst_debug_message_get (message));
697 * gst_debug_level_get_name:
698 * @level: the level to get the name for
700 * Get the string representation of a debugging level
705 gst_debug_level_get_name (GstDebugLevel level)
710 case GST_LEVEL_ERROR:
712 case GST_LEVEL_WARNING:
716 case GST_LEVEL_DEBUG:
721 g_warning ("invalid level specified for gst_debug_level_get_name");
727 * gst_debug_add_log_function:
728 * @func: the function to use
731 * Adds the logging function to the list of logging functions.
732 * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
735 gst_debug_add_log_function (GstLogFunction func, gpointer data)
740 g_return_if_fail (func != NULL);
742 entry = g_new (LogFuncEntry, 1);
744 entry->user_data = data;
745 /* FIXME: we leak the old list here - other threads might access it right now
746 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
747 * but that is waaay costly.
748 * It'd probably be clever to use some kind of RCU here, but I don't know
749 * anything about that.
751 g_static_mutex_lock (&__log_func_mutex);
752 list = g_slist_copy (__log_functions);
753 __log_functions = g_slist_prepend (list, entry);
754 g_static_mutex_unlock (&__log_func_mutex);
756 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
761 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
763 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
765 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
769 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
771 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
773 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
777 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
783 g_static_mutex_lock (&__log_func_mutex);
784 new = __log_functions;
785 while ((found = g_slist_find_custom (new, data, func))) {
786 if (new == __log_functions) {
787 new = g_slist_copy (new);
790 g_free (found->data);
791 new = g_slist_delete_link (new, found);
794 /* FIXME: We leak the old list here. See _add_log_function for why. */
795 __log_functions = new;
796 g_static_mutex_unlock (&__log_func_mutex);
802 * gst_debug_remove_log_function:
803 * @func: the log function to remove
805 * Removes all registered instances of the given logging functions.
807 * Returns: How many instances of the function were removed
810 gst_debug_remove_log_function (GstLogFunction func)
814 g_return_val_if_fail (func != NULL, 0);
817 gst_debug_remove_with_compare_func
818 (gst_debug_compare_log_function_by_func, (gpointer) func);
819 GST_DEBUG ("removed log function %p %d times from log function list", func,
826 * gst_debug_remove_log_function_by_data:
827 * @data: user data of the log function to remove
829 * Removes all registered instances of log functions with the given user data.
831 * Returns: How many instances of the function were removed
834 gst_debug_remove_log_function_by_data (gpointer data)
839 gst_debug_remove_with_compare_func
840 (gst_debug_compare_log_function_by_data, data);
842 ("removed %d log functions with user data %p from log function list",
849 * gst_debug_set_colored:
850 * @colored: Whether to use colored output or not
852 * Sets or unsets the use of coloured debugging output.
855 gst_debug_set_colored (gboolean colored)
857 gst_atomic_int_set (&__use_color, colored ? 1 : 0);
861 * gst_debug_is_colored:
863 * Checks if the debugging output should be colored.
865 * Returns: TRUE, if the debug output should be colored.
868 gst_debug_is_colored (void)
870 return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
874 * gst_debug_set_active:
875 * @active: Whether to use debugging output or not
877 * If activated, debugging messages are sent to the debugging
879 * It makes sense to deactivate it for speed issues.
880 * <note><para>This function is not threadsafe. It makes sense to only call it
881 * during initialization.</para></note>
884 gst_debug_set_active (gboolean active)
886 __gst_debug_enabled = active;
888 __gst_debug_min = GST_LEVEL_COUNT;
890 __gst_debug_min = GST_LEVEL_NONE;
894 * gst_debug_is_active:
896 * Checks if debugging output is activated.
898 * Returns: TRUE, if debugging is activated
901 gst_debug_is_active (void)
903 return __gst_debug_enabled;
907 * gst_debug_set_default_threshold:
908 * @level: level to set
910 * Sets the default threshold to the given level and updates all categories to
911 * use this threshold.
914 gst_debug_set_default_threshold (GstDebugLevel level)
916 gst_atomic_int_set (&__default_level, level);
917 gst_debug_reset_all_thresholds ();
921 * gst_debug_get_default_threshold:
923 * Returns the default threshold that is used for new categories.
925 * Returns: the default threshold level
928 gst_debug_get_default_threshold (void)
930 return (GstDebugLevel) g_atomic_int_get (&__default_level);
933 gst_debug_reset_threshold (gpointer category, gpointer unused)
935 GstDebugCategory *cat = (GstDebugCategory *) category;
938 g_static_mutex_lock (&__level_name_mutex);
941 LevelNameEntry *entry = walk->data;
943 walk = g_slist_next (walk);
944 if (g_pattern_match_string (entry->pat, cat->name)) {
945 GST_LOG ("category %s matches pattern %p - gets set to level %d",
946 cat->name, entry->pat, entry->level);
947 gst_debug_category_set_threshold (cat, entry->level);
951 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
954 g_static_mutex_unlock (&__level_name_mutex);
957 gst_debug_reset_all_thresholds (void)
959 g_static_mutex_lock (&__cat_mutex);
960 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
961 g_static_mutex_unlock (&__cat_mutex);
964 for_each_threshold_by_entry (gpointer data, gpointer user_data)
966 GstDebugCategory *cat = (GstDebugCategory *) data;
967 LevelNameEntry *entry = (LevelNameEntry *) user_data;
969 if (g_pattern_match_string (entry->pat, cat->name)) {
970 GST_LOG ("category %s matches pattern %p - gets set to level %d",
971 cat->name, entry->pat, entry->level);
972 gst_debug_category_set_threshold (cat, entry->level);
977 * gst_debug_set_threshold_for_name:
978 * @name: name of the categories to set
979 * @level: level to set them to
981 * Sets all categories which match the given glob style pattern to the given
985 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
988 LevelNameEntry *entry;
990 g_return_if_fail (name != NULL);
992 pat = g_pattern_spec_new (name);
993 entry = g_new (LevelNameEntry, 1);
995 entry->level = level;
996 g_static_mutex_lock (&__level_name_mutex);
997 __level_name = g_slist_prepend (__level_name, entry);
998 g_static_mutex_unlock (&__level_name_mutex);
999 g_static_mutex_lock (&__cat_mutex);
1000 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1001 g_static_mutex_unlock (&__cat_mutex);
1005 * gst_debug_unset_threshold_for_name:
1006 * @name: name of the categories to set
1008 * Resets all categories with the given name back to the default level.
1011 gst_debug_unset_threshold_for_name (const gchar * name)
1016 g_return_if_fail (name != NULL);
1018 pat = g_pattern_spec_new (name);
1019 g_static_mutex_lock (&__level_name_mutex);
1020 walk = __level_name;
1021 /* improve this if you want, it's mighty slow */
1023 LevelNameEntry *entry = walk->data;
1025 if (g_pattern_spec_equal (entry->pat, pat)) {
1026 __level_name = g_slist_remove_link (__level_name, walk);
1027 g_pattern_spec_free (entry->pat);
1029 g_slist_free_1 (walk);
1030 walk = __level_name;
1033 g_static_mutex_unlock (&__level_name_mutex);
1034 g_pattern_spec_free (pat);
1035 gst_debug_reset_all_thresholds ();
1039 _gst_debug_category_new (const gchar * name, guint color,
1040 const gchar * description)
1042 GstDebugCategory *cat;
1044 g_return_val_if_fail (name != NULL, NULL);
1046 cat = g_new (GstDebugCategory, 1);
1047 cat->name = g_strdup (name);
1049 if (description != NULL) {
1050 cat->description = g_strdup (description);
1052 cat->description = g_strdup ("no description");
1054 gst_atomic_int_set (&cat->threshold, 0);
1055 gst_debug_reset_threshold (cat, NULL);
1057 /* add to category list */
1058 g_static_mutex_lock (&__cat_mutex);
1059 __categories = g_slist_prepend (__categories, cat);
1060 g_static_mutex_unlock (&__cat_mutex);
1066 * gst_debug_category_free:
1067 * @category: #GstDebugCategory to free.
1069 * Removes and frees the category and all associated resources.
1072 gst_debug_category_free (GstDebugCategory * category)
1074 if (category == NULL)
1077 /* remove from category list */
1078 g_static_mutex_lock (&__cat_mutex);
1079 __categories = g_slist_remove (__categories, category);
1080 g_static_mutex_unlock (&__cat_mutex);
1082 g_free ((gpointer) category->name);
1083 g_free ((gpointer) category->description);
1088 * gst_debug_category_set_threshold:
1089 * @category: a #GstDebugCategory to set threshold of.
1090 * @level: the #GstDebugLevel threshold to set.
1092 * Sets the threshold of the category to the given level. Debug information will
1093 * only be output if the threshold is lower or equal to the level of the
1094 * debugging message.
1096 * Do not use this function in production code, because other functions may
1097 * change the threshold of categories as side effect. It is however a nice
1098 * function to use when debugging (even from gdb).
1102 gst_debug_category_set_threshold (GstDebugCategory * category,
1103 GstDebugLevel level)
1105 g_return_if_fail (category != NULL);
1107 if (level > __gst_debug_min) {
1108 __gst_debug_enabled = TRUE;
1109 __gst_debug_min = level;
1112 gst_atomic_int_set (&category->threshold, level);
1116 * gst_debug_category_reset_threshold:
1117 * @category: a #GstDebugCategory to reset threshold of.
1119 * Resets the threshold of the category to the default level. Debug information
1120 * will only be output if the threshold is lower or equal to the level of the
1121 * debugging message.
1122 * Use this function to set the threshold back to where it was after using
1123 * gst_debug_category_set_threshold().
1126 gst_debug_category_reset_threshold (GstDebugCategory * category)
1128 gst_debug_reset_threshold (category, NULL);
1132 * gst_debug_category_get_threshold:
1133 * @category: a #GstDebugCategory to get threshold of.
1135 * Returns the threshold of a #GstDebugCategory.
1137 * Returns: the #GstDebugLevel that is used as threshold.
1140 gst_debug_category_get_threshold (GstDebugCategory * category)
1142 return g_atomic_int_get (&category->threshold);
1146 * gst_debug_category_get_name:
1147 * @category: a #GstDebugCategory to get name of.
1149 * Returns the name of a debug category.
1151 * Returns: the name of the category.
1154 gst_debug_category_get_name (GstDebugCategory * category)
1156 return category->name;
1160 * gst_debug_category_get_color:
1161 * @category: a #GstDebugCategory to get the color of.
1163 * Returns the color of a debug category used when printing output in this
1166 * Returns: the color of the category.
1169 gst_debug_category_get_color (GstDebugCategory * category)
1171 return category->color;
1175 * gst_debug_category_get_description:
1176 * @category: a #GstDebugCategory to get the description of.
1178 * Returns the description of a debug category.
1180 * Returns: the description of the category.
1183 gst_debug_category_get_description (GstDebugCategory * category)
1185 return category->description;
1189 * gst_debug_get_all_categories:
1191 * Returns a snapshot of a all categories that are currently in use . This list
1192 * may change anytime.
1193 * The caller has to free the list after use.
1195 * Returns: the list of categories
1198 gst_debug_get_all_categories (void)
1202 g_static_mutex_lock (&__cat_mutex);
1203 ret = g_slist_copy (__categories);
1204 g_static_mutex_unlock (&__cat_mutex);
1209 /*** FUNCTION POINTERS ********************************************************/
1211 static GHashTable *__gst_function_pointers; /* NULL */
1212 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1215 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1216 G_GNUC_NO_INSTRUMENT;
1218 /* This function MUST NOT return NULL */
1219 const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1227 if (G_UNLIKELY (func == NULL))
1230 g_static_mutex_lock (&__dbg_functions_mutex);
1231 if (G_LIKELY (__gst_function_pointers)) {
1232 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1233 g_static_mutex_unlock (&__dbg_functions_mutex);
1234 if (G_LIKELY (ptrname))
1237 g_static_mutex_unlock (&__dbg_functions_mutex);
1239 /* we need to create an entry in the hash table for this one so we don't leak
1242 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1243 gchar *name = g_strdup (dl_info.dli_sname);
1245 _gst_debug_register_funcptr (func, name);
1250 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1252 _gst_debug_register_funcptr (func, name);
1258 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1260 gpointer ptr = (gpointer) func;
1262 g_static_mutex_lock (&__dbg_functions_mutex);
1264 if (!__gst_function_pointers)
1265 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1266 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1267 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1269 g_static_mutex_unlock (&__dbg_functions_mutex);
1272 /*** PRINTF EXTENSIONS ********************************************************/
1274 #ifdef HAVE_PRINTF_EXTENSION
1276 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1277 const void *const *args)
1284 ptr = *(void **) args[0];
1286 buffer = gst_debug_print_object (ptr);
1287 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1295 _gst_info_printf_extension_segment (FILE * stream,
1296 const struct printf_info *info, const void *const *args)
1303 ptr = *(void **) args[0];
1305 buffer = gst_debug_print_segment (ptr);
1306 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1314 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1318 argtypes[0] = PA_POINTER;
1321 #endif /* HAVE_PRINTF_EXTENSION */
1323 #else /* !GST_DISABLE_GST_DEBUG */
1325 gst_debug_remove_log_function (GstLogFunction func)
1331 gst_debug_remove_log_function_by_data (gpointer data)
1337 __gst_in_valgrind (void)
1342 #endif /* GST_DISABLE_GST_DEBUG */
1345 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1346 /* FIXME make this thread specific */
1347 static GSList *stack_trace = NULL;
1350 __cyg_profile_func_enter (void *this_fn, void *call_site)
1351 G_GNUC_NO_INSTRUMENT;
1352 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1354 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1355 gchar *site = _gst_debug_nameof_funcptr (call_site);
1357 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1360 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1361 this_fn, name, call_site, site));
1368 __cyg_profile_func_exit (void *this_fn, void *call_site)
1369 G_GNUC_NO_INSTRUMENT;
1370 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1372 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1374 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1375 g_free (stack_trace->data);
1376 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1382 * gst_debug_print_stack_trace:
1384 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1385 * gstreamer code, which can be printed with this function.
1388 gst_debug_print_stack_trace (void)
1390 GSList *walk = stack_trace;
1394 walk = g_slist_next (walk);
1397 gchar *name = (gchar *) walk->data;
1399 g_print ("#%-2d %s\n", count++, name);
1401 walk = g_slist_next (walk);
1406 gst_debug_print_stack_trace (void)
1408 /* nothing because it's compiled out */
1411 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */