gst/gstinfo.c

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