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_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: 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"
109 #include "gstsegment.h"
111 # include <valgrind/valgrind.h>
113 #include <glib/gprintf.h> /* g_sprintf */
115 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
116 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
117 /* time of initialization, so we get useful debugging output times */
118 static GstClockTime start_time;
122 #include <rld_interface.h>
123 typedef struct DL_INFO
125 const char *dli_fname;
127 const char *dli_sname;
131 long dli_reserved[4];
135 #define _RLD_DLADDR 14
136 int dladdr (void *address, Dl_info * dl);
139 dladdr (void *address, Dl_info * dl)
143 v = _rld_new_interface (_RLD_DLADDR, address, dl);
149 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
150 static void gst_debug_reset_all_thresholds (void);
152 #ifdef HAVE_PRINTF_EXTENSION
153 static int _gst_info_printf_extension_ptr (FILE * stream,
154 const struct printf_info *info, const void *const *args);
155 static int _gst_info_printf_extension_segment (FILE * stream,
156 const struct printf_info *info, const void *const *args);
157 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
158 size_t n, int *argtypes);
161 struct _GstDebugMessage
168 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
169 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
170 static GSList *__level_name = NULL;
178 /* list of all categories */
179 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
180 static GSList *__categories = NULL;
182 /* all registered debug handlers */
189 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
190 static GSList *__log_functions = NULL;
192 static gint __default_level;
193 static gint __use_color;
195 /* disabled by default, as soon as some threshold is set > NONE,
196 * it becomes enabled. */
197 gboolean __gst_debug_enabled = FALSE;
198 GstDebugLevel __gst_debug_min = GST_LEVEL_NONE;
200 GstDebugCategory *GST_CAT_DEFAULT = NULL;
202 GstDebugCategory *GST_CAT_GST_INIT = NULL;
203 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
204 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
205 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
206 GstDebugCategory *GST_CAT_STATES = NULL;
207 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
209 GstDebugCategory *GST_CAT_BUFFER = NULL;
210 GstDebugCategory *GST_CAT_BUS = NULL;
211 GstDebugCategory *GST_CAT_CAPS = NULL;
212 GstDebugCategory *GST_CAT_CLOCK = NULL;
213 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
214 GstDebugCategory *GST_CAT_PADS = NULL;
215 GstDebugCategory *GST_CAT_PIPELINE = NULL;
216 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
217 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
218 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
219 GstDebugCategory *GST_CAT_TYPES = NULL;
220 GstDebugCategory *GST_CAT_XML = NULL;
221 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
222 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
223 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
224 GstDebugCategory *GST_CAT_EVENT = NULL;
225 GstDebugCategory *GST_CAT_MESSAGE = NULL;
226 GstDebugCategory *GST_CAT_PARAMS = NULL;
227 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
228 GstDebugCategory *GST_CAT_SIGNAL = NULL;
229 GstDebugCategory *GST_CAT_PROBE = NULL;
230 GstDebugCategory *GST_CAT_REGISTRY = NULL;
231 GstDebugCategory *GST_CAT_QOS = NULL;
233 /* FIXME: export this? */
235 __gst_in_valgrind (void)
243 in_valgrind = GST_VG_UNCHECKED;
245 if (in_valgrind == GST_VG_UNCHECKED) {
247 if (RUNNING_ON_VALGRIND) {
248 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
249 printf ("GStreamer has detected that it is running inside valgrind.\n");
250 printf ("It might now take different code paths to ease debugging.\n");
251 printf ("Of course, this may also lead to different bugs.\n");
252 in_valgrind = GST_VG_INSIDE;
254 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
255 in_valgrind = GST_VG_NO_VALGRIND;
258 in_valgrind = GST_VG_NO_VALGRIND;
260 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
261 in_valgrind == GST_VG_INSIDE);
263 return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
269 * Initializes the debugging system.
270 * Normally you don't want to call this, because gst_init() does it for you.
273 _gst_debug_init (void)
277 gst_atomic_int_set (&__default_level, GST_LEVEL_DEFAULT);
278 gst_atomic_int_set (&__use_color, 1);
280 /* get time we started for debugging messages */
281 g_get_current_time (¤t);
282 start_time = GST_TIMEVAL_TO_TIME (current);
284 #ifdef HAVE_PRINTF_EXTENSION
285 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
286 _gst_info_printf_extension_arginfo);
287 register_printf_function (GST_SEGMENT_FORMAT[0],
288 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
291 /* do NOT use a single debug function before this line has been run */
292 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
293 GST_DEBUG_UNDERLINE, NULL);
294 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
295 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
297 gst_debug_add_log_function (gst_debug_log_default, NULL);
299 /* FIXME: add descriptions here */
300 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
301 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
302 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
303 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
304 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
305 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
306 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
307 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
308 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
309 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
310 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
311 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
312 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
313 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
314 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
315 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
316 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
317 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
318 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
319 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
320 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
321 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
322 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
323 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
324 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
325 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
326 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
327 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
328 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
329 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
330 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
331 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
332 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
333 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
334 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
335 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
336 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
337 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
338 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
339 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
340 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
342 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
343 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
344 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
345 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
346 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
347 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
348 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
349 GST_DEBUG_BOLD, NULL);
350 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
351 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
352 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
353 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
354 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
355 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
358 /* print out the valgrind message if we're in valgrind */
359 __gst_in_valgrind ();
362 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
363 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
367 * @category: category to log
368 * @level: level of the message is in
369 * @file: the file that emitted the message, usually the __FILE__ identifier
370 * @function: the function that emitted the message
371 * @line: the line from that the message was emitted, usually __LINE__
372 * @object: the object this message relates to or NULL if none
373 * @format: a printf style format string
374 * @...: optional arguments for the format
376 * Logs the given message using the currently registered debugging handlers.
379 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
380 const gchar * file, const gchar * function, gint line,
381 GObject * object, const gchar * format, ...)
385 va_start (var_args, format);
386 gst_debug_log_valist (category, level, file, function, line, object, format,
392 * gst_debug_log_valist:
393 * @category: category to log
394 * @level: level of the message is in
395 * @file: the file that emitted the message, usually the __FILE__ identifier
396 * @function: the function that emitted the message
397 * @line: the line from that the message was emitted, usually __LINE__
398 * @object: the object this message relates to or NULL if none
399 * @format: a printf style format string
400 * @args: optional arguments for the format
402 * Logs the given message using the currently registered debugging handlers.
405 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
406 const gchar * file, const gchar * function, gint line,
407 GObject * object, const gchar * format, va_list args)
409 GstDebugMessage message;
413 g_return_if_fail (category != NULL);
414 g_return_if_fail (file != NULL);
415 g_return_if_fail (function != NULL);
416 g_return_if_fail (format != NULL);
418 message.message = NULL;
419 message.format = format;
420 G_VA_COPY (message.arguments, args);
422 handler = __log_functions;
424 entry = handler->data;
425 handler = g_slist_next (handler);
426 entry->func (category, level, file, function, line, object, &message,
429 g_free (message.message);
430 va_end (message.arguments);
434 * gst_debug_message_get:
435 * @message: a debug message
437 * Gets the string representation of a #GstDebugMessage. This function is used
438 * in debug handlers to extract the message.
440 * Returns: the string representation of a #GstDebugMessage.
443 gst_debug_message_get (GstDebugMessage * message)
445 if (message->message == NULL) {
446 message->message = g_strdup_vprintf (message->format, message->arguments);
448 return message->message;
453 gst_debug_print_object (gpointer ptr)
455 GObject *object = (GObject *) ptr;
458 /* This is a cute trick to detect unmapped memory, but is unportable,
459 * slow, screws around with madvise, and not actually that useful. */
463 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
464 if (ret == -1 && errno == ENOMEM) {
465 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
470 /* nicely printed object */
471 if (object == NULL) {
472 return g_strdup ("(NULL)");
474 if (*(GType *) ptr == GST_TYPE_CAPS) {
475 return gst_caps_to_string ((GstCaps *) ptr);
477 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
478 return gst_structure_to_string ((GstStructure *) ptr);
481 if (*(guint32 *) ptr == 0xffffffff) {
482 return g_strdup_printf ("<poisoned@%p>", ptr);
485 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
486 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
488 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
489 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
491 if (G_IS_OBJECT (object)) {
492 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
495 return g_strdup_printf ("%p", ptr);
499 gst_debug_print_segment (gpointer ptr)
501 GstSegment *segment = (GstSegment *) ptr;
503 /* nicely printed segment */
504 if (segment == NULL) {
505 return g_strdup ("(NULL)");
508 switch (segment->format) {
509 case GST_FORMAT_UNDEFINED:{
510 return g_strdup_printf ("UNDEFINED segment");
512 case GST_FORMAT_TIME:{
513 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
514 ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
515 ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
516 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
517 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
518 GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
519 segment->rate, segment->applied_rate, (guint) segment->flags,
520 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
523 const gchar *format_name;
525 format_name = gst_format_get_name (segment->format);
526 if (G_UNLIKELY (format_name == NULL))
527 format_name = "(UNKNOWN FORMAT)";
528 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
529 ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
530 ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
531 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
532 format_name, segment->start, segment->stop, segment->last_stop,
533 segment->duration, segment->rate, segment->applied_rate,
534 (guint) segment->flags, GST_TIME_ARGS (segment->time),
535 GST_TIME_ARGS (segment->accum));
541 * gst_debug_construct_term_color:
542 * @colorinfo: the color info
544 * Constructs a string that can be used for getting the desired color in color
546 * You need to free the string after use.
548 * Returns: a string containing the color definition
551 gst_debug_construct_term_color (guint colorinfo)
556 color = g_string_new ("\033[00");
558 if (colorinfo & GST_DEBUG_BOLD) {
559 g_string_append (color, ";01");
561 if (colorinfo & GST_DEBUG_UNDERLINE) {
562 g_string_append (color, ";04");
564 if (colorinfo & GST_DEBUG_FG_MASK) {
565 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
567 if (colorinfo & GST_DEBUG_BG_MASK) {
568 g_string_append_printf (color, ";4%1d",
569 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
571 g_string_append (color, "m");
574 g_string_free (color, FALSE);
579 * gst_debug_log_default:
580 * @category: category to log
581 * @level: level of the message
582 * @file: the file that emitted the message, usually the __FILE__ identifier
583 * @function: the function that emitted the message
584 * @line: the line from that the message was emitted, usually __LINE__
585 * @message: the actual message
586 * @object: the object this message relates to or NULL if none
587 * @unused: an unused variable, reserved for some user_data.
589 * The default logging handler used by GStreamer. Logging functions get called
590 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
591 * message and additional info using the glib error handler.
592 * You can add other handlers by using gst_debug_add_log_function().
593 * And you can remove this handler by calling
594 * gst_debug_remove_log_function(gst_debug_log_default);
597 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
598 const gchar * file, const gchar * function, gint line,
599 GObject * object, GstDebugMessage * message, gpointer unused)
607 GstClockTime elapsed;
608 gboolean free_color = TRUE;
609 gboolean free_obj = TRUE;
611 if (level > gst_debug_category_get_threshold (category))
617 if (gst_debug_is_colored ()) {
618 color = gst_debug_construct_term_color (gst_debug_category_get_color
621 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
630 obj = gst_debug_print_object (object);
636 g_get_current_time (&now);
637 elapsed = GST_TIMEVAL_TO_TIME (now) - start_time;
638 g_printerr ("%s (%p - %" GST_TIME_FORMAT
639 ") %s%20s%s(%s%5d%s) %s%s(%d):%s:%s%s %s\n",
640 gst_debug_level_get_name (level), g_thread_self (),
641 GST_TIME_ARGS (elapsed), color,
642 gst_debug_category_get_name (category), clear, pidcolor, pid, clear,
643 color, file, line, function, obj, clear, gst_debug_message_get (message));
652 * gst_debug_level_get_name:
653 * @level: the level to get the name for
655 * Get the string trepresentation of a debugging level
660 gst_debug_level_get_name (GstDebugLevel level)
665 case GST_LEVEL_ERROR:
667 case GST_LEVEL_WARNING:
671 case GST_LEVEL_DEBUG:
676 g_warning ("invalid level specified for gst_debug_level_get_name");
682 * gst_debug_add_log_function:
683 * @func: the function to use
686 * Adds the logging function to the list of logging functions.
687 * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
690 gst_debug_add_log_function (GstLogFunction func, gpointer data)
695 g_return_if_fail (func != NULL);
697 entry = g_new (LogFuncEntry, 1);
699 entry->user_data = data;
700 /* FIXME: we leak the old list here - other threads might access it right now
701 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
702 * but that is waaay costly.
703 * It'd probably be clever to use some kind of RCU here, but I don't know
704 * anything about that.
706 g_static_mutex_lock (&__log_func_mutex);
707 list = g_slist_copy (__log_functions);
708 __log_functions = g_slist_prepend (list, entry);
709 g_static_mutex_unlock (&__log_func_mutex);
711 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
716 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
718 gpointer entryfunc = ((LogFuncEntry *) entry)->func;
720 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
724 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
726 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
728 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
732 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
738 g_static_mutex_lock (&__log_func_mutex);
739 new = __log_functions;
740 while ((found = g_slist_find_custom (new, data, func))) {
741 if (new == __log_functions) {
742 new = g_slist_copy (new);
745 g_free (found->data);
746 new = g_slist_delete_link (new, found);
749 /* FIXME: We leak the old list here. See _add_log_function for why. */
750 __log_functions = new;
751 g_static_mutex_unlock (&__log_func_mutex);
757 * gst_debug_remove_log_function:
758 * @func: the log function to remove
760 * Removes all registrered instances of the given logging functions.
762 * Returns: How many instances of the function were removed
765 gst_debug_remove_log_function (GstLogFunction func)
769 g_return_val_if_fail (func != NULL, 0);
772 gst_debug_remove_with_compare_func
773 (gst_debug_compare_log_function_by_func, func);
774 GST_DEBUG ("removed log function %p %d times from log function list", func,
781 * gst_debug_remove_log_function_by_data:
782 * @data: user data of the log function to remove
784 * Removes all registrered instances of log functions with the given user data.
786 * Returns: How many instances of the function were removed
789 gst_debug_remove_log_function_by_data (gpointer data)
794 gst_debug_remove_with_compare_func
795 (gst_debug_compare_log_function_by_data, data);
797 ("removed %d log functions with user data %p from log function list",
804 * gst_debug_set_colored:
805 * @colored: Whether to use colored output or not
807 * Sets or unsets the use of coloured debugging output.
810 gst_debug_set_colored (gboolean colored)
812 gst_atomic_int_set (&__use_color, colored ? 1 : 0);
816 * gst_debug_is_colored:
818 * Checks if the debugging output should be colored.
820 * Returns: TRUE, if the debug output should be colored.
823 gst_debug_is_colored (void)
825 return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
829 * gst_debug_set_active:
830 * @active: Whether to use debugging output or not
832 * If activated, debugging messages are sent to the debugging
834 * It makes sense to deactivate it for speed issues.
835 * <note><para>This function is not threadsafe. It makes sense to only call it
836 * during initialization.</para></note>
839 gst_debug_set_active (gboolean active)
841 __gst_debug_enabled = active;
843 __gst_debug_min = GST_LEVEL_COUNT;
845 __gst_debug_min = GST_LEVEL_NONE;
849 * gst_debug_is_active:
851 * Checks if debugging output is activated.
853 * Returns: TRUE, if debugging is activated
856 gst_debug_is_active (void)
858 return __gst_debug_enabled;
862 * gst_debug_set_default_threshold:
863 * @level: level to set
865 * Sets the default threshold to the given level and updates all categories to
866 * use this threshold.
869 gst_debug_set_default_threshold (GstDebugLevel level)
871 gst_atomic_int_set (&__default_level, level);
872 gst_debug_reset_all_thresholds ();
876 * gst_debug_get_default_threshold:
878 * Returns the default threshold that is used for new categories.
880 * Returns: the default threshold level
883 gst_debug_get_default_threshold (void)
885 return (GstDebugLevel) g_atomic_int_get (&__default_level);
888 gst_debug_reset_threshold (gpointer category, gpointer unused)
890 GstDebugCategory *cat = (GstDebugCategory *) category;
893 g_static_mutex_lock (&__level_name_mutex);
896 LevelNameEntry *entry = walk->data;
898 walk = g_slist_next (walk);
899 if (g_pattern_match_string (entry->pat, cat->name)) {
900 GST_LOG ("category %s matches pattern %p - gets set to level %d",
901 cat->name, entry->pat, entry->level);
902 gst_debug_category_set_threshold (cat, entry->level);
906 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
909 g_static_mutex_unlock (&__level_name_mutex);
912 gst_debug_reset_all_thresholds (void)
914 g_static_mutex_lock (&__cat_mutex);
915 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
916 g_static_mutex_unlock (&__cat_mutex);
919 for_each_threshold_by_entry (gpointer data, gpointer user_data)
921 GstDebugCategory *cat = (GstDebugCategory *) data;
922 LevelNameEntry *entry = (LevelNameEntry *) user_data;
924 if (g_pattern_match_string (entry->pat, cat->name)) {
925 GST_LOG ("category %s matches pattern %p - gets set to level %d",
926 cat->name, entry->pat, entry->level);
927 gst_debug_category_set_threshold (cat, entry->level);
932 * gst_debug_set_threshold_for_name:
933 * @name: name of the categories to set
934 * @level: level to set them to
936 * Sets all categories which match the given glob style pattern to the given
940 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
943 LevelNameEntry *entry;
945 g_return_if_fail (name != NULL);
947 pat = g_pattern_spec_new (name);
948 entry = g_new (LevelNameEntry, 1);
950 entry->level = level;
951 g_static_mutex_lock (&__level_name_mutex);
952 __level_name = g_slist_prepend (__level_name, entry);
953 g_static_mutex_unlock (&__level_name_mutex);
954 g_static_mutex_lock (&__cat_mutex);
955 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
956 g_static_mutex_unlock (&__cat_mutex);
960 * gst_debug_unset_threshold_for_name:
961 * @name: name of the categories to set
963 * Resets all categories with the given name back to the default level.
966 gst_debug_unset_threshold_for_name (const gchar * name)
971 g_return_if_fail (name != NULL);
973 pat = g_pattern_spec_new (name);
974 g_static_mutex_lock (&__level_name_mutex);
976 /* improve this if you want, it's mighty slow */
978 LevelNameEntry *entry = walk->data;
980 if (g_pattern_spec_equal (entry->pat, pat)) {
981 __level_name = g_slist_remove_link (__level_name, walk);
982 g_pattern_spec_free (entry->pat);
984 g_slist_free_1 (walk);
988 g_static_mutex_unlock (&__level_name_mutex);
989 g_pattern_spec_free (pat);
990 gst_debug_reset_all_thresholds ();
994 _gst_debug_category_new (gchar * name, guint color, gchar * description)
996 GstDebugCategory *cat;
998 g_return_val_if_fail (name != NULL, NULL);
1000 cat = g_new (GstDebugCategory, 1);
1001 cat->name = g_strdup (name);
1003 if (description != NULL) {
1004 cat->description = g_strdup (description);
1006 cat->description = g_strdup ("no description");
1008 gst_atomic_int_set (&cat->threshold, 0);
1009 gst_debug_reset_threshold (cat, NULL);
1011 /* add to category list */
1012 g_static_mutex_lock (&__cat_mutex);
1013 __categories = g_slist_prepend (__categories, cat);
1014 g_static_mutex_unlock (&__cat_mutex);
1020 * gst_debug_category_free:
1021 * @category: #GstDebugCategory to free.
1023 * Removes and frees the category and all associated resources.
1026 gst_debug_category_free (GstDebugCategory * category)
1028 if (category == NULL)
1031 /* remove from category list */
1032 g_static_mutex_lock (&__cat_mutex);
1033 __categories = g_slist_remove (__categories, category);
1034 g_static_mutex_unlock (&__cat_mutex);
1036 g_free ((gpointer) category->name);
1037 g_free ((gpointer) category->description);
1042 * gst_debug_category_set_threshold:
1043 * @category: a #GstDebugCategory to set threshold of.
1044 * @level: the #GstDebugLevel threshold to set.
1046 * Sets the threshold of the category to the given level. Debug information will
1047 * only be output if the threshold is lower or equal to the level of the
1048 * debugging message.
1050 * Do not use this function in production code, because other functions may
1051 * change the threshold of categories as side effect. It is however a nice
1052 * function to use when debugging (even from gdb).
1056 gst_debug_category_set_threshold (GstDebugCategory * category,
1057 GstDebugLevel level)
1059 g_return_if_fail (category != NULL);
1061 if (level > __gst_debug_min) {
1062 __gst_debug_enabled = TRUE;
1063 __gst_debug_min = level;
1066 gst_atomic_int_set (&category->threshold, level);
1070 * gst_debug_category_reset_threshold:
1071 * @category: a #GstDebugCategory to reset threshold of.
1073 * Resets the threshold of the category to the default level. Debug information
1074 * will only be output if the threshold is lower or equal to the level of the
1075 * debugging message.
1076 * Use this function to set the threshold back to where it was after using
1077 * gst_debug_category_set_threshold().
1080 gst_debug_category_reset_threshold (GstDebugCategory * category)
1082 gst_debug_reset_threshold (category, NULL);
1086 * gst_debug_category_get_threshold:
1087 * @category: a #GstDebugCategory to get threshold of.
1089 * Returns the threshold of a #GstCategory.
1091 * Returns: the #GstDebugLevel that is used as threshold.
1094 gst_debug_category_get_threshold (GstDebugCategory * category)
1096 return g_atomic_int_get (&category->threshold);
1100 * gst_debug_category_get_name:
1101 * @category: a #GstDebugCategory to get name of.
1103 * Returns the name of a debug category.
1105 * Returns: the name of the category.
1108 gst_debug_category_get_name (GstDebugCategory * category)
1110 return category->name;
1114 * gst_debug_category_get_color:
1115 * @category: a #GstDebugCategory to get the color of.
1117 * Returns the color of a debug category used when printing output in this
1120 * Returns: the color of the category.
1123 gst_debug_category_get_color (GstDebugCategory * category)
1125 return category->color;
1129 * gst_debug_category_get_description:
1130 * @category: a #GstDebugCategory to get the description of.
1132 * Returns the description of a debug category.
1134 * Returns: the description of the category.
1137 gst_debug_category_get_description (GstDebugCategory * category)
1139 return category->description;
1143 * gst_debug_get_all_categories:
1145 * Returns a snapshot of a all categories that are currently in use . This list
1146 * may change anytime.
1147 * The caller has to free the list after use.
1149 * Returns: the list of categories
1152 gst_debug_get_all_categories (void)
1156 g_static_mutex_lock (&__cat_mutex);
1157 ret = g_slist_copy (__categories);
1158 g_static_mutex_unlock (&__cat_mutex);
1163 /*** FUNCTION POINTERS ********************************************************/
1165 static GHashTable *__gst_function_pointers; /* NULL */
1166 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1169 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1170 G_GNUC_NO_INSTRUMENT;
1172 /* This function MUST NOT return NULL */
1173 const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1175 gpointer ptr = (gpointer) func;
1182 if (G_LIKELY (__gst_function_pointers)) {
1183 g_static_mutex_lock (&__dbg_functions_mutex);
1184 ptrname = g_hash_table_lookup (__gst_function_pointers, ptr);
1185 g_static_mutex_unlock (&__dbg_functions_mutex);
1186 if (G_LIKELY (ptrname))
1189 /* we need to create an entry in the hash table for this one so we don't leak
1192 if (dladdr (ptr, &dlinfo) && dlinfo.dli_sname) {
1193 gchar *name = g_strdup (dlinfo.dli_sname);
1195 _gst_debug_register_funcptr (ptr, name);
1200 gchar *name = g_strdup_printf ("%p", ptr);
1202 _gst_debug_register_funcptr (ptr, name);
1208 _gst_debug_register_funcptr (GstDebugFuncPtr func, gchar * ptrname)
1210 gpointer ptr = (gpointer) func;
1212 g_static_mutex_lock (&__dbg_functions_mutex);
1214 if (!__gst_function_pointers)
1215 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1216 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1217 g_hash_table_insert (__gst_function_pointers, ptr, ptrname);
1219 g_static_mutex_unlock (&__dbg_functions_mutex);
1222 #ifdef HAVE_PRINTF_EXTENSION
1224 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1225 const void *const *args)
1232 ptr = *(void **) args[0];
1234 buffer = gst_debug_print_object (ptr);
1235 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1243 _gst_info_printf_extension_segment (FILE * stream,
1244 const struct printf_info *info, const void *const *args)
1251 ptr = *(void **) args[0];
1253 buffer = gst_debug_print_segment (ptr);
1254 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1262 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1266 argtypes[0] = PA_POINTER;
1269 #endif /* HAVE_PRINTF_EXTENSION */
1271 #else /* !GST_DISABLE_GST_DEBUG */
1273 gst_debug_remove_log_function (GstLogFunction func)
1279 gst_debug_remove_log_function_by_data (gpointer data)
1285 __gst_in_valgrind (void)
1290 #endif /* GST_DISABLE_GST_DEBUG */
1293 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1294 /* FIXME make this thread specific */
1295 static GSList *stack_trace = NULL;
1298 __cyg_profile_func_enter (void *this_fn, void *call_site)
1299 G_GNUC_NO_INSTRUMENT;
1300 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1302 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1303 gchar *site = _gst_debug_nameof_funcptr (call_site);
1305 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1308 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1309 this_fn, name, call_site, site));
1316 __cyg_profile_func_exit (void *this_fn, void *call_site)
1317 G_GNUC_NO_INSTRUMENT;
1318 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1320 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1322 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1323 g_free (stack_trace->data);
1324 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1330 * gst_debug_print_stack_trace:
1332 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktracke is available for
1333 * gstreamer code, which can be printed with this function.
1336 gst_debug_print_stack_trace (void)
1338 GSList *walk = stack_trace;
1342 walk = g_slist_next (walk);
1345 gchar *name = (gchar *) walk->data;
1347 g_print ("#%-2d %s\n", count++, name);
1349 walk = g_slist_next (walk);
1354 gst_debug_print_stack_trace (void)
1356 /* nothing because it's compiled out */
1359 #endif /* GST_ENABLE_FUNC_INTSTRUMENTATION */