gst/gstinfo.c

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