Do not install usterr-signal-safe
[lttng-ust.git] / include / lttng / ust-tracepoint-event.h
index 90e58e09319674ddd62b82d1c44e4bb516b9d216..6983ef1691d39949e3a72fe11cedf7030cf1d050 100644 (file)
@@ -1,27 +1,21 @@
 /*
- * Copyright (C) 2009     Steven Rostedt <srostedt@redhat.com>
- * Copyright (C) 2011     Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation;
- * version 2.1 of the License.
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
  *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ * Permission is hereby granted to use or copy this program
+ * for any purpose,  provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is granted,
+ * provided the above notices are retained, and a notice that the code was
+ * modified is included with the above copyright notice.
  */
 
 #include <stdio.h>
 #include <urcu/compiler.h>
 #include <lttng/ust-events.h>
-#include <lttng/usterr-signal-safe.h>
 #include <lttng/ringbuffer-config.h>
+#include <string.h>
 
 /*
  * Macro declarations used for all stages.
 /* ctf_string is redefined at each step */
 
 /*
- * TRACEPOINT_EVENT_CLASS can be used to add a generic function handlers
- * for events. That is, if all events have the same parameters and just
- * have distinct trace points.  Each tracepoint can be defined with
- * TRACEPOINT_EVENT_INSTANCE and that will map the
- * TRACEPOINT_EVENT_CLASS to the tracepoint.
+ * TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
+ * same arguments and having the same field layout.
+ *
+ * TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
+ * its own provider and name. It refers to a class (template).
  *
- * TRACEPOINT_EVENT is a one to one mapping between tracepoint and
- * template.
+ * TRACEPOINT_EVENT declared both a class and an instance and does a
+ * direct mapping from the instance to the class.
  */
 
 #undef TRACEPOINT_EVENT
-#define TRACEPOINT_EVENT(provider, name, proto, args, fields)  \
-       TRACEPOINT_EVENT_CLASS(provider, name,          \
-                            TP_PARAMS(proto),          \
-                            TP_PARAMS(args),           \
-                            TP_PARAMS(fields))         \
-       TRACEPOINT_EVENT_INSTANCE(provider, name, name, TP_PARAMS(proto), TP_PARAMS(args))
-
-#undef TRACEPOINT_EVENT_NOARGS
-#define TRACEPOINT_EVENT_NOARGS(provider, name, fields)        \
-       TRACEPOINT_EVENT_CLASS_NOARGS(provider, name,   \
-                            TP_PARAMS(fields))         \
-       TRACEPOINT_EVENT_INSTANCE_NOARGS(provider, name, name)
+#define TRACEPOINT_EVENT(_provider, _name, _args, _fields)     \
+       TRACEPOINT_EVENT_CLASS(_provider, _name,                \
+                        _TP_PARAMS(_args),                     \
+                        _TP_PARAMS(_fields))                   \
+       TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name,      \
+                        _TP_PARAMS(args))
 
 /* Helpers */
 #define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
                __max1 > __max2 ? __max1: __max2;       \
        })
 
+/*
+ * Stage 0 of tracepoint event generation.
+ *
+ * Check that each TRACEPOINT_EVENT provider argument match the
+ * TRACEPOINT_PROVIDER by creating dummy callbacks.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
+
+static inline
+void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
+{
+}
+
+#undef TRACEPOINT_EVENT_CLASS
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)       \
+       __tracepoint_provider_mismatch_##_provider();
+
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)  \
+       __tracepoint_provider_mismatch_##_provider();
+
+static __attribute__((unused))
+void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
+{
+#include TRACEPOINT_INCLUDE
+}
 
 /*
- * Stage 1 of the trace events.
+ * Stage 1 of tracepoint event generation.
  *
  * Create event field type metadata section.
  * Each event produce an array of fields.
 #undef TP_FIELDS
 #define TP_FIELDS(args...) args        /* Only one used in this phase */
 
-#undef TRACEPOINT_EVENT_CLASS_NOARGS
-#define TRACEPOINT_EVENT_CLASS_NOARGS(_provider, _name, _fields)                            \
+#undef TRACEPOINT_EVENT_CLASS
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)                            \
        static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
-               _fields                                                      \
+               _fields                                                                      \
        };
 
-#undef TRACEPOINT_EVENT_CLASS
-#define TRACEPOINT_EVENT_CLASS(_provider, _name, _proto, _args, _fields)                    \
-       TRACEPOINT_EVENT_CLASS_NOARGS(_provider, _name, TP_PARAMS(_fields))
-
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
 
 /*
- * Stage 2 of the trace events.
+ * Stage 2 of tracepoint event generation.
  *
  * Create probe callback prototypes.
  */
 /* Reset all macros within TRACEPOINT_EVENT */
 #include <lttng/ust-tracepoint-event-reset.h>
 
-#undef TP_PROTO
-#define TP_PROTO(args...) args
+#undef TP_ARGS
+#define TP_ARGS(args...) args
 
 #undef TRACEPOINT_EVENT_CLASS
-#define TRACEPOINT_EVENT_CLASS(_provider, _name, _proto, _args, _fields)                    \
-static void __event_probe__##_provider##___##_name(void *__data, _proto);
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)               \
+static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
 
-#undef TRACEPOINT_EVENT_CLASS_NOARGS
-#define TRACEPOINT_EVENT_CLASS_NOARGS(_provider, _name, _fields)                            \
-static void __event_probe__##_provider##___##_name(void *__data);
-
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
 
 /*
- * Stage 3 of the trace events.
+ * Stage 3 of tracepoint event generation.
  *
  * Create an array of events.
  */
@@ -213,8 +221,8 @@ static void __event_probe__##_provider##___##_name(void *__data);
 /* Reset all macros within TRACEPOINT_EVENT */
 #include <lttng/ust-tracepoint-event-reset.h>
 
-#undef TRACEPOINT_EVENT_INSTANCE_NOARGS
-#define TRACEPOINT_EVENT_INSTANCE_NOARGS(_provider, _template, _name)         \
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)         \
                {                                                              \
                        .fields = __event_fields___##_provider##___##_template,\
                        .name = #_provider ":" #_name,                         \
@@ -222,41 +230,25 @@ static void __event_probe__##_provider##___##_name(void *__data);
                        .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template), \
                },
 
-#undef TRACEPOINT_EVENT_INSTANCE
-#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _proto, _args)         \
-       TRACEPOINT_EVENT_INSTANCE_NOARGS(_provider, _template, _name)
-
-#define TP_ID1(_token, _system)        _token##_system
-#define TP_ID(_token, _system) TP_ID1(_token, _system)
-
-static const struct lttng_event_desc TP_ID(__event_desc___, TRACEPOINT_SYSTEM)[] = {
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+static const struct lttng_event_desc _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
+#include TRACEPOINT_INCLUDE
 };
 
-#undef TP_ID1
-#undef TP_ID
-
 
 /*
- * Stage 4 of the trace events.
+ * Stage 4 of tracepoint event generation.
  *
  * Create a toplevel descriptor for the whole probe.
  */
 
-#define TP_ID1(_token, _system)        _token##_system
-#define TP_ID(_token, _system) TP_ID1(_token, _system)
-
 /* non-const because list head will be modified when registered. */
-static struct lttng_probe_desc TP_ID(__probe_desc___, TRACEPOINT_SYSTEM) = {
-       .event_desc = TP_ID(__event_desc___, TRACEPOINT_SYSTEM),
-       .nr_events = _TP_ARRAY_SIZE(TP_ID(__event_desc___, TRACEPOINT_SYSTEM)),
+static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
+       .event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
+       .nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)),
 };
 
-#undef TP_ID1
-#undef TP_ID
-
 /*
- * Stage 5 of the trace events.
+ * Stage 5 of tracepoint event generation.
  *
  * Create static inline function that calculates event size.
  */
@@ -293,15 +285,15 @@ static struct lttng_probe_desc TP_ID(__probe_desc___, TRACEPOINT_SYSTEM) = {
 #define ctf_string(_item, _src)                                                       \
        __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
 
-#undef TP_PROTO
-#define TP_PROTO(args...) args
+#undef TP_ARGS
+#define TP_ARGS(args...) args
 
 #undef TP_FIELDS
 #define TP_FIELDS(args...) args
 
 #undef TRACEPOINT_EVENT_CLASS
-#define TRACEPOINT_EVENT_CLASS(_provider, _name, _proto, _args, _fields)      \
-static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _proto) \
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)      \
+static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
 {                                                                            \
        size_t __event_len = 0;                                               \
        unsigned int __dynamic_len_idx = 0;                                   \
@@ -312,10 +304,10 @@ static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic
        return __event_len;                                                   \
 }
 
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
 
 /*
- * Stage 6 of the trace events.
+ * Stage 6 of tracepoint event generation.
  *
  * Create static inline function that calculates event payload alignment.
  */
@@ -344,33 +336,30 @@ static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic
 #undef ctf_string
 #define ctf_string(_item, _src)
 
-#undef TP_PROTO
-#define TP_PROTO(args...) args
+#undef TP_ARGS
+#define TP_ARGS(args...) args
 
 #undef TP_FIELDS
 #define TP_FIELDS(args...) args
 
 #undef TRACEPOINT_EVENT_CLASS
-#define TRACEPOINT_EVENT_CLASS(_provider, _name, _proto, _args, _fields)      \
-static inline size_t __event_get_align__##_provider##___##_name(_proto)              \
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)             \
+static inline                                                                \
+size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args))      \
 {                                                                            \
        size_t __event_align = 1;                                             \
        _fields                                                               \
        return __event_align;                                                 \
 }
 
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
 
 
 /*
- * Stage 7 of the trace events.
- *
- * Create the probe function : call even size calculation and write event data
- * into the buffer.
+ * Stage 7 of tracepoint event generation.
  *
- * We use both the field and assignment macros to write the fields in the order
- * defined in the field declaration. The field declarations control the
- * execution order, jumping to the appropriate assignment block.
+ * Create the probe function. This function calls event size calculation
+ * and writes event data into the buffer.
  */
 
 /* Reset all macros within TRACEPOINT_EVENT */
@@ -418,9 +407,6 @@ static inline size_t __event_get_align__##_provider##___##_name(_proto)           \
 #undef __get_dynamic_len
 #define __get_dynamic_len(field)       __dynamic_len[__dynamic_len_idx++]
 
-#undef TP_PROTO
-#define TP_PROTO(args...) args
-
 #undef TP_ARGS
 #define TP_ARGS(args...) args
 
@@ -428,12 +414,12 @@ static inline size_t __event_get_align__##_provider##___##_name(_proto)         \
 #define TP_FIELDS(args...) args
 
 #undef TRACEPOINT_EVENT_CLASS
-#define TRACEPOINT_EVENT_CLASS(_provider, _name, _proto, _args, _fields)      \
-static void __event_probe__##_provider##___##_name(void *__data, _proto)      \
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)             \
+static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args))\
 {                                                                            \
-       struct ltt_event *__event = __data;                                   \
+       struct ltt_event *__event = __tp_data;                                \
        struct ltt_channel *__chan = __event->chan;                           \
-       struct lttng_ust_lib_ring_buffer_ctx __ctx;                                   \
+       struct lttng_ust_lib_ring_buffer_ctx __ctx;                           \
        size_t __event_len, __event_align;                                    \
        size_t __dynamic_len_idx = 0;                                         \
        size_t __dynamic_len[_TP_ARRAY_SIZE(__event_fields___##_provider##___##_name)];       \
@@ -447,8 +433,9 @@ static void __event_probe__##_provider##___##_name(void *__data, _proto)      \
                return;                                                       \
        if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled)))                 \
                return;                                                       \
-       __event_len = __event_get_size__##_provider##___##_name(__dynamic_len, _args);        \
-       __event_align = __event_get_align__##_provider##___##_name(_args);                    \
+       __event_len = __event_get_size__##_provider##___##_name(__dynamic_len,\
+                _TP_ARGS_DATA_VAR(_args));                                   \
+       __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
        lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len,  \
                                 __event_align, -1, __chan->handle);          \
        __ret = __chan->ops->event_reserve(&__ctx, __event->id);              \
@@ -458,39 +445,12 @@ static void __event_probe__##_provider##___##_name(void *__data, _proto)      \
        __chan->ops->event_commit(&__ctx);                                    \
 }
 
-#undef TRACEPOINT_EVENT_CLASS_NOARGS
-#define TRACEPOINT_EVENT_CLASS_NOARGS(_provider, _name, _fields)             \
-static void __event_probe__##_provider##___##_name(void *__data)             \
-{                                                                            \
-       struct ltt_event *__event = __data;                                   \
-       struct ltt_channel *__chan = __event->chan;                           \
-       struct lttng_ust_lib_ring_buffer_ctx __ctx;                                   \
-       size_t __event_len, __event_align;                                    \
-       int __ret;                                                            \
-                                                                             \
-       if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active)))          \
-               return;                                                       \
-       if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled)))                  \
-               return;                                                       \
-       if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled)))                 \
-               return;                                                       \
-       __event_len = 0;                                                      \
-       __event_align = 1;                                                    \
-       lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len,  \
-                                __event_align, -1, __chan->handle);          \
-       __ret = __chan->ops->event_reserve(&__ctx, __event->id);              \
-       if (__ret < 0)                                                        \
-               return;                                                       \
-       _fields                                                               \
-       __chan->ops->event_commit(&__ctx);                                    \
-}
-
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
 
 #undef __get_dynamic_len
 
 /*
- * Stage 8 of the trace events.
+ * Stage 8 of tracepoint event generation.
  *
  * Register/unregister probes at module load/unload.
  */
@@ -498,23 +458,17 @@ static void __event_probe__##_provider##___##_name(void *__data)        \
 /* Reset all macros within TRACEPOINT_EVENT */
 #include <lttng/ust-tracepoint-event-reset.h>
 
-#define TP_ID1(_token, _system)        _token##_system
-#define TP_ID(_token, _system) TP_ID1(_token, _system)
-
 static void __attribute__((constructor))
-TP_ID(__lttng_events_init__, TRACEPOINT_SYSTEM)(void)
+_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
 {
        int ret;
 
-       ret = ltt_probe_register(&TP_ID(__probe_desc___, TRACEPOINT_SYSTEM));
+       ret = ltt_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
        assert(!ret);
 }
 
 static void __attribute__((destructor))
-TP_ID(__lttng_events_exit__, TRACEPOINT_SYSTEM)(void)
+_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
 {
-       ltt_probe_unregister(&TP_ID(__probe_desc___, TRACEPOINT_SYSTEM));
+       ltt_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
 }
-
-#undef TP_ID1
-#undef TP_ID
This page took 0.030426 seconds and 4 git commands to generate.