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