4 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Holds LTTng per-session event registry.
9 #include <linux/module.h>
10 #include <linux/list.h>
11 #include <linux/mutex.h>
12 #include <linux/sched.h>
13 #include <linux/slab.h>
14 #include <linux/jiffies.h>
15 #include <linux/uuid.h>
16 #include "wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
17 #include "ltt-events.h"
18 #include "ltt-tracer.h"
20 static LIST_HEAD(sessions
);
21 static LIST_HEAD(ltt_transport_list
);
22 static DEFINE_MUTEX(sessions_mutex
);
23 static struct kmem_cache
*event_cache
;
25 static void _ltt_event_destroy(struct ltt_event
*event
);
26 static int _ltt_event_unregister(struct ltt_event
*event
);
28 int _ltt_event_metadata_statedump(struct ltt_session
*session
,
29 struct ltt_channel
*chan
,
30 struct ltt_event
*event
);
32 int _ltt_session_metadata_statedump(struct ltt_session
*session
);
36 void synchronize_trace(void)
39 #ifdef CONFIG_PREEMPT_RT
44 struct ltt_session
*ltt_session_create(void)
46 struct ltt_session
*session
;
48 mutex_lock(&sessions_mutex
);
49 session
= kzalloc(sizeof(struct ltt_session
), GFP_KERNEL
);
52 INIT_LIST_HEAD(&session
->chan
);
53 INIT_LIST_HEAD(&session
->events
);
54 uuid_le_gen(&session
->uuid
);
55 list_add(&session
->list
, &sessions
);
56 mutex_unlock(&sessions_mutex
);
60 void ltt_session_destroy(struct ltt_session
*session
)
62 struct ltt_channel
*chan
, *tmpchan
;
63 struct ltt_event
*event
, *tmpevent
;
66 mutex_lock(&sessions_mutex
);
67 ACCESS_ONCE(session
->active
) = 0;
68 list_for_each_entry(event
, &session
->events
, list
) {
69 ret
= _ltt_event_unregister(event
);
72 synchronize_trace(); /* Wait for in-flight events to complete */
73 list_for_each_entry_safe(event
, tmpevent
, &session
->events
, list
)
74 _ltt_event_destroy(event
);
75 list_for_each_entry_safe(chan
, tmpchan
, &session
->chan
, list
)
76 _ltt_channel_destroy(chan
);
77 list_del(&session
->list
);
78 mutex_unlock(&sessions_mutex
);
82 int ltt_session_start(struct ltt_session
*session
)
85 struct ltt_channel
*chan
;
87 mutex_lock(&sessions_mutex
);
88 if (session
->active
) {
94 * Snapshot the number of events per channel to know the type of header
97 list_for_each_entry(chan
, &session
->chan
, list
) {
98 if (chan
->header_type
)
99 continue; /* don't change it if session stop/restart */
100 if (chan
->free_event_id
< 31)
101 chan
->header_type
= 1; /* compact */
103 chan
->header_type
= 2; /* large */
106 ACCESS_ONCE(session
->active
) = 1;
107 synchronize_trace(); /* Wait for in-flight events to complete */
108 ret
= _ltt_session_metadata_statedump(session
);
110 ACCESS_ONCE(session
->active
) = 0;
111 synchronize_trace(); /* Wait for in-flight events to complete */
114 mutex_unlock(&sessions_mutex
);
118 int ltt_session_stop(struct ltt_session
*session
)
122 mutex_lock(&sessions_mutex
);
123 if (!session
->active
) {
127 ACCESS_ONCE(session
->active
) = 0;
128 synchronize_trace(); /* Wait for in-flight events to complete */
130 mutex_unlock(&sessions_mutex
);
134 static struct ltt_transport
*ltt_transport_find(const char *name
)
136 struct ltt_transport
*transport
;
138 list_for_each_entry(transport
, <t_transport_list
, node
) {
139 if (!strcmp(transport
->name
, name
))
145 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
146 const char *transport_name
,
148 size_t subbuf_size
, size_t num_subbuf
,
149 unsigned int switch_timer_interval
,
150 unsigned int read_timer_interval
)
152 struct ltt_channel
*chan
;
153 struct ltt_transport
*transport
;
155 mutex_lock(&sessions_mutex
);
156 if (session
->active
) {
157 printk(KERN_WARNING
"LTTng refusing to add channel to active session\n");
158 goto active
; /* Refuse to add channel to active session */
160 transport
= ltt_transport_find(transport_name
);
162 printk(KERN_WARNING
"LTTng transport %s not found\n",
166 chan
= kzalloc(sizeof(struct ltt_channel
), GFP_KERNEL
);
169 chan
->session
= session
;
170 init_waitqueue_head(&chan
->notify_wait
);
171 chan
->chan
= transport
->ops
.channel_create("[lttng]", chan
, buf_addr
,
172 subbuf_size
, num_subbuf
, switch_timer_interval
,
173 read_timer_interval
);
176 chan
->id
= session
->free_chan_id
++;
177 chan
->ops
= &transport
->ops
;
178 list_add(&chan
->list
, &session
->chan
);
179 mutex_unlock(&sessions_mutex
);
187 mutex_unlock(&sessions_mutex
);
192 * Only used internally at session destruction.
194 void _ltt_channel_destroy(struct ltt_channel
*chan
)
196 chan
->ops
->channel_destroy(chan
->chan
);
197 list_del(&chan
->list
);
202 * Supports event creation while tracing session is active.
204 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
, char *name
,
205 struct lttng_kernel_event
*event_param
,
208 struct ltt_event
*event
;
211 mutex_lock(&sessions_mutex
);
212 if (chan
->free_event_id
== -1UL)
215 * This is O(n^2) (for each event, the loop is called at event
216 * creation). Might require a hash if we have lots of events.
218 list_for_each_entry(event
, &chan
->session
->events
, list
)
219 if (!strcmp(event
->desc
->name
, name
))
221 event
= kmem_cache_zalloc(event_cache
, GFP_KERNEL
);
225 event
->filter
= filter
;
226 event
->id
= chan
->free_event_id
++;
227 event
->instrumentation
= event_param
->instrumentation
;
228 /* Populate ltt_event structure before tracepoint registration. */
230 switch (event_param
->instrumentation
) {
231 case LTTNG_KERNEL_TRACEPOINTS
:
232 event
->desc
= ltt_event_get(name
);
235 ret
= tracepoint_probe_register(name
,
236 event
->desc
->probe_callback
,
241 case LTTNG_KERNEL_KPROBES
:
242 ret
= lttng_kprobes_register(name
,
243 event_param
->u
.kprobe
.symbol_name
,
244 event_param
->u
.kprobe
.offset
,
245 event_param
->u
.kprobe
.addr
,
250 case LTTNG_KERNEL_FUNCTION_TRACER
:
251 ret
= lttng_ftrace_register(name
,
252 event_param
->u
.ftrace
.symbol_name
,
260 ret
= _ltt_event_metadata_statedump(chan
->session
, chan
, event
);
262 goto statedump_error
;
263 list_add(&event
->list
, &chan
->session
->events
);
264 mutex_unlock(&sessions_mutex
);
268 WARN_ON_ONCE(tracepoint_probe_unregister(name
,
269 event
->desc
->probe_callback
,
271 ltt_event_put(event
->desc
);
273 kmem_cache_free(event_cache
, event
);
277 mutex_unlock(&sessions_mutex
);
282 * Only used internally at session destruction.
284 int _ltt_event_unregister(struct ltt_event
*event
)
288 switch (event
->instrumentation
) {
289 case LTTNG_KERNEL_TRACEPOINTS
:
290 ret
= tracepoint_probe_unregister(event
->desc
->name
,
291 event
->desc
->probe_callback
,
295 ltt_event_put(event
->desc
);
297 case LTTNG_KERNEL_KPROBES
:
298 lttng_kprobes_unregister(event
);
301 case LTTNG_KERNEL_FUNCTION_TRACER
:
302 lttng_ftrace_unregister(event
);
312 * Used when an event FD is released.
314 int ltt_event_unregister(struct ltt_event
*event
)
318 mutex_lock(&sessions_mutex
);
319 ret
= ltt_event_unregister(event
);
320 mutex_unlock(&sessions_mutex
);
325 * Only used internally at session destruction.
328 void _ltt_event_destroy(struct ltt_event
*event
)
330 ltt_event_put(event
->desc
);
331 list_del(&event
->list
);
332 kmem_cache_free(event_cache
, event
);
336 * We have exclusive access to our metadata buffer (protected by the
337 * sessions_mutex), so we can do racy operations such as looking for
338 * remaining space left in packet and write, since mutual exclusion
339 * protects us from concurrent writes.
341 int lttng_metadata_printf(struct ltt_session
*session
,
342 const char *fmt
, ...)
344 struct lib_ring_buffer_ctx ctx
;
345 struct ltt_channel
*chan
= session
->metadata
;
347 int ret
= 0, waitret
;
348 size_t len
, reserve_len
, pos
;
351 WARN_ON_ONCE(!ACCESS_ONCE(session
->active
));
354 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
362 for (pos
= 0; pos
< len
; pos
+= reserve_len
) {
363 reserve_len
= min_t(size_t,
364 chan
->ops
->packet_avail_size(chan
->chan
),
366 lib_ring_buffer_ctx_init(&ctx
, chan
->chan
, NULL
, reserve_len
,
369 * We don't care about metadata buffer's records lost
370 * count, because we always retry here. Report error if
371 * we need to bail out after timeout or being
374 waitret
= wait_event_interruptible_timeout(*chan
->ops
->get_reader_wait_queue(chan
),
376 ret
= chan
->ops
->event_reserve(&ctx
);
377 ret
!= -ENOBUFS
|| !ret
;
379 msecs_to_jiffies(LTTNG_METADATA_TIMEOUT_MSEC
));
380 if (!waitret
|| waitret
== -ERESTARTSYS
|| ret
) {
381 printk(KERN_WARNING
"LTTng: Failure to write metadata to buffers (%s)\n",
382 waitret
== -ERESTARTSYS
? "interrupted" :
383 (ret
== -ENOBUFS
? "timeout" : "I/O error"));
384 if (waitret
== -ERESTARTSYS
)
388 chan
->ops
->event_write(&ctx
, &str
[pos
], len
);
389 chan
->ops
->event_commit(&ctx
);
397 int _ltt_fields_metadata_statedump(struct ltt_session
*session
,
398 struct ltt_event
*event
)
400 const struct lttng_event_desc
*desc
= event
->desc
;
404 for (i
= 0; i
< desc
->nr_fields
; i
++) {
405 const struct lttng_event_field
*field
= &desc
->fields
[i
];
407 switch (field
->type
.atype
) {
409 ret
= lttng_metadata_printf(session
,
410 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s;\n",
411 field
->type
.u
.basic
.integer
.size
,
412 field
->type
.u
.basic
.integer
.alignment
,
413 field
->type
.u
.basic
.integer
.signedness
,
414 (field
->type
.u
.basic
.integer
.encoding
== lttng_encode_none
)
416 : (field
->type
.u
.basic
.integer
.encoding
== lttng_encode_UTF8
)
419 field
->type
.u
.basic
.integer
.base
,
421 field
->type
.u
.basic
.integer
.reverse_byte_order
? " byte_order = le;" : "",
423 field
->type
.u
.basic
.integer
.reverse_byte_order
? " byte_order = be;" : "",
428 ret
= lttng_metadata_printf(session
,
430 field
->type
.u
.basic
.enumeration
.name
,
435 const struct lttng_basic_type
*elem_type
;
437 elem_type
= &field
->type
.u
.array
.elem_type
;
438 ret
= lttng_metadata_printf(session
,
439 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[%u];\n",
440 elem_type
->u
.basic
.integer
.size
,
441 elem_type
->u
.basic
.integer
.alignment
,
442 elem_type
->u
.basic
.integer
.signedness
,
443 (elem_type
->u
.basic
.integer
.encoding
== lttng_encode_none
)
445 : (elem_type
->u
.basic
.integer
.encoding
== lttng_encode_UTF8
)
448 elem_type
->u
.basic
.integer
.base
,
450 elem_type
->u
.basic
.integer
.reverse_byte_order
? " byte_order = le;" : "",
452 elem_type
->u
.basic
.integer
.reverse_byte_order
? " byte_order = be;" : "",
454 field
->name
, field
->type
.u
.array
.length
);
459 const struct lttng_basic_type
*elem_type
;
460 const struct lttng_basic_type
*length_type
;
462 elem_type
= &field
->type
.u
.sequence
.elem_type
;
463 length_type
= &field
->type
.u
.sequence
.length_type
;
464 ret
= lttng_metadata_printf(session
,
465 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
466 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[ __%s_length ];\n",
467 length_type
->u
.basic
.integer
.size
,
468 length_type
->u
.basic
.integer
.alignment
,
469 length_type
->u
.basic
.integer
.signedness
,
470 (length_type
->u
.basic
.integer
.encoding
== lttng_encode_none
)
472 : (length_type
->u
.basic
.integer
.encoding
== lttng_encode_UTF8
)
475 length_type
->u
.basic
.integer
.base
,
477 length_type
->u
.basic
.integer
.reverse_byte_order
? " byte_order = le;" : "",
479 length_type
->u
.basic
.integer
.reverse_byte_order
480 ? " byte_order = be;" : "",
483 elem_type
->u
.basic
.integer
.size
,
484 elem_type
->u
.basic
.integer
.alignment
,
485 elem_type
->u
.basic
.integer
.signedness
,
486 (elem_type
->u
.basic
.integer
.encoding
== lttng_encode_none
)
488 : (elem_type
->u
.basic
.integer
.encoding
== lttng_encode_UTF8
)
491 elem_type
->u
.basic
.integer
.base
,
493 elem_type
->u
.basic
.integer
.reverse_byte_order
? " byte_order = le;" : "",
495 elem_type
->u
.basic
.integer
.reverse_byte_order
? " byte_order = be;" : "",
504 /* Default encoding is UTF8 */
505 ret
= lttng_metadata_printf(session
,
507 field
->type
.u
.basic
.string
.encoding
== lttng_encode_ASCII
?
508 " { encoding = ASCII; }" : "",
520 int _ltt_event_metadata_statedump(struct ltt_session
*session
,
521 struct ltt_channel
*chan
,
522 struct ltt_event
*event
)
526 if (event
->metadata_dumped
|| !ACCESS_ONCE(session
->active
))
528 if (chan
== session
->metadata
)
531 ret
= lttng_metadata_printf(session
,
536 " event.fields := struct {\n",
543 ret
= _ltt_fields_metadata_statedump(session
, event
);
548 * LTTng space reservation can only reserve multiples of the
551 ret
= lttng_metadata_printf(session
,
560 event
->metadata_dumped
= 1;
567 int _ltt_channel_metadata_statedump(struct ltt_session
*session
,
568 struct ltt_channel
*chan
)
572 if (chan
->metadata_dumped
|| !ACCESS_ONCE(session
->active
))
574 if (chan
== session
->metadata
)
577 WARN_ON_ONCE(!chan
->header_type
);
578 ret
= lttng_metadata_printf(session
,
581 " event.header := %s;\n"
582 " packet.context := struct packet_context;\n"
585 chan
->header_type
== 1 ? "struct event_header_compact" :
586 "struct event_header_large");
590 chan
->metadata_dumped
= 1;
596 int _ltt_stream_packet_context_declare(struct ltt_session
*session
)
598 return lttng_metadata_printf(session
,
599 "struct packet_context {\n"
600 " uint64_t timestamp_begin;\n"
601 " uint64_t timestamp_end;\n"
602 " uint32_t events_discarded;\n"
603 " uint32_t content_size;\n"
604 " uint32_t packet_size;\n"
605 " uint32_t cpu_id;\n"
613 * id 31 is reserved to indicate an extended header.
616 * id: range: 0 - 65534.
617 * id 65535 is reserved to indicate an extended header.
620 int _ltt_event_header_declare(struct ltt_session
*session
)
622 return lttng_metadata_printf(session
,
623 "struct event_header_compact {\n"
624 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
627 " uint27_t timestamp;\n"
631 " uint64_t timestamp;\n"
636 "struct event_header_large {\n"
637 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
640 " uint32_t timestamp;\n"
644 " uint64_t timestamp;\n"
648 ltt_alignof(uint32_t) * CHAR_BIT
,
649 ltt_alignof(uint16_t) * CHAR_BIT
654 * Output metadata into this session's metadata buffers.
657 int _ltt_session_metadata_statedump(struct ltt_session
*session
)
660 struct ltt_channel
*chan
;
661 struct ltt_event
*event
;
664 if (!ACCESS_ONCE(session
->active
))
666 if (session
->metadata_dumped
)
668 if (!session
->metadata
) {
669 printk(KERN_WARNING
"LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n");
673 snprintf(uuid_s
, sizeof(uuid_s
),
674 "%x%x%x%x-%x%x-%x%x-%x%x-%x%x%x%x%x%x",
675 uuid_s
[0], uuid_s
[1], uuid_s
[2], uuid_s
[3],
676 uuid_s
[4], uuid_s
[5], uuid_s
[6], uuid_s
[7],
677 uuid_s
[8], uuid_s
[9], uuid_s
[10], uuid_s
[11],
678 uuid_s
[12], uuid_s
[13], uuid_s
[14], uuid_s
[15]);
680 ret
= lttng_metadata_printf(session
,
681 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
682 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
683 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
684 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
685 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
686 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
692 " byte_order = %s;\n"
693 " packet.header := struct {\n"
695 " uint8_t uuid[16];\n"
696 " uint32_t stream_id;\n"
699 ltt_alignof(uint8_t) * CHAR_BIT
,
700 ltt_alignof(uint32_t) * CHAR_BIT
,
701 ltt_alignof(uint64_t) * CHAR_BIT
,
714 ret
= _ltt_stream_packet_context_declare(session
);
718 ret
= _ltt_event_header_declare(session
);
723 list_for_each_entry(chan
, &session
->chan
, list
) {
724 ret
= _ltt_channel_metadata_statedump(session
, chan
);
729 list_for_each_entry(event
, &session
->events
, list
) {
730 ret
= _ltt_event_metadata_statedump(session
, chan
, event
);
734 session
->metadata_dumped
= 1;
740 * ltt_transport_register - LTT transport registration
741 * @transport: transport structure
743 * Registers a transport which can be used as output to extract the data out of
744 * LTTng. The module calling this registration function must ensure that no
745 * trap-inducing code will be executed by the transport functions. E.g.
746 * vmalloc_sync_all() must be called between a vmalloc and the moment the memory
747 * is made visible to the transport function. This registration acts as a
748 * vmalloc_sync_all. Therefore, only if the module allocates virtual memory
749 * after its registration must it synchronize the TLBs.
751 void ltt_transport_register(struct ltt_transport
*transport
)
754 * Make sure no page fault can be triggered by the module about to be
755 * registered. We deal with this here so we don't have to call
756 * vmalloc_sync_all() in each module's init.
758 wrapper_vmalloc_sync_all();
760 mutex_lock(&sessions_mutex
);
761 list_add_tail(&transport
->node
, <t_transport_list
);
762 mutex_unlock(&sessions_mutex
);
764 EXPORT_SYMBOL_GPL(ltt_transport_register
);
767 * ltt_transport_unregister - LTT transport unregistration
768 * @transport: transport structure
770 void ltt_transport_unregister(struct ltt_transport
*transport
)
772 mutex_lock(&sessions_mutex
);
773 list_del(&transport
->node
);
774 mutex_unlock(&sessions_mutex
);
776 EXPORT_SYMBOL_GPL(ltt_transport_unregister
);
778 static int __init
ltt_events_init(void)
782 event_cache
= KMEM_CACHE(ltt_event
, 0);
785 ret
= ltt_debugfs_abi_init();
790 kmem_cache_destroy(event_cache
);
794 module_init(ltt_events_init
);
796 static void __exit
ltt_events_exit(void)
798 struct ltt_session
*session
, *tmpsession
;
800 ltt_debugfs_abi_exit();
801 list_for_each_entry_safe(session
, tmpsession
, &sessions
, list
)
802 ltt_session_destroy(session
);
803 kmem_cache_destroy(event_cache
);
806 module_exit(ltt_events_exit
);
808 MODULE_LICENSE("GPL and additional rights");
809 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
810 MODULE_DESCRIPTION("LTTng Events");