2 * Copyright (c) 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #include <urcu/compiler.h>
26 #include <urcu/rculist.h>
27 #include <lttng/ust-events.h>
28 #include <lttng/ringbuffer-config.h>
29 #include <lttng/ust-compiler.h>
30 #include <lttng/tracepoint.h>
34 #define __LTTNG_UST_NULL_STRING "(null)"
36 #undef tp_list_for_each_entry_rcu
37 #define tp_list_for_each_entry_rcu(pos, head, member) \
38 for (pos = cds_list_entry(tp_rcu_dereference_bp((head)->next), __typeof__(*pos), member); \
39 &pos->member != (head); \
40 pos = cds_list_entry(tp_rcu_dereference_bp(pos->member.next), __typeof__(*pos), member))
43 * TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
44 * same arguments and having the same field layout.
46 * TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
47 * its own provider and name. It refers to a class (template).
49 * TRACEPOINT_EVENT declared both a class and an instance and does a
50 * direct mapping from the instance to the class.
53 #undef TRACEPOINT_EVENT
54 #define TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
55 TRACEPOINT_EVENT_CLASS(_provider, _name, \
57 _TP_PARAMS(_fields)) \
58 TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name, \
62 #define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
64 #define _tp_max_t(type, x, y) \
68 __max1 > __max2 ? __max1: __max2; \
72 * Stage 0 of tracepoint event generation.
74 * Check that each TRACEPOINT_EVENT provider argument match the
75 * TRACEPOINT_PROVIDER by creating dummy callbacks.
78 /* Reset all macros within TRACEPOINT_EVENT */
79 #include <lttng/ust-tracepoint-event-reset.h>
81 static inline lttng_ust_notrace
82 void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_
, TRACEPOINT_PROVIDER
)(void);
84 void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_
, TRACEPOINT_PROVIDER
)(void)
88 #undef TRACEPOINT_EVENT_CLASS
89 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
90 __tracepoint_provider_mismatch_##_provider();
92 #undef TRACEPOINT_EVENT_INSTANCE
93 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
94 __tracepoint_provider_mismatch_##_provider();
96 static inline lttng_ust_notrace
97 void _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)(void);
99 void _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)(void)
101 #include TRACEPOINT_INCLUDE
105 * Stage 0.1 of tracepoint event generation.
107 * Check that each TRACEPOINT_EVENT provider:name does not exceed the
108 * tracepoint name length limit.
111 /* Reset all macros within TRACEPOINT_EVENT */
112 #include <lttng/ust-tracepoint-event-reset.h>
114 #undef TRACEPOINT_EVENT_INSTANCE
115 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
117 __tp_name_len_check##_provider##___##_name[LTTNG_UST_SYM_NAME_LEN] \
118 __attribute__((unused)) = \
119 #_provider ":" #_name;
121 #include TRACEPOINT_INCLUDE
124 * Stage 0.9 of tracepoint event generation
126 * Unfolding the enums
128 #include <lttng/ust-tracepoint-event-reset.h>
130 /* Enumeration entry (single value) */
131 #undef ctf_enum_value
132 #define ctf_enum_value(_string, _value) \
135 .value = lttng_is_signed_type(__typeof__(_value)) ? \
136 (long long) (_value) : (_value), \
137 .signedness = lttng_is_signed_type(__typeof__(_value)), \
140 .value = lttng_is_signed_type(__typeof__(_value)) ? \
141 (long long) (_value) : (_value), \
142 .signedness = lttng_is_signed_type(__typeof__(_value)), \
144 .string = (_string), \
147 /* Enumeration entry (range) */
148 #undef ctf_enum_range
149 #define ctf_enum_range(_string, _range_start, _range_end) \
152 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
153 (long long) (_range_start) : (_range_start), \
154 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
157 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
158 (long long) (_range_end) : (_range_end), \
159 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
161 .string = (_string), \
164 #undef TP_ENUM_VALUES
165 #define TP_ENUM_VALUES(...) \
168 #undef TRACEPOINT_ENUM
169 #define TRACEPOINT_ENUM(_provider, _name, _values) \
170 const struct lttng_enum_entry __enum_values__##_provider##_##_name[] = { \
172 ctf_enum_value("", 0) /* Dummy, 0-len array forbidden by C99. */ \
175 #include TRACEPOINT_INCLUDE
178 * Stage 1 of tracepoint event generation.
180 * Create event field type metadata section.
181 * Each event produce an array of fields.
184 /* Reset all macros within TRACEPOINT_EVENT */
185 #include <lttng/ust-tracepoint-event-reset.h>
186 #include <lttng/ust-tracepoint-event-write.h>
187 #include <lttng/ust-tracepoint-event-nowrite.h>
189 #undef _ctf_integer_ext
190 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
193 .type = __type_integer(_type, _byte_order, _base, none),\
194 .nowrite = _nowrite, \
198 #define _ctf_float(_type, _item, _src, _nowrite) \
201 .type = __type_float(_type), \
202 .nowrite = _nowrite, \
205 #undef _ctf_array_encoded
206 #define _ctf_array_encoded(_type, _item, _src, _length, _encoding, _nowrite) \
211 .atype = atype_array, \
216 .elem_type = __type_integer(_type, BYTE_ORDER, 10, _encoding), \
221 .nowrite = _nowrite, \
224 #undef _ctf_sequence_encoded
225 #define _ctf_sequence_encoded(_type, _item, _src, \
226 _length_type, _src_length, _encoding, _nowrite, \
232 .atype = atype_sequence, \
237 .length_type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
238 .elem_type = __type_integer(_type, BYTE_ORDER, _elem_type_base, _encoding), \
242 .nowrite = _nowrite, \
246 #define _ctf_string(_item, _src, _nowrite) \
251 .atype = atype_string, \
254 .basic = { .string = { .encoding = lttng_encode_UTF8 } } \
257 .nowrite = _nowrite, \
261 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
265 .atype = atype_enum, \
269 .desc = &__enum_##_provider##_##_name, \
270 .container_type = { \
271 .size = sizeof(_type) * CHAR_BIT, \
272 .alignment = lttng_alignof(_type) * CHAR_BIT, \
273 .signedness = lttng_is_signed_type(_type), \
274 .reverse_byte_order = 0, \
276 .encoding = lttng_encode_none, \
282 .nowrite = _nowrite, \
286 #define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
288 #undef TRACEPOINT_EVENT_CLASS
289 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
290 static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
292 ctf_integer(int, dummy, 0) /* Dummy, C99 forbids 0-len array. */ \
295 #undef TRACEPOINT_ENUM
296 #define TRACEPOINT_ENUM(_provider, _name, _values) \
297 static const struct lttng_enum_desc __enum_##_provider##_##_name = { \
298 .name = #_provider "_" #_name, \
299 .entries = __enum_values__##_provider##_##_name, \
300 .nr_entries = _TP_ARRAY_SIZE(__enum_values__##_provider##_##_name) - 1, \
303 #include TRACEPOINT_INCLUDE
306 * Stage 2 of tracepoint event generation.
308 * Create probe callback prototypes.
311 /* Reset all macros within TRACEPOINT_EVENT */
312 #include <lttng/ust-tracepoint-event-reset.h>
315 #define TP_ARGS(...) __VA_ARGS__
317 #undef TRACEPOINT_EVENT_CLASS
318 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
319 static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
321 #include TRACEPOINT_INCLUDE
324 * Stage 3.0 of tracepoint event generation.
326 * Create static inline function that calculates event size.
329 /* Reset all macros within TRACEPOINT_EVENT */
330 #include <lttng/ust-tracepoint-event-reset.h>
331 #include <lttng/ust-tracepoint-event-write.h>
333 #undef _ctf_integer_ext
334 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
335 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
336 __event_len += sizeof(_type);
339 #define _ctf_float(_type, _item, _src, _nowrite) \
340 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
341 __event_len += sizeof(_type);
343 #undef _ctf_array_encoded
344 #define _ctf_array_encoded(_type, _item, _src, _length, _encoding, _nowrite) \
345 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
346 __event_len += sizeof(_type) * (_length);
348 #undef _ctf_sequence_encoded
349 #define _ctf_sequence_encoded(_type, _item, _src, _length_type, \
350 _src_length, _encoding, _nowrite, _elem_type_base) \
351 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type)); \
352 __event_len += sizeof(_length_type); \
353 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
354 __dynamic_len[__dynamic_len_idx] = (_src_length); \
355 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
359 #define _ctf_string(_item, _src, _nowrite) \
360 __event_len += __dynamic_len[__dynamic_len_idx++] = \
361 strlen((_src) ? (_src) : __LTTNG_UST_NULL_STRING) + 1;
364 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
365 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
368 #define TP_ARGS(...) __VA_ARGS__
371 #define TP_FIELDS(...) __VA_ARGS__
373 #undef TRACEPOINT_EVENT_CLASS
374 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
375 static inline lttng_ust_notrace \
376 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)); \
378 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
380 size_t __event_len = 0; \
381 unsigned int __dynamic_len_idx = 0; \
384 (void) __dynamic_len_idx; /* don't warn if unused */ \
386 return __event_len; \
389 #include TRACEPOINT_INCLUDE
392 * Stage 3.1 of tracepoint event generation.
394 * Create static inline function that layout the filter stack data.
395 * We make both write and nowrite data available to the filter.
398 /* Reset all macros within TRACEPOINT_EVENT */
399 #include <lttng/ust-tracepoint-event-reset.h>
400 #include <lttng/ust-tracepoint-event-write.h>
401 #include <lttng/ust-tracepoint-event-nowrite.h>
403 #undef _ctf_integer_ext
404 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
405 if (lttng_is_signed_type(_type)) { \
406 int64_t __ctf_tmp_int64; \
407 switch (sizeof(_type)) { \
410 union { _type t; int8_t v; } __tmp = { (_type) (_src) }; \
411 __ctf_tmp_int64 = (int64_t) __tmp.v; \
416 union { _type t; int16_t v; } __tmp = { (_type) (_src) }; \
417 if (_byte_order != BYTE_ORDER) \
418 __tmp.v = bswap_16(__tmp.v); \
419 __ctf_tmp_int64 = (int64_t) __tmp.v; \
424 union { _type t; int32_t v; } __tmp = { (_type) (_src) }; \
425 if (_byte_order != BYTE_ORDER) \
426 __tmp.v = bswap_32(__tmp.v); \
427 __ctf_tmp_int64 = (int64_t) __tmp.v; \
432 union { _type t; int64_t v; } __tmp = { (_type) (_src) }; \
433 if (_byte_order != BYTE_ORDER) \
434 __tmp.v = bswap_64(__tmp.v); \
435 __ctf_tmp_int64 = (int64_t) __tmp.v; \
441 memcpy(__stack_data, &__ctf_tmp_int64, sizeof(int64_t)); \
443 uint64_t __ctf_tmp_uint64; \
444 switch (sizeof(_type)) { \
447 union { _type t; uint8_t v; } __tmp = { (_type) (_src) }; \
448 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
453 union { _type t; uint16_t v; } __tmp = { (_type) (_src) }; \
454 if (_byte_order != BYTE_ORDER) \
455 __tmp.v = bswap_16(__tmp.v); \
456 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
461 union { _type t; uint32_t v; } __tmp = { (_type) (_src) }; \
462 if (_byte_order != BYTE_ORDER) \
463 __tmp.v = bswap_32(__tmp.v); \
464 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
469 union { _type t; uint64_t v; } __tmp = { (_type) (_src) }; \
470 if (_byte_order != BYTE_ORDER) \
471 __tmp.v = bswap_64(__tmp.v); \
472 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
478 memcpy(__stack_data, &__ctf_tmp_uint64, sizeof(uint64_t)); \
480 __stack_data += sizeof(int64_t);
483 #define _ctf_float(_type, _item, _src, _nowrite) \
485 double __ctf_tmp_double = (double) (_type) (_src); \
486 memcpy(__stack_data, &__ctf_tmp_double, sizeof(double)); \
487 __stack_data += sizeof(double); \
490 #undef _ctf_array_encoded
491 #define _ctf_array_encoded(_type, _item, _src, _length, _encoding, _nowrite) \
493 unsigned long __ctf_tmp_ulong = (unsigned long) (_length); \
494 const void *__ctf_tmp_ptr = (_src); \
495 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
496 __stack_data += sizeof(unsigned long); \
497 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
498 __stack_data += sizeof(void *); \
501 #undef _ctf_sequence_encoded
502 #define _ctf_sequence_encoded(_type, _item, _src, _length_type, \
503 _src_length, _encoding, _nowrite, _elem_type_base) \
505 unsigned long __ctf_tmp_ulong = (unsigned long) (_src_length); \
506 const void *__ctf_tmp_ptr = (_src); \
507 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
508 __stack_data += sizeof(unsigned long); \
509 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
510 __stack_data += sizeof(void *); \
514 #define _ctf_string(_item, _src, _nowrite) \
516 const void *__ctf_tmp_ptr = \
517 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
518 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
519 __stack_data += sizeof(void *); \
523 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
524 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
527 #define TP_ARGS(...) __VA_ARGS__
530 #define TP_FIELDS(...) __VA_ARGS__
532 #undef TRACEPOINT_EVENT_CLASS
533 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
535 void __event_prepare_filter_stack__##_provider##___##_name(char *__stack_data,\
536 _TP_ARGS_DATA_PROTO(_args)) \
541 #include TRACEPOINT_INCLUDE
544 * Stage 4 of tracepoint event generation.
546 * Create static inline function that calculates event payload alignment.
549 /* Reset all macros within TRACEPOINT_EVENT */
550 #include <lttng/ust-tracepoint-event-reset.h>
551 #include <lttng/ust-tracepoint-event-write.h>
553 #undef _ctf_integer_ext
554 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
555 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
558 #define _ctf_float(_type, _item, _src, _nowrite) \
559 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
561 #undef _ctf_array_encoded
562 #define _ctf_array_encoded(_type, _item, _src, _length, _encoding, _nowrite) \
563 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
565 #undef _ctf_sequence_encoded
566 #define _ctf_sequence_encoded(_type, _item, _src, _length_type, \
567 _src_length, _encoding, _nowrite, _elem_type_base) \
568 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type)); \
569 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
572 #define _ctf_string(_item, _src, _nowrite)
575 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
576 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
579 #define TP_ARGS(...) __VA_ARGS__
582 #define TP_FIELDS(...) __VA_ARGS__
584 #undef TRACEPOINT_EVENT_CLASS
585 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
586 static inline lttng_ust_notrace \
587 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)); \
589 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)) \
591 size_t __event_align = 1; \
593 return __event_align; \
596 #include TRACEPOINT_INCLUDE
600 * Stage 5 of tracepoint event generation.
602 * Create the probe function. This function calls event size calculation
603 * and writes event data into the buffer.
606 /* Reset all macros within TRACEPOINT_EVENT */
607 #include <lttng/ust-tracepoint-event-reset.h>
608 #include <lttng/ust-tracepoint-event-write.h>
610 #undef _ctf_integer_ext
611 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
613 _type __tmp = (_src); \
614 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
615 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
619 #define _ctf_float(_type, _item, _src, _nowrite) \
621 _type __tmp = (_src); \
622 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
623 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
626 #undef _ctf_array_encoded
627 #define _ctf_array_encoded(_type, _item, _src, _length, _encoding, _nowrite) \
628 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
629 __chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));
631 #undef _ctf_sequence_encoded
632 #define _ctf_sequence_encoded(_type, _item, _src, _length_type, \
633 _src_length, _encoding, _nowrite, _elem_type_base) \
635 _length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
636 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
637 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
639 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
640 __chan->ops->event_write(&__ctx, _src, \
641 sizeof(_type) * __get_dynamic_len(dest));
644 * __chan->ops->u.has_strcpy is a flag letting us know if the LTTng-UST
645 * tracepoint provider ABI implements event_strcpy. This dynamic check
646 * can be removed when the tracepoint provider ABI moves to 2.
648 #if (LTTNG_UST_PROVIDER_MAJOR > 1)
649 #error "Tracepoint probe provider major version has changed. Please remove dynamic check for has_strcpy."
653 #define _ctf_string(_item, _src, _nowrite) \
655 const char *__ctf_tmp_string = \
656 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
657 lib_ring_buffer_align_ctx(&__ctx, \
658 lttng_alignof(*__ctf_tmp_string)); \
659 if (__chan->ops->u.has_strcpy) \
660 __chan->ops->event_strcpy(&__ctx, __ctf_tmp_string, \
661 __get_dynamic_len(dest)); \
663 __chan->ops->event_write(&__ctx, __ctf_tmp_string, \
664 __get_dynamic_len(dest)); \
669 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
670 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
672 /* Beware: this get len actually consumes the len value */
673 #undef __get_dynamic_len
674 #define __get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
677 #define TP_ARGS(...) __VA_ARGS__
680 #define TP_FIELDS(...) __VA_ARGS__
683 * For state dump, check that "session" argument (mandatory) matches the
684 * session this event belongs to. Ensures that we write state dump data only
685 * into the started session, not into all sessions.
687 #undef _TP_SESSION_CHECK
688 #ifdef TP_SESSION_CHECK
689 #define _TP_SESSION_CHECK(session, csession) (session == csession)
690 #else /* TP_SESSION_CHECK */
691 #define _TP_SESSION_CHECK(session, csession) 1
692 #endif /* TP_SESSION_CHECK */
695 * Use of __builtin_return_address(0) sometimes seems to cause stack
696 * corruption on 32-bit PowerPC. Disable this feature on that
697 * architecture for now by always using the NULL value for the ip
702 #define _TP_IP_PARAM(x) (x)
703 #else /* TP_IP_PARAM */
705 #if defined(__PPC__) && !defined(__PPC64__)
706 #define _TP_IP_PARAM(x) NULL
707 #else /* #if defined(__PPC__) && !defined(__PPC64__) */
708 #define _TP_IP_PARAM(x) __builtin_return_address(0)
709 #endif /* #else #if defined(__PPC__) && !defined(__PPC64__) */
711 #endif /* TP_IP_PARAM */
714 * Using twice size for filter stack data to hold size and pointer for
715 * each field (worse case). For integers, max size required is 64-bit.
716 * Same for double-precision floats. Those fit within
717 * 2*sizeof(unsigned long) for all supported architectures.
718 * Perform UNION (||) of filter runtime list.
720 #undef TRACEPOINT_EVENT_CLASS
721 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
722 static lttng_ust_notrace \
723 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)); \
725 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)) \
727 struct lttng_event *__event = (struct lttng_event *) __tp_data; \
728 struct lttng_channel *__chan = __event->chan; \
729 struct lttng_ust_lib_ring_buffer_ctx __ctx; \
730 struct lttng_stack_ctx __lttng_ctx; \
731 size_t __event_len, __event_align; \
732 size_t __dynamic_len_idx = 0; \
734 size_t __dynamic_len[_TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1]; \
735 char __filter_stack_data[2 * sizeof(unsigned long) * (_TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1)]; \
740 (void) __dynamic_len_idx; /* don't warn if unused */ \
741 if (!_TP_SESSION_CHECK(session, __chan->session)) \
743 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active))) \
745 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled))) \
747 if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
749 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
751 if (caa_unlikely(!cds_list_empty(&__event->bytecode_runtime_head))) { \
752 struct lttng_bytecode_runtime *bc_runtime; \
753 int __filter_record = __event->has_enablers_without_bytecode; \
755 __event_prepare_filter_stack__##_provider##___##_name(__stackvar.__filter_stack_data, \
756 _TP_ARGS_DATA_VAR(_args)); \
757 tp_list_for_each_entry_rcu(bc_runtime, &__event->bytecode_runtime_head, node) { \
758 if (caa_unlikely(bc_runtime->filter(bc_runtime, \
759 __stackvar.__filter_stack_data) & LTTNG_FILTER_RECORD_FLAG)) \
760 __filter_record = 1; \
762 if (caa_likely(!__filter_record)) \
765 __event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
766 _TP_ARGS_DATA_VAR(_args)); \
767 __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
768 memset(&__lttng_ctx, 0, sizeof(__lttng_ctx)); \
769 __lttng_ctx.event = __event; \
770 __lttng_ctx.chan_ctx = tp_rcu_dereference_bp(__chan->ctx); \
771 __lttng_ctx.event_ctx = tp_rcu_dereference_bp(__event->ctx); \
772 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
773 __event_align, -1, __chan->handle, &__lttng_ctx); \
774 __ctx.ip = _TP_IP_PARAM(TP_IP_PARAM); \
775 __ret = __chan->ops->event_reserve(&__ctx, __event->id); \
779 __chan->ops->event_commit(&__ctx); \
782 #include TRACEPOINT_INCLUDE
784 #undef __get_dynamic_len
787 * Stage 5.1 of tracepoint event generation.
789 * Create probe signature
792 /* Reset all macros within TRACEPOINT_EVENT */
793 #include <lttng/ust-tracepoint-event-reset.h>
796 #define TP_ARGS(...) __VA_ARGS__
798 #define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
800 #undef TRACEPOINT_EVENT_CLASS
801 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
802 static const char __tp_event_signature___##_provider##___##_name[] = \
803 _TP_EXTRACT_STRING2(_args);
805 #include TRACEPOINT_INCLUDE
807 #undef _TP_EXTRACT_STRING2
810 * Stage 6 of tracepoint event generation.
812 * Tracepoint loglevel mapping definition generation. We generate a
813 * symbol for each mapping for a provider/event to ensure at most a 1 to
814 * 1 mapping between events and loglevels. If the symbol is repeated,
815 * the compiler will complain.
818 /* Reset all macros within TRACEPOINT_EVENT */
819 #include <lttng/ust-tracepoint-event-reset.h>
822 * Declare _loglevel___##__provider##___##__name as non-static, with
823 * hidden visibility for c++ handling of weakref. We do a weakref to the
824 * symbol in a later stage, which requires that the symbol is not
828 #define LTTNG_TP_EXTERN_C extern "C"
830 #define LTTNG_TP_EXTERN_C
833 #undef TRACEPOINT_LOGLEVEL
834 #define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
835 static const int _loglevel_value___##__provider##___##__name = __loglevel; \
836 LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name \
837 __attribute__((visibility("hidden"))) = \
838 &_loglevel_value___##__provider##___##__name;
840 #include TRACEPOINT_INCLUDE
842 #undef LTTNG_TP_EXTERN_C
845 * Stage 6.1 of tracepoint event generation.
847 * Tracepoint UML URI info.
850 /* Reset all macros within TRACEPOINT_EVENT */
851 #include <lttng/ust-tracepoint-event-reset.h>
854 * Declare _model_emf_uri___##__provider##___##__name as non-static,
855 * with hidden visibility for c++ handling of weakref. We do a weakref
856 * to the symbol in a later stage, which requires that the symbol is not
860 #define LTTNG_TP_EXTERN_C extern "C"
862 #define LTTNG_TP_EXTERN_C
865 #undef TRACEPOINT_MODEL_EMF_URI
866 #define TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri) \
867 LTTNG_TP_EXTERN_C const char *_model_emf_uri___##__provider##___##__name \
868 __attribute__((visibility("hidden"))) = __uri; \
870 #include TRACEPOINT_INCLUDE
872 #undef LTTNG_TP_EXTERN_C
875 * Stage 7.1 of tracepoint event generation.
877 * Create events description structures. We use a weakref because
878 * loglevels are optional. If not declared, the event will point to the
879 * a loglevel that contains NULL.
882 /* Reset all macros within TRACEPOINT_EVENT */
883 #include <lttng/ust-tracepoint-event-reset.h>
885 #undef TRACEPOINT_EVENT_INSTANCE
886 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
888 __ref_loglevel___##_provider##___##_name \
889 __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
890 static const char * \
891 __ref_model_emf_uri___##_provider##___##_name \
892 __attribute__((weakref ("_model_emf_uri___" #_provider "___" #_name)));\
893 static const struct lttng_event_desc __event_desc___##_provider##_##_name = { \
894 .name = #_provider ":" #_name, \
895 .probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
897 .fields = __event_fields___##_provider##___##_template, \
898 .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template) - 1, \
899 .loglevel = &__ref_loglevel___##_provider##___##_name, \
900 .signature = __tp_event_signature___##_provider##___##_template, \
903 .model_emf_uri = &__ref_model_emf_uri___##_provider##___##_name, \
908 #include TRACEPOINT_INCLUDE
911 * Stage 7.2 of tracepoint event generation.
913 * Create array of events.
916 /* Reset all macros within TRACEPOINT_EVENT */
917 #include <lttng/ust-tracepoint-event-reset.h>
919 #undef TRACEPOINT_EVENT_INSTANCE
920 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
921 &__event_desc___##_provider##_##_name,
923 static const struct lttng_event_desc
*_TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
)[] = {
924 #include TRACEPOINT_INCLUDE
925 NULL
, /* Dummy, C99 forbids 0-len array. */
930 * Stage 8 of tracepoint event generation.
932 * Create a toplevel descriptor for the whole probe.
935 /* non-const because list head will be modified when registered. */
936 static struct lttng_probe_desc
_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
) = {
937 .provider
= __tp_stringify(TRACEPOINT_PROVIDER
),
938 .event_desc
= _TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
),
939 .nr_events
= _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___
, TRACEPOINT_PROVIDER
)) - 1,
940 .head
= { NULL
, NULL
},
941 .lazy_init_head
= { NULL
, NULL
},
943 .major
= LTTNG_UST_PROVIDER_MAJOR
,
944 .minor
= LTTNG_UST_PROVIDER_MINOR
,
947 static int _TP_COMBINE_TOKENS(__probe_register_refcount___
, TRACEPOINT_PROVIDER
);
950 * Stage 9 of tracepoint event generation.
952 * Register/unregister probes at module load/unload.
954 * Generate the constructor as an externally visible symbol for use when
955 * linking the probe statically.
957 * Register refcount is protected by libc dynamic loader mutex.
960 /* Reset all macros within TRACEPOINT_EVENT */
961 #include <lttng/ust-tracepoint-event-reset.h>
962 static void lttng_ust_notrace
__attribute__((constructor
))
963 _TP_COMBINE_TOKENS(__lttng_events_init__
, TRACEPOINT_PROVIDER
)(void);
965 _TP_COMBINE_TOKENS(__lttng_events_init__
, TRACEPOINT_PROVIDER
)(void)
969 if (_TP_COMBINE_TOKENS(__probe_register_refcount___
,
970 TRACEPOINT_PROVIDER
)++) {
974 * __tracepoint_provider_check_ ## TRACEPOINT_PROVIDER() is a
975 * static inline function that ensures every probe PROVIDER
976 * argument match the provider within which they appear. It
977 * calls empty static inline functions, and therefore has no
978 * runtime effect. However, if it detects an error, a linker
981 _TP_COMBINE_TOKENS(__tracepoint_provider_check_
, TRACEPOINT_PROVIDER
)();
982 ret
= lttng_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
));
984 fprintf(stderr
, "LTTng-UST: Error (%d) while registering tracepoint probe. Duplicate registration of tracepoint probes having the same name is not allowed.\n", ret
);
989 static void lttng_ust_notrace
__attribute__((destructor
))
990 _TP_COMBINE_TOKENS(__lttng_events_exit__
, TRACEPOINT_PROVIDER
)(void);
992 _TP_COMBINE_TOKENS(__lttng_events_exit__
, TRACEPOINT_PROVIDER
)(void)
994 if (--_TP_COMBINE_TOKENS(__probe_register_refcount___
,
995 TRACEPOINT_PROVIDER
)) {
998 lttng_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___
, TRACEPOINT_PROVIDER
));
1001 int _TP_COMBINE_TOKENS(__tracepoint_provider_
, TRACEPOINT_PROVIDER
);