projects / lttng-ust.git / blob
? search:


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