gst/gstinfo.c

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