gst/gsttracer.c

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracer.h: tracing subsystem
   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 #include "gst_private.h"
  23 #include "gstenumtypes.h"
  24 #include "gstregistry.h"
  25 #include "gsttracer.h"
  26 #include "gsttracerfactory.h"
  27 #include "gstutils.h"
  28
  29 #ifndef GST_DISABLE_GST_DEBUG
  30
  31 GST_DEBUG_CATEGORY_EXTERN (tracer_debug);
  32 #define GST_CAT_DEFAULT tracer_debug
  33
  34 /* tracing plugins base class */
  35
  36 enum
  37 {
  38   PROP_0,
  39   PROP_PARAMS,
  40   PROP_MASK,
  41   PROP_LAST
  42 };
  43
  44 static GParamSpec *properties[PROP_LAST];
  45
  46 static void gst_tracer_set_property (GObject * object, guint prop_id,
  47     const GValue * value, GParamSpec * pspec);
  48 static void gst_tracer_get_property (GObject * object, guint prop_id,
  49     GValue * value, GParamSpec * pspec);
  50
  51 struct _GstTracerPrivate
  52 {
  53   const gchar *params;
  54   GstTracerHook mask;
  55 };
  56
  57 #define gst_tracer_parent_class parent_class
  58 G_DEFINE_ABSTRACT_TYPE (GstTracer, gst_tracer, GST_TYPE_OBJECT);
  59
  60 static void
  61 gst_tracer_class_init (GstTracerClass * klass)
  62 {
  63   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  64
  65   gobject_class->set_property = gst_tracer_set_property;
  66   gobject_class->get_property = gst_tracer_get_property;
  67
  68   properties[PROP_PARAMS] =
  69       g_param_spec_string ("params", "Params", "Extra configuration parameters",
  70       NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
  71
  72   properties[PROP_MASK] =
  73       g_param_spec_flags ("mask", "Mask", "Event mask", GST_TYPE_TRACER_HOOK,
  74       GST_TRACER_HOOK_NONE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
  75
  76   g_object_class_install_properties (gobject_class, PROP_LAST, properties);
  77   g_type_class_add_private (klass, sizeof (GstTracerPrivate));
  78 }
  79
  80 static void
  81 gst_tracer_init (GstTracer * tracer)
  82 {
  83   tracer->priv = G_TYPE_INSTANCE_GET_PRIVATE (tracer, GST_TYPE_TRACER,
  84       GstTracerPrivate);
  85 }
  86
  87 static void
  88 gst_tracer_set_property (GObject * object, guint prop_id,
  89     const GValue * value, GParamSpec * pspec)
  90 {
  91   GstTracer *self = GST_TRACER_CAST (object);
  92
  93   switch (prop_id) {
  94     case PROP_PARAMS:
  95       self->priv->params = g_value_get_string (value);
  96       break;
  97     case PROP_MASK:
  98       self->priv->mask = g_value_get_flags (value);
  99       break;
 100     default:
 101       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 102       break;
 103   }
 104 }
 105
 106 static void
 107 gst_tracer_get_property (GObject * object, guint prop_id,
 108     GValue * value, GParamSpec * pspec)
 109 {
 110   GstTracer *self = GST_TRACER_CAST (object);
 111
 112   switch (prop_id) {
 113     case PROP_PARAMS:
 114       g_value_set_string (value, self->priv->params);
 115       break;
 116     case PROP_MASK:
 117       g_value_set_flags (value, self->priv->mask);
 118       break;
 119     default:
 120       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 121       break;
 122   }
 123 }
 124
 125 static void
 126 gst_tracer_invoke (GstTracer * self, GstTracerHookId hid,
 127     GstTracerMessageId mid, va_list var_args)
 128 {
 129   GstTracerClass *klass = GST_TRACER_GET_CLASS (self);
 130
 131   g_return_if_fail (klass->invoke);
 132
 133   klass->invoke (self, hid, mid, var_args);
 134 }
 135
 136 /* tracing modules */
 137
 138 gboolean
 139 gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
 140 {
 141   GstPluginFeature *existing_feature;
 142   GstRegistry *registry;
 143   GstTracerFactory *factory;
 144
 145   g_return_val_if_fail (name != NULL, FALSE);
 146   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_TRACER), FALSE);
 147
 148   registry = gst_registry_get ();
 149   /* check if feature already exists, if it exists there is no need to update it
 150    * when the registry is getting updated, outdated plugins and all their
 151    * features are removed and readded.
 152    */
 153   existing_feature = gst_registry_lookup_feature (registry, name);
 154   if (existing_feature) {
 155     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 156         existing_feature, name);
 157     factory = GST_TRACER_FACTORY_CAST (existing_feature);
 158     factory->type = type;
 159     existing_feature->loaded = TRUE;
 160     //g_type_set_qdata (type, __gst_elementclass_factory, factory);
 161     gst_object_unref (existing_feature);
 162     return TRUE;
 163   }
 164
 165   factory = g_object_newv (GST_TYPE_TRACER_FACTORY, 0, NULL);
 166   GST_DEBUG_OBJECT (factory, "new tracer factory for %s", name);
 167
 168   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 169   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory),
 170       GST_RANK_NONE);
 171
 172   factory->type = type;
 173   GST_DEBUG_OBJECT (factory, "tracer factory for %u:%s",
 174       (guint) type, g_type_name (type));
 175
 176   if (plugin && plugin->desc.name) {
 177     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name; /* interned string */
 178     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 179     g_object_add_weak_pointer ((GObject *) plugin,
 180         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 181   } else {
 182     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 183     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 184   }
 185   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 186
 187   gst_registry_add_feature (gst_registry_get (),
 188       GST_PLUGIN_FEATURE_CAST (factory));
 189
 190   return TRUE;
 191 }
 192
 193 /* tracing helpers */
 194
 195 gboolean _priv_tracer_enabled = FALSE;
 196 /* TODO(ensonic): use GPtrArray ? */
 197 GList *_priv_tracers[GST_TRACER_HOOK_ID_LAST] = { NULL, };
 198
 199 /* Initialize the debugging system */
 200 void
 201 _priv_gst_tracer_init (void)
 202 {
 203   const gchar *env = g_getenv ("GST_TRACE");
 204
 205   if (env != NULL && *env != '\0') {
 206     GstRegistry *registry = gst_registry_get ();
 207     GstPluginFeature *feature;
 208     GstTracerFactory *factory;
 209     GstTracerHook mask;
 210     GstTracer *tracer;
 211     gchar **t = g_strsplit_set (env, ";", 0);
 212     gint i = 0, j;
 213     gchar *params;
 214
 215     GST_INFO ("enabling tracers: '%s'", env);
 216
 217     while (t[i]) {
 218       // check t[i] for params
 219       if ((params = strchr (t[i], '('))) {
 220         gchar *end = strchr (&params[1], ')');
 221         *params = '\0';
 222         params++;
 223         if (end)
 224           *end = '\0';
 225       } else {
 226         params = NULL;
 227       }
 228
 229       GST_INFO ("checking tracer: '%s'", t[i]);
 230
 231       if ((feature = gst_registry_lookup_feature (registry, t[i]))) {
 232         factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
 233         if (factory) {
 234           GST_INFO_OBJECT (factory, "creating tracer: type-id=%u",
 235               (guint) factory->type);
 236
 237           tracer = g_object_new (factory->type, "params", params, NULL);
 238           g_object_get (tracer, "mask", &mask, NULL);
 239
 240           if (mask) {
 241             /* add to lists according to mask */
 242             j = 0;
 243             while (mask && (j < GST_TRACER_HOOK_ID_LAST)) {
 244               if (mask & 1) {
 245                 _priv_tracers[j] = g_list_prepend (_priv_tracers[j],
 246                     gst_object_ref (tracer));
 247                 GST_WARNING_OBJECT (tracer, "added tracer to hook %d", j);
 248               }
 249               mask >>= 1;
 250               j++;
 251             }
 252
 253             _priv_tracer_enabled = TRUE;
 254           } else {
 255             GST_WARNING_OBJECT (tracer,
 256                 "tracer with zero mask won't have any effect");
 257           }
 258           gst_object_unref (tracer);
 259         } else {
 260           GST_WARNING_OBJECT (feature,
 261               "loading plugin containing feature %s failed!", t[i]);
 262         }
 263       } else {
 264         GST_WARNING ("no tracer named '%s'", t[i]);
 265       }
 266       i++;
 267     }
 268     g_strfreev (t);
 269   }
 270 }
 271
 272 void
 273 _priv_gst_tracer_deinit (void)
 274 {
 275   gint i;
 276   GList *node;
 277
 278   /* shutdown tracers for final reports */
 279   for (i = 0; i < GST_TRACER_HOOK_ID_LAST; i++) {
 280     for (node = _priv_tracers[i]; node; node = g_list_next (node)) {
 281       gst_object_unref (node->data);
 282     }
 283     g_list_free (_priv_tracers[i]);
 284     _priv_tracers[i] = NULL;
 285   }
 286   _priv_tracer_enabled = FALSE;
 287 }
 288
 289 void
 290 gst_tracer_dispatch (GstTracerHookId hid, GstTracerMessageId mid, ...)
 291 {
 292   va_list var_args;
 293   GList *node;
 294
 295   for (node = _priv_tracers[hid]; node; node = g_list_next (node)) {
 296     va_start (var_args, mid);
 297     gst_tracer_invoke (node->data, hid, mid, var_args);
 298     va_end (var_args);
 299   }
 300 }
 301
 302 /* tracing module helpers */
 303
 304 void
 305 gst_tracer_log_trace (GstStructure * s)
 306 {
 307   gchar *data;
 308
 309   // TODO(ensonic): use a GVariant?
 310   data = gst_structure_to_string (s);
 311   GST_TRACE ("%s", data);
 312   g_free (data);
 313   gst_structure_free (s);
 314 }
 315
 316 #endif /* GST_DISABLE_GST_DEBUG */