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: #gstreamer-gstconfig, #gstreamer-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 *_priv_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 #ifdef 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 #ifdef 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   _priv_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 is_colored;
 870
 871   if (level > gst_debug_category_get_threshold (category))
 872     return;
 873
 874   pid = getpid ();
 875   is_colored = gst_debug_is_colored ();
 876
 877   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
 878       gst_util_get_timestamp ());
 879
 880   if (object) {
 881     obj = gst_debug_print_object (object);
 882   } else {
 883     obj = g_strdup ("");
 884   }
 885
 886   if (is_colored) {
 887 #ifndef G_OS_WIN32
 888     /* colors, non-windows */
 889     gchar *color = NULL;
 890     const gchar *clear;
 891     gchar pidcolor[10];
 892     const gchar *levelcolor;
 893
 894     color = gst_debug_construct_term_color (gst_debug_category_get_color
 895         (category));
 896     clear = "\033[00m";
 897     g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
 898     levelcolor = levelcolormap[level];
 899
 900 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
 901     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
 902         pidcolor, pid, clear, g_thread_self (), levelcolor,
 903         gst_debug_level_get_name (level), clear, color,
 904         gst_debug_category_get_name (category), file, line, function, obj,
 905         clear, gst_debug_message_get (message));
 906 #undef PRINT_FMT
 907     g_free (color);
 908 #else
 909     /* colors, windows. We take a lock to keep colors and content together.
 910      * Maybe there is a better way but for now this will do the right
 911      * thing. */
 912     static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
 913     const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
 914 #define SET_COLOR(c) \
 915   SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c));
 916     g_static_mutex_lock (&win_print_mutex);
 917     /* timestamp */
 918     g_printerr ("%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
 919     /* pid */
 920     SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
 921     g_printerr (PID_FMT, pid);
 922     /* thread */
 923     SET_COLOR (clear);
 924     g_printerr (" " PTR_FMT " ", g_thread_self ());
 925     /* level */
 926     SET_COLOR (levelcolormap[level]);
 927     g_printerr ("%s ", gst_debug_level_get_name (level));
 928     /* category */
 929     SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
 930             (category)));
 931     g_printerr (CAT_FMT, gst_debug_category_get_name (category),
 932         file, line, function, obj);
 933     /* message */
 934     SET_COLOR (clear);
 935     g_printerr (" %s\n", gst_debug_message_get (message));
 936     g_static_mutex_unlock (&win_print_mutex);
 937 #endif
 938   } else {
 939     /* no color, all platforms */
 940 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
 941     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed), pid,
 942         g_thread_self (), gst_debug_level_get_name (level),
 943         gst_debug_category_get_name (category), file, line, function, obj,
 944         gst_debug_message_get (message));
 945 #undef PRINT_FMT
 946   }
 947
 948   g_free (obj);
 949 }
 950
 951 /**
 952  * gst_debug_level_get_name:
 953  * @level: the level to get the name for
 954  *
 955  * Get the string representation of a debugging level
 956  *
 957  * Returns: the name
 958  */
 959 const gchar *
 960 gst_debug_level_get_name (GstDebugLevel level)
 961 {
 962   switch (level) {
 963     case GST_LEVEL_NONE:
 964       return "";
 965     case GST_LEVEL_ERROR:
 966       return "ERROR  ";
 967     case GST_LEVEL_WARNING:
 968       return "WARN   ";
 969     case GST_LEVEL_INFO:
 970       return "INFO   ";
 971     case GST_LEVEL_DEBUG:
 972       return "DEBUG  ";
 973     case GST_LEVEL_LOG:
 974       return "LOG    ";
 975     case GST_LEVEL_FIXME:
 976       return "FIXME  ";
 977     case GST_LEVEL_MEMDUMP:
 978       return "MEMDUMP";
 979     default:
 980       g_warning ("invalid level specified for gst_debug_level_get_name");
 981       return "";
 982   }
 983 }
 984
 985 /**
 986  * gst_debug_add_log_function:
 987  * @func: the function to use
 988  * @data: user data
 989  *
 990  * Adds the logging function to the list of logging functions.
 991  * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
 992  */
 993 void
 994 gst_debug_add_log_function (GstLogFunction func, gpointer data)
 995 {
 996   LogFuncEntry *entry;
 997   GSList *list;
 998
 999   g_return_if_fail (func != NULL);
1000
1001   entry = g_new (LogFuncEntry, 1);
1002   entry->func = func;
1003   entry->user_data = data;
1004   /* FIXME: we leak the old list here - other threads might access it right now
1005    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1006    * but that is waaay costly.
1007    * It'd probably be clever to use some kind of RCU here, but I don't know
1008    * anything about that.
1009    */
1010   g_static_mutex_lock (&__log_func_mutex);
1011   list = g_slist_copy (__log_functions);
1012   __log_functions = g_slist_prepend (list, entry);
1013   g_static_mutex_unlock (&__log_func_mutex);
1014
1015   GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1016       func, data);
1017 }
1018
1019 static gint
1020 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1021 {
1022   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1023
1024   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1025 }
1026
1027 static gint
1028 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1029 {
1030   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1031
1032   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1033 }
1034
1035 static guint
1036 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1037 {
1038   GSList *found;
1039   GSList *new;
1040   guint removals = 0;
1041
1042   g_static_mutex_lock (&__log_func_mutex);
1043   new = __log_functions;
1044   while ((found = g_slist_find_custom (new, data, func))) {
1045     if (new == __log_functions) {
1046       /* make a copy when we have the first hit, so that we modify the copy and
1047        * make that the new list later */
1048       new = g_slist_copy (new);
1049       continue;
1050     }
1051     g_free (found->data);
1052     new = g_slist_delete_link (new, found);
1053     removals++;
1054   }
1055   /* FIXME: We leak the old list here. See _add_log_function for why. */
1056   __log_functions = new;
1057   g_static_mutex_unlock (&__log_func_mutex);
1058
1059   return removals;
1060 }
1061
1062 /**
1063  * gst_debug_remove_log_function:
1064  * @func: the log function to remove
1065  *
1066  * Removes all registered instances of the given logging functions.
1067  *
1068  * Returns: How many instances of the function were removed
1069  */
1070 guint
1071 gst_debug_remove_log_function (GstLogFunction func)
1072 {
1073   guint removals;
1074
1075   g_return_val_if_fail (func != NULL, 0);
1076
1077   removals =
1078       gst_debug_remove_with_compare_func
1079       (gst_debug_compare_log_function_by_func, (gpointer) func);
1080   GST_DEBUG ("removed log function %p %d times from log function list", func,
1081       removals);
1082
1083   return removals;
1084 }
1085
1086 /**
1087  * gst_debug_remove_log_function_by_data:
1088  * @data: user data of the log function to remove
1089  *
1090  * Removes all registered instances of log functions with the given user data.
1091  *
1092  * Returns: How many instances of the function were removed
1093  */
1094 guint
1095 gst_debug_remove_log_function_by_data (gpointer data)
1096 {
1097   guint removals;
1098
1099   removals =
1100       gst_debug_remove_with_compare_func
1101       (gst_debug_compare_log_function_by_data, data);
1102   GST_DEBUG
1103       ("removed %d log functions with user data %p from log function list",
1104       removals, data);
1105
1106   return removals;
1107 }
1108
1109 /**
1110  * gst_debug_set_colored:
1111  * @colored: Whether to use colored output or not
1112  *
1113  * Sets or unsets the use of coloured debugging output.
1114  */
1115 void
1116 gst_debug_set_colored (gboolean colored)
1117 {
1118   g_atomic_int_set (&__use_color, colored ? 1 : 0);
1119 }
1120
1121 /**
1122  * gst_debug_is_colored:
1123  *
1124  * Checks if the debugging output should be colored.
1125  *
1126  * Returns: TRUE, if the debug output should be colored.
1127  */
1128 gboolean
1129 gst_debug_is_colored (void)
1130 {
1131   return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
1132 }
1133
1134 /**
1135  * gst_debug_set_active:
1136  * @active: Whether to use debugging output or not
1137  *
1138  * If activated, debugging messages are sent to the debugging
1139  * handlers.
1140  * It makes sense to deactivate it for speed issues.
1141  * <note><para>This function is not threadsafe. It makes sense to only call it
1142  * during initialization.</para></note>
1143  */
1144 void
1145 gst_debug_set_active (gboolean active)
1146 {
1147   __gst_debug_enabled = active;
1148   if (active)
1149     __gst_debug_min = GST_LEVEL_COUNT;
1150   else
1151     __gst_debug_min = GST_LEVEL_NONE;
1152 }
1153
1154 /**
1155  * gst_debug_is_active:
1156  *
1157  * Checks if debugging output is activated.
1158  *
1159  * Returns: TRUE, if debugging is activated
1160  */
1161 gboolean
1162 gst_debug_is_active (void)
1163 {
1164   return __gst_debug_enabled;
1165 }
1166
1167 /**
1168  * gst_debug_set_default_threshold:
1169  * @level: level to set
1170  *
1171  * Sets the default threshold to the given level and updates all categories to
1172  * use this threshold.
1173  */
1174 void
1175 gst_debug_set_default_threshold (GstDebugLevel level)
1176 {
1177   g_atomic_int_set (&__default_level, level);
1178   gst_debug_reset_all_thresholds ();
1179 }
1180
1181 /**
1182  * gst_debug_get_default_threshold:
1183  *
1184  * Returns the default threshold that is used for new categories.
1185  *
1186  * Returns: the default threshold level
1187  */
1188 GstDebugLevel
1189 gst_debug_get_default_threshold (void)
1190 {
1191   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1192 }
1193
1194 static void
1195 gst_debug_reset_threshold (gpointer category, gpointer unused)
1196 {
1197   GstDebugCategory *cat = (GstDebugCategory *) category;
1198   GSList *walk;
1199
1200   g_static_mutex_lock (&__level_name_mutex);
1201   walk = __level_name;
1202   while (walk) {
1203     LevelNameEntry *entry = walk->data;
1204
1205     walk = g_slist_next (walk);
1206     if (g_pattern_match_string (entry->pat, cat->name)) {
1207       GST_LOG ("category %s matches pattern %p - gets set to level %d",
1208           cat->name, entry->pat, entry->level);
1209       gst_debug_category_set_threshold (cat, entry->level);
1210       goto exit;
1211     }
1212   }
1213   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1214
1215 exit:
1216   g_static_mutex_unlock (&__level_name_mutex);
1217 }
1218
1219 static void
1220 gst_debug_reset_all_thresholds (void)
1221 {
1222   g_static_mutex_lock (&__cat_mutex);
1223   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1224   g_static_mutex_unlock (&__cat_mutex);
1225 }
1226
1227 static void
1228 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1229 {
1230   GstDebugCategory *cat = (GstDebugCategory *) data;
1231   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1232
1233   if (g_pattern_match_string (entry->pat, cat->name)) {
1234     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1235         cat->name, entry->pat, entry->level);
1236     gst_debug_category_set_threshold (cat, entry->level);
1237   }
1238 }
1239
1240 /**
1241  * gst_debug_set_threshold_for_name:
1242  * @name: name of the categories to set
1243  * @level: level to set them to
1244  *
1245  * Sets all categories which match the given glob style pattern to the given
1246  * level.
1247  */
1248 void
1249 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1250 {
1251   GPatternSpec *pat;
1252   LevelNameEntry *entry;
1253
1254   g_return_if_fail (name != NULL);
1255
1256   pat = g_pattern_spec_new (name);
1257   entry = g_new (LevelNameEntry, 1);
1258   entry->pat = pat;
1259   entry->level = level;
1260   g_static_mutex_lock (&__level_name_mutex);
1261   __level_name = g_slist_prepend (__level_name, entry);
1262   g_static_mutex_unlock (&__level_name_mutex);
1263   g_static_mutex_lock (&__cat_mutex);
1264   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1265   g_static_mutex_unlock (&__cat_mutex);
1266 }
1267
1268 /**
1269  * gst_debug_unset_threshold_for_name:
1270  * @name: name of the categories to set
1271  *
1272  * Resets all categories with the given name back to the default level.
1273  */
1274 void
1275 gst_debug_unset_threshold_for_name (const gchar * name)
1276 {
1277   GSList *walk;
1278   GPatternSpec *pat;
1279
1280   g_return_if_fail (name != NULL);
1281
1282   pat = g_pattern_spec_new (name);
1283   g_static_mutex_lock (&__level_name_mutex);
1284   walk = __level_name;
1285   /* improve this if you want, it's mighty slow */
1286   while (walk) {
1287     LevelNameEntry *entry = walk->data;
1288
1289     if (g_pattern_spec_equal (entry->pat, pat)) {
1290       __level_name = g_slist_remove_link (__level_name, walk);
1291       g_pattern_spec_free (entry->pat);
1292       g_free (entry);
1293       g_slist_free_1 (walk);
1294       walk = __level_name;
1295     }
1296   }
1297   g_static_mutex_unlock (&__level_name_mutex);
1298   g_pattern_spec_free (pat);
1299   gst_debug_reset_all_thresholds ();
1300 }
1301
1302 GstDebugCategory *
1303 _gst_debug_category_new (const gchar * name, guint color,
1304     const gchar * description)
1305 {
1306   GstDebugCategory *cat;
1307
1308   g_return_val_if_fail (name != NULL, NULL);
1309
1310   cat = g_new (GstDebugCategory, 1);
1311   cat->name = g_strdup (name);
1312   cat->color = color;
1313   if (description != NULL) {
1314     cat->description = g_strdup (description);
1315   } else {
1316     cat->description = g_strdup ("no description");
1317   }
1318   g_atomic_int_set (&cat->threshold, 0);
1319   gst_debug_reset_threshold (cat, NULL);
1320
1321   /* add to category list */
1322   g_static_mutex_lock (&__cat_mutex);
1323   __categories = g_slist_prepend (__categories, cat);
1324   g_static_mutex_unlock (&__cat_mutex);
1325
1326   return cat;
1327 }
1328
1329 /**
1330  * gst_debug_category_free:
1331  * @category: #GstDebugCategory to free.
1332  *
1333  * Removes and frees the category and all associated resources.
1334  */
1335 void
1336 gst_debug_category_free (GstDebugCategory * category)
1337 {
1338   if (category == NULL)
1339     return;
1340
1341   /* remove from category list */
1342   g_static_mutex_lock (&__cat_mutex);
1343   __categories = g_slist_remove (__categories, category);
1344   g_static_mutex_unlock (&__cat_mutex);
1345
1346   g_free ((gpointer) category->name);
1347   g_free ((gpointer) category->description);
1348   g_free (category);
1349 }
1350
1351 /**
1352  * gst_debug_category_set_threshold:
1353  * @category: a #GstDebugCategory to set threshold of.
1354  * @level: the #GstDebugLevel threshold to set.
1355  *
1356  * Sets the threshold of the category to the given level. Debug information will
1357  * only be output if the threshold is lower or equal to the level of the
1358  * debugging message.
1359  * <note><para>
1360  * Do not use this function in production code, because other functions may
1361  * change the threshold of categories as side effect. It is however a nice
1362  * function to use when debugging (even from gdb).
1363  * </para></note>
1364  */
1365 void
1366 gst_debug_category_set_threshold (GstDebugCategory * category,
1367     GstDebugLevel level)
1368 {
1369   g_return_if_fail (category != NULL);
1370
1371   if (level > __gst_debug_min) {
1372     __gst_debug_enabled = TRUE;
1373     __gst_debug_min = level;
1374   }
1375
1376   g_atomic_int_set (&category->threshold, level);
1377 }
1378
1379 /**
1380  * gst_debug_category_reset_threshold:
1381  * @category: a #GstDebugCategory to reset threshold of.
1382  *
1383  * Resets the threshold of the category to the default level. Debug information
1384  * will only be output if the threshold is lower or equal to the level of the
1385  * debugging message.
1386  * Use this function to set the threshold back to where it was after using
1387  * gst_debug_category_set_threshold().
1388  */
1389 void
1390 gst_debug_category_reset_threshold (GstDebugCategory * category)
1391 {
1392   gst_debug_reset_threshold (category, NULL);
1393 }
1394
1395 /**
1396  * gst_debug_category_get_threshold:
1397  * @category: a #GstDebugCategory to get threshold of.
1398  *
1399  * Returns the threshold of a #GstDebugCategory.
1400  *
1401  * Returns: the #GstDebugLevel that is used as threshold.
1402  */
1403 GstDebugLevel
1404 gst_debug_category_get_threshold (GstDebugCategory * category)
1405 {
1406   return g_atomic_int_get (&category->threshold);
1407 }
1408
1409 /**
1410  * gst_debug_category_get_name:
1411  * @category: a #GstDebugCategory to get name of.
1412  *
1413  * Returns the name of a debug category.
1414  *
1415  * Returns: the name of the category.
1416  */
1417 const gchar *
1418 gst_debug_category_get_name (GstDebugCategory * category)
1419 {
1420   return category->name;
1421 }
1422
1423 /**
1424  * gst_debug_category_get_color:
1425  * @category: a #GstDebugCategory to get the color of.
1426  *
1427  * Returns the color of a debug category used when printing output in this
1428  * category.
1429  *
1430  * Returns: the color of the category.
1431  */
1432 guint
1433 gst_debug_category_get_color (GstDebugCategory * category)
1434 {
1435   return category->color;
1436 }
1437
1438 /**
1439  * gst_debug_category_get_description:
1440  * @category: a #GstDebugCategory to get the description of.
1441  *
1442  * Returns the description of a debug category.
1443  *
1444  * Returns: the description of the category.
1445  */
1446 const gchar *
1447 gst_debug_category_get_description (GstDebugCategory * category)
1448 {
1449   return category->description;
1450 }
1451
1452 /**
1453  * gst_debug_get_all_categories:
1454  *
1455  * Returns a snapshot of a all categories that are currently in use . This list
1456  * may change anytime.
1457  * The caller has to free the list after use.
1458  *
1459  * Returns: the list of categories
1460  */
1461 GSList *
1462 gst_debug_get_all_categories (void)
1463 {
1464   GSList *ret;
1465
1466   g_static_mutex_lock (&__cat_mutex);
1467   ret = g_slist_copy (__categories);
1468   g_static_mutex_unlock (&__cat_mutex);
1469
1470   return ret;
1471 }
1472
1473 GstDebugCategory *
1474 _gst_debug_get_category (const gchar * name)
1475 {
1476   GstDebugCategory *ret = NULL;
1477   GSList *node;
1478
1479   for (node = __categories; node; node = g_slist_next (node)) {
1480     ret = (GstDebugCategory *) node->data;
1481     if (!strcmp (name, ret->name)) {
1482       return ret;
1483     }
1484   }
1485   return NULL;
1486 }
1487
1488 /*** FUNCTION POINTERS ********************************************************/
1489
1490 static GHashTable *__gst_function_pointers;     /* NULL */
1491 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1492
1493 /* This function MUST NOT return NULL */
1494 const gchar *
1495 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1496 {
1497   gchar *ptrname;
1498
1499 #ifdef HAVE_DLADDR
1500   Dl_info dl_info;
1501 #endif
1502
1503   if (G_UNLIKELY (func == NULL))
1504     return "(NULL)";
1505
1506   g_static_mutex_lock (&__dbg_functions_mutex);
1507   if (G_LIKELY (__gst_function_pointers)) {
1508     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1509     g_static_mutex_unlock (&__dbg_functions_mutex);
1510     if (G_LIKELY (ptrname))
1511       return ptrname;
1512   } else {
1513     g_static_mutex_unlock (&__dbg_functions_mutex);
1514   }
1515   /* we need to create an entry in the hash table for this one so we don't leak
1516    * the name */
1517 #ifdef HAVE_DLADDR
1518   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1519     gchar *name = g_strdup (dl_info.dli_sname);
1520
1521     _gst_debug_register_funcptr (func, name);
1522     return name;
1523   } else
1524 #endif
1525   {
1526     gchar *name = g_strdup_printf ("%p", (gpointer) func);
1527
1528     _gst_debug_register_funcptr (func, name);
1529     return name;
1530   }
1531 }
1532
1533 void
1534 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1535 {
1536   gpointer ptr = (gpointer) func;
1537
1538   g_static_mutex_lock (&__dbg_functions_mutex);
1539
1540   if (!__gst_function_pointers)
1541     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1542   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1543     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1544
1545   g_static_mutex_unlock (&__dbg_functions_mutex);
1546 }
1547
1548 /*** PRINTF EXTENSIONS ********************************************************/
1549
1550 #ifdef HAVE_PRINTF_EXTENSION
1551 static int
1552 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1553     const void *const *args)
1554 {
1555   char *buffer;
1556   int len;
1557   void *ptr;
1558
1559   buffer = NULL;
1560   ptr = *(void **) args[0];
1561
1562   buffer = gst_debug_print_object (ptr);
1563   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1564       buffer);
1565
1566   g_free (buffer);
1567   return len;
1568 }
1569
1570 static int
1571 _gst_info_printf_extension_segment (FILE * stream,
1572     const struct printf_info *info, const void *const *args)
1573 {
1574   char *buffer;
1575   int len;
1576   void *ptr;
1577
1578   buffer = NULL;
1579   ptr = *(void **) args[0];
1580
1581   buffer = gst_debug_print_segment (ptr);
1582   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1583       buffer);
1584
1585   g_free (buffer);
1586   return len;
1587 }
1588
1589 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1590 static int
1591 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1592     int *argtypes, int *size)
1593 #else
1594 static int
1595 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1596     int *argtypes)
1597 #endif
1598 {
1599   if (n > 0) {
1600     argtypes[0] = PA_POINTER;
1601 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1602     *size = sizeof (gpointer);
1603 #endif
1604   }
1605   return 1;
1606 }
1607 #endif /* HAVE_PRINTF_EXTENSION */
1608
1609 static void
1610 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1611     const guint8 * mem, gsize mem_offset, gsize mem_size)
1612 {
1613   gchar hexstr[50], ascstr[18], digitstr[4];
1614
1615   if (mem_size > 16)
1616     mem_size = 16;
1617
1618   hexstr[0] = '\0';
1619   ascstr[0] = '\0';
1620
1621   if (mem != NULL) {
1622     guint i = 0;
1623
1624     mem += mem_offset;
1625     while (i < mem_size) {
1626       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1627       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1628       g_strlcat (hexstr, digitstr, sizeof (hexstr));
1629       ++i;
1630     }
1631     ascstr[i] = '\0';
1632   }
1633
1634   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1635       (guint) mem_offset, hexstr, ascstr);
1636 }
1637
1638 void
1639 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1640     const gchar * func, gint line, GObject * obj, const gchar * msg,
1641     const guint8 * data, guint length)
1642 {
1643   guint off = 0;
1644
1645   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1646       "-------------------------------------------------------------------");
1647
1648   if (msg != NULL && *msg != '\0') {
1649     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1650   }
1651
1652   while (off < length) {
1653     gchar buf[128];
1654
1655     /* gst_info_dump_mem_line will process 16 bytes at most */
1656     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1657     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1658     off += 16;
1659   }
1660
1661   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1662       "-------------------------------------------------------------------");
1663 }
1664
1665 #else /* !GST_DISABLE_GST_DEBUG */
1666 #ifndef GST_REMOVE_DISABLED
1667
1668 GstDebugCategory *
1669 _gst_debug_category_new (const gchar * name, guint color,
1670     const gchar * description)
1671 {
1672   return NULL;
1673 }
1674
1675 void
1676 _gst_debug_register_funcptr (gpointer func, const gchar * ptrname)
1677 {
1678 }
1679
1680 /* This function MUST NOT return NULL */
1681 const gchar *
1682 _gst_debug_nameof_funcptr (gpointer func)
1683 {
1684   return "(NULL)";
1685 }
1686
1687 void
1688 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1689     const gchar * file, const gchar * function, gint line,
1690     GObject * object, const gchar * format, ...)
1691 {
1692 }
1693
1694 void
1695 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1696     const gchar * file, const gchar * function, gint line,
1697     GObject * object, const gchar * format, va_list args)
1698 {
1699 }
1700
1701 const gchar *
1702 gst_debug_message_get (GstDebugMessage * message)
1703 {
1704   return "";
1705 }
1706
1707 void
1708 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1709     const gchar * file, const gchar * function, gint line,
1710     GObject * object, GstDebugMessage * message, gpointer unused)
1711 {
1712 }
1713
1714 G_CONST_RETURN gchar *
1715 gst_debug_level_get_name (GstDebugLevel level)
1716 {
1717   return "NONE";
1718 }
1719
1720 void
1721 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1722 {
1723 }
1724
1725 guint
1726 gst_debug_remove_log_function (GstLogFunction func)
1727 {
1728   return 0;
1729 }
1730
1731 guint
1732 gst_debug_remove_log_function_by_data (gpointer data)
1733 {
1734   return 0;
1735 }
1736
1737 void
1738 gst_debug_set_active (gboolean active)
1739 {
1740 }
1741
1742 gboolean
1743 gst_debug_is_active (void)
1744 {
1745   return FALSE;
1746 }
1747
1748 void
1749 gst_debug_set_colored (gboolean colored)
1750 {
1751 }
1752
1753 gboolean
1754 gst_debug_is_colored (void)
1755 {
1756   return FALSE;
1757 }
1758
1759 void
1760 gst_debug_set_default_threshold (GstDebugLevel level)
1761 {
1762 }
1763
1764 GstDebugLevel
1765 gst_debug_get_default_threshold (void)
1766 {
1767   return GST_LEVEL_NONE;
1768 }
1769
1770 void
1771 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1772 {
1773 }
1774
1775 void
1776 gst_debug_unset_threshold_for_name (const gchar * name)
1777 {
1778 }
1779
1780 void
1781 gst_debug_category_free (GstDebugCategory * category)
1782 {
1783 }
1784
1785 void
1786 gst_debug_category_set_threshold (GstDebugCategory * category,
1787     GstDebugLevel level)
1788 {
1789 }
1790
1791 void
1792 gst_debug_category_reset_threshold (GstDebugCategory * category)
1793 {
1794 }
1795
1796 GstDebugLevel
1797 gst_debug_category_get_threshold (GstDebugCategory * category)
1798 {
1799   return GST_LEVEL_NONE;
1800 }
1801
1802 G_CONST_RETURN gchar *
1803 gst_debug_category_get_name (GstDebugCategory * category)
1804 {
1805   return "";
1806 }
1807
1808 guint
1809 gst_debug_category_get_color (GstDebugCategory * category)
1810 {
1811   return 0;
1812 }
1813
1814 G_CONST_RETURN gchar *
1815 gst_debug_category_get_description (GstDebugCategory * category)
1816 {
1817   return "";
1818 }
1819
1820 GSList *
1821 gst_debug_get_all_categories (void)
1822 {
1823   return NULL;
1824 }
1825
1826 GstDebugCategory *
1827 _gst_debug_get_category (const gchar * name)
1828 {
1829   return NULL;
1830 }
1831
1832 gchar *
1833 gst_debug_construct_term_color (guint colorinfo)
1834 {
1835   return g_strdup ("00");
1836 }
1837
1838 gint
1839 gst_debug_construct_win_color (guint colorinfo)
1840 {
1841   return 0;
1842 }
1843
1844 gboolean
1845 _priv_gst_in_valgrind (void)
1846 {
1847   return FALSE;
1848 }
1849
1850 void
1851 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1852     const gchar * func, gint line, GObject * obj, const gchar * msg,
1853     const guint8 * data, guint length)
1854 {
1855 }
1856 #endif /* GST_REMOVE_DISABLED */
1857 #endif /* GST_DISABLE_GST_DEBUG */
1858
1859
1860 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1861 /* FIXME make this thread specific */
1862 static GSList *stack_trace = NULL;
1863
1864 void
1865 __cyg_profile_func_enter (void *this_fn, void *call_site)
1866     G_GNUC_NO_INSTRUMENT;
1867      void __cyg_profile_func_enter (void *this_fn, void *call_site)
1868 {
1869   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1870   gchar *site = _gst_debug_nameof_funcptr (call_site);
1871
1872   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1873       site);
1874   stack_trace =
1875       g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1876           this_fn, name, call_site, site));
1877
1878   g_free (name);
1879   g_free (site);
1880 }
1881
1882 void
1883 __cyg_profile_func_exit (void *this_fn, void *call_site)
1884     G_GNUC_NO_INSTRUMENT;
1885      void __cyg_profile_func_exit (void *this_fn, void *call_site)
1886 {
1887   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1888
1889   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1890   g_free (stack_trace->data);
1891   stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1892
1893   g_free (name);
1894 }
1895
1896 /**
1897  * gst_debug_print_stack_trace:
1898  *
1899  * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1900  * gstreamer code, which can be printed with this function.
1901  */
1902 void
1903 gst_debug_print_stack_trace (void)
1904 {
1905   GSList *walk = stack_trace;
1906   gint count = 0;
1907
1908   if (walk)
1909     walk = g_slist_next (walk);
1910
1911   while (walk) {
1912     gchar *name = (gchar *) walk->data;
1913
1914     g_print ("#%-2d %s\n", count++, name);
1915
1916     walk = g_slist_next (walk);
1917   }
1918 }
1919 #else
1920 void
1921 gst_debug_print_stack_trace (void)
1922 {
1923   /* nothing because it's compiled out */
1924 }
1925
1926 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */