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