1 #include <linux/debugfs.h>
3 #include "lttng-types.h"
4 #include "../wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
5 #include "../wrapper/ringbuffer/frontend_types.h"
6 #include "../ltt-events.h"
7 #include "../ltt-tracer-core.h"
10 * Macro declarations used for all stages.
14 * DECLARE_EVENT_CLASS can be used to add a generic function
15 * handlers for events. That is, if all events have the same
16 * parameters and just have distinct trace points.
17 * Each tracepoint can be defined with DEFINE_EVENT and that
18 * will map the DECLARE_EVENT_CLASS to the tracepoint.
20 * TRACE_EVENT is a one to one mapping between tracepoint and template.
24 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
25 DECLARE_EVENT_CLASS(name, \
31 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
33 #undef DEFINE_EVENT_PRINT
34 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
35 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
37 /* Callbacks are meaningless to LTTng. */
39 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
40 assign, print, reg, unreg) \
41 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
42 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
45 * Stage 1 of the trace events.
47 * Create dummy trace calls for each events, verifying that the LTTng module
48 * TRACE_EVENT headers match the kernel arguments. Will be optimized out by the
52 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
55 #define TP_PROTO(args...) args
58 #define TP_ARGS(args...) args
61 #define DEFINE_EVENT(_template, _name, _proto, _args) \
62 void trace_##_name(_proto);
64 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
67 * Stage 2 of the trace events.
69 * Create event field type metadata section.
70 * Each event produce an array of fields.
73 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
75 /* Named field types must be defined in lttng-types.h */
78 #define __field(_type, _item) \
81 .type = __type_integer(_type, __BYTE_ORDER, 10, none),\
85 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
87 #undef __field_network
88 #define __field_network(_type, _item) \
91 .type = __type_integer(_type, __BIG_ENDIAN, 10, none),\
95 #define __array_enc(_type, _item, _length, _encoding) \
100 .atype = atype_array, \
104 .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
110 #define __array(_type, _item, _length) \
111 __array_enc(_type, _item, _length, none)
114 #define __array_text(_type, _item, _length) \
115 __array_enc(_type, _item, _length, UTF8)
117 #undef __dynamic_array_enc
118 #define __dynamic_array_enc(_type, _item, _length, _encoding) \
123 .atype = atype_sequence, \
126 .length_type = __type_integer(u32, __BYTE_ORDER, 10, none), \
127 .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
132 #undef __dynamic_array
133 #define __dynamic_array(_type, _item, _length) \
134 __dynamic_array_enc(_type, _item, _length, none)
136 #undef __dynamic_array_text
137 #define __dynamic_array_text(_type, _item, _length) \
138 __dynamic_array_enc(_type, _item, _length, UTF8)
141 #define __string(_item, _src) \
146 .atype = atype_string, \
147 .u.basic.string.encoding = lttng_encode_UTF8, \
151 #undef TP_STRUCT__entry
152 #define TP_STRUCT__entry(args...) args /* Only one used in this phase */
154 #undef DECLARE_EVENT_CLASS
155 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
156 static const struct lttng_event_field __event_fields___##_name[] = { \
160 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
162 #undef __type_integer
165 * Stage 3 of the trace events.
167 * Create probe callback prototypes.
170 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
173 #define TP_PROTO(args...) args
175 #undef DECLARE_EVENT_CLASS
176 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
177 static void __event_probe__##_name(void *__data, _proto);
179 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
182 * Stage 4 of the trace events.
184 * Create an array of events.
187 /* Named field types must be defined in lttng-types.h */
189 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
192 #define DEFINE_EVENT(_template, _name, _proto, _args) \
194 .fields = __event_fields___##_template, \
196 .probe_callback = (void *) &__event_probe__##_template,\
197 .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
200 #define TP_ID1(_token, _system) _token##_system
201 #define TP_ID(_token, _system) TP_ID1(_token, _system)
203 static const struct lttng_event_desc
TP_ID(__event_desc___
, TRACE_SYSTEM
)[] = {
204 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
212 * Stage 5 of the trace events.
214 * Create a toplevel descriptor for the whole probe.
217 #define TP_ID1(_token, _system) _token##_system
218 #define TP_ID(_token, _system) TP_ID1(_token, _system)
220 /* non-const because list head will be modified when registered. */
221 static struct lttng_probe_desc
TP_ID(__probe_desc___
, TRACE_SYSTEM
) = {
222 .event_desc
= TP_ID(__event_desc___
, TRACE_SYSTEM
),
223 .nr_events
= ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)),
230 * Stage 6 of the trace events.
232 * Create static inline function that calculates event size.
235 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
237 /* Named field types must be defined in lttng-types.h */
240 #define __field(_type, _item) \
241 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
242 __event_len += sizeof(_type);
245 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
248 #define __array(_type, _item, _length) \
249 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
250 __event_len += sizeof(_type) * (_length);
253 #define __array_text(_type, _item, _length) \
254 __array(_type, _item, _length)
256 #undef __dynamic_array
257 #define __dynamic_array(_type, _item, _length) \
258 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(u32)); \
259 __event_len += sizeof(u32); \
260 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
261 __event_len += sizeof(_type) * (_length);
263 #undef __dynamic_array_text
264 #define __dynamic_array_text(_type, _item, _length) \
265 __dynamic_array(_type, _item, _length)
268 #define __string(_item, _src) \
269 __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
272 #define TP_PROTO(args...) args
274 #undef TP_STRUCT__entry
275 #define TP_STRUCT__entry(args...) args
277 #undef DECLARE_EVENT_CLASS
278 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
279 static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
281 size_t __event_len = 0; \
282 unsigned int __dynamic_len_idx = 0; \
285 (void) __dynamic_len_idx; /* don't warn if unused */ \
287 return __event_len; \
290 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
293 * Stage 7 of the trace events.
295 * Create static inline function that calculates event payload alignment.
298 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
300 /* Named field types must be defined in lttng-types.h */
303 #define __field(_type, _item) \
304 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
307 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
310 #define __array(_type, _item, _length) \
311 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
314 #define __array_text(_type, _item, _length) \
315 __array(_type, _item, _length)
317 #undef __dynamic_array
318 #define __dynamic_array(_type, _item, _length) \
319 __event_align = max_t(size_t, __event_align, ltt_alignof(u32)); \
320 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
322 #undef __dynamic_array_text
323 #define __dynamic_array_text(_type, _item, _length) \
324 __dynamic_array(_type, _item, _length)
327 #define __string(_item, _src)
330 #define TP_PROTO(args...) args
332 #undef TP_STRUCT__entry
333 #define TP_STRUCT__entry(args...) args
335 #undef DECLARE_EVENT_CLASS
336 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
337 static inline size_t __event_get_align__##_name(_proto) \
339 size_t __event_align = 1; \
341 return __event_align; \
344 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
348 * Stage 8 of the trace events.
350 * Create structure declaration that allows the "assign" macros to access the
354 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
356 /* Named field types must be defined in lttng-types.h */
359 #define __field(_type, _item) _type _item;
362 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
365 #define __array(_type, _item, _length) _type _item;
368 #define __array_text(_type, _item, _length) \
369 __array(_type, _item, _length)
371 #undef __dynamic_array
372 #define __dynamic_array(_type, _item, _length) _type _item;
374 #undef __dynamic_array_text
375 #define __dynamic_array_text(_type, _item, _length) \
376 __dynamic_array(_type, _item, _length)
379 #define __string(_item, _src) char _item;
381 #undef TP_STRUCT__entry
382 #define TP_STRUCT__entry(args...) args
384 #undef DECLARE_EVENT_CLASS
385 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
386 struct __event_typemap__##_name { \
390 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
394 * Stage 9 of the trace events.
396 * Create the probe function : call even size calculation and write event data
399 * We use both the field and assignment macros to write the fields in the order
400 * defined in the field declaration. The field declarations control the
401 * execution order, jumping to the appropriate assignment block.
404 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
407 #define __field(_type, _item) \
408 goto __assign_##_item; \
412 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
415 #define __array(_type, _item, _length) \
416 goto __assign_##_item; \
420 #define __array_text(_type, _item, _length) \
421 __array(_type, _item, _length)
423 #undef __dynamic_array
424 #define __dynamic_array(_type, _item, _length) \
425 goto __assign_##_item##_1; \
426 __end_field_##_item##_1: \
427 goto __assign_##_item##_2; \
428 __end_field_##_item##_2:
430 #undef __dynamic_array_text
431 #define __dynamic_array_text(_type, _item, _length) \
432 __dynamic_array(_type, _item, _length)
435 #define __string(_item, _src) \
436 goto __assign_##_item; \
440 * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
444 #define tp_assign(dest, src) \
447 __typeof__(__typemap.dest) __tmp = (src); \
448 lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__tmp)); \
449 __chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp)); \
451 goto __end_field_##dest;
454 #define tp_memcpy(dest, src, len) \
457 (void) __typemap.dest; \
458 lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest)); \
459 __chan->ops->event_write(&ctx, src, len); \
460 goto __end_field_##dest;
463 #define tp_memcpy_dyn(dest, src, len) \
464 __assign_##dest##_1: \
466 u32 __tmpl = (len); \
467 lib_ring_buffer_align_ctx(&ctx, ltt_alignof(u32)); \
468 __chan->ops->event_write(&ctx, &__tmpl, sizeof(u32)); \
470 goto __end_field_##dest##_1; \
471 __assign_##dest##_2: \
472 lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest)); \
473 __chan->ops->event_write(&ctx, src, len); \
474 goto __end_field_##dest##_2;
477 #define tp_strcpy(dest, src) \
478 tp_memcpy(dest, src, __get_dynamic_array_len(dest))
480 /* Named field types must be defined in lttng-types.h */
483 #define __get_str(field) field
485 #undef __get_dynamic_array
486 #define __get_dynamic_array(field) field
488 /* Beware: this get len actually consumes the len value */
489 #undef __get_dynamic_array_len
490 #define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
493 #define TP_PROTO(args...) args
496 #define TP_ARGS(args...) args
498 #undef TP_STRUCT__entry
499 #define TP_STRUCT__entry(args...) args
501 #undef TP_fast_assign
502 #define TP_fast_assign(args...) args
504 #undef DECLARE_EVENT_CLASS
505 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
506 static void __event_probe__##_name(void *__data, _proto) \
508 struct ltt_event *__event = __data; \
509 struct ltt_channel *__chan = __event->chan; \
510 struct lib_ring_buffer_ctx ctx; \
511 size_t __event_len, __event_align; \
512 size_t __dynamic_len_idx = 0; \
513 size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)]; \
514 struct __event_typemap__##_name __typemap; \
518 (void) __dynamic_len_idx; /* don't warn if unused */ \
519 if (!ACCESS_ONCE(__chan->session->active)) \
521 __event_len = __event_get_size__##_name(__dynamic_len, _args); \
522 __event_align = __event_get_align__##_name(_args); \
523 lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len, \
524 __event_align, -1); \
525 __ret = __chan->ops->event_reserve(&ctx, __event->id); \
528 /* Control code (field ordering) */ \
530 __chan->ops->event_commit(&ctx); \
532 /* Copy code, steered by control code */ \
536 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
539 * Stage 10 of the trace events.
541 * Register/unregister probes at module load/unload.
544 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
546 #define TP_ID1(_token, _system) _token##_system
547 #define TP_ID(_token, _system) TP_ID1(_token, _system)
548 #define module_init_eval1(_token, _system) module_init(_token##_system)
549 #define module_init_eval(_token, _system) module_init_eval1(_token, _system)
550 #define module_exit_eval1(_token, _system) module_exit(_token##_system)
551 #define module_exit_eval(_token, _system) module_exit_eval1(_token, _system)
553 static int TP_ID(__lttng_events_init__
, TRACE_SYSTEM
)(void)
555 wrapper_vmalloc_sync_all();
556 return ltt_probe_register(&TP_ID(__probe_desc___
, TRACE_SYSTEM
));
559 module_init_eval(__lttng_events_init__
, TRACE_SYSTEM
);
561 static void TP_ID(__lttng_events_exit__
, TRACE_SYSTEM
)(void)
563 ltt_probe_unregister(&TP_ID(__probe_desc___
, TRACE_SYSTEM
));
566 module_exit_eval(__lttng_events_exit__
, TRACE_SYSTEM
);
568 #undef module_init_eval
569 #undef module_exit_eval
This page took 0.043764 seconds and 4 git commands to generate.