projects / lttng-ust.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Move to kernel style SPDX license identifiers
[lttng-ust.git] / include / lttng / ust-tracepoint-event.h
... / ...
CommitLineData
1/*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright (C) 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 */
6
7#include <stdint.h>
8#include <stdio.h>
9#include <stdlib.h>
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>
17#include <string.h>
18
19#define __LTTNG_UST_NULL_STRING "(null)"
20
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))
26
27/*
28 * TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
29 * same arguments and having the same field layout.
30 *
31 * TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
32 * its own provider and name. It refers to a class (template).
33 *
34 * TRACEPOINT_EVENT declared both a class and an instance and does a
35 * direct mapping from the instance to the class.
36 */
37
38#undef TRACEPOINT_EVENT
39#define TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
40 _TRACEPOINT_EVENT_CLASS(_provider, _name, \
41 _TP_PARAMS(_args), \
42 _TP_PARAMS(_fields)) \
43 _TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name, \
44 _TP_PARAMS(_args))
45
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))
49
50#undef TRACEPOINT_EVENT_INSTANCE
51#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
52 _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _TP_PARAMS(_args))
53
54/* Helpers */
55#define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
56
57#define _tp_max_t(type, x, y) \
58 ({ \
59 type __max1 = (x); \
60 type __max2 = (y); \
61 __max1 > __max2 ? __max1: __max2; \
62 })
63
64/*
65 * Stage 0 of tracepoint event generation.
66 *
67 * Check that each TRACEPOINT_EVENT provider argument match the
68 * TRACEPOINT_PROVIDER by creating dummy callbacks.
69 */
70
71/* Reset all macros within TRACEPOINT_EVENT */
72#include <lttng/ust-tracepoint-event-reset.h>
73
74static inline lttng_ust_notrace
75void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void);
76static inline
77void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
78{
79}
80
81#undef _TRACEPOINT_EVENT_CLASS
82#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
83 __tracepoint_provider_mismatch_##_provider();
84
85#undef _TRACEPOINT_EVENT_INSTANCE
86#define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
87 __tracepoint_provider_mismatch_##_provider();
88
89static inline lttng_ust_notrace
90void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void);
91static inline
92void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
93{
94#include TRACEPOINT_INCLUDE
95}
96
97/*
98 * Stage 0.1 of tracepoint event generation.
99 *
100 * Check that each TRACEPOINT_EVENT provider:name does not exceed the
101 * tracepoint name length limit.
102 */
103
104/* Reset all macros within TRACEPOINT_EVENT */
105#include <lttng/ust-tracepoint-event-reset.h>
106
107#undef _TRACEPOINT_EVENT_INSTANCE
108#define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
109static const char \
110 __tp_name_len_check##_provider##___##_name[LTTNG_UST_SYM_NAME_LEN] \
111 __attribute__((unused)) = \
112 #_provider ":" #_name;
113
114#include TRACEPOINT_INCLUDE
115
116/*
117 * Stage 0.2 of tracepoint event generation.
118 *
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.
122 */
123
124/* Reset all macros within TRACEPOINT_EVENT */
125#include <lttng/ust-tracepoint-event-reset.h>
126
127#undef TP_ARGS
128#define TP_ARGS(...) __VA_ARGS__
129
130#undef _TRACEPOINT_EVENT_INSTANCE
131#define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
132void __event_template_proto___##_provider##___##_template(_TP_ARGS_DATA_PROTO(_args));
133
134#undef _TRACEPOINT_EVENT_CLASS
135#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
136void __event_template_proto___##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
137
138#include TRACEPOINT_INCLUDE
139
140/*
141 * Stage 0.9 of tracepoint event generation
142 *
143 * Unfolding the enums
144 */
145#include <lttng/ust-tracepoint-event-reset.h>
146
147/* Enumeration entry (single value) */
148#undef ctf_enum_value
149#define ctf_enum_value(_string, _value) \
150 { \
151 .start = { \
152 .value = lttng_is_signed_type(__typeof__(_value)) ? \
153 (long long) (_value) : (_value), \
154 .signedness = lttng_is_signed_type(__typeof__(_value)), \
155 }, \
156 .end = { \
157 .value = lttng_is_signed_type(__typeof__(_value)) ? \
158 (long long) (_value) : (_value), \
159 .signedness = lttng_is_signed_type(__typeof__(_value)), \
160 }, \
161 .string = (_string), \
162 },
163
164/* Enumeration entry (range) */
165#undef ctf_enum_range
166#define ctf_enum_range(_string, _range_start, _range_end) \
167 { \
168 .start = { \
169 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
170 (long long) (_range_start) : (_range_start), \
171 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
172 }, \
173 .end = { \
174 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
175 (long long) (_range_end) : (_range_end), \
176 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
177 }, \
178 .string = (_string), \
179 },
180
181/* Enumeration entry (automatic value; follows the rules of CTF) */
182#undef ctf_enum_auto
183#define ctf_enum_auto(_string) \
184 { \
185 .start = { \
186 .value = -1ULL, \
187 .signedness = 0, \
188 }, \
189 .end = { \
190 .value = -1ULL, \
191 .signedness = 0, \
192 }, \
193 .string = (_string), \
194 .u = { \
195 .extra = { \
196 .options = LTTNG_ENUM_ENTRY_OPTION_IS_AUTO, \
197 }, \
198 }, \
199 },
200
201#undef TP_ENUM_VALUES
202#define TP_ENUM_VALUES(...) \
203 __VA_ARGS__
204
205#undef TRACEPOINT_ENUM
206#define TRACEPOINT_ENUM(_provider, _name, _values) \
207 const struct lttng_enum_entry __enum_values__##_provider##_##_name[] = { \
208 _values \
209 ctf_enum_value("", 0) /* Dummy, 0-len array forbidden by C99. */ \
210 };
211#include TRACEPOINT_INCLUDE
212
213/*
214 * Stage 0.9.1
215 * Verifying array and sequence elements are of an integer type.
216 */
217
218/* Reset all macros within TRACEPOINT_EVENT */
219#include <lttng/ust-tracepoint-event-reset.h>
220#include <lttng/ust-tracepoint-event-write.h>
221#include <lttng/ust-tracepoint-event-nowrite.h>
222
223#undef _ctf_array_encoded
224#define _ctf_array_encoded(_type, _item, _src, _byte_order, \
225 _length, _encoding, _nowrite, \
226 _elem_type_base) \
227 _lttng_array_element_type_is_supported(_type, _item)
228
229#undef _ctf_sequence_encoded
230#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
231 _length_type, _src_length, _encoding, _nowrite, \
232 _elem_type_base) \
233 _lttng_array_element_type_is_supported(_type, _item)
234
235#undef TP_FIELDS
236#define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
237
238#undef _TRACEPOINT_EVENT_CLASS
239#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
240 _fields
241
242#include TRACEPOINT_INCLUDE
243
244/*
245 * Stage 1 of tracepoint event generation.
246 *
247 * Create event field type metadata section.
248 * Each event produce an array of fields.
249 */
250
251/* Reset all macros within TRACEPOINT_EVENT */
252#include <lttng/ust-tracepoint-event-reset.h>
253#include <lttng/ust-tracepoint-event-write.h>
254#include <lttng/ust-tracepoint-event-nowrite.h>
255
256#undef _ctf_integer_ext
257#define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
258 { \
259 .name = #_item, \
260 .type = __type_integer(_type, _byte_order, _base, none),\
261 .nowrite = _nowrite, \
262 .u = { \
263 .ext = { \
264 .nofilter = 0, \
265 }, \
266 }, \
267 },
268
269#undef _ctf_float
270#define _ctf_float(_type, _item, _src, _nowrite) \
271 { \
272 .name = #_item, \
273 .type = __type_float(_type), \
274 .nowrite = _nowrite, \
275 .u = { \
276 .ext = { \
277 .nofilter = 0, \
278 }, \
279 }, \
280 },
281
282#undef _ctf_array_encoded
283#define _ctf_array_encoded(_type, _item, _src, _byte_order, \
284 _length, _encoding, _nowrite, \
285 _elem_type_base) \
286 { \
287 .name = #_item, \
288 .type = \
289 { \
290 .atype = atype_array_nestable, \
291 .u = \
292 { \
293 .array_nestable = \
294 { \
295 .elem_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
296 __type_integer(_type, _byte_order, _elem_type_base, _encoding)), \
297 .length = _length, \
298 .alignment = 0, \
299 } \
300 } \
301 }, \
302 .nowrite = _nowrite, \
303 .u = { \
304 .ext = { \
305 .nofilter = 0, \
306 }, \
307 }, \
308 },
309
310#undef _ctf_sequence_encoded
311#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
312 _length_type, _src_length, _encoding, _nowrite, \
313 _elem_type_base) \
314 { \
315 .name = "_" #_item "_length", \
316 .type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
317 .nowrite = _nowrite, \
318 .u = { \
319 .ext = { \
320 .nofilter = 1, \
321 }, \
322 }, \
323 }, \
324 { \
325 .name = #_item, \
326 .type = \
327 { \
328 .atype = atype_sequence_nestable, \
329 .u = \
330 { \
331 .sequence_nestable = \
332 { \
333 .length_name = "_" #_item "_length", \
334 .elem_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
335 __type_integer(_type, _byte_order, _elem_type_base, _encoding)), \
336 .alignment = 0, \
337 }, \
338 }, \
339 }, \
340 .nowrite = _nowrite, \
341 .u = { \
342 .ext = { \
343 .nofilter = 0, \
344 }, \
345 }, \
346 },
347
348#undef _ctf_string
349#define _ctf_string(_item, _src, _nowrite) \
350 { \
351 .name = #_item, \
352 .type = \
353 { \
354 .atype = atype_string, \
355 .u = \
356 { \
357 .string = { .encoding = lttng_encode_UTF8 } \
358 }, \
359 }, \
360 .nowrite = _nowrite, \
361 .u = { \
362 .ext = { \
363 .nofilter = 0, \
364 }, \
365 }, \
366 },
367
368#undef _ctf_enum
369#define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
370 { \
371 .name = #_item, \
372 .type = { \
373 .atype = atype_enum_nestable, \
374 .u = { \
375 .enum_nestable = { \
376 .desc = &__enum_##_provider##_##_name, \
377 .container_type = __LTTNG_COMPOUND_LITERAL(struct lttng_type, \
378 __type_integer(_type, BYTE_ORDER, 10, none)), \
379 }, \
380 }, \
381 }, \
382 .nowrite = _nowrite, \
383 .u = { \
384 .ext = { \
385 .nofilter = 0, \
386 }, \
387 }, \
388 },
389
390#undef TP_FIELDS
391#define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
392
393#undef _TRACEPOINT_EVENT_CLASS
394#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
395 static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
396 _fields \
397 ctf_integer(int, dummy, 0) /* Dummy, C99 forbids 0-len array. */ \
398 };
399
400#undef TRACEPOINT_ENUM
401#define TRACEPOINT_ENUM(_provider, _name, _values) \
402 static const struct lttng_enum_desc __enum_##_provider##_##_name = { \
403 .name = #_provider "_" #_name, \
404 .entries = __enum_values__##_provider##_##_name, \
405 .nr_entries = _TP_ARRAY_SIZE(__enum_values__##_provider##_##_name) - 1, \
406 };
407
408#include TRACEPOINT_INCLUDE
409
410/*
411 * Stage 2 of tracepoint event generation.
412 *
413 * Create probe callback prototypes.
414 */
415
416/* Reset all macros within TRACEPOINT_EVENT */
417#include <lttng/ust-tracepoint-event-reset.h>
418
419#undef TP_ARGS
420#define TP_ARGS(...) __VA_ARGS__
421
422#undef _TRACEPOINT_EVENT_CLASS
423#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
424static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
425
426#include TRACEPOINT_INCLUDE
427
428/*
429 * Stage 2.1 of tracepoint event generation.
430 *
431 * Create probe event notifier callback prototypes.
432 */
433
434/* Reset all macros within TRACEPOINT_EVENT */
435#include <lttng/ust-tracepoint-event-reset.h>
436
437#undef TP_ARGS
438#define TP_ARGS(...) __VA_ARGS__
439
440#undef _TRACEPOINT_EVENT_CLASS
441#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
442static void __event_notifier_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
443
444#include TRACEPOINT_INCLUDE
445
446/*
447 * Stage 3.0 of tracepoint event generation.
448 *
449 * Create static inline function that calculates event size.
450 */
451
452/* Reset all macros within TRACEPOINT_EVENT */
453#include <lttng/ust-tracepoint-event-reset.h>
454#include <lttng/ust-tracepoint-event-write.h>
455
456#undef _ctf_integer_ext
457#define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
458 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
459 __event_len += sizeof(_type);
460
461#undef _ctf_float
462#define _ctf_float(_type, _item, _src, _nowrite) \
463 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
464 __event_len += sizeof(_type);
465
466#undef _ctf_array_encoded
467#define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, _encoding, \
468 _nowrite, _elem_type_base) \
469 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
470 __event_len += sizeof(_type) * (_length);
471
472#undef _ctf_sequence_encoded
473#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
474 _src_length, _encoding, _nowrite, _elem_type_base) \
475 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type)); \
476 __event_len += sizeof(_length_type); \
477 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
478 __dynamic_len[__dynamic_len_idx] = (_src_length); \
479 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
480 __dynamic_len_idx++;
481
482#undef _ctf_string
483#define _ctf_string(_item, _src, _nowrite) \
484 __event_len += __dynamic_len[__dynamic_len_idx++] = \
485 strlen((_src) ? (_src) : __LTTNG_UST_NULL_STRING) + 1;
486
487#undef _ctf_enum
488#define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
489 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
490
491#undef TP_ARGS
492#define TP_ARGS(...) __VA_ARGS__
493
494#undef TP_FIELDS
495#define TP_FIELDS(...) __VA_ARGS__
496
497#undef _TRACEPOINT_EVENT_CLASS
498#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
499static inline lttng_ust_notrace \
500size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)); \
501static inline \
502size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
503{ \
504 size_t __event_len = 0; \
505 unsigned int __dynamic_len_idx = 0; \
506 \
507 if (0) \
508 (void) __dynamic_len_idx; /* don't warn if unused */ \
509 _fields \
510 return __event_len; \
511}
512
513#include TRACEPOINT_INCLUDE
514
515/*
516 * Stage 3.1 of tracepoint event generation.
517 *
518 * Create static inline function that layout the filter stack data.
519 * We make both write and nowrite data available to the filter.
520 */
521
522/* Reset all macros within TRACEPOINT_EVENT */
523#include <lttng/ust-tracepoint-event-reset.h>
524#include <lttng/ust-tracepoint-event-write.h>
525#include <lttng/ust-tracepoint-event-nowrite.h>
526
527#undef _ctf_integer_ext
528#define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
529 if (lttng_is_signed_type(_type)) { \
530 int64_t __ctf_tmp_int64; \
531 switch (sizeof(_type)) { \
532 case 1: \
533 { \
534 union { _type t; int8_t v; } __tmp = { (_type) (_src) }; \
535 __ctf_tmp_int64 = (int64_t) __tmp.v; \
536 break; \
537 } \
538 case 2: \
539 { \
540 union { _type t; int16_t v; } __tmp = { (_type) (_src) }; \
541 if (_byte_order != BYTE_ORDER) \
542 __tmp.v = bswap_16(__tmp.v); \
543 __ctf_tmp_int64 = (int64_t) __tmp.v; \
544 break; \
545 } \
546 case 4: \
547 { \
548 union { _type t; int32_t v; } __tmp = { (_type) (_src) }; \
549 if (_byte_order != BYTE_ORDER) \
550 __tmp.v = bswap_32(__tmp.v); \
551 __ctf_tmp_int64 = (int64_t) __tmp.v; \
552 break; \
553 } \
554 case 8: \
555 { \
556 union { _type t; int64_t v; } __tmp = { (_type) (_src) }; \
557 if (_byte_order != BYTE_ORDER) \
558 __tmp.v = bswap_64(__tmp.v); \
559 __ctf_tmp_int64 = (int64_t) __tmp.v; \
560 break; \
561 } \
562 default: \
563 abort(); \
564 }; \
565 memcpy(__stack_data, &__ctf_tmp_int64, sizeof(int64_t)); \
566 } else { \
567 uint64_t __ctf_tmp_uint64; \
568 switch (sizeof(_type)) { \
569 case 1: \
570 { \
571 union { _type t; uint8_t v; } __tmp = { (_type) (_src) }; \
572 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
573 break; \
574 } \
575 case 2: \
576 { \
577 union { _type t; uint16_t v; } __tmp = { (_type) (_src) }; \
578 if (_byte_order != BYTE_ORDER) \
579 __tmp.v = bswap_16(__tmp.v); \
580 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
581 break; \
582 } \
583 case 4: \
584 { \
585 union { _type t; uint32_t v; } __tmp = { (_type) (_src) }; \
586 if (_byte_order != BYTE_ORDER) \
587 __tmp.v = bswap_32(__tmp.v); \
588 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
589 break; \
590 } \
591 case 8: \
592 { \
593 union { _type t; uint64_t v; } __tmp = { (_type) (_src) }; \
594 if (_byte_order != BYTE_ORDER) \
595 __tmp.v = bswap_64(__tmp.v); \
596 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
597 break; \
598 } \
599 default: \
600 abort(); \
601 }; \
602 memcpy(__stack_data, &__ctf_tmp_uint64, sizeof(uint64_t)); \
603 } \
604 __stack_data += sizeof(int64_t);
605
606#undef _ctf_float
607#define _ctf_float(_type, _item, _src, _nowrite) \
608 { \
609 double __ctf_tmp_double = (double) (_type) (_src); \
610 memcpy(__stack_data, &__ctf_tmp_double, sizeof(double)); \
611 __stack_data += sizeof(double); \
612 }
613
614#undef _ctf_array_encoded
615#define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
616 _encoding, _nowrite, _elem_type_base) \
617 { \
618 unsigned long __ctf_tmp_ulong = (unsigned long) (_length); \
619 const void *__ctf_tmp_ptr = (_src); \
620 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
621 __stack_data += sizeof(unsigned long); \
622 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
623 __stack_data += sizeof(void *); \
624 }
625
626#undef _ctf_sequence_encoded
627#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
628 _src_length, _encoding, _nowrite, _elem_type_base) \
629 { \
630 unsigned long __ctf_tmp_ulong = (unsigned long) (_src_length); \
631 const void *__ctf_tmp_ptr = (_src); \
632 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
633 __stack_data += sizeof(unsigned long); \
634 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
635 __stack_data += sizeof(void *); \
636 }
637
638#undef _ctf_string
639#define _ctf_string(_item, _src, _nowrite) \
640 { \
641 const void *__ctf_tmp_ptr = \
642 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
643 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
644 __stack_data += sizeof(void *); \
645 }
646
647#undef _ctf_enum
648#define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
649 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
650
651#undef TP_ARGS
652#define TP_ARGS(...) __VA_ARGS__
653
654#undef TP_FIELDS
655#define TP_FIELDS(...) __VA_ARGS__
656
657#undef _TRACEPOINT_EVENT_CLASS
658#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
659static inline \
660void __event_prepare_interpreter_stack__##_provider##___##_name(char *__stack_data,\
661 _TP_ARGS_DATA_PROTO(_args)) \
662{ \
663 _fields \
664}
665
666#include TRACEPOINT_INCLUDE
667
668/*
669 * Stage 4 of tracepoint event generation.
670 *
671 * Create static inline function that calculates event payload alignment.
672 */
673
674/* Reset all macros within TRACEPOINT_EVENT */
675#include <lttng/ust-tracepoint-event-reset.h>
676#include <lttng/ust-tracepoint-event-write.h>
677
678#undef _ctf_integer_ext
679#define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
680 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
681
682#undef _ctf_float
683#define _ctf_float(_type, _item, _src, _nowrite) \
684 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
685
686#undef _ctf_array_encoded
687#define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
688 _encoding, _nowrite, _elem_type_base) \
689 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
690
691#undef _ctf_sequence_encoded
692#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
693 _src_length, _encoding, _nowrite, _elem_type_base) \
694 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type)); \
695 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
696
697#undef _ctf_string
698#define _ctf_string(_item, _src, _nowrite)
699
700#undef _ctf_enum
701#define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
702 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
703
704#undef TP_ARGS
705#define TP_ARGS(...) __VA_ARGS__
706
707#undef TP_FIELDS
708#define TP_FIELDS(...) __VA_ARGS__
709
710#undef _TRACEPOINT_EVENT_CLASS
711#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
712static inline lttng_ust_notrace \
713size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)); \
714static inline \
715size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)) \
716{ \
717 size_t __event_align = 1; \
718 _fields \
719 return __event_align; \
720}
721
722#include TRACEPOINT_INCLUDE
723
724
725/*
726 * Stage 5 of tracepoint event generation.
727 *
728 * Create the probe function. This function calls event size calculation
729 * and writes event data into the buffer.
730 */
731
732/* Reset all macros within TRACEPOINT_EVENT */
733#include <lttng/ust-tracepoint-event-reset.h>
734#include <lttng/ust-tracepoint-event-write.h>
735
736#undef _ctf_integer_ext
737#define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
738 { \
739 _type __tmp = (_src); \
740 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
741 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
742 }
743
744#undef _ctf_float
745#define _ctf_float(_type, _item, _src, _nowrite) \
746 { \
747 _type __tmp = (_src); \
748 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
749 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
750 }
751
752#undef _ctf_array_encoded
753#define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
754 _encoding, _nowrite, _elem_type_base) \
755 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
756 __chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));
757
758#undef _ctf_sequence_encoded
759#define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
760 _src_length, _encoding, _nowrite, _elem_type_base) \
761 { \
762 _length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
763 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
764 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
765 } \
766 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
767 __chan->ops->event_write(&__ctx, _src, \
768 sizeof(_type) * __get_dynamic_len(dest));
769
770#undef _ctf_string
771#define _ctf_string(_item, _src, _nowrite) \
772 { \
773 const char *__ctf_tmp_string = \
774 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
775 lib_ring_buffer_align_ctx(&__ctx, \
776 lttng_alignof(*__ctf_tmp_string)); \
777 __chan->ops->event_strcpy(&__ctx, __ctf_tmp_string, \
778 __get_dynamic_len(dest)); \
779 }
780
781
782#undef _ctf_enum
783#define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
784 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
785
786/* Beware: this get len actually consumes the len value */
787#undef __get_dynamic_len
788#define __get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
789
790#undef TP_ARGS
791#define TP_ARGS(...) __VA_ARGS__
792
793#undef TP_FIELDS
794#define TP_FIELDS(...) __VA_ARGS__
795
796/*
797 * For state dump, check that "session" argument (mandatory) matches the
798 * session this event belongs to. Ensures that we write state dump data only
799 * into the started session, not into all sessions.
800 */
801#undef _TP_SESSION_CHECK
802#ifdef TP_SESSION_CHECK
803#define _TP_SESSION_CHECK(session, csession) (session == csession)
804#else /* TP_SESSION_CHECK */
805#define _TP_SESSION_CHECK(session, csession) 1
806#endif /* TP_SESSION_CHECK */
807
808/*
809 * Use of __builtin_return_address(0) sometimes seems to cause stack
810 * corruption on 32-bit PowerPC. Disable this feature on that
811 * architecture for now by always using the NULL value for the ip
812 * context.
813 */
814#undef _TP_IP_PARAM
815#ifdef TP_IP_PARAM
816#define _TP_IP_PARAM(x) (x)
817#else /* TP_IP_PARAM */
818
819#if defined(__PPC__) && !defined(__PPC64__)
820#define _TP_IP_PARAM(x) NULL
821#else /* #if defined(__PPC__) && !defined(__PPC64__) */
822#define _TP_IP_PARAM(x) __builtin_return_address(0)
823#endif /* #else #if defined(__PPC__) && !defined(__PPC64__) */
824
825#endif /* TP_IP_PARAM */
826
827/*
828 * Using twice size for filter stack data to hold size and pointer for
829 * each field (worse case). For integers, max size required is 64-bit.
830 * Same for double-precision floats. Those fit within
831 * 2*sizeof(unsigned long) for all supported architectures.
832 * Perform UNION (||) of filter runtime list.
833 */
834#undef _TRACEPOINT_EVENT_CLASS
835#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
836static lttng_ust_notrace \
837void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)); \
838static \
839void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)) \
840{ \
841 struct lttng_event *__event = (struct lttng_event *) __tp_data; \
842 struct lttng_channel *__chan = __event->chan; \
843 struct lttng_ust_lib_ring_buffer_ctx __ctx; \
844 struct lttng_stack_ctx __lttng_ctx; \
845 size_t __event_len, __event_align; \
846 size_t __dynamic_len_idx = 0; \
847 const size_t __num_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1; \
848 union { \
849 size_t __dynamic_len[__num_fields]; \
850 char __filter_stack_data[2 * sizeof(unsigned long) * __num_fields]; \
851 } __stackvar; \
852 int __ret; \
853 \
854 if (0) \
855 (void) __dynamic_len_idx; /* don't warn if unused */ \
856 if (!_TP_SESSION_CHECK(session, __chan->session)) \
857 return; \
858 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active))) \
859 return; \
860 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled))) \
861 return; \
862 if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
863 return; \
864 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
865 return; \
866 if (caa_unlikely(!cds_list_empty(&__event->filter_bytecode_runtime_head))) { \
867 struct lttng_bytecode_runtime *__filter_bc_runtime; \
868 int __filter_record = __event->has_enablers_without_bytecode; \
869 \
870 __event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__filter_stack_data, \
871 _TP_ARGS_DATA_VAR(_args)); \
872 tp_list_for_each_entry_rcu(__filter_bc_runtime, &__event->filter_bytecode_runtime_head, node) { \
873 if (caa_unlikely(__filter_bc_runtime->interpreter_funcs.filter(__filter_bc_runtime, \
874 __stackvar.__filter_stack_data) & LTTNG_INTERPRETER_RECORD_FLAG)) { \
875 __filter_record = 1; \
876 break; \
877 } \
878 } \
879 if (caa_likely(!__filter_record)) \
880 return; \
881 } \
882 __event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
883 _TP_ARGS_DATA_VAR(_args)); \
884 __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
885 memset(&__lttng_ctx, 0, sizeof(__lttng_ctx)); \
886 __lttng_ctx.event = __event; \
887 __lttng_ctx.chan_ctx = tp_rcu_dereference(__chan->ctx); \
888 __lttng_ctx.event_ctx = tp_rcu_dereference(__event->ctx); \
889 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
890 __event_align, -1, __chan->handle, &__lttng_ctx); \
891 __ctx.ip = _TP_IP_PARAM(TP_IP_PARAM); \
892 __ret = __chan->ops->event_reserve(&__ctx, __event->id); \
893 if (__ret < 0) \
894 return; \
895 _fields \
896 __chan->ops->event_commit(&__ctx); \
897}
898
899#include TRACEPOINT_INCLUDE
900
901#undef __get_dynamic_len
902
903/*
904 * Stage 5.1 of tracepoint event generation.
905 *
906 * Create probe signature
907 */
908
909/* Reset all macros within TRACEPOINT_EVENT */
910#include <lttng/ust-tracepoint-event-reset.h>
911
912#undef TP_ARGS
913#define TP_ARGS(...) __VA_ARGS__
914
915#define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
916
917#undef _TRACEPOINT_EVENT_CLASS
918#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
919static const char __tp_event_signature___##_provider##___##_name[] = \
920 _TP_EXTRACT_STRING2(_args);
921
922#include TRACEPOINT_INCLUDE
923
924#undef _TP_EXTRACT_STRING2
925
926/*
927 * Stage 5.2 of tracepoint event generation.
928 *
929 * Create the event notifier probe function.
930 */
931#undef _TRACEPOINT_EVENT_CLASS
932#define _TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
933static lttng_ust_notrace \
934void __event_notifier_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)); \
935static \
936void __event_notifier_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)) \
937{ \
938 struct lttng_event_notifier *__event_notifier = (struct lttng_event_notifier *) __tp_data; \
939 const size_t __num_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1;\
940 union { \
941 size_t __dynamic_len[__num_fields]; \
942 char __interpreter_stack_data[2 * sizeof(unsigned long) * __num_fields]; \
943 } __stackvar; \
944 \
945 if (caa_unlikely(!CMM_ACCESS_ONCE(__event_notifier->enabled))) \
946 return; \
947 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
948 return; \
949 if (caa_unlikely(!cds_list_empty(&__event_notifier->filter_bytecode_runtime_head))) { \
950 struct lttng_bytecode_runtime *__filter_bc_runtime; \
951 int __filter_record = __event_notifier->has_enablers_without_bytecode; \
952 \
953 __event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
954 _TP_ARGS_DATA_VAR(_args)); \
955 tp_list_for_each_entry_rcu(__filter_bc_runtime, &__event_notifier->filter_bytecode_runtime_head, node) { \
956 if (caa_unlikely(__filter_bc_runtime->interpreter_funcs.filter(__filter_bc_runtime, \
957 __stackvar.__interpreter_stack_data) & LTTNG_INTERPRETER_RECORD_FLAG)) \
958 __filter_record = 1; \
959 } \
960 if (caa_likely(!__filter_record)) \
961 return; \
962 } \
963 if (caa_unlikely(!cds_list_empty(&__event_notifier->capture_bytecode_runtime_head))) \
964 __event_prepare_interpreter_stack__##_provider##___##_name(__stackvar.__interpreter_stack_data, \
965 _TP_ARGS_DATA_VAR(_args)); \
966 \
967 __event_notifier->notification_send(__event_notifier, \
968 __stackvar.__interpreter_stack_data); \
969}
970
971#include TRACEPOINT_INCLUDE
972
973/*
974 * Stage 6 of tracepoint event generation.
975 *
976 * Tracepoint loglevel mapping definition generation. We generate a
977 * symbol for each mapping for a provider/event to ensure at most a 1 to
978 * 1 mapping between events and loglevels. If the symbol is repeated,
979 * the compiler will complain.
980 */
981
982/* Reset all macros within TRACEPOINT_EVENT */
983#include <lttng/ust-tracepoint-event-reset.h>
984
985/*
986 * Declare _loglevel___##__provider##___##__name as non-static, with
987 * hidden visibility for c++ handling of weakref. We do a weakref to the
988 * symbol in a later stage, which requires that the symbol is not
989 * mangled.
990 */
991#ifdef __cplusplus
992#define LTTNG_TP_EXTERN_C extern "C"
993#else
994#define LTTNG_TP_EXTERN_C
995#endif
996
997#undef TRACEPOINT_LOGLEVEL
998#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
999static const int _loglevel_value___##__provider##___##__name = __loglevel; \
1000LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name \
1001 __attribute__((visibility("hidden"))) = \
1002 &_loglevel_value___##__provider##___##__name;
1003
1004#include TRACEPOINT_INCLUDE
1005
1006#undef LTTNG_TP_EXTERN_C
1007
1008/*
1009 * Stage 6.1 of tracepoint event generation.
1010 *
1011 * Tracepoint UML URI info.
1012 */
1013
1014/* Reset all macros within TRACEPOINT_EVENT */
1015#include <lttng/ust-tracepoint-event-reset.h>
1016
1017/*
1018 * Declare _model_emf_uri___##__provider##___##__name as non-static,
1019 * with hidden visibility for c++ handling of weakref. We do a weakref
1020 * to the symbol in a later stage, which requires that the symbol is not
1021 * mangled.
1022 */
1023#ifdef __cplusplus
1024#define LTTNG_TP_EXTERN_C extern "C"
1025#else
1026#define LTTNG_TP_EXTERN_C
1027#endif
1028
1029#undef TRACEPOINT_MODEL_EMF_URI
1030#define TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri) \
1031LTTNG_TP_EXTERN_C const char *_model_emf_uri___##__provider##___##__name \
1032 __attribute__((visibility("hidden"))) = __uri; \
1033
1034#include TRACEPOINT_INCLUDE
1035
1036#undef LTTNG_TP_EXTERN_C
1037
1038/*
1039 * Stage 7.1 of tracepoint event generation.
1040 *
1041 * Create events description structures. We use a weakref because
1042 * loglevels are optional. If not declared, the event will point to the
1043 * a loglevel that contains NULL.
1044 */
1045
1046/* Reset all macros within TRACEPOINT_EVENT */
1047#include <lttng/ust-tracepoint-event-reset.h>
1048
1049#undef _TRACEPOINT_EVENT_INSTANCE
1050#define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
1051static const int * \
1052 __ref_loglevel___##_provider##___##_name \
1053 __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
1054static const char * \
1055 __ref_model_emf_uri___##_provider##___##_name \
1056 __attribute__((weakref ("_model_emf_uri___" #_provider "___" #_name)));\
1057static const struct lttng_event_desc __event_desc___##_provider##_##_name = { \
1058 .name = #_provider ":" #_name, \
1059 .probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
1060 .ctx = NULL, \
1061 .fields = __event_fields___##_provider##___##_template, \
1062 .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template) - 1, \
1063 .loglevel = &__ref_loglevel___##_provider##___##_name, \
1064 .signature = __tp_event_signature___##_provider##___##_template, \
1065 .u = { \
1066 .ext = { \
1067 .model_emf_uri = &__ref_model_emf_uri___##_provider##___##_name, \
1068 .event_notifier_callback = (void (*)(void)) &__event_notifier_probe__##_provider##___##_template,\
1069 }, \
1070 }, \
1071};
1072
1073#include TRACEPOINT_INCLUDE
1074
1075/*
1076 * Stage 7.2 of tracepoint event generation.
1077 *
1078 * Create array of events.
1079 */
1080
1081/* Reset all macros within TRACEPOINT_EVENT */
1082#include <lttng/ust-tracepoint-event-reset.h>
1083
1084#undef _TRACEPOINT_EVENT_INSTANCE
1085#define _TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
1086 &__event_desc___##_provider##_##_name,
1087
1088static const struct lttng_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
1089#include TRACEPOINT_INCLUDE
1090 NULL, /* Dummy, C99 forbids 0-len array. */
1091};
1092
1093
1094/*
1095 * Stage 8 of tracepoint event generation.
1096 *
1097 * Create a toplevel descriptor for the whole probe.
1098 */
1099
1100/* non-const because list head will be modified when registered. */
1101static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
1102 .provider = __tp_stringify(TRACEPOINT_PROVIDER),
1103 .event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
1104 .nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)) - 1,
1105 .head = { NULL, NULL },
1106 .lazy_init_head = { NULL, NULL },
1107 .lazy = 0,
1108 .major = LTTNG_UST_PROVIDER_MAJOR,
1109 .minor = LTTNG_UST_PROVIDER_MINOR,
1110};
1111
1112static int _TP_COMBINE_TOKENS(__probe_register_refcount___, TRACEPOINT_PROVIDER);
1113
1114/*
1115 * Stage 9 of tracepoint event generation.
1116 *
1117 * Register/unregister probes at module load/unload.
1118 *
1119 * Generate the constructor as an externally visible symbol for use when
1120 * linking the probe statically.
1121 *
1122 * Register refcount is protected by libc dynamic loader mutex.
1123 */
1124
1125/* Reset all macros within TRACEPOINT_EVENT */
1126#include <lttng/ust-tracepoint-event-reset.h>
1127static void lttng_ust_notrace __attribute__((constructor))
1128_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void);
1129static void
1130_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
1131{
1132 int ret;
1133
1134 if (_TP_COMBINE_TOKENS(__probe_register_refcount___,
1135 TRACEPOINT_PROVIDER)++) {
1136 return;
1137 }
1138 /*
1139 * __tracepoint_provider_check_ ## TRACEPOINT_PROVIDER() is a
1140 * static inline function that ensures every probe PROVIDER
1141 * argument match the provider within which they appear. It
1142 * calls empty static inline functions, and therefore has no
1143 * runtime effect. However, if it detects an error, a linker
1144 * error will appear.
1145 */
1146 _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)();
1147 ret = lttng_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
1148 if (ret) {
1149 fprintf(stderr, "LTTng-UST: Error (%d) while registering tracepoint probe.\n", ret);
1150 abort();
1151 }
1152}
1153
1154static void lttng_ust_notrace __attribute__((destructor))
1155_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void);
1156static void
1157_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
1158{
1159 if (--_TP_COMBINE_TOKENS(__probe_register_refcount___,
1160 TRACEPOINT_PROVIDER)) {
1161 return;
1162 }
1163 lttng_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
1164}
1165
1166int _TP_COMBINE_TOKENS(__tracepoint_provider_, TRACEPOINT_PROVIDER)
1167__attribute__((visibility("default")));
LTTng 2.0 Userspace Tracer
This page took 0.026212 seconds and 4 git commands to generate.