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


380593b04d3fa8c1f6ade28056bbdb17fb8fedd6
[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 },
241
242 #undef _ctf_float
243 #define _ctf_float(_type, _item, _src, _nowrite) \
244 { \
245 .name = #_item, \
246 .type = __type_float(_type), \
247 .nowrite = _nowrite, \
248 },
249
250 #undef _ctf_array_encoded
251 #define _ctf_array_encoded(_type, _item, _src, _byte_order, \
252 _length, _encoding, _nowrite, \
253 _elem_type_base) \
254 { \
255 .name = #_item, \
256 .type = \
257 { \
258 .atype = atype_array, \
259 .u = \
260 { \
261 .array = \
262 { \
263 .elem_type = __type_integer(_type, _byte_order, _elem_type_base, _encoding), \
264 .length = _length, \
265 } \
266 } \
267 }, \
268 .nowrite = _nowrite, \
269 },
270
271 #undef _ctf_sequence_encoded
272 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, \
273 _length_type, _src_length, _encoding, _nowrite, \
274 _elem_type_base) \
275 { \
276 .name = #_item, \
277 .type = \
278 { \
279 .atype = atype_sequence, \
280 .u = \
281 { \
282 .sequence = \
283 { \
284 .length_type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
285 .elem_type = __type_integer(_type, _byte_order, _elem_type_base, _encoding), \
286 }, \
287 }, \
288 }, \
289 .nowrite = _nowrite, \
290 },
291
292 #undef _ctf_string
293 #define _ctf_string(_item, _src, _nowrite) \
294 { \
295 .name = #_item, \
296 .type = \
297 { \
298 .atype = atype_string, \
299 .u = \
300 { \
301 .basic = { .string = { .encoding = lttng_encode_UTF8 } } \
302 }, \
303 }, \
304 .nowrite = _nowrite, \
305 },
306
307 #undef _ctf_enum
308 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
309 { \
310 .name = #_item, \
311 .type = { \
312 .atype = atype_enum, \
313 .u = { \
314 .basic = { \
315 .enumeration = { \
316 .desc = &__enum_##_provider##_##_name, \
317 .container_type = { \
318 .size = sizeof(_type) * CHAR_BIT, \
319 .alignment = lttng_alignof(_type) * CHAR_BIT, \
320 .signedness = lttng_is_signed_type(_type), \
321 .reverse_byte_order = 0, \
322 .base = 10, \
323 .encoding = lttng_encode_none, \
324 }, \
325 }, \
326 }, \
327 }, \
328 }, \
329 .nowrite = _nowrite, \
330 },
331
332 #undef TP_FIELDS
333 #define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
334
335 #undef TRACEPOINT_EVENT_CLASS
336 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
337 static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
338 _fields \
339 ctf_integer(int, dummy, 0) /* Dummy, C99 forbids 0-len array. */ \
340 };
341
342 #undef TRACEPOINT_ENUM
343 #define TRACEPOINT_ENUM(_provider, _name, _values) \
344 static const struct lttng_enum_desc __enum_##_provider##_##_name = { \
345 .name = #_provider "_" #_name, \
346 .entries = __enum_values__##_provider##_##_name, \
347 .nr_entries = _TP_ARRAY_SIZE(__enum_values__##_provider##_##_name) - 1, \
348 };
349
350 #include TRACEPOINT_INCLUDE
351
352 /*
353 * Stage 2 of tracepoint event generation.
354 *
355 * Create probe callback prototypes.
356 */
357
358 /* Reset all macros within TRACEPOINT_EVENT */
359 #include <lttng/ust-tracepoint-event-reset.h>
360
361 #undef TP_ARGS
362 #define TP_ARGS(...) __VA_ARGS__
363
364 #undef TRACEPOINT_EVENT_CLASS
365 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
366 static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
367
368 #include TRACEPOINT_INCLUDE
369
370 /*
371 * Stage 3.0 of tracepoint event generation.
372 *
373 * Create static inline function that calculates event size.
374 */
375
376 /* Reset all macros within TRACEPOINT_EVENT */
377 #include <lttng/ust-tracepoint-event-reset.h>
378 #include <lttng/ust-tracepoint-event-write.h>
379
380 #undef _ctf_integer_ext
381 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
382 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
383 __event_len += sizeof(_type);
384
385 #undef _ctf_float
386 #define _ctf_float(_type, _item, _src, _nowrite) \
387 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
388 __event_len += sizeof(_type);
389
390 #undef _ctf_array_encoded
391 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, _encoding, \
392 _nowrite, _elem_type_base) \
393 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
394 __event_len += sizeof(_type) * (_length);
395
396 #undef _ctf_sequence_encoded
397 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
398 _src_length, _encoding, _nowrite, _elem_type_base) \
399 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type)); \
400 __event_len += sizeof(_length_type); \
401 __event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
402 __dynamic_len[__dynamic_len_idx] = (_src_length); \
403 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
404 __dynamic_len_idx++;
405
406 #undef _ctf_string
407 #define _ctf_string(_item, _src, _nowrite) \
408 __event_len += __dynamic_len[__dynamic_len_idx++] = \
409 strlen((_src) ? (_src) : __LTTNG_UST_NULL_STRING) + 1;
410
411 #undef _ctf_enum
412 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
413 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
414
415 #undef TP_ARGS
416 #define TP_ARGS(...) __VA_ARGS__
417
418 #undef TP_FIELDS
419 #define TP_FIELDS(...) __VA_ARGS__
420
421 #undef TRACEPOINT_EVENT_CLASS
422 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
423 static inline lttng_ust_notrace \
424 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)); \
425 static inline \
426 size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
427 { \
428 size_t __event_len = 0; \
429 unsigned int __dynamic_len_idx = 0; \
430 \
431 if (0) \
432 (void) __dynamic_len_idx; /* don't warn if unused */ \
433 _fields \
434 return __event_len; \
435 }
436
437 #include TRACEPOINT_INCLUDE
438
439 /*
440 * Stage 3.1 of tracepoint event generation.
441 *
442 * Create static inline function that layout the filter stack data.
443 * We make both write and nowrite data available to the filter.
444 */
445
446 /* Reset all macros within TRACEPOINT_EVENT */
447 #include <lttng/ust-tracepoint-event-reset.h>
448 #include <lttng/ust-tracepoint-event-write.h>
449 #include <lttng/ust-tracepoint-event-nowrite.h>
450
451 #undef _ctf_integer_ext
452 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
453 if (lttng_is_signed_type(_type)) { \
454 int64_t __ctf_tmp_int64; \
455 switch (sizeof(_type)) { \
456 case 1: \
457 { \
458 union { _type t; int8_t v; } __tmp = { (_type) (_src) }; \
459 __ctf_tmp_int64 = (int64_t) __tmp.v; \
460 break; \
461 } \
462 case 2: \
463 { \
464 union { _type t; int16_t v; } __tmp = { (_type) (_src) }; \
465 if (_byte_order != BYTE_ORDER) \
466 __tmp.v = bswap_16(__tmp.v); \
467 __ctf_tmp_int64 = (int64_t) __tmp.v; \
468 break; \
469 } \
470 case 4: \
471 { \
472 union { _type t; int32_t v; } __tmp = { (_type) (_src) }; \
473 if (_byte_order != BYTE_ORDER) \
474 __tmp.v = bswap_32(__tmp.v); \
475 __ctf_tmp_int64 = (int64_t) __tmp.v; \
476 break; \
477 } \
478 case 8: \
479 { \
480 union { _type t; int64_t v; } __tmp = { (_type) (_src) }; \
481 if (_byte_order != BYTE_ORDER) \
482 __tmp.v = bswap_64(__tmp.v); \
483 __ctf_tmp_int64 = (int64_t) __tmp.v; \
484 break; \
485 } \
486 default: \
487 abort(); \
488 }; \
489 memcpy(__stack_data, &__ctf_tmp_int64, sizeof(int64_t)); \
490 } else { \
491 uint64_t __ctf_tmp_uint64; \
492 switch (sizeof(_type)) { \
493 case 1: \
494 { \
495 union { _type t; uint8_t v; } __tmp = { (_type) (_src) }; \
496 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
497 break; \
498 } \
499 case 2: \
500 { \
501 union { _type t; uint16_t v; } __tmp = { (_type) (_src) }; \
502 if (_byte_order != BYTE_ORDER) \
503 __tmp.v = bswap_16(__tmp.v); \
504 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
505 break; \
506 } \
507 case 4: \
508 { \
509 union { _type t; uint32_t v; } __tmp = { (_type) (_src) }; \
510 if (_byte_order != BYTE_ORDER) \
511 __tmp.v = bswap_32(__tmp.v); \
512 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
513 break; \
514 } \
515 case 8: \
516 { \
517 union { _type t; uint64_t v; } __tmp = { (_type) (_src) }; \
518 if (_byte_order != BYTE_ORDER) \
519 __tmp.v = bswap_64(__tmp.v); \
520 __ctf_tmp_uint64 = (uint64_t) __tmp.v; \
521 break; \
522 } \
523 default: \
524 abort(); \
525 }; \
526 memcpy(__stack_data, &__ctf_tmp_uint64, sizeof(uint64_t)); \
527 } \
528 __stack_data += sizeof(int64_t);
529
530 #undef _ctf_float
531 #define _ctf_float(_type, _item, _src, _nowrite) \
532 { \
533 double __ctf_tmp_double = (double) (_type) (_src); \
534 memcpy(__stack_data, &__ctf_tmp_double, sizeof(double)); \
535 __stack_data += sizeof(double); \
536 }
537
538 #undef _ctf_array_encoded
539 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
540 _encoding, _nowrite, _elem_type_base) \
541 { \
542 unsigned long __ctf_tmp_ulong = (unsigned long) (_length); \
543 const void *__ctf_tmp_ptr = (_src); \
544 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
545 __stack_data += sizeof(unsigned long); \
546 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
547 __stack_data += sizeof(void *); \
548 }
549
550 #undef _ctf_sequence_encoded
551 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
552 _src_length, _encoding, _nowrite, _elem_type_base) \
553 { \
554 unsigned long __ctf_tmp_ulong = (unsigned long) (_src_length); \
555 const void *__ctf_tmp_ptr = (_src); \
556 memcpy(__stack_data, &__ctf_tmp_ulong, sizeof(unsigned long)); \
557 __stack_data += sizeof(unsigned long); \
558 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
559 __stack_data += sizeof(void *); \
560 }
561
562 #undef _ctf_string
563 #define _ctf_string(_item, _src, _nowrite) \
564 { \
565 const void *__ctf_tmp_ptr = \
566 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
567 memcpy(__stack_data, &__ctf_tmp_ptr, sizeof(void *)); \
568 __stack_data += sizeof(void *); \
569 }
570
571 #undef _ctf_enum
572 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
573 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
574
575 #undef TP_ARGS
576 #define TP_ARGS(...) __VA_ARGS__
577
578 #undef TP_FIELDS
579 #define TP_FIELDS(...) __VA_ARGS__
580
581 #undef TRACEPOINT_EVENT_CLASS
582 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
583 static inline \
584 void __event_prepare_filter_stack__##_provider##___##_name(char *__stack_data,\
585 _TP_ARGS_DATA_PROTO(_args)) \
586 { \
587 _fields \
588 }
589
590 #include TRACEPOINT_INCLUDE
591
592 /*
593 * Stage 4 of tracepoint event generation.
594 *
595 * Create static inline function that calculates event payload alignment.
596 */
597
598 /* Reset all macros within TRACEPOINT_EVENT */
599 #include <lttng/ust-tracepoint-event-reset.h>
600 #include <lttng/ust-tracepoint-event-write.h>
601
602 #undef _ctf_integer_ext
603 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
604 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
605
606 #undef _ctf_float
607 #define _ctf_float(_type, _item, _src, _nowrite) \
608 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
609
610 #undef _ctf_array_encoded
611 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
612 _encoding, _nowrite, _elem_type_base) \
613 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
614
615 #undef _ctf_sequence_encoded
616 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
617 _src_length, _encoding, _nowrite, _elem_type_base) \
618 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type)); \
619 __event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
620
621 #undef _ctf_string
622 #define _ctf_string(_item, _src, _nowrite)
623
624 #undef _ctf_enum
625 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
626 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
627
628 #undef TP_ARGS
629 #define TP_ARGS(...) __VA_ARGS__
630
631 #undef TP_FIELDS
632 #define TP_FIELDS(...) __VA_ARGS__
633
634 #undef TRACEPOINT_EVENT_CLASS
635 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
636 static inline lttng_ust_notrace \
637 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)); \
638 static inline \
639 size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)) \
640 { \
641 size_t __event_align = 1; \
642 _fields \
643 return __event_align; \
644 }
645
646 #include TRACEPOINT_INCLUDE
647
648
649 /*
650 * Stage 5 of tracepoint event generation.
651 *
652 * Create the probe function. This function calls event size calculation
653 * and writes event data into the buffer.
654 */
655
656 /* Reset all macros within TRACEPOINT_EVENT */
657 #include <lttng/ust-tracepoint-event-reset.h>
658 #include <lttng/ust-tracepoint-event-write.h>
659
660 #undef _ctf_integer_ext
661 #define _ctf_integer_ext(_type, _item, _src, _byte_order, _base, _nowrite) \
662 { \
663 _type __tmp = (_src); \
664 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
665 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
666 }
667
668 #undef _ctf_float
669 #define _ctf_float(_type, _item, _src, _nowrite) \
670 { \
671 _type __tmp = (_src); \
672 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
673 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
674 }
675
676 #undef _ctf_array_encoded
677 #define _ctf_array_encoded(_type, _item, _src, _byte_order, _length, \
678 _encoding, _nowrite, _elem_type_base) \
679 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
680 __chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));
681
682 #undef _ctf_sequence_encoded
683 #define _ctf_sequence_encoded(_type, _item, _src, _byte_order, _length_type, \
684 _src_length, _encoding, _nowrite, _elem_type_base) \
685 { \
686 _length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
687 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
688 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
689 } \
690 lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
691 __chan->ops->event_write(&__ctx, _src, \
692 sizeof(_type) * __get_dynamic_len(dest));
693
694 /*
695 * __chan->ops->u.has_strcpy is a flag letting us know if the LTTng-UST
696 * tracepoint provider ABI implements event_strcpy. This dynamic check
697 * can be removed when the tracepoint provider ABI moves to 2.
698 */
699 #if (LTTNG_UST_PROVIDER_MAJOR > 1)
700 #error "Tracepoint probe provider major version has changed. Please remove dynamic check for has_strcpy."
701 #endif
702
703 #undef _ctf_string
704 #define _ctf_string(_item, _src, _nowrite) \
705 { \
706 const char *__ctf_tmp_string = \
707 ((_src) ? (_src) : __LTTNG_UST_NULL_STRING); \
708 lib_ring_buffer_align_ctx(&__ctx, \
709 lttng_alignof(*__ctf_tmp_string)); \
710 if (__chan->ops->u.has_strcpy) \
711 __chan->ops->event_strcpy(&__ctx, __ctf_tmp_string, \
712 __get_dynamic_len(dest)); \
713 else \
714 __chan->ops->event_write(&__ctx, __ctf_tmp_string, \
715 __get_dynamic_len(dest)); \
716 }
717
718
719 #undef _ctf_enum
720 #define _ctf_enum(_provider, _name, _type, _item, _src, _nowrite) \
721 _ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10, _nowrite)
722
723 /* Beware: this get len actually consumes the len value */
724 #undef __get_dynamic_len
725 #define __get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
726
727 #undef TP_ARGS
728 #define TP_ARGS(...) __VA_ARGS__
729
730 #undef TP_FIELDS
731 #define TP_FIELDS(...) __VA_ARGS__
732
733 /*
734 * For state dump, check that "session" argument (mandatory) matches the
735 * session this event belongs to. Ensures that we write state dump data only
736 * into the started session, not into all sessions.
737 */
738 #undef _TP_SESSION_CHECK
739 #ifdef TP_SESSION_CHECK
740 #define _TP_SESSION_CHECK(session, csession) (session == csession)
741 #else /* TP_SESSION_CHECK */
742 #define _TP_SESSION_CHECK(session, csession) 1
743 #endif /* TP_SESSION_CHECK */
744
745 /*
746 * Use of __builtin_return_address(0) sometimes seems to cause stack
747 * corruption on 32-bit PowerPC. Disable this feature on that
748 * architecture for now by always using the NULL value for the ip
749 * context.
750 */
751 #undef _TP_IP_PARAM
752 #ifdef TP_IP_PARAM
753 #define _TP_IP_PARAM(x) (x)
754 #else /* TP_IP_PARAM */
755
756 #if defined(__PPC__) && !defined(__PPC64__)
757 #define _TP_IP_PARAM(x) NULL
758 #else /* #if defined(__PPC__) && !defined(__PPC64__) */
759 #define _TP_IP_PARAM(x) __builtin_return_address(0)
760 #endif /* #else #if defined(__PPC__) && !defined(__PPC64__) */
761
762 #endif /* TP_IP_PARAM */
763
764 /*
765 * Using twice size for filter stack data to hold size and pointer for
766 * each field (worse case). For integers, max size required is 64-bit.
767 * Same for double-precision floats. Those fit within
768 * 2*sizeof(unsigned long) for all supported architectures.
769 * Perform UNION (||) of filter runtime list.
770 */
771 #undef TRACEPOINT_EVENT_CLASS
772 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
773 static lttng_ust_notrace \
774 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)); \
775 static \
776 void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args)) \
777 { \
778 struct lttng_event *__event = (struct lttng_event *) __tp_data; \
779 struct lttng_channel *__chan = __event->chan; \
780 struct lttng_ust_lib_ring_buffer_ctx __ctx; \
781 struct lttng_stack_ctx __lttng_ctx; \
782 size_t __event_len, __event_align; \
783 size_t __dynamic_len_idx = 0; \
784 const size_t __num_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_name) - 1; \
785 union { \
786 size_t __dynamic_len[__num_fields]; \
787 char __filter_stack_data[2 * sizeof(unsigned long) * __num_fields]; \
788 } __stackvar; \
789 int __ret; \
790 \
791 if (0) \
792 (void) __dynamic_len_idx; /* don't warn if unused */ \
793 if (!_TP_SESSION_CHECK(session, __chan->session)) \
794 return; \
795 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active))) \
796 return; \
797 if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled))) \
798 return; \
799 if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
800 return; \
801 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
802 return; \
803 if (caa_unlikely(!cds_list_empty(&__event->bytecode_runtime_head))) { \
804 struct lttng_bytecode_runtime *bc_runtime; \
805 int __filter_record = __event->has_enablers_without_bytecode; \
806 \
807 __event_prepare_filter_stack__##_provider##___##_name(__stackvar.__filter_stack_data, \
808 _TP_ARGS_DATA_VAR(_args)); \
809 tp_list_for_each_entry_rcu(bc_runtime, &__event->bytecode_runtime_head, node) { \
810 if (caa_unlikely(bc_runtime->filter(bc_runtime, \
811 __stackvar.__filter_stack_data) & LTTNG_FILTER_RECORD_FLAG)) { \
812 __filter_record = 1; \
813 break; \
814 } \
815 } \
816 if (caa_likely(!__filter_record)) \
817 return; \
818 } \
819 __event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len, \
820 _TP_ARGS_DATA_VAR(_args)); \
821 __event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
822 memset(&__lttng_ctx, 0, sizeof(__lttng_ctx)); \
823 __lttng_ctx.event = __event; \
824 __lttng_ctx.chan_ctx = tp_rcu_dereference_bp(__chan->ctx); \
825 __lttng_ctx.event_ctx = tp_rcu_dereference_bp(__event->ctx); \
826 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
827 __event_align, -1, __chan->handle, &__lttng_ctx); \
828 __ctx.ip = _TP_IP_PARAM(TP_IP_PARAM); \
829 __ret = __chan->ops->event_reserve(&__ctx, __event->id); \
830 if (__ret < 0) \
831 return; \
832 _fields \
833 __chan->ops->event_commit(&__ctx); \
834 }
835
836 #include TRACEPOINT_INCLUDE
837
838 #undef __get_dynamic_len
839
840 /*
841 * Stage 5.1 of tracepoint event generation.
842 *
843 * Create probe signature
844 */
845
846 /* Reset all macros within TRACEPOINT_EVENT */
847 #include <lttng/ust-tracepoint-event-reset.h>
848
849 #undef TP_ARGS
850 #define TP_ARGS(...) __VA_ARGS__
851
852 #define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
853
854 #undef TRACEPOINT_EVENT_CLASS
855 #define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
856 static const char __tp_event_signature___##_provider##___##_name[] = \
857 _TP_EXTRACT_STRING2(_args);
858
859 #include TRACEPOINT_INCLUDE
860
861 #undef _TP_EXTRACT_STRING2
862
863 /*
864 * Stage 6 of tracepoint event generation.
865 *
866 * Tracepoint loglevel mapping definition generation. We generate a
867 * symbol for each mapping for a provider/event to ensure at most a 1 to
868 * 1 mapping between events and loglevels. If the symbol is repeated,
869 * the compiler will complain.
870 */
871
872 /* Reset all macros within TRACEPOINT_EVENT */
873 #include <lttng/ust-tracepoint-event-reset.h>
874
875 /*
876 * Declare _loglevel___##__provider##___##__name as non-static, with
877 * hidden visibility for c++ handling of weakref. We do a weakref to the
878 * symbol in a later stage, which requires that the symbol is not
879 * mangled.
880 */
881 #ifdef __cplusplus
882 #define LTTNG_TP_EXTERN_C extern "C"
883 #else
884 #define LTTNG_TP_EXTERN_C
885 #endif
886
887 #undef TRACEPOINT_LOGLEVEL
888 #define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
889 static const int _loglevel_value___##__provider##___##__name = __loglevel; \
890 LTTNG_TP_EXTERN_C const int *_loglevel___##__provider##___##__name \
891 __attribute__((visibility("hidden"))) = \
892 &_loglevel_value___##__provider##___##__name;
893
894 #include TRACEPOINT_INCLUDE
895
896 #undef LTTNG_TP_EXTERN_C
897
898 /*
899 * Stage 6.1 of tracepoint event generation.
900 *
901 * Tracepoint UML URI info.
902 */
903
904 /* Reset all macros within TRACEPOINT_EVENT */
905 #include <lttng/ust-tracepoint-event-reset.h>
906
907 /*
908 * Declare _model_emf_uri___##__provider##___##__name as non-static,
909 * with hidden visibility for c++ handling of weakref. We do a weakref
910 * to the symbol in a later stage, which requires that the symbol is not
911 * mangled.
912 */
913 #ifdef __cplusplus
914 #define LTTNG_TP_EXTERN_C extern "C"
915 #else
916 #define LTTNG_TP_EXTERN_C
917 #endif
918
919 #undef TRACEPOINT_MODEL_EMF_URI
920 #define TRACEPOINT_MODEL_EMF_URI(__provider, __name, __uri) \
921 LTTNG_TP_EXTERN_C const char *_model_emf_uri___##__provider##___##__name \
922 __attribute__((visibility("hidden"))) = __uri; \
923
924 #include TRACEPOINT_INCLUDE
925
926 #undef LTTNG_TP_EXTERN_C
927
928 /*
929 * Stage 7.1 of tracepoint event generation.
930 *
931 * Create events description structures. We use a weakref because
932 * loglevels are optional. If not declared, the event will point to the
933 * a loglevel that contains NULL.
934 */
935
936 /* Reset all macros within TRACEPOINT_EVENT */
937 #include <lttng/ust-tracepoint-event-reset.h>
938
939 #undef TRACEPOINT_EVENT_INSTANCE
940 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
941 static const int * \
942 __ref_loglevel___##_provider##___##_name \
943 __attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
944 static const char * \
945 __ref_model_emf_uri___##_provider##___##_name \
946 __attribute__((weakref ("_model_emf_uri___" #_provider "___" #_name)));\
947 static const struct lttng_event_desc __event_desc___##_provider##_##_name = { \
948 .name = #_provider ":" #_name, \
949 .probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
950 .ctx = NULL, \
951 .fields = __event_fields___##_provider##___##_template, \
952 .nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template) - 1, \
953 .loglevel = &__ref_loglevel___##_provider##___##_name, \
954 .signature = __tp_event_signature___##_provider##___##_template, \
955 .u = { \
956 .ext = { \
957 .model_emf_uri = &__ref_model_emf_uri___##_provider##___##_name, \
958 }, \
959 }, \
960 };
961
962 #include TRACEPOINT_INCLUDE
963
964 /*
965 * Stage 7.2 of tracepoint event generation.
966 *
967 * Create array of events.
968 */
969
970 /* Reset all macros within TRACEPOINT_EVENT */
971 #include <lttng/ust-tracepoint-event-reset.h>
972
973 #undef TRACEPOINT_EVENT_INSTANCE
974 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
975 &__event_desc___##_provider##_##_name,
976
977 static const struct lttng_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
978 #include TRACEPOINT_INCLUDE
979 NULL, /* Dummy, C99 forbids 0-len array. */
980 };
981
982
983 /*
984 * Stage 8 of tracepoint event generation.
985 *
986 * Create a toplevel descriptor for the whole probe.
987 */
988
989 /* non-const because list head will be modified when registered. */
990 static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
991 .provider = __tp_stringify(TRACEPOINT_PROVIDER),
992 .event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
993 .nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)) - 1,
994 .head = { NULL, NULL },
995 .lazy_init_head = { NULL, NULL },
996 .lazy = 0,
997 .major = LTTNG_UST_PROVIDER_MAJOR,
998 .minor = LTTNG_UST_PROVIDER_MINOR,
999 };
1000
1001 static int _TP_COMBINE_TOKENS(__probe_register_refcount___, TRACEPOINT_PROVIDER);
1002
1003 /*
1004 * Stage 9 of tracepoint event generation.
1005 *
1006 * Register/unregister probes at module load/unload.
1007 *
1008 * Generate the constructor as an externally visible symbol for use when
1009 * linking the probe statically.
1010 *
1011 * Register refcount is protected by libc dynamic loader mutex.
1012 */
1013
1014 /* Reset all macros within TRACEPOINT_EVENT */
1015 #include <lttng/ust-tracepoint-event-reset.h>
1016 static void lttng_ust_notrace __attribute__((constructor))
1017 _TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void);
1018 static void
1019 _TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
1020 {
1021 int ret;
1022
1023 if (_TP_COMBINE_TOKENS(__probe_register_refcount___,
1024 TRACEPOINT_PROVIDER)++) {
1025 return;
1026 }
1027 /*
1028 * __tracepoint_provider_check_ ## TRACEPOINT_PROVIDER() is a
1029 * static inline function that ensures every probe PROVIDER
1030 * argument match the provider within which they appear. It
1031 * calls empty static inline functions, and therefore has no
1032 * runtime effect. However, if it detects an error, a linker
1033 * error will appear.
1034 */
1035 _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)();
1036 ret = lttng_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
1037 if (ret) {
1038 fprintf(stderr, "LTTng-UST: Error (%d) while registering tracepoint probe.\n", ret);
1039 abort();
1040 }
1041 }
1042
1043 static void lttng_ust_notrace __attribute__((destructor))
1044 _TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void);
1045 static void
1046 _TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
1047 {
1048 if (--_TP_COMBINE_TOKENS(__probe_register_refcount___,
1049 TRACEPOINT_PROVIDER)) {
1050 return;
1051 }
1052 lttng_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
1053 }
1054
1055 int _TP_COMBINE_TOKENS(__tracepoint_provider_, TRACEPOINT_PROVIDER);
LTTng 2.0 Userspace Tracer
This page took 0.049098 seconds and 3 git commands to generate.