gst/gsttrace.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gsttrace.c: Tracing functions (deprecated)
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gsttrace
  25  * @short_description: Tracing functionality
  26  *
  27  * Traces allows to track object allocation. They provide a instance counter per
  28  * #GType. The counter is incremented for each object allocated and decremented
  29  * it when it's freed.
  30  *
  31  * <example>
  32  * <title>Tracing object instances</title>
  33  *   <programlisting>
  34  *     // trace un-freed object instances
  35  *     gst_alloc_trace_set_flags_all (GST_ALLOC_TRACE_LIVE);
  36  *     if (!gst_alloc_trace_available ()) {
  37  *       g_warning ("Trace not available (recompile with trace enabled).");
  38  *     }
  39  *     gst_alloc_trace_print_live ();
  40  *     // do something here
  41  *     gst_alloc_trace_print_live ();
  42  *   </programlisting>
  43  * </example>
  44  *
  45  * Last reviewed on 2005-11-21 (0.9.5)
  46  */
  47
  48 #ifdef HAVE_CONFIG_H
  49 #include "config.h"
  50 #endif
  51 #include <stdio.h>
  52 #ifdef HAVE_UNISTD_H
  53 #include <unistd.h>
  54 #endif
  55 #include <sys/stat.h>
  56 #include <fcntl.h>
  57 #include <string.h>
  58
  59 #include "gst_private.h"
  60 #include "gstinfo.h"
  61
  62 #include "gsttrace.h"
  63
  64 static
  65 #ifdef __inline__
  66   __inline__
  67 #endif
  68     void
  69 read_tsc (gint64 * dst)
  70 {
  71 #ifdef HAVE_RDTSC
  72   guint64 tsc;
  73   __asm__ __volatile__ ("rdtsc":"=A" (tsc));
  74
  75   *dst = tsc;
  76 #else
  77   *dst = 0;
  78 #endif
  79 }
  80
  81 /**
  82  * gst_trace_read_tsc:
  83  * @dst: pointer to hold the result.
  84  *
  85  * Read a platform independent timer value that can be used in
  86  * benchmarks.
  87  */
  88 void
  89 gst_trace_read_tsc (gint64 * dst)
  90 {
  91   read_tsc (dst);
  92 }
  93
  94 GstTrace *_gst_trace_default = NULL;
  95 gint _gst_trace_on = 1;
  96
  97 /**
  98  * gst_trace_new:
  99  * @filename: a filename
 100  * @size: the max size of the file
 101  *
 102  * Create a ringbuffer of @size in the file with @filename to
 103  * store trace results in.
 104  *
 105  * Returns: a new #GstTrace.
 106  */
 107 GstTrace *
 108 gst_trace_new (gchar * filename, gint size)
 109 {
 110   GstTrace *trace = g_malloc (sizeof (GstTrace));
 111
 112   g_return_val_if_fail (trace != NULL, NULL);
 113   trace->filename = g_strdup (filename);
 114   GST_DEBUG ("opening '%s'\n", trace->filename);
 115 #ifndef S_IWUSR
 116 #define S_IWUSR S_IWRITE
 117 #endif
 118 #ifndef S_IRUSR
 119 #define S_IRUSR S_IREAD
 120 #endif
 121   trace->fd =
 122       open (trace->filename, O_RDWR | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 123   perror ("opening trace file");
 124   g_return_val_if_fail (trace->fd > 0, NULL);
 125   trace->buf = g_malloc (size * sizeof (GstTraceEntry));
 126   g_return_val_if_fail (trace->buf != NULL, NULL);
 127   trace->bufsize = size;
 128   trace->bufoffset = 0;
 129
 130   return trace;
 131 }
 132
 133 /**
 134  * gst_trace_destroy:
 135  * @trace: the #GstTrace to destroy
 136  *
 137  * Flush an close the previously allocated @trace.
 138  */
 139 void
 140 gst_trace_destroy (GstTrace * trace)
 141 {
 142   g_return_if_fail (trace != NULL);
 143   g_return_if_fail (trace->buf != NULL);
 144
 145   if (gst_trace_get_remaining (trace) > 0)
 146     gst_trace_flush (trace);
 147   close (trace->fd);
 148   g_free (trace->buf);
 149   g_free (trace);
 150 }
 151
 152 /**
 153  * gst_trace_flush:
 154  * @trace: the #GstTrace to flush.
 155  *
 156  * Flush any pending trace entries in @trace to the trace file.
 157  * @trace can be NULL in which case the default #GstTrace will be
 158  * flushed.
 159  */
 160 void
 161 gst_trace_flush (GstTrace * trace)
 162 {
 163   if (!trace) {
 164     trace = _gst_trace_default;
 165     if (!trace)
 166       return;
 167   }
 168
 169   g_return_if_fail (write (trace->fd, trace->buf,
 170           trace->bufoffset * sizeof (GstTraceEntry)) != -1);
 171   trace->bufoffset = 0;
 172 }
 173
 174 /**
 175  * gst_trace_text_flush:
 176  * @trace: the #GstTrace to flush.
 177  *
 178  * Flush any pending trace entries in @trace to the trace file,
 179  * formatted as a text line with timestamp and sequence numbers.
 180  * @trace can be NULL in which case the default #GstTrace will be
 181  * flushed.
 182  */
 183 void
 184 gst_trace_text_flush (GstTrace * trace)
 185 {
 186   int i;
 187
 188 #define STRSIZE (20 + 1 + 10 + 1 + 10 + 1 + 112 + 1 + 1)
 189   char str[STRSIZE];
 190
 191   if (!trace) {
 192     trace = _gst_trace_default;
 193     if (!trace)
 194       return;
 195   }
 196
 197   for (i = 0; i < trace->bufoffset; i++) {
 198     g_snprintf (str, STRSIZE, "%20" G_GINT64_FORMAT " %10d %10d %s\n",
 199         trace->buf[i].timestamp,
 200         trace->buf[i].sequence, trace->buf[i].data, trace->buf[i].message);
 201     g_return_if_fail (write (trace->fd, str, strlen (str)) != -1);
 202   }
 203   trace->bufoffset = 0;
 204 #undef STRSIZE
 205 }
 206
 207 /**
 208  * gst_trace_set_default:
 209  * @trace: the #GstTrace to set as the default.
 210  *
 211  * Set the default #GstTrace to @trace.
 212  */
 213 void
 214 gst_trace_set_default (GstTrace * trace)
 215 {
 216   g_return_if_fail (trace != NULL);
 217   _gst_trace_default = trace;
 218 }
 219
 220 void
 221 _gst_trace_add_entry (GstTrace * trace, guint32 seq, guint32 data, gchar * msg)
 222 {
 223   GstTraceEntry *entry;
 224
 225   if (!trace) {
 226     trace = _gst_trace_default;
 227     if (!trace)
 228       return;
 229   }
 230
 231   entry = trace->buf + trace->bufoffset;
 232   read_tsc (&(entry->timestamp));
 233   entry->sequence = seq;
 234   entry->data = data;
 235   strncpy (entry->message, msg, 112);
 236   trace->bufoffset++;
 237
 238   gst_trace_flush (trace);
 239 }
 240
 241
 242 /* global flags */
 243 static GstAllocTraceFlags _gst_trace_flags = 0;
 244
 245 /* list of registered tracers */
 246 static GList *_gst_alloc_tracers = NULL;
 247
 248 /**
 249  * gst_alloc_trace_available:
 250  *
 251  * Check if alloc tracing was commiled into the core
 252  *
 253  * Returns: TRUE if the core was compiled with alloc
 254  * tracing enabled.
 255  */
 256 gboolean
 257 gst_alloc_trace_available (void)
 258 {
 259 #ifdef GST_DISABLE_ALLOC_TRACE
 260   return FALSE;
 261 #else
 262   return TRUE;
 263 #endif
 264 }
 265
 266 /**
 267  * _gst_alloc_trace_register:
 268  * @name: the name of the new alloc trace object.
 269  *
 270  * Register an get a handle to a GstAllocTrace object that
 271  * can be used to trace memory allocations.
 272  *
 273  * Returns: A handle to a GstAllocTrace.
 274  */
 275 GstAllocTrace *
 276 _gst_alloc_trace_register (const gchar * name)
 277 {
 278   GstAllocTrace *trace;
 279
 280   g_return_val_if_fail (name, NULL);
 281
 282   trace = g_new0 (GstAllocTrace, 1);
 283   trace->name = g_strdup (name);
 284   trace->live = 0;
 285   trace->mem_live = NULL;
 286   trace->flags = _gst_trace_flags;
 287
 288   _gst_alloc_tracers = g_list_prepend (_gst_alloc_tracers, trace);
 289
 290   return trace;
 291 }
 292
 293 /**
 294  * gst_alloc_trace_list:
 295  *
 296  * Get a list of all registered alloc trace objects.
 297  *
 298  * Returns: a GList of GstAllocTrace objects.
 299  */
 300 const GList *
 301 gst_alloc_trace_list (void)
 302 {
 303   return _gst_alloc_tracers;
 304 }
 305
 306 /**
 307  * gst_alloc_trace_live_all:
 308  *
 309  * Get the total number of live registered alloc trace objects.
 310  *
 311  * Returns: the total number of live registered alloc trace objects.
 312  */
 313 int
 314 gst_alloc_trace_live_all (void)
 315 {
 316   GList *walk = _gst_alloc_tracers;
 317   int num = 0;
 318
 319   while (walk) {
 320     GstAllocTrace *trace = (GstAllocTrace *) walk->data;
 321
 322     num += trace->live;
 323
 324     walk = g_list_next (walk);
 325   }
 326
 327   return num;
 328 }
 329
 330 static gint
 331 compare_func (GstAllocTrace * a, GstAllocTrace * b)
 332 {
 333   return strcmp (a->name, b->name);
 334 }
 335
 336 static GList *
 337 gst_alloc_trace_list_sorted (void)
 338 {
 339   GList *ret;
 340
 341   ret = g_list_sort (g_list_copy (_gst_alloc_tracers),
 342       (GCompareFunc) compare_func);
 343
 344   return ret;
 345 }
 346
 347 /**
 348  * gst_alloc_trace_print_all:
 349  *
 350  * Print the status of all registered alloc trace objects.
 351  */
 352 void
 353 gst_alloc_trace_print_all (void)
 354 {
 355   GList *orig, *walk;
 356
 357   orig = walk = gst_alloc_trace_list_sorted ();
 358
 359   while (walk) {
 360     GstAllocTrace *trace = (GstAllocTrace *) walk->data;
 361
 362     gst_alloc_trace_print (trace);
 363
 364     walk = g_list_next (walk);
 365   }
 366
 367   g_list_free (orig);
 368 }
 369
 370 /**
 371  * gst_alloc_trace_print_live:
 372  *
 373  * Print the status of all registered alloc trace objects, ignoring those
 374  * without live objects.
 375  */
 376 void
 377 gst_alloc_trace_print_live (void)
 378 {
 379   GList *orig, *walk;
 380
 381   orig = walk = gst_alloc_trace_list_sorted ();
 382
 383   while (walk) {
 384     GstAllocTrace *trace = (GstAllocTrace *) walk->data;
 385
 386     if (trace->live)
 387       gst_alloc_trace_print (trace);
 388
 389     walk = g_list_next (walk);
 390   }
 391
 392   g_list_free (orig);
 393 }
 394
 395 /**
 396  * gst_alloc_trace_set_flags_all:
 397  * @flags: the options to enable
 398  *
 399  * Enable the specified options on all registered alloc trace
 400  * objects.
 401  */
 402 void
 403 gst_alloc_trace_set_flags_all (GstAllocTraceFlags flags)
 404 {
 405   GList *walk = _gst_alloc_tracers;
 406
 407   while (walk) {
 408     GstAllocTrace *trace = (GstAllocTrace *) walk->data;
 409
 410     GST_DEBUG ("set flags on %p\n", trace);
 411     gst_alloc_trace_set_flags (trace, flags);
 412
 413     walk = g_list_next (walk);
 414   }
 415   _gst_trace_flags = flags;
 416 }
 417
 418 /**
 419  * gst_alloc_trace_get:
 420  * @name: the name of the alloc trace object
 421  *
 422  * Get the named alloc trace object.
 423  *
 424  * Returns: a GstAllocTrace with the given name or NULL when
 425  * no alloc tracer was registered with that name.
 426  */
 427 GstAllocTrace *
 428 gst_alloc_trace_get (const gchar * name)
 429 {
 430   GList *walk = _gst_alloc_tracers;
 431
 432   g_return_val_if_fail (name, NULL);
 433
 434   while (walk) {
 435     GstAllocTrace *trace = (GstAllocTrace *) walk->data;
 436
 437     if (!strcmp (trace->name, name))
 438       return trace;
 439
 440     walk = g_list_next (walk);
 441   }
 442   return NULL;
 443 }
 444
 445 /**
 446  * gst_alloc_trace_print:
 447  * @trace: the GstAllocTrace to print
 448  *
 449  * Print the status of the given GstAllocTrace.
 450  */
 451 void
 452 gst_alloc_trace_print (const GstAllocTrace * trace)
 453 {
 454   GSList *mem_live;
 455
 456   g_return_if_fail (trace != NULL);
 457
 458   if (trace->flags & GST_ALLOC_TRACE_LIVE) {
 459     g_print ("%-22.22s : %d\n", trace->name, trace->live);
 460   } else {
 461     g_print ("%-22.22s : (no live count)\n", trace->name);
 462   }
 463
 464   if (trace->flags & GST_ALLOC_TRACE_MEM_LIVE) {
 465     mem_live = trace->mem_live;
 466
 467     while (mem_live) {
 468       g_print ("%-22.22s : %p\n", "", mem_live->data);
 469       mem_live = mem_live->next;
 470     }
 471   }
 472 }
 473
 474 /**
 475  * gst_alloc_trace_set_flags:
 476  * @trace: the GstAllocTrace
 477  * @flags: flags to set
 478  *
 479  * Enable the given features on the given GstAllocTrace object.
 480  */
 481 void
 482 gst_alloc_trace_set_flags (GstAllocTrace * trace, GstAllocTraceFlags flags)
 483 {
 484   g_return_if_fail (trace != NULL);
 485
 486   trace->flags = flags;
 487 }