4 * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
5 * Copyright (C) 2010-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Dual LGPL v2.1/GPL v2 license.
10 #include <linux/debugfs.h>
12 #include "lttng-types.h"
13 #include "../wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
14 #include "../wrapper/ringbuffer/frontend_types.h"
15 #include "../ltt-events.h"
16 #include "../ltt-tracer-core.h"
19 * Macro declarations used for all stages.
23 * DECLARE_EVENT_CLASS can be used to add a generic function
24 * handlers for events. That is, if all events have the same
25 * parameters and just have distinct trace points.
26 * Each tracepoint can be defined with DEFINE_EVENT and that
27 * will map the DECLARE_EVENT_CLASS to the tracepoint.
29 * TRACE_EVENT is a one to one mapping between tracepoint and template.
33 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
34 DECLARE_EVENT_CLASS(name, \
40 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
42 #undef TRACE_EVENT_NOARGS
43 #define TRACE_EVENT_NOARGS(name, tstruct, assign, print) \
44 DECLARE_EVENT_CLASS_NOARGS(name, \
48 DEFINE_EVENT_NOARGS(name, name)
51 #undef DEFINE_EVENT_PRINT
52 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
53 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
55 /* Callbacks are meaningless to LTTng. */
57 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
58 assign, print, reg, unreg) \
59 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
60 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
63 * Stage 1 of the trace events.
65 * Create dummy trace calls for each events, verifying that the LTTng module
66 * TRACE_EVENT headers match the kernel arguments. Will be optimized out by the
70 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
73 #define TP_PROTO(args...) args
76 #define TP_ARGS(args...) args
79 #define DEFINE_EVENT(_template, _name, _proto, _args) \
80 void trace_##_name(_proto);
82 #undef DEFINE_EVENT_NOARGS
83 #define DEFINE_EVENT_NOARGS(_template, _name) \
84 void trace_##_name(void *__data);
86 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
89 * Stage 2 of the trace events.
91 * Create event field type metadata section.
92 * Each event produce an array of fields.
95 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
97 /* Named field types must be defined in lttng-types.h */
100 #define __field_full(_type, _item, _order, _base) \
103 .type = __type_integer(_type, _order, _base, none), \
107 #define __field(_type, _item) \
108 __field_full(_type, _item, __BYTE_ORDER, 10)
111 #define __field_ext(_type, _item, _filter_type) \
112 __field(_type, _item)
114 #undef __field_network
115 #define __field_network(_type, _item) \
116 __field_full(_type, _item, __BIG_ENDIAN, 10)
118 #undef __field_network_hex
119 #define __field_network_hex(_type, _item) \
120 __field_full(_type, _item, __BIG_ENDIAN, 16)
122 #undef __array_enc_ext
123 #define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
128 .atype = atype_array, \
132 .elem_type = __type_integer(_type, _order, _base, _encoding), \
138 #define __array(_type, _item, _length) \
139 __array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, none)
142 #define __array_text(_type, _item, _length) \
143 __array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, UTF8)
146 #define __array_hex(_type, _item, _length) \
147 __array_enc_ext(_type, _item, _length, __BYTE_ORDER, 16, none)
149 #undef __dynamic_array_enc_ext
150 #define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding) \
155 .atype = atype_sequence, \
158 .length_type = __type_integer(u32, __BYTE_ORDER, 10, none), \
159 .elem_type = __type_integer(_type, _order, _base, _encoding), \
164 #undef __dynamic_array
165 #define __dynamic_array(_type, _item, _length) \
166 __dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, none)
168 #undef __dynamic_array_text
169 #define __dynamic_array_text(_type, _item, _length) \
170 __dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, UTF8)
172 #undef __dynamic_array_hex
173 #define __dynamic_array_hex(_type, _item, _length) \
174 __dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 16, none)
177 #define __string(_item, _src) \
182 .atype = atype_string, \
183 .u.basic.string.encoding = lttng_encode_UTF8, \
187 #undef TP_STRUCT__entry
188 #define TP_STRUCT__entry(args...) args /* Only one used in this phase */
190 #undef DECLARE_EVENT_CLASS_NOARGS
191 #define DECLARE_EVENT_CLASS_NOARGS(_name, _tstruct, _assign, _print) \
192 static const struct lttng_event_field __event_fields___##_name[] = { \
196 #undef DECLARE_EVENT_CLASS
197 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
198 DECLARE_EVENT_CLASS_NOARGS(_name, PARAMS(_tstruct), PARAMS(_assign), \
201 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
204 * Stage 3 of the trace events.
206 * Create probe callback prototypes.
209 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
212 #define TP_PROTO(args...) args
214 #undef DECLARE_EVENT_CLASS
215 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
216 static void __event_probe__##_name(void *__data, _proto);
218 #undef DECLARE_EVENT_CLASS_NOARGS
219 #define DECLARE_EVENT_CLASS_NOARGS(_name, _tstruct, _assign, _print) \
220 static void __event_probe__##_name(void *__data);
222 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
225 * Stage 3.9 of the trace events.
227 * Create event descriptions.
230 /* Named field types must be defined in lttng-types.h */
232 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
235 #define TP_PROBE_CB(_template) &__event_probe__##_template
238 #undef DEFINE_EVENT_NOARGS
239 #define DEFINE_EVENT_NOARGS(_template, _name) \
240 static const struct lttng_event_desc __event_desc___##_name = { \
241 .fields = __event_fields___##_template, \
243 .probe_callback = (void *) TP_PROBE_CB(_template), \
244 .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
245 .owner = THIS_MODULE, \
249 #define DEFINE_EVENT(_template, _name, _proto, _args) \
250 DEFINE_EVENT_NOARGS(_template, _name)
252 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
256 * Stage 4 of the trace events.
258 * Create an array of event description pointers.
261 /* Named field types must be defined in lttng-types.h */
263 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
265 #undef DEFINE_EVENT_NOARGS
266 #define DEFINE_EVENT_NOARGS(_template, _name) \
267 &__event_desc___##_name,
270 #define DEFINE_EVENT(_template, _name, _proto, _args) \
271 DEFINE_EVENT_NOARGS(_template, _name)
273 #define TP_ID1(_token, _system) _token##_system
274 #define TP_ID(_token, _system) TP_ID1(_token, _system)
276 static const struct lttng_event_desc
*TP_ID(__event_desc___
, TRACE_SYSTEM
)[] = {
277 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
285 * Stage 5 of the trace events.
287 * Create a toplevel descriptor for the whole probe.
290 #define TP_ID1(_token, _system) _token##_system
291 #define TP_ID(_token, _system) TP_ID1(_token, _system)
293 /* non-const because list head will be modified when registered. */
294 static __used
struct lttng_probe_desc
TP_ID(__probe_desc___
, TRACE_SYSTEM
) = {
295 .event_desc
= TP_ID(__event_desc___
, TRACE_SYSTEM
),
296 .nr_events
= ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)),
303 * Stage 6 of the trace events.
305 * Create static inline function that calculates event size.
308 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
310 /* Named field types must be defined in lttng-types.h */
313 #define __field_full(_type, _item, _order, _base) \
314 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
315 __event_len += sizeof(_type);
317 #undef __array_enc_ext
318 #define __array_enc_ext(_type, _item, _length, _order, _base, _encoding) \
319 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
320 __event_len += sizeof(_type) * (_length);
322 #undef __dynamic_array_enc_ext
323 #define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
324 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(u32)); \
325 __event_len += sizeof(u32); \
326 __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
327 __dynamic_len[__dynamic_len_idx] = (_length); \
328 __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
332 #define __string(_item, _src) \
333 __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
336 #define TP_PROTO(args...) args
338 #undef TP_STRUCT__entry
339 #define TP_STRUCT__entry(args...) args
341 #undef DECLARE_EVENT_CLASS
342 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
343 static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
345 size_t __event_len = 0; \
346 unsigned int __dynamic_len_idx = 0; \
349 (void) __dynamic_len_idx; /* don't warn if unused */ \
351 return __event_len; \
354 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
357 * Stage 7 of the trace events.
359 * Create static inline function that calculates event payload alignment.
362 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
364 /* Named field types must be defined in lttng-types.h */
367 #define __field_full(_type, _item, _order, _base) \
368 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
370 #undef __array_enc_ext
371 #define __array_enc_ext(_type, _item, _length, _order, _base, _encoding) \
372 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
374 #undef __dynamic_array_enc_ext
375 #define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
376 __event_align = max_t(size_t, __event_align, ltt_alignof(u32)); \
377 __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
380 #define __string(_item, _src)
383 #define TP_PROTO(args...) args
385 #undef TP_STRUCT__entry
386 #define TP_STRUCT__entry(args...) args
388 #undef DECLARE_EVENT_CLASS
389 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
390 static inline size_t __event_get_align__##_name(_proto) \
392 size_t __event_align = 1; \
394 return __event_align; \
397 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
401 * Stage 8 of the trace events.
403 * Create structure declaration that allows the "assign" macros to access the
407 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
409 /* Named field types must be defined in lttng-types.h */
412 #define __field_full(_type, _item, _order, _base) _type _item;
414 #undef __array_enc_ext
415 #define __array_enc_ext(_type, _item, _length, _order, _base, _encoding) \
418 #undef __dynamic_array_enc_ext
419 #define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
423 #define __string(_item, _src) char _item;
425 #undef TP_STRUCT__entry
426 #define TP_STRUCT__entry(args...) args
428 #undef DECLARE_EVENT_CLASS
429 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
430 struct __event_typemap__##_name { \
434 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
438 * Stage 9 of the trace events.
440 * Create the probe function : call even size calculation and write event data
443 * We use both the field and assignment macros to write the fields in the order
444 * defined in the field declaration. The field declarations control the
445 * execution order, jumping to the appropriate assignment block.
448 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
451 #define __field_full(_type, _item, _order, _base) \
452 goto __assign_##_item; \
455 #undef __array_enc_ext
456 #define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
457 goto __assign_##_item; \
460 #undef __dynamic_array_enc_ext
461 #define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
462 goto __assign_##_item##_1; \
463 __end_field_##_item##_1: \
464 goto __assign_##_item##_2; \
465 __end_field_##_item##_2:
468 #define __string(_item, _src) \
469 goto __assign_##_item; \
473 * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
477 #define tp_assign(dest, src) \
480 __typeof__(__typemap.dest) __tmp = (src); \
481 lib_ring_buffer_align_ctx(&__ctx, ltt_alignof(__tmp)); \
482 __chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
484 goto __end_field_##dest;
487 #define tp_memcpy(dest, src, len) \
490 (void) __typemap.dest; \
491 lib_ring_buffer_align_ctx(&__ctx, ltt_alignof(__typemap.dest)); \
492 __chan->ops->event_write(&__ctx, src, len); \
493 goto __end_field_##dest;
496 #define tp_memcpy_dyn(dest, src) \
497 __assign_##dest##_1: \
499 u32 __tmpl = __dynamic_len[__dynamic_len_idx]; \
500 lib_ring_buffer_align_ctx(&__ctx, ltt_alignof(u32)); \
501 __chan->ops->event_write(&__ctx, &__tmpl, sizeof(u32)); \
503 goto __end_field_##dest##_1; \
504 __assign_##dest##_2: \
505 lib_ring_buffer_align_ctx(&__ctx, ltt_alignof(__typemap.dest)); \
506 __chan->ops->event_write(&__ctx, src, \
507 sizeof(__typemap.dest) * __get_dynamic_array_len(dest));\
508 goto __end_field_##dest##_2;
511 #define tp_strcpy(dest, src) \
512 tp_memcpy(dest, src, __get_dynamic_array_len(dest))
514 /* Named field types must be defined in lttng-types.h */
517 #define __get_str(field) field
519 #undef __get_dynamic_array
520 #define __get_dynamic_array(field) field
522 /* Beware: this get len actually consumes the len value */
523 #undef __get_dynamic_array_len
524 #define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
527 #define TP_PROTO(args...) args
530 #define TP_ARGS(args...) args
532 #undef TP_STRUCT__entry
533 #define TP_STRUCT__entry(args...) args
535 #undef TP_fast_assign
536 #define TP_fast_assign(args...) args
538 #undef DECLARE_EVENT_CLASS
539 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
540 static void __event_probe__##_name(void *__data, _proto) \
542 struct ltt_event *__event = __data; \
543 struct ltt_channel *__chan = __event->chan; \
544 struct lib_ring_buffer_ctx __ctx; \
545 size_t __event_len, __event_align; \
546 size_t __dynamic_len_idx = 0; \
547 size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)]; \
548 struct __event_typemap__##_name __typemap; \
552 (void) __dynamic_len_idx; /* don't warn if unused */ \
553 if (unlikely(!ACCESS_ONCE(__chan->session->active))) \
555 if (unlikely(!ACCESS_ONCE(__chan->enabled))) \
557 if (unlikely(!ACCESS_ONCE(__event->enabled))) \
559 __event_len = __event_get_size__##_name(__dynamic_len, _args); \
560 __event_align = __event_get_align__##_name(_args); \
561 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
562 __event_align, -1); \
563 __ret = __chan->ops->event_reserve(&__ctx, __event->id); \
566 /* Control code (field ordering) */ \
568 __chan->ops->event_commit(&__ctx); \
570 /* Copy code, steered by control code */ \
574 #undef DECLARE_EVENT_CLASS_NOARGS
575 #define DECLARE_EVENT_CLASS_NOARGS(_name, _tstruct, _assign, _print) \
576 static void __event_probe__##_name(void *__data) \
578 struct ltt_event *__event = __data; \
579 struct ltt_channel *__chan = __event->chan; \
580 struct lib_ring_buffer_ctx __ctx; \
581 size_t __event_len, __event_align; \
584 if (unlikely(!ACCESS_ONCE(__chan->session->active))) \
586 if (unlikely(!ACCESS_ONCE(__chan->enabled))) \
588 if (unlikely(!ACCESS_ONCE(__event->enabled))) \
592 lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
593 __event_align, -1); \
594 __ret = __chan->ops->event_reserve(&__ctx, __event->id); \
597 /* Control code (field ordering) */ \
599 __chan->ops->event_commit(&__ctx); \
601 /* Copy code, steered by control code */ \
605 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
608 * Stage 10 of the trace events.
610 * Register/unregister probes at module load/unload.
613 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
615 #define TP_ID1(_token, _system) _token##_system
616 #define TP_ID(_token, _system) TP_ID1(_token, _system)
617 #define module_init_eval1(_token, _system) module_init(_token##_system)
618 #define module_init_eval(_token, _system) module_init_eval1(_token, _system)
619 #define module_exit_eval1(_token, _system) module_exit(_token##_system)
620 #define module_exit_eval(_token, _system) module_exit_eval1(_token, _system)
622 #ifndef TP_MODULE_OVERRIDE
623 static int TP_ID(__lttng_events_init__
, TRACE_SYSTEM
)(void)
625 wrapper_vmalloc_sync_all();
626 return ltt_probe_register(&TP_ID(__probe_desc___
, TRACE_SYSTEM
));
629 module_init_eval(__lttng_events_init__
, TRACE_SYSTEM
);
631 static void TP_ID(__lttng_events_exit__
, TRACE_SYSTEM
)(void)
633 ltt_probe_unregister(&TP_ID(__probe_desc___
, TRACE_SYSTEM
));
636 module_exit_eval(__lttng_events_exit__
, TRACE_SYSTEM
);
639 #undef module_init_eval
640 #undef module_exit_eval
646 #undef TRACE_EVENT_FLAGS
This page took 0.045334 seconds and 5 git commands to generate.