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