2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #include <urcu/compiler.h>
11 #include <urcu/rculist.h>
12 #include <lttng/ust-events.h>
13 #include <lttng/ust-ringbuffer-context.h>
14 #include <lttng/ust-arch.h>
15 #include <lttng/ust-compiler.h>
16 #include <lttng/tracepoint.h>
17 #include <lttng/ust-endian.h>
18 #include <lttng/ust-api-compat.h>
20 #include <lttng/ust-api-compat.h>
22 #if LTTNG_UST_COMPAT_API(0)
23 #define TP_FIELDS LTTNG_UST_TP_FIELDS
25 #define ctf_integer lttng_ust_field_integer
26 #define ctf_integer_hex lttng_ust_field_integer_hex
27 #define ctf_integer_network lttng_ust_field_integer_network
28 #define ctf_integer_network_hex lttng_ust_field_integer_network_hex
29 #define ctf_integer_nowrite lttng_ust_field_integer_nowrite
31 #define ctf_float lttng_ust_field_float
32 #define ctf_float_nowrite lttng_ust_field_float_nowrite
34 #define ctf_array lttng_ust_field_array
35 #define ctf_array_hex lttng_ust_field_array_hex
36 #define ctf_array_network lttng_ust_field_array_network
37 #define ctf_array_network_hex lttng_ust_field_array_network_hex
38 #define ctf_array_text lttng_ust_field_array_text
39 #define ctf_array_nowrite lttng_ust_field_array_nowrite
40 #define ctf_array_nowrite_hex lttng_ust_field_array_nowrite_hex
41 #define ctf_array_network_nowrite lttng_ust_field_array_network_nowrite
42 #define ctf_array_network_nowrite_hex lttng_ust_field_array_network_nowrite_hex
43 #define ctf_array_text_nowrite lttng_ust_field_array_text_nowrite
45 #define ctf_sequence lttng_ust_field_sequence
46 #define ctf_sequence_hex lttng_ust_field_sequence_hex
47 #define ctf_sequence_network lttng_ust_field_sequence_network
48 #define ctf_sequence_network_hex lttng_ust_field_sequence_network_hex
49 #define ctf_sequence_text lttng_ust_field_sequence_text
50 #define ctf_sequence_nowrite lttng_ust_field_sequence_nowrite
51 #define ctf_sequence_nowrite_hex lttng_ust_field_sequence_nowrite_hex
52 #define ctf_sequence_network_nowrite lttng_ust_field_sequence_network_nowrite
53 #define ctf_sequence_network_nowrite_hex lttng_ust_field_sequence_network_nowrite_hex
54 #define ctf_sequence_text_nowrite lttng_ust_field_sequence_text_nowrite
56 #define ctf_string lttng_ust_field_string
57 #define ctf_string_nowrite lttng_ust_field_string_nowrite
59 #define ctf_unused lttng_ust_field_unused
60 #define ctf_unused_nowrite lttng_ust_field_unused_nowrite
62 #define ctf_enum lttng_ust_field_enum
63 #define ctf_enum_nowrite lttng_ust_field_enum_nowrite
64 #define ctf_enum_value lttng_ust_field_enum_value
65 #define ctf_enum_range lttng_ust_field_enum_range
66 #define ctf_enum_auto lttng_ust_field_enum_auto
67 #endif /* #if LTTNG_UST_COMPAT_API(0) */
69 #define LTTNG_UST__NULL_STRING "(null)"
72 * LTTNG_UST_TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
73 * same arguments and having the same field layout.
75 * LTTNG_UST_TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
76 * its own provider and name. It refers to a class (template).
78 * LTTNG_UST_TRACEPOINT_EVENT declared both a class and an instance and does a
79 * direct mapping from the instance to the class.
82 #undef LTTNG_UST_TRACEPOINT_EVENT
83 #define LTTNG_UST_TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
84 LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, \
85 LTTNG_UST__TP_PARAMS(_args), \
86 LTTNG_UST__TP_PARAMS(_fields)) \
87 LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_provider, _name, _provider, _name, \
88 LTTNG_UST__TP_PARAMS(_args))
90 #undef LTTNG_UST_TRACEPOINT_EVENT_CLASS
91 #define LTTNG_UST_TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
92 LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, LTTNG_UST__TP_PARAMS(_args), LTTNG_UST__TP_PARAMS(_fields))
94 #undef LTTNG_UST_TRACEPOINT_EVENT_INSTANCE
95 #define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
96 LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, LTTNG_UST__TP_PARAMS(_args))
99 #define LTTNG_UST__TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
101 #define lttng_ust__tp_max_t(type, x, y) \
103 type lttng_ust__max1 = (x); \
104 type lttng_ust__max2 = (y); \
105 lttng_ust__max1 > lttng_ust__max2 ? lttng_ust__max1: lttng_ust__max2; \
109 * Stage 0 of tracepoint event generation.
111 * Check that each LTTNG_UST_TRACEPOINT_EVENT provider argument match the
112 * LTTNG_UST_TRACEPOINT_PROVIDER by creating dummy callbacks.
115 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
116 #include <lttng/ust-tracepoint-event-reset.h>
119 void LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_mismatch_
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
122 void LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_mismatch_
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
126 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
127 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
128 lttng_ust_tracepoint_provider_mismatch_##_provider();
130 #undef LTTNG_UST__TRACEPOINT_EVENT_INSTANCE
131 #define LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
132 lttng_ust_tracepoint_provider_mismatch_##_provider();
135 void LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_check_
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
138 void LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_check_
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
140 #include LTTNG_UST_TRACEPOINT_INCLUDE
144 * Stage 0.1 of tracepoint event generation.
146 * Check that each LTTNG_UST_TRACEPOINT_EVENT provider:name does not exceed the
147 * tracepoint name length limit.
150 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
151 #include <lttng/ust-tracepoint-event-reset.h>
153 #undef LTTNG_UST__TRACEPOINT_EVENT_INSTANCE
154 #define LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
155 lttng_ust_tracepoint_validate_name_len(_provider, _name);
157 #include LTTNG_UST_TRACEPOINT_INCLUDE
160 * Stage 0.2 of tracepoint event generation.
162 * Create dummy trace prototypes for each event class, and for each used
163 * template. This will allow checking whether the prototypes from the
164 * class and the instance using the class actually match.
167 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
168 #include <lttng/ust-tracepoint-event-reset.h>
170 #undef LTTNG_UST_TP_ARGS
171 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
173 #undef LTTNG_UST__TRACEPOINT_EVENT_INSTANCE
174 #define LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
175 void lttng_ust__event_template_proto___##_template_provider##___##_template_name(LTTNG_UST__TP_ARGS_DATA_PROTO(_args));
177 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
178 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
179 void lttng_ust__event_template_proto___##_provider##___##_name(LTTNG_UST__TP_ARGS_DATA_PROTO(_args));
181 #include LTTNG_UST_TRACEPOINT_INCLUDE
184 * Stage 0.9 of tracepoint event generation
186 * Unfolding the enums
188 #include <lttng/ust-tracepoint-event-reset.h>
190 /* Enumeration entry (single value) */
191 #undef lttng_ust_field_enum_value
192 #define lttng_ust_field_enum_value(_string, _value) \
193 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
194 .struct_size = sizeof(struct lttng_ust_enum_entry), \
196 .value = lttng_ust_is_signed_type(__typeof__(_value)) ? \
197 (long long) (_value) : (_value), \
198 .signedness = lttng_ust_is_signed_type(__typeof__(_value)), \
201 .value = lttng_ust_is_signed_type(__typeof__(_value)) ? \
202 (long long) (_value) : (_value), \
203 .signedness = lttng_ust_is_signed_type(__typeof__(_value)), \
205 .string = (_string), \
208 /* Enumeration entry (range) */
209 #undef lttng_ust_field_enum_range
210 #define lttng_ust_field_enum_range(_string, _range_start, _range_end) \
211 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
212 .struct_size = sizeof(struct lttng_ust_enum_entry), \
214 .value = lttng_ust_is_signed_type(__typeof__(_range_start)) ? \
215 (long long) (_range_start) : (_range_start), \
216 .signedness = lttng_ust_is_signed_type(__typeof__(_range_start)), \
219 .value = lttng_ust_is_signed_type(__typeof__(_range_end)) ? \
220 (long long) (_range_end) : (_range_end), \
221 .signedness = lttng_ust_is_signed_type(__typeof__(_range_end)), \
223 .string = (_string), \
226 /* Enumeration entry (automatic value; follows the rules of CTF) */
227 #undef lttng_ust_field_enum_auto
228 #define lttng_ust_field_enum_auto(_string) \
229 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_enum_entry, { \
230 .struct_size = sizeof(struct lttng_ust_enum_entry), \
239 .string = (_string), \
240 .options = LTTNG_UST_ENUM_ENTRY_OPTION_IS_AUTO, \
243 #undef LTTNG_UST_TP_ENUM_VALUES
244 #define LTTNG_UST_TP_ENUM_VALUES(...) \
247 #if LTTNG_UST_COMPAT_API(0)
248 # undef TP_ENUM_VALUES
249 # define TP_ENUM_VALUES LTTNG_UST_TP_ENUM_VALUES
250 #endif /* #if LTTNG_UST_COMPAT_API(0) */
252 #undef LTTNG_UST_TRACEPOINT_ENUM
253 #define LTTNG_UST_TRACEPOINT_ENUM(_provider, _name, _values) \
254 const struct lttng_ust_enum_entry * const __enum_values__##_provider##_##_name[] = { \
256 lttng_ust_field_enum_value("", 0) /* Dummy, 0-len array forbidden by C99. */ \
258 #include LTTNG_UST_TRACEPOINT_INCLUDE
260 #if defined(__cplusplus)
264 * Verifying array and sequence elements are of an integer or pointer
267 * This compile-time check is only enabled in C++, because the C
268 * implementation of lttng_ust_is_pointer_type does not support opaque
272 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
273 #include <lttng/ust-tracepoint-event-reset.h>
274 #include <lttng/ust-tracepoint-event-write.h>
275 #include <lttng/ust-tracepoint-event-nowrite.h>
277 #undef lttng_ust__field_array_encoded
278 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, \
279 _length, _encoding, _nowrite, \
281 lttng_ust_field_array_element_type_is_supported(_type, _item);
283 #undef lttng_ust__field_sequence_encoded
284 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, \
285 _length_type, _src_length, _encoding, _nowrite, \
287 lttng_ust_field_array_element_type_is_supported(_type, _item);
289 #undef LTTNG_UST_TP_FIELDS
290 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
292 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
293 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
296 #include LTTNG_UST_TRACEPOINT_INCLUDE
301 * Stage 0.9.2 of tracepoint event generation.
303 * Create probe signature
306 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
307 #include <lttng/ust-tracepoint-event-reset.h>
309 #undef LTTNG_UST_TP_ARGS
310 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
312 #define LTTNG_UST__TP_EXTRACT_STRING2(...) #__VA_ARGS__
314 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
315 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
316 static const char __tp_event_signature___##_provider##___##_name[] = \
317 LTTNG_UST__TP_EXTRACT_STRING2(_args);
319 #include LTTNG_UST_TRACEPOINT_INCLUDE
321 #undef LTTNG_UST__TP_EXTRACT_STRING2
324 * Stage 1 of tracepoint event generation.
326 * Create probe callback prototypes.
329 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
330 #include <lttng/ust-tracepoint-event-reset.h>
332 #undef LTTNG_UST_TP_ARGS
333 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
335 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
336 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
337 static void lttng_ust__event_probe__##_provider##___##_name(LTTNG_UST__TP_ARGS_DATA_PROTO(_args));
339 #include LTTNG_UST_TRACEPOINT_INCLUDE
342 * Stage 1.1 of tracepoint event generation.
344 * Declare toplevel descriptor for the whole probe.
345 * Unlike C, C++ does not allow tentative definitions. Therefore, we
346 * need to explicitly declare the variable with "extern", using hidden
347 * visibility to keep this symbol from being exported to the global
351 extern const struct lttng_ust_probe_desc
LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
)
352 __attribute__((visibility("hidden")));
355 * Stage 2 of tracepoint event generation.
357 * Create event field type metadata section.
358 * Each event produce an array of fields.
361 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
362 #include <lttng/ust-tracepoint-event-reset.h>
363 #include <lttng/ust-tracepoint-event-write.h>
364 #include <lttng/ust-tracepoint-event-nowrite.h>
366 #undef lttng_ust__field_integer_ext
367 #define lttng_ust__field_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
368 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
369 .struct_size = sizeof(struct lttng_ust_event_field), \
371 .type = lttng_ust_type_integer_define(_type, _byte_order, _base), \
372 .nowrite = _nowrite, \
376 #undef lttng_ust__field_float
377 #define lttng_ust__field_float(_type, _item, _src, _nowrite) \
378 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
379 .struct_size = sizeof(struct lttng_ust_event_field), \
381 .type = lttng_ust_type_float_define(_type), \
382 .nowrite = _nowrite, \
386 #undef lttng_ust__field_array_encoded
387 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, \
388 _length, _encoding, _nowrite, \
390 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
391 .struct_size = sizeof(struct lttng_ust_event_field), \
393 .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_array, { \
395 .type = lttng_ust_type_array, \
397 .struct_size = sizeof(struct lttng_ust_type_array), \
398 .elem_type = lttng_ust_type_integer_define(_type, _byte_order, _elem_type_base), \
401 .encoding = lttng_ust_string_encoding_##_encoding, \
403 .nowrite = _nowrite, \
407 #undef lttng_ust__field_sequence_encoded
408 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, \
409 _length_type, _src_length, _encoding, _nowrite, \
411 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
412 .struct_size = sizeof(struct lttng_ust_event_field), \
413 .name = "_" #_item "_length", \
414 .type = lttng_ust_type_integer_define(_length_type, LTTNG_UST_BYTE_ORDER, 10), \
415 .nowrite = _nowrite, \
418 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
419 .struct_size = sizeof(struct lttng_ust_event_field), \
421 .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_sequence, { \
423 .type = lttng_ust_type_sequence, \
425 .struct_size = sizeof(struct lttng_ust_type_sequence), \
426 .length_name = NULL, /* Use previous field. */ \
427 .elem_type = lttng_ust_type_integer_define(_type, _byte_order, _elem_type_base), \
429 .encoding = lttng_ust_string_encoding_##_encoding, \
431 .nowrite = _nowrite, \
435 #undef lttng_ust__field_string
436 #define lttng_ust__field_string(_item, _src, _nowrite) \
437 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
438 .struct_size = sizeof(struct lttng_ust_event_field), \
440 .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_string, { \
442 .type = lttng_ust_type_string, \
444 .struct_size = sizeof(struct lttng_ust_type_string), \
445 .encoding = lttng_ust_string_encoding_UTF8, \
447 .nowrite = _nowrite, \
451 #undef lttng_ust__field_unused
452 #define lttng_ust__field_unused(_src)
454 #undef lttng_ust__field_enum
455 #define lttng_ust__field_enum(_provider, _name, _type, _item, _src, _nowrite) \
456 LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \
457 .struct_size = sizeof(struct lttng_ust_event_field), \
459 .type = (const struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(const struct lttng_ust_type_enum, { \
461 .type = lttng_ust_type_enum, \
463 .struct_size = sizeof(struct lttng_ust_type_enum), \
464 .desc = &__enum_##_provider##_##_name, \
465 .container_type = lttng_ust_type_integer_define(_type, LTTNG_UST_BYTE_ORDER, 10), \
467 .nowrite = _nowrite, \
471 #undef LTTNG_UST_TP_FIELDS
472 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
474 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
475 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
476 static const struct lttng_ust_event_field * const lttng_ust__event_fields___##_provider##___##_name[] = { \
478 lttng_ust_field_integer(int, dummy, 0) /* Dummy, C99 forbids 0-len array. */ \
480 static const struct lttng_ust_tracepoint_class lttng_ust__event_class___##_provider##___##_name = { \
481 .struct_size = sizeof(struct lttng_ust_tracepoint_class), \
482 .fields = lttng_ust__event_fields___##_provider##___##_name, \
483 .nr_fields = LTTNG_UST__TP_ARRAY_SIZE(lttng_ust__event_fields___##_provider##___##_name) - 1, \
484 .probe_callback = (void (*)(void)) <tng_ust__event_probe__##_provider##___##_name, \
485 .signature = __tp_event_signature___##_provider##___##_name, \
486 .probe_desc = <tng_ust__probe_desc___##_provider, \
489 #undef LTTNG_UST_TRACEPOINT_ENUM
490 #define LTTNG_UST_TRACEPOINT_ENUM(_provider, _name, _values) \
491 static const struct lttng_ust_enum_desc __enum_##_provider##_##_name = { \
492 .struct_size = sizeof(struct lttng_ust_enum_desc), \
493 .name = #_provider "_" #_name, \
494 .entries = __enum_values__##_provider##_##_name, \
495 .nr_entries = LTTNG_UST__TP_ARRAY_SIZE(__enum_values__##_provider##_##_name) - 1, \
496 .probe_desc = <tng_ust__probe_desc___##_provider, \
499 #include LTTNG_UST_TRACEPOINT_INCLUDE
502 * Stage 3.0 of tracepoint event generation.
504 * Create static inline function that calculates event size.
507 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
508 #include <lttng/ust-tracepoint-event-reset.h>
509 #include <lttng/ust-tracepoint-event-write.h>
511 #undef lttng_ust__field_integer_ext
512 #define lttng_ust__field_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
514 (void) (_src); /* Unused */ \
515 __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
516 __event_len += sizeof(_type);
518 #undef lttng_ust__field_float
519 #define lttng_ust__field_float(_type, _item, _src, _nowrite) \
521 (void) (_src); /* Unused */ \
522 __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
523 __event_len += sizeof(_type);
525 #undef lttng_ust__field_array_encoded
526 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, _length, _encoding, \
527 _nowrite, _elem_type_base) \
529 (void) (_src); /* Unused */ \
530 __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
531 __event_len += sizeof(_type) * (_length);
533 #undef lttng_ust__field_sequence_encoded
534 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
535 _src_length, _encoding, _nowrite, _elem_type_base) \
537 (void) (_src); /* Unused */ \
538 __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_length_type)); \
539 __event_len += sizeof(_length_type); \
540 __event_len += lttng_ust_ring_buffer_align(__event_len, lttng_ust_rb_alignof(_type)); \
541 __dynamic_len[__dynamic_len_idx] = (_src_length); \
542 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
545 #undef lttng_ust__field_string
546 #define lttng_ust__field_string(_item, _src, _nowrite) \
547 __event_len += __dynamic_len[__dynamic_len_idx++] = \
548 strlen((_src) ? (_src) : LTTNG_UST__NULL_STRING) + 1;
550 #undef lttng_ust__field_unused
551 #define lttng_ust__field_unused(_src) \
553 (void) (_src); /* Unused */
555 #undef lttng_ust__field_enum
556 #define lttng_ust__field_enum(_provider, _name, _type, _item, _src, _nowrite) \
557 lttng_ust__field_integer_ext(_type, _item, _src, LTTNG_UST_BYTE_ORDER, 10, _nowrite)
559 #undef LTTNG_UST_TP_ARGS
560 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
562 #undef LTTNG_UST_TP_FIELDS
563 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__
565 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
566 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
568 size_t lttng_ust__event_get_size__##_provider##___##_name(size_t *__dynamic_len, LTTNG_UST__TP_ARGS_DATA_PROTO(_args)) \
571 size_t lttng_ust__event_get_size__##_provider##___##_name( \
572 size_t *__dynamic_len __attribute__((__unused__)), \
573 LTTNG_UST__TP_ARGS_DATA_PROTO(_args)) \
575 size_t __event_len = 0; \
576 unsigned int __dynamic_len_idx __attribute__((__unused__)) = 0; \
579 (void) __tp_data; /* don't warn if unused */ \
582 return __event_len; \
585 #include LTTNG_UST_TRACEPOINT_INCLUDE
588 * Stage 3.1 of tracepoint event generation.
590 * Create static inline function that layout the filter stack data.
591 * We make both write and nowrite data available to the filter.
594 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
595 #include <lttng/ust-tracepoint-event-reset.h>
596 #include <lttng/ust-tracepoint-event-write.h>
597 #include <lttng/ust-tracepoint-event-nowrite.h>
599 #undef lttng_ust__field_integer_ext
600 #define lttng_ust__field_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
601 if (lttng_ust_is_signed_type(_type)) { \
602 int64_t __ctf_tmp_int64; \
603 switch (sizeof(_type)) { \
606 union { _type t; int8_t v; } __tmp = { (_type) (_src) }; \
607 __ctf_tmp_int64 = (int64_t) __tmp.v; \
612 union { _type t; int16_t v; } __tmp = { (_type) (_src) }; \
613 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
614 __tmp.v = lttng_ust_bswap_16(__tmp.v); \
615 __ctf_tmp_int64 = (int64_t) __tmp.v; \
620 union { _type t; int32_t v; } __tmp = { (_type) (_src) }; \
621 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
622 __tmp.v = lttng_ust_bswap_32(__tmp.v); \
623 __ctf_tmp_int64 = (int64_t) __tmp.v; \
628 union { _type t; int64_t v; } __tmp = { (_type) (_src) }; \
629 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
630 __tmp.v = lttng_ust_bswap_64(__tmp.v); \
631 __ctf_tmp_int64 = (int64_t) __tmp.v; \
637 memcpy(__stack_data, &__ctf_tmp_int64, sizeof(int64_t)); \
639 uint64_t __ctf_tmp_uint64; \
640 switch (sizeof(_type)) { \
643 union { _type t; uint8_t v; } __tmp = { (_type) (_src) }; \
644 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
649 union { _type t; uint16_t v; } __tmp = { (_type) (_src) }; \
650 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
651 __tmp.v = lttng_ust_bswap_16(__tmp.v); \
652 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
657 union { _type t; uint32_t v; } __tmp = { (_type) (_src) }; \
658 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
659 __tmp.v = lttng_ust_bswap_32(__tmp.v); \
660 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
665 union { _type t; uint64_t v; } __tmp = { (_type) (_src) }; \
666 if (_byte_order != LTTNG_UST_BYTE_ORDER) \
667 __tmp.v = lttng_ust_bswap_64(__tmp.v); \
668 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
674 memcpy(__stack_data, &__ctf_tmp_uint64, sizeof(uint64_t)); \
676 __stack_data += sizeof(int64_t);
678 #undef lttng_ust__field_float
679 #define lttng_ust__field_float(_type, _item, _src, _nowrite) \
681 double __ctf_tmp_double = (double) (_type) (_src); \
682 memcpy(__stack_data, &__ctf_tmp_double, sizeof(double)); \
683 __stack_data += sizeof(double); \
686 #undef lttng_ust__field_array_encoded
687 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, _length, \
688 _encoding, _nowrite, _elem_type_base) \
690 unsigned long __ctf_tmp_ulong = (unsigned long) (_length); \
691 const void *__ctf_tmp_ptr = (_src); \
692 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
693 __stack_data += sizeof(unsigned long); \
694 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
695 __stack_data += sizeof(void *); \
698 #undef lttng_ust__field_sequence_encoded
699 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
700 _src_length, _encoding, _nowrite, _elem_type_base) \
702 unsigned long __ctf_tmp_ulong = (unsigned long) (_src_length); \
703 const void *__ctf_tmp_ptr = (_src); \
704 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
705 __stack_data += sizeof(unsigned long); \
706 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
707 __stack_data += sizeof(void *); \
710 #undef lttng_ust__field_string
711 #define lttng_ust__field_string(_item, _src, _nowrite) \
713 const void *__ctf_tmp_ptr = \
714 ((_src) ? (_src) : LTTNG_UST__NULL_STRING); \
715 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
716 __stack_data += sizeof(void *); \
719 #undef lttng_ust__field_unused
720 #define lttng_ust__field_unused(_src) \
724 #undef lttng_ust__field_enum
725 #define lttng_ust__field_enum(_provider, _name, _type, _item, _src, _nowrite) \
726 lttng_ust__field_integer_ext(_type, _item, _src, LTTNG_UST_BYTE_ORDER, 10, _nowrite)
728 #undef LTTNG_UST_TP_ARGS
729 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
731 #undef LTTNG_UST_TP_FIELDS
732 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__
734 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
735 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
737 void lttng_ust__event_prepare_interpreter_stack__##_provider##___##_name(char *__stack_data,\
738 LTTNG_UST__TP_ARGS_DATA_PROTO(_args)) \
741 (void) __tp_data; /* don't warn if unused */ \
742 (void) __stack_data; /* don't warn if unused */ \
748 #include LTTNG_UST_TRACEPOINT_INCLUDE
751 * Stage 4 of tracepoint event generation.
753 * Create static inline function that calculates event payload alignment.
756 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
757 #include <lttng/ust-tracepoint-event-reset.h>
758 #include <lttng/ust-tracepoint-event-write.h>
760 #undef lttng_ust__field_integer_ext
761 #define lttng_ust__field_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
763 (void) (_src); /* Unused */ \
764 __event_align = lttng_ust__tp_max_t(size_t, __event_align, lttng_ust_rb_alignof(_type));
766 #undef lttng_ust__field_float
767 #define lttng_ust__field_float(_type, _item, _src, _nowrite) \
769 (void) (_src); /* Unused */ \
770 __event_align = lttng_ust__tp_max_t(size_t, __event_align, lttng_ust_rb_alignof(_type));
772 #undef lttng_ust__field_array_encoded
773 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, _length, \
774 _encoding, _nowrite, _elem_type_base) \
776 (void) (_src); /* Unused */ \
777 __event_align = lttng_ust__tp_max_t(size_t, __event_align, lttng_ust_rb_alignof(_type));
779 #undef lttng_ust__field_sequence_encoded
780 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
781 _src_length, _encoding, _nowrite, _elem_type_base) \
783 (void) (_src); /* Unused */ \
785 (void) (_src_length); /* Unused */ \
786 __event_align = lttng_ust__tp_max_t(size_t, __event_align, lttng_ust_rb_alignof(_length_type)); \
787 __event_align = lttng_ust__tp_max_t(size_t, __event_align, lttng_ust_rb_alignof(_type));
789 #undef lttng_ust__field_string
790 #define lttng_ust__field_string(_item, _src, _nowrite) \
792 (void) (_src); /* Unused */
794 #undef lttng_ust__field_unused
795 #define lttng_ust__field_unused(_src) \
797 (void) (_src); /* Unused */
799 #undef lttng_ust__field_enum
800 #define lttng_ust__field_enum(_provider, _name, _type, _item, _src, _nowrite) \
801 lttng_ust__field_integer_ext(_type, _item, _src, LTTNG_UST_BYTE_ORDER, 10, _nowrite)
803 #undef LTTNG_UST_TP_ARGS
804 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
806 #undef LTTNG_UST_TP_FIELDS
807 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__
809 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
810 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
812 size_t lttng_ust__event_get_align__##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(_args)) \
815 size_t lttng_ust__event_get_align__##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(_args)) \
817 size_t __event_align = 1; \
819 return __event_align; \
822 #include LTTNG_UST_TRACEPOINT_INCLUDE
826 * Stage 5 of tracepoint event generation.
828 * Create the probe function. This function calls event size calculation
829 * and writes event data into the buffer.
832 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
833 #include <lttng/ust-tracepoint-event-reset.h>
834 #include <lttng/ust-tracepoint-event-write.h>
836 #undef lttng_ust__field_integer_ext
837 #define lttng_ust__field_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
839 _type __tmp = (_src); \
840 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp), lttng_ust_rb_alignof(__tmp));\
843 #undef lttng_ust__field_float
844 #define lttng_ust__field_float(_type, _item, _src, _nowrite) \
846 _type __tmp = (_src); \
847 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp), lttng_ust_rb_alignof(__tmp));\
850 #undef lttng_ust__field_array_encoded
851 #define lttng_ust__field_array_encoded(_type, _item, _src, _byte_order, _length, \
852 _encoding, _nowrite, _elem_type_base) \
853 if (lttng_ust_string_encoding_##_encoding == lttng_ust_string_encoding_none) \
854 __chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length), lttng_ust_rb_alignof(_type)); \
856 __chan->ops->event_pstrcpy_pad(&__ctx, (const char *) (_src), _length); \
858 #undef lttng_ust__field_sequence_encoded
859 #define lttng_ust__field_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
860 _src_length, _encoding, _nowrite, _elem_type_base) \
862 _length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
863 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type), lttng_ust_rb_alignof(_length_type));\
865 if (lttng_ust_string_encoding_##_encoding == lttng_ust_string_encoding_none) \
866 __chan->ops->event_write(&__ctx, _src, \
867 sizeof(_type) * lttng_ust__get_dynamic_len(dest), lttng_ust_rb_alignof(_type)); \
869 __chan->ops->event_pstrcpy_pad(&__ctx, (const char *) (_src), lttng_ust__get_dynamic_len(dest)); \
871 #undef lttng_ust__field_string
872 #define lttng_ust__field_string(_item, _src, _nowrite) \
874 const char *__ctf_tmp_string = \
875 ((_src) ? (_src) : LTTNG_UST__NULL_STRING); \
876 __chan->ops->event_strcpy(&__ctx, __ctf_tmp_string, \
877 lttng_ust__get_dynamic_len(dest)); \
880 #undef lttng_ust__field_unused
881 #define lttng_ust__field_unused(_src)
883 #undef lttng_ust__field_enum
884 #define lttng_ust__field_enum(_provider, _name, _type, _item, _src, _nowrite) \
885 lttng_ust__field_integer_ext(_type, _item, _src, LTTNG_UST_BYTE_ORDER, 10, _nowrite)
887 /* Beware: this get len actually consumes the len value */
888 #undef lttng_ust__get_dynamic_len
889 #define lttng_ust__get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
891 #undef LTTNG_UST_TP_ARGS
892 #define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
894 #undef LTTNG_UST_TP_FIELDS
895 #define LTTNG_UST_TP_FIELDS(...) __VA_ARGS__
898 * For state dump, check that "session" argument (mandatory) matches the
899 * session this event belongs to. Ensures that we write state dump data only
900 * into the started session, not into all sessions.
902 #undef LTTNG_UST__TP_SESSION_CHECK
903 #ifdef LTTNG_UST_TP_SESSION_CHECK
904 #define LTTNG_UST__TP_SESSION_CHECK(session, csession) (session == csession)
905 #else /* TP_SESSION_CHECK */
906 #define LTTNG_UST__TP_SESSION_CHECK(session, csession) 1
907 #endif /* TP_SESSION_CHECK */
910 * Use of __builtin_return_address(0) sometimes seems to cause stack
911 * corruption on 32-bit PowerPC. Disable this feature on that
912 * architecture for now by always using the NULL value for the ip
915 #undef LTTNG_UST__TP_IP_PARAM
917 #ifdef LTTNG_UST_TP_IP_PARAM
918 #define LTTNG_UST__TP_IP_PARAM(x) (x)
919 #else /* TP_IP_PARAM */
921 #if defined(LTTNG_UST_ARCH_PPC) && !defined(LTTNG_UST_ARCH_PPC64)
922 #define LTTNG_UST__TP_IP_PARAM(x) NULL
924 #define LTTNG_UST__TP_IP_PARAM(x) __builtin_return_address(0)
927 #endif /* TP_IP_PARAM */
930 * Using twice size for filter stack data to hold size and pointer for
931 * each field (worse case). For integers, max size required is 64-bit.
932 * Same for double-precision floats. Those fit within
933 * 2*sizeof(unsigned long) for all supported architectures.
934 * Perform UNION (||) of filter runtime list.
936 #undef LTTNG_UST__TRACEPOINT_EVENT_CLASS
937 #define LTTNG_UST__TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
939 void lttng_ust__event_probe__##_provider##___##_name(LTTNG_UST__TP_ARGS_DATA_PROTO(_args)) \
942 void lttng_ust__event_probe__##_provider##___##_name(LTTNG_UST__TP_ARGS_DATA_PROTO(_args)) \
944 struct lttng_ust_event_common *__event = (struct lttng_ust_event_common *) __tp_data; \
945 size_t __dynamic_len_idx = 0; \
946 const size_t __num_fields = LTTNG_UST__TP_ARRAY_SIZE(lttng_ust__event_fields___##_provider##___##_name) - 1; \
947 struct lttng_ust_probe_ctx __probe_ctx; \
949 size_t __dynamic_len[__num_fields]; \
950 char __interpreter_stack_data[2 * sizeof(unsigned long) * __num_fields]; \
953 bool __interpreter_stack_prepared = false; \
956 (void) __dynamic_len_idx; /* don't warn if unused */ \
957 switch (__event->type) { \
958 case LTTNG_UST_EVENT_TYPE_RECORDER: \
960 struct lttng_ust_event_recorder *__event_recorder = (struct lttng_ust_event_recorder *) __event->child; \
961 struct lttng_ust_channel_buffer *__chan = __event_recorder->chan; \
962 struct lttng_ust_channel_common *__chan_common = __chan->parent; \
964 if (!LTTNG_UST__TP_SESSION_CHECK(session, __chan_common->session)) \
966 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan_common->session->active))) \
968 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan_common->enabled))) \
972 case LTTNG_UST_EVENT_TYPE_NOTIFIER: \
975 if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
977 if (caa_unlikely(!LTTNG_UST_TP_RCU_LINK_TEST())) \
979 __probe_ctx.struct_size = sizeof(struct lttng_ust_probe_ctx); \
980 __probe_ctx.ip = LTTNG_UST__TP_IP_PARAM(LTTNG_UST_TP_IP_PARAM); \
981 if (caa_unlikely(CMM_ACCESS_ONCE(__event->eval_filter))) { \
982 lttng_ust__event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
983 LTTNG_UST__TP_ARGS_DATA_VAR(_args)); \
984 __interpreter_stack_prepared = true; \
985 if (caa_likely(__event->run_filter(__event, \
986 __stackvar.__interpreter_stack_data, &__probe_ctx, NULL) != LTTNG_UST_EVENT_FILTER_ACCEPT)) \
989 switch (__event->type) { \
990 case LTTNG_UST_EVENT_TYPE_RECORDER: \
992 size_t __event_len, __event_align; \
993 struct lttng_ust_event_recorder *__event_recorder = (struct lttng_ust_event_recorder *) __event->child; \
994 struct lttng_ust_channel_buffer *__chan = __event_recorder->chan; \
995 struct lttng_ust_ring_buffer_ctx __ctx; \
997 __event_len = lttng_ust__event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
998 LTTNG_UST__TP_ARGS_DATA_VAR(_args)); \
999 __event_align = lttng_ust__event_get_align__##_provider##___##_name(LTTNG_UST__TP_ARGS_VAR(_args)); \
1000 lttng_ust_ring_buffer_ctx_init(&__ctx, __event_recorder, __event_len, __event_align, \
1002 __ret = __chan->ops->event_reserve(&__ctx); \
1006 __chan->ops->event_commit(&__ctx); \
1009 case LTTNG_UST_EVENT_TYPE_NOTIFIER: \
1011 struct lttng_ust_event_notifier *__event_notifier = (struct lttng_ust_event_notifier *) __event->child; \
1012 struct lttng_ust_notification_ctx __notif_ctx; \
1014 __notif_ctx.struct_size = sizeof(struct lttng_ust_notification_ctx); \
1015 __notif_ctx.eval_capture = CMM_ACCESS_ONCE(__event_notifier->eval_capture); \
1017 if (caa_unlikely(!__interpreter_stack_prepared && __notif_ctx.eval_capture)) \
1018 lttng_ust__event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
1019 LTTNG_UST__TP_ARGS_DATA_VAR(_args)); \
1021 __event_notifier->notification_send(__event_notifier, \
1022 __stackvar.__interpreter_stack_data, \
1030 #include LTTNG_UST_TRACEPOINT_INCLUDE
1032 #undef lttng_ust__get_dynamic_len
1035 * Stage 6 of tracepoint event generation.
1037 * Tracepoint loglevel mapping definition generation. We generate a
1038 * symbol for each mapping for a provider/event to ensure at most a 1 to
1039 * 1 mapping between events and loglevels. If the symbol is repeated,
1040 * the compiler will complain.
1043 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
1044 #include <lttng/ust-tracepoint-event-reset.h>
1047 * Declare _loglevel___##__provider##___##__name as non-static, with
1048 * hidden visibility for c++ handling of weakref. We do a weakref to the
1049 * symbol in a later stage, which requires that the symbol is not
1053 #define LTTNG_UST_TP_EXTERN_C extern "C"
1055 #define LTTNG_UST_TP_EXTERN_C
1058 #undef LTTNG_UST_TRACEPOINT_LOGLEVEL
1059 #define LTTNG_UST_TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
1060 static const int _loglevel_value___##__provider##___##__name = __loglevel; \
1061 LTTNG_UST_TP_EXTERN_C const int * const _loglevel___##__provider##___##__name \
1062 __attribute__((visibility("hidden"))) = \
1063 &_loglevel_value___##__provider##___##__name;
1065 #include LTTNG_UST_TRACEPOINT_INCLUDE
1067 #undef LTTNG_UST_TP_EXTERN_C
1070 * Stage 6.1 of tracepoint event generation.
1072 * Tracepoint UML URI info.
1075 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
1076 #include <lttng/ust-tracepoint-event-reset.h>
1079 * Declare _model_emf_uri___##__provider##___##__name as non-static,
1080 * with hidden visibility for c++ handling of weakref. We do a weakref
1081 * to the symbol in a later stage, which requires that the symbol is not
1085 #define LTTNG_UST_TP_EXTERN_C extern "C"
1087 #define LTTNG_UST_TP_EXTERN_C
1090 #undef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
1091 #define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri) \
1092 LTTNG_UST_TP_EXTERN_C const char * const _model_emf_uri___##__provider##___##__name \
1093 __attribute__((visibility("hidden"))) = __uri; \
1095 #include LTTNG_UST_TRACEPOINT_INCLUDE
1097 #undef LTTNG_UST_TP_EXTERN_C
1100 * Stage 7.0 of tracepoint event generation.
1102 * Create events description structures. We use a weakref because
1103 * loglevels are optional. If not declared, the event will point to
1104 * a loglevel that contains NULL.
1106 * C++ requires that const objects have a user-declared default
1107 * constructor. However, in both C++ and C, weakref cannot be
1108 * initialized because it causes the weakref attribute to be ignored.
1109 * Therefore, the loglevel and model_emf_uri pointers are not const
1110 * to ensure C++ compilers default-initialize them.
1113 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
1114 #include <lttng/ust-tracepoint-event-reset.h>
1116 #undef LTTNG_UST__TRACEPOINT_EVENT_INSTANCE
1117 #define LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
1118 static const int * \
1119 __ref_loglevel___##_provider##___##_name \
1120 __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
1121 static const char * \
1122 __ref_model_emf_uri___##_provider##___##_name \
1123 __attribute__((weakref ("_model_emf_uri___" #_provider "___" #_name)));\
1124 static const struct lttng_ust_event_desc lttng_ust__event_desc___##_provider##_##_name = { \
1125 .struct_size = sizeof(struct lttng_ust_event_desc), \
1126 .event_name = #_name, \
1127 .probe_desc = <tng_ust__probe_desc___##_provider, \
1128 .tp_class = <tng_ust__event_class___##_template_provider##___##_template_name, \
1129 .loglevel = &__ref_loglevel___##_provider##___##_name, \
1130 .model_emf_uri = &__ref_model_emf_uri___##_provider##___##_name, \
1133 #include LTTNG_UST_TRACEPOINT_INCLUDE
1136 * Stage 7.1 of tracepoint event generation.
1138 * Create array of events.
1141 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
1142 #include <lttng/ust-tracepoint-event-reset.h>
1144 #undef LTTNG_UST__TRACEPOINT_EVENT_INSTANCE
1145 #define LTTNG_UST__TRACEPOINT_EVENT_INSTANCE(_template_provider, _template_name, _provider, _name, _args) \
1146 <tng_ust__event_desc___##_provider##_##_name,
1148 static const struct lttng_ust_event_desc
* const LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__provider_event_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
)[] = {
1149 #include LTTNG_UST_TRACEPOINT_INCLUDE
1150 NULL
, /* Dummy, C99 forbids 0-len array. */
1155 * Stage 8 of tracepoint event generation.
1157 * Create a toplevel descriptor for the whole probe.
1160 const struct lttng_ust_probe_desc
LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
) = {
1161 .struct_size
= sizeof(struct lttng_ust_probe_desc
),
1162 .provider_name
= lttng_ust__tp_stringify(LTTNG_UST_TRACEPOINT_PROVIDER
),
1163 .event_desc
= LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__provider_event_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
),
1164 .nr_events
= LTTNG_UST__TP_ARRAY_SIZE(LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__provider_event_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
)) - 1,
1165 .major
= LTTNG_UST_PROVIDER_MAJOR
,
1166 .minor
= LTTNG_UST_PROVIDER_MINOR
,
1169 static int LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_refcount___
, LTTNG_UST_TRACEPOINT_PROVIDER
);
1170 static struct lttng_ust_registered_probe
*LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_cookie___
, LTTNG_UST_TRACEPOINT_PROVIDER
);
1173 * Stage 9 of tracepoint event generation.
1175 * Register/unregister probes at module load/unload.
1177 * Generate the constructor as an externally visible symbol for use when
1178 * linking the probe statically.
1180 * Register refcount is protected by libc dynamic loader mutex.
1182 * Note that when building this code as C++, the definition of constructors
1183 * and destructors invoking the registration and unregistration functions
1184 * must be performed _after_ the initialization of the probes.
1186 * This is because we rely on the order of initialization of static variables
1187 * and anonymous namespaces (their order of declaration) to ensure probes are
1188 * fully initialized, see
1189 * https://en.cppreference.com/w/cpp/language/initialization. This is especially
1190 * important when LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP is defined as
1191 * compound literals are then dynamically initialized.
1194 /* Reset all macros within LTTNG_UST_TRACEPOINT_EVENT */
1195 #include <lttng/ust-tracepoint-event-reset.h>
1198 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_init__
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void) lttng_ust_notrace
;
1200 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_init__
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
1202 struct lttng_ust_registered_probe
*reg_probe
;
1204 if (LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_refcount___
,
1205 LTTNG_UST_TRACEPOINT_PROVIDER
)++) {
1209 * lttng_ust_tracepoint_provider_check_ ## LTTNG_UST_TRACEPOINT_PROVIDER() is a
1210 * static inline function that ensures every probe PROVIDER
1211 * argument match the provider within which they appear. It
1212 * calls empty static inline functions, and therefore has no
1213 * runtime effect. However, if it detects an error, a linker
1214 * error will appear.
1216 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_check_
, LTTNG_UST_TRACEPOINT_PROVIDER
)();
1217 assert(!LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_cookie___
, LTTNG_UST_TRACEPOINT_PROVIDER
));
1218 reg_probe
= lttng_ust_probe_register(<TNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_desc___
, LTTNG_UST_TRACEPOINT_PROVIDER
));
1220 fprintf(stderr
, "LTTng-UST: Error while registering tracepoint probe.\n");
1223 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_cookie___
, LTTNG_UST_TRACEPOINT_PROVIDER
) = reg_probe
;
1227 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_exit__
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void) lttng_ust_notrace
;
1229 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_exit__
, LTTNG_UST_TRACEPOINT_PROVIDER
)(void)
1231 if (--LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_refcount___
,
1232 LTTNG_UST_TRACEPOINT_PROVIDER
)) {
1235 lttng_ust_probe_unregister(LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_cookie___
, LTTNG_UST_TRACEPOINT_PROVIDER
));
1236 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__probe_register_cookie___
, LTTNG_UST_TRACEPOINT_PROVIDER
) = NULL
;
1239 LTTNG_UST_DECLARE_CONSTRUCTOR_DESTRUCTOR(
1240 LTTNG_UST_TRACEPOINT_PROVIDER
,
1241 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_init__
, LTTNG_UST_TRACEPOINT_PROVIDER
),
1242 LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust__events_exit__
, LTTNG_UST_TRACEPOINT_PROVIDER
),
1246 * LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION: Define this before
1247 * including a tracepoint instrumentation header to hide symbols
1248 * associated with the tracepoint provider. This is useful if the
1249 * tracepoint definition (including the header after defining
1250 * LTTNG_UST_TRACEPOINT_DEFINE) is in the same module as the provider
1251 * (including the header after defining
1252 * LTTNG_UST_TRACEPOINT_CREATE_PROBES).
1254 #undef LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY
1255 #ifdef LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION
1256 #define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("hidden")))
1258 #define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("default")))
1261 int LTTNG_UST__TP_COMBINE_TOKENS(lttng_ust_tracepoint_provider_
, LTTNG_UST_TRACEPOINT_PROVIDER
)
1262 LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY
;