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