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