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/ringbuffer-config.h>
14 #include <lttng/ust-compiler.h>
15 #include <lttng/tracepoint.h>
16 #include <lttng/ust-endian.h>
19 #define __LTTNG_UST_NULL_STRING "(null)"
21 #undef tp_list_for_each_entry_rcu
22 #define tp_list_for_each_entry_rcu(pos, head, member) \
23 for (pos = cds_list_entry(tp_rcu_dereference((head)->next), __typeof__(*pos), member); \
24 &pos->member != (head); \
25 pos = cds_list_entry(tp_rcu_dereference(pos->member.next), __typeof__(*pos), member))
28 * TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
29 * same arguments and having the same field layout.
31 * TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
32 * its own provider and name. It refers to a class (template).
34 * TRACEPOINT_EVENT declared both a class and an instance and does a
35 * direct mapping from the instance to the class.
38 #undef TRACEPOINT_EVENT
39 #define TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
40 _TRACEPOINT_EVENT_CLASS(_provider, _name, \
42 _TP_PARAMS(_fields)) \
43 _TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name, \
46 #undef TRACEPOINT_EVENT_CLASS
47 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
48 _TRACEPOINT_EVENT_CLASS(_provider, _name, _TP_PARAMS(_args), _TP_PARAMS(_fields))
50 #undef TRACEPOINT_EVENT_INSTANCE
51 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
52 _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _TP_PARAMS(_args))
55 #define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
57 #define _tp_max_t(type, x, y) \
61 __max1 > __max2 ? __max1: __max2; \
65 * Stage 0 of tracepoint event generation.
67 * Check that each TRACEPOINT_EVENT provider argument match the
68 * TRACEPOINT_PROVIDER by creating dummy callbacks.
71 /* Reset all macros within TRACEPOINT_EVENT */
72 #include <lttng/ust-tracepoint-event-reset.h>
74 static inline lttng_ust_notrace
75 void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_
, TRACEPOINT_PROVIDER
)(void);
77 void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_
, TRACEPOINT_PROVIDER
)(void)
81 #undef _TRACEPOINT_EVENT_CLASS
82 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
83 __tracepoint_provider_mismatch_##_provider();
85 #undef _TRACEPOINT_EVENT_INSTANCE
86 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
87 __tracepoint_provider_mismatch_##_provider();
89 static inline lttng_ust_notrace
90 void _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)(void);
92 void _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)(void)
94 #include TRACEPOINT_INCLUDE
98 * Stage 0.1 of tracepoint event generation.
100 * Check that each TRACEPOINT_EVENT provider:name does not exceed the
101 * tracepoint name length limit.
104 /* Reset all macros within TRACEPOINT_EVENT */
105 #include <lttng/ust-tracepoint-event-reset.h>
107 #undef _TRACEPOINT_EVENT_INSTANCE
108 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
110 __tp_name_len_check##_provider##___##_name[LTTNG_UST_ABI_SYM_NAME_LEN] \
111 __attribute__((unused)) = \
112 #_provider ":" #_name;
114 #include TRACEPOINT_INCLUDE
117 * Stage 0.2 of tracepoint event generation.
119 * Create dummy trace prototypes for each event class, and for each used
120 * template. This will allow checking whether the prototypes from the
121 * class and the instance using the class actually match.
124 /* Reset all macros within TRACEPOINT_EVENT */
125 #include <lttng/ust-tracepoint-event-reset.h>
128 #define TP_ARGS(...) __VA_ARGS__
130 #undef _TRACEPOINT_EVENT_INSTANCE
131 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
132 void __event_template_proto___##_provider##___##_template(_TP_ARGS_DATA_PROTO(_args));
134 #undef _TRACEPOINT_EVENT_CLASS
135 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
136 void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
138 #include TRACEPOINT_INCLUDE
141 * Stage 0.9 of tracepoint event generation
143 * Unfolding the enums
145 #include <lttng/ust-tracepoint-event-reset.h>
147 /* Enumeration entry (single value) */
148 #undef ctf_enum_value
149 #define ctf_enum_value(_string, _value) \
150 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_enum_entry, { \
151 .struct_size = sizeof(struct lttng_ust_enum_entry), \
153 .value = lttng_is_signed_type(__typeof__(_value)) ? \
154 (long long) (_value) : (_value), \
155 .signedness = lttng_is_signed_type(__typeof__(_value)), \
158 .value = lttng_is_signed_type(__typeof__(_value)) ? \
159 (long long) (_value) : (_value), \
160 .signedness = lttng_is_signed_type(__typeof__(_value)), \
162 .string = (_string), \
165 /* Enumeration entry (range) */
166 #undef ctf_enum_range
167 #define ctf_enum_range(_string, _range_start, _range_end) \
168 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_enum_entry, { \
169 .struct_size = sizeof(struct lttng_ust_enum_entry), \
171 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
172 (long long) (_range_start) : (_range_start), \
173 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
176 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
177 (long long) (_range_end) : (_range_end), \
178 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
180 .string = (_string), \
183 /* Enumeration entry (automatic value; follows the rules of CTF) */
185 #define ctf_enum_auto(_string) \
186 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_enum_entry, { \
187 .struct_size = sizeof(struct lttng_ust_enum_entry), \
196 .string = (_string), \
197 .options = LTTNG_ENUM_ENTRY_OPTION_IS_AUTO, \
200 #undef TP_ENUM_VALUES
201 #define TP_ENUM_VALUES(...) \
204 #undef TRACEPOINT_ENUM
205 #define TRACEPOINT_ENUM(_provider, _name, _values) \
206 const struct lttng_ust_enum_entry *__enum_values__##_provider##_##_name[] = { \
208 ctf_enum_value("", 0) /* Dummy, 0-len array forbidden by C99. */ \
210 #include TRACEPOINT_INCLUDE
214 * Verifying array and sequence elements are of an integer type.
217 /* Reset all macros within TRACEPOINT_EVENT */
218 #include <lttng/ust-tracepoint-event-reset.h>
219 #include <lttng/ust-tracepoint-event-write.h>
220 #include <lttng/ust-tracepoint-event-nowrite.h>
222 #undef _ctf_array_encoded
223 #define _ctf_array_encoded(_type, _item, _src, _byte_order, \
224 _length, _encoding, _nowrite, \
226 _lttng_array_element_type_is_supported(_type, _item)
228 #undef _ctf_sequence_encoded
229 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
230 _length_type, _src_length, _encoding, _nowrite, \
232 _lttng_array_element_type_is_supported(_type, _item)
235 #define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
237 #undef _TRACEPOINT_EVENT_CLASS
238 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
241 #include TRACEPOINT_INCLUDE
244 * Stage 1 of tracepoint event generation.
246 * Create event field type metadata section.
247 * Each event produce an array of fields.
250 /* Reset all macros within TRACEPOINT_EVENT */
251 #include <lttng/ust-tracepoint-event-reset.h>
252 #include <lttng/ust-tracepoint-event-write.h>
253 #include <lttng/ust-tracepoint-event-nowrite.h>
255 #undef _ctf_integer_ext
256 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
257 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
258 .struct_size = sizeof(struct lttng_ust_event_field), \
260 .type = __type_integer(_type, _byte_order, _base, none), \
261 .nowrite = _nowrite, \
266 #define _ctf_float(_type, _item, _src, _nowrite) \
267 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
268 .struct_size = sizeof(struct lttng_ust_event_field), \
270 .type = __type_float(_type), \
271 .nowrite = _nowrite, \
275 #undef _ctf_array_encoded
276 #define _ctf_array_encoded(_type, _item, _src, _byte_order, \
277 _length, _encoding, _nowrite, \
279 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
280 .struct_size = sizeof(struct lttng_ust_event_field), \
283 .atype = atype_array_nestable, \
285 .array_nestable = { \
286 .elem_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
287 __type_integer(_type, _byte_order, _elem_type_base, _encoding)), \
293 .nowrite = _nowrite, \
297 #undef _ctf_sequence_encoded
298 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
299 _length_type, _src_length, _encoding, _nowrite, \
301 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
302 .struct_size = sizeof(struct lttng_ust_event_field), \
303 .name = "_" #_item "_length", \
304 .type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
305 .nowrite = _nowrite, \
308 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
309 .struct_size = sizeof(struct lttng_ust_event_field), \
312 .atype = atype_sequence_nestable, \
314 .sequence_nestable = { \
315 .length_name = "_" #_item "_length", \
316 .elem_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
317 __type_integer(_type, _byte_order, _elem_type_base, _encoding)), \
322 .nowrite = _nowrite, \
327 #define _ctf_string(_item, _src, _nowrite) \
328 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
329 .struct_size = sizeof(struct lttng_ust_event_field), \
332 .atype = atype_string, \
334 .string = { .encoding = lttng_encode_UTF8 } \
337 .nowrite = _nowrite, \
342 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
343 __LTTNG_COMPOUND_LITERAL(struct lttng_ust_event_field, { \
344 .struct_size = sizeof(struct lttng_ust_event_field), \
347 .atype = atype_enum_nestable, \
350 .desc = &__enum_##_provider##_##_name, \
351 .container_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
352 __type_integer(_type, BYTE_ORDER, 10, none)), \
356 .nowrite = _nowrite, \
361 #define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
363 #undef _TRACEPOINT_EVENT_CLASS
364 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
365 static const struct lttng_ust_event_field *__event_fields___##_provider##___##_name[] = { \
367 ctf_integer(int, dummy, 0) /* Dummy, C99 forbids 0-len array. */ \
370 #undef TRACEPOINT_ENUM
371 #define TRACEPOINT_ENUM(_provider, _name, _values) \
372 static const struct lttng_ust_enum_desc __enum_##_provider##_##_name = { \
373 .struct_size = sizeof(struct lttng_ust_enum_desc), \
374 .name = #_provider "_" #_name, \
375 .entries = __enum_values__##_provider##_##_name, \
376 .nr_entries = _TP_ARRAY_SIZE(__enum_values__##_provider##_##_name) - 1, \
379 #include TRACEPOINT_INCLUDE
382 * Stage 2 of tracepoint event generation.
384 * Create probe callback prototypes.
387 /* Reset all macros within TRACEPOINT_EVENT */
388 #include <lttng/ust-tracepoint-event-reset.h>
391 #define TP_ARGS(...) __VA_ARGS__
393 #undef _TRACEPOINT_EVENT_CLASS
394 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
395 static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
397 #include TRACEPOINT_INCLUDE
400 * Stage 3.0 of tracepoint event generation.
402 * Create static inline function that calculates event size.
405 /* Reset all macros within TRACEPOINT_EVENT */
406 #include <lttng/ust-tracepoint-event-reset.h>
407 #include <lttng/ust-tracepoint-event-write.h>
409 #undef _ctf_integer_ext
410 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
411 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
412 __event_len += sizeof(_type);
415 #define _ctf_float(_type, _item, _src, _nowrite) \
416 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
417 __event_len += sizeof(_type);
419 #undef _ctf_array_encoded
420 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, _encoding, \
421 _nowrite, _elem_type_base) \
422 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
423 __event_len += sizeof(_type) * (_length);
425 #undef _ctf_sequence_encoded
426 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
427 _src_length, _encoding, _nowrite, _elem_type_base) \
428 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type)); \
429 __event_len += sizeof(_length_type); \
430 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
431 __dynamic_len[__dynamic_len_idx] = (_src_length); \
432 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
436 #define _ctf_string(_item, _src, _nowrite) \
437 __event_len += __dynamic_len[__dynamic_len_idx++] = \
438 strlen((_src) ? (_src) : __LTTNG_UST_NULL_STRING) + 1;
441 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
442 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
445 #define TP_ARGS(...) __VA_ARGS__
448 #define TP_FIELDS(...) __VA_ARGS__
450 #undef _TRACEPOINT_EVENT_CLASS
451 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
452 static inline lttng_ust_notrace \
453 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)); \
455 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
457 size_t __event_len = 0; \
458 unsigned int __dynamic_len_idx = 0; \
461 (void) __dynamic_len_idx; /* don't warn if unused */ \
463 return __event_len; \
466 #include TRACEPOINT_INCLUDE
469 * Stage 3.1 of tracepoint event generation.
471 * Create static inline function that layout the filter stack data.
472 * We make both write and nowrite data available to the filter.
475 /* Reset all macros within TRACEPOINT_EVENT */
476 #include <lttng/ust-tracepoint-event-reset.h>
477 #include <lttng/ust-tracepoint-event-write.h>
478 #include <lttng/ust-tracepoint-event-nowrite.h>
480 #undef _ctf_integer_ext
481 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
482 if (lttng_is_signed_type(_type)) { \
483 int64_t __ctf_tmp_int64; \
484 switch (sizeof(_type)) { \
487 union { _type t; int8_t v; } __tmp = { (_type) (_src) }; \
488 __ctf_tmp_int64 = (int64_t) __tmp.v; \
493 union { _type t; int16_t v; } __tmp = { (_type) (_src) }; \
494 if (_byte_order != BYTE_ORDER) \
495 __tmp.v = bswap_16(__tmp.v); \
496 __ctf_tmp_int64 = (int64_t) __tmp.v; \
501 union { _type t; int32_t v; } __tmp = { (_type) (_src) }; \
502 if (_byte_order != BYTE_ORDER) \
503 __tmp.v = bswap_32(__tmp.v); \
504 __ctf_tmp_int64 = (int64_t) __tmp.v; \
509 union { _type t; int64_t v; } __tmp = { (_type) (_src) }; \
510 if (_byte_order != BYTE_ORDER) \
511 __tmp.v = bswap_64(__tmp.v); \
512 __ctf_tmp_int64 = (int64_t) __tmp.v; \
518 memcpy(__stack_data, &__ctf_tmp_int64, sizeof(int64_t)); \
520 uint64_t __ctf_tmp_uint64; \
521 switch (sizeof(_type)) { \
524 union { _type t; uint8_t v; } __tmp = { (_type) (_src) }; \
525 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
530 union { _type t; uint16_t v; } __tmp = { (_type) (_src) }; \
531 if (_byte_order != BYTE_ORDER) \
532 __tmp.v = bswap_16(__tmp.v); \
533 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
538 union { _type t; uint32_t v; } __tmp = { (_type) (_src) }; \
539 if (_byte_order != BYTE_ORDER) \
540 __tmp.v = bswap_32(__tmp.v); \
541 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
546 union { _type t; uint64_t v; } __tmp = { (_type) (_src) }; \
547 if (_byte_order != BYTE_ORDER) \
548 __tmp.v = bswap_64(__tmp.v); \
549 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
555 memcpy(__stack_data, &__ctf_tmp_uint64, sizeof(uint64_t)); \
557 __stack_data += sizeof(int64_t);
560 #define _ctf_float(_type, _item, _src, _nowrite) \
562 double __ctf_tmp_double = (double) (_type) (_src); \
563 memcpy(__stack_data, &__ctf_tmp_double, sizeof(double)); \
564 __stack_data += sizeof(double); \
567 #undef _ctf_array_encoded
568 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
569 _encoding, _nowrite, _elem_type_base) \
571 unsigned long __ctf_tmp_ulong = (unsigned long) (_length); \
572 const void *__ctf_tmp_ptr = (_src); \
573 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
574 __stack_data += sizeof(unsigned long); \
575 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
576 __stack_data += sizeof(void *); \
579 #undef _ctf_sequence_encoded
580 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
581 _src_length, _encoding, _nowrite, _elem_type_base) \
583 unsigned long __ctf_tmp_ulong = (unsigned long) (_src_length); \
584 const void *__ctf_tmp_ptr = (_src); \
585 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
586 __stack_data += sizeof(unsigned long); \
587 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
588 __stack_data += sizeof(void *); \
592 #define _ctf_string(_item, _src, _nowrite) \
594 const void *__ctf_tmp_ptr = \
595 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
596 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
597 __stack_data += sizeof(void *); \
601 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
602 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
605 #define TP_ARGS(...) __VA_ARGS__
608 #define TP_FIELDS(...) __VA_ARGS__
610 #undef _TRACEPOINT_EVENT_CLASS
611 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
613 void __event_prepare_interpreter_stack__##_provider##___##_name(char *__stack_data,\
614 _TP_ARGS_DATA_PROTO(_args)) \
619 #include TRACEPOINT_INCLUDE
622 * Stage 4 of tracepoint event generation.
624 * Create static inline function that calculates event payload alignment.
627 /* Reset all macros within TRACEPOINT_EVENT */
628 #include <lttng/ust-tracepoint-event-reset.h>
629 #include <lttng/ust-tracepoint-event-write.h>
631 #undef _ctf_integer_ext
632 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
633 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
636 #define _ctf_float(_type, _item, _src, _nowrite) \
637 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
639 #undef _ctf_array_encoded
640 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
641 _encoding, _nowrite, _elem_type_base) \
642 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
644 #undef _ctf_sequence_encoded
645 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
646 _src_length, _encoding, _nowrite, _elem_type_base) \
647 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type)); \
648 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
651 #define _ctf_string(_item, _src, _nowrite)
654 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
655 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
658 #define TP_ARGS(...) __VA_ARGS__
661 #define TP_FIELDS(...) __VA_ARGS__
663 #undef _TRACEPOINT_EVENT_CLASS
664 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
665 static inline lttng_ust_notrace \
666 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)); \
668 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)) \
670 size_t __event_align = 1; \
672 return __event_align; \
675 #include TRACEPOINT_INCLUDE
679 * Stage 5 of tracepoint event generation.
681 * Create the probe function. This function calls event size calculation
682 * and writes event data into the buffer.
685 /* Reset all macros within TRACEPOINT_EVENT */
686 #include <lttng/ust-tracepoint-event-reset.h>
687 #include <lttng/ust-tracepoint-event-write.h>
689 #undef _ctf_integer_ext
690 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
692 _type __tmp = (_src); \
693 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
694 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
698 #define _ctf_float(_type, _item, _src, _nowrite) \
700 _type __tmp = (_src); \
701 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
702 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
705 #undef _ctf_array_encoded
706 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
707 _encoding, _nowrite, _elem_type_base) \
708 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
709 __chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));
711 #undef _ctf_sequence_encoded
712 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
713 _src_length, _encoding, _nowrite, _elem_type_base) \
715 _length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
716 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
717 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
719 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
720 __chan->ops->event_write(&__ctx, _src, \
721 sizeof(_type) * __get_dynamic_len(dest));
724 #define _ctf_string(_item, _src, _nowrite) \
726 const char *__ctf_tmp_string = \
727 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
728 lib_ring_buffer_align_ctx(&__ctx, \
729 lttng_alignof(*__ctf_tmp_string)); \
730 __chan->ops->event_strcpy(&__ctx, __ctf_tmp_string, \
731 __get_dynamic_len(dest)); \
736 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
737 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
739 /* Beware: this get len actually consumes the len value */
740 #undef __get_dynamic_len
741 #define __get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
744 #define TP_ARGS(...) __VA_ARGS__
747 #define TP_FIELDS(...) __VA_ARGS__
750 * For state dump, check that "session" argument (mandatory) matches the
751 * session this event belongs to. Ensures that we write state dump data only
752 * into the started session, not into all sessions.
754 #undef _TP_SESSION_CHECK
755 #ifdef TP_SESSION_CHECK
756 #define _TP_SESSION_CHECK(session, csession) (session == csession)
757 #else /* TP_SESSION_CHECK */
758 #define _TP_SESSION_CHECK(session, csession) 1
759 #endif /* TP_SESSION_CHECK */
762 * Use of __builtin_return_address(0) sometimes seems to cause stack
763 * corruption on 32-bit PowerPC. Disable this feature on that
764 * architecture for now by always using the NULL value for the ip
769 #define _TP_IP_PARAM(x) (x)
770 #else /* TP_IP_PARAM */
772 #if defined(__PPC__) && !defined(__PPC64__)
773 #define _TP_IP_PARAM(x) NULL
774 #else /* #if defined(__PPC__) && !defined(__PPC64__) */
775 #define _TP_IP_PARAM(x) __builtin_return_address(0)
776 #endif /* #else #if defined(__PPC__) && !defined(__PPC64__) */
778 #endif /* TP_IP_PARAM */
781 * Using twice size for filter stack data to hold size and pointer for
782 * each field (worse case). For integers, max size required is 64-bit.
783 * Same for double-precision floats. Those fit within
784 * 2*sizeof(unsigned long) for all supported architectures.
785 * Perform UNION (||) of filter runtime list.
787 #undef _TRACEPOINT_EVENT_CLASS
788 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
789 static lttng_ust_notrace \
790 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)); \
792 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)) \
794 struct lttng_ust_event_common *__event = (struct lttng_ust_event_common *) __tp_data; \
795 size_t __dynamic_len_idx = 0; \
796 const size_t __num_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1; \
798 size_t __dynamic_len[__num_fields]; \
799 char __interpreter_stack_data[2 * sizeof(unsigned long) * __num_fields]; \
804 (void) __dynamic_len_idx; /* don't warn if unused */ \
805 switch (__event->type) { \
806 case LTTNG_UST_EVENT_TYPE_RECORDER: \
808 struct lttng_ust_event_recorder *__event_recorder = (struct lttng_ust_event_recorder *) __event->child; \
809 struct lttng_channel *__chan = __event_recorder->chan; \
811 if (!_TP_SESSION_CHECK(session, __chan->session)) \
813 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active))) \
815 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled))) \
819 case LTTNG_UST_EVENT_TYPE_NOTIFIER: \
822 if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
824 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
826 if (caa_unlikely(!cds_list_empty(&__event->filter_bytecode_runtime_head))) { \
827 struct lttng_ust_bytecode_runtime *__filter_bc_runtime; \
828 int __filter_record = __event->has_enablers_without_bytecode; \
830 __event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
831 _TP_ARGS_DATA_VAR(_args)); \
832 tp_list_for_each_entry_rcu(__filter_bc_runtime, &__event->filter_bytecode_runtime_head, node) { \
833 if (caa_unlikely(__filter_bc_runtime->interpreter_funcs.filter(__filter_bc_runtime, \
834 __stackvar.__interpreter_stack_data) & LTTNG_INTERPRETER_RECORD_FLAG)) { \
835 __filter_record = 1; \
839 if (caa_likely(!__filter_record)) \
842 switch (__event->type) { \
843 case LTTNG_UST_EVENT_TYPE_RECORDER: \
845 size_t __event_len, __event_align; \
846 struct lttng_ust_event_recorder *__event_recorder = (struct lttng_ust_event_recorder *) __event->child; \
847 struct lttng_channel *__chan = __event_recorder->chan; \
848 struct lttng_ust_lib_ring_buffer_ctx __ctx; \
849 struct lttng_ust_stack_ctx __lttng_ctx; \
851 __event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
852 _TP_ARGS_DATA_VAR(_args)); \
853 __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
854 memset(&__lttng_ctx, 0, sizeof(__lttng_ctx)); \
855 __lttng_ctx.struct_size = sizeof(struct lttng_ust_stack_ctx); \
856 __lttng_ctx.event_recorder = __event_recorder; \
857 __lttng_ctx.chan_ctx = tp_rcu_dereference(__chan->ctx); \
858 __lttng_ctx.event_ctx = tp_rcu_dereference(__event_recorder->ctx); \
859 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, &__lttng_ctx, __event_len, \
860 __event_align, -1, __chan->handle); \
861 __ctx.ip = _TP_IP_PARAM(TP_IP_PARAM); \
862 __ret = __chan->ops->event_reserve(&__ctx, __event_recorder->id); \
866 __chan->ops->event_commit(&__ctx); \
869 case LTTNG_UST_EVENT_TYPE_NOTIFIER: \
871 struct lttng_ust_event_notifier *__event_notifier = (struct lttng_ust_event_notifier *) __event->child; \
873 if (caa_unlikely(!cds_list_empty(&__event_notifier->capture_bytecode_runtime_head))) \
874 __event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
875 _TP_ARGS_DATA_VAR(_args)); \
877 __event_notifier->notification_send(__event_notifier, \
878 __stackvar.__interpreter_stack_data); \
884 #include TRACEPOINT_INCLUDE
886 #undef __get_dynamic_len
889 * Stage 5.1 of tracepoint event generation.
891 * Create probe signature
894 /* Reset all macros within TRACEPOINT_EVENT */
895 #include <lttng/ust-tracepoint-event-reset.h>
898 #define TP_ARGS(...) __VA_ARGS__
900 #define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
902 #undef _TRACEPOINT_EVENT_CLASS
903 #define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
904 static const char __tp_event_signature___##_provider##___##_name[] = \
905 _TP_EXTRACT_STRING2(_args);
907 #include TRACEPOINT_INCLUDE
909 #undef _TP_EXTRACT_STRING2
912 * Stage 6 of tracepoint event generation.
914 * Tracepoint loglevel mapping definition generation. We generate a
915 * symbol for each mapping for a provider/event to ensure at most a 1 to
916 * 1 mapping between events and loglevels. If the symbol is repeated,
917 * the compiler will complain.
920 /* Reset all macros within TRACEPOINT_EVENT */
921 #include <lttng/ust-tracepoint-event-reset.h>
924 * Declare _loglevel___##__provider##___##__name as non-static, with
925 * hidden visibility for c++ handling of weakref. We do a weakref to the
926 * symbol in a later stage, which requires that the symbol is not
930 #define LTTNG_TP_EXTERN_C extern "C"
932 #define LTTNG_TP_EXTERN_C
935 #undef TRACEPOINT_LOGLEVEL
936 #define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
937 static const int _loglevel_value___##__provider##___##__name = __loglevel; \
938 LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name \
939 __attribute__((visibility("hidden"))) = \
940 &_loglevel_value___##__provider##___##__name;
942 #include TRACEPOINT_INCLUDE
944 #undef LTTNG_TP_EXTERN_C
947 * Stage 6.1 of tracepoint event generation.
949 * Tracepoint UML URI info.
952 /* Reset all macros within TRACEPOINT_EVENT */
953 #include <lttng/ust-tracepoint-event-reset.h>
956 * Declare _model_emf_uri___##__provider##___##__name as non-static,
957 * with hidden visibility for c++ handling of weakref. We do a weakref
958 * to the symbol in a later stage, which requires that the symbol is not
962 #define LTTNG_TP_EXTERN_C extern "C"
964 #define LTTNG_TP_EXTERN_C
967 #undef TRACEPOINT_MODEL_EMF_URI
968 #define TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri) \
969 LTTNG_TP_EXTERN_C const char *_model_emf_uri___##__provider##___##__name \
970 __attribute__((visibility("hidden"))) = __uri; \
972 #include TRACEPOINT_INCLUDE
974 #undef LTTNG_TP_EXTERN_C
977 * Stage 7.1 of tracepoint event generation.
979 * Create events description structures. We use a weakref because
980 * loglevels are optional. If not declared, the event will point to the
981 * a loglevel that contains NULL.
984 /* Reset all macros within TRACEPOINT_EVENT */
985 #include <lttng/ust-tracepoint-event-reset.h>
987 #undef _TRACEPOINT_EVENT_INSTANCE
988 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
990 __ref_loglevel___##_provider##___##_name \
991 __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
992 static const char * \
993 __ref_model_emf_uri___##_provider##___##_name \
994 __attribute__((weakref ("_model_emf_uri___" #_provider "___" #_name)));\
995 static const struct lttng_ust_event_desc __event_desc___##_provider##_##_name = { \
996 .struct_size = sizeof(struct lttng_ust_event_desc), \
997 .name = #_provider ":" #_name, \
998 .probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template, \
1000 .fields = __event_fields___##_provider##___##_template, \
1001 .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template) - 1, \
1002 .loglevel = &__ref_loglevel___##_provider##___##_name, \
1003 .signature = __tp_event_signature___##_provider##___##_template, \
1004 .model_emf_uri = &__ref_model_emf_uri___##_provider##___##_name, \
1007 #include TRACEPOINT_INCLUDE
1010 * Stage 7.2 of tracepoint event generation.
1012 * Create array of events.
1015 /* Reset all macros within TRACEPOINT_EVENT */
1016 #include <lttng/ust-tracepoint-event-reset.h>
1018 #undef _TRACEPOINT_EVENT_INSTANCE
1019 #define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
1020 &__event_desc___##_provider##_##_name,
1022 static const struct lttng_ust_event_desc
*_TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
)[] = {
1023 #include TRACEPOINT_INCLUDE
1024 NULL
, /* Dummy, C99 forbids 0-len array. */
1029 * Stage 8 of tracepoint event generation.
1031 * Create a toplevel descriptor for the whole probe.
1034 /* non-const because list head will be modified when registered. */
1035 static struct lttng_ust_probe_desc
_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
) = {
1036 .struct_size
= sizeof(struct lttng_ust_probe_desc
),
1037 .provider
= __tp_stringify(TRACEPOINT_PROVIDER
),
1038 .event_desc
= _TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
),
1039 .nr_events
= _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
)) - 1,
1040 .head
= { NULL
, NULL
},
1041 .lazy_init_head
= { NULL
, NULL
},
1043 .major
= LTTNG_UST_PROVIDER_MAJOR
,
1044 .minor
= LTTNG_UST_PROVIDER_MINOR
,
1047 static int _TP_COMBINE_TOKENS(__probe_register_refcount___
, TRACEPOINT_PROVIDER
);
1050 * Stage 9 of tracepoint event generation.
1052 * Register/unregister probes at module load/unload.
1054 * Generate the constructor as an externally visible symbol for use when
1055 * linking the probe statically.
1057 * Register refcount is protected by libc dynamic loader mutex.
1060 /* Reset all macros within TRACEPOINT_EVENT */
1061 #include <lttng/ust-tracepoint-event-reset.h>
1062 static void lttng_ust_notrace
__attribute__((constructor
))
1063 _TP_COMBINE_TOKENS(__lttng_events_init__
, TRACEPOINT_PROVIDER
)(void);
1065 _TP_COMBINE_TOKENS(__lttng_events_init__
, TRACEPOINT_PROVIDER
)(void)
1069 if (_TP_COMBINE_TOKENS(__probe_register_refcount___
,
1070 TRACEPOINT_PROVIDER
)++) {
1074 * __tracepoint_provider_check_ ## TRACEPOINT_PROVIDER() is a
1075 * static inline function that ensures every probe PROVIDER
1076 * argument match the provider within which they appear. It
1077 * calls empty static inline functions, and therefore has no
1078 * runtime effect. However, if it detects an error, a linker
1079 * error will appear.
1081 _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)();
1082 ret
= lttng_ust_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
));
1084 fprintf(stderr
, "LTTng-UST: Error (%d) while registering tracepoint probe.\n", ret
);
1089 static void lttng_ust_notrace
__attribute__((destructor
))
1090 _TP_COMBINE_TOKENS(__lttng_events_exit__
, TRACEPOINT_PROVIDER
)(void);
1092 _TP_COMBINE_TOKENS(__lttng_events_exit__
, TRACEPOINT_PROVIDER
)(void)
1094 if (--_TP_COMBINE_TOKENS(__probe_register_refcount___
,
1095 TRACEPOINT_PROVIDER
)) {
1098 lttng_ust_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
));
1101 int _TP_COMBINE_TOKENS(__tracepoint_provider_
, TRACEPOINT_PROVIDER
)
1102 __attribute__((visibility("default")));