plugins/tracers/gstleaks.h

   1 /* GStreamer
   2  * Copyright (C) 2016 Collabora Ltd. <guillaume.desmottes@collabora.co.uk>
   3  *
   4  * gstleaks.c: tracing module detecting object leaks
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef __GST_LEAKS_TRACER_H__
  23 #define __GST_LEAKS_TRACER_H__
  24
  25 #include <gst/gst.h>
  26 #include <gst/gsttracer.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GST_TYPE_LEAKS_TRACER \
  31   (gst_leaks_tracer_get_type())
  32 #define GST_LEAKS_TRACER(obj) \
  33   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_LEAKS_TRACER,GstLeaksTracer))
  34 #define GST_LEAKS_TRACER_CLASS(klass) \
  35   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_LEAKS_TRACER,GstLeaksTracerClass))
  36 #define GST_IS_LEAKS_TRACER(obj) \
  37   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_LEAKS_TRACER))
  38 #define GST_IS_LEAKS_TRACER_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_LEAKS_TRACER))
  40 #define GST_LEAKS_TRACER_CAST(obj) ((GstLeaksTracer *)(obj))
  41
  42 typedef struct _GstLeaksTracer GstLeaksTracer;
  43 typedef struct _GstLeaksTracerClass GstLeaksTracerClass;
  44
  45 /**
  46  * GstLeaksTracer:
  47  *
  48  * Opaque #GstLeaksTracer data structure
  49  */
  50 struct _GstLeaksTracer {
  51   GstTracer parent;
  52
  53   /*< private >*/
  54   /* gpointer (object currently alive) -> gchar * (its creation trace, or
  55    * NULL). Protected by object lock */
  56   GHashTable *objects;
  57   /* array of GType used as filtering */
  58   GArray *filter;
  59   /* Set of owned ObjectLog.  Protected by object lock */
  60   GHashTable *added;
  61   /* Set of owned ObjectLog.  Protected by object lock */
  62   GHashTable *removed;
  63   /* If not NULL, contain a set of GQuark representing type filter not
  64    * (yet?) known by the type system.
  65    * Protected by object lock. */
  66   GHashTable *unhandled_filter;
  67   /* The number of elements in unhandled_filter */
  68   gint unhandled_filter_count;
  69   gboolean done;
  70
  71   gboolean check_refs;
  72
  73   gboolean log_stack_trace;
  74 };
  75
  76 struct _GstLeaksTracerClass {
  77   GstTracerClass parent_class;
  78 };
  79
  80 G_GNUC_INTERNAL GType gst_leaks_tracer_get_type (void);
  81
  82 G_END_DECLS
  83
  84 #endif /* __GST_LEAKS_TRACER_H__ */