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 facillities
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 (my_category); // define category
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: unnoticable)
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 */
107 #include "gst_private.h"
108 #include "gstutils.h"
110 # include <valgrind/valgrind.h>
112 #include <glib/gprintf.h> /* g_sprintf */
114 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
115 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
116 /* time of initialization, so we get useful debugging output times */
117 static GstClockTime start_time;
121 #include <rld_interface.h>
122 typedef struct DL_INFO
124 const char *dli_fname;
126 const char *dli_sname;
130 long dli_reserved[4];
134 #define _RLD_DLADDR 14
135 int dladdr (void *address, Dl_info * dl);
138 dladdr (void *address, Dl_info * dl)
142 v = _rld_new_interface (_RLD_DLADDR, address, dl);
148 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
149 static void gst_debug_reset_all_thresholds (void);
151 #ifdef HAVE_PRINTF_EXTENSION
152 static int _gst_info_printf_extension (FILE * stream,
153 const struct printf_info *info, const void *const *args);
154 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
155 size_t n, int *argtypes);
158 struct _GstDebugMessage
165 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
166 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
167 static GSList *__level_name = NULL;
175 /* list of all categories */
176 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
177 static GSList *__categories = NULL;
179 /* all registered debug handlers */
186 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
187 static GSList *__log_functions = NULL;
189 static gint __default_level;
190 static gint __use_color;
192 /* enabled by default */
193 gboolean __gst_debug_enabled = TRUE;
196 GstDebugCategory *GST_CAT_DEFAULT = NULL;
198 GstDebugCategory *GST_CAT_GST_INIT = NULL;
199 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
200 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
201 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
202 GstDebugCategory *GST_CAT_STATES = NULL;
203 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
205 GstDebugCategory *GST_CAT_BUFFER = NULL;
206 GstDebugCategory *GST_CAT_BUS = NULL;
207 GstDebugCategory *GST_CAT_CAPS = NULL;
208 GstDebugCategory *GST_CAT_CLOCK = NULL;
209 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
210 GstDebugCategory *GST_CAT_PADS = NULL;
211 GstDebugCategory *GST_CAT_PIPELINE = NULL;
212 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
213 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
214 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
215 GstDebugCategory *GST_CAT_TYPES = NULL;
216 GstDebugCategory *GST_CAT_XML = NULL;
217 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
218 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
219 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
220 GstDebugCategory *GST_CAT_EVENT = NULL;
221 GstDebugCategory *GST_CAT_MESSAGE = NULL;
222 GstDebugCategory *GST_CAT_PARAMS = NULL;
223 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
224 GstDebugCategory *GST_CAT_SIGNAL = NULL;
225 GstDebugCategory *GST_CAT_PROBE = NULL;
226 GstDebugCategory *GST_CAT_REGISTRY = NULL;
227 GstDebugCategory *GST_CAT_QOS = NULL;
229 /* FIXME: export this? */
231 __gst_in_valgrind (void)
239 in_valgrind = GST_VG_UNCHECKED;
241 if (in_valgrind == GST_VG_UNCHECKED) {
243 if (RUNNING_ON_VALGRIND) {
244 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
246 ("GStreamer has detected that it is running inside valgrind.");
248 ("It might now take different code paths to ease debugging.");
249 VALGRIND_PRINTF ("Of course, this may also lead to different bugs.");
250 in_valgrind = GST_VG_INSIDE;
252 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
253 in_valgrind = GST_VG_NO_VALGRIND;
256 in_valgrind = GST_VG_NO_VALGRIND;
258 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
259 in_valgrind == GST_VG_INSIDE);
261 return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
267 * Initializes the debugging system.
268 * Normally you don't want to call this, because gst_init() does it for you.
271 _gst_debug_init (void)
275 gst_atomic_int_set (&__default_level, GST_LEVEL_DEFAULT);
276 gst_atomic_int_set (&__use_color, 1);
278 /* get time we started for debugging messages */
279 g_get_current_time (¤t);
280 start_time = GST_TIMEVAL_TO_TIME (current);
282 #ifdef HAVE_PRINTF_EXTENSION
283 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension,
284 _gst_info_printf_extension_arginfo);
287 /* do NOT use a single debug function before this line has been run */
288 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
289 GST_DEBUG_UNDERLINE, NULL);
290 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
291 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
293 gst_debug_add_log_function (gst_debug_log_default, NULL);
295 /* FIXME: add descriptions here */
296 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
297 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
298 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
299 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
300 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
301 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
302 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
303 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
304 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
305 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
306 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
307 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
308 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
309 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
310 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
311 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
312 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
313 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
314 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
315 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
316 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
317 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
318 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
319 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
320 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
321 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
322 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
323 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
324 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
325 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
326 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
327 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
328 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
329 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
330 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
331 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
332 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
333 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
334 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
335 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
336 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
338 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
339 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
340 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
341 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
342 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
343 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
344 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
345 GST_DEBUG_BOLD, NULL);
346 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
347 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
348 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
349 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
350 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
351 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
354 /* print out the valgrind message if we're in valgrind */
355 __gst_in_valgrind ();
358 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
359 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
363 * @category: category to log
364 * @level: level of the message is in
365 * @file: the file that emitted the message, usually the __FILE__ identifier
366 * @function: the function that emitted the message
367 * @line: the line from that the message was emitted, usually __LINE__
368 * @object: the object this message relates to or NULL if none
369 * @format: a printf style format string
370 * @...: optional arguments for the format
372 * Logs the given message using the currently registered debugging handlers.
375 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
376 const gchar * file, const gchar * function, gint line,
377 GObject * object, const gchar * format, ...)
381 va_start (var_args, format);
382 gst_debug_log_valist (category, level, file, function, line, object, format,
388 * gst_debug_log_valist:
389 * @category: category to log
390 * @level: level of the message is in
391 * @file: the file that emitted the message, usually the __FILE__ identifier
392 * @function: the function that emitted the message
393 * @line: the line from that the message was emitted, usually __LINE__
394 * @object: the object this message relates to or NULL if none
395 * @format: a printf style format string
396 * @args: optional arguments for the format
398 * Logs the given message using the currently registered debugging handlers.
401 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
402 const gchar * file, const gchar * function, gint line,
403 GObject * object, const gchar * format, va_list args)
405 GstDebugMessage message;
409 g_return_if_fail (category != NULL);
410 g_return_if_fail (file != NULL);
411 g_return_if_fail (function != NULL);
412 g_return_if_fail (format != NULL);
414 message.message = NULL;
415 message.format = format;
416 G_VA_COPY (message.arguments, args);
418 handler = __log_functions;
420 entry = handler->data;
421 handler = g_slist_next (handler);
422 entry->func (category, level, file, function, line, object, &message,
425 g_free (message.message);
426 va_end (message.arguments);
430 * gst_debug_message_get:
431 * @message: a debug message
433 * Gets the string representation of a #GstDebugMessage. This function is used
434 * in debug handlers to extract the message.
436 * Returns: the string representation of a #GstDebugMessage.
439 gst_debug_message_get (GstDebugMessage * message)
441 if (message->message == NULL) {
442 message->message = g_strdup_vprintf (message->format, message->arguments);
444 return message->message;
449 gst_debug_print_object (gpointer ptr)
451 GObject *object = (GObject *) ptr;
454 /* This is a cute trick to detect unmapped memory, but is unportable,
455 * slow, screws around with madvise, and not actually that useful. */
459 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
460 if (ret == -1 && errno == ENOMEM) {
461 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
466 /* nicely printed object */
467 if (object == NULL) {
468 return g_strdup ("(NULL)");
470 if (*(GType *) ptr == GST_TYPE_CAPS) {
471 return gst_caps_to_string ((GstCaps *) ptr);
473 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
474 return gst_structure_to_string ((GstStructure *) ptr);
477 if (*(guint32 *) ptr == 0xffffffff) {
478 return g_strdup_printf ("<poisoned@%p>", ptr);
481 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
482 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
484 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
485 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
487 if (G_IS_OBJECT (object)) {
488 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
491 return g_strdup_printf ("%p", ptr);
495 * gst_debug_construct_term_color:
496 * @colorinfo: the color info
498 * Constructs a string that can be used for getting the desired color in color
500 * You need to free the string after use.
502 * Returns: a string containing the color definition
505 gst_debug_construct_term_color (guint colorinfo)
510 color = g_string_new ("\033[00");
512 if (colorinfo & GST_DEBUG_BOLD) {
513 g_string_append (color, ";01");
515 if (colorinfo & GST_DEBUG_UNDERLINE) {
516 g_string_append (color, ";04");
518 if (colorinfo & GST_DEBUG_FG_MASK) {
519 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
521 if (colorinfo & GST_DEBUG_BG_MASK) {
522 g_string_append_printf (color, ";4%1d",
523 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
525 g_string_append (color, "m");
528 g_string_free (color, FALSE);
533 * gst_debug_log_default:
534 * @category: category to log
535 * @level: level of the message
536 * @file: the file that emitted the message, usually the __FILE__ identifier
537 * @function: the function that emitted the message
538 * @line: the line from that the message was emitted, usually __LINE__
539 * @message: the actual message
540 * @object: the object this message relates to or NULL if none
541 * @unused: an unused variable, reserved for some user_data.
543 * The default logging handler used by GStreamer. Logging functions get called
544 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
545 * message and additional info using the glib error handler.
546 * You can add other handlers by using gst_debug_add_log_function().
547 * And you can remove this handler by calling
548 * gst_debug_remove_log_function(gst_debug_log_default);
551 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
552 const gchar * file, const gchar * function, gint line,
553 GObject * object, GstDebugMessage * message, gpointer unused)
561 GstClockTime elapsed;
562 gboolean free_color = TRUE;
563 gboolean free_obj = TRUE;
565 if (level > gst_debug_category_get_threshold (category))
571 if (gst_debug_is_colored ()) {
572 color = gst_debug_construct_term_color (gst_debug_category_get_color
575 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
584 obj = gst_debug_print_object (object);
590 g_get_current_time (&now);
591 elapsed = GST_TIMEVAL_TO_TIME (now) - start_time;
592 g_printerr ("%s (%p - %" GST_TIME_FORMAT
593 ") %s%20s%s(%s%5d%s) %s%s(%d):%s:%s%s %s\n",
594 gst_debug_level_get_name (level), g_thread_self (),
595 GST_TIME_ARGS (elapsed), color,
596 gst_debug_category_get_name (category), clear, pidcolor, pid, clear,
597 color, file, line, function, obj, clear, gst_debug_message_get (message));
606 * gst_debug_level_get_name:
607 * @level: the level to get the name for
609 * Get the string trepresentation of a debugging level
614 gst_debug_level_get_name (GstDebugLevel level)
619 case GST_LEVEL_ERROR:
621 case GST_LEVEL_WARNING:
625 case GST_LEVEL_DEBUG:
630 g_warning ("invalid level specified for gst_debug_level_get_name");
636 * gst_debug_add_log_function:
637 * @func: the function to use
640 * Adds the logging function to the list of logging functions.
641 * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
644 gst_debug_add_log_function (GstLogFunction func, gpointer data)
649 g_return_if_fail (func != NULL);
651 entry = g_new (LogFuncEntry, 1);
653 entry->user_data = data;
654 /* FIXME: we leak the old list here - other threads might access it right now
655 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
656 * but that is waaay costly.
657 * It'd probably be clever to use some kind of RCU here, but I don't know
658 * anything about that.
660 g_static_mutex_lock (&__log_func_mutex);
661 list = g_slist_copy (__log_functions);
662 __log_functions = g_slist_prepend (list, entry);
663 g_static_mutex_unlock (&__log_func_mutex);
665 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
670 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
672 gpointer entryfunc = ((LogFuncEntry *) entry)->func;
674 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
678 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
680 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
682 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
686 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
692 g_static_mutex_lock (&__log_func_mutex);
693 new = __log_functions;
694 while ((found = g_slist_find_custom (new, data, func))) {
695 if (new == __log_functions) {
696 new = g_slist_copy (new);
699 g_free (found->data);
700 new = g_slist_delete_link (new, found);
703 /* FIXME: We leak the old list here. See _add_log_function for why. */
704 __log_functions = new;
705 g_static_mutex_unlock (&__log_func_mutex);
711 * gst_debug_remove_log_function:
712 * @func: the log function to remove
714 * Removes all registrered instances of the given logging functions.
716 * Returns: How many instances of the function were removed
719 gst_debug_remove_log_function (GstLogFunction func)
723 g_return_val_if_fail (func != NULL, 0);
726 gst_debug_remove_with_compare_func
727 (gst_debug_compare_log_function_by_func, func);
728 GST_DEBUG ("removed log function %p %d times from log function list", func,
735 * gst_debug_remove_log_function_by_data:
736 * @data: user data of the log function to remove
738 * Removes all registrered instances of log functions with the given user data.
740 * Returns: How many instances of the function were removed
743 gst_debug_remove_log_function_by_data (gpointer data)
748 gst_debug_remove_with_compare_func
749 (gst_debug_compare_log_function_by_data, data);
751 ("removed %d log functions with user data %p from log function list",
758 * gst_debug_set_colored:
759 * @colored: Whether to use colored output or not
761 * Sets or unsets the use of coloured debugging output.
764 gst_debug_set_colored (gboolean colored)
766 gst_atomic_int_set (&__use_color, colored ? 1 : 0);
770 * gst_debug_is_colored:
772 * Checks if the debugging output should be colored.
774 * Returns: TRUE, if the debug output should be colored.
777 gst_debug_is_colored (void)
779 return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
783 * gst_debug_set_active:
784 * @active: Whether to use debugging output or not
786 * If activated, debugging messages are sent to the debugging
788 * It makes sense to deactivate it for speed issues.
789 * <note><para>This function is not threadsafe. It makes sense to only call it
790 * during initialization.</para></note>
793 gst_debug_set_active (gboolean active)
795 __gst_debug_enabled = active;
799 * gst_debug_is_active:
801 * Checks if debugging output is activated.
803 * Returns: TRUE, if debugging is activated
806 gst_debug_is_active (void)
808 return __gst_debug_enabled;
812 * gst_debug_set_default_threshold:
813 * @level: level to set
815 * Sets the default threshold to the given level and updates all categories to
816 * use this threshold.
819 gst_debug_set_default_threshold (GstDebugLevel level)
821 gst_atomic_int_set (&__default_level, level);
822 gst_debug_reset_all_thresholds ();
826 * gst_debug_get_default_threshold:
828 * Returns the default threshold that is used for new categories.
830 * Returns: the default threshold level
833 gst_debug_get_default_threshold (void)
835 return (GstDebugLevel) g_atomic_int_get (&__default_level);
838 gst_debug_reset_threshold (gpointer category, gpointer unused)
840 GstDebugCategory *cat = (GstDebugCategory *) category;
843 g_static_mutex_lock (&__level_name_mutex);
846 LevelNameEntry *entry = walk->data;
848 walk = g_slist_next (walk);
849 if (g_pattern_match_string (entry->pat, cat->name)) {
850 GST_LOG ("category %s matches pattern %p - gets set to level %d",
851 cat->name, entry->pat, entry->level);
852 gst_debug_category_set_threshold (cat, entry->level);
856 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
859 g_static_mutex_unlock (&__level_name_mutex);
862 gst_debug_reset_all_thresholds (void)
864 g_static_mutex_lock (&__cat_mutex);
865 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
866 g_static_mutex_unlock (&__cat_mutex);
869 for_each_threshold_by_entry (gpointer data, gpointer user_data)
871 GstDebugCategory *cat = (GstDebugCategory *) data;
872 LevelNameEntry *entry = (LevelNameEntry *) user_data;
874 if (g_pattern_match_string (entry->pat, cat->name)) {
875 GST_LOG ("category %s matches pattern %p - gets set to level %d",
876 cat->name, entry->pat, entry->level);
877 gst_debug_category_set_threshold (cat, entry->level);
882 * gst_debug_set_threshold_for_name:
883 * @name: name of the categories to set
884 * @level: level to set them to
886 * Sets all categories which match the given glob style pattern to the given
890 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
893 LevelNameEntry *entry;
895 g_return_if_fail (name != NULL);
897 pat = g_pattern_spec_new (name);
898 entry = g_new (LevelNameEntry, 1);
900 entry->level = level;
901 g_static_mutex_lock (&__level_name_mutex);
902 __level_name = g_slist_prepend (__level_name, entry);
903 g_static_mutex_unlock (&__level_name_mutex);
904 g_static_mutex_lock (&__cat_mutex);
905 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
906 g_static_mutex_unlock (&__cat_mutex);
910 * gst_debug_unset_threshold_for_name:
911 * @name: name of the categories to set
913 * Resets all categories with the given name back to the default level.
916 gst_debug_unset_threshold_for_name (const gchar * name)
921 g_return_if_fail (name != NULL);
923 pat = g_pattern_spec_new (name);
924 g_static_mutex_lock (&__level_name_mutex);
926 /* improve this if you want, it's mighty slow */
928 LevelNameEntry *entry = walk->data;
930 if (g_pattern_spec_equal (entry->pat, pat)) {
931 __level_name = g_slist_remove_link (__level_name, walk);
932 g_pattern_spec_free (entry->pat);
934 g_slist_free_1 (walk);
938 g_static_mutex_unlock (&__level_name_mutex);
939 g_pattern_spec_free (pat);
940 gst_debug_reset_all_thresholds ();
944 _gst_debug_category_new (gchar * name, guint color, gchar * description)
946 GstDebugCategory *cat;
948 g_return_val_if_fail (name != NULL, NULL);
950 cat = g_new (GstDebugCategory, 1);
951 cat->name = g_strdup (name);
953 if (description != NULL) {
954 cat->description = g_strdup (description);
956 cat->description = g_strdup ("no description");
958 gst_atomic_int_set (&cat->threshold, 0);
959 gst_debug_reset_threshold (cat, NULL);
961 /* add to category list */
962 g_static_mutex_lock (&__cat_mutex);
963 __categories = g_slist_prepend (__categories, cat);
964 g_static_mutex_unlock (&__cat_mutex);
970 * gst_debug_category_free:
971 * @category: #GstDebugCategory to free.
973 * Removes and frees the category and all associated resources.
976 gst_debug_category_free (GstDebugCategory * category)
978 if (category == NULL)
981 /* remove from category list */
982 g_static_mutex_lock (&__cat_mutex);
983 __categories = g_slist_remove (__categories, category);
984 g_static_mutex_unlock (&__cat_mutex);
986 g_free ((gpointer) category->name);
987 g_free ((gpointer) category->description);
992 * gst_debug_category_set_threshold:
993 * @category: a #GstDebugCategory to set threshold of.
994 * @level: the #GstDebugLevel threshold to set.
996 * Sets the threshold of the category to the given level. Debug information will
997 * only be output if the threshold is lower or equal to the level of the
1000 * Do not use this function in production code, because other functions may
1001 * change the threshold of categories as side effect. It is however a nice
1002 * function to use when debugging (even from gdb).
1006 gst_debug_category_set_threshold (GstDebugCategory * category,
1007 GstDebugLevel level)
1009 g_return_if_fail (category != NULL);
1011 gst_atomic_int_set (&category->threshold, level);
1015 * gst_debug_category_reset_threshold:
1016 * @category: a #GstDebugCategory to reset threshold of.
1018 * Resets the threshold of the category to the default level. Debug information
1019 * will only be output if the threshold is lower or equal to the level of the
1020 * debugging message.
1021 * Use this function to set the threshold back to where it was after using
1022 * gst_debug_category_set_threshold().
1025 gst_debug_category_reset_threshold (GstDebugCategory * category)
1027 gst_debug_reset_threshold (category, NULL);
1031 * gst_debug_category_get_threshold:
1032 * @category: a #GstDebugCategory to get threshold of.
1034 * Returns the threshold of a #GstCategory.
1036 * Returns: the #GstDebugLevel that is used as threshold.
1039 gst_debug_category_get_threshold (GstDebugCategory * category)
1041 return g_atomic_int_get (&category->threshold);
1045 * gst_debug_category_get_name:
1046 * @category: a #GstDebugCategory to get name of.
1048 * Returns the name of a debug category.
1050 * Returns: the name of the category.
1053 gst_debug_category_get_name (GstDebugCategory * category)
1055 return category->name;
1059 * gst_debug_category_get_color:
1060 * @category: a #GstDebugCategory to get the color of.
1062 * Returns the color of a debug category used when printing output in this
1065 * Returns: the color of the category.
1068 gst_debug_category_get_color (GstDebugCategory * category)
1070 return category->color;
1074 * gst_debug_category_get_description:
1075 * @category: a #GstDebugCategory to get the description of.
1077 * Returns the description of a debug category.
1079 * Returns: the description of the category.
1082 gst_debug_category_get_description (GstDebugCategory * category)
1084 return category->description;
1088 * gst_debug_get_all_categories:
1090 * Returns a snapshot of a all categories that are currently in use . This list
1091 * may change anytime.
1092 * The caller has to free the list after use.
1094 * Returns: the list of categories
1097 gst_debug_get_all_categories (void)
1101 g_static_mutex_lock (&__cat_mutex);
1102 ret = g_slist_copy (__categories);
1103 g_static_mutex_unlock (&__cat_mutex);
1108 /*** FUNCTION POINTERS ********************************************************/
1110 static GHashTable *__gst_function_pointers; /* NULL */
1111 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1114 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1115 G_GNUC_NO_INSTRUMENT;
1117 /* This function MUST NOT return NULL */
1118 const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1120 gpointer ptr = (gpointer) func;
1127 if (__gst_function_pointers) {
1128 g_static_mutex_lock (&__dbg_functions_mutex);
1129 ptrname = g_hash_table_lookup (__gst_function_pointers, ptr);
1130 g_static_mutex_unlock (&__dbg_functions_mutex);
1134 /* we need to create an entry in the hash table for this one so we don't leak
1137 if (dladdr (ptr, &dlinfo) && dlinfo.dli_sname) {
1138 gchar *name = g_strdup (dlinfo.dli_sname);
1140 _gst_debug_register_funcptr (ptr, name);
1145 gchar *name = g_strdup_printf ("%p", ptr);
1147 _gst_debug_register_funcptr (ptr, name);
1153 _gst_debug_register_funcptr (GstDebugFuncPtr func, gchar * ptrname)
1155 gpointer ptr = (gpointer) func;
1157 g_static_mutex_lock (&__dbg_functions_mutex);
1159 if (!__gst_function_pointers)
1160 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1161 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1162 g_hash_table_insert (__gst_function_pointers, ptr, ptrname);
1164 g_static_mutex_unlock (&__dbg_functions_mutex);
1167 #ifdef HAVE_PRINTF_EXTENSION
1169 _gst_info_printf_extension (FILE * stream, const struct printf_info *info,
1170 const void *const *args)
1177 ptr = *(void **) args[0];
1179 buffer = gst_debug_print_object (ptr);
1180 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1188 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1192 argtypes[0] = PA_POINTER;
1195 #endif /* HAVE_PRINTF_EXTENSION */
1197 #else /* !GST_DISABLE_GST_DEBUG */
1199 gst_debug_remove_log_function (GstLogFunction func)
1205 gst_debug_remove_log_function_by_data (gpointer data)
1211 __gst_in_valgrind (void)
1216 #endif /* GST_DISABLE_GST_DEBUG */
1219 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1220 /* FIXME make this thread specific */
1221 static GSList *stack_trace = NULL;
1224 __cyg_profile_func_enter (void *this_fn, void *call_site)
1225 G_GNUC_NO_INSTRUMENT;
1226 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1228 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1229 gchar *site = _gst_debug_nameof_funcptr (call_site);
1231 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1234 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1235 this_fn, name, call_site, site));
1242 __cyg_profile_func_exit (void *this_fn, void *call_site)
1243 G_GNUC_NO_INSTRUMENT;
1244 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1246 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1248 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1249 g_free (stack_trace->data);
1250 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1256 * gst_debug_print_stack_trace:
1258 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktracke is available for
1259 * gstreamer code, which can be printed with this function.
1262 gst_debug_print_stack_trace (void)
1264 GSList *walk = stack_trace;
1268 walk = g_slist_next (walk);
1271 gchar *name = (gchar *) walk->data;
1273 g_print ("#%-2d %s\n", count++, name);
1275 walk = g_slist_next (walk);
1280 gst_debug_print_stack_trace (void)
1282 /* nothing because it's compiled out */
1285 #endif /* GST_ENABLE_FUNC_INTSTRUMENTATION */