* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
*
- * gsttrace.h: Header for tracing functions (depracated)
+ * gsttrace.h: Header for tracing functions (deprecated)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
#ifndef __GST_TRACE_H__
#define __GST_TRACE_H__
-#ifndef GST_DISABLE_TRACE
-
#include <glib.h>
G_BEGIN_DECLS
-typedef struct _GstTrace GstTrace;
-typedef struct _GstTraceEntry GstTraceEntry;
-
-struct _GstTrace {
- /* where this trace is going */
- gchar *filename;
- int fd;
-
- /* current buffer, size, head offset */
- GstTraceEntry *buf;
- gint bufsize;
- gint bufoffset;
-};
-
-struct _GstTraceEntry {
- gint64 timestamp;
- guint32 sequence;
- guint32 data;
- gchar message[112];
-};
-
-
-
-GstTrace* gst_trace_new (gchar *filename, gint size);
-
-void gst_trace_destroy (GstTrace *trace);
-void gst_trace_flush (GstTrace *trace);
-void gst_trace_text_flush (GstTrace *trace);
-#define gst_trace_get_size(trace) ((trace)->bufsize)
-#define gst_trace_get_offset(trace) ((trace)->bufoffset)
-#define gst_trace_get_remaining(trace) ((trace)->bufsize - (trace)->bufoffset)
-void gst_trace_set_default (GstTrace *trace);
-
-void _gst_trace_add_entry (GstTrace *trace, guint32 seq,
- guint32 data, gchar *msg);
-
-void gst_trace_read_tsc (gint64 *dst);
-
-
-typedef enum
-{
- GST_ALLOC_TRACE_LIVE = (1 << 0),
- GST_ALLOC_TRACE_MEM_LIVE = (1 << 1)
+/**
+ * GstAllocTraceFlags:
+ * @GST_ALLOC_TRACE_NONE: No tracing specified or desired. Since 0.10.36.
+ * @GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory.
+ * @GST_ALLOC_TRACE_MEM_LIVE: Trace pointers of unfreed memory.
+ *
+ * Flags indicating which tracing feature to enable.
+ */
+typedef enum {
+ GST_ALLOC_TRACE_NONE = 0,
+ GST_ALLOC_TRACE_LIVE = (1 << 0),
+ GST_ALLOC_TRACE_MEM_LIVE = (1 << 1)
} GstAllocTraceFlags;
-typedef struct _GstAllocTrace GstAllocTrace;
+typedef struct _GstAllocTrace GstAllocTrace;
+/**
+ * GstAllocTrace:
+ * @name: The name of the tracing object
+ * @flags: Flags for this object
+ * @offset: offset of the GType
+ * @live: counter for live memory
+ * @mem_live: list with pointers to unfreed memory
+ *
+ * The main tracing object
+ */
struct _GstAllocTrace {
- gchar *name;
- gint flags;
+ gchar *name;
+ gint flags;
- gint live;
- GSList *mem_live;
+ goffset offset;
+ gint live;
+ GSList *mem_live;
};
-gboolean gst_alloc_trace_available (void);
-G_CONST_RETURN GList* gst_alloc_trace_list (void);
-GstAllocTrace* _gst_alloc_trace_register (const gchar *name);
+#ifndef GST_DISABLE_TRACE
-int gst_alloc_trace_live_all (void);
-void gst_alloc_trace_print_all (void);
-void gst_alloc_trace_set_flags_all (GstAllocTraceFlags flags);
+GST_EXPORT GMutex _gst_trace_mutex;
-GstAllocTrace* gst_alloc_trace_get (const gchar *name);
-void gst_alloc_trace_print (const GstAllocTrace *trace);
-void gst_alloc_trace_set_flags (GstAllocTrace *trace, GstAllocTraceFlags flags);
+void _priv_gst_alloc_trace_initialize (void);
+void _priv_gst_alloc_trace_deinit (void);
+GstAllocTrace* _priv_gst_alloc_trace_register (const gchar *name, goffset offset);
+void _priv_gst_alloc_trace_dump (void);
#ifndef GST_DISABLE_ALLOC_TRACE
-#define gst_alloc_trace_register(name) _gst_alloc_trace_register (name);
-#define gst_alloc_trace_new(trace, mem) \
-G_STMT_START { \
- if ((trace)->flags & GST_ALLOC_TRACE_LIVE) \
- (trace)->live++; \
- if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE) \
- (trace)->mem_live = \
- g_slist_prepend ((trace)->mem_live, mem); \
-} G_STMT_END
+/**
+ * gst_alloc_trace_register:
+ * @name: The name of the tracer object
+ *
+ * Register a new alloc tracer with the given name
+ */
+#define _gst_alloc_trace_register(name,offset) _priv_gst_alloc_trace_register (name,offset)
-#define gst_alloc_trace_free(trace, mem) \
-G_STMT_START { \
- if ((trace)->flags & GST_ALLOC_TRACE_LIVE) \
- (trace)->live--; \
- if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE) \
- (trace)->mem_live = \
- g_slist_remove ((trace)->mem_live, mem); \
-} G_STMT_END
+#define _gst_alloc_trace_dump _priv_gst_alloc_trace_dump
-#else
-#define gst_alloc_trace_register(name) (NULL)
-#define gst_alloc_trace_new(trace, mem)
-#define gst_alloc_trace_free(trace, mem)
-#endif
+/**
+ * gst_alloc_trace_new:
+ * @trace: The tracer to use
+ * @mem: The memory allocated
+ *
+ * Use the tracer to trace a new memory allocation
+ */
+#define _gst_alloc_trace_new(trace, mem) \
+G_STMT_START { \
+ if (G_UNLIKELY ((trace)->flags)) { \
+ g_mutex_lock (&_gst_trace_mutex); \
+ if ((trace)->flags & GST_ALLOC_TRACE_LIVE) \
+ (trace)->live++; \
+ if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE) \
+ (trace)->mem_live = \
+ g_slist_prepend ((trace)->mem_live, mem); \
+ g_mutex_unlock (&_gst_trace_mutex); \
+ } \
+} G_STMT_END
+/**
+ * gst_alloc_trace_free:
+ * @trace: The tracer to use
+ * @mem: The memory that is freed
+ *
+ * Trace a memory free operation
+ */
+#define _gst_alloc_trace_free(trace, mem) \
+G_STMT_START { \
+ if (G_UNLIKELY ((trace)->flags)) { \
+ g_mutex_lock (&_gst_trace_mutex); \
+ if ((trace)->flags & GST_ALLOC_TRACE_LIVE) \
+ (trace)->live--; \
+ if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE) \
+ (trace)->mem_live = \
+ g_slist_remove ((trace)->mem_live, mem); \
+ g_mutex_unlock (&_gst_trace_mutex); \
+ } \
+} G_STMT_END
-#ifndef GST_DISABLE_TRACE
-extern gint _gst_trace_on;
-#define gst_trace_add_entry(trace,seq,data,msg) \
- if (_gst_trace_on) { \
- _gst_trace_add_entry(trace,(guint32)seq,(guint32)data,msg); \
- }
#else
-#define gst_trace_add_entry(trace,seq,data,msg)
+#define _gst_alloc_trace_register(name) (NULL)
+#define _gst_alloc_trace_new(trace, mem)
+#define _gst_alloc_trace_free(trace, mem)
+#define _gst_alloc_trace_dump()
#endif
#else /* GST_DISABLE_TRACE */
-#pragma GCC poison gst_trace_new
-#pragma GCC poison gst_trace_destroy
-#pragma GCC poison gst_trace_flush
-#pragma GCC poison gst_trace_text_flush
-#pragma GCC poison gst_trace_get_size
-#pragma GCC poison gst_trace_get_offset
-#pragma GCC poison gst_trace_get_remaining
-#pragma GCC poison gst_trace_set_default
-#pragma GCC poison _gst_trace_add_entry
-#pragma GCC poison gst_trace_read_tsc
-#pragma GCC poison gst_trace_add_entry
-
-#define gst_alloc_trace_register(name)
-#define gst_alloc_trace_new(trace, mem)
-#define gst_alloc_trace_free(trace, mem)
-
-#define gst_alloc_trace_available() (FALSE)
-#define gst_alloc_trace_list() (NULL)
-#define _gst_alloc_trace_register(name) (NULL)
-
-#define gst_alloc_trace_print_all()
-#define gst_alloc_trace_set_flags_all(flags)
-
-#define gst_alloc_trace_get(name) (NULL)
-#define gst_alloc_trace_print(trace)
-#define gst_alloc_trace_set_flags(trace,flags)
-
+#define _gst_alloc_trace_register(name, offset) (NULL)
+#define _gst_alloc_trace_new(trace, mem)
+#define _gst_alloc_trace_free(trace, mem)
+#define _gst_alloc_trace_dump()
#endif /* GST_DISABLE_TRACE */