ee7e5d9694fdd6790c152f5ab54f3d9ea95582a2
2 #include <lttng-types.h>
3 #include <linux/debugfs.h>
4 #include <linux/ringbuffer/frontend_types.h>
5 #include "../ltt-events.h"
6 #include "../ltt-tracer-core.h"
8 struct lttng_event_field
{
10 const struct lttng_type type
;
13 struct lttng_event_desc
{
14 const struct lttng_event_field
*fields
;
16 unsigned int nr_fields
;
20 * Macro declarations used for all stages.
24 * DECLARE_EVENT_CLASS can be used to add a generic function
25 * handlers for events. That is, if all events have the same
26 * parameters and just have distinct trace points.
27 * Each tracepoint can be defined with DEFINE_EVENT and that
28 * will map the DECLARE_EVENT_CLASS to the tracepoint.
30 * TRACE_EVENT is a one to one mapping between tracepoint and template.
34 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
35 DECLARE_EVENT_CLASS(name, \
41 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
43 #undef DEFINE_EVENT_PRINT
44 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
45 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
47 /* Callbacks are meaningless to LTTng. */
49 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
50 assign, print, reg, unreg) \
51 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
52 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
55 * Stage 1 of the trace events.
57 * Create event field type metadata section.
58 * Each event produce an array of fields.
61 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
63 /* Named field types must be defined in lttng-types.h */
66 #define __field(_type, _item) \
67 { .name = #_item, .type = { .atype = atype_integer, .name = #_type} },
70 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
73 #define __array(_type, _item, _length) \
77 .atype = atype_array, \
79 .u.array.elem_type = #_type, \
80 .u.array.length = _length, \
84 #undef __dynamic_array
85 #define __dynamic_array(_type, _item, _length) \
89 .atype = atype_sequence, \
91 .u.sequence.elem_type = #_type, \
92 .u.sequence.length_type = "u32", \
97 #define __string(_item, _src) \
101 .atype = atype_string, \
103 .u.string.encoding = lttng_encode_UTF8, \
107 #undef TP_STRUCT__entry
108 #define TP_STRUCT__entry(args...) args /* Only one used in this phase */
110 #undef DECLARE_EVENT_CLASS
111 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
112 static const struct lttng_event_field __event_fields___##_name[] = { \
116 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
119 * Stage 2 of the trace events.
121 * Create an array of events.
124 /* Named field types must be defined in lttng-types.h */
126 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
129 #define DEFINE_EVENT(_template, _name, _proto, _args) \
131 .fields = __event_fields___##_template, \
133 .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
136 #define TP_ID1(_token, _system) _token##_system
137 #define TP_ID(_token, _system) TP_ID1(_token, _system)
139 static const struct lttng_event_desc
TP_ID(__event_desc___
, TRACE_SYSTEM
)[] = {
140 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
147 * Stage 3 of the trace events.
149 * Create seq file metadata output.
152 #define TP_ID1(_token, _system) _token##_system
153 #define TP_ID(_token, _system) TP_ID1(_token, _system)
155 static void *TP_ID(__lttng_seq_start__
, TRACE_SYSTEM
)(struct seq_file
*m
,
158 const struct lttng_event_desc
*desc
=
159 &TP_ID(__event_desc___
, TRACE_SYSTEM
)[*pos
];
161 if (desc
> &TP_ID(__event_desc___
, TRACE_SYSTEM
)
162 [ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)) - 1])
164 return (void *) desc
;
167 static void *TP_ID(__lttng_seq_next__
, TRACE_SYSTEM
)(struct seq_file
*m
,
168 void *p
, loff_t
*ppos
)
170 const struct lttng_event_desc
*desc
=
171 &TP_ID(__event_desc___
, TRACE_SYSTEM
)[++(*ppos
)];
173 if (desc
> &TP_ID(__event_desc___
, TRACE_SYSTEM
)
174 [ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)) - 1])
176 return (void *) desc
;
179 static void TP_ID(__lttng_seq_stop__
, TRACE_SYSTEM
)(struct seq_file
*m
,
184 static int TP_ID(__lttng_seq_show__
, TRACE_SYSTEM
)(struct seq_file
*m
,
187 const struct lttng_event_desc
*desc
= p
;
190 seq_printf(m
, "event {\n"
193 "\tstream = UNKNOWN;\n"
196 for (i
= 0; i
< desc
->nr_fields
; i
++) {
197 if (desc
->fields
[i
].type
.name
) /* Named type */
198 seq_printf(m
, "\t\t%s",
199 desc
->fields
[i
].type
.name
);
200 else /* Nameless type */
201 lttng_print_event_type(m
, 2, &desc
->fields
[i
].type
);
202 seq_printf(m
, " %s;\n", desc
->fields
[i
].name
);
204 seq_printf(m
, "\t};\n");
205 seq_printf(m
, "};\n");
210 struct seq_operations
TP_ID(__lttng_types_seq_ops__
, TRACE_SYSTEM
) = {
211 .start
= TP_ID(__lttng_seq_start__
, TRACE_SYSTEM
),
212 .next
= TP_ID(__lttng_seq_next__
, TRACE_SYSTEM
),
213 .stop
= TP_ID(__lttng_seq_stop__
, TRACE_SYSTEM
),
214 .show
= TP_ID(__lttng_seq_show__
, TRACE_SYSTEM
),
218 TP_ID(__lttng_types_open__
, TRACE_SYSTEM
)(struct inode
*inode
, struct file
*file
)
220 return seq_open(file
, &TP_ID(__lttng_types_seq_ops__
, TRACE_SYSTEM
));
224 struct file_operations
TP_ID(__lttng_types_fops__
, TRACE_SYSTEM
) = {
225 .open
= TP_ID(__lttng_types_open__
, TRACE_SYSTEM
),
228 .release
= seq_release_private
,
231 static struct dentry
*TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
);
233 static int TP_ID(__lttng_types_init__
, TRACE_SYSTEM
)(void)
237 TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
) =
238 debugfs_create_file("lttng-events-" __stringify(TRACE_SYSTEM
),
240 &TP_ID(__lttng_types_fops__
, TRACE_SYSTEM
));
241 if (IS_ERR(TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
))
242 || !TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
)) {
243 printk(KERN_ERR
"Error creating LTTng type export file\n");
251 static void TP_ID(__lttng_types_exit__
, TRACE_SYSTEM
)(void)
253 debugfs_remove(TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
));
260 * Stage 4 of the trace events.
262 * Create static inline function that calculates event size.
265 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
267 /* Named field types must be defined in lttng-types.h */
270 #define __field(_type, _item) \
271 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
272 __event_len += sizeof(_type);
275 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
278 #define __array(_type, _item, _length) \
279 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
280 __event_len += sizeof(_type) * (_length);
282 #undef __dynamic_array
283 #define __dynamic_array(_type, _item, _length) \
284 __event_len += lib_ring_buffer_align(__event_len, __alignof__(u32)); \
285 __event_len += sizeof(u32); \
286 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
287 __event_len += sizeof(_type) * (_length);
290 #define __string(_item, _src) \
291 __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
294 #define TP_PROTO(args...) args
296 #undef TP_STRUCT__entry
297 #define TP_STRUCT__entry(args...) args
299 #undef DECLARE_EVENT_CLASS
300 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
301 static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
303 size_t __event_len = 0; \
304 unsigned int __dynamic_len_idx = 0; \
307 (void) __dynamic_len_idx; /* don't warn if unused */ \
309 return __event_len; \
312 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
317 * Stage 5 of the trace events.
319 * Create static inline function that calculates event payload alignment.
322 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
324 /* Named field types must be defined in lttng-types.h */
327 #define __field(_type, _item) \
328 __event_align = max_t(size_t, __event_align, __alignof__(_type));
331 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
334 #define __array(_type, _item, _length) \
335 __event_align = max_t(size_t, __event_align, __alignof__(_type));
337 #undef __dynamic_array
338 #define __dynamic_array(_type, _item, _length) \
339 __event_align = max_t(size_t, __event_align, __alignof__(u32)); \
340 __event_align = max_t(size_t, __event_align, __alignof__(_type));
343 #define __string(_item, _src)
346 #define TP_PROTO(args...) args
348 #undef TP_STRUCT__entry
349 #define TP_STRUCT__entry(args...) args
351 #undef DECLARE_EVENT_CLASS
352 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
353 static inline size_t __event_get_align__##_name(_proto) \
355 size_t __event_align = 1; \
357 return __event_align; \
360 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
364 * Stage 6 of the trace events.
366 * Create structure declaration that allows the "assign" macros to access the
370 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
372 /* Named field types must be defined in lttng-types.h */
375 #define __field(_type, _item) _type _item;
378 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
381 #define __array(_type, _item, _length) _type _item;
383 #undef __dynamic_array
384 #define __dynamic_array(_type, _item, _length) _type _item;
387 #define __string(_item, _src) char _item;
389 #undef TP_STRUCT__entry
390 #define TP_STRUCT__entry(args...) args
392 #undef DECLARE_EVENT_CLASS
393 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
394 struct __event_typemap__##_name { \
398 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
402 * Stage 7 of the trace events.
404 * Create the probe function : call even size calculation and write event data
407 * We use both the field and assignment macros to write the fields in the order
408 * defined in the field declaration. The field declarations control the
409 * execution order, jumping to the appropriate assignment block.
412 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
415 #define __field(_type, _item) \
416 goto __assign_##_item; \
420 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
423 #define __array(_type, _item, _length) \
424 goto __assign_##_item; \
427 #undef __dynamic_array
428 #define __dynamic_array(_type, _item, _length) \
429 goto __assign_##_item##_1; \
430 __end_field_##_item##_1: \
431 goto __assign_##_item##_2; \
432 __end_field_##_item##_2:
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, __alignof__(__tmp)); \
449 __chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp)); \
451 goto __end_field_##dest;
454 #define tp_memcpy(dest, src, len) \
456 lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest)); \
457 __chan->ops->event_write(&ctx, src, len); \
458 goto __end_field_##dest;
461 #define tp_memcpy_dyn(dest, src, len) \
462 __assign_##dest##_1: \
464 u32 __tmpl = (len); \
465 lib_ring_buffer_align_ctx(&ctx, __alignof__(u32)); \
466 __chan->ops->event_write(&ctx, &__tmpl, sizeof(u32)); \
468 goto __end_field_##dest##_1; \
469 __assign_##dest##_2: \
470 lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest)); \
471 __chan->ops->event_write(&ctx, src, len); \
472 goto __end_field_##dest##_2;
475 #define tp_strcpy(dest, src) \
476 tp_memcpy(dest, src, __get_dynamic_array_len(dest))
478 /* Named field types must be defined in lttng-types.h */
481 #define __get_str(field) field
483 #undef __get_dynamic_array
484 #define __get_dynamic_array(field) field
486 /* Beware: this get len actually consumes the len value */
487 #undef __get_dynamic_array_len
488 #define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
491 #define TP_PROTO(args...) args
494 #define TP_ARGS(args...) args
496 #undef TP_STRUCT__entry
497 #define TP_STRUCT__entry(args...) args
499 #undef TP_fast_assign
500 #define TP_fast_assign(args...) args
502 #undef DECLARE_EVENT_CLASS
503 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
504 static void __event_probe__##_name(void *__data, _proto) \
506 struct ltt_event *__event = __data; \
507 struct ltt_channel *__chan = __event->chan; \
508 struct lib_ring_buffer_ctx ctx; \
509 size_t __event_len, __event_align; \
510 size_t __dynamic_len_idx = 0; \
511 size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)]; \
512 struct __event_typemap__##_name __typemap; \
516 (void) __dynamic_len_idx; /* don't warn if unused */ \
517 __event_len = __event_get_size__##_name(__dynamic_len, _args); \
518 __event_align = __event_get_align__##_name(_args); \
519 lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len, \
520 __event_align, -1); \
521 __ret = __chan->ops->event_reserve(&ctx); \
524 /* Control code (field ordering) */ \
526 __chan->ops->event_commit(&ctx); \
528 /* Copy code, steered by control code */ \
532 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
536 * Stage 8 of the trace events.
538 * Register/unregister probes at module load/unload.
541 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
543 #define TP_ID1(_token, _system) _token##_system
544 #define TP_ID(_token, _system) TP_ID1(_token, _system)
545 #define module_init_eval1(_token, _system) module_init(_token##_system)
546 #define module_init_eval(_token, _system) module_init_eval1(_token, _system)
547 #define module_exit_eval1(_token, _system) module_exit(_token##_system)
548 #define module_exit_eval(_token, _system) module_exit_eval1(_token, _system)
551 #define DEFINE_EVENT(_template, _name, _proto, _args) \
552 ret = ltt_probe_register(#_name, (void *) __event_probe__##_template); \
555 static int TP_ID(__lttng_events_init__
, TRACE_SYSTEM
)(void)
559 ret
= TP_ID(__lttng_types_init__
, TRACE_SYSTEM
)();
562 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
566 module_init_eval(__lttng_events_init__
, TRACE_SYSTEM
);
569 #define DEFINE_EVENT(_template, _name, _proto, _args) \
570 ltt_probe_unregister(#_name);
572 static void TP_ID(__lttng_events_exit__
, TRACE_SYSTEM
)(void)
574 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
575 TP_ID(__lttng_types_exit__
, TRACE_SYSTEM
)();
578 module_exit_eval(__lttng_events_exit__
, TRACE_SYSTEM
);
580 #undef module_init_eval
581 #undef module_exit_eval
This page took 0.069259 seconds and 5 git commands to generate.