Introduce API compatibility macros
[lttng-ust.git] / include / lttng / ust-tracepoint-event.h
index 408e2a2b62330cc57c49c2d13ef3d2f9dc975d5f..e663e839bc0e5426b643dfce5f4f93e17ca57b8b 100644 (file)
@@ -10,7 +10,7 @@
 #include <urcu/compiler.h>
 #include <urcu/rculist.h>
 #include <lttng/ust-events.h>
-#include <lttng/ringbuffer-context.h>
+#include <lttng/ust-ringbuffer-context.h>
 #include <lttng/ust-arch.h>
 #include <lttng/ust-compiler.h>
 #include <lttng/tracepoint.h>
@@ -109,10 +109,7 @@ void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
 
 #undef _TRACEPOINT_EVENT_INSTANCE
 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
-static const char                                                      \
-       __tp_name_len_check##_provider##___##_name[LTTNG_UST_ABI_SYM_NAME_LEN] \
-       __attribute__((unused)) =                                       \
-               #_provider ":" #_name;
+       lttng_ust_tracepoint_validate_name_len(_provider, _name);
 
 #include TRACEPOINT_INCLUDE
 
@@ -150,7 +147,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 /* Enumeration entry (single value) */
 #undef ctf_enum_value
 #define ctf_enum_value(_string, _value)                                        \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, {   \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
                .struct_size = sizeof(struct lttng_ust_enum_entry),             \
                .start = {                                              \
                        .value = lttng_ust_is_signed_type(__typeof__(_value)) ? \
@@ -168,7 +165,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 /* Enumeration entry (range) */
 #undef ctf_enum_range
 #define ctf_enum_range(_string, _range_start, _range_end)              \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, {   \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
                .struct_size = sizeof(struct lttng_ust_enum_entry),             \
                .start = {                                              \
                        .value = lttng_ust_is_signed_type(__typeof__(_range_start)) ? \
@@ -186,7 +183,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 /* Enumeration entry (automatic value; follows the rules of CTF) */
 #undef ctf_enum_auto
 #define ctf_enum_auto(_string)                                         \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, {   \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
                .struct_size = sizeof(struct lttng_ust_enum_entry),             \
                .start = {                                              \
                        .value = -1ULL,                                 \
@@ -206,7 +203,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef TRACEPOINT_ENUM
 #define TRACEPOINT_ENUM(_provider, _name, _values)                     \
-       const struct lttng_ust_enum_entry *__enum_values__##_provider##_##_name[] = { \
+       const struct lttng_ust_enum_entry * const __enum_values__##_provider##_##_name[] = { \
                _values                                                 \
                ctf_enum_value("", 0)   /* Dummy, 0-len array forbidden by C99. */ \
        };
@@ -226,13 +223,13 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 #define _ctf_array_encoded(_type, _item, _src, _byte_order,    \
                        _length, _encoding, _nowrite,           \
                        _elem_type_base)                        \
-       lttng_ust_ctf_array_element_type_is_supported(_type, _item)
+       lttng_ust_ctf_array_element_type_is_supported(_type, _item);
 
 #undef _ctf_sequence_encoded
 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
                        _length_type, _src_length, _encoding, _nowrite, \
                        _elem_type_base)                        \
-       lttng_ust_ctf_array_element_type_is_supported(_type, _item)
+       lttng_ust_ctf_array_element_type_is_supported(_type, _item);
 
 #undef TP_FIELDS
 #define TP_FIELDS(...) __VA_ARGS__     /* Only one used in this phase */
@@ -257,7 +254,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef _ctf_integer_ext
 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
                .type = lttng_ust_type_integer_define(_type, _byte_order, _base), \
@@ -267,7 +264,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef _ctf_float
 #define _ctf_float(_type, _item, _src, _nowrite)               \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
                .type = lttng_ust_type_float_define(_type),     \
@@ -279,10 +276,10 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 #define _ctf_array_encoded(_type, _item, _src, _byte_order,    \
                        _length, _encoding, _nowrite,           \
                        _elem_type_base)                        \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
-               .type = (const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_array, { \
+               .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_array, { \
                        .parent = {                             \
                                .type = lttng_ust_type_array,   \
                        },                                      \
@@ -300,17 +297,17 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
                        _length_type, _src_length, _encoding, _nowrite, \
                        _elem_type_base)                        \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = "_" #_item "_length",                   \
                .type = lttng_ust_type_integer_define(_length_type, BYTE_ORDER, 10), \
                .nowrite = _nowrite,                            \
                .nofilter = 1,                                  \
        }),                                                     \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
-               .type = (const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_sequence, { \
+               .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_sequence, { \
                        .parent = {                             \
                                .type = lttng_ust_type_sequence, \
                        },                                      \
@@ -326,10 +323,10 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef _ctf_string
 #define _ctf_string(_item, _src, _nowrite)                     \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
-               .type = (const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_string, { \
+               .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_string, { \
                        .parent = {                             \
                                .type = lttng_ust_type_string,  \
                        },                                      \
@@ -345,10 +342,10 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef _ctf_enum
 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
-       __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
+       LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
                .struct_size = sizeof(struct lttng_ust_event_field), \
                .name = #_item,                                 \
-               .type = (const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_enum, { \
+               .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_enum, { \
                        .parent = {                             \
                                .type = lttng_ust_type_enum,    \
                        },                                      \
@@ -365,7 +362,7 @@ void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)
 
 #undef _TRACEPOINT_EVENT_CLASS
 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)                           \
-       static const struct lttng_ust_event_field *__event_fields___##_provider##___##_name[] = { \
+       static const struct lttng_ust_event_field * const __event_fields___##_provider##___##_name[] = { \
                _fields                                                                      \
                ctf_integer(int, dummy, 0)      /* Dummy, C99 forbids 0-len array. */        \
        };
@@ -413,14 +410,14 @@ static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite)       \
        if (0)                                                                   \
                (void) (_src);  /* Unused */                                     \
-       __event_len += lttng_ust_lib_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
+       __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
        __event_len += sizeof(_type);
 
 #undef _ctf_float
 #define _ctf_float(_type, _item, _src, _nowrite)                                \
        if (0)                                                                   \
                (void) (_src);  /* Unused */                                     \
-       __event_len += lttng_ust_lib_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
+       __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
        __event_len += sizeof(_type);
 
 #undef _ctf_array_encoded
@@ -428,7 +425,7 @@ static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
                        _nowrite, _elem_type_base)                               \
        if (0)                                                                   \
                (void) (_src);  /* Unused */                                     \
-       __event_len += lttng_ust_lib_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
+       __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
        __event_len += sizeof(_type) * (_length);
 
 #undef _ctf_sequence_encoded
@@ -436,9 +433,9 @@ static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
                        _src_length, _encoding, _nowrite, _elem_type_base)       \
        if (0)                                                                   \
                (void) (_src);  /* Unused */                                     \
-       __event_len += lttng_ust_lib_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_length_type));   \
+       __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_length_type));   \
        __event_len += sizeof(_length_type);                                   \
-       __event_len += lttng_ust_lib_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
+       __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
        __dynamic_len[__dynamic_len_idx] = (_src_length);                      \
        __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx];       \
        __dynamic_len_idx++;
@@ -889,12 +886,12 @@ void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args))         \
                size_t __event_len, __event_align;                            \
                struct lttng_ust_event_recorder *__event_recorder = (struct lttng_ust_event_recorder *) __event->child; \
                struct lttng_ust_channel_buffer *__chan = __event_recorder->chan; \
-               struct lttng_ust_lib_ring_buffer_ctx __ctx;                   \
+               struct lttng_ust_ring_buffer_ctx __ctx;               \
                                                                              \
                __event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
                         _TP_ARGS_DATA_VAR(_args));                           \
                __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
-               lttng_ust_lib_ring_buffer_ctx_init(&__ctx, __event_recorder, __event_len, __event_align, \
+               lttng_ust_ring_buffer_ctx_init(&__ctx, __event_recorder, __event_len, __event_align, \
                                _TP_IP_PARAM(TP_IP_PARAM));                   \
                __ret = __chan->ops->event_reserve(&__ctx);                   \
                if (__ret < 0)                                                \
@@ -969,21 +966,21 @@ static const char __tp_event_signature___##_provider##___##_name[] =      \
  * mangled.
  */
 #ifdef __cplusplus
-#define LTTNG_TP_EXTERN_C extern "C"
+#define LTTNG_UST_TP_EXTERN_C extern "C"
 #else
-#define LTTNG_TP_EXTERN_C
+#define LTTNG_UST_TP_EXTERN_C
 #endif
 
 #undef TRACEPOINT_LOGLEVEL
-#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel)               \
-static const int _loglevel_value___##__provider##___##__name = __loglevel; \
-LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name        \
-               __attribute__((visibility("hidden"))) =                    \
+#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel)                    \
+static const int _loglevel_value___##__provider##___##__name = __loglevel;     \
+LTTNG_UST_TP_EXTERN_C const int * const _loglevel___##__provider##___##__name  \
+               __attribute__((visibility("hidden"))) =                         \
                &_loglevel_value___##__provider##___##__name;
 
 #include TRACEPOINT_INCLUDE
 
-#undef LTTNG_TP_EXTERN_C
+#undef LTTNG_UST_TP_EXTERN_C
 
 /*
  * Stage 6.1 of tracepoint event generation.
@@ -1001,19 +998,19 @@ LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name          \
  * mangled.
  */
 #ifdef __cplusplus
-#define LTTNG_TP_EXTERN_C extern "C"
+#define LTTNG_UST_TP_EXTERN_C extern "C"
 #else
-#define LTTNG_TP_EXTERN_C
+#define LTTNG_UST_TP_EXTERN_C
 #endif
 
 #undef TRACEPOINT_MODEL_EMF_URI
 #define TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri)               \
-LTTNG_TP_EXTERN_C const char *_model_emf_uri___##__provider##___##__name   \
+LTTNG_UST_TP_EXTERN_C const char * const _model_emf_uri___##__provider##___##__name   \
                __attribute__((visibility("hidden"))) = __uri;             \
 
 #include TRACEPOINT_INCLUDE
 
-#undef LTTNG_TP_EXTERN_C
+#undef LTTNG_UST_TP_EXTERN_C
 
 /*
  * Stage 7.0 of tracepoint event generation.
@@ -1032,8 +1029,14 @@ extern const struct lttng_ust_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRA
  * 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
+ * loglevels are optional. If not declared, the event will point to
  * a loglevel that contains NULL.
+ *
+ * C++ requires that const objects have a user-declared default
+ * constructor. However, in both C++ and C, weakref cannot be
+ * initialized because it causes the weakref attribute to be ignored.
+ * Therefore, the loglevel and model_emf_uri pointers are not const
+ * to ensure C++ compilers default-initialize them.
  */
 
 /* Reset all macros within TRACEPOINT_EVENT */
@@ -1074,7 +1077,7 @@ static const struct lttng_ust_event_desc __event_desc___##_provider##_##_name =
 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)        \
        &__event_desc___##_provider##_##_name,
 
-static const struct lttng_ust_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
+static const struct lttng_ust_event_desc * const _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
 #include TRACEPOINT_INCLUDE
        NULL,   /* Dummy, C99 forbids 0-len array. */
 };
This page took 0.033636 seconds and 4 git commands to generate.