gst/gsttracerutils.c

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracerutils.c: 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 /**
  23  * SECTION:gsttracerutils
  24  * @short_description: Tracing subsystem
  25  *
  26  * The tracing subsystem provides hooks in the core library and API for modules
  27  * to attach to them.
  28  *
  29  * The user can activate tracers by setting the environment variable GST_TRACE
  30  * to a ';' separated list of tracers.
  31  */
  32
  33 #define GST_USE_UNSTABLE_API
  34
  35 #include "gst_private.h"
  36 #include "gsttracer.h"
  37 #include "gsttracerfactory.h"
  38 #include "gsttracerutils.h"
  39
  40 #ifndef GST_DISABLE_GST_DEBUG
  41
  42 /* tracer quarks */
  43
  44 /* These strings must match order and number declared in the GstTracerQuarkId
  45  * enum in gsttracerutils.h! */
  46 static const gchar *_quark_strings[] = {
  47   "pad-push-pre", "pad-push-post", "pad-push-list-pre", "pad-push-list-post",
  48   "pad-pull-range-pre", "pad-pull-range-post", "pad-push-event-pre",
  49   "pad-push-event-post", "pad-query-pre", "pad-query-post",
  50   "element-post-message-pre",
  51   "element-post-message-post", "element-query-pre", "element-query-post"
  52 };
  53
  54 GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  55
  56 /* tracing helpers */
  57
  58 gboolean _priv_tracer_enabled = FALSE;
  59 GHashTable *_priv_tracers = NULL;
  60
  61 /* Initialize the tracing system */
  62 void
  63 _priv_gst_tracing_init (void)
  64 {
  65   const gchar *env = g_getenv ("GST_TRACE");
  66
  67   if (env != NULL && *env != '\0') {
  68     GstRegistry *registry = gst_registry_get ();
  69     GstPluginFeature *feature;
  70     GstTracerFactory *factory;
  71     gchar **t = g_strsplit_set (env, ";", 0);
  72     gint i = 0;
  73     gchar *params;
  74
  75     GST_INFO ("enabling tracers: '%s'", env);
  76
  77     if (G_N_ELEMENTS (_quark_strings) != GST_TRACER_QUARK_MAX)
  78       g_warning ("the quark table is not consistent! %d != %d",
  79           (gint) G_N_ELEMENTS (_quark_strings), GST_TRACER_QUARK_MAX);
  80
  81     for (i = 0; i < GST_TRACER_QUARK_MAX; i++) {
  82       _priv_gst_tracer_quark_table[i] =
  83           g_quark_from_static_string (_quark_strings[i]);
  84     }
  85
  86     _priv_tracers = g_hash_table_new (NULL, NULL);
  87
  88     i = 0;
  89     while (t[i]) {
  90       // check t[i] for params
  91       if ((params = strchr (t[i], '('))) {
  92         gchar *end = strchr (&params[1], ')');
  93         *params = '\0';
  94         params++;
  95         if (end)
  96           *end = '\0';
  97       } else {
  98         params = NULL;
  99       }
 100
 101       GST_INFO ("checking tracer: '%s'", t[i]);
 102
 103       if ((feature = gst_registry_lookup_feature (registry, t[i]))) {
 104         factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
 105         if (factory) {
 106           GST_INFO_OBJECT (factory, "creating tracer: type-id=%u",
 107               (guint) factory->type);
 108
 109           /* tracers register them self to the hooks */
 110           gst_object_unref (g_object_new (factory->type, "params", params,
 111                   NULL));
 112         } else {
 113           GST_WARNING_OBJECT (feature,
 114               "loading plugin containing feature %s failed!", t[i]);
 115         }
 116       } else {
 117         GST_WARNING ("no tracer named '%s'", t[i]);
 118       }
 119       i++;
 120     }
 121     g_strfreev (t);
 122   }
 123 }
 124
 125 void
 126 _priv_gst_tracing_deinit (void)
 127 {
 128   GList *h_list, *h_node, *t_node;
 129   GstTracerHook *hook;
 130
 131   _priv_tracer_enabled = FALSE;
 132   if (!_priv_tracers)
 133     return;
 134
 135   /* shutdown tracers for final reports */
 136   h_list = g_hash_table_get_values (_priv_tracers);
 137   for (h_node = h_list; h_node; h_node = g_list_next (h_node)) {
 138     for (t_node = h_node->data; t_node; t_node = g_list_next (t_node)) {
 139       hook = (GstTracerHook *) t_node->data;
 140       gst_object_unref (hook->tracer);
 141       g_slice_free (GstTracerHook, hook);
 142     }
 143     g_list_free (h_node->data);
 144   }
 145   g_list_free (h_list);
 146   g_hash_table_destroy (_priv_tracers);
 147   _priv_tracers = NULL;
 148 }
 149
 150 /**
 151  * gst_tracing_register_hook_id:
 152  * @tracer: the tracer
 153  * @detail: the detailed hook
 154  * @func: (scope async): the callback
 155  *
 156  * Register @func to be called when the trace hook @detail is getting invoked.
 157  */
 158 void
 159 gst_tracing_register_hook_id (GstTracer * tracer, GQuark detail, GCallback func)
 160 {
 161   gpointer key = GINT_TO_POINTER (detail);
 162   GList *list = g_hash_table_lookup (_priv_tracers, key);
 163   GstTracerHook *hook = g_slice_new0 (GstTracerHook);
 164   hook->tracer = gst_object_ref (tracer);
 165   hook->func = func;
 166
 167   list = g_list_prepend (list, hook);
 168   g_hash_table_replace (_priv_tracers, key, list);
 169   GST_DEBUG ("registering tracer for '%s', list.len=%d",
 170       (detail ? g_quark_to_string (detail) : "*"), g_list_length (list));
 171   _priv_tracer_enabled = TRUE;
 172 }
 173
 174 /**
 175  * gst_tracing_register_hook:
 176  * @tracer: the tracer
 177  * @detail: the detailed hook
 178  * @func: (scope async): the callback
 179  *
 180  * Register @func to be called when the trace hook @detail is getting invoked.
 181  */
 182 void
 183 gst_tracing_register_hook (GstTracer * tracer, const gchar * detail,
 184     GCallback func)
 185 {
 186   gst_tracing_register_hook_id (tracer, g_quark_try_string (detail), func);
 187 }
 188
 189 #endif /* GST_DISABLE_GST_DEBUG */