#include <urcu/system.h>
#include <dlfcn.h> /* for dlopen */
#include <string.h> /* for memset */
+
#include <lttng/ust-config.h> /* for sdt */
#include <lttng/ust-compiler.h>
+#include <lttng/ust-tracer.h>
+
+#define LTTNG_UST_TRACEPOINT_NAME_LEN_MAX 256
#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
/*
*/
#include <sys/sdt.h>
-#define _LTTNG_SDT_NARG(...) \
- __LTTNG_SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0)
+#define _LTTNG_UST_SDT_NARG(...) \
+ __LTTNG_UST_SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0)
-#define __LTTNG_SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N
+#define __LTTNG_UST_SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N
-#define _LTTNG_SDT_PROBE_N(provider, name, N, ...) \
+#define _LTTNG_UST_SDT_PROBE_N(provider, name, N, ...) \
_SDT_PROBE(provider, name, N, (__VA_ARGS__))
-#define LTTNG_STAP_PROBEV(provider, name, ...) \
- _LTTNG_SDT_PROBE_N(provider, name, _LTTNG_SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__)
+#define LTTNG_UST_STAP_PROBEV(provider, name, ...) \
+ _LTTNG_UST_SDT_PROBE_N(provider, name, _LTTNG_UST_SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__)
#else
-#define LTTNG_STAP_PROBEV(...)
+#define LTTNG_UST_STAP_PROBEV(...)
#endif
#ifdef __cplusplus
#define tracepoint(provider, name, ...) \
do { \
- LTTNG_STAP_PROBEV(provider, name, ## __VA_ARGS__); \
+ LTTNG_UST_STAP_PROBEV(provider, name, ## __VA_ARGS__); \
if (tracepoint_enabled(provider, name)) \
do_tracepoint(provider, name, __VA_ARGS__); \
} while (0)
#define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_PARAMS(...) __VA_ARGS__
+/*
+ * sizeof(#_provider) - 1 : length of the provider string (excluding \0).
+ * sizeof(#_name) - 1 : length of the name string (excluding \0).
+ * + 1 : separator between provider and event name.
+ *
+ * Upper bound (inclusive) is LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1 to
+ * account for \0.
+ *
+ * The comparison is:
+ * left hand side: sizeof(#_provider) - 1 + sizeof(#_name) - 1 + 1
+ * right hand side: LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1
+ * operator: <= (inclusive)
+ * Simplified in the code below.
+ */
+#define lttng_ust_tracepoint_validate_name_len(_provider, _name) \
+ lttng_ust_static_assert(sizeof(#_provider) + sizeof(#_name) <= LTTNG_UST_TRACEPOINT_NAME_LEN_MAX, \
+ "Tracepoint name length is too long", \
+ Tracepoint_name_length_is_too_long)
+
/*
* The tracepoint cb is marked always inline so we can distinguish
* between caller's ip addresses within the probe using the return
*/
#define _DECLARE_TRACEPOINT(_provider, _name, ...) \
extern struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name; \
-static inline __attribute__((always_inline, unused)) lttng_ust_notrace \
-void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
+static inline \
+void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
+ __attribute__((always_inline, unused)) lttng_ust_notrace; \
static \
void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
{ \
end: \
tp_rcu_read_unlock(); \
} \
-static inline lttng_ust_notrace \
-void __tracepoint_register_##_provider##___##_name(char *name, \
- void (*func)(void), void *data); \
static inline \
-void __tracepoint_register_##_provider##___##_name(char *name, \
+void __tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
+ void (*func)(void), void *data) \
+ lttng_ust_notrace; \
+static inline \
+void __tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
void (*func)(void), void *data) \
{ \
- __tracepoint_probe_register(name, func, data, \
+ __tracepoint_probe_register(provider_name, event_name, func, data, \
__tracepoint_##_provider##___##_name.signature); \
} \
-static inline lttng_ust_notrace \
-void __tracepoint_unregister_##_provider##___##_name(char *name, \
- void (*func)(void), void *data); \
static inline \
-void __tracepoint_unregister_##_provider##___##_name(char *name, \
+void __tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
+ void (*func)(void), void *data) \
+ lttng_ust_notrace; \
+static inline \
+void __tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
void (*func)(void), void *data) \
{ \
- __tracepoint_probe_unregister(name, func, data); \
+ __tracepoint_probe_unregister(provider_name, event_name, func, data); \
}
-extern int __tracepoint_probe_register(const char *name, void (*func)(void),
- void *data, const char *signature);
-extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
- void *data);
+extern int __tracepoint_probe_register(const char *provider_name, const char *event_name,
+ void (*func)(void), void *data, const char *signature);
+extern int __tracepoint_probe_unregister(const char *provider_name, const char *event_name,
+ void (*func)(void), void *data);
/*
* tracepoint dynamic linkage handling (callbacks). Hidden visibility:
* shared across objects in a module/main executable.
+ *
+ * IMPORTANT: this structure is part of the ABI between instrumented
+ * applications and UST. Fields need to be only added at the end, never
+ * reordered, never removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
*/
struct lttng_ust_tracepoint_dlopen {
+ uint32_t struct_size;
+
void *liblttngust_handle;
int (*tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start,
void (*rcu_read_lock_sym)(void);
void (*rcu_read_unlock_sym)(void);
void *(*rcu_dereference_sym)(void *p);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
extern struct lttng_ust_tracepoint_dlopen tracepoint_dlopen;
int __tracepoint_ptrs_registered
__attribute__((weak, visibility("hidden")));
struct lttng_ust_tracepoint_dlopen tracepoint_dlopen
- __attribute__((weak, visibility("hidden")));
+ __attribute__((weak, visibility("hidden"))) = {
+ .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen),
+};
/*
* Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
* 4.8 and prior does not have the same behavior for symbol scoping on
* Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared
* across objects in a module/main executable. The callbacks are used to
* control and check if the destructors should be executed.
+ *
+ * IMPORTANT: this structure is part of the ABI between instrumented
+ * applications and UST. Fields need to be only added at the end, never
+ * reordered, never removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
*/
struct lttng_ust_tracepoint_destructors_syms {
+ uint32_t struct_size;
+
void (*tracepoint_disable_destructors)(void);
int (*tracepoint_get_destructors_state)(void);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
extern struct lttng_ust_tracepoint_destructors_syms tracepoint_destructors_syms;
extern struct lttng_ust_tracepoint_destructors_syms *tracepoint_destructors_syms_ptr;
struct lttng_ust_tracepoint_destructors_syms tracepoint_destructors_syms
- __attribute__((weak, visibility("hidden")));
+ __attribute__((weak, visibility("hidden"))) = {
+ .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms),
+};
struct lttng_ust_tracepoint_destructors_syms *tracepoint_destructors_syms_ptr
__attribute__((weak, visibility("hidden")));
}
#ifndef _LGPL_SOURCE
-static inline void lttng_ust_notrace
-__tracepoint__init_urcu_sym(void);
+static inline void
+__tracepoint__init_urcu_sym(void)
+ lttng_ust_notrace;
static inline void
__tracepoint__init_urcu_sym(void)
{
"tp_rcu_dereference_sym"));
}
#else
-static inline void lttng_ust_notrace
-__tracepoint__init_urcu_sym(void);
+static inline void
+__tracepoint__init_urcu_sym(void)
+ lttng_ust_notrace;
static inline void
__tracepoint__init_urcu_sym(void)
{
}
#endif
-static void lttng_ust_notrace __attribute__((constructor))
-__tracepoints__init(void);
+static void
+__tracepoints__init(void)
+ lttng_ust_notrace __attribute__((constructor));
static void
__tracepoints__init(void)
{
tracepoint_dlopen_ptr = &tracepoint_dlopen;
if (!tracepoint_dlopen_ptr->liblttngust_handle)
tracepoint_dlopen_ptr->liblttngust_handle =
- dlopen("liblttng-ust-tracepoint.so.1", RTLD_NOW | RTLD_GLOBAL);
+ dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
if (!tracepoint_dlopen_ptr->liblttngust_handle)
return;
__tracepoint__init_urcu_sym();
}
-static void lttng_ust_notrace __attribute__((destructor))
-__tracepoints__destroy(void);
+static void
+__tracepoints__destroy(void)
+ lttng_ust_notrace __attribute__((destructor));
static void
__tracepoints__destroy(void)
{
#define _TP_EXTRACT_STRING(...) #__VA_ARGS__
#define _DEFINE_TRACEPOINT(_provider, _name, _args) \
+ lttng_ust_tracepoint_validate_name_len(_provider, _name); \
extern int __tracepoint_provider_##_provider; \
- static const char __tp_strtab_##_provider##___##_name[] \
+ static const char __tp_provider_strtab_##_provider##___##_name[] \
+ __attribute__((section("__tracepoints_strings"))) = \
+ #_provider; \
+ static const char __tp_name_strtab_##_provider##___##_name[] \
__attribute__((section("__tracepoints_strings"))) = \
- #_provider ":" #_name; \
+ #_name; \
struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name \
- __attribute__((section("__tracepoints"))) = \
- { \
- __tp_strtab_##_provider##___##_name, \
+ __attribute__((section("__tracepoints"))) = { \
+ sizeof(struct lttng_ust_tracepoint), \
+ __tp_provider_strtab_##_provider##___##_name, \
+ __tp_name_strtab_##_provider##___##_name, \
0, \
NULL, \
_TRACEPOINT_UNDEFINED_REF(_provider), \
_TP_EXTRACT_STRING(_args), \
- { }, \
}; \
static struct lttng_ust_tracepoint * \
__tracepoint_ptr_##_provider##___##_name \
__lttng_ust_variable_attribute_no_sanitize_address = \
&__tracepoint_##_provider##___##_name;
-static void lttng_ust_notrace __attribute__((constructor))
-__tracepoints__ptrs_init(void);
+static void
+__tracepoints__ptrs_init(void)
+ lttng_ust_notrace __attribute__((constructor));
static void
__tracepoints__ptrs_init(void)
{
tracepoint_dlopen_ptr = &tracepoint_dlopen;
if (!tracepoint_dlopen_ptr->liblttngust_handle)
tracepoint_dlopen_ptr->liblttngust_handle =
- dlopen("liblttng-ust-tracepoint.so.1", RTLD_NOW | RTLD_GLOBAL);
+ dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
if (!tracepoint_dlopen_ptr->liblttngust_handle)
return;
if (!tracepoint_destructors_syms_ptr)
}
}
-static void lttng_ust_notrace __attribute__((destructor))
-__tracepoints__ptrs_destroy(void);
+static void
+__tracepoints__ptrs_destroy(void)
+ lttng_ust_notrace __attribute__((destructor));
static void
__tracepoints__ptrs_destroy(void)
{