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