6631fbcd1ce82d21dc1ca1de667f01be6488c455
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
;
17 unsigned int nr_fields
;
21 * Macro declarations used for all stages.
25 * DECLARE_EVENT_CLASS can be used to add a generic function
26 * handlers for events. That is, if all events have the same
27 * parameters and just have distinct trace points.
28 * Each tracepoint can be defined with DEFINE_EVENT and that
29 * will map the DECLARE_EVENT_CLASS to the tracepoint.
31 * TRACE_EVENT is a one to one mapping between tracepoint and template.
35 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
36 DECLARE_EVENT_CLASS(name, \
42 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
44 #undef DEFINE_EVENT_PRINT
45 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
46 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
48 /* Callbacks are meaningless to LTTng. */
50 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
51 assign, print, reg, unreg) \
52 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
53 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
56 * Stage 1 of the trace events.
58 * Create event field type metadata section.
59 * Each event produce an array of fields.
62 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
64 /* Named field types must be defined in lttng-types.h */
67 #define __field(_type, _item) \
68 { .name = #_item, .type = { .atype = atype_integer, .name = #_type} },
71 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
74 #define __array(_type, _item, _length) \
78 .atype = atype_array, \
80 .u.array.elem_type = #_type, \
81 .u.array.length = _length, \
85 #undef __dynamic_array
86 #define __dynamic_array(_type, _item, _length) \
90 .atype = atype_sequence, \
92 .u.sequence.elem_type = #_type, \
93 .u.sequence.length_type = "u32", \
98 #define __string(_item, _src) \
102 .atype = atype_string, \
104 .u.string.encoding = lttng_encode_UTF8, \
108 #undef TP_STRUCT__entry
109 #define TP_STRUCT__entry(args...) args /* Only one used in this phase */
111 #undef DECLARE_EVENT_CLASS
112 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
113 static const struct lttng_event_field __event_fields___##_name[] = { \
117 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
120 * Stage 1.1 of the trace events.
122 * Create probe callback prototypes.
125 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
128 #define TP_PROTO(args...) args
130 #undef DECLARE_EVENT_CLASS
131 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
132 static void __event_probe__##_name(void *__data, _proto);
134 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
137 * Stage 2 of the trace events.
139 * Create an array of events.
142 /* Named field types must be defined in lttng-types.h */
144 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
147 #define DEFINE_EVENT(_template, _name, _proto, _args) \
149 .fields = __event_fields___##_template, \
151 .probe_callback = (void *) &__event_probe__##_template,\
152 .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
155 #define TP_ID1(_token, _system) _token##_system
156 #define TP_ID(_token, _system) TP_ID1(_token, _system)
158 static const struct lttng_event_desc
TP_ID(__event_desc___
, TRACE_SYSTEM
)[] = {
159 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
166 * Stage 3 of the trace events.
168 * Create seq file metadata output.
171 #define TP_ID1(_token, _system) _token##_system
172 #define TP_ID(_token, _system) TP_ID1(_token, _system)
174 static void *TP_ID(__lttng_seq_start__
, TRACE_SYSTEM
)(struct seq_file
*m
,
177 const struct lttng_event_desc
*desc
=
178 &TP_ID(__event_desc___
, TRACE_SYSTEM
)[*pos
];
180 if (desc
> &TP_ID(__event_desc___
, TRACE_SYSTEM
)
181 [ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)) - 1])
183 return (void *) desc
;
186 static void *TP_ID(__lttng_seq_next__
, TRACE_SYSTEM
)(struct seq_file
*m
,
187 void *p
, loff_t
*ppos
)
189 const struct lttng_event_desc
*desc
=
190 &TP_ID(__event_desc___
, TRACE_SYSTEM
)[++(*ppos
)];
192 if (desc
> &TP_ID(__event_desc___
, TRACE_SYSTEM
)
193 [ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)) - 1])
195 return (void *) desc
;
198 static void TP_ID(__lttng_seq_stop__
, TRACE_SYSTEM
)(struct seq_file
*m
,
203 static int TP_ID(__lttng_seq_show__
, TRACE_SYSTEM
)(struct seq_file
*m
,
206 const struct lttng_event_desc
*desc
= p
;
209 seq_printf(m
, "event {\n"
212 "\tstream = UNKNOWN;\n"
215 for (i
= 0; i
< desc
->nr_fields
; i
++) {
216 if (desc
->fields
[i
].type
.name
) /* Named type */
217 seq_printf(m
, "\t\t%s",
218 desc
->fields
[i
].type
.name
);
219 else /* Nameless type */
220 lttng_print_event_type(m
, 2, &desc
->fields
[i
].type
);
221 seq_printf(m
, " %s;\n", desc
->fields
[i
].name
);
223 seq_printf(m
, "\t};\n");
224 seq_printf(m
, "};\n");
229 struct seq_operations
TP_ID(__lttng_types_seq_ops__
, TRACE_SYSTEM
) = {
230 .start
= TP_ID(__lttng_seq_start__
, TRACE_SYSTEM
),
231 .next
= TP_ID(__lttng_seq_next__
, TRACE_SYSTEM
),
232 .stop
= TP_ID(__lttng_seq_stop__
, TRACE_SYSTEM
),
233 .show
= TP_ID(__lttng_seq_show__
, TRACE_SYSTEM
),
237 TP_ID(__lttng_types_open__
, TRACE_SYSTEM
)(struct inode
*inode
, struct file
*file
)
239 return seq_open(file
, &TP_ID(__lttng_types_seq_ops__
, TRACE_SYSTEM
));
243 struct file_operations
TP_ID(__lttng_types_fops__
, TRACE_SYSTEM
) = {
244 .open
= TP_ID(__lttng_types_open__
, TRACE_SYSTEM
),
247 .release
= seq_release_private
,
250 static struct dentry
*TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
);
252 static int TP_ID(__lttng_types_init__
, TRACE_SYSTEM
)(void)
256 TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
) =
257 debugfs_create_file("lttng-events-" __stringify(TRACE_SYSTEM
),
259 &TP_ID(__lttng_types_fops__
, TRACE_SYSTEM
));
260 if (IS_ERR(TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
))
261 || !TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
)) {
262 printk(KERN_ERR
"Error creating LTTng type export file\n");
270 static void TP_ID(__lttng_types_exit__
, TRACE_SYSTEM
)(void)
272 debugfs_remove(TP_ID(__lttng_types_dentry__
, TRACE_SYSTEM
));
279 * Stage 4 of the trace events.
281 * Create static inline function that calculates event size.
284 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
286 /* Named field types must be defined in lttng-types.h */
289 #define __field(_type, _item) \
290 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
291 __event_len += sizeof(_type);
294 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
297 #define __array(_type, _item, _length) \
298 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
299 __event_len += sizeof(_type) * (_length);
301 #undef __dynamic_array
302 #define __dynamic_array(_type, _item, _length) \
303 __event_len += lib_ring_buffer_align(__event_len, __alignof__(u32)); \
304 __event_len += sizeof(u32); \
305 __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
306 __event_len += sizeof(_type) * (_length);
309 #define __string(_item, _src) \
310 __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
313 #define TP_PROTO(args...) args
315 #undef TP_STRUCT__entry
316 #define TP_STRUCT__entry(args...) args
318 #undef DECLARE_EVENT_CLASS
319 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
320 static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
322 size_t __event_len = 0; \
323 unsigned int __dynamic_len_idx = 0; \
326 (void) __dynamic_len_idx; /* don't warn if unused */ \
328 return __event_len; \
331 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
336 * Stage 5 of the trace events.
338 * Create static inline function that calculates event payload alignment.
341 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
343 /* Named field types must be defined in lttng-types.h */
346 #define __field(_type, _item) \
347 __event_align = max_t(size_t, __event_align, __alignof__(_type));
350 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
353 #define __array(_type, _item, _length) \
354 __event_align = max_t(size_t, __event_align, __alignof__(_type));
356 #undef __dynamic_array
357 #define __dynamic_array(_type, _item, _length) \
358 __event_align = max_t(size_t, __event_align, __alignof__(u32)); \
359 __event_align = max_t(size_t, __event_align, __alignof__(_type));
362 #define __string(_item, _src)
365 #define TP_PROTO(args...) args
367 #undef TP_STRUCT__entry
368 #define TP_STRUCT__entry(args...) args
370 #undef DECLARE_EVENT_CLASS
371 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
372 static inline size_t __event_get_align__##_name(_proto) \
374 size_t __event_align = 1; \
376 return __event_align; \
379 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
383 * Stage 6 of the trace events.
385 * Create structure declaration that allows the "assign" macros to access the
389 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
391 /* Named field types must be defined in lttng-types.h */
394 #define __field(_type, _item) _type _item;
397 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
400 #define __array(_type, _item, _length) _type _item;
402 #undef __dynamic_array
403 #define __dynamic_array(_type, _item, _length) _type _item;
406 #define __string(_item, _src) char _item;
408 #undef TP_STRUCT__entry
409 #define TP_STRUCT__entry(args...) args
411 #undef DECLARE_EVENT_CLASS
412 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
413 struct __event_typemap__##_name { \
417 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
421 * Stage 7 of the trace events.
423 * Create the probe function : call even size calculation and write event data
426 * We use both the field and assignment macros to write the fields in the order
427 * defined in the field declaration. The field declarations control the
428 * execution order, jumping to the appropriate assignment block.
431 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
434 #define __field(_type, _item) \
435 goto __assign_##_item; \
439 #define __field_ext(_type, _item, _filter_type) __field(_type, _item)
442 #define __array(_type, _item, _length) \
443 goto __assign_##_item; \
446 #undef __dynamic_array
447 #define __dynamic_array(_type, _item, _length) \
448 goto __assign_##_item##_1; \
449 __end_field_##_item##_1: \
450 goto __assign_##_item##_2; \
451 __end_field_##_item##_2:
454 #define __string(_item, _src) \
455 goto __assign_##_item; \
459 * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
463 #define tp_assign(dest, src) \
466 __typeof__(__typemap.dest) __tmp = (src); \
467 lib_ring_buffer_align_ctx(&ctx, __alignof__(__tmp)); \
468 __chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp)); \
470 goto __end_field_##dest;
473 #define tp_memcpy(dest, src, len) \
475 lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest)); \
476 __chan->ops->event_write(&ctx, src, len); \
477 goto __end_field_##dest;
480 #define tp_memcpy_dyn(dest, src, len) \
481 __assign_##dest##_1: \
483 u32 __tmpl = (len); \
484 lib_ring_buffer_align_ctx(&ctx, __alignof__(u32)); \
485 __chan->ops->event_write(&ctx, &__tmpl, sizeof(u32)); \
487 goto __end_field_##dest##_1; \
488 __assign_##dest##_2: \
489 lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest)); \
490 __chan->ops->event_write(&ctx, src, len); \
491 goto __end_field_##dest##_2;
494 #define tp_strcpy(dest, src) \
495 tp_memcpy(dest, src, __get_dynamic_array_len(dest))
497 /* Named field types must be defined in lttng-types.h */
500 #define __get_str(field) field
502 #undef __get_dynamic_array
503 #define __get_dynamic_array(field) field
505 /* Beware: this get len actually consumes the len value */
506 #undef __get_dynamic_array_len
507 #define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
510 #define TP_PROTO(args...) args
513 #define TP_ARGS(args...) args
515 #undef TP_STRUCT__entry
516 #define TP_STRUCT__entry(args...) args
518 #undef TP_fast_assign
519 #define TP_fast_assign(args...) args
521 #undef DECLARE_EVENT_CLASS
522 #define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
523 static void __event_probe__##_name(void *__data, _proto) \
525 struct ltt_event *__event = __data; \
526 struct ltt_channel *__chan = __event->chan; \
527 struct lib_ring_buffer_ctx ctx; \
528 size_t __event_len, __event_align; \
529 size_t __dynamic_len_idx = 0; \
530 size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)]; \
531 struct __event_typemap__##_name __typemap; \
535 (void) __dynamic_len_idx; /* don't warn if unused */ \
536 if (!ACCESS_ONCE(__chan->session->active)) \
538 __event_len = __event_get_size__##_name(__dynamic_len, _args); \
539 __event_align = __event_get_align__##_name(_args); \
540 lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len, \
541 __event_align, -1); \
542 __ret = __chan->ops->event_reserve(&ctx); \
545 /* Control code (field ordering) */ \
547 __chan->ops->event_commit(&ctx); \
549 /* Copy code, steered by control code */ \
553 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
556 * Stage 8 of the trace events.
558 * Register/unregister probes at module load/unload.
561 #include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
563 #define TP_ID1(_token, _system) _token##_system
564 #define TP_ID(_token, _system) TP_ID1(_token, _system)
565 #define module_init_eval1(_token, _system) module_init(_token##_system)
566 #define module_init_eval(_token, _system) module_init_eval1(_token, _system)
567 #define module_exit_eval1(_token, _system) module_exit(_token##_system)
568 #define module_exit_eval(_token, _system) module_exit_eval1(_token, _system)
570 static int TP_ID(__lttng_events_init__
, TRACE_SYSTEM
)(void)
575 ret
= TP_ID(__lttng_types_init__
, TRACE_SYSTEM
)();
578 for (i
= 0; i
< ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)); i
++) {
579 const struct lttng_event_desc
*event_desc
;
581 event_desc
= &TP_ID(__event_desc___
, TRACE_SYSTEM
)[i
];
582 ret
= ltt_probe_register(event_desc
->name
,
583 event_desc
->probe_callback
);
590 for (i
--; i
>= 0; i
--) {
591 const struct lttng_event_desc
*event_desc
;
593 event_desc
= &TP_ID(__event_desc___
, TRACE_SYSTEM
)[i
];
594 ltt_probe_unregister(event_desc
->name
);
599 module_init_eval(__lttng_events_init__
, TRACE_SYSTEM
);
601 static void TP_ID(__lttng_events_exit__
, TRACE_SYSTEM
)(void)
605 for (i
= 0; i
< ARRAY_SIZE(TP_ID(__event_desc___
, TRACE_SYSTEM
)); i
++) {
606 const struct lttng_event_desc
*event_desc
;
608 event_desc
= &TP_ID(__event_desc___
, TRACE_SYSTEM
)[i
];
609 ltt_probe_unregister(event_desc
->name
);
611 TP_ID(__lttng_types_exit__
, TRACE_SYSTEM
)();
614 module_exit_eval(__lttng_events_exit__
, TRACE_SYSTEM
);
616 #undef module_init_eval
617 #undef module_exit_eval
This page took 0.04159 seconds and 4 git commands to generate.