gst/gsttrace.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gsttrace.h: Header for 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 #ifndef __GST_TRACE_H__
  25 #define __GST_TRACE_H__
  26
  27 #include <glib.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #ifndef GST_DISABLE_TRACE
  32
  33 typedef struct _GstTrace        GstTrace;
  34 typedef struct _GstTraceEntry   GstTraceEntry;
  35
  36 struct _GstTrace {
  37   /* where this trace is going */
  38   gchar *filename;
  39   int fd;
  40
  41   /* current buffer, size, head offset */
  42   GstTraceEntry *buf;
  43   gint bufsize;
  44   gint bufoffset;
  45 };
  46
  47 struct _GstTraceEntry {
  48   gint64 timestamp;
  49   guint32 sequence;
  50   guint32 data;
  51   gchar message[112];
  52 };
  53
  54
  55
  56 GstTrace*       gst_trace_new                   (gchar *filename, gint size);
  57
  58 void            gst_trace_destroy               (GstTrace *trace);
  59 void            gst_trace_flush                 (GstTrace *trace);
  60 void            gst_trace_text_flush            (GstTrace *trace);
  61 #define         gst_trace_get_size(trace)       ((trace)->bufsize)
  62 #define         gst_trace_get_offset(trace)     ((trace)->bufoffset)
  63 #define         gst_trace_get_remaining(trace)  ((trace)->bufsize - (trace)->bufoffset)
  64 void            gst_trace_set_default           (GstTrace *trace);
  65
  66 void            _gst_trace_add_entry            (GstTrace *trace, guint32 seq,
  67                                                  guint32 data, gchar *msg);
  68
  69 void            gst_trace_read_tsc              (gint64 *dst);
  70
  71
  72 /**
  73  * GstAllocTraceFlags:
  74  * @GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory
  75  * @GST_ALLOC_TRACE_MEM_LIVE: trace pointers of unfreed memory
  76  *
  77  * Flags indicating which tracing feature to enable.
  78  */
  79 typedef enum {
  80   GST_ALLOC_TRACE_LIVE          = (1 << 0),
  81   GST_ALLOC_TRACE_MEM_LIVE      = (1 << 1)
  82 } GstAllocTraceFlags;
  83
  84 typedef struct _GstAllocTrace   GstAllocTrace;
  85
  86 /**
  87  * GstAllocTrace:
  88  * @name: The name of the tracing object
  89  * @flags: Flags for this object
  90  * @live: counter for live memory
  91  * @mem_live: list with pointers to unfreed memory
  92  *
  93  * The main tracing object
  94  */
  95 struct _GstAllocTrace {
  96   gchar         *name;
  97   gint           flags;
  98
  99   gint           live;
 100   GSList        *mem_live;
 101 };
 102
 103 gboolean                gst_alloc_trace_available       (void);
 104 G_CONST_RETURN GList*   gst_alloc_trace_list            (void);
 105 GstAllocTrace*          _gst_alloc_trace_register       (const gchar *name);
 106
 107 int                     gst_alloc_trace_live_all        (void);
 108 void                    gst_alloc_trace_print_all       (void);
 109 void                    gst_alloc_trace_print_live      (void);
 110 void                    gst_alloc_trace_set_flags_all   (GstAllocTraceFlags flags);
 111
 112 GstAllocTrace*          gst_alloc_trace_get             (const gchar *name);
 113 void                    gst_alloc_trace_print           (const GstAllocTrace *trace);
 114 void                    gst_alloc_trace_set_flags       (GstAllocTrace *trace, GstAllocTraceFlags flags);
 115
 116
 117 #ifndef GST_DISABLE_ALLOC_TRACE
 118 /**
 119  * gst_alloc_trace_register:
 120  * @name: The name of the tracer object
 121  *
 122  * Register a new alloc tracer with the given name
 123  */
 124 #define gst_alloc_trace_register(name) _gst_alloc_trace_register (name);
 125
 126 /**
 127  * gst_alloc_trace_new:
 128  * @trace: The tracer to use
 129  * @mem: The memory allocated
 130  *
 131  * Use the tracer to trace a new memory allocation
 132  */
 133 #define gst_alloc_trace_new(trace, mem)                 \
 134 G_STMT_START {                                          \
 135   if ((trace)->flags & GST_ALLOC_TRACE_LIVE)            \
 136     (trace)->live++;                                    \
 137   if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE)        \
 138     (trace)->mem_live =                                 \
 139       g_slist_prepend ((trace)->mem_live, mem);         \
 140 } G_STMT_END
 141
 142 /**
 143  * gst_alloc_trace_free:
 144  * @trace: The tracer to use
 145  * @mem: The memory that is freed
 146  *
 147  * Trace a memory free operation
 148  */
 149 #define gst_alloc_trace_free(trace, mem)                \
 150 G_STMT_START {                                          \
 151   if ((trace)->flags & GST_ALLOC_TRACE_LIVE)            \
 152     (trace)->live--;                                    \
 153   if ((trace)->flags & GST_ALLOC_TRACE_MEM_LIVE)        \
 154     (trace)->mem_live =                                 \
 155       g_slist_remove ((trace)->mem_live, mem);          \
 156 } G_STMT_END
 157
 158 #else
 159 #define gst_alloc_trace_register(name) (NULL)
 160 #define gst_alloc_trace_new(trace, mem)
 161 #define gst_alloc_trace_free(trace, mem)
 162 #endif
 163
 164
 165 extern gint _gst_trace_on;
 166 #define gst_trace_add_entry(trace,seq,data,msg) \
 167   if (_gst_trace_on) { \
 168     _gst_trace_add_entry(trace,(guint32)seq,(guint32)data,msg); \
 169   }
 170
 171 #else /* GST_DISABLE_TRACE */
 172
 173 #if defined _GNUC_ && _GNUC_ >= 3
 174 #pragma GCC poison      gst_trace_new
 175 #pragma GCC poison      gst_trace_destroy
 176 #pragma GCC poison      gst_trace_flush
 177 #pragma GCC poison      gst_trace_text_flush
 178 #pragma GCC poison      gst_trace_get_size
 179 #pragma GCC poison      gst_trace_get_offset
 180 #pragma GCC poison      gst_trace_get_remaining
 181 #pragma GCC poison      gst_trace_set_default
 182 #pragma GCC poison      _gst_trace_add_entry
 183 #pragma GCC poison      gst_trace_read_tsc
 184 #pragma GCC poison      gst_trace_add_entry
 185 #endif
 186
 187 #define         gst_alloc_trace_register(name)
 188 #define         gst_alloc_trace_new(trace, mem)
 189 #define         gst_alloc_trace_free(trace, mem)
 190
 191 #define         gst_alloc_trace_available()     (FALSE)
 192 #define         gst_alloc_trace_list()          (NULL)
 193 #define         _gst_alloc_trace_register(name) (NULL)
 194
 195 #define         gst_alloc_trace_print_all()
 196 #define         gst_alloc_trace_set_flags_all(flags)
 197
 198 #define         gst_alloc_trace_get(name)       (NULL)
 199 #define         gst_alloc_trace_print(trace)
 200 #define         gst_alloc_trace_set_flags(trace,flags)
 201
 202 #define         gst_trace_add_entry(trace,seq,data,msg)
 203
 204 #endif /* GST_DISABLE_TRACE */
 205
 206 G_END_DECLS
 207
 208 #endif /* __GST_TRACE_H__ */