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