gst/gsttracerutils.h

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracerutils.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
  23 #ifndef __GST_TRACER_UTILS_H__
  24 #define __GST_TRACER_UTILS_H__
  25
  26 #include <glib.h>
  27 #include <glib-object.h>
  28 #include <gst/gstconfig.h>
  29 #include <gst/gstbin.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #ifndef GST_DISABLE_GST_DEBUG
  34
  35 /* tracing hooks */
  36
  37 void _priv_gst_tracing_init (void);
  38 void _priv_gst_tracing_deinit (void);
  39
  40 /* tracer quarks */
  41
  42 /* These enums need to match the number and order
  43  * of strings declared in _quark_table, in gsttracerutils.c */
  44 typedef enum /*< skip >*/
  45 {
  46   GST_TRACER_QUARK_HOOK_PAD_PUSH_PRE = 0,
  47   GST_TRACER_QUARK_HOOK_PAD_PUSH_POST,
  48   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_PRE,
  49   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_POST,
  50   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_PRE,
  51   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_POST,
  52   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_PRE ,
  53   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_POST,
  54   GST_TRACER_QUARK_HOOK_PAD_QUERY_PRE ,
  55   GST_TRACER_QUARK_HOOK_PAD_QUERY_POST,
  56   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_PRE,
  57   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_POST,
  58   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_PRE,
  59   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_POST,
  60   GST_TRACER_QUARK_HOOK_ELEMENT_NEW,
  61   GST_TRACER_QUARK_HOOK_ELEMENT_ADD_PAD,
  62   GST_TRACER_QUARK_HOOK_ELEMENT_REMOVE_PAD,
  63   GST_TRACER_QUARK_HOOK_BIN_ADD_PRE,
  64   GST_TRACER_QUARK_HOOK_BIN_ADD_POST,
  65   GST_TRACER_QUARK_HOOK_BIN_REMOVE_PRE,
  66   GST_TRACER_QUARK_HOOK_BIN_REMOVE_POST,
  67   GST_TRACER_QUARK_HOOK_PAD_LINK_PRE,
  68   GST_TRACER_QUARK_HOOK_PAD_LINK_POST,
  69   GST_TRACER_QUARK_HOOK_PAD_UNLINK_PRE,
  70   GST_TRACER_QUARK_HOOK_PAD_UNLINK_POST,
  71   GST_TRACER_QUARK_MAX
  72 } GstTracerQuarkId;
  73
  74 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  75
  76 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
  77
  78 /* tracing module helpers */
  79
  80 typedef struct {
  81   GObject *tracer;
  82   GCallback func;
  83 } GstTracerHook;
  84
  85 extern gboolean _priv_tracer_enabled;
  86 /* key are hook-id quarks, values are GstTracerHook */
  87 extern GHashTable *_priv_tracers;
  88
  89 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
  90
  91 #define GST_TRACER_TS \
  92   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
  93
  94 /* tracing hooks */
  95
  96 #define GST_TRACER_ARGS h->tracer, ts
  97 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
  98   if (GST_TRACER_IS_ENABLED) {                                         \
  99     GstClockTime ts = GST_TRACER_TS;                                   \
 100     GList *__l, *__n;                                                  \
 101     GstTracerHook *h;                                                  \
 102     __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key));  \
 103     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 104       h = (GstTracerHook *) __n->data;                                 \
 105       ((type)(h->func)) args;                                          \
 106     }                                                                  \
 107     __l = g_hash_table_lookup (_priv_tracers, NULL);                   \
 108     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 109       h = (GstTracerHook *) __n->data;                                 \
 110       ((type)(h->func)) args;                                          \
 111     }                                                                  \
 112   }                                                                    \
 113 }G_STMT_END
 114
 115 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
 116     GstBuffer *);
 117 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
 118   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
 119     GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
 120 }G_STMT_END
 121
 122 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
 123     GstFlowReturn);
 124 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
 125   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
 126     GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
 127 }G_STMT_END
 128
 129 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
 130     GstBufferList *);
 131 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 132   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
 133     GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
 134 }G_STMT_END
 135
 136 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
 137     GstFlowReturn);
 138 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 139   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
 140     GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
 141 }G_STMT_END
 142
 143 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
 144     guint64, guint);
 145 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 146   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
 147     GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
 148 }G_STMT_END
 149
 150 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
 151     GstPad *, GstBuffer *, GstFlowReturn);
 152 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 153   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
 154     GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
 155 }G_STMT_END
 156
 157 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
 158     GstEvent *);
 159 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 160   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
 161     GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
 162 }G_STMT_END
 163
 164 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
 165     GstPad *, gboolean);
 166 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 167   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
 168     GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
 169 }G_STMT_END
 170
 171 typedef void (*GstTracerHookPadQueryPre) (GObject *, GstClockTime, GstPad *,
 172     GstQuery *);
 173 #define GST_TRACER_PAD_QUERY_PRE(pad, query) G_STMT_START{ \
 174   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_PRE), \
 175     GstTracerHookPadQueryPre, (GST_TRACER_ARGS, pad, query)); \
 176 }G_STMT_END
 177
 178 typedef void (*GstTracerHookPadQueryPost) (GObject *, GstClockTime,
 179     GstPad *, gboolean, GstQuery *);
 180 #define GST_TRACER_PAD_QUERY_POST(pad, res, query) G_STMT_START{ \
 181   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_POST), \
 182     GstTracerHookPadQueryPost, (GST_TRACER_ARGS, pad, res, query)); \
 183 }G_STMT_END
 184
 185 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
 186     GstElement *, GstMessage *);
 187 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 188   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
 189     GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
 190 }G_STMT_END
 191
 192 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
 193     GstElement *, gboolean);
 194 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 195   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
 196     GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
 197 }G_STMT_END
 198
 199 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
 200     GstElement *, GstQuery *);
 201 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 202   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
 203     GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
 204 }G_STMT_END
 205
 206 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
 207     GstElement *, gboolean);
 208 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 209   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
 210     GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
 211 }G_STMT_END
 212
 213 typedef void (*GstTracerHookElementNew) (GObject *, GstClockTime,
 214     GstElement *);
 215 #define GST_TRACER_ELEMENT_NEW(element) G_STMT_START{ \
 216   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_NEW), \
 217     GstTracerHookElementNew, (GST_TRACER_ARGS, element)); \
 218 }G_STMT_END
 219
 220 typedef void (*GstTracerHookElementAddPad) (GObject *, GstClockTime,
 221     GstElement *, GstPad *);
 222 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad) G_STMT_START{ \
 223   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_ADD_PAD), \
 224     GstTracerHookElementAddPad, (GST_TRACER_ARGS, element, pad)); \
 225 }G_STMT_END
 226
 227 typedef void (*GstTracerHookElementRemovePad) (GObject *, GstClockTime,
 228     GstElement *, GstPad *);
 229 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad) G_STMT_START{ \
 230   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_REMOVE_PAD), \
 231     GstTracerHookElementRemovePad, (GST_TRACER_ARGS, element, pad)); \
 232 }G_STMT_END
 233
 234 typedef void (*GstTracerHookBinAddPre) (GObject *, GstClockTime,
 235     GstBin *, GstElement *);
 236 #define GST_TRACER_BIN_ADD_PRE(bin, element) G_STMT_START{ \
 237   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_PRE), \
 238     GstTracerHookBinAddPre, (GST_TRACER_ARGS, bin, element)); \
 239 }G_STMT_END
 240
 241 typedef void (*GstTracerHookBinAddPost) (GObject *, GstClockTime,
 242     GstBin *, GstElement *, gboolean);
 243 #define GST_TRACER_BIN_ADD_POST(bin, element, result) G_STMT_START{ \
 244   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_POST), \
 245     GstTracerHookBinAddPost, (GST_TRACER_ARGS, bin, element, result)); \
 246 }G_STMT_END
 247
 248 typedef void (*GstTracerHookBinRemovePre) (GObject *, GstClockTime,
 249     GstBin *, GstElement *);
 250 #define GST_TRACER_BIN_REMOVE_PRE(bin, element) G_STMT_START{ \
 251   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_PRE), \
 252     GstTracerHookBinRemovePre, (GST_TRACER_ARGS, bin, element)); \
 253 }G_STMT_END
 254
 255 typedef void (*GstTracerHookBinRemovePost) (GObject *, GstClockTime,
 256     GstBin *, gboolean);
 257 #define GST_TRACER_BIN_REMOVE_POST(bin, result) G_STMT_START{ \
 258   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_POST), \
 259     GstTracerHookBinRemovePost, (GST_TRACER_ARGS, bin, result)); \
 260 }G_STMT_END
 261
 262 typedef void (*GstTracerHookPadLinkPre) (GObject *, GstClockTime,
 263     GstPad *, GstPad *);
 264 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad) G_STMT_START{ \
 265   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_PRE), \
 266     GstTracerHookPadLinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
 267 }G_STMT_END
 268
 269 typedef void (*GstTracerHookPadLinkPost) (GObject *, GstClockTime,
 270     GstPad *, GstPad *, GstPadLinkReturn);
 271 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
 272   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_POST), \
 273     GstTracerHookPadLinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
 274 }G_STMT_END
 275
 276 typedef void (*GstTracerHookPadUnlinkPre) (GObject *, GstClockTime,
 277     GstPad *, GstPad *);
 278 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad) G_STMT_START{ \
 279   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_PRE), \
 280     GstTracerHookPadUnlinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
 281 }G_STMT_END
 282
 283 typedef void (*GstTracerHookPadUnlinkPost) (GObject *, GstClockTime,
 284     GstPad *, GstPad *, gboolean);
 285 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
 286   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_POST), \
 287     GstTracerHookPadUnlinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
 288 }G_STMT_END
 289
 290 #else /* !GST_DISABLE_GST_DEBUG */
 291
 292 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 293 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 294 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 295 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 296 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 297 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 298 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 299 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 300 #define GST_TRACER_PAD_QUERY_PRE(pad, query)
 301 #define GST_TRACER_PAD_QUERY_POST(pad, res, query)
 302 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 303 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 304 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 305 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 306 #define GST_TRACER_ELEMENT_NEW(element)
 307 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad)
 308 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad)
 309 #define GST_TRACER_BIN_ADD_PRE(bin, element)
 310 #define GST_TRACER_BIN_ADD_POST(bin, element, res)
 311 #define GST_TRACER_BIN_REMOVE_PRE(bin, element)
 312 #define GST_TRACER_BIN_REMOVE_POST(bin, res)
 313 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad)
 314 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, res)
 315 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad)
 316 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, res)
 317
 318 #endif /* GST_DISABLE_GST_DEBUG */
 319
 320 G_END_DECLS
 321
 322 #endif /* __GST_TRACER_UTILS_H__ */
 323