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