1 /* GStreamer
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>
5 *
6 * gstinfo.c: debugging functions
7 *
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.
12 *
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.
17 *
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.
22 */
24 /**
25 * SECTION:gstinfo
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.
29 *
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.
33 *
34 * The debugging subsystem works only after GStreamer has been initialized
35 * - for example by calling gst_init().
36 *
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
43 * messages to stderr.
44 *
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,
50 * declare
51 * the variables and set the default category.
52 * <informalexample>
53 * <programlisting>
54 * GST_DEBUG_CATEGORY (my_category); // define category
55 * &hash;define GST_CAT_DEFAULT my_category // set as default
56 * </programlisting>
57 * </informalexample>
58 * After that you only need to initialize the category.
59 * <informalexample>
60 * <programlisting>
61 * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
62 * 0, "This is my very own");
63 * </programlisting>
64 * </informalexample>
65 * Initialization must be done before the category is used first.
66 * Plugins do this
67 * in their plugin_init function, libraries and applications should do that
68 * during their initialization.
69 *
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
73 * and even structs described in this file evaluate to default values or
74 * nothing
75 * at all. So don't take addresses of these functions or use other tricks.
76 * If you must do that for some reason, there is still an option.
77 * If the debugging
78 * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
79 * <gst/gst.h>,
80 * so you can check that before doing your trick.
81 * Disabling the debugging subsystem will give you a slight (read: unnoticable)
82 * speed increase and will reduce the size of your compiled code. The GStreamer
83 * library itself becomes around 10% smaller.
84 *
85 * Please note that there are naming conventions for the names of debugging
86 * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
87 */
89 #include "gst_private.h"
90 #include "gstinfo.h"
92 #ifndef GST_DISABLE_GST_DEBUG
94 #ifdef HAVE_DLFCN_H
95 #include <dlfcn.h>
96 #endif
97 #ifdef HAVE_PRINTF_EXTENSION
98 #include <printf.h>
99 #endif
100 #include <stdio.h> /* fprintf */
101 #ifdef HAVE_UNISTD_H
102 #include <unistd.h>
103 #endif
104 #include <string.h> /* G_VA_COPY */
105 #include "gst_private.h"
106 #include "gstutils.h"
107 #ifdef HAVE_VALGRIND
108 #include <valgrind/valgrind.h>
109 #endif
110 #include <glib/gprintf.h> /* g_sprintf */
112 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
113 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
114 /* time of initialization, so we get useful debugging output times */
115 static GstClockTime start_time;
117 #if 0
118 #if defined __sgi__
119 #include <rld_interface.h>
120 typedef struct DL_INFO
121 {
122 const char *dli_fname;
123 void *dli_fbase;
124 const char *dli_sname;
125 void *dli_saddr;
126 int dli_version;
127 int dli_reserved1;
128 long dli_reserved[4];
129 }
130 Dl_info;
132 #define _RLD_DLADDR 14
133 int dladdr (void *address, Dl_info * dl);
135 int
136 dladdr (void *address, Dl_info * dl)
137 {
138 void *v;
140 v = _rld_new_interface (_RLD_DLADDR, address, dl);
141 return (int) v;
142 }
143 #endif /* __sgi__ */
144 #endif
146 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
147 static void gst_debug_reset_all_thresholds (void);
149 #ifdef HAVE_PRINTF_EXTENSION
150 static int _gst_info_printf_extension (FILE * stream,
151 const struct printf_info *info, const void *const *args);
152 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
153 size_t n, int *argtypes);
154 #endif
156 struct _GstDebugMessage
157 {
158 gchar *message;
159 const gchar *format;
160 va_list arguments;
161 };
163 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
164 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
165 static GSList *__level_name = NULL;
166 typedef struct
167 {
168 GPatternSpec *pat;
169 GstDebugLevel level;
170 }
171 LevelNameEntry;
173 /* list of all categories */
174 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
175 static GSList *__categories = NULL;
177 /* all registered debug handlers */
178 typedef struct
179 {
180 GstLogFunction func;
181 gpointer user_data;
182 }
183 LogFuncEntry;
184 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
185 static GSList *__log_functions = NULL;
187 static gint __default_level;
188 static gint __use_color;
189 gboolean __gst_debug_enabled = TRUE;
192 GstDebugCategory *GST_CAT_DEFAULT = NULL;
194 GstDebugCategory *GST_CAT_GST_INIT = NULL;
195 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
196 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
197 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
198 GstDebugCategory *GST_CAT_STATES = NULL;
199 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
201 GstDebugCategory *GST_CAT_BUFFER = NULL;
202 GstDebugCategory *GST_CAT_BUS = NULL;
203 GstDebugCategory *GST_CAT_CAPS = NULL;
204 GstDebugCategory *GST_CAT_CLOCK = NULL;
205 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
206 GstDebugCategory *GST_CAT_PADS = NULL;
207 GstDebugCategory *GST_CAT_PIPELINE = NULL;
208 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
209 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
210 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
211 GstDebugCategory *GST_CAT_THREAD = NULL;
212 GstDebugCategory *GST_CAT_TYPES = NULL;
213 GstDebugCategory *GST_CAT_XML = NULL;
214 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
215 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
216 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
217 GstDebugCategory *GST_CAT_EVENT = NULL;
218 GstDebugCategory *GST_CAT_MESSAGE = NULL;
219 GstDebugCategory *GST_CAT_PARAMS = NULL;
220 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
221 GstDebugCategory *GST_CAT_SIGNAL = NULL;
222 GstDebugCategory *GST_CAT_PROBE = NULL;
223 GstDebugCategory *GST_CAT_REGISTRY = NULL;
225 /* FIXME: export this? */
226 gboolean
227 __gst_in_valgrind (void)
228 {
229 static enum
230 {
231 GST_VG_UNCHECKED,
232 GST_VG_NO_VALGRIND,
233 GST_VG_INSIDE
234 }
235 in_valgrind = GST_VG_UNCHECKED;
237 if (in_valgrind == GST_VG_UNCHECKED) {
238 #ifdef HAVE_VALGRIND
239 if (RUNNING_ON_VALGRIND) {
240 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
241 VALGRIND_PRINTF
242 ("GStreamer has detected that it is running inside valgrind.");
243 VALGRIND_PRINTF
244 ("It might now take different code paths to ease debugging.");
245 VALGRIND_PRINTF ("Of course, this may also lead to different bugs.");
246 in_valgrind = GST_VG_INSIDE;
247 } else {
248 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
249 in_valgrind = GST_VG_NO_VALGRIND;
250 }
251 #else
252 in_valgrind = GST_VG_NO_VALGRIND;
253 #endif
254 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
255 in_valgrind == GST_VG_INSIDE);
256 }
257 return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
258 }
260 /**
261 * _gst_debug_init:
262 *
263 * Initializes the debugging system.
264 * Normally you don't want to call this, because gst_init does it for you.
265 */
266 void
267 _gst_debug_init (void)
268 {
269 GTimeVal current;
271 gst_atomic_int_set (&__default_level, GST_LEVEL_DEFAULT);
272 gst_atomic_int_set (&__use_color, 1);
274 /* get time we started for debugging messages */
275 g_get_current_time (¤t);
276 start_time = GST_TIMEVAL_TO_TIME (current);
278 #ifdef HAVE_PRINTF_EXTENSION
279 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension,
280 _gst_info_printf_extension_arginfo);
281 #endif
283 /* do NOT use a single debug function before this line has been run */
284 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
285 GST_DEBUG_UNDERLINE, NULL);
286 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
287 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
289 gst_debug_add_log_function (gst_debug_log_default, NULL);
291 /* FIXME: add descriptions here */
292 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
293 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
294 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
295 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
296 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
297 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
298 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
299 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
300 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
301 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
302 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
303 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
304 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
305 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
306 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
307 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
308 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
309 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
310 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
311 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
312 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
313 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
314 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
315 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
316 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
317 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
318 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
319 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
320 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
321 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
322 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
323 GST_CAT_THREAD = _gst_debug_category_new ("GST_THREAD",
324 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
325 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
326 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
327 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
328 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
329 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
330 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
331 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
332 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
333 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
334 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
336 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
337 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
338 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
339 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
340 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
341 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
342 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
343 GST_DEBUG_BOLD, NULL);
344 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
345 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
346 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
347 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
348 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
351 /* print out the valgrind message if we're in valgrind */
352 __gst_in_valgrind ();
353 }
355 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
356 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
358 /**
359 * gst_debug_log:
360 * @category: category to log
361 * @level: level of the message is in
362 * @file: the file that emitted the message, usually the __FILE__ identifier
363 * @function: the function that emitted the message
364 * @line: the line from that the message was emitted, usually __LINE__
365 * @object: the object this message relates to or NULL if none
366 * @format: a printf style format string
367 * @...: optional arguments for the format
368 *
369 * Logs the given message using the currently registered debugging handlers.
370 */
371 void
372 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
373 const gchar * file, const gchar * function, gint line,
374 GObject * object, const gchar * format, ...)
375 {
376 va_list var_args;
378 va_start (var_args, format);
379 gst_debug_log_valist (category, level, file, function, line, object, format,
380 var_args);
381 va_end (var_args);
382 }
384 /**
385 * gst_debug_log_valist:
386 * @category: category to log
387 * @level: level of the message is in
388 * @file: the file that emitted the message, usually the __FILE__ identifier
389 * @function: the function that emitted the message
390 * @line: the line from that the message was emitted, usually __LINE__
391 * @object: the object this message relates to or NULL if none
392 * @format: a printf style format string
393 * @args: optional arguments for the format
394 *
395 * Logs the given message using the currently registered debugging handlers.
396 */
397 void
398 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
399 const gchar * file, const gchar * function, gint line,
400 GObject * object, const gchar * format, va_list args)
401 {
402 GstDebugMessage message;
403 LogFuncEntry *entry;
404 GSList *handler;
406 g_return_if_fail (category != NULL);
407 g_return_if_fail (file != NULL);
408 g_return_if_fail (function != NULL);
409 g_return_if_fail (format != NULL);
411 message.message = NULL;
412 message.format = format;
413 G_VA_COPY (message.arguments, args);
415 handler = __log_functions;
416 while (handler) {
417 entry = handler->data;
418 handler = g_slist_next (handler);
419 entry->func (category, level, file, function, line, object, &message,
420 entry->user_data);
421 }
422 g_free (message.message);
423 va_end (message.arguments);
424 }
426 /**
427 * gst_debug_message_get:
428 * @message: a debug message
429 *
430 * Gets the string representation of a #GstDebugMessage. This function is used
431 * in debug handlers to extract the message.
432 *
433 * Returns: the string representation of a #GstDebugMessage.
434 */
435 const gchar *
436 gst_debug_message_get (GstDebugMessage * message)
437 {
438 if (message->message == NULL) {
439 message->message = g_strdup_vprintf (message->format, message->arguments);
440 }
441 return message->message;
442 }
445 static gchar *
446 gst_debug_print_object (gpointer ptr)
447 {
448 GObject *object = (GObject *) ptr;
450 #ifdef unused
451 /* This is a cute trick to detect unmapped memory, but is unportable,
452 * slow, screws around with madvise, and not actually that useful. */
453 {
454 int ret;
456 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
457 if (ret == -1 && errno == ENOMEM) {
458 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
459 }
460 }
461 #endif
463 /* nicely printed object */
464 if (object == NULL) {
465 return g_strdup ("(NULL)");
466 }
467 if (*(GType *) ptr == GST_TYPE_CAPS) {
468 return gst_caps_to_string ((GstCaps *) ptr);
469 }
470 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
471 return gst_structure_to_string ((GstStructure *) ptr);
472 }
473 #ifdef USE_POISONING
474 if (*(guint32 *) ptr == 0xffffffff) {
475 return g_strdup_printf ("<poisoned@%p>", ptr);
476 }
477 #endif
478 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
479 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
480 }
481 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
482 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
483 }
484 if (G_IS_OBJECT (object)) {
485 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
486 }
488 return g_strdup_printf ("%p", ptr);
489 }
491 /**
492 * gst_debug_construct_term_color:
493 * @colorinfo: the color info
494 *
495 * Constructs a string that can be used for getting the desired color in color
496 * terminals.
497 * You need to free the string after use.
498 *
499 * Returns: a string containing the color definition
500 */
501 gchar *
502 gst_debug_construct_term_color (guint colorinfo)
503 {
504 GString *color;
505 gchar *ret;
507 color = g_string_new ("\033[00");
509 if (colorinfo & GST_DEBUG_BOLD) {
510 g_string_append (color, ";01");
511 }
512 if (colorinfo & GST_DEBUG_UNDERLINE) {
513 g_string_append (color, ";04");
514 }
515 if (colorinfo & GST_DEBUG_FG_MASK) {
516 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
517 }
518 if (colorinfo & GST_DEBUG_BG_MASK) {
519 g_string_append_printf (color, ";4%1d",
520 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
521 }
522 g_string_append (color, "m");
524 ret = color->str;
525 g_string_free (color, FALSE);
526 return ret;
527 }
529 /**
530 * gst_debug_log_default:
531 * @category: category to log
532 * @level: level of the message
533 * @file: the file that emitted the message, usually the __FILE__ identifier
534 * @function: the function that emitted the message
535 * @line: the line from that the message was emitted, usually __LINE__
536 * @message: the actual message
537 * @object: the object this message relates to or NULL if none
538 * @unused: an unused variable, reserved for some user_data.
539 *
540 * The default logging handler used by GStreamer. Logging functions get called
541 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
542 * message and additional info using the glib error handler.
543 * You can add other handlers by using #gst_debug_add_log_function.
544 * And you can remove this handler by calling
545 * gst_debug_remove_log_function (gst_debug_log_default);
546 */
547 void
548 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
549 const gchar * file, const gchar * function, gint line,
550 GObject * object, GstDebugMessage * message, gpointer unused)
551 {
552 gchar *color = NULL;
553 gchar *clear;
554 gchar *obj = NULL;
555 gchar pidcolor[10];
556 gint pid;
557 GTimeVal now;
558 GstClockTime elapsed;
559 gboolean free_color = TRUE;
560 gboolean free_obj = TRUE;
562 if (level > gst_debug_category_get_threshold (category))
563 return;
565 pid = getpid ();
567 /* color info */
568 if (gst_debug_is_colored ()) {
569 color = gst_debug_construct_term_color (gst_debug_category_get_color
570 (category));
571 clear = "\033[00m";
572 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
573 } else {
574 color = "\0";
575 free_color = FALSE;
576 clear = "";
577 pidcolor[0] = '\0';
578 }
580 if (object) {
581 obj = gst_debug_print_object (object);
582 } else {
583 obj = "\0";
584 free_obj = FALSE;
585 }
587 g_get_current_time (&now);
588 elapsed = GST_TIMEVAL_TO_TIME (now) - start_time;
589 g_printerr ("%s (%p - %" GST_TIME_FORMAT
590 ") %s%20s%s(%s%5d%s) %s%s(%d):%s:%s%s %s\n",
591 gst_debug_level_get_name (level), g_thread_self (),
592 GST_TIME_ARGS (elapsed), color,
593 gst_debug_category_get_name (category), clear, pidcolor, pid, clear,
594 color, file, line, function, obj, clear, gst_debug_message_get (message));
596 if (free_color)
597 g_free (color);
598 if (free_obj)
599 g_free (obj);
600 }
602 /**
603 * gst_debug_level_get_name:
604 * @level: the level to get the name for
605 *
606 * Get the string trepresentation of a debugging level
607 *
608 * Returns: the name
609 */
610 const gchar *
611 gst_debug_level_get_name (GstDebugLevel level)
612 {
613 switch (level) {
614 case GST_LEVEL_NONE:
615 return "";
616 case GST_LEVEL_ERROR:
617 return "ERROR";
618 case GST_LEVEL_WARNING:
619 return "WARN ";
620 case GST_LEVEL_INFO:
621 return "INFO ";
622 case GST_LEVEL_DEBUG:
623 return "DEBUG";
624 case GST_LEVEL_LOG:
625 return "LOG ";
626 default:
627 g_warning ("invalid level specified for gst_debug_level_get_name");
628 return "";
629 }
630 }
632 /**
633 * gst_debug_add_log_function:
634 * @func: the function to use
635 * @data: user data
636 *
637 * Adds the logging function to the list of logging functions.
638 * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
639 */
640 void
641 gst_debug_add_log_function (GstLogFunction func, gpointer data)
642 {
643 LogFuncEntry *entry;
644 GSList *list;
646 g_return_if_fail (func != NULL);
648 entry = g_new (LogFuncEntry, 1);
649 entry->func = func;
650 entry->user_data = data;
651 /* FIXME: we leak the old list here - other threads might access it right now
652 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
653 * but that is waaay costly.
654 * It'd probably be clever to use some kind of RCU here, but I don't know
655 * anything about that.
656 */
657 g_static_mutex_lock (&__log_func_mutex);
658 list = g_slist_copy (__log_functions);
659 __log_functions = g_slist_prepend (list, entry);
660 g_static_mutex_unlock (&__log_func_mutex);
662 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
663 func, data);
664 }
666 static gint
667 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
668 {
669 gpointer entryfunc = ((LogFuncEntry *) entry)->func;
671 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
672 }
674 static gint
675 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
676 {
677 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
679 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
680 }
682 static guint
683 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
684 {
685 GSList *found;
686 GSList *new;
687 guint removals = 0;
689 g_static_mutex_lock (&__log_func_mutex);
690 new = __log_functions;
691 while ((found = g_slist_find_custom (new, data, func))) {
692 if (new == __log_functions) {
693 new = g_slist_copy (new);
694 continue;
695 }
696 g_free (found->data);
697 new = g_slist_delete_link (new, found);
698 removals++;
699 }
700 /* FIXME: We leak the old list here. See _add_log_function for why. */
701 __log_functions = new;
702 g_static_mutex_unlock (&__log_func_mutex);
704 return removals;
705 }
707 /**
708 * gst_debug_remove_log_function:
709 * @func: the log function to remove
710 *
711 * Removes all registrered instances of the given logging functions.
712 *
713 * Returns: How many instances of the function were removed
714 */
715 guint
716 gst_debug_remove_log_function (GstLogFunction func)
717 {
718 guint removals;
720 g_return_val_if_fail (func != NULL, 0);
722 removals =
723 gst_debug_remove_with_compare_func
724 (gst_debug_compare_log_function_by_func, func);
725 GST_DEBUG ("removed log function %p %d times from log function list", func,
726 removals);
728 return removals;
729 }
731 /**
732 * gst_debug_remove_log_function_by_data:
733 * @data: user data of the log function to remove
734 *
735 * Removes all registrered instances of log functions with the given user data.
736 *
737 * Returns: How many instances of the function were removed
738 */
739 guint
740 gst_debug_remove_log_function_by_data (gpointer data)
741 {
742 guint removals;
744 removals =
745 gst_debug_remove_with_compare_func
746 (gst_debug_compare_log_function_by_data, data);
747 GST_DEBUG
748 ("removed %d log functions with user data %p from log function list",
749 removals, data);
751 return removals;
752 }
754 /**
755 * gst_debug_set_colored:
756 * @colored: Whether to use colored output or not
757 *
758 * Sets or unsets the use of coloured debugging output.
759 */
760 void
761 gst_debug_set_colored (gboolean colored)
762 {
763 gst_atomic_int_set (&__use_color, colored ? 1 : 0);
764 }
766 /**
767 * gst_debug_is_colored:
768 *
769 * Checks if the debugging output should be colored.
770 *
771 * Returns: TRUE, if the debug output should be colored.
772 */
773 gboolean
774 gst_debug_is_colored (void)
775 {
776 return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
777 }
779 /**
780 * gst_debug_set_active:
781 * @active: Whether to use debugging output or not
782 *
783 * If activated, debugging messages are sent to the debugging
784 * handlers.
785 * It makes sense to deactivate it for speed issues.
786 * <note><para>This function is not threadsafe. It makes sense to only call it
787 * during initialization.</para></note>
788 */
789 void
790 gst_debug_set_active (gboolean active)
791 {
792 __gst_debug_enabled = active;
793 }
795 /**
796 * gst_debug_is_active:
797 *
798 * Checks if debugging output is activated.
799 *
800 * Returns: TRUE, if debugging is activated
801 */
802 gboolean
803 gst_debug_is_active (void)
804 {
805 return __gst_debug_enabled;
806 }
808 /**
809 * gst_debug_set_default_threshold:
810 * @level: level to set
811 *
812 * Sets the default threshold to the given level and updates all categories to
813 * use this threshold.
814 */
815 void
816 gst_debug_set_default_threshold (GstDebugLevel level)
817 {
818 gst_atomic_int_set (&__default_level, level);
819 gst_debug_reset_all_thresholds ();
820 }
822 /**
823 * gst_debug_get_default_threshold:
824 *
825 * Returns the default threshold that is used for new categories.
826 *
827 * Returns: the default threshold level
828 */
829 GstDebugLevel
830 gst_debug_get_default_threshold (void)
831 {
832 return (GstDebugLevel) g_atomic_int_get (&__default_level);
833 }
834 static void
835 gst_debug_reset_threshold (gpointer category, gpointer unused)
836 {
837 GstDebugCategory *cat = (GstDebugCategory *) category;
838 GSList *walk;
840 g_static_mutex_lock (&__level_name_mutex);
841 walk = __level_name;
842 while (walk) {
843 LevelNameEntry *entry = walk->data;
845 walk = g_slist_next (walk);
846 if (g_pattern_match_string (entry->pat, cat->name)) {
847 GST_LOG ("category %s matches pattern %p - gets set to level %d",
848 cat->name, entry->pat, entry->level);
849 gst_debug_category_set_threshold (cat, entry->level);
850 goto exit;
851 }
852 }
853 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
855 exit:
856 g_static_mutex_unlock (&__level_name_mutex);
857 }
858 static void
859 gst_debug_reset_all_thresholds (void)
860 {
861 g_static_mutex_lock (&__cat_mutex);
862 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
863 g_static_mutex_unlock (&__cat_mutex);
864 }
865 static void
866 for_each_threshold_by_entry (gpointer data, gpointer user_data)
867 {
868 GstDebugCategory *cat = (GstDebugCategory *) data;
869 LevelNameEntry *entry = (LevelNameEntry *) user_data;
871 if (g_pattern_match_string (entry->pat, cat->name)) {
872 GST_LOG ("category %s matches pattern %p - gets set to level %d",
873 cat->name, entry->pat, entry->level);
874 gst_debug_category_set_threshold (cat, entry->level);
875 }
876 }
878 /**
879 * gst_debug_set_threshold_for_name:
880 * @name: name of the categories to set
881 * @level: level to set them to
882 *
883 * Sets all categories which match the given glob style pattern to the given
884 * level.
885 */
886 void
887 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
888 {
889 GPatternSpec *pat;
890 LevelNameEntry *entry;
892 g_return_if_fail (name != NULL);
894 pat = g_pattern_spec_new (name);
895 entry = g_new (LevelNameEntry, 1);
896 entry->pat = pat;
897 entry->level = level;
898 g_static_mutex_lock (&__level_name_mutex);
899 __level_name = g_slist_prepend (__level_name, entry);
900 g_static_mutex_unlock (&__level_name_mutex);
901 g_static_mutex_lock (&__cat_mutex);
902 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
903 g_static_mutex_unlock (&__cat_mutex);
904 }
906 /**
907 * gst_debug_unset_threshold_for_name:
908 * @name: name of the categories to set
909 *
910 * Resets all categories with the given name back to the default level.
911 */
912 void
913 gst_debug_unset_threshold_for_name (const gchar * name)
914 {
915 GSList *walk;
916 GPatternSpec *pat;
918 g_return_if_fail (name != NULL);
920 pat = g_pattern_spec_new (name);
921 g_static_mutex_lock (&__level_name_mutex);
922 walk = __level_name;
923 /* improve this if you want, it's mighty slow */
924 while (walk) {
925 LevelNameEntry *entry = walk->data;
927 if (g_pattern_spec_equal (entry->pat, pat)) {
928 __level_name = g_slist_remove_link (__level_name, walk);
929 g_pattern_spec_free (entry->pat);
930 g_free (entry);
931 g_slist_free_1 (walk);
932 walk = __level_name;
933 }
934 }
935 g_static_mutex_unlock (&__level_name_mutex);
936 g_pattern_spec_free (pat);
937 gst_debug_reset_all_thresholds ();
938 }
940 GstDebugCategory *
941 _gst_debug_category_new (gchar * name, guint color, gchar * description)
942 {
943 GstDebugCategory *cat;
945 g_return_val_if_fail (name != NULL, NULL);
947 cat = g_new (GstDebugCategory, 1);
948 cat->name = g_strdup (name);
949 cat->color = color;
950 if (description != NULL) {
951 cat->description = g_strdup (description);
952 } else {
953 cat->description = g_strdup ("no description");
954 }
955 gst_atomic_int_set (&cat->threshold, 0);
956 gst_debug_reset_threshold (cat, NULL);
958 /* add to category list */
959 g_static_mutex_lock (&__cat_mutex);
960 __categories = g_slist_prepend (__categories, cat);
961 g_static_mutex_unlock (&__cat_mutex);
963 return cat;
964 }
966 /**
967 * gst_debug_category_free:
968 * @category: #GstDebugCategory to free.
969 *
970 * Removes and frees the category and all associated resources.
971 */
972 void
973 gst_debug_category_free (GstDebugCategory * category)
974 {
975 if (category == NULL)
976 return;
978 /* remove from category list */
979 g_static_mutex_lock (&__cat_mutex);
980 __categories = g_slist_remove (__categories, category);
981 g_static_mutex_unlock (&__cat_mutex);
983 g_free ((gpointer) category->name);
984 g_free ((gpointer) category->description);
985 g_free (category);
986 }
988 /**
989 * gst_debug_category_set_threshold:
990 * @category: a #GstDebugCategory to set threshold of.
991 * @level: the #GstDebugLevel threshold to set.
992 *
993 * Sets the threshold of the category to the given level. Debug information will
994 * only be output if the threshold is lower or equal to the level of the
995 * debugging message.
996 * <note><para>
997 * Do not use this function in production code, because other functions may
998 * change the threshold of categories as side effect. It is however a nice
999 * function to use when debugging (even from gdb).
1000 * </para></note>
1001 */
1002 void
1003 gst_debug_category_set_threshold (GstDebugCategory * category,
1004 GstDebugLevel level)
1005 {
1006 g_return_if_fail (category != NULL);
1008 gst_atomic_int_set (&category->threshold, level);
1009 }
1011 /**
1012 * gst_debug_category_reset_threshold:
1013 * @category: a #GstDebugCategory to reset threshold of.
1014 *
1015 * Resets the threshold of the category to the default level. Debug information
1016 * will only be output if the threshold is lower or equal to the level of the
1017 * debugging message.
1018 * Use this function to set the threshold back to where it was after using
1019 * gst_debug_category_set_threshold().
1020 */
1021 void
1022 gst_debug_category_reset_threshold (GstDebugCategory * category)
1023 {
1024 gst_debug_reset_threshold (category, NULL);
1025 }
1027 /**
1028 * gst_debug_category_get_threshold:
1029 * @category: a #GstDebugCategory to get threshold of.
1030 *
1031 * Returns the threshold of a #GstCategory.
1032 *
1033 * Returns: the #GstDebugLevel that is used as threshold.
1034 */
1035 GstDebugLevel
1036 gst_debug_category_get_threshold (GstDebugCategory * category)
1037 {
1038 return g_atomic_int_get (&category->threshold);
1039 }
1041 /**
1042 * gst_debug_category_get_name:
1043 * @category: a #GstDebugCategory to get name of.
1044 *
1045 * Returns the name of a debug category.
1046 *
1047 * Returns: the name of the category.
1048 */
1049 const gchar *
1050 gst_debug_category_get_name (GstDebugCategory * category)
1051 {
1052 return category->name;
1053 }
1055 /**
1056 * gst_debug_category_get_color:
1057 * @category: a #GstDebugCategory to get the color of.
1058 *
1059 * Returns the color of a debug category used when printing output in this
1060 * category.
1061 *
1062 * Returns: the color of the category.
1063 */
1064 guint
1065 gst_debug_category_get_color (GstDebugCategory * category)
1066 {
1067 return category->color;
1068 }
1070 /**
1071 * gst_debug_category_get_description:
1072 * @category: a #GstDebugCategory to get the description of.
1073 *
1074 * Returns the description of a debug category.
1075 *
1076 * Returns: the description of the category.
1077 */
1078 const gchar *
1079 gst_debug_category_get_description (GstDebugCategory * category)
1080 {
1081 return category->description;
1082 }
1084 /**
1085 * gst_debug_get_all_categories:
1086 *
1087 * Returns a snapshot of a all categories that are currently in use . This list
1088 * may change anytime.
1089 * The caller has to free the list after use.
1090 * <emphasis>This function is not threadsafe, so only use it while only the
1091 * main thread is running.</emphasis>
1092 *
1093 * Returns: the list of categories
1094 */
1095 GSList *
1096 gst_debug_get_all_categories (void)
1097 {
1098 GSList *ret;
1100 g_static_mutex_lock (&__cat_mutex);
1101 ret = g_slist_copy (__categories);
1102 g_static_mutex_unlock (&__cat_mutex);
1104 return ret;
1105 }
1107 /*** FUNCTION POINTERS ********************************************************/
1109 static GHashTable *__gst_function_pointers; /* NULL */
1110 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1112 const gchar *
1113 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1114 G_GNUC_NO_INSTRUMENT;
1116 /* This function MUST NOT return NULL */
1117 const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1118 {
1119 gpointer ptr = (gpointer) func;
1120 gchar *ptrname;
1122 #ifdef HAVE_DLADDR
1123 Dl_info dlinfo;
1124 #endif
1126 if (__gst_function_pointers) {
1127 g_static_mutex_lock (&__dbg_functions_mutex);
1128 ptrname = g_hash_table_lookup (__gst_function_pointers, ptr);
1129 g_static_mutex_unlock (&__dbg_functions_mutex);
1130 if (ptrname)
1131 return ptrname;
1132 }
1133 /* we need to create an entry in the hash table for this one so we don't leak
1134 * the name */
1135 #ifdef HAVE_DLADDR
1136 if (dladdr (ptr, &dlinfo) && dlinfo.dli_sname) {
1137 gchar *name = g_strdup (dlinfo.dli_sname);
1139 _gst_debug_register_funcptr (ptr, name);
1140 return name;
1141 } else
1142 #endif
1143 {
1144 gchar *name = g_strdup_printf ("%p", ptr);
1146 _gst_debug_register_funcptr (ptr, name);
1147 return name;
1148 }
1149 }
1151 void
1152 _gst_debug_register_funcptr (GstDebugFuncPtr func, gchar * ptrname)
1153 {
1154 gpointer ptr = (gpointer) func;
1156 g_static_mutex_lock (&__dbg_functions_mutex);
1158 if (!__gst_function_pointers)
1159 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1160 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1161 g_hash_table_insert (__gst_function_pointers, ptr, ptrname);
1163 g_static_mutex_unlock (&__dbg_functions_mutex);
1164 }
1166 #ifdef HAVE_PRINTF_EXTENSION
1167 static int
1168 _gst_info_printf_extension (FILE * stream, const struct printf_info *info,
1169 const void *const *args)
1170 {
1171 char *buffer;
1172 int len;
1173 void *ptr;
1175 buffer = NULL;
1176 ptr = *(void **) args[0];
1178 buffer = gst_debug_print_object (ptr);
1179 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1180 buffer);
1182 free (buffer);
1183 return len;
1184 }
1186 static int
1187 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1188 int *argtypes)
1189 {
1190 if (n > 0)
1191 argtypes[0] = PA_POINTER;
1192 return 1;
1193 }
1194 #endif /* HAVE_PRINTF_EXTENSION */
1196 #else /* !GST_DISABLE_GST_DEBUG */
1197 guint
1198 gst_debug_remove_log_function (GstLogFunction func)
1199 {
1200 return 0;
1201 }
1203 guint
1204 gst_debug_remove_log_function_by_data (gpointer data)
1205 {
1206 return 0;
1207 }
1209 gboolean
1210 __gst_in_valgrind (void)
1211 {
1212 return FALSE;
1213 }
1215 #endif /* GST_DISABLE_GST_DEBUG */
1218 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1219 /* FIXME make this thread specific */
1220 static GSList *stack_trace = NULL;
1222 void
1223 __cyg_profile_func_enter (void *this_fn, void *call_site)
1224 G_GNUC_NO_INSTRUMENT;
1225 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1226 {
1227 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1228 gchar *site = _gst_debug_nameof_funcptr (call_site);
1230 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1231 site);
1232 stack_trace =
1233 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1234 this_fn, name, call_site, site));
1236 g_free (name);
1237 g_free (site);
1238 }
1240 void
1241 __cyg_profile_func_exit (void *this_fn, void *call_site)
1242 G_GNUC_NO_INSTRUMENT;
1243 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1244 {
1245 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1247 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1248 g_free (stack_trace->data);
1249 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1251 g_free (name);
1252 }
1254 /**
1255 * gst_debug_print_stack_trace:
1256 *
1257 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktracke is available for
1258 * gstreamer code, which can be printed with this function.
1259 */
1260 void
1261 gst_debug_print_stack_trace (void)
1262 {
1263 GSList *walk = stack_trace;
1264 gint count = 0;
1266 if (walk)
1267 walk = g_slist_next (walk);
1269 while (walk) {
1270 gchar *name = (gchar *) walk->data;
1272 g_print ("#%-2d %s\n", count++, name);
1274 walk = g_slist_next (walk);
1275 }
1276 }
1277 #else
1278 void
1279 gst_debug_print_stack_trace (void)
1280 {
1281 /* nothing because it's compiled out */
1282 }
1284 #endif /* GST_ENABLE_FUNC_INTSTRUMENTATION */