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