/*
- * Copyright (C) 2009 Steven Rostedt <srostedt@redhat.com>
- * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (c) 2011-2012 - 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.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * 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
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*/
#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, args, fields) \
- TRACEPOINT_EVENT_CLASS(provider, name, \
- TP_PARAMS(args), \
- TP_PARAMS(fields)) \
- TRACEPOINT_EVENT_INSTANCE(provider, name, name, TP_PARAMS(args))
+#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]))
})
/*
- * Stage 0 of the trace events.
+ * 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>
-#define TP_ID1(_token, _provider) _token##_provider
-#define TP_ID(_token, _provider) TP_ID1(_token, _provider)
-
static inline
-void TP_ID(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
+void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
{
}
#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
__tracepoint_provider_mismatch_##_provider();
-static __attribute__((unused))
-void TP_ID(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
+static inline
+void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
{
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
}
-#undef TP_ID1
-#undef TP_ID
+/*
+ * Stage 0.1 of tracepoint event generation.
+ *
+ * Check that each TRACEPOINT_EVENT provider:name does not exceed the
+ * tracepoint name length limit.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
+
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
+static const char \
+ __tp_name_len_check##_provider##___##_name[LTTNG_UST_SYM_NAME_LEN] \
+ __attribute__((unused)) = \
+ #_provider ":" #_name;
+
+#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 */
+#define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
_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.
*/
#include <lttng/ust-tracepoint-event-reset.h>
#undef TP_ARGS
-#define TP_ARGS(args...) args
+#define TP_ARGS(...) __VA_ARGS__
#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
-static void __event_probe__##_provider##___##_name(_TP_ARGS_PROTO_DATA(_args));
-
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
-
-/*
- * Stage 3 of the trace events.
- *
- * Create an array of events.
- */
-
-/* Reset all macros within TRACEPOINT_EVENT */
-#include <lttng/ust-tracepoint-event-reset.h>
-
-#undef TRACEPOINT_EVENT_INSTANCE
-#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
- { \
- .fields = __event_fields___##_provider##___##_template,\
- .name = #_provider ":" #_name, \
- .probe_callback = (void *) &__event_probe__##_provider##___##_template,\
- .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template), \
- },
-
-#define TP_ID1(_token, _provider) _token##_provider
-#define TP_ID(_token, _provider) TP_ID1(_token, _provider)
-
-static const struct lttng_event_desc TP_ID(__event_desc___, TRACEPOINT_PROVIDER)[] = {
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
-};
-
-#undef TP_ID1
-#undef TP_ID
-
-
-/*
- * Stage 4 of the trace events.
- *
- * Create a toplevel descriptor for the whole probe.
- */
-
-#define TP_ID1(_token, _provider) _token##_provider
-#define TP_ID(_token, _provider) TP_ID1(_token, _provider)
-
-/* non-const because list head will be modified when registered. */
-static struct lttng_probe_desc TP_ID(__probe_desc___, TRACEPOINT_PROVIDER) = {
- .event_desc = TP_ID(__event_desc___, TRACEPOINT_PROVIDER),
- .nr_events = _TP_ARRAY_SIZE(TP_ID(__event_desc___, TRACEPOINT_PROVIDER)),
-};
+static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
-#undef TP_ID1
-#undef TP_ID
+#include TRACEPOINT_INCLUDE
/*
- * Stage 5 of the trace events.
+ * Stage 3 of tracepoint event generation.
*
* Create static inline function that calculates event size.
*/
__event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
#undef TP_ARGS
-#define TP_ARGS(args...) args
+#define TP_ARGS(...) __VA_ARGS__
#undef TP_FIELDS
-#define TP_FIELDS(args...) args
+#define TP_FIELDS(...) __VA_ARGS__
#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
-static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_PROTO_DATA(_args)) \
+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; \
return __event_len; \
}
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#include TRACEPOINT_INCLUDE
/*
- * Stage 6 of the trace events.
+ * Stage 4 of tracepoint event generation.
*
* Create static inline function that calculates event payload alignment.
*/
#define ctf_string(_item, _src)
#undef TP_ARGS
-#define TP_ARGS(args...) args
+#define TP_ARGS(...) __VA_ARGS__
#undef TP_FIELDS
-#define TP_FIELDS(args...) args
+#define TP_FIELDS(...) __VA_ARGS__
#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _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 5 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 */
#define __get_dynamic_len(field) __dynamic_len[__dynamic_len_idx++]
#undef TP_ARGS
-#define TP_ARGS(args...) args
+#define TP_ARGS(...) __VA_ARGS__
#undef TP_FIELDS
-#define TP_FIELDS(args...) args
+#define TP_FIELDS(...) __VA_ARGS__
#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
-static void __event_probe__##_provider##___##_name(_TP_ARGS_PROTO_DATA(_args))\
+static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args))\
{ \
- struct ltt_event *__event = __tp_cb_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)]; \
if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
return; \
__event_len = __event_get_size__##_provider##___##_name(__dynamic_len,\
- _TP_ARGS_VARS_DATA(_args)); \
- __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VARS(_args)); \
+ _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); \
__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 5.1 of tracepoint event generation.
*
- * Register/unregister probes at module load/unload.
+ * Create probe signature
*/
/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>
-#define TP_ID1(_token, _provider) _token##_provider
-#define TP_ID(_token, _provider) TP_ID1(_token, _provider)
+#undef TP_ARGS
+#define TP_ARGS(...) __VA_ARGS__
+
+#define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
+
+#undef TRACEPOINT_EVENT_CLASS
+#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
+const char __tp_event_signature___##_provider##___##_name[] = \
+ _TP_EXTRACT_STRING2(_args);
+
+#include TRACEPOINT_INCLUDE
+
+#undef _TP_EXTRACT_STRING2
+/*
+ * Stage 6 of tracepoint event generation.
+ *
+ * Tracepoint loglevel mapping definition generation. We generate a
+ * symbol for each mapping for a provider/event to ensure at most a 1 to
+ * 1 mapping between events and loglevels. If the symbol is repeated,
+ * the compiler will complain.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
+
+#undef TRACEPOINT_LOGLEVEL
+#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
+static const int _loglevel_value___##__provider##___##__name = __loglevel; \
+static const int *_loglevel___##__provider##___##__name = \
+ &_loglevel_value___##__provider##___##__name;
+
+#include TRACEPOINT_INCLUDE
+
+/*
+ * Stage 7.1 of tracepoint event generation.
+ *
+ * Create events description structures. We use a weakref because
+ * loglevels are optional. If not declared, the event will point to the
+ * a loglevel that contains NULL.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
+
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
+static const int * \
+ __ref_loglevel___##_provider##___##_name \
+ __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
+const struct lttng_event_desc __event_desc___##_provider##_##_name = { \
+ .fields = __event_fields___##_provider##___##_template, \
+ .name = #_provider ":" #_name, \
+ .probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
+ .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template), \
+ .loglevel = &__ref_loglevel___##_provider##___##_name, \
+ .signature = __tp_event_signature___##_provider##___##_template, \
+};
+
+#include TRACEPOINT_INCLUDE
+
+/*
+ * Stage 7.2 of tracepoint event generation.
+ *
+ * Create array of events.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
+
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
+ &__event_desc___##_provider##_##_name,
+
+static const struct lttng_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
+#include TRACEPOINT_INCLUDE
+};
+
+
+/*
+ * Stage 8 of tracepoint event generation.
+ *
+ * Create a toplevel descriptor for the whole probe.
+ */
+
+/* non-const because list head will be modified when registered. */
+static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
+ .provider = __tp_stringify(TRACEPOINT_PROVIDER),
+ .event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
+ .nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)),
+};
+
+/*
+ * Stage 9 of tracepoint event generation.
+ *
+ * Register/unregister probes at module load/unload.
+ *
+ * Generate the constructor as an externally visible symbol for use when
+ * linking the probe statically.
+ */
+
+/* Reset all macros within TRACEPOINT_EVENT */
+#include <lttng/ust-tracepoint-event-reset.h>
static void __attribute__((constructor))
-TP_ID(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
+_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
{
int ret;
- ret = ltt_probe_register(&TP_ID(__probe_desc___, TRACEPOINT_PROVIDER));
+ /*
+ * __tracepoint_provider_check_ ## TRACEPOINT_PROVIDER() is a
+ * static inline function that ensures every probe PROVIDER
+ * argument match the provider within which they appear. It
+ * calls empty static inline functions, and therefore has no
+ * runtime effect. However, if it detects an error, a linker
+ * error will appear.
+ */
+ _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)();
+ ret = ltt_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
assert(!ret);
}
static void __attribute__((destructor))
-TP_ID(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
+_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
{
- ltt_probe_unregister(&TP_ID(__probe_desc___, TRACEPOINT_PROVIDER));
+ ltt_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
}
-#undef TP_ID1
-#undef TP_ID
+int _TP_COMBINE_TOKENS(__tracepoint_provider_, TRACEPOINT_PROVIDER);
projects / lttng-ust.git / blobdiff