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  * Copyright (C) 2008-2009 Tim-Philipp Müller <tim centricular net>
   6  *
   7  * gstinfo.c: debugging functions
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 /**
  26  * SECTION:gstinfo
  27  * @short_description: Debugging and logging facilities
  28  * @see_also: #GstConfig, #Gst for command line parameters
  29  * and environment variables that affect the debugging output.
  30  *
  31  * GStreamer's debugging subsystem is an easy way to get information about what
  32  * the application is doing.  It is not meant for programming errors. Use GLib
  33  * methods (g_warning and friends) for that.
  34  *
  35  * The debugging subsystem works only after GStreamer has been initialized
  36  * - for example by calling gst_init().
  37  *
  38  * The debugging subsystem is used to log informational messages while the
  39  * application runs.  Each messages has some properties attached to it. Among
  40  * these properties are the debugging category, the severity (called "level"
  41  * here) and an optional #GObject it belongs to. Each of these messages is sent
  42  * to all registered debugging handlers, which then handle the messages.
  43  * GStreamer attaches a default handler on startup, which outputs requested
  44  * messages to stderr.
  45  *
  46  * Messages are output by using shortcut macros like #GST_DEBUG,
  47  * #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()
  48  * with the right parameters.
  49  * The only thing a developer will probably want to do is define his own
  50  * categories. This is easily done with 3 lines. At the top of your code,
  51  * declare
  52  * the variables and set the default category.
  53  * <informalexample>
  54  * <programlisting>
  55  * GST_DEBUG_CATEGORY_STATIC (my_category);     // define category (statically)
  56  * &hash;define GST_CAT_DEFAULT my_category     // set as default
  57  * </programlisting>
  58  * </informalexample>
  59  * After that you only need to initialize the category.
  60  * <informalexample>
  61  * <programlisting>
  62  * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
  63  *                          0, "This is my very own");
  64  * </programlisting>
  65  * </informalexample>
  66  * Initialization must be done before the category is used first.
  67  * Plugins do this
  68  * in their plugin_init function, libraries and applications should do that
  69  * during their initialization.
  70  *
  71  * The whole debugging subsystem can be disabled at build time with passing the
  72  * --disable-gst-debug switch to configure. If this is done, every function,
  73  * macro and even structs described in this file evaluate to default values or
  74  * nothing at all.
  75  * 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: unnoticeable)
  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 #define GST_INFO_C
  90 #include "gst_private.h"
  91 #include "gstinfo.h"
  92
  93 #ifndef GST_DISABLE_GST_DEBUG
  94
  95 #ifdef HAVE_DLFCN_H
  96 #  include <dlfcn.h>
  97 #endif
  98 #ifdef HAVE_PRINTF_EXTENSION
  99 #  include <printf.h>
 100 #endif
 101 #include <stdio.h>              /* fprintf */
 102 #ifdef HAVE_UNISTD_H
 103 #  include <unistd.h>           /* getpid on UNIX */
 104 #endif
 105 #ifdef HAVE_PROCESS_H
 106 #  include <process.h>          /* getpid on win32 */
 107 #endif
 108 #include <string.h>             /* G_VA_COPY */
 109 #ifdef G_OS_WIN32
 110 #  define WIN32_LEAN_AND_MEAN   /* prevents from including too many things */
 111 #  include <windows.h>          /* GetStdHandle, windows console */
 112 #endif
 113
 114 #include "gst_private.h"
 115 #include "gstutils.h"
 116 #include "gstquark.h"
 117 #include "gstsegment.h"
 118 #ifdef HAVE_VALGRIND_H
 119 #  include <valgrind/valgrind.h>
 120 #endif
 121 #include <glib/gprintf.h>       /* g_sprintf */
 122
 123 #endif /* !GST_DISABLE_GST_DEBUG */
 124
 125 /* we want these symbols exported even if debug is disabled, to maintain
 126  * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
 127 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
 128
 129 /* disabled by default, as soon as some threshold is set > NONE,
 130  * it becomes enabled. */
 131 gboolean __gst_debug_enabled = FALSE;
 132 GstDebugLevel __gst_debug_min = GST_LEVEL_NONE;
 133
 134 GstDebugCategory *GST_CAT_DEFAULT = NULL;
 135
 136 GstDebugCategory *GST_CAT_GST_INIT = NULL;
 137 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
 138 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
 139 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
 140 GstDebugCategory *GST_CAT_STATES = NULL;
 141 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
 142
 143 GstDebugCategory *GST_CAT_BUFFER = NULL;
 144 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
 145 GstDebugCategory *GST_CAT_BUS = NULL;
 146 GstDebugCategory *GST_CAT_CAPS = NULL;
 147 GstDebugCategory *GST_CAT_CLOCK = NULL;
 148 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
 149 GstDebugCategory *GST_CAT_PADS = NULL;
 150 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
 151 GstDebugCategory *GST_CAT_PIPELINE = NULL;
 152 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
 153 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
 154 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
 155 GstDebugCategory *GST_CAT_TYPES = NULL;
 156 GstDebugCategory *GST_CAT_XML = NULL;
 157 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
 158 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
 159 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
 160 GstDebugCategory *GST_CAT_EVENT = NULL;
 161 GstDebugCategory *GST_CAT_MESSAGE = NULL;
 162 GstDebugCategory *GST_CAT_PARAMS = NULL;
 163 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
 164 GstDebugCategory *GST_CAT_SIGNAL = NULL;
 165 GstDebugCategory *GST_CAT_PROBE = NULL;
 166 GstDebugCategory *GST_CAT_REGISTRY = NULL;
 167 GstDebugCategory *GST_CAT_QOS = NULL;
 168 GstDebugCategory *GST_CAT_POLL = NULL;
 169
 170
 171 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
 172
 173 #ifndef GST_DISABLE_GST_DEBUG
 174
 175 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
 176 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
 177
 178 /* time of initialization, so we get useful debugging output times
 179  * FIXME: we use this in gstdebugutils.c, what about a function + macro to
 180  * get the running time: GST_DEBUG_RUNNING_TIME
 181  */
 182 GstClockTime _priv_gst_info_start_time;
 183
 184 #if 0
 185 #if defined __sgi__
 186 #include <rld_interface.h>
 187 typedef struct DL_INFO
 188 {
 189   const char *dli_fname;
 190   void *dli_fbase;
 191   const char *dli_sname;
 192   void *dli_saddr;
 193   int dli_version;
 194   int dli_reserved1;
 195   long dli_reserved[4];
 196 }
 197 Dl_info;
 198
 199 #define _RLD_DLADDR             14
 200 int dladdr (void *address, Dl_info * dl);
 201
 202 int
 203 dladdr (void *address, Dl_info * dl)
 204 {
 205   void *v;
 206
 207   v = _rld_new_interface (_RLD_DLADDR, address, dl);
 208   return (int) v;
 209 }
 210 #endif /* __sgi__ */
 211 #endif
 212
 213 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
 214 static void gst_debug_reset_all_thresholds (void);
 215
 216 #ifdef HAVE_PRINTF_EXTENSION
 217 static int _gst_info_printf_extension_ptr (FILE * stream,
 218     const struct printf_info *info, const void *const *args);
 219 static int _gst_info_printf_extension_segment (FILE * stream,
 220     const struct printf_info *info, const void *const *args);
 221 #if HAVE_REGISTER_PRINTF_SPECIFIER
 222 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
 223     size_t n, int *argtypes, int *size);
 224 #else
 225 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
 226     size_t n, int *argtypes);
 227 #endif
 228 #endif
 229
 230 struct _GstDebugMessage
 231 {
 232   gchar *message;
 233   const gchar *format;
 234   va_list arguments;
 235 };
 236
 237 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
 238 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
 239 static GSList *__level_name = NULL;
 240 typedef struct
 241 {
 242   GPatternSpec *pat;
 243   GstDebugLevel level;
 244 }
 245 LevelNameEntry;
 246
 247 /* list of all categories */
 248 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
 249 static GSList *__categories = NULL;
 250
 251 /* all registered debug handlers */
 252 typedef struct
 253 {
 254   GstLogFunction func;
 255   gpointer user_data;
 256 }
 257 LogFuncEntry;
 258 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
 259 static GSList *__log_functions = NULL;
 260
 261 #define PRETTY_TAGS_DEFAULT  TRUE
 262 static gboolean pretty_tags = PRETTY_TAGS_DEFAULT;
 263
 264 static gint __default_level;
 265 static gint __use_color;
 266
 267 /* FIXME: export this? */
 268 gboolean
 269 _priv_gst_in_valgrind (void)
 270 {
 271   static enum
 272   {
 273     GST_VG_UNCHECKED,
 274     GST_VG_NO_VALGRIND,
 275     GST_VG_INSIDE
 276   }
 277   in_valgrind = GST_VG_UNCHECKED;
 278
 279   if (in_valgrind == GST_VG_UNCHECKED) {
 280 #ifdef HAVE_VALGRIND_H
 281     if (RUNNING_ON_VALGRIND) {
 282       GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
 283       printf ("GStreamer has detected that it is running inside valgrind.\n");
 284       printf ("It might now take different code paths to ease debugging.\n");
 285       printf ("Of course, this may also lead to different bugs.\n");
 286       in_valgrind = GST_VG_INSIDE;
 287     } else {
 288       GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
 289       in_valgrind = GST_VG_NO_VALGRIND;
 290     }
 291 #else
 292     in_valgrind = GST_VG_NO_VALGRIND;
 293 #endif
 294     g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
 295         in_valgrind == GST_VG_INSIDE);
 296   }
 297   return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
 298 }
 299
 300 /**
 301  * _gst_debug_init:
 302  *
 303  * Initializes the debugging system.
 304  * Normally you don't want to call this, because gst_init() does it for you.
 305  */
 306 void
 307 _gst_debug_init (void)
 308 {
 309   const gchar *env;
 310
 311   g_atomic_int_set (&__default_level, GST_LEVEL_DEFAULT);
 312   g_atomic_int_set (&__use_color, 1);
 313
 314   /* get time we started for debugging messages */
 315   _priv_gst_info_start_time = gst_util_get_timestamp ();
 316
 317 #ifdef HAVE_PRINTF_EXTENSION
 318 #if HAVE_REGISTER_PRINTF_SPECIFIER
 319   register_printf_specifier (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
 320       _gst_info_printf_extension_arginfo);
 321   register_printf_specifier (GST_SEGMENT_FORMAT[0],
 322       _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
 323 #else
 324   register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
 325       _gst_info_printf_extension_arginfo);
 326   register_printf_function (GST_SEGMENT_FORMAT[0],
 327       _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
 328 #endif
 329 #endif
 330
 331   /* do NOT use a single debug function before this line has been run */
 332   GST_CAT_DEFAULT = _gst_debug_category_new ("default",
 333       GST_DEBUG_UNDERLINE, NULL);
 334   _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
 335       GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
 336
 337   gst_debug_add_log_function (gst_debug_log_default, NULL);
 338
 339   /* FIXME: add descriptions here */
 340   GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
 341       GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
 342   GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
 343       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 344   GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
 345       GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
 346   GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
 347       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 348   GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
 349       GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
 350   GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
 351       GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
 352   GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
 353       GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
 354   GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
 355       GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
 356   GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
 357   GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
 358       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 359   GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
 360       GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
 361   GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
 362       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 363   GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
 364       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
 365   GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
 366       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 367   GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
 368       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 369   GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
 370       GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
 371   GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
 372       GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
 373   GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
 374       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
 375   GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
 376       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 377   GST_CAT_XML = _gst_debug_category_new ("GST_XML",
 378       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 379   GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
 380       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 381   GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
 382       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
 383   GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
 384       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
 385
 386   GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
 387       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 388   GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
 389       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 390   GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
 391       GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
 392   GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
 393       GST_DEBUG_BOLD, NULL);
 394   GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
 395       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 396   GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
 397       GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
 398   GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
 399   GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
 400   GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
 401
 402
 403   /* print out the valgrind message if we're in valgrind */
 404   _priv_gst_in_valgrind ();
 405
 406   env = g_getenv ("GST_DEBUG_OPTIONS");
 407   if (env != NULL) {
 408     if (strstr (env, "full_tags") || strstr (env, "full-tags"))
 409       pretty_tags = FALSE;
 410     else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
 411       pretty_tags = TRUE;
 412   }
 413 }
 414
 415 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
 416 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
 417
 418 /**
 419  * gst_debug_log:
 420  * @category: category to log
 421  * @level: level of the message is in
 422  * @file: the file that emitted the message, usually the __FILE__ identifier
 423  * @function: the function that emitted the message
 424  * @line: the line from that the message was emitted, usually __LINE__
 425  * @object: the object this message relates to or NULL if none
 426  * @format: a printf style format string
 427  * @...: optional arguments for the format
 428  *
 429  * Logs the given message using the currently registered debugging handlers.
 430  */
 431 void
 432 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
 433     const gchar * file, const gchar * function, gint line,
 434     GObject * object, const gchar * format, ...)
 435 {
 436   va_list var_args;
 437
 438   va_start (var_args, format);
 439   gst_debug_log_valist (category, level, file, function, line, object, format,
 440       var_args);
 441   va_end (var_args);
 442 }
 443
 444 /**
 445  * gst_debug_log_valist:
 446  * @category: category to log
 447  * @level: level of the message is in
 448  * @file: the file that emitted the message, usually the __FILE__ identifier
 449  * @function: the function that emitted the message
 450  * @line: the line from that the message was emitted, usually __LINE__
 451  * @object: the object this message relates to or NULL if none
 452  * @format: a printf style format string
 453  * @args: optional arguments for the format
 454  *
 455  * Logs the given message using the currently registered debugging handlers.
 456  */
 457 void
 458 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
 459     const gchar * file, const gchar * function, gint line,
 460     GObject * object, const gchar * format, va_list args)
 461 {
 462   GstDebugMessage message;
 463   LogFuncEntry *entry;
 464   GSList *handler;
 465
 466 #ifdef _MSC_VER
 467   gchar *file_basename;
 468 #endif
 469
 470   g_return_if_fail (category != NULL);
 471   g_return_if_fail (file != NULL);
 472   g_return_if_fail (function != NULL);
 473   g_return_if_fail (format != NULL);
 474
 475 #ifdef _MSC_VER
 476   /*
 477    * The predefined macro __FILE__ is always the exact path given to the
 478    * compiler with MSVC, which may or may not be the basename.  We work
 479    * around it at runtime to improve the readability.
 480    */
 481   file = file_basename = g_path_get_basename (file);
 482 #endif
 483
 484   message.message = NULL;
 485   message.format = format;
 486   G_VA_COPY (message.arguments, args);
 487
 488   handler = __log_functions;
 489   while (handler) {
 490     entry = handler->data;
 491     handler = g_slist_next (handler);
 492     entry->func (category, level, file, function, line, object, &message,
 493         entry->user_data);
 494   }
 495   g_free (message.message);
 496   va_end (message.arguments);
 497
 498 #ifdef _MSC_VER
 499   g_free (file_basename);
 500 #endif
 501 }
 502
 503 /**
 504  * gst_debug_message_get:
 505  * @message: a debug message
 506  *
 507  * Gets the string representation of a #GstDebugMessage. This function is used
 508  * in debug handlers to extract the message.
 509  *
 510  * Returns: the string representation of a #GstDebugMessage.
 511  */
 512 const gchar *
 513 gst_debug_message_get (GstDebugMessage * message)
 514 {
 515   if (message->message == NULL) {
 516     message->message = g_strdup_vprintf (message->format, message->arguments);
 517   }
 518   return message->message;
 519 }
 520
 521 #define MAX_BUFFER_DUMP_STRING_LEN  100
 522
 523 /* structure_to_pretty_string:
 524  * @structure: a #GstStructure
 525  *
 526  * Converts @structure to a human-readable string representation. Basically
 527  * the same as gst_structure_to_string(), but if the structure contains large
 528  * buffers such as images the hex representation of those buffers will be
 529  * shortened so that the string remains readable.
 530  *
 531  * Returns: a newly-allocated string. g_free() when no longer needed.
 532  */
 533 static gchar *
 534 structure_to_pretty_string (const GstStructure * s)
 535 {
 536   gchar *str, *pos, *end;
 537
 538   str = gst_structure_to_string (s);
 539   if (str == NULL)
 540     return NULL;
 541
 542   pos = str;
 543   while ((pos = strstr (pos, "(buffer)"))) {
 544     guint count = 0;
 545
 546     pos += strlen ("(buffer)");
 547     for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
 548       ++count;
 549     if (count > MAX_BUFFER_DUMP_STRING_LEN) {
 550       memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
 551       memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
 552       g_memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
 553           strlen (pos + count) + 1);
 554       pos += MAX_BUFFER_DUMP_STRING_LEN;
 555     }
 556   }
 557
 558   return str;
 559 }
 560
 561 static inline gchar *
 562 gst_info_structure_to_string (GstStructure * s)
 563 {
 564   if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
 565     return structure_to_pretty_string (s);
 566   else
 567     return gst_structure_to_string (s);
 568 }
 569
 570 static gchar *
 571 gst_debug_print_object (gpointer ptr)
 572 {
 573   GObject *object = (GObject *) ptr;
 574
 575 #ifdef unused
 576   /* This is a cute trick to detect unmapped memory, but is unportable,
 577    * slow, screws around with madvise, and not actually that useful. */
 578   {
 579     int ret;
 580
 581     ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
 582     if (ret == -1 && errno == ENOMEM) {
 583       buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
 584     }
 585   }
 586 #endif
 587
 588   /* nicely printed object */
 589   if (object == NULL) {
 590     return g_strdup ("(NULL)");
 591   }
 592   if (*(GType *) ptr == GST_TYPE_CAPS) {
 593     return gst_caps_to_string ((GstCaps *) ptr);
 594   }
 595   if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
 596     return gst_info_structure_to_string ((GstStructure *) ptr);
 597   }
 598 #ifdef USE_POISONING
 599   if (*(guint32 *) ptr == 0xffffffff) {
 600     return g_strdup_printf ("<poisoned@%p>", ptr);
 601   }
 602 #endif
 603   if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
 604     return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
 605   }
 606   if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
 607     return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
 608   }
 609   if (G_IS_OBJECT (object)) {
 610     return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
 611   }
 612   if (GST_IS_MESSAGE (object)) {
 613     GstMessage *msg = GST_MESSAGE_CAST (object);
 614     gchar *s, *ret;
 615
 616     if (msg->structure) {
 617       s = gst_info_structure_to_string (msg->structure);
 618     } else {
 619       s = g_strdup ("(NULL)");
 620     }
 621
 622     ret = g_strdup_printf ("%s message from element '%s': %s",
 623         GST_MESSAGE_TYPE_NAME (msg), (msg->src != NULL) ?
 624         GST_ELEMENT_NAME (msg->src) : "(NULL)", s);
 625     g_free (s);
 626     return ret;
 627   }
 628   if (GST_IS_QUERY (object)) {
 629     GstQuery *query = GST_QUERY_CAST (object);
 630
 631     if (query->structure) {
 632       return gst_info_structure_to_string (query->structure);
 633     } else {
 634       const gchar *query_type_name;
 635
 636       query_type_name = gst_query_type_get_name (query->type);
 637       if (G_LIKELY (query_type_name != NULL)) {
 638         return g_strdup_printf ("%s query", query_type_name);
 639       } else {
 640         return g_strdup_printf ("query of unknown type %d", query->type);
 641       }
 642     }
 643   }
 644
 645   return g_strdup_printf ("%p", ptr);
 646 }
 647
 648 #ifdef HAVE_PRINTF_EXTENSION
 649
 650 static gchar *
 651 gst_debug_print_segment (gpointer ptr)
 652 {
 653   GstSegment *segment = (GstSegment *) ptr;
 654
 655   /* nicely printed segment */
 656   if (segment == NULL) {
 657     return g_strdup ("(NULL)");
 658   }
 659
 660   switch (segment->format) {
 661     case GST_FORMAT_UNDEFINED:{
 662       return g_strdup_printf ("UNDEFINED segment");
 663     }
 664     case GST_FORMAT_TIME:{
 665       return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
 666           ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
 667           ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
 668           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
 669           GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
 670           GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
 671           segment->rate, segment->applied_rate, (guint) segment->flags,
 672           GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
 673     }
 674     default:{
 675       const gchar *format_name;
 676
 677       format_name = gst_format_get_name (segment->format);
 678       if (G_UNLIKELY (format_name == NULL))
 679         format_name = "(UNKNOWN FORMAT)";
 680       return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
 681           ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
 682           ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
 683           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
 684           format_name, segment->start, segment->stop, segment->last_stop,
 685           segment->duration, segment->rate, segment->applied_rate,
 686           (guint) segment->flags, GST_TIME_ARGS (segment->time),
 687           GST_TIME_ARGS (segment->accum));
 688     }
 689   }
 690 }
 691
 692 #endif /* HAVE_PRINTF_EXTENSION */
 693
 694 /**
 695  * gst_debug_construct_term_color:
 696  * @colorinfo: the color info
 697  *
 698  * Constructs a string that can be used for getting the desired color in color
 699  * terminals.
 700  * You need to free the string after use.
 701  *
 702  * Returns: a string containing the color definition
 703  */
 704 gchar *
 705 gst_debug_construct_term_color (guint colorinfo)
 706 {
 707   GString *color;
 708
 709   color = g_string_new ("\033[00");
 710
 711   if (colorinfo & GST_DEBUG_BOLD) {
 712     g_string_append_len (color, ";01", 3);
 713   }
 714   if (colorinfo & GST_DEBUG_UNDERLINE) {
 715     g_string_append_len (color, ";04", 3);
 716   }
 717   if (colorinfo & GST_DEBUG_FG_MASK) {
 718     g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
 719   }
 720   if (colorinfo & GST_DEBUG_BG_MASK) {
 721     g_string_append_printf (color, ";4%1d",
 722         (colorinfo & GST_DEBUG_BG_MASK) >> 4);
 723   }
 724   g_string_append_c (color, 'm');
 725
 726   return g_string_free (color, FALSE);
 727 }
 728
 729 /**
 730  * gst_debug_construct_win_color:
 731  * @colorinfo: the color info
 732  *
 733  * Constructs an integer that can be used for getting the desired color in
 734  * windows' terminals (cmd.exe). As there is no mean to underline, we simply
 735  * ignore this attribute.
 736  *
 737  * This function returns 0 on non-windows machines.
 738  *
 739  * Returns: an integer containing the color definition
 740  *
 741  * Since: 0.10.23
 742  */
 743 gint
 744 gst_debug_construct_win_color (guint colorinfo)
 745 {
 746   gint color = 0;
 747 #ifdef G_OS_WIN32
 748   static const guchar ansi_to_win_fg[8] = {
 749     0,                          /* black   */
 750     FOREGROUND_RED,             /* red     */
 751     FOREGROUND_GREEN,           /* green   */
 752     FOREGROUND_RED | FOREGROUND_GREEN,  /* yellow  */
 753     FOREGROUND_BLUE,            /* blue    */
 754     FOREGROUND_RED | FOREGROUND_BLUE,   /* magenta */
 755     FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan    */
 756     FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white   */
 757   };
 758   static const guchar ansi_to_win_bg[8] = {
 759     0,
 760     BACKGROUND_RED,
 761     BACKGROUND_GREEN,
 762     BACKGROUND_RED | BACKGROUND_GREEN,
 763     BACKGROUND_BLUE,
 764     BACKGROUND_RED | BACKGROUND_BLUE,
 765     BACKGROUND_GREEN | FOREGROUND_BLUE,
 766     BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
 767   };
 768
 769   /* we draw black as white, as cmd.exe can only have black bg */
 770   if (colorinfo == 0) {
 771     return ansi_to_win_fg[7];
 772   }
 773
 774   if (colorinfo & GST_DEBUG_BOLD) {
 775     color |= FOREGROUND_INTENSITY;
 776   }
 777   if (colorinfo & GST_DEBUG_FG_MASK) {
 778     color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
 779   }
 780   if (colorinfo & GST_DEBUG_BG_MASK) {
 781     color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
 782   }
 783 #endif
 784   return color;
 785 }
 786
 787 /* width of %p varies depending on actual value of pointer, which can make
 788  * output unevenly aligned if multiple threads are involved, hence the %14p
 789  * (should really be %18p, but %14p seems a good compromise between too many
 790  * white spaces and likely unalignment on my system) */
 791 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
 792 #define PTR_FMT "%14p"
 793 #else
 794 #define PTR_FMT "%10p"
 795 #endif
 796 #define PID_FMT "%5d"
 797 #define CAT_FMT "%20s %s:%d:%s:%s"
 798
 799 #ifdef G_OS_WIN32
 800 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
 801   /* GST_LEVEL_NONE */
 802   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
 803   /* GST_LEVEL_ERROR */
 804   FOREGROUND_RED | FOREGROUND_INTENSITY,
 805   /* GST_LEVEL_WARNING */
 806   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
 807   /* GST_LEVEL_INFO */
 808   FOREGROUND_GREEN | FOREGROUND_INTENSITY,
 809   /* GST_LEVEL_DEBUG */
 810   FOREGROUND_GREEN | FOREGROUND_BLUE,
 811   /* GST_LEVEL_LOG */
 812   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
 813   /* GST_LEVEL_FIXME */
 814   FOREGROUND_RED | FOREGROUND_GREEN,
 815   /* placeholder for log level 7 */
 816   0,
 817   /* placeholder for log level 8 */
 818   0,
 819   /* GST_LEVEL_MEMDUMP */
 820   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
 821 };
 822
 823 static const guchar available_colors[] = {
 824   FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
 825   FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
 826   FOREGROUND_GREEN | FOREGROUND_BLUE,
 827 };
 828 #else
 829 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
 830   "\033[37m",                   /* GST_LEVEL_NONE */
 831   "\033[31;01m",                /* GST_LEVEL_ERROR */
 832   "\033[33;01m",                /* GST_LEVEL_WARNING */
 833   "\033[32;01m",                /* GST_LEVEL_INFO */
 834   "\033[36m",                   /* GST_LEVEL_DEBUG */
 835   "\033[37m",                   /* GST_LEVEL_LOG */
 836   "\033[33;01m",                /* GST_LEVEL_FIXME */
 837   "\033[37m",                   /* placeholder for log level 7 */
 838   "\033[37m",                   /* placeholder for log level 8 */
 839   "\033[37m"                    /* GST_LEVEL_MEMDUMP */
 840 };
 841 #endif
 842
 843 /**
 844  * gst_debug_log_default:
 845  * @category: category to log
 846  * @level: level of the message
 847  * @file: the file that emitted the message, usually the __FILE__ identifier
 848  * @function: the function that emitted the message
 849  * @line: the line from that the message was emitted, usually __LINE__
 850  * @message: the actual message
 851  * @object: the object this message relates to or NULL if none
 852  * @unused: an unused variable, reserved for some user_data.
 853  *
 854  * The default logging handler used by GStreamer. Logging functions get called
 855  * whenever a macro like GST_DEBUG or similar is used. This function outputs the
 856  * message and additional info using the glib error handler.
 857  * You can add other handlers by using gst_debug_add_log_function().
 858  * And you can remove this handler by calling
 859  * gst_debug_remove_log_function(gst_debug_log_default);
 860  */
 861 void
 862 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
 863     const gchar * file, const gchar * function, gint line,
 864     GObject * object, GstDebugMessage * message, gpointer unused)
 865 {
 866   gint pid;
 867   GstClockTime elapsed;
 868   gchar *obj = NULL;
 869   gboolean free_obj = TRUE;
 870   gboolean is_colored;
 871
 872   if (level > gst_debug_category_get_threshold (category))
 873     return;
 874
 875   pid = getpid ();
 876   is_colored = gst_debug_is_colored ();
 877
 878   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
 879       gst_util_get_timestamp ());
 880
 881   if (object) {
 882     obj = gst_debug_print_object (object);
 883   } else {
 884     obj = "\0";
 885     free_obj = FALSE;
 886   }
 887
 888   if (is_colored) {
 889 #ifndef G_OS_WIN32
 890     /* colors, non-windows */
 891     gchar *color = NULL;
 892     gchar *clear;
 893     gchar pidcolor[10];
 894     const gchar *levelcolor;
 895
 896     color = gst_debug_construct_term_color (gst_debug_category_get_color
 897         (category));
 898     clear = "\033[00m";
 899     g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
 900     levelcolor = levelcolormap[level];
 901
 902 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
 903     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
 904         pidcolor, pid, clear, g_thread_self (), levelcolor,
 905         gst_debug_level_get_name (level), clear, color,
 906         gst_debug_category_get_name (category), file, line, function, obj,
 907         clear, gst_debug_message_get (message));
 908 #undef PRINT_FMT
 909     g_free (color);
 910 #else
 911     /* colors, windows. We take a lock to keep colors and content together.
 912      * Maybe there is a better way but for now this will do the right
 913      * thing. */
 914     static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
 915     const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
 916 #define SET_COLOR(c) \
 917   SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c));
 918     g_static_mutex_lock (&win_print_mutex);
 919     /* timestamp */
 920     g_printerr ("%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
 921     /* pid */
 922     SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
 923     g_printerr (PID_FMT, pid);
 924     /* thread */
 925     SET_COLOR (clear);
 926     g_printerr (" " PTR_FMT " ", g_thread_self ());
 927     /* level */
 928     SET_COLOR (levelcolormap[level]);
 929     g_printerr ("%s ", gst_debug_level_get_name (level));
 930     /* category */
 931     SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
 932             (category)));
 933     g_printerr (CAT_FMT, gst_debug_category_get_name (category),
 934         file, line, function, obj);
 935     /* message */
 936     SET_COLOR (clear);
 937     g_printerr (" %s\n", gst_debug_message_get (message));
 938     g_static_mutex_unlock (&win_print_mutex);
 939 #endif
 940   } else {
 941     /* no color, all platforms */
 942 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
 943     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed), pid,
 944         g_thread_self (), gst_debug_level_get_name (level),
 945         gst_debug_category_get_name (category), file, line, function, obj,
 946         gst_debug_message_get (message));
 947 #undef PRINT_FMT
 948   }
 949
 950   if (free_obj)
 951     g_free (obj);
 952 }
 953
 954 /**
 955  * gst_debug_level_get_name:
 956  * @level: the level to get the name for
 957  *
 958  * Get the string representation of a debugging level
 959  *
 960  * Returns: the name
 961  */
 962 const gchar *
 963 gst_debug_level_get_name (GstDebugLevel level)
 964 {
 965   switch (level) {
 966     case GST_LEVEL_NONE:
 967       return "";
 968     case GST_LEVEL_ERROR:
 969       return "ERROR  ";
 970     case GST_LEVEL_WARNING:
 971       return "WARN   ";
 972     case GST_LEVEL_INFO:
 973       return "INFO   ";
 974     case GST_LEVEL_DEBUG:
 975       return "DEBUG  ";
 976     case GST_LEVEL_LOG:
 977       return "LOG    ";
 978     case GST_LEVEL_FIXME:
 979       return "FIXME  ";
 980     case GST_LEVEL_MEMDUMP:
 981       return "MEMDUMP";
 982     default:
 983       g_warning ("invalid level specified for gst_debug_level_get_name");
 984       return "";
 985   }
 986 }
 987
 988 /**
 989  * gst_debug_add_log_function:
 990  * @func: the function to use
 991  * @data: user data
 992  *
 993  * Adds the logging function to the list of logging functions.
 994  * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
 995  */
 996 void
 997 gst_debug_add_log_function (GstLogFunction func, gpointer data)
 998 {
 999   LogFuncEntry *entry;
1000   GSList *list;
1001
1002   g_return_if_fail (func != NULL);
1003
1004   entry = g_new (LogFuncEntry, 1);
1005   entry->func = func;
1006   entry->user_data = data;
1007   /* FIXME: we leak the old list here - other threads might access it right now
1008    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1009    * but that is waaay costly.
1010    * It'd probably be clever to use some kind of RCU here, but I don't know
1011    * anything about that.
1012    */
1013   g_static_mutex_lock (&__log_func_mutex);
1014   list = g_slist_copy (__log_functions);
1015   __log_functions = g_slist_prepend (list, entry);
1016   g_static_mutex_unlock (&__log_func_mutex);
1017
1018   GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1019       func, data);
1020 }
1021
1022 static gint
1023 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1024 {
1025   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1026
1027   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1028 }
1029
1030 static gint
1031 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1032 {
1033   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1034
1035   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1036 }
1037
1038 static guint
1039 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1040 {
1041   GSList *found;
1042   GSList *new;
1043   guint removals = 0;
1044
1045   g_static_mutex_lock (&__log_func_mutex);
1046   new = __log_functions;
1047   while ((found = g_slist_find_custom (new, data, func))) {
1048     if (new == __log_functions) {
1049       /* make a copy when we have the first hit, so that we modify the copy and
1050        * make that the new list later */
1051       new = g_slist_copy (new);
1052       continue;
1053     }
1054     g_free (found->data);
1055     new = g_slist_delete_link (new, found);
1056     removals++;
1057   }
1058   /* FIXME: We leak the old list here. See _add_log_function for why. */
1059   __log_functions = new;
1060   g_static_mutex_unlock (&__log_func_mutex);
1061
1062   return removals;
1063 }
1064
1065 /**
1066  * gst_debug_remove_log_function:
1067  * @func: the log function to remove
1068  *
1069  * Removes all registered instances of the given logging functions.
1070  *
1071  * Returns: How many instances of the function were removed
1072  */
1073 guint
1074 gst_debug_remove_log_function (GstLogFunction func)
1075 {
1076   guint removals;
1077
1078   g_return_val_if_fail (func != NULL, 0);
1079
1080   removals =
1081       gst_debug_remove_with_compare_func
1082       (gst_debug_compare_log_function_by_func, (gpointer) func);
1083   GST_DEBUG ("removed log function %p %d times from log function list", func,
1084       removals);
1085
1086   return removals;
1087 }
1088
1089 /**
1090  * gst_debug_remove_log_function_by_data:
1091  * @data: user data of the log function to remove
1092  *
1093  * Removes all registered instances of log functions with the given user data.
1094  *
1095  * Returns: How many instances of the function were removed
1096  */
1097 guint
1098 gst_debug_remove_log_function_by_data (gpointer data)
1099 {
1100   guint removals;
1101
1102   removals =
1103       gst_debug_remove_with_compare_func
1104       (gst_debug_compare_log_function_by_data, data);
1105   GST_DEBUG
1106       ("removed %d log functions with user data %p from log function list",
1107       removals, data);
1108
1109   return removals;
1110 }
1111
1112 /**
1113  * gst_debug_set_colored:
1114  * @colored: Whether to use colored output or not
1115  *
1116  * Sets or unsets the use of coloured debugging output.
1117  */
1118 void
1119 gst_debug_set_colored (gboolean colored)
1120 {
1121   g_atomic_int_set (&__use_color, colored ? 1 : 0);
1122 }
1123
1124 /**
1125  * gst_debug_is_colored:
1126  *
1127  * Checks if the debugging output should be colored.
1128  *
1129  * Returns: TRUE, if the debug output should be colored.
1130  */
1131 gboolean
1132 gst_debug_is_colored (void)
1133 {
1134   return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
1135 }
1136
1137 /**
1138  * gst_debug_set_active:
1139  * @active: Whether to use debugging output or not
1140  *
1141  * If activated, debugging messages are sent to the debugging
1142  * handlers.
1143  * It makes sense to deactivate it for speed issues.
1144  * <note><para>This function is not threadsafe. It makes sense to only call it
1145  * during initialization.</para></note>
1146  */
1147 void
1148 gst_debug_set_active (gboolean active)
1149 {
1150   __gst_debug_enabled = active;
1151   if (active)
1152     __gst_debug_min = GST_LEVEL_COUNT;
1153   else
1154     __gst_debug_min = GST_LEVEL_NONE;
1155 }
1156
1157 /**
1158  * gst_debug_is_active:
1159  *
1160  * Checks if debugging output is activated.
1161  *
1162  * Returns: TRUE, if debugging is activated
1163  */
1164 gboolean
1165 gst_debug_is_active (void)
1166 {
1167   return __gst_debug_enabled;
1168 }
1169
1170 /**
1171  * gst_debug_set_default_threshold:
1172  * @level: level to set
1173  *
1174  * Sets the default threshold to the given level and updates all categories to
1175  * use this threshold.
1176  */
1177 void
1178 gst_debug_set_default_threshold (GstDebugLevel level)
1179 {
1180   g_atomic_int_set (&__default_level, level);
1181   gst_debug_reset_all_thresholds ();
1182 }
1183
1184 /**
1185  * gst_debug_get_default_threshold:
1186  *
1187  * Returns the default threshold that is used for new categories.
1188  *
1189  * Returns: the default threshold level
1190  */
1191 GstDebugLevel
1192 gst_debug_get_default_threshold (void)
1193 {
1194   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1195 }
1196
1197 static void
1198 gst_debug_reset_threshold (gpointer category, gpointer unused)
1199 {
1200   GstDebugCategory *cat = (GstDebugCategory *) category;
1201   GSList *walk;
1202
1203   g_static_mutex_lock (&__level_name_mutex);
1204   walk = __level_name;
1205   while (walk) {
1206     LevelNameEntry *entry = walk->data;
1207
1208     walk = g_slist_next (walk);
1209     if (g_pattern_match_string (entry->pat, cat->name)) {
1210       GST_LOG ("category %s matches pattern %p - gets set to level %d",
1211           cat->name, entry->pat, entry->level);
1212       gst_debug_category_set_threshold (cat, entry->level);
1213       goto exit;
1214     }
1215   }
1216   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1217
1218 exit:
1219   g_static_mutex_unlock (&__level_name_mutex);
1220 }
1221
1222 static void
1223 gst_debug_reset_all_thresholds (void)
1224 {
1225   g_static_mutex_lock (&__cat_mutex);
1226   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1227   g_static_mutex_unlock (&__cat_mutex);
1228 }
1229
1230 static void
1231 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1232 {
1233   GstDebugCategory *cat = (GstDebugCategory *) data;
1234   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1235
1236   if (g_pattern_match_string (entry->pat, cat->name)) {
1237     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1238         cat->name, entry->pat, entry->level);
1239     gst_debug_category_set_threshold (cat, entry->level);
1240   }
1241 }
1242
1243 /**
1244  * gst_debug_set_threshold_for_name:
1245  * @name: name of the categories to set
1246  * @level: level to set them to
1247  *
1248  * Sets all categories which match the given glob style pattern to the given
1249  * level.
1250  */
1251 void
1252 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1253 {
1254   GPatternSpec *pat;
1255   LevelNameEntry *entry;
1256
1257   g_return_if_fail (name != NULL);
1258
1259   pat = g_pattern_spec_new (name);
1260   entry = g_new (LevelNameEntry, 1);
1261   entry->pat = pat;
1262   entry->level = level;
1263   g_static_mutex_lock (&__level_name_mutex);
1264   __level_name = g_slist_prepend (__level_name, entry);
1265   g_static_mutex_unlock (&__level_name_mutex);
1266   g_static_mutex_lock (&__cat_mutex);
1267   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1268   g_static_mutex_unlock (&__cat_mutex);
1269 }
1270
1271 /**
1272  * gst_debug_unset_threshold_for_name:
1273  * @name: name of the categories to set
1274  *
1275  * Resets all categories with the given name back to the default level.
1276  */
1277 void
1278 gst_debug_unset_threshold_for_name (const gchar * name)
1279 {
1280   GSList *walk;
1281   GPatternSpec *pat;
1282
1283   g_return_if_fail (name != NULL);
1284
1285   pat = g_pattern_spec_new (name);
1286   g_static_mutex_lock (&__level_name_mutex);
1287   walk = __level_name;
1288   /* improve this if you want, it's mighty slow */
1289   while (walk) {
1290     LevelNameEntry *entry = walk->data;
1291
1292     if (g_pattern_spec_equal (entry->pat, pat)) {
1293       __level_name = g_slist_remove_link (__level_name, walk);
1294       g_pattern_spec_free (entry->pat);
1295       g_free (entry);
1296       g_slist_free_1 (walk);
1297       walk = __level_name;
1298     }
1299   }
1300   g_static_mutex_unlock (&__level_name_mutex);
1301   g_pattern_spec_free (pat);
1302   gst_debug_reset_all_thresholds ();
1303 }
1304
1305 GstDebugCategory *
1306 _gst_debug_category_new (const gchar * name, guint color,
1307     const gchar * description)
1308 {
1309   GstDebugCategory *cat;
1310
1311   g_return_val_if_fail (name != NULL, NULL);
1312
1313   cat = g_new (GstDebugCategory, 1);
1314   cat->name = g_strdup (name);
1315   cat->color = color;
1316   if (description != NULL) {
1317     cat->description = g_strdup (description);
1318   } else {
1319     cat->description = g_strdup ("no description");
1320   }
1321   g_atomic_int_set (&cat->threshold, 0);
1322   gst_debug_reset_threshold (cat, NULL);
1323
1324   /* add to category list */
1325   g_static_mutex_lock (&__cat_mutex);
1326   __categories = g_slist_prepend (__categories, cat);
1327   g_static_mutex_unlock (&__cat_mutex);
1328
1329   return cat;
1330 }
1331
1332 /**
1333  * gst_debug_category_free:
1334  * @category: #GstDebugCategory to free.
1335  *
1336  * Removes and frees the category and all associated resources.
1337  */
1338 void
1339 gst_debug_category_free (GstDebugCategory * category)
1340 {
1341   if (category == NULL)
1342     return;
1343
1344   /* remove from category list */
1345   g_static_mutex_lock (&__cat_mutex);
1346   __categories = g_slist_remove (__categories, category);
1347   g_static_mutex_unlock (&__cat_mutex);
1348
1349   g_free ((gpointer) category->name);
1350   g_free ((gpointer) category->description);
1351   g_free (category);
1352 }
1353
1354 /**
1355  * gst_debug_category_set_threshold:
1356  * @category: a #GstDebugCategory to set threshold of.
1357  * @level: the #GstDebugLevel threshold to set.
1358  *
1359  * Sets the threshold of the category to the given level. Debug information will
1360  * only be output if the threshold is lower or equal to the level of the
1361  * debugging message.
1362  * <note><para>
1363  * Do not use this function in production code, because other functions may
1364  * change the threshold of categories as side effect. It is however a nice
1365  * function to use when debugging (even from gdb).
1366  * </para></note>
1367  */
1368 void
1369 gst_debug_category_set_threshold (GstDebugCategory * category,
1370     GstDebugLevel level)
1371 {
1372   g_return_if_fail (category != NULL);
1373
1374   if (level > __gst_debug_min) {
1375     __gst_debug_enabled = TRUE;
1376     __gst_debug_min = level;
1377   }
1378
1379   g_atomic_int_set (&category->threshold, level);
1380 }
1381
1382 /**
1383  * gst_debug_category_reset_threshold:
1384  * @category: a #GstDebugCategory to reset threshold of.
1385  *
1386  * Resets the threshold of the category to the default level. Debug information
1387  * will only be output if the threshold is lower or equal to the level of the
1388  * debugging message.
1389  * Use this function to set the threshold back to where it was after using
1390  * gst_debug_category_set_threshold().
1391  */
1392 void
1393 gst_debug_category_reset_threshold (GstDebugCategory * category)
1394 {
1395   gst_debug_reset_threshold (category, NULL);
1396 }
1397
1398 /**
1399  * gst_debug_category_get_threshold:
1400  * @category: a #GstDebugCategory to get threshold of.
1401  *
1402  * Returns the threshold of a #GstDebugCategory.
1403  *
1404  * Returns: the #GstDebugLevel that is used as threshold.
1405  */
1406 GstDebugLevel
1407 gst_debug_category_get_threshold (GstDebugCategory * category)
1408 {
1409   return g_atomic_int_get (&category->threshold);
1410 }
1411
1412 /**
1413  * gst_debug_category_get_name:
1414  * @category: a #GstDebugCategory to get name of.
1415  *
1416  * Returns the name of a debug category.
1417  *
1418  * Returns: the name of the category.
1419  */
1420 const gchar *
1421 gst_debug_category_get_name (GstDebugCategory * category)
1422 {
1423   return category->name;
1424 }
1425
1426 /**
1427  * gst_debug_category_get_color:
1428  * @category: a #GstDebugCategory to get the color of.
1429  *
1430  * Returns the color of a debug category used when printing output in this
1431  * category.
1432  *
1433  * Returns: the color of the category.
1434  */
1435 guint
1436 gst_debug_category_get_color (GstDebugCategory * category)
1437 {
1438   return category->color;
1439 }
1440
1441 /**
1442  * gst_debug_category_get_description:
1443  * @category: a #GstDebugCategory to get the description of.
1444  *
1445  * Returns the description of a debug category.
1446  *
1447  * Returns: the description of the category.
1448  */
1449 const gchar *
1450 gst_debug_category_get_description (GstDebugCategory * category)
1451 {
1452   return category->description;
1453 }
1454
1455 /**
1456  * gst_debug_get_all_categories:
1457  *
1458  * Returns a snapshot of a all categories that are currently in use . This list
1459  * may change anytime.
1460  * The caller has to free the list after use.
1461  *
1462  * Returns: the list of categories
1463  */
1464 GSList *
1465 gst_debug_get_all_categories (void)
1466 {
1467   GSList *ret;
1468
1469   g_static_mutex_lock (&__cat_mutex);
1470   ret = g_slist_copy (__categories);
1471   g_static_mutex_unlock (&__cat_mutex);
1472
1473   return ret;
1474 }
1475
1476 GstDebugCategory *
1477 _gst_debug_get_category (const gchar * name)
1478 {
1479   GstDebugCategory *ret = NULL;
1480   GSList *node;
1481
1482   for (node = __categories; node; node = g_slist_next (node)) {
1483     ret = (GstDebugCategory *) node->data;
1484     if (!strcmp (name, ret->name)) {
1485       return ret;
1486     }
1487   }
1488   return NULL;
1489 }
1490
1491 /*** FUNCTION POINTERS ********************************************************/
1492
1493 static GHashTable *__gst_function_pointers;     /* NULL */
1494 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1495
1496 const gchar *
1497 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1498     G_GNUC_NO_INSTRUMENT;
1499
1500 /* This function MUST NOT return NULL */
1501      const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1502 {
1503   gchar *ptrname;
1504
1505 #ifdef HAVE_DLADDR
1506   Dl_info dl_info;
1507 #endif
1508
1509   if (G_UNLIKELY (func == NULL))
1510     return "(NULL)";
1511
1512   g_static_mutex_lock (&__dbg_functions_mutex);
1513   if (G_LIKELY (__gst_function_pointers)) {
1514     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1515     g_static_mutex_unlock (&__dbg_functions_mutex);
1516     if (G_LIKELY (ptrname))
1517       return ptrname;
1518   } else {
1519     g_static_mutex_unlock (&__dbg_functions_mutex);
1520   }
1521   /* we need to create an entry in the hash table for this one so we don't leak
1522    * the name */
1523 #ifdef HAVE_DLADDR
1524   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1525     gchar *name = g_strdup (dl_info.dli_sname);
1526
1527     _gst_debug_register_funcptr (func, name);
1528     return name;
1529   } else
1530 #endif
1531   {
1532     gchar *name = g_strdup_printf ("%p", (gpointer) func);
1533
1534     _gst_debug_register_funcptr (func, name);
1535     return name;
1536   }
1537 }
1538
1539 void
1540 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1541 {
1542   gpointer ptr = (gpointer) func;
1543
1544   g_static_mutex_lock (&__dbg_functions_mutex);
1545
1546   if (!__gst_function_pointers)
1547     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1548   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1549     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1550
1551   g_static_mutex_unlock (&__dbg_functions_mutex);
1552 }
1553
1554 /*** PRINTF EXTENSIONS ********************************************************/
1555
1556 #ifdef HAVE_PRINTF_EXTENSION
1557 static int
1558 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1559     const void *const *args)
1560 {
1561   char *buffer;
1562   int len;
1563   void *ptr;
1564
1565   buffer = NULL;
1566   ptr = *(void **) args[0];
1567
1568   buffer = gst_debug_print_object (ptr);
1569   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1570       buffer);
1571
1572   g_free (buffer);
1573   return len;
1574 }
1575
1576 static int
1577 _gst_info_printf_extension_segment (FILE * stream,
1578     const struct printf_info *info, const void *const *args)
1579 {
1580   char *buffer;
1581   int len;
1582   void *ptr;
1583
1584   buffer = NULL;
1585   ptr = *(void **) args[0];
1586
1587   buffer = gst_debug_print_segment (ptr);
1588   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1589       buffer);
1590
1591   g_free (buffer);
1592   return len;
1593 }
1594
1595 #if HAVE_REGISTER_PRINTF_SPECIFIER
1596 static int
1597 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1598     int *argtypes, int *size)
1599 #else
1600 static int
1601 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1602     int *argtypes)
1603 #endif
1604 {
1605   if (n > 0) {
1606     argtypes[0] = PA_POINTER;
1607 #if HAVE_REGISTER_PRINTF_SPECIFIER
1608     *size = sizeof (gpointer);
1609 #endif
1610   }
1611   return 1;
1612 }
1613 #endif /* HAVE_PRINTF_EXTENSION */
1614
1615 static void
1616 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1617     const guint8 * mem, gsize mem_offset, gsize mem_size)
1618 {
1619   gchar hexstr[50], ascstr[18], digitstr[4];
1620
1621   if (mem_size > 16)
1622     mem_size = 16;
1623
1624   hexstr[0] = '\0';
1625   ascstr[0] = '\0';
1626
1627   if (mem != NULL) {
1628     guint i = 0;
1629
1630     mem += mem_offset;
1631     while (i < mem_size) {
1632       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1633       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1634       g_strlcat (hexstr, digitstr, sizeof (hexstr));
1635       ++i;
1636     }
1637     ascstr[i] = '\0';
1638   }
1639
1640   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1641       (guint) mem_offset, hexstr, ascstr);
1642 }
1643
1644 void
1645 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1646     const gchar * func, gint line, GObject * obj, const gchar * msg,
1647     const guint8 * data, guint length)
1648 {
1649   guint off = 0;
1650
1651   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1652       "-------------------------------------------------------------------");
1653
1654   if (msg != NULL && *msg != '\0') {
1655     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1656   }
1657
1658   while (off < length) {
1659     gchar buf[128];
1660
1661     /* gst_info_dump_mem_line will process 16 bytes at most */
1662     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1663     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1664     off += 16;
1665   }
1666
1667   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1668       "-------------------------------------------------------------------");
1669 }
1670
1671 #else /* !GST_DISABLE_GST_DEBUG */
1672 #ifndef GST_REMOVE_DISABLED
1673
1674 GstDebugCategory *
1675 _gst_debug_category_new (const gchar * name, guint color,
1676     const gchar * description)
1677 {
1678   return NULL;
1679 }
1680
1681 void
1682 _gst_debug_register_funcptr (gpointer func, const gchar * ptrname)
1683 {
1684 }
1685
1686 /* This function MUST NOT return NULL */
1687 const gchar *
1688 _gst_debug_nameof_funcptr (gpointer func)
1689 {
1690   return "(NULL)";
1691 }
1692
1693 void
1694 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1695     const gchar * file, const gchar * function, gint line,
1696     GObject * object, const gchar * format, ...)
1697 {
1698 }
1699
1700 void
1701 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1702     const gchar * file, const gchar * function, gint line,
1703     GObject * object, const gchar * format, va_list args)
1704 {
1705 }
1706
1707 const gchar *
1708 gst_debug_message_get (GstDebugMessage * message)
1709 {
1710   return "";
1711 }
1712
1713 void
1714 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1715     const gchar * file, const gchar * function, gint line,
1716     GObject * object, GstDebugMessage * message, gpointer unused)
1717 {
1718 }
1719
1720 G_CONST_RETURN gchar *
1721 gst_debug_level_get_name (GstDebugLevel level)
1722 {
1723   return "NONE";
1724 }
1725
1726 void
1727 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1728 {
1729 }
1730
1731 guint
1732 gst_debug_remove_log_function (GstLogFunction func)
1733 {
1734   return 0;
1735 }
1736
1737 guint
1738 gst_debug_remove_log_function_by_data (gpointer data)
1739 {
1740   return 0;
1741 }
1742
1743 void
1744 gst_debug_set_active (gboolean active)
1745 {
1746 }
1747
1748 gboolean
1749 gst_debug_is_active (void)
1750 {
1751   return FALSE;
1752 }
1753
1754 void
1755 gst_debug_set_colored (gboolean colored)
1756 {
1757 }
1758
1759 gboolean
1760 gst_debug_is_colored (void)
1761 {
1762   return FALSE;
1763 }
1764
1765 void
1766 gst_debug_set_default_threshold (GstDebugLevel level)
1767 {
1768 }
1769
1770 GstDebugLevel
1771 gst_debug_get_default_threshold (void)
1772 {
1773   return GST_LEVEL_NONE;
1774 }
1775
1776 void
1777 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1778 {
1779 }
1780
1781 void
1782 gst_debug_unset_threshold_for_name (const gchar * name)
1783 {
1784 }
1785
1786 void
1787 gst_debug_category_free (GstDebugCategory * category)
1788 {
1789 }
1790
1791 void
1792 gst_debug_category_set_threshold (GstDebugCategory * category,
1793     GstDebugLevel level)
1794 {
1795 }
1796
1797 void
1798 gst_debug_category_reset_threshold (GstDebugCategory * category)
1799 {
1800 }
1801
1802 GstDebugLevel
1803 gst_debug_category_get_threshold (GstDebugCategory * category)
1804 {
1805   return GST_LEVEL_NONE;
1806 }
1807
1808 G_CONST_RETURN gchar *
1809 gst_debug_category_get_name (GstDebugCategory * category)
1810 {
1811   return "";
1812 }
1813
1814 guint
1815 gst_debug_category_get_color (GstDebugCategory * category)
1816 {
1817   return 0;
1818 }
1819
1820 G_CONST_RETURN gchar *
1821 gst_debug_category_get_description (GstDebugCategory * category)
1822 {
1823   return "";
1824 }
1825
1826 GSList *
1827 gst_debug_get_all_categories (void)
1828 {
1829   return NULL;
1830 }
1831
1832 GstDebugCategory *
1833 _gst_debug_get_category (const gchar * name)
1834 {
1835   return NULL;
1836 }
1837
1838 gchar *
1839 gst_debug_construct_term_color (guint colorinfo)
1840 {
1841   return g_strdup ("00");
1842 }
1843
1844 gint
1845 gst_debug_construct_win_color (guint colorinfo)
1846 {
1847   return 0;
1848 }
1849
1850 gboolean
1851 _priv_gst_in_valgrind (void)
1852 {
1853   return FALSE;
1854 }
1855
1856 void
1857 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1858     const gchar * func, gint line, GObject * obj, const gchar * msg,
1859     const guint8 * data, guint length)
1860 {
1861 }
1862 #endif /* GST_REMOVE_DISABLED */
1863 #endif /* GST_DISABLE_GST_DEBUG */
1864
1865
1866 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1867 /* FIXME make this thread specific */
1868 static GSList *stack_trace = NULL;
1869
1870 void
1871 __cyg_profile_func_enter (void *this_fn, void *call_site)
1872     G_GNUC_NO_INSTRUMENT;
1873      void __cyg_profile_func_enter (void *this_fn, void *call_site)
1874 {
1875   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1876   gchar *site = _gst_debug_nameof_funcptr (call_site);
1877
1878   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1879       site);
1880   stack_trace =
1881       g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1882           this_fn, name, call_site, site));
1883
1884   g_free (name);
1885   g_free (site);
1886 }
1887
1888 void
1889 __cyg_profile_func_exit (void *this_fn, void *call_site)
1890     G_GNUC_NO_INSTRUMENT;
1891      void __cyg_profile_func_exit (void *this_fn, void *call_site)
1892 {
1893   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1894
1895   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1896   g_free (stack_trace->data);
1897   stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1898
1899   g_free (name);
1900 }
1901
1902 /**
1903  * gst_debug_print_stack_trace:
1904  *
1905  * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1906  * gstreamer code, which can be printed with this function.
1907  */
1908 void
1909 gst_debug_print_stack_trace (void)
1910 {
1911   GSList *walk = stack_trace;
1912   gint count = 0;
1913
1914   if (walk)
1915     walk = g_slist_next (walk);
1916
1917   while (walk) {
1918     gchar *name = (gchar *) walk->data;
1919
1920     g_print ("#%-2d %s\n", count++, name);
1921
1922     walk = g_slist_next (walk);
1923   }
1924 }
1925 #else
1926 void
1927 gst_debug_print_stack_trace (void)
1928 {
1929   /* nothing because it's compiled out */
1930 }
1931
1932 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */