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 const gchar *
 324 gst_debug_message_get (GstDebugMessage * message)
 325 {
 326   if (message->message == NULL) {
 327     message->message = g_strdup_vprintf (message->format, message->arguments);
 328   }
 329   return message->message;
 330 }
 331
 332
 333 static gchar *
 334 gst_debug_print_object (gpointer ptr)
 335 {
 336   GObject *object = (GObject *) ptr;
 337
 338 #ifdef unused
 339   /* This is a cute trick to detect unmapped memory, but is unportable,
 340    * slow, screws around with madvise, and not actually that useful. */
 341   {
 342     int ret;
 343
 344     ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
 345     if (ret == -1 && errno == ENOMEM) {
 346       buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
 347     }
 348   }
 349 #endif
 350
 351   /* nicely printed object */
 352   if (object == NULL) {
 353     return g_strdup ("(NULL)");
 354   }
 355   if (*(GType *) ptr == GST_TYPE_CAPS) {
 356     return gst_caps_to_string ((GstCaps *) ptr);
 357   }
 358   if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
 359     return gst_structure_to_string ((GstStructure *) ptr);
 360   }
 361 #ifdef USE_POISONING
 362   if (*(guint32 *) ptr == 0xffffffff) {
 363     return g_strdup_printf ("<poisoned@%p>", ptr);
 364   }
 365 #endif
 366   if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
 367     return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
 368   }
 369   if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
 370     return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
 371   }
 372   if (G_IS_OBJECT (object)) {
 373     return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
 374   }
 375
 376   return g_strdup_printf ("%p", ptr);
 377 }
 378
 379 /**
 380  * gst_debug_construct_term_color:
 381  * @colorinfo: the color info
 382  *
 383  * Constructs a string that can be used for getting the desired color in color
 384  * terminals.
 385  * You need to free the string after use.
 386  *
 387  * Returns: a string containing the color definition
 388  */
 389 gchar *
 390 gst_debug_construct_term_color (guint colorinfo)
 391 {
 392   GString *color;
 393   gchar *ret;
 394
 395   color = g_string_new ("\033[00");
 396
 397   if (colorinfo & GST_DEBUG_BOLD) {
 398     g_string_append (color, ";01");
 399   }
 400   if (colorinfo & GST_DEBUG_UNDERLINE) {
 401     g_string_append (color, ";04");
 402   }
 403   if (colorinfo & GST_DEBUG_FG_MASK) {
 404     g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
 405   }
 406   if (colorinfo & GST_DEBUG_BG_MASK) {
 407     g_string_append_printf (color, ";4%1d",
 408         (colorinfo & GST_DEBUG_BG_MASK) >> 4);
 409   }
 410   g_string_append (color, "m");
 411
 412   ret = color->str;
 413   g_string_free (color, FALSE);
 414   return ret;
 415 }
 416
 417 /**
 418  * gst_debug_log_default:
 419  * @category: category to log
 420  * @level: level of the message
 421  * @file: the file that emitted the message, usually the __FILE__ identifier
 422  * @function: the function that emitted the message
 423  * @line: the line from that the message was emitted, usually __LINE__
 424  * @message: the actual message
 425  * @object: the object this message relates to or NULL if none
 426  * @unused: an unused variable, reserved for some user_data.
 427  *
 428  * The default logging handler used by GStreamer. Logging functions get called
 429  * whenever a macro like GST_DEBUG or similar is used. This function outputs the
 430  * message and additional info using the glib error handler.
 431  * You can add other handlers by using #gst_debug_add_log_function.
 432  * And you can remove this handler by calling
 433  * gst_debug_remove_log_function (gst_debug_log_default);
 434  */
 435 void
 436 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
 437     const gchar * file, const gchar * function, gint line,
 438     GObject * object, GstDebugMessage * message, gpointer unused)
 439 {
 440   gchar *color;
 441   gchar *clear;
 442   gchar *obj;
 443   gchar *pidcolor;
 444   gint pid;
 445
 446   if (level > gst_debug_category_get_threshold (category))
 447     return;
 448
 449   pid = getpid ();
 450
 451   /* color info */
 452   if (gst_debug_is_colored ()) {
 453     color =
 454         gst_debug_construct_term_color (gst_debug_category_get_color
 455         (category));
 456     clear = "\033[00m";
 457     pidcolor = g_strdup_printf ("\033[3%1dm", pid % 6 + 31);
 458   } else {
 459     color = g_strdup ("");
 460     clear = "";
 461     pidcolor = g_strdup ("");
 462   }
 463
 464   obj = object ? gst_debug_print_object (object) : g_strdup ("");
 465
 466   g_printerr ("%s %s%15s%s(%s%5d%s) %s%s(%d):%s:%s%s %s\n",
 467       gst_debug_level_get_name (level),
 468       color, gst_debug_category_get_name (category), clear,
 469       pidcolor, pid, clear,
 470       color, file, line, function, obj, clear, gst_debug_message_get (message));
 471
 472   g_free (color);
 473   g_free (pidcolor);
 474   g_free (obj);
 475 }
 476
 477 /**
 478  * gst_debug_level_get_name:
 479  * @level: the level to get the name for
 480  *
 481  * Get the string trepresentation of a debugging level
 482  *
 483  * Returns: the name
 484  */
 485 const gchar *
 486 gst_debug_level_get_name (GstDebugLevel level)
 487 {
 488   switch (level) {
 489     case GST_LEVEL_NONE:
 490       return "";
 491     case GST_LEVEL_ERROR:
 492       return "ERROR";
 493     case GST_LEVEL_WARNING:
 494       return "WARN ";
 495     case GST_LEVEL_INFO:
 496       return "INFO ";
 497     case GST_LEVEL_DEBUG:
 498       return "DEBUG";
 499     case GST_LEVEL_LOG:
 500       return "LOG  ";
 501     default:
 502       g_warning ("invalid level specified for gst_debug_level_get_name");
 503       return "";
 504   }
 505 }
 506
 507 /**
 508  * gst_debug_add_log_function:
 509  * @func: the function to use
 510  * @data: user data
 511  *
 512  * Adds the logging function to the list of logging functions.
 513  * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
 514  */
 515 void
 516 gst_debug_add_log_function (GstLogFunction func, gpointer data)
 517 {
 518   LogFuncEntry *entry;
 519   GSList *list;
 520
 521   g_return_if_fail (func != NULL);
 522
 523   entry = g_new (LogFuncEntry, 1);
 524   entry->func = func;
 525   entry->user_data = data;
 526   /* FIXME: we leak the old list here - other threads might access it right now
 527    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
 528    * but that is waaay costly.
 529    * It'd probably be clever to use some kind of RCU here, but I don't know
 530    * anything about that.
 531    */
 532   g_static_mutex_lock (&__log_func_mutex);
 533   list = g_slist_copy (__log_functions);
 534   __log_functions = g_slist_prepend (list, entry);
 535   g_static_mutex_unlock (&__log_func_mutex);
 536
 537   GST_DEBUG ("prepended log function %p (user data %p) to log functions",
 538       func, data);
 539 }
 540
 541 static gint
 542 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
 543 {
 544   gpointer entryfunc = ((LogFuncEntry *) entry)->func;
 545
 546   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
 547 }
 548
 549 static gint
 550 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
 551 {
 552   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
 553
 554   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
 555 }
 556
 557 static guint
 558 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
 559 {
 560   GSList *found;
 561   GSList *new;
 562   guint removals = 0;
 563
 564   g_static_mutex_lock (&__log_func_mutex);
 565   new = __log_functions;
 566   while ((found = g_slist_find_custom (new, data, func))) {
 567     if (new == __log_functions) {
 568       new = g_slist_copy (new);
 569       continue;
 570     }
 571     g_free (found->data);
 572     new = g_slist_delete_link (new, found);
 573     removals++;
 574   }
 575   /* FIXME: We leak the old list here. See _add_log_function for why. */
 576   __log_functions = new;
 577   g_static_mutex_unlock (&__log_func_mutex);
 578
 579   return removals;
 580 }
 581
 582 /**
 583  * gst_debug_remove_log_function:
 584  * @func: the log function to remove
 585  *
 586  * Removes all registrered instances of the given logging functions.
 587  *
 588  * Returns: How many instances of the function were removed
 589  */
 590 guint
 591 gst_debug_remove_log_function (GstLogFunction func)
 592 {
 593   guint removals;
 594
 595   g_return_val_if_fail (func != NULL, 0);
 596
 597   removals =
 598       gst_debug_remove_with_compare_func
 599       (gst_debug_compare_log_function_by_func, func);
 600   GST_DEBUG ("removed log function %p %d times from log function list", func,
 601       removals);
 602
 603   return removals;
 604 }
 605
 606 /**
 607  * gst_debug_remove_log_function_by_data:
 608  * @data: user data of the log function to remove
 609  *
 610  * Removes all registrered instances of log functions with the given user data.
 611  *
 612  * Returns: How many instances of the function were removed
 613  */
 614 guint
 615 gst_debug_remove_log_function_by_data (gpointer data)
 616 {
 617   guint removals;
 618
 619   removals =
 620       gst_debug_remove_with_compare_func
 621       (gst_debug_compare_log_function_by_data, data);
 622   GST_DEBUG
 623       ("removed %d log functions with user data %p from log function list",
 624       removals, data);
 625
 626   return removals;
 627 }
 628
 629 /**
 630  * gst_debug_set_colored:
 631  * @colored: Whether to use colored output or not
 632  *
 633  * Sets or unsets the use of coloured debugging output.
 634  */
 635 void
 636 gst_debug_set_colored (gboolean colored)
 637 {
 638   gst_atomic_int_set (&__use_color, colored ? 1 : 0);
 639 }
 640
 641 /**
 642  * gst_debug_is_colored:
 643  *
 644  * Checks if the debugging output should be colored.
 645  *
 646  * Returns: TRUE, if the debug output should be colored.
 647  */
 648 gboolean
 649 gst_debug_is_colored (void)
 650 {
 651   return gst_atomic_int_read (&__use_color) == 0 ? FALSE : TRUE;
 652 }
 653
 654 /**
 655  * gst_debug_set_active:
 656  * @active: Whether to use debugging output or not
 657  *
 658  * If activated, debugging messages are sent to the debugging
 659  * handlers.
 660  * It makes sense to deactivate it for speed issues.
 661  * <note><para>This function is not threadsafe. It makes sense to only call it
 662  * during initialization.</para></note>
 663  */
 664 void
 665 gst_debug_set_active (gboolean active)
 666 {
 667   __gst_debug_enabled = active;
 668 }
 669
 670 /**
 671  * gst_debug_is_active:
 672  *
 673  * Checks if debugging output is activated.
 674  *
 675  * Returns: TRUE, if debugging is activated
 676  */
 677 gboolean
 678 gst_debug_is_active (void)
 679 {
 680   return __gst_debug_enabled;
 681 }
 682
 683 /**
 684  * gst_debug_set_default_threshold:
 685  * @level: level to set
 686  *
 687  * Sets the default threshold to the given level and updates all categories to
 688  * use this threshold.
 689  */
 690 void
 691 gst_debug_set_default_threshold (GstDebugLevel level)
 692 {
 693   gst_atomic_int_set (&__default_level, level);
 694   gst_debug_reset_all_thresholds ();
 695 }
 696
 697 /**
 698  * gst_debug_get_default_threshold:
 699  *
 700  * Returns the default threshold that is used for new categories.
 701  *
 702  * Returns: the default threshold level
 703  */
 704 GstDebugLevel
 705 gst_debug_get_default_threshold (void)
 706 {
 707   return (GstDebugLevel) gst_atomic_int_read (&__default_level);
 708 }
 709 static void
 710 gst_debug_reset_threshold (gpointer category, gpointer unused)
 711 {
 712   GstDebugCategory *cat = (GstDebugCategory *) category;
 713   GSList *walk;
 714
 715   g_static_mutex_lock (&__level_name_mutex);
 716   walk = __level_name;
 717   while (walk) {
 718     LevelNameEntry *entry = walk->data;
 719
 720     walk = g_slist_next (walk);
 721     if (g_pattern_match_string (entry->pat, cat->name)) {
 722       GST_LOG ("category %s matches pattern %p - gets set to level %d",
 723           cat->name, entry->pat, entry->level);
 724       gst_debug_category_set_threshold (cat, entry->level);
 725       goto exit;
 726     }
 727   }
 728   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
 729
 730 exit:
 731   g_static_mutex_unlock (&__level_name_mutex);
 732 }
 733 static void
 734 gst_debug_reset_all_thresholds (void)
 735 {
 736   g_static_mutex_lock (&__cat_mutex);
 737   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
 738   g_static_mutex_unlock (&__cat_mutex);
 739 }
 740 static void
 741 for_each_threshold_by_entry (gpointer data, gpointer user_data)
 742 {
 743   GstDebugCategory *cat = (GstDebugCategory *) data;
 744   LevelNameEntry *entry = (LevelNameEntry *) user_data;
 745
 746   if (g_pattern_match_string (entry->pat, cat->name)) {
 747     GST_LOG ("category %s matches pattern %p - gets set to level %d",
 748         cat->name, entry->pat, entry->level);
 749     gst_debug_category_set_threshold (cat, entry->level);
 750   }
 751 }
 752
 753 /**
 754  * gst_debug_set_threshold_for_name:
 755  * @name: name of the categories to set
 756  * @level: level to set them to
 757  *
 758  * Sets all categories which match the gven glob style pattern to the given
 759  * level.
 760  */
 761 void
 762 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
 763 {
 764   GPatternSpec *pat;
 765   LevelNameEntry *entry;
 766
 767   g_return_if_fail (name != NULL);
 768
 769   pat = g_pattern_spec_new (name);
 770   entry = g_new (LevelNameEntry, 1);
 771   entry->pat = pat;
 772   entry->level = level;
 773   g_static_mutex_lock (&__level_name_mutex);
 774   __level_name = g_slist_prepend (__level_name, entry);
 775   g_static_mutex_unlock (&__level_name_mutex);
 776   g_static_mutex_lock (&__cat_mutex);
 777   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
 778   g_static_mutex_unlock (&__cat_mutex);
 779 }
 780
 781 /**
 782  * gst_debug_unset_threshold_for_name:
 783  * @name: name of the categories to set
 784  *
 785  * Resets all categories with the given name back to the default level.
 786  */
 787 void
 788 gst_debug_unset_threshold_for_name (const gchar * name)
 789 {
 790   GSList *walk;
 791   GPatternSpec *pat;
 792
 793   g_return_if_fail (name != NULL);
 794
 795   pat = g_pattern_spec_new (name);
 796   g_static_mutex_lock (&__level_name_mutex);
 797   walk = __level_name;
 798   /* improve this if you want, it's mighty slow */
 799   while (walk) {
 800     LevelNameEntry *entry = walk->data;
 801
 802     if (g_pattern_spec_equal (entry->pat, pat)) {
 803       __level_name = g_slist_remove_link (__level_name, walk);
 804       g_pattern_spec_free (entry->pat);
 805       g_free (entry);
 806       g_slist_free_1 (walk);
 807       walk = __level_name;
 808     }
 809   }
 810   g_static_mutex_unlock (&__level_name_mutex);
 811   g_pattern_spec_free (pat);
 812   gst_debug_reset_all_thresholds ();
 813 }
 814
 815 GstDebugCategory *
 816 _gst_debug_category_new (gchar * name, guint color, gchar * description)
 817 {
 818   GstDebugCategory *cat;
 819
 820   g_return_val_if_fail (name != NULL, NULL);
 821
 822   cat = g_new (GstDebugCategory, 1);
 823   cat->name = g_strdup (name);
 824   cat->color = color;
 825   if (description != NULL) {
 826     cat->description = g_strdup (description);
 827   } else {
 828     cat->description = g_strdup ("no description");
 829   }
 830   cat->threshold = g_new (GstAtomicInt, 1);
 831   gst_atomic_int_init (cat->threshold, 0);
 832   gst_debug_reset_threshold (cat, NULL);
 833
 834   /* add to category list */
 835   g_static_mutex_lock (&__cat_mutex);
 836   __categories = g_slist_prepend (__categories, cat);
 837   g_static_mutex_unlock (&__cat_mutex);
 838
 839   return cat;
 840 }
 841
 842 /**
 843  * gst_debug_category_free:
 844  * @category: #GstDebugCategory to free.
 845  *
 846  * Removes and frees the category and all associated resources.
 847  */
 848 void
 849 gst_debug_category_free (GstDebugCategory * category)
 850 {
 851   if (category == NULL)
 852     return;
 853
 854   /* remove from category list */
 855   g_static_mutex_lock (&__cat_mutex);
 856   __categories = g_slist_remove (__categories, category);
 857   g_static_mutex_unlock (&__cat_mutex);
 858
 859   g_free ((gpointer) category->name);
 860   g_free ((gpointer) category->description);
 861   gst_atomic_int_destroy (category->threshold);
 862   g_free (category->threshold);
 863   g_free (category);
 864 }
 865
 866 /**
 867  * gst_debug_category_set_threshold:
 868  * @category: a #GstDebugCategory to set threshold of.
 869  * @level: the #GstDebugLevel threshold to set.
 870  *
 871  * Sets the threshold of the category to the given level. Debug information will
 872  * only be output if the threshold is lower or equal to the level of the
 873  * debugging message.
 874  * <note><para>
 875  * Do not use this function in production code, because other functions may
 876  * change the threshold of categories as side effect. It is however a nice
 877  * function to use when debugging (even from gdb).
 878  * </para></note>
 879  */
 880 void
 881 gst_debug_category_set_threshold (GstDebugCategory * category,
 882     GstDebugLevel level)
 883 {
 884   g_return_if_fail (category != NULL);
 885
 886   gst_atomic_int_set (category->threshold, level);
 887 }
 888
 889 /**
 890  * gst_debug_category_reset_threshold:
 891  * @category: a #GstDebugCategory to reset threshold of.
 892  *
 893  * Resets the threshold of the category to the default level. Debug information
 894  * will only be output if the threshold is lower or equal to the level of the
 895  * debugging message.
 896  * Use this function to set the threshold back to where it was after using
 897  * gst_debug_category_set_threshold().
 898  */
 899 void
 900 gst_debug_category_reset_threshold (GstDebugCategory * category)
 901 {
 902   gst_debug_reset_threshold (category, NULL);
 903 }
 904
 905 /**
 906  * gst_debug_category_get_threshold:
 907  * @category: a #GstDebugCategory to get threshold of.
 908  *
 909  * Returns the threshold of a #GstCategory.
 910  *
 911  * Returns: the #GstDebugLevel that is used as threshold.
 912  */
 913 GstDebugLevel
 914 gst_debug_category_get_threshold (GstDebugCategory * category)
 915 {
 916   return gst_atomic_int_read (category->threshold);
 917 }
 918
 919 /**
 920  * gst_debug_category_get_name:
 921  * @category: a #GstDebugCategory to get name of.
 922  *
 923  * Returns the name of a debug category.
 924  *
 925  * Returns: the name of the category.
 926  */
 927 const gchar *
 928 gst_debug_category_get_name (GstDebugCategory * category)
 929 {
 930   return category->name;
 931 }
 932
 933 /**
 934  * gst_debug_category_get_color:
 935  * @category: a #GstDebugCategory to get the color of.
 936  *
 937  * Returns the color of a debug category used when printing output in this
 938  * category.
 939  *
 940  * Returns: the color of the category.
 941  */
 942 guint
 943 gst_debug_category_get_color (GstDebugCategory * category)
 944 {
 945   return category->color;
 946 }
 947
 948 /**
 949  * gst_debug_category_get_description:
 950  * @category: a #GstDebugCategory to get the description of.
 951  *
 952  * Returns the description of a debug category.
 953  *
 954  * Returns: the description of the category.
 955  */
 956 const gchar *
 957 gst_debug_category_get_description (GstDebugCategory * category)
 958 {
 959   return category->description;
 960 }
 961
 962 /**
 963  * gst_debug_get_all_categories:
 964  *
 965  * Returns a snapshot of a all categories that are currently in use . This list
 966  * may change anytime.
 967  * The caller has to free the list after use.
 968  * <emphasis>This function is not threadsafe, so only use it while only the
 969  * main thread is running.</emphasis>
 970  *
 971  * Returns: the list of categories
 972  */
 973 GSList *
 974 gst_debug_get_all_categories (void)
 975 {
 976   GSList *ret;
 977
 978   g_static_mutex_lock (&__cat_mutex);
 979   ret = g_slist_copy (__categories);
 980   g_static_mutex_unlock (&__cat_mutex);
 981
 982   return ret;
 983 }
 984
 985 /*** FUNCTION POINTERS ********************************************************/
 986
 987 GHashTable *__gst_function_pointers = NULL;
 988 const gchar *
 989 _gst_debug_nameof_funcptr (void *ptr)
 990     G_GNUC_NO_INSTRUMENT;
 991
 992 /* This function MUST NOT return NULL */
 993      const gchar *_gst_debug_nameof_funcptr (void *ptr)
 994 {
 995   gchar *ptrname;
 996
 997 #ifdef HAVE_DLADDR
 998   Dl_info dlinfo;
 999 #endif
1000
1001   if (__gst_function_pointers
1002       && (ptrname = g_hash_table_lookup (__gst_function_pointers, ptr))) {
1003     return ptrname;
1004   }
1005   /* we need to create an entry in the hash table for this one so we don't leak
1006    * the name */
1007 #ifdef HAVE_DLADDR
1008   if (dladdr (ptr, &dlinfo) && dlinfo.dli_sname) {
1009     gchar *name = g_strdup (dlinfo.dli_sname);
1010
1011     _gst_debug_register_funcptr (ptr, name);
1012     return name;
1013   } else
1014 #endif
1015   {
1016     gchar *name = g_strdup_printf ("%p", ptr);
1017
1018     _gst_debug_register_funcptr (ptr, name);
1019     return name;
1020   }
1021 }
1022
1023 void *
1024 _gst_debug_register_funcptr (void *ptr, gchar * ptrname)
1025 {
1026   if (!__gst_function_pointers)
1027     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1028   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1029     g_hash_table_insert (__gst_function_pointers, ptr, ptrname);
1030
1031   return ptr;
1032 }
1033
1034 #ifdef HAVE_PRINTF_EXTENSION
1035 static int
1036 _gst_info_printf_extension (FILE * stream, const struct printf_info *info,
1037     const void *const *args)
1038 {
1039   char *buffer;
1040   int len;
1041   void *ptr;
1042
1043   buffer = NULL;
1044   ptr = *(void **) args[0];
1045
1046   buffer = gst_debug_print_object (ptr);
1047   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1048       buffer);
1049
1050   free (buffer);
1051   return len;
1052 }
1053
1054 static int
1055 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1056     int *argtypes)
1057 {
1058   if (n > 0)
1059     argtypes[0] = PA_POINTER;
1060   return 1;
1061 }
1062 #endif /* HAVE_PRINTF_EXTENSION */
1063
1064 #endif /* GST_DISABLE_GST_DEBUG */
1065
1066 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1067 /* FIXME make this thread specific */
1068 static GSList *stack_trace = NULL;
1069
1070 void
1071 __cyg_profile_func_enter (void *this_fn, void *call_site)
1072     G_GNUC_NO_INSTRUMENT;
1073      void __cyg_profile_func_enter (void *this_fn, void *call_site)
1074 {
1075   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1076   gchar *site = _gst_debug_nameof_funcptr (call_site);
1077
1078   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1079       site);
1080   stack_trace =
1081       g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1082           this_fn, name, call_site, site));
1083
1084   g_free (name);
1085   g_free (site);
1086 }
1087
1088 void
1089 __cyg_profile_func_exit (void *this_fn, void *call_site)
1090     G_GNUC_NO_INSTRUMENT;
1091      void __cyg_profile_func_exit (void *this_fn, void *call_site)
1092 {
1093   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1094
1095   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1096   g_free (stack_trace->data);
1097   stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1098
1099   g_free (name);
1100 }
1101
1102 void
1103 gst_debug_print_stack_trace (void)
1104 {
1105   GSList *walk = stack_trace;
1106   gint count = 0;
1107
1108   if (walk)
1109     walk = g_slist_next (walk);
1110
1111   while (walk) {
1112     gchar *name = (gchar *) walk->data;
1113
1114     g_print ("#%-2d %s\n", count++, name);
1115
1116     walk = g_slist_next (walk);
1117   }
1118 }
1119 #else
1120 void
1121 gst_debug_print_stack_trace (void)
1122 {
1123   /* nothing because it's compiled out */
1124 }
1125
1126 #endif /* GST_ENABLE_FUNC_INTSTRUMENTATION */