1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * This page_alloc.h wrapper needs to be included before gfpflags.h because it
12 * overrides a function with a define.
14 #include "wrapper/page_alloc.h"
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/jiffies.h>
21 #include <linux/utsname.h>
22 #include <linux/err.h>
23 #include <linux/seq_file.h>
24 #include <linux/file.h>
25 #include <linux/anon_inodes.h>
26 #include <wrapper/file.h>
27 #include <linux/uaccess.h>
28 #include <linux/vmalloc.h>
29 #include <linux/dmi.h>
31 #include <wrapper/uuid.h>
32 #include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */
33 #include <wrapper/random.h>
34 #include <wrapper/tracepoint.h>
35 #include <wrapper/list.h>
36 #include <wrapper/types.h>
37 #include <lttng/kernel-version.h>
38 #include <lttng/events.h>
39 #include <lttng/tracer.h>
40 #include <lttng/event-notifier-notification.h>
41 #include <lttng/abi-old.h>
42 #include <lttng/endian.h>
43 #include <lttng/string-utils.h>
44 #include <lttng/utils.h>
45 #include <ringbuffer/backend.h>
46 #include <ringbuffer/frontend.h>
47 #include <wrapper/time.h>
49 #define METADATA_CACHE_DEFAULT_SIZE 4096
51 static LIST_HEAD(sessions
);
52 static LIST_HEAD(event_notifier_groups
);
53 static LIST_HEAD(lttng_transport_list
);
55 * Protect the sessions and metadata caches.
57 static DEFINE_MUTEX(sessions_mutex
);
58 static struct kmem_cache
*event_cache
;
59 static struct kmem_cache
*event_notifier_cache
;
61 static void lttng_session_lazy_sync_event_enablers(struct lttng_session
*session
);
62 static void lttng_session_sync_event_enablers(struct lttng_session
*session
);
63 static void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
);
64 static void lttng_event_notifier_enabler_destroy(struct lttng_event_notifier_enabler
*event_notifier_enabler
);
65 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
);
67 static void _lttng_event_destroy(struct lttng_event
*event
);
68 static void _lttng_event_notifier_destroy(struct lttng_event_notifier
*event_notifier
);
69 static void _lttng_channel_destroy(struct lttng_channel
*chan
);
70 static int _lttng_event_unregister(struct lttng_event
*event
);
71 static int _lttng_event_notifier_unregister(struct lttng_event_notifier
*event_notifier
);
73 int _lttng_event_metadata_statedump(struct lttng_session
*session
,
74 struct lttng_channel
*chan
,
75 struct lttng_event
*event
);
77 int _lttng_session_metadata_statedump(struct lttng_session
*session
);
79 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
);
81 int _lttng_type_statedump(struct lttng_session
*session
,
82 const struct lttng_type
*type
,
85 int _lttng_field_statedump(struct lttng_session
*session
,
86 const struct lttng_event_field
*field
,
89 void synchronize_trace(void)
91 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5,1,0))
97 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0))
98 #ifdef CONFIG_PREEMPT_RT_FULL
101 #else /* (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0)) */
102 #ifdef CONFIG_PREEMPT_RT
105 #endif /* (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0)) */
108 void lttng_lock_sessions(void)
110 mutex_lock(&sessions_mutex
);
113 void lttng_unlock_sessions(void)
115 mutex_unlock(&sessions_mutex
);
118 static struct lttng_transport
*lttng_transport_find(const char *name
)
120 struct lttng_transport
*transport
;
122 list_for_each_entry(transport
, <tng_transport_list
, node
) {
123 if (!strcmp(transport
->name
, name
))
130 * Called with sessions lock held.
132 int lttng_session_active(void)
134 struct lttng_session
*iter
;
136 list_for_each_entry(iter
, &sessions
, list
) {
143 struct lttng_session
*lttng_session_create(void)
145 struct lttng_session
*session
;
146 struct lttng_metadata_cache
*metadata_cache
;
149 mutex_lock(&sessions_mutex
);
150 session
= lttng_kvzalloc(sizeof(struct lttng_session
), GFP_KERNEL
);
153 INIT_LIST_HEAD(&session
->chan
);
154 INIT_LIST_HEAD(&session
->events
);
155 lttng_guid_gen(&session
->uuid
);
157 metadata_cache
= kzalloc(sizeof(struct lttng_metadata_cache
),
160 goto err_free_session
;
161 metadata_cache
->data
= vzalloc(METADATA_CACHE_DEFAULT_SIZE
);
162 if (!metadata_cache
->data
)
164 metadata_cache
->cache_alloc
= METADATA_CACHE_DEFAULT_SIZE
;
165 kref_init(&metadata_cache
->refcount
);
166 mutex_init(&metadata_cache
->lock
);
167 session
->metadata_cache
= metadata_cache
;
168 INIT_LIST_HEAD(&metadata_cache
->metadata_stream
);
169 memcpy(&metadata_cache
->uuid
, &session
->uuid
,
170 sizeof(metadata_cache
->uuid
));
171 INIT_LIST_HEAD(&session
->enablers_head
);
172 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
173 INIT_HLIST_HEAD(&session
->events_ht
.table
[i
]);
174 list_add(&session
->list
, &sessions
);
175 session
->pid_tracker
.session
= session
;
176 session
->pid_tracker
.tracker_type
= TRACKER_PID
;
177 session
->vpid_tracker
.session
= session
;
178 session
->vpid_tracker
.tracker_type
= TRACKER_VPID
;
179 session
->uid_tracker
.session
= session
;
180 session
->uid_tracker
.tracker_type
= TRACKER_UID
;
181 session
->vuid_tracker
.session
= session
;
182 session
->vuid_tracker
.tracker_type
= TRACKER_VUID
;
183 session
->gid_tracker
.session
= session
;
184 session
->gid_tracker
.tracker_type
= TRACKER_GID
;
185 session
->vgid_tracker
.session
= session
;
186 session
->vgid_tracker
.tracker_type
= TRACKER_VGID
;
187 mutex_unlock(&sessions_mutex
);
191 kfree(metadata_cache
);
193 lttng_kvfree(session
);
195 mutex_unlock(&sessions_mutex
);
199 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
201 struct lttng_transport
*transport
= NULL
;
202 struct lttng_event_notifier_group
*event_notifier_group
;
203 const char *transport_name
= "relay-event-notifier";
204 size_t subbuf_size
= 4096; //TODO
205 size_t num_subbuf
= 16; //TODO
206 unsigned int switch_timer_interval
= 0;
207 unsigned int read_timer_interval
= 0;
210 mutex_lock(&sessions_mutex
);
212 transport
= lttng_transport_find(transport_name
);
214 printk(KERN_WARNING
"LTTng: transport %s not found\n",
218 if (!try_module_get(transport
->owner
)) {
219 printk(KERN_WARNING
"LTTng: Can't lock transport %s module.\n",
224 event_notifier_group
= lttng_kvzalloc(sizeof(struct lttng_event_notifier_group
),
226 if (!event_notifier_group
)
230 * Initialize the ring buffer used to store event notifier
233 event_notifier_group
->ops
= &transport
->ops
;
234 event_notifier_group
->chan
= transport
->ops
.channel_create(
235 transport_name
, event_notifier_group
, NULL
,
236 subbuf_size
, num_subbuf
, switch_timer_interval
,
237 read_timer_interval
);
238 if (!event_notifier_group
->chan
)
241 event_notifier_group
->transport
= transport
;
243 INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
244 INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
245 for (i
= 0; i
< LTTNG_EVENT_NOTIFIER_HT_SIZE
; i
++)
246 INIT_HLIST_HEAD(&event_notifier_group
->event_notifiers_ht
.table
[i
]);
248 list_add(&event_notifier_group
->node
, &event_notifier_groups
);
250 mutex_unlock(&sessions_mutex
);
252 return event_notifier_group
;
255 lttng_kvfree(event_notifier_group
);
258 module_put(transport
->owner
);
260 mutex_unlock(&sessions_mutex
);
264 void metadata_cache_destroy(struct kref
*kref
)
266 struct lttng_metadata_cache
*cache
=
267 container_of(kref
, struct lttng_metadata_cache
, refcount
);
272 void lttng_session_destroy(struct lttng_session
*session
)
274 struct lttng_channel
*chan
, *tmpchan
;
275 struct lttng_event
*event
, *tmpevent
;
276 struct lttng_metadata_stream
*metadata_stream
;
277 struct lttng_event_enabler
*event_enabler
, *tmp_event_enabler
;
280 mutex_lock(&sessions_mutex
);
281 WRITE_ONCE(session
->active
, 0);
282 list_for_each_entry(chan
, &session
->chan
, list
) {
283 ret
= lttng_syscalls_unregister_event(chan
);
286 list_for_each_entry(event
, &session
->events
, list
) {
287 ret
= _lttng_event_unregister(event
);
290 synchronize_trace(); /* Wait for in-flight events to complete */
291 list_for_each_entry(chan
, &session
->chan
, list
) {
292 ret
= lttng_syscalls_destroy_event(chan
);
295 list_for_each_entry_safe(event_enabler
, tmp_event_enabler
,
296 &session
->enablers_head
, node
)
297 lttng_event_enabler_destroy(event_enabler
);
298 list_for_each_entry_safe(event
, tmpevent
, &session
->events
, list
)
299 _lttng_event_destroy(event
);
300 list_for_each_entry_safe(chan
, tmpchan
, &session
->chan
, list
) {
301 BUG_ON(chan
->channel_type
== METADATA_CHANNEL
);
302 _lttng_channel_destroy(chan
);
304 mutex_lock(&session
->metadata_cache
->lock
);
305 list_for_each_entry(metadata_stream
, &session
->metadata_cache
->metadata_stream
, list
)
306 _lttng_metadata_channel_hangup(metadata_stream
);
307 mutex_unlock(&session
->metadata_cache
->lock
);
308 lttng_id_tracker_destroy(&session
->pid_tracker
, false);
309 lttng_id_tracker_destroy(&session
->vpid_tracker
, false);
310 lttng_id_tracker_destroy(&session
->uid_tracker
, false);
311 lttng_id_tracker_destroy(&session
->vuid_tracker
, false);
312 lttng_id_tracker_destroy(&session
->gid_tracker
, false);
313 lttng_id_tracker_destroy(&session
->vgid_tracker
, false);
314 kref_put(&session
->metadata_cache
->refcount
, metadata_cache_destroy
);
315 list_del(&session
->list
);
316 mutex_unlock(&sessions_mutex
);
317 lttng_kvfree(session
);
320 void lttng_event_notifier_group_destroy(
321 struct lttng_event_notifier_group
*event_notifier_group
)
323 struct lttng_event_notifier_enabler
*event_notifier_enabler
, *tmp_event_notifier_enabler
;
324 struct lttng_event_notifier
*event_notifier
, *tmpevent_notifier
;
327 if (!event_notifier_group
)
330 mutex_lock(&sessions_mutex
);
332 ret
= lttng_syscalls_unregister_event_notifier(event_notifier_group
);
335 list_for_each_entry_safe(event_notifier
, tmpevent_notifier
,
336 &event_notifier_group
->event_notifiers_head
, list
) {
337 ret
= _lttng_event_notifier_unregister(event_notifier
);
341 /* Wait for in-flight event notifier to complete */
344 irq_work_sync(&event_notifier_group
->wakeup_pending
);
346 kfree(event_notifier_group
->sc_filter
);
348 list_for_each_entry_safe(event_notifier_enabler
, tmp_event_notifier_enabler
,
349 &event_notifier_group
->enablers_head
, node
)
350 lttng_event_notifier_enabler_destroy(event_notifier_enabler
);
352 list_for_each_entry_safe(event_notifier
, tmpevent_notifier
,
353 &event_notifier_group
->event_notifiers_head
, list
)
354 _lttng_event_notifier_destroy(event_notifier
);
356 event_notifier_group
->ops
->channel_destroy(event_notifier_group
->chan
);
357 module_put(event_notifier_group
->transport
->owner
);
358 list_del(&event_notifier_group
->node
);
360 mutex_unlock(&sessions_mutex
);
361 lttng_kvfree(event_notifier_group
);
364 int lttng_session_statedump(struct lttng_session
*session
)
368 mutex_lock(&sessions_mutex
);
369 ret
= lttng_statedump_start(session
);
370 mutex_unlock(&sessions_mutex
);
374 int lttng_session_enable(struct lttng_session
*session
)
377 struct lttng_channel
*chan
;
379 mutex_lock(&sessions_mutex
);
380 if (session
->active
) {
385 /* Set transient enabler state to "enabled" */
388 /* We need to sync enablers with session before activation. */
389 lttng_session_sync_event_enablers(session
);
392 * Snapshot the number of events per channel to know the type of header
395 list_for_each_entry(chan
, &session
->chan
, list
) {
396 if (chan
->header_type
)
397 continue; /* don't change it if session stop/restart */
398 if (chan
->free_event_id
< 31)
399 chan
->header_type
= 1; /* compact */
401 chan
->header_type
= 2; /* large */
404 /* Clear each stream's quiescent state. */
405 list_for_each_entry(chan
, &session
->chan
, list
) {
406 if (chan
->channel_type
!= METADATA_CHANNEL
)
407 lib_ring_buffer_clear_quiescent_channel(chan
->chan
);
410 WRITE_ONCE(session
->active
, 1);
411 WRITE_ONCE(session
->been_active
, 1);
412 ret
= _lttng_session_metadata_statedump(session
);
414 WRITE_ONCE(session
->active
, 0);
417 ret
= lttng_statedump_start(session
);
419 WRITE_ONCE(session
->active
, 0);
421 mutex_unlock(&sessions_mutex
);
425 int lttng_session_disable(struct lttng_session
*session
)
428 struct lttng_channel
*chan
;
430 mutex_lock(&sessions_mutex
);
431 if (!session
->active
) {
435 WRITE_ONCE(session
->active
, 0);
437 /* Set transient enabler state to "disabled" */
439 lttng_session_sync_event_enablers(session
);
441 /* Set each stream's quiescent state. */
442 list_for_each_entry(chan
, &session
->chan
, list
) {
443 if (chan
->channel_type
!= METADATA_CHANNEL
)
444 lib_ring_buffer_set_quiescent_channel(chan
->chan
);
447 mutex_unlock(&sessions_mutex
);
451 int lttng_session_metadata_regenerate(struct lttng_session
*session
)
454 struct lttng_channel
*chan
;
455 struct lttng_event
*event
;
456 struct lttng_metadata_cache
*cache
= session
->metadata_cache
;
457 struct lttng_metadata_stream
*stream
;
459 mutex_lock(&sessions_mutex
);
460 if (!session
->active
) {
465 mutex_lock(&cache
->lock
);
466 memset(cache
->data
, 0, cache
->cache_alloc
);
467 cache
->metadata_written
= 0;
469 list_for_each_entry(stream
, &session
->metadata_cache
->metadata_stream
, list
) {
470 stream
->metadata_out
= 0;
471 stream
->metadata_in
= 0;
473 mutex_unlock(&cache
->lock
);
475 session
->metadata_dumped
= 0;
476 list_for_each_entry(chan
, &session
->chan
, list
) {
477 chan
->metadata_dumped
= 0;
480 list_for_each_entry(event
, &session
->events
, list
) {
481 event
->metadata_dumped
= 0;
484 ret
= _lttng_session_metadata_statedump(session
);
487 mutex_unlock(&sessions_mutex
);
491 int lttng_channel_enable(struct lttng_channel
*channel
)
495 mutex_lock(&sessions_mutex
);
496 if (channel
->channel_type
== METADATA_CHANNEL
) {
500 if (channel
->enabled
) {
504 /* Set transient enabler state to "enabled" */
506 lttng_session_sync_event_enablers(channel
->session
);
507 /* Set atomically the state to "enabled" */
508 WRITE_ONCE(channel
->enabled
, 1);
510 mutex_unlock(&sessions_mutex
);
514 int lttng_channel_disable(struct lttng_channel
*channel
)
518 mutex_lock(&sessions_mutex
);
519 if (channel
->channel_type
== METADATA_CHANNEL
) {
523 if (!channel
->enabled
) {
527 /* Set atomically the state to "disabled" */
528 WRITE_ONCE(channel
->enabled
, 0);
529 /* Set transient enabler state to "enabled" */
531 lttng_session_sync_event_enablers(channel
->session
);
533 mutex_unlock(&sessions_mutex
);
537 int lttng_event_enable(struct lttng_event
*event
)
541 mutex_lock(&sessions_mutex
);
542 if (event
->chan
->channel_type
== METADATA_CHANNEL
) {
546 if (event
->enabled
) {
550 switch (event
->instrumentation
) {
551 case LTTNG_KERNEL_TRACEPOINT
:
552 case LTTNG_KERNEL_SYSCALL
:
555 case LTTNG_KERNEL_KPROBE
:
556 case LTTNG_KERNEL_UPROBE
:
557 case LTTNG_KERNEL_NOOP
:
558 WRITE_ONCE(event
->enabled
, 1);
560 case LTTNG_KERNEL_KRETPROBE
:
561 ret
= lttng_kretprobes_event_enable_state(event
, 1);
563 case LTTNG_KERNEL_FUNCTION
: /* Fall-through. */
569 mutex_unlock(&sessions_mutex
);
573 int lttng_event_disable(struct lttng_event
*event
)
577 mutex_lock(&sessions_mutex
);
578 if (event
->chan
->channel_type
== METADATA_CHANNEL
) {
582 if (!event
->enabled
) {
586 switch (event
->instrumentation
) {
587 case LTTNG_KERNEL_TRACEPOINT
:
588 case LTTNG_KERNEL_SYSCALL
:
591 case LTTNG_KERNEL_KPROBE
:
592 case LTTNG_KERNEL_UPROBE
:
593 case LTTNG_KERNEL_NOOP
:
594 WRITE_ONCE(event
->enabled
, 0);
596 case LTTNG_KERNEL_KRETPROBE
:
597 ret
= lttng_kretprobes_event_enable_state(event
, 0);
599 case LTTNG_KERNEL_FUNCTION
: /* Fall-through. */
605 mutex_unlock(&sessions_mutex
);
609 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
)
613 mutex_lock(&sessions_mutex
);
614 if (event_notifier
->enabled
) {
618 switch (event_notifier
->instrumentation
) {
619 case LTTNG_KERNEL_TRACEPOINT
:
620 case LTTNG_KERNEL_SYSCALL
:
623 case LTTNG_KERNEL_KPROBE
:
624 case LTTNG_KERNEL_UPROBE
:
625 WRITE_ONCE(event_notifier
->enabled
, 1);
627 case LTTNG_KERNEL_FUNCTION
:
628 case LTTNG_KERNEL_NOOP
:
629 case LTTNG_KERNEL_KRETPROBE
:
635 mutex_unlock(&sessions_mutex
);
639 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
)
643 mutex_lock(&sessions_mutex
);
644 if (!event_notifier
->enabled
) {
648 switch (event_notifier
->instrumentation
) {
649 case LTTNG_KERNEL_TRACEPOINT
:
650 case LTTNG_KERNEL_SYSCALL
:
653 case LTTNG_KERNEL_KPROBE
:
654 case LTTNG_KERNEL_UPROBE
:
655 WRITE_ONCE(event_notifier
->enabled
, 0);
657 case LTTNG_KERNEL_FUNCTION
:
658 case LTTNG_KERNEL_NOOP
:
659 case LTTNG_KERNEL_KRETPROBE
:
665 mutex_unlock(&sessions_mutex
);
669 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
670 const char *transport_name
,
672 size_t subbuf_size
, size_t num_subbuf
,
673 unsigned int switch_timer_interval
,
674 unsigned int read_timer_interval
,
675 enum channel_type channel_type
)
677 struct lttng_channel
*chan
;
678 struct lttng_transport
*transport
= NULL
;
680 mutex_lock(&sessions_mutex
);
681 if (session
->been_active
&& channel_type
!= METADATA_CHANNEL
)
682 goto active
; /* Refuse to add channel to active session */
683 transport
= lttng_transport_find(transport_name
);
685 printk(KERN_WARNING
"LTTng: transport %s not found\n",
689 if (!try_module_get(transport
->owner
)) {
690 printk(KERN_WARNING
"LTTng: Can't lock transport module.\n");
693 chan
= kzalloc(sizeof(struct lttng_channel
), GFP_KERNEL
);
696 chan
->session
= session
;
697 chan
->id
= session
->free_chan_id
++;
698 chan
->ops
= &transport
->ops
;
700 * Note: the channel creation op already writes into the packet
701 * headers. Therefore the "chan" information used as input
702 * should be already accessible.
704 chan
->chan
= transport
->ops
.channel_create(transport_name
,
705 chan
, buf_addr
, subbuf_size
, num_subbuf
,
706 switch_timer_interval
, read_timer_interval
);
711 chan
->transport
= transport
;
712 chan
->channel_type
= channel_type
;
713 list_add(&chan
->list
, &session
->chan
);
714 mutex_unlock(&sessions_mutex
);
721 module_put(transport
->owner
);
724 mutex_unlock(&sessions_mutex
);
729 * Only used internally at session destruction for per-cpu channels, and
730 * when metadata channel is released.
731 * Needs to be called with sessions mutex held.
734 void _lttng_channel_destroy(struct lttng_channel
*chan
)
736 chan
->ops
->channel_destroy(chan
->chan
);
737 module_put(chan
->transport
->owner
);
738 list_del(&chan
->list
);
739 lttng_destroy_context(chan
->ctx
);
743 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
)
745 BUG_ON(chan
->channel_type
!= METADATA_CHANNEL
);
747 /* Protect the metadata cache with the sessions_mutex. */
748 mutex_lock(&sessions_mutex
);
749 _lttng_channel_destroy(chan
);
750 mutex_unlock(&sessions_mutex
);
752 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy
);
755 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
)
757 stream
->finalized
= 1;
758 wake_up_interruptible(&stream
->read_wait
);
762 * Supports event creation while tracing session is active.
763 * Needs to be called with sessions mutex held.
765 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
766 struct lttng_kernel_event
*event_param
,
768 const struct lttng_event_desc
*event_desc
,
769 enum lttng_kernel_instrumentation itype
)
771 struct lttng_session
*session
= chan
->session
;
772 struct lttng_event
*event
;
773 const char *event_name
;
774 struct hlist_head
*head
;
777 if (chan
->free_event_id
== -1U) {
783 case LTTNG_KERNEL_TRACEPOINT
:
784 event_name
= event_desc
->name
;
786 case LTTNG_KERNEL_KPROBE
:
787 case LTTNG_KERNEL_UPROBE
:
788 case LTTNG_KERNEL_KRETPROBE
:
789 case LTTNG_KERNEL_NOOP
:
790 case LTTNG_KERNEL_SYSCALL
:
791 event_name
= event_param
->name
;
793 case LTTNG_KERNEL_FUNCTION
: /* Fall-through. */
800 head
= utils_borrow_hash_table_bucket(session
->events_ht
.table
,
801 LTTNG_EVENT_HT_SIZE
, event_name
);
802 lttng_hlist_for_each_entry(event
, head
, hlist
) {
803 WARN_ON_ONCE(!event
->desc
);
804 if (!strncmp(event
->desc
->name
, event_name
,
805 LTTNG_KERNEL_SYM_NAME_LEN
- 1)
806 && chan
== event
->chan
) {
812 event
= kmem_cache_zalloc(event_cache
, GFP_KERNEL
);
818 event
->filter
= filter
;
819 event
->id
= chan
->free_event_id
++;
820 event
->instrumentation
= itype
;
821 event
->evtype
= LTTNG_TYPE_EVENT
;
822 INIT_LIST_HEAD(&event
->filter_bytecode_runtime_head
);
823 INIT_LIST_HEAD(&event
->enablers_ref_head
);
826 case LTTNG_KERNEL_TRACEPOINT
:
827 /* Event will be enabled by enabler sync. */
829 event
->registered
= 0;
830 event
->desc
= lttng_event_desc_get(event_name
);
835 /* Populate lttng_event structure before event registration. */
838 case LTTNG_KERNEL_KPROBE
:
840 * Needs to be explicitly enabled after creation, since
841 * we may want to apply filters.
844 event
->registered
= 1;
846 * Populate lttng_event structure before event
850 ret
= lttng_kprobes_register_event(event_name
,
851 event_param
->u
.kprobe
.symbol_name
,
852 event_param
->u
.kprobe
.offset
,
853 event_param
->u
.kprobe
.addr
,
859 ret
= try_module_get(event
->desc
->owner
);
862 case LTTNG_KERNEL_KRETPROBE
:
864 struct lttng_event
*event_return
;
866 /* kretprobe defines 2 events */
868 * Needs to be explicitly enabled after creation, since
869 * we may want to apply filters.
872 event
->registered
= 1;
874 kmem_cache_zalloc(event_cache
, GFP_KERNEL
);
879 event_return
->chan
= chan
;
880 event_return
->filter
= filter
;
881 event_return
->id
= chan
->free_event_id
++;
882 event_return
->enabled
= 0;
883 event_return
->registered
= 1;
884 event_return
->instrumentation
= itype
;
886 * Populate lttng_event structure before kretprobe registration.
889 ret
= lttng_kretprobes_register(event_name
,
890 event_param
->u
.kretprobe
.symbol_name
,
891 event_param
->u
.kretprobe
.offset
,
892 event_param
->u
.kretprobe
.addr
,
893 event
, event_return
);
895 kmem_cache_free(event_cache
, event_return
);
899 /* Take 2 refs on the module: one per event. */
900 ret
= try_module_get(event
->desc
->owner
);
902 ret
= try_module_get(event
->desc
->owner
);
904 ret
= _lttng_event_metadata_statedump(chan
->session
, chan
,
906 WARN_ON_ONCE(ret
> 0);
908 kmem_cache_free(event_cache
, event_return
);
909 module_put(event
->desc
->owner
);
910 module_put(event
->desc
->owner
);
911 goto statedump_error
;
913 list_add(&event_return
->list
, &chan
->session
->events
);
916 case LTTNG_KERNEL_NOOP
:
917 case LTTNG_KERNEL_SYSCALL
:
919 * Needs to be explicitly enabled after creation, since
920 * we may want to apply filters.
923 event
->registered
= 0;
924 event
->desc
= event_desc
;
925 switch (event_param
->u
.syscall
.entryexit
) {
926 case LTTNG_KERNEL_SYSCALL_ENTRYEXIT
:
929 case LTTNG_KERNEL_SYSCALL_ENTRY
:
930 event
->u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
932 case LTTNG_KERNEL_SYSCALL_EXIT
:
933 event
->u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
936 switch (event_param
->u
.syscall
.abi
) {
937 case LTTNG_KERNEL_SYSCALL_ABI_ALL
:
940 case LTTNG_KERNEL_SYSCALL_ABI_NATIVE
:
941 event
->u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
943 case LTTNG_KERNEL_SYSCALL_ABI_COMPAT
:
944 event
->u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
952 case LTTNG_KERNEL_UPROBE
:
954 * Needs to be explicitly enabled after creation, since
955 * we may want to apply filters.
958 event
->registered
= 1;
961 * Populate lttng_event structure before event
966 ret
= lttng_uprobes_register_event(event_param
->name
,
967 event_param
->u
.uprobe
.fd
,
971 ret
= try_module_get(event
->desc
->owner
);
974 case LTTNG_KERNEL_FUNCTION
: /* Fall-through */
980 ret
= _lttng_event_metadata_statedump(chan
->session
, chan
, event
);
981 WARN_ON_ONCE(ret
> 0);
983 goto statedump_error
;
985 hlist_add_head(&event
->hlist
, head
);
986 list_add(&event
->list
, &chan
->session
->events
);
990 /* If a statedump error occurs, events will not be readable. */
992 kmem_cache_free(event_cache
, event
);
1000 struct lttng_event_notifier
*_lttng_event_notifier_create(
1001 const struct lttng_event_desc
*event_desc
,
1002 uint64_t token
, struct lttng_event_notifier_group
*event_notifier_group
,
1003 struct lttng_kernel_event_notifier
*event_notifier_param
,
1004 void *filter
, enum lttng_kernel_instrumentation itype
)
1006 struct lttng_event_notifier
*event_notifier
;
1007 const char *event_name
;
1008 struct hlist_head
*head
;
1012 case LTTNG_KERNEL_TRACEPOINT
:
1013 event_name
= event_desc
->name
;
1015 case LTTNG_KERNEL_KPROBE
:
1016 case LTTNG_KERNEL_UPROBE
:
1017 case LTTNG_KERNEL_SYSCALL
:
1018 event_name
= event_notifier_param
->event
.name
;
1020 case LTTNG_KERNEL_KRETPROBE
:
1021 case LTTNG_KERNEL_FUNCTION
:
1022 case LTTNG_KERNEL_NOOP
:
1029 head
= utils_borrow_hash_table_bucket(event_notifier_group
->event_notifiers_ht
.table
,
1030 LTTNG_EVENT_NOTIFIER_HT_SIZE
, event_name
);
1031 lttng_hlist_for_each_entry(event_notifier
, head
, hlist
) {
1032 WARN_ON_ONCE(!event_notifier
->desc
);
1033 if (!strncmp(event_notifier
->desc
->name
, event_name
,
1034 LTTNG_KERNEL_SYM_NAME_LEN
- 1)
1035 && event_notifier_group
== event_notifier
->group
1036 && token
== event_notifier
->user_token
) {
1042 event_notifier
= kmem_cache_zalloc(event_notifier_cache
, GFP_KERNEL
);
1043 if (!event_notifier
) {
1048 event_notifier
->group
= event_notifier_group
;
1049 event_notifier
->user_token
= token
;
1050 event_notifier
->filter
= filter
;
1051 event_notifier
->instrumentation
= itype
;
1052 event_notifier
->evtype
= LTTNG_TYPE_EVENT
;
1053 event_notifier
->send_notification
= lttng_event_notifier_notification_send
;
1054 INIT_LIST_HEAD(&event_notifier
->filter_bytecode_runtime_head
);
1055 INIT_LIST_HEAD(&event_notifier
->enablers_ref_head
);
1058 case LTTNG_KERNEL_TRACEPOINT
:
1059 /* Event will be enabled by enabler sync. */
1060 event_notifier
->enabled
= 0;
1061 event_notifier
->registered
= 0;
1062 event_notifier
->desc
= lttng_event_desc_get(event_name
);
1063 if (!event_notifier
->desc
) {
1065 goto register_error
;
1067 /* Populate lttng_event_notifier structure before event registration. */
1070 case LTTNG_KERNEL_KPROBE
:
1072 * Needs to be explicitly enabled after creation, since
1073 * we may want to apply filters.
1075 event_notifier
->enabled
= 0;
1076 event_notifier
->registered
= 1;
1078 * Populate lttng_event_notifier structure before event
1082 ret
= lttng_kprobes_register_event_notifier(
1083 event_notifier_param
->event
.u
.kprobe
.symbol_name
,
1084 event_notifier_param
->event
.u
.kprobe
.offset
,
1085 event_notifier_param
->event
.u
.kprobe
.addr
,
1089 goto register_error
;
1091 ret
= try_module_get(event_notifier
->desc
->owner
);
1094 case LTTNG_KERNEL_NOOP
:
1095 case LTTNG_KERNEL_SYSCALL
:
1097 * Needs to be explicitly enabled after creation, since
1098 * we may want to apply filters.
1100 event_notifier
->enabled
= 0;
1101 event_notifier
->registered
= 0;
1102 event_notifier
->desc
= event_desc
;
1103 switch (event_notifier_param
->event
.u
.syscall
.entryexit
) {
1104 case LTTNG_KERNEL_SYSCALL_ENTRYEXIT
:
1106 goto register_error
;
1107 case LTTNG_KERNEL_SYSCALL_ENTRY
:
1108 event_notifier
->u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1110 case LTTNG_KERNEL_SYSCALL_EXIT
:
1111 event_notifier
->u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1114 switch (event_notifier_param
->event
.u
.syscall
.abi
) {
1115 case LTTNG_KERNEL_SYSCALL_ABI_ALL
:
1117 goto register_error
;
1118 case LTTNG_KERNEL_SYSCALL_ABI_NATIVE
:
1119 event_notifier
->u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1121 case LTTNG_KERNEL_SYSCALL_ABI_COMPAT
:
1122 event_notifier
->u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1126 if (!event_notifier
->desc
) {
1128 goto register_error
;
1131 case LTTNG_KERNEL_UPROBE
:
1133 * Needs to be explicitly enabled after creation, since
1134 * we may want to apply filters.
1136 event_notifier
->enabled
= 0;
1137 event_notifier
->registered
= 1;
1140 * Populate lttng_event_notifier structure before
1141 * event_notifier registration.
1145 ret
= lttng_uprobes_register_event_notifier(
1146 event_notifier_param
->event
.name
,
1147 event_notifier_param
->event
.u
.uprobe
.fd
,
1150 goto register_error
;
1151 ret
= try_module_get(event_notifier
->desc
->owner
);
1154 case LTTNG_KERNEL_KRETPROBE
:
1155 case LTTNG_KERNEL_FUNCTION
:
1159 goto register_error
;
1162 list_add(&event_notifier
->list
, &event_notifier_group
->event_notifiers_head
);
1163 hlist_add_head(&event_notifier
->hlist
, head
);
1164 return event_notifier
;
1167 kmem_cache_free(event_notifier_cache
, event_notifier
);
1171 return ERR_PTR(ret
);
1174 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
1175 struct lttng_kernel_event
*event_param
,
1177 const struct lttng_event_desc
*event_desc
,
1178 enum lttng_kernel_instrumentation itype
)
1180 struct lttng_event
*event
;
1182 mutex_lock(&sessions_mutex
);
1183 event
= _lttng_event_create(chan
, event_param
, filter
, event_desc
,
1185 mutex_unlock(&sessions_mutex
);
1189 struct lttng_event_notifier
*lttng_event_notifier_create(
1190 const struct lttng_event_desc
*event_desc
,
1191 uint64_t id
, struct lttng_event_notifier_group
*event_notifier_group
,
1192 struct lttng_kernel_event_notifier
*event_notifier_param
,
1193 void *filter
, enum lttng_kernel_instrumentation itype
)
1195 struct lttng_event_notifier
*event_notifier
;
1197 mutex_lock(&sessions_mutex
);
1198 event_notifier
= _lttng_event_notifier_create(event_desc
, id
,
1199 event_notifier_group
, event_notifier_param
, filter
, itype
);
1200 mutex_unlock(&sessions_mutex
);
1201 return event_notifier
;
1204 /* Only used for tracepoints for now. */
1206 void register_event(struct lttng_event
*event
)
1208 const struct lttng_event_desc
*desc
;
1211 if (event
->registered
)
1215 switch (event
->instrumentation
) {
1216 case LTTNG_KERNEL_TRACEPOINT
:
1217 ret
= lttng_wrapper_tracepoint_probe_register(desc
->kname
,
1218 desc
->probe_callback
,
1221 case LTTNG_KERNEL_SYSCALL
:
1222 ret
= lttng_syscall_filter_enable_event(event
->chan
, event
);
1224 case LTTNG_KERNEL_KPROBE
:
1225 case LTTNG_KERNEL_UPROBE
:
1226 case LTTNG_KERNEL_KRETPROBE
:
1227 case LTTNG_KERNEL_NOOP
:
1230 case LTTNG_KERNEL_FUNCTION
: /* Fall-through */
1235 event
->registered
= 1;
1239 * Only used internally at session destruction.
1241 int _lttng_event_unregister(struct lttng_event
*event
)
1243 const struct lttng_event_desc
*desc
;
1246 if (!event
->registered
)
1250 switch (event
->instrumentation
) {
1251 case LTTNG_KERNEL_TRACEPOINT
:
1252 ret
= lttng_wrapper_tracepoint_probe_unregister(event
->desc
->kname
,
1253 event
->desc
->probe_callback
,
1256 case LTTNG_KERNEL_KPROBE
:
1257 lttng_kprobes_unregister_event(event
);
1260 case LTTNG_KERNEL_KRETPROBE
:
1261 lttng_kretprobes_unregister(event
);
1264 case LTTNG_KERNEL_SYSCALL
:
1265 ret
= lttng_syscall_filter_disable_event(event
->chan
, event
);
1267 case LTTNG_KERNEL_NOOP
:
1270 case LTTNG_KERNEL_UPROBE
:
1271 lttng_uprobes_unregister_event(event
);
1274 case LTTNG_KERNEL_FUNCTION
: /* Fall-through */
1279 event
->registered
= 0;
1283 /* Only used for tracepoints for now. */
1285 void register_event_notifier(struct lttng_event_notifier
*event_notifier
)
1287 const struct lttng_event_desc
*desc
;
1290 if (event_notifier
->registered
)
1293 desc
= event_notifier
->desc
;
1294 switch (event_notifier
->instrumentation
) {
1295 case LTTNG_KERNEL_TRACEPOINT
:
1296 ret
= lttng_wrapper_tracepoint_probe_register(desc
->kname
,
1297 desc
->event_notifier_callback
,
1300 case LTTNG_KERNEL_SYSCALL
:
1301 ret
= lttng_syscall_filter_enable_event_notifier(event_notifier
);
1303 case LTTNG_KERNEL_KPROBE
:
1304 case LTTNG_KERNEL_UPROBE
:
1307 case LTTNG_KERNEL_KRETPROBE
:
1308 case LTTNG_KERNEL_FUNCTION
:
1309 case LTTNG_KERNEL_NOOP
:
1314 event_notifier
->registered
= 1;
1318 int _lttng_event_notifier_unregister(
1319 struct lttng_event_notifier
*event_notifier
)
1321 const struct lttng_event_desc
*desc
;
1324 if (!event_notifier
->registered
)
1327 desc
= event_notifier
->desc
;
1328 switch (event_notifier
->instrumentation
) {
1329 case LTTNG_KERNEL_TRACEPOINT
:
1330 ret
= lttng_wrapper_tracepoint_probe_unregister(event_notifier
->desc
->kname
,
1331 event_notifier
->desc
->event_notifier_callback
,
1334 case LTTNG_KERNEL_KPROBE
:
1335 lttng_kprobes_unregister_event_notifier(event_notifier
);
1338 case LTTNG_KERNEL_UPROBE
:
1339 lttng_uprobes_unregister_event_notifier(event_notifier
);
1342 case LTTNG_KERNEL_SYSCALL
:
1343 ret
= lttng_syscall_filter_disable_event_notifier(event_notifier
);
1345 case LTTNG_KERNEL_KRETPROBE
:
1346 case LTTNG_KERNEL_FUNCTION
:
1347 case LTTNG_KERNEL_NOOP
:
1352 event_notifier
->registered
= 0;
1357 * Only used internally at session destruction.
1360 void _lttng_event_destroy(struct lttng_event
*event
)
1362 switch (event
->instrumentation
) {
1363 case LTTNG_KERNEL_TRACEPOINT
:
1364 lttng_event_desc_put(event
->desc
);
1366 case LTTNG_KERNEL_KPROBE
:
1367 module_put(event
->desc
->owner
);
1368 lttng_kprobes_destroy_event_private(event
);
1370 case LTTNG_KERNEL_KRETPROBE
:
1371 module_put(event
->desc
->owner
);
1372 lttng_kretprobes_destroy_private(event
);
1374 case LTTNG_KERNEL_NOOP
:
1375 case LTTNG_KERNEL_SYSCALL
:
1377 case LTTNG_KERNEL_UPROBE
:
1378 module_put(event
->desc
->owner
);
1379 lttng_uprobes_destroy_event_private(event
);
1381 case LTTNG_KERNEL_FUNCTION
: /* Fall-through */
1385 list_del(&event
->list
);
1386 lttng_destroy_context(event
->ctx
);
1387 kmem_cache_free(event_cache
, event
);
1391 * Only used internally at session destruction.
1394 void _lttng_event_notifier_destroy(struct lttng_event_notifier
*event_notifier
)
1396 switch (event_notifier
->instrumentation
) {
1397 case LTTNG_KERNEL_TRACEPOINT
:
1398 lttng_event_desc_put(event_notifier
->desc
);
1400 case LTTNG_KERNEL_KPROBE
:
1401 module_put(event_notifier
->desc
->owner
);
1402 lttng_kprobes_destroy_event_notifier_private(event_notifier
);
1404 case LTTNG_KERNEL_NOOP
:
1405 case LTTNG_KERNEL_SYSCALL
:
1407 case LTTNG_KERNEL_UPROBE
:
1408 module_put(event_notifier
->desc
->owner
);
1409 lttng_uprobes_destroy_event_notifier_private(event_notifier
);
1411 case LTTNG_KERNEL_KRETPROBE
:
1412 case LTTNG_KERNEL_FUNCTION
:
1416 list_del(&event_notifier
->list
);
1417 kmem_cache_free(event_notifier_cache
, event_notifier
);
1420 struct lttng_id_tracker
*get_tracker(struct lttng_session
*session
,
1421 enum tracker_type tracker_type
)
1423 switch (tracker_type
) {
1425 return &session
->pid_tracker
;
1427 return &session
->vpid_tracker
;
1429 return &session
->uid_tracker
;
1431 return &session
->vuid_tracker
;
1433 return &session
->gid_tracker
;
1435 return &session
->vgid_tracker
;
1442 int lttng_session_track_id(struct lttng_session
*session
,
1443 enum tracker_type tracker_type
, int id
)
1445 struct lttng_id_tracker
*tracker
;
1448 tracker
= get_tracker(session
, tracker_type
);
1453 mutex_lock(&sessions_mutex
);
1455 /* track all ids: destroy tracker. */
1456 lttng_id_tracker_destroy(tracker
, true);
1459 ret
= lttng_id_tracker_add(tracker
, id
);
1461 mutex_unlock(&sessions_mutex
);
1465 int lttng_session_untrack_id(struct lttng_session
*session
,
1466 enum tracker_type tracker_type
, int id
)
1468 struct lttng_id_tracker
*tracker
;
1471 tracker
= get_tracker(session
, tracker_type
);
1476 mutex_lock(&sessions_mutex
);
1478 /* untrack all ids: replace by empty tracker. */
1479 ret
= lttng_id_tracker_empty_set(tracker
);
1481 ret
= lttng_id_tracker_del(tracker
, id
);
1483 mutex_unlock(&sessions_mutex
);
1488 void *id_list_start(struct seq_file
*m
, loff_t
*pos
)
1490 struct lttng_id_tracker
*id_tracker
= m
->private;
1491 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1492 struct lttng_id_hash_node
*e
;
1495 mutex_lock(&sessions_mutex
);
1497 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1498 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1500 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1506 /* ID tracker disabled. */
1507 if (iter
>= *pos
&& iter
== 0) {
1508 return id_tracker_p
; /* empty tracker */
1516 /* Called with sessions_mutex held. */
1518 void *id_list_next(struct seq_file
*m
, void *p
, loff_t
*ppos
)
1520 struct lttng_id_tracker
*id_tracker
= m
->private;
1521 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1522 struct lttng_id_hash_node
*e
;
1527 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1528 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1530 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1531 if (iter
++ >= *ppos
)
1536 /* ID tracker disabled. */
1537 if (iter
>= *ppos
&& iter
== 0)
1538 return p
; /* empty tracker */
1547 void id_list_stop(struct seq_file
*m
, void *p
)
1549 mutex_unlock(&sessions_mutex
);
1553 int id_list_show(struct seq_file
*m
, void *p
)
1555 struct lttng_id_tracker
*id_tracker
= m
->private;
1556 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1559 if (p
== id_tracker_p
) {
1560 /* Tracker disabled. */
1563 const struct lttng_id_hash_node
*e
= p
;
1565 id
= lttng_id_tracker_get_node_id(e
);
1567 switch (id_tracker
->tracker_type
) {
1569 seq_printf(m
, "process { pid = %d; };\n", id
);
1572 seq_printf(m
, "process { vpid = %d; };\n", id
);
1575 seq_printf(m
, "user { uid = %d; };\n", id
);
1578 seq_printf(m
, "user { vuid = %d; };\n", id
);
1581 seq_printf(m
, "group { gid = %d; };\n", id
);
1584 seq_printf(m
, "group { vgid = %d; };\n", id
);
1587 seq_printf(m
, "UNKNOWN { field = %d };\n", id
);
1593 const struct seq_operations lttng_tracker_ids_list_seq_ops
= {
1594 .start
= id_list_start
,
1595 .next
= id_list_next
,
1596 .stop
= id_list_stop
,
1597 .show
= id_list_show
,
1601 int lttng_tracker_ids_list_open(struct inode
*inode
, struct file
*file
)
1603 return seq_open(file
, <tng_tracker_ids_list_seq_ops
);
1607 int lttng_tracker_ids_list_release(struct inode
*inode
, struct file
*file
)
1609 struct seq_file
*m
= file
->private_data
;
1610 struct lttng_id_tracker
*id_tracker
= m
->private;
1613 WARN_ON_ONCE(!id_tracker
);
1614 ret
= seq_release(inode
, file
);
1616 fput(id_tracker
->session
->file
);
1620 const struct file_operations lttng_tracker_ids_list_fops
= {
1621 .owner
= THIS_MODULE
,
1622 .open
= lttng_tracker_ids_list_open
,
1624 .llseek
= seq_lseek
,
1625 .release
= lttng_tracker_ids_list_release
,
1628 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
1629 enum tracker_type tracker_type
)
1631 struct file
*tracker_ids_list_file
;
1635 file_fd
= lttng_get_unused_fd();
1641 tracker_ids_list_file
= anon_inode_getfile("[lttng_tracker_ids_list]",
1642 <tng_tracker_ids_list_fops
,
1644 if (IS_ERR(tracker_ids_list_file
)) {
1645 ret
= PTR_ERR(tracker_ids_list_file
);
1648 if (!atomic_long_add_unless(&session
->file
->f_count
, 1, LONG_MAX
)) {
1650 goto refcount_error
;
1652 ret
= lttng_tracker_ids_list_fops
.open(NULL
, tracker_ids_list_file
);
1655 m
= tracker_ids_list_file
->private_data
;
1657 m
->private = get_tracker(session
, tracker_type
);
1658 BUG_ON(!m
->private);
1659 fd_install(file_fd
, tracker_ids_list_file
);
1664 atomic_long_dec(&session
->file
->f_count
);
1666 fput(tracker_ids_list_file
);
1668 put_unused_fd(file_fd
);
1674 * Enabler management.
1677 int lttng_match_enabler_star_glob(const char *desc_name
,
1678 const char *pattern
)
1680 if (!strutils_star_glob_match(pattern
, LTTNG_SIZE_MAX
,
1681 desc_name
, LTTNG_SIZE_MAX
))
1687 int lttng_match_enabler_name(const char *desc_name
,
1690 if (strcmp(desc_name
, name
))
1695 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
1696 struct lttng_enabler
*enabler
)
1698 const char *desc_name
, *enabler_name
;
1699 bool compat
= false, entry
= false;
1701 enabler_name
= enabler
->event_param
.name
;
1702 switch (enabler
->event_param
.instrumentation
) {
1703 case LTTNG_KERNEL_TRACEPOINT
:
1704 desc_name
= desc
->name
;
1705 switch (enabler
->format_type
) {
1706 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1707 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1708 case LTTNG_ENABLER_FORMAT_NAME
:
1709 return lttng_match_enabler_name(desc_name
, enabler_name
);
1714 case LTTNG_KERNEL_SYSCALL
:
1715 desc_name
= desc
->name
;
1716 if (!strncmp(desc_name
, "compat_", strlen("compat_"))) {
1717 desc_name
+= strlen("compat_");
1720 if (!strncmp(desc_name
, "syscall_exit_",
1721 strlen("syscall_exit_"))) {
1722 desc_name
+= strlen("syscall_exit_");
1723 } else if (!strncmp(desc_name
, "syscall_entry_",
1724 strlen("syscall_entry_"))) {
1725 desc_name
+= strlen("syscall_entry_");
1731 switch (enabler
->event_param
.u
.syscall
.entryexit
) {
1732 case LTTNG_KERNEL_SYSCALL_ENTRYEXIT
:
1734 case LTTNG_KERNEL_SYSCALL_ENTRY
:
1738 case LTTNG_KERNEL_SYSCALL_EXIT
:
1745 switch (enabler
->event_param
.u
.syscall
.abi
) {
1746 case LTTNG_KERNEL_SYSCALL_ABI_ALL
:
1748 case LTTNG_KERNEL_SYSCALL_ABI_NATIVE
:
1752 case LTTNG_KERNEL_SYSCALL_ABI_COMPAT
:
1759 switch (enabler
->event_param
.u
.syscall
.match
) {
1760 case LTTNG_KERNEL_SYSCALL_MATCH_NAME
:
1761 switch (enabler
->format_type
) {
1762 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1763 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1764 case LTTNG_ENABLER_FORMAT_NAME
:
1765 return lttng_match_enabler_name(desc_name
, enabler_name
);
1770 case LTTNG_KERNEL_SYSCALL_MATCH_NR
:
1771 return -EINVAL
; /* Not implemented. */
1783 int lttng_event_enabler_match_event(struct lttng_event_enabler
*event_enabler
,
1784 struct lttng_event
*event
)
1786 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(
1789 if (base_enabler
->event_param
.instrumentation
!= event
->instrumentation
)
1791 if (lttng_desc_match_enabler(event
->desc
, base_enabler
)
1792 && event
->chan
== event_enabler
->chan
)
1799 int lttng_event_notifier_enabler_match_event_notifier(struct lttng_event_notifier_enabler
*event_notifier_enabler
,
1800 struct lttng_event_notifier
*event_notifier
)
1802 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(
1803 event_notifier_enabler
);
1805 if (base_enabler
->event_param
.instrumentation
!= event_notifier
->instrumentation
)
1807 if (lttng_desc_match_enabler(event_notifier
->desc
, base_enabler
)
1808 && event_notifier
->group
== event_notifier_enabler
->group
1809 && event_notifier
->user_token
== event_notifier_enabler
->base
.user_token
)
1816 struct lttng_enabler_ref
*lttng_enabler_ref(
1817 struct list_head
*enablers_ref_list
,
1818 struct lttng_enabler
*enabler
)
1820 struct lttng_enabler_ref
*enabler_ref
;
1822 list_for_each_entry(enabler_ref
, enablers_ref_list
, node
) {
1823 if (enabler_ref
->ref
== enabler
)
1830 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler
*event_enabler
)
1832 struct lttng_session
*session
= event_enabler
->chan
->session
;
1833 struct lttng_probe_desc
*probe_desc
;
1834 const struct lttng_event_desc
*desc
;
1836 struct list_head
*probe_list
;
1838 probe_list
= lttng_get_probe_list_head();
1840 * For each probe event, if we find that a probe event matches
1841 * our enabler, create an associated lttng_event if not
1844 list_for_each_entry(probe_desc
, probe_list
, head
) {
1845 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
1847 struct hlist_head
*head
;
1848 struct lttng_event
*event
;
1850 desc
= probe_desc
->event_desc
[i
];
1851 if (!lttng_desc_match_enabler(desc
,
1852 lttng_event_enabler_as_enabler(event_enabler
)))
1856 * Check if already created.
1858 head
= utils_borrow_hash_table_bucket(
1859 session
->events_ht
.table
, LTTNG_EVENT_HT_SIZE
,
1861 lttng_hlist_for_each_entry(event
, head
, hlist
) {
1862 if (event
->desc
== desc
1863 && event
->chan
== event_enabler
->chan
)
1870 * We need to create an event for this
1873 event
= _lttng_event_create(event_enabler
->chan
,
1875 LTTNG_KERNEL_TRACEPOINT
);
1877 printk(KERN_INFO
"LTTng: Unable to create event %s\n",
1878 probe_desc
->event_desc
[i
]->name
);
1885 void lttng_create_tracepoint_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
1887 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
1888 struct lttng_probe_desc
*probe_desc
;
1889 const struct lttng_event_desc
*desc
;
1891 struct list_head
*probe_list
;
1893 probe_list
= lttng_get_probe_list_head();
1895 * For each probe event, if we find that a probe event matches
1896 * our enabler, create an associated lttng_event_notifier if not
1899 list_for_each_entry(probe_desc
, probe_list
, head
) {
1900 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
1902 struct hlist_head
*head
;
1903 struct lttng_event_notifier
*event_notifier
;
1905 desc
= probe_desc
->event_desc
[i
];
1906 if (!lttng_desc_match_enabler(desc
,
1907 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)))
1911 * Check if already created.
1913 head
= utils_borrow_hash_table_bucket(
1914 event_notifier_group
->event_notifiers_ht
.table
,
1915 LTTNG_EVENT_NOTIFIER_HT_SIZE
, desc
->name
);
1916 lttng_hlist_for_each_entry(event_notifier
, head
, hlist
) {
1917 if (event_notifier
->desc
== desc
1918 && event_notifier
->user_token
== event_notifier_enabler
->base
.user_token
)
1925 * We need to create a event_notifier for this event probe.
1927 event_notifier
= _lttng_event_notifier_create(desc
,
1928 event_notifier_enabler
->base
.user_token
,
1929 event_notifier_group
, NULL
, NULL
,
1930 LTTNG_KERNEL_TRACEPOINT
);
1931 if (IS_ERR(event_notifier
)) {
1932 printk(KERN_INFO
"Unable to create event_notifier %s\n",
1933 probe_desc
->event_desc
[i
]->name
);
1940 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler
*event_enabler
)
1944 ret
= lttng_syscalls_register_event(event_enabler
->chan
, NULL
);
1949 void lttng_create_syscall_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
1953 ret
= lttng_syscalls_register_event_notifier(event_notifier_enabler
, NULL
);
1955 ret
= lttng_syscals_create_matching_event_notifiers(event_notifier_enabler
, NULL
);
1960 * Create struct lttng_event if it is missing and present in the list of
1961 * tracepoint probes.
1962 * Should be called with sessions mutex held.
1965 void lttng_create_event_if_missing(struct lttng_event_enabler
*event_enabler
)
1967 switch (event_enabler
->base
.event_param
.instrumentation
) {
1968 case LTTNG_KERNEL_TRACEPOINT
:
1969 lttng_create_tracepoint_event_if_missing(event_enabler
);
1971 case LTTNG_KERNEL_SYSCALL
:
1972 lttng_create_syscall_event_if_missing(event_enabler
);
1981 * Create events associated with an event_enabler (if not already present),
1982 * and add backward reference from the event to the enabler.
1983 * Should be called with sessions mutex held.
1986 int lttng_event_enabler_ref_events(struct lttng_event_enabler
*event_enabler
)
1988 struct lttng_channel
*chan
= event_enabler
->chan
;
1989 struct lttng_session
*session
= event_enabler
->chan
->session
;
1990 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(event_enabler
);
1991 struct lttng_event
*event
;
1993 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_SYSCALL
&&
1994 base_enabler
->event_param
.u
.syscall
.entryexit
== LTTNG_KERNEL_SYSCALL_ENTRYEXIT
&&
1995 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_SYSCALL_ABI_ALL
&&
1996 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_SYSCALL_MATCH_NAME
&&
1997 !strcmp(base_enabler
->event_param
.name
, "*")) {
1998 if (base_enabler
->enabled
)
1999 WRITE_ONCE(chan
->syscall_all
, 1);
2001 WRITE_ONCE(chan
->syscall_all
, 0);
2004 /* First ensure that probe events are created for this enabler. */
2005 lttng_create_event_if_missing(event_enabler
);
2007 /* For each event matching event_enabler in session event list. */
2008 list_for_each_entry(event
, &session
->events
, list
) {
2009 struct lttng_enabler_ref
*enabler_ref
;
2011 if (!lttng_event_enabler_match_event(event_enabler
, event
))
2013 enabler_ref
= lttng_enabler_ref(&event
->enablers_ref_head
,
2014 lttng_event_enabler_as_enabler(event_enabler
));
2017 * If no backward ref, create it.
2018 * Add backward ref from event to event_enabler.
2020 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2023 enabler_ref
->ref
= lttng_event_enabler_as_enabler(event_enabler
);
2024 list_add(&enabler_ref
->node
,
2025 &event
->enablers_ref_head
);
2029 * Link filter bytecodes if not linked yet.
2031 lttng_enabler_link_bytecode(event
->desc
,
2033 &event
->filter_bytecode_runtime_head
,
2034 lttng_event_enabler_as_enabler(event_enabler
));
2036 /* TODO: merge event context. */
2042 * Create struct lttng_event_notifier if it is missing and present in the list of
2043 * tracepoint probes.
2044 * Should be called with sessions mutex held.
2047 void lttng_create_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2049 switch (event_notifier_enabler
->base
.event_param
.instrumentation
) {
2050 case LTTNG_KERNEL_TRACEPOINT
:
2051 lttng_create_tracepoint_event_notifier_if_missing(event_notifier_enabler
);
2053 case LTTNG_KERNEL_SYSCALL
:
2054 lttng_create_syscall_event_notifier_if_missing(event_notifier_enabler
);
2063 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2066 int lttng_event_notifier_enabler_ref_event_notifiers(
2067 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2069 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2070 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2071 struct lttng_event_notifier
*event_notifier
;
2073 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_SYSCALL
&&
2074 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_SYSCALL_ABI_ALL
&&
2075 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_SYSCALL_MATCH_NAME
&&
2076 !strcmp(base_enabler
->event_param
.name
, "*")) {
2078 int enabled
= base_enabler
->enabled
;
2079 enum lttng_kernel_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2081 if (entryexit
== LTTNG_KERNEL_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_SYSCALL_ENTRYEXIT
)
2082 WRITE_ONCE(event_notifier_group
->syscall_all_entry
, enabled
);
2084 if (entryexit
== LTTNG_KERNEL_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_SYSCALL_ENTRYEXIT
)
2085 WRITE_ONCE(event_notifier_group
->syscall_all_exit
, enabled
);
2089 /* First ensure that probe event_notifiers are created for this enabler. */
2090 lttng_create_event_notifier_if_missing(event_notifier_enabler
);
2092 /* Link the created event_notifier with its associated enabler. */
2093 list_for_each_entry(event_notifier
, &event_notifier_group
->event_notifiers_head
, list
) {
2094 struct lttng_enabler_ref
*enabler_ref
;
2096 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler
, event_notifier
))
2099 enabler_ref
= lttng_enabler_ref(&event_notifier
->enablers_ref_head
,
2100 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2103 * If no backward ref, create it.
2104 * Add backward ref from event_notifier to enabler.
2106 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2110 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2111 event_notifier_enabler
);
2112 list_add(&enabler_ref
->node
,
2113 &event_notifier
->enablers_ref_head
);
2117 * Link filter bytecodes if not linked yet.
2119 lttng_enabler_link_bytecode(event_notifier
->desc
,
2120 lttng_static_ctx
, &event_notifier
->filter_bytecode_runtime_head
,
2121 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2127 * Called at module load: connect the probe on all enablers matching
2129 * Called with sessions lock held.
2131 int lttng_fix_pending_events(void)
2133 struct lttng_session
*session
;
2135 list_for_each_entry(session
, &sessions
, list
)
2136 lttng_session_lazy_sync_event_enablers(session
);
2140 static bool lttng_event_notifier_group_has_active_event_notifiers(
2141 struct lttng_event_notifier_group
*event_notifier_group
)
2143 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2145 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
,
2147 if (event_notifier_enabler
->base
.enabled
)
2153 bool lttng_event_notifier_active(void)
2155 struct lttng_event_notifier_group
*event_notifier_group
;
2157 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2158 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group
))
2164 int lttng_fix_pending_event_notifiers(void)
2166 struct lttng_event_notifier_group
*event_notifier_group
;
2168 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
)
2169 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
2173 struct lttng_event_enabler
*lttng_event_enabler_create(
2174 enum lttng_enabler_format_type format_type
,
2175 struct lttng_kernel_event
*event_param
,
2176 struct lttng_channel
*chan
)
2178 struct lttng_event_enabler
*event_enabler
;
2180 event_enabler
= kzalloc(sizeof(*event_enabler
), GFP_KERNEL
);
2183 event_enabler
->base
.format_type
= format_type
;
2184 INIT_LIST_HEAD(&event_enabler
->base
.filter_bytecode_head
);
2185 memcpy(&event_enabler
->base
.event_param
, event_param
,
2186 sizeof(event_enabler
->base
.event_param
));
2187 event_enabler
->chan
= chan
;
2189 event_enabler
->base
.enabled
= 0;
2190 event_enabler
->base
.evtype
= LTTNG_TYPE_ENABLER
;
2191 mutex_lock(&sessions_mutex
);
2192 list_add(&event_enabler
->node
, &event_enabler
->chan
->session
->enablers_head
);
2193 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2194 mutex_unlock(&sessions_mutex
);
2195 return event_enabler
;
2198 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
)
2200 mutex_lock(&sessions_mutex
);
2201 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 1;
2202 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2203 mutex_unlock(&sessions_mutex
);
2207 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
)
2209 mutex_lock(&sessions_mutex
);
2210 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 0;
2211 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2212 mutex_unlock(&sessions_mutex
);
2217 int lttng_enabler_attach_filter_bytecode(struct lttng_enabler
*enabler
,
2218 struct lttng_kernel_filter_bytecode __user
*bytecode
)
2220 struct lttng_filter_bytecode_node
*bytecode_node
;
2221 uint32_t bytecode_len
;
2224 ret
= get_user(bytecode_len
, &bytecode
->len
);
2227 bytecode_node
= kzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2231 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2232 sizeof(*bytecode
) + bytecode_len
);
2236 bytecode_node
->enabler
= enabler
;
2237 /* Enforce length based on allocated size */
2238 bytecode_node
->bc
.len
= bytecode_len
;
2239 list_add_tail(&bytecode_node
->node
, &enabler
->filter_bytecode_head
);
2244 kfree(bytecode_node
);
2248 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
2249 struct lttng_kernel_filter_bytecode __user
*bytecode
)
2252 ret
= lttng_enabler_attach_filter_bytecode(
2253 lttng_event_enabler_as_enabler(event_enabler
), bytecode
);
2257 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2264 int lttng_event_add_callsite(struct lttng_event
*event
,
2265 struct lttng_kernel_event_callsite __user
*callsite
)
2268 switch (event
->instrumentation
) {
2269 case LTTNG_KERNEL_UPROBE
:
2270 return lttng_uprobes_event_add_callsite(event
, callsite
);
2276 int lttng_event_enabler_attach_context(struct lttng_event_enabler
*event_enabler
,
2277 struct lttng_kernel_context
*context_param
)
2283 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
2285 struct lttng_filter_bytecode_node
*filter_node
, *tmp_filter_node
;
2287 /* Destroy filter bytecode */
2288 list_for_each_entry_safe(filter_node
, tmp_filter_node
,
2289 &enabler
->filter_bytecode_head
, node
) {
2295 void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
)
2297 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler
));
2299 /* Destroy contexts */
2300 lttng_destroy_context(event_enabler
->ctx
);
2302 list_del(&event_enabler
->node
);
2303 kfree(event_enabler
);
2306 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
2307 struct lttng_event_notifier_group
*event_notifier_group
,
2308 enum lttng_enabler_format_type format_type
,
2309 struct lttng_kernel_event_notifier
*event_notifier_param
)
2311 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2313 event_notifier_enabler
= kzalloc(sizeof(*event_notifier_enabler
), GFP_KERNEL
);
2314 if (!event_notifier_enabler
)
2317 event_notifier_enabler
->base
.format_type
= format_type
;
2318 INIT_LIST_HEAD(&event_notifier_enabler
->base
.filter_bytecode_head
);
2320 memcpy(&event_notifier_enabler
->base
.event_param
, &event_notifier_param
->event
,
2321 sizeof(event_notifier_enabler
->base
.event_param
));
2322 event_notifier_enabler
->base
.evtype
= LTTNG_TYPE_ENABLER
;
2324 event_notifier_enabler
->base
.enabled
= 0;
2325 event_notifier_enabler
->base
.user_token
= event_notifier_param
->event
.token
;
2326 event_notifier_enabler
->group
= event_notifier_group
;
2328 mutex_lock(&sessions_mutex
);
2329 list_add(&event_notifier_enabler
->node
, &event_notifier_enabler
->group
->enablers_head
);
2330 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2332 mutex_unlock(&sessions_mutex
);
2334 return event_notifier_enabler
;
2337 int lttng_event_notifier_enabler_enable(
2338 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2340 mutex_lock(&sessions_mutex
);
2341 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
2342 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2343 mutex_unlock(&sessions_mutex
);
2347 int lttng_event_notifier_enabler_disable(
2348 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2350 mutex_lock(&sessions_mutex
);
2351 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
2352 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2353 mutex_unlock(&sessions_mutex
);
2357 int lttng_event_notifier_enabler_attach_filter_bytecode(
2358 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2359 struct lttng_kernel_filter_bytecode __user
*bytecode
)
2363 ret
= lttng_enabler_attach_filter_bytecode(
2364 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
2369 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2376 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
2377 struct lttng_kernel_event_callsite __user
*callsite
)
2380 switch (event_notifier
->instrumentation
) {
2381 case LTTNG_KERNEL_UPROBE
:
2382 return lttng_uprobes_event_notifier_add_callsite(event_notifier
,
2389 int lttng_event_notifier_enabler_attach_context(
2390 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2391 struct lttng_kernel_context
*context_param
)
2397 void lttng_event_notifier_enabler_destroy(
2398 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2400 if (!event_notifier_enabler
) {
2404 list_del(&event_notifier_enabler
->node
);
2406 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2407 kfree(event_notifier_enabler
);
2411 * lttng_session_sync_event_enablers should be called just before starting a
2413 * Should be called with sessions mutex held.
2416 void lttng_session_sync_event_enablers(struct lttng_session
*session
)
2418 struct lttng_event_enabler
*event_enabler
;
2419 struct lttng_event
*event
;
2421 list_for_each_entry(event_enabler
, &session
->enablers_head
, node
)
2422 lttng_event_enabler_ref_events(event_enabler
);
2424 * For each event, if at least one of its enablers is enabled,
2425 * and its channel and session transient states are enabled, we
2426 * enable the event, else we disable it.
2428 list_for_each_entry(event
, &session
->events
, list
) {
2429 struct lttng_enabler_ref
*enabler_ref
;
2430 struct lttng_bytecode_runtime
*runtime
;
2431 int enabled
= 0, has_enablers_without_bytecode
= 0;
2433 switch (event
->instrumentation
) {
2434 case LTTNG_KERNEL_TRACEPOINT
:
2435 case LTTNG_KERNEL_SYSCALL
:
2437 list_for_each_entry(enabler_ref
,
2438 &event
->enablers_ref_head
, node
) {
2439 if (enabler_ref
->ref
->enabled
) {
2446 /* Not handled with lazy sync. */
2450 * Enabled state is based on union of enablers, with
2451 * intesection of session and channel transient enable
2454 enabled
= enabled
&& session
->tstate
&& event
->chan
->tstate
;
2456 WRITE_ONCE(event
->enabled
, enabled
);
2458 * Sync tracepoint registration with event enabled
2462 register_event(event
);
2464 _lttng_event_unregister(event
);
2467 /* Check if has enablers without bytecode enabled */
2468 list_for_each_entry(enabler_ref
,
2469 &event
->enablers_ref_head
, node
) {
2470 if (enabler_ref
->ref
->enabled
2471 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2472 has_enablers_without_bytecode
= 1;
2476 event
->has_enablers_without_bytecode
=
2477 has_enablers_without_bytecode
;
2479 /* Enable filters */
2480 list_for_each_entry(runtime
,
2481 &event
->filter_bytecode_runtime_head
, node
)
2482 lttng_filter_sync_state(runtime
);
2487 * Apply enablers to session events, adding events to session if need
2488 * be. It is required after each modification applied to an active
2489 * session, and right before session "start".
2490 * "lazy" sync means we only sync if required.
2491 * Should be called with sessions mutex held.
2494 void lttng_session_lazy_sync_event_enablers(struct lttng_session
*session
)
2496 /* We can skip if session is not active */
2497 if (!session
->active
)
2499 lttng_session_sync_event_enablers(session
);
2503 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2505 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2506 struct lttng_event_notifier
*event_notifier
;
2508 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2509 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2512 * For each event_notifier, if at least one of its enablers is enabled,
2513 * we enable the event_notifier, else we disable it.
2515 list_for_each_entry(event_notifier
, &event_notifier_group
->event_notifiers_head
, list
) {
2516 struct lttng_enabler_ref
*enabler_ref
;
2517 struct lttng_bytecode_runtime
*runtime
;
2518 int enabled
= 0, has_enablers_without_bytecode
= 0;
2520 switch (event_notifier
->instrumentation
) {
2521 case LTTNG_KERNEL_TRACEPOINT
:
2522 case LTTNG_KERNEL_SYSCALL
:
2523 /* Enable event_notifiers */
2524 list_for_each_entry(enabler_ref
,
2525 &event_notifier
->enablers_ref_head
, node
) {
2526 if (enabler_ref
->ref
->enabled
) {
2533 /* Not handled with sync. */
2537 WRITE_ONCE(event_notifier
->enabled
, enabled
);
2539 * Sync tracepoint registration with event_notifier enabled
2543 if (!event_notifier
->registered
)
2544 register_event_notifier(event_notifier
);
2546 if (event_notifier
->registered
)
2547 _lttng_event_notifier_unregister(event_notifier
);
2550 /* Check if has enablers without bytecode enabled */
2551 list_for_each_entry(enabler_ref
,
2552 &event_notifier
->enablers_ref_head
, node
) {
2553 if (enabler_ref
->ref
->enabled
2554 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2555 has_enablers_without_bytecode
= 1;
2559 event_notifier
->has_enablers_without_bytecode
=
2560 has_enablers_without_bytecode
;
2562 /* Enable filters */
2563 list_for_each_entry(runtime
,
2564 &event_notifier
->filter_bytecode_runtime_head
, node
)
2565 lttng_filter_sync_state(runtime
);
2570 * Serialize at most one packet worth of metadata into a metadata
2572 * We grab the metadata cache mutex to get exclusive access to our metadata
2573 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2574 * allows us to do racy operations such as looking for remaining space left in
2575 * packet and write, since mutual exclusion protects us from concurrent writes.
2576 * Mutual exclusion on the metadata cache allow us to read the cache content
2577 * without racing against reallocation of the cache by updates.
2578 * Returns the number of bytes written in the channel, 0 if no data
2579 * was written and a negative value on error.
2581 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
2582 struct channel
*chan
, bool *coherent
)
2584 struct lib_ring_buffer_ctx ctx
;
2586 size_t len
, reserve_len
;
2589 * Ensure we support mutiple get_next / put sequences followed by
2590 * put_next. The metadata cache lock protects reading the metadata
2591 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2592 * "flush" operations on the buffer invoked by different processes.
2593 * Moreover, since the metadata cache memory can be reallocated, we
2594 * need to have exclusive access against updates even though we only
2597 mutex_lock(&stream
->metadata_cache
->lock
);
2598 WARN_ON(stream
->metadata_in
< stream
->metadata_out
);
2599 if (stream
->metadata_in
!= stream
->metadata_out
)
2602 /* Metadata regenerated, change the version. */
2603 if (stream
->metadata_cache
->version
!= stream
->version
)
2604 stream
->version
= stream
->metadata_cache
->version
;
2606 len
= stream
->metadata_cache
->metadata_written
-
2607 stream
->metadata_in
;
2610 reserve_len
= min_t(size_t,
2611 stream
->transport
->ops
.packet_avail_size(chan
),
2613 lib_ring_buffer_ctx_init(&ctx
, chan
, NULL
, reserve_len
,
2616 * If reservation failed, return an error to the caller.
2618 ret
= stream
->transport
->ops
.event_reserve(&ctx
, 0);
2620 printk(KERN_WARNING
"LTTng: Metadata event reservation failed\n");
2621 stream
->coherent
= false;
2624 stream
->transport
->ops
.event_write(&ctx
,
2625 stream
->metadata_cache
->data
+ stream
->metadata_in
,
2627 stream
->transport
->ops
.event_commit(&ctx
);
2628 stream
->metadata_in
+= reserve_len
;
2629 if (reserve_len
< len
)
2630 stream
->coherent
= false;
2632 stream
->coherent
= true;
2637 *coherent
= stream
->coherent
;
2638 mutex_unlock(&stream
->metadata_cache
->lock
);
2643 void lttng_metadata_begin(struct lttng_session
*session
)
2645 if (atomic_inc_return(&session
->metadata_cache
->producing
) == 1)
2646 mutex_lock(&session
->metadata_cache
->lock
);
2650 void lttng_metadata_end(struct lttng_session
*session
)
2652 WARN_ON_ONCE(!atomic_read(&session
->metadata_cache
->producing
));
2653 if (atomic_dec_return(&session
->metadata_cache
->producing
) == 0) {
2654 struct lttng_metadata_stream
*stream
;
2656 list_for_each_entry(stream
, &session
->metadata_cache
->metadata_stream
, list
)
2657 wake_up_interruptible(&stream
->read_wait
);
2658 mutex_unlock(&session
->metadata_cache
->lock
);
2663 * Write the metadata to the metadata cache.
2664 * Must be called with sessions_mutex held.
2665 * The metadata cache lock protects us from concurrent read access from
2666 * thread outputting metadata content to ring buffer.
2667 * The content of the printf is printed as a single atomic metadata
2670 int lttng_metadata_printf(struct lttng_session
*session
,
2671 const char *fmt
, ...)
2677 WARN_ON_ONCE(!LTTNG_READ_ONCE(session
->active
));
2680 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
2686 WARN_ON_ONCE(!atomic_read(&session
->metadata_cache
->producing
));
2687 if (session
->metadata_cache
->metadata_written
+ len
>
2688 session
->metadata_cache
->cache_alloc
) {
2689 char *tmp_cache_realloc
;
2690 unsigned int tmp_cache_alloc_size
;
2692 tmp_cache_alloc_size
= max_t(unsigned int,
2693 session
->metadata_cache
->cache_alloc
+ len
,
2694 session
->metadata_cache
->cache_alloc
<< 1);
2695 tmp_cache_realloc
= vzalloc(tmp_cache_alloc_size
);
2696 if (!tmp_cache_realloc
)
2698 if (session
->metadata_cache
->data
) {
2699 memcpy(tmp_cache_realloc
,
2700 session
->metadata_cache
->data
,
2701 session
->metadata_cache
->cache_alloc
);
2702 vfree(session
->metadata_cache
->data
);
2705 session
->metadata_cache
->cache_alloc
= tmp_cache_alloc_size
;
2706 session
->metadata_cache
->data
= tmp_cache_realloc
;
2708 memcpy(session
->metadata_cache
->data
+
2709 session
->metadata_cache
->metadata_written
,
2711 session
->metadata_cache
->metadata_written
+= len
;
2722 int print_tabs(struct lttng_session
*session
, size_t nesting
)
2726 for (i
= 0; i
< nesting
; i
++) {
2729 ret
= lttng_metadata_printf(session
, " ");
2738 int lttng_field_name_statedump(struct lttng_session
*session
,
2739 const struct lttng_event_field
*field
,
2742 return lttng_metadata_printf(session
, " _%s;\n", field
->name
);
2746 int _lttng_integer_type_statedump(struct lttng_session
*session
,
2747 const struct lttng_type
*type
,
2752 WARN_ON_ONCE(type
->atype
!= atype_integer
);
2753 ret
= print_tabs(session
, nesting
);
2756 ret
= lttng_metadata_printf(session
,
2757 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
2758 type
->u
.integer
.size
,
2759 type
->u
.integer
.alignment
,
2760 type
->u
.integer
.signedness
,
2761 (type
->u
.integer
.encoding
== lttng_encode_none
)
2763 : (type
->u
.integer
.encoding
== lttng_encode_UTF8
)
2766 type
->u
.integer
.base
,
2767 #if __BYTE_ORDER == __BIG_ENDIAN
2768 type
->u
.integer
.reverse_byte_order
? " byte_order = le;" : ""
2770 type
->u
.integer
.reverse_byte_order
? " byte_order = be;" : ""
2777 * Must be called with sessions_mutex held.
2780 int _lttng_struct_type_statedump(struct lttng_session
*session
,
2781 const struct lttng_type
*type
,
2785 uint32_t i
, nr_fields
;
2786 unsigned int alignment
;
2788 WARN_ON_ONCE(type
->atype
!= atype_struct_nestable
);
2790 ret
= print_tabs(session
, nesting
);
2793 ret
= lttng_metadata_printf(session
,
2797 nr_fields
= type
->u
.struct_nestable
.nr_fields
;
2798 for (i
= 0; i
< nr_fields
; i
++) {
2799 const struct lttng_event_field
*iter_field
;
2801 iter_field
= &type
->u
.struct_nestable
.fields
[i
];
2802 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1);
2806 ret
= print_tabs(session
, nesting
);
2809 alignment
= type
->u
.struct_nestable
.alignment
;
2811 ret
= lttng_metadata_printf(session
,
2815 ret
= lttng_metadata_printf(session
,
2822 * Must be called with sessions_mutex held.
2825 int _lttng_struct_field_statedump(struct lttng_session
*session
,
2826 const struct lttng_event_field
*field
,
2831 ret
= _lttng_struct_type_statedump(session
,
2832 &field
->type
, nesting
);
2835 return lttng_field_name_statedump(session
, field
, nesting
);
2839 * Must be called with sessions_mutex held.
2842 int _lttng_variant_type_statedump(struct lttng_session
*session
,
2843 const struct lttng_type
*type
,
2847 uint32_t i
, nr_choices
;
2849 WARN_ON_ONCE(type
->atype
!= atype_variant_nestable
);
2851 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
2853 if (type
->u
.variant_nestable
.alignment
!= 0)
2855 ret
= print_tabs(session
, nesting
);
2858 ret
= lttng_metadata_printf(session
,
2859 "variant <_%s> {\n",
2860 type
->u
.variant_nestable
.tag_name
);
2863 nr_choices
= type
->u
.variant_nestable
.nr_choices
;
2864 for (i
= 0; i
< nr_choices
; i
++) {
2865 const struct lttng_event_field
*iter_field
;
2867 iter_field
= &type
->u
.variant_nestable
.choices
[i
];
2868 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1);
2872 ret
= print_tabs(session
, nesting
);
2875 ret
= lttng_metadata_printf(session
,
2881 * Must be called with sessions_mutex held.
2884 int _lttng_variant_field_statedump(struct lttng_session
*session
,
2885 const struct lttng_event_field
*field
,
2890 ret
= _lttng_variant_type_statedump(session
,
2891 &field
->type
, nesting
);
2894 return lttng_field_name_statedump(session
, field
, nesting
);
2898 * Must be called with sessions_mutex held.
2901 int _lttng_array_field_statedump(struct lttng_session
*session
,
2902 const struct lttng_event_field
*field
,
2906 const struct lttng_type
*elem_type
;
2908 WARN_ON_ONCE(field
->type
.atype
!= atype_array_nestable
);
2910 if (field
->type
.u
.array_nestable
.alignment
) {
2911 ret
= print_tabs(session
, nesting
);
2914 ret
= lttng_metadata_printf(session
,
2915 "struct { } align(%u) _%s_padding;\n",
2916 field
->type
.u
.array_nestable
.alignment
* CHAR_BIT
,
2922 * Nested compound types: Only array of structures and variants are
2923 * currently supported.
2925 elem_type
= field
->type
.u
.array_nestable
.elem_type
;
2926 switch (elem_type
->atype
) {
2928 case atype_struct_nestable
:
2929 case atype_variant_nestable
:
2930 ret
= _lttng_type_statedump(session
, elem_type
, nesting
);
2938 ret
= lttng_metadata_printf(session
,
2941 field
->type
.u
.array_nestable
.length
);
2946 * Must be called with sessions_mutex held.
2949 int _lttng_sequence_field_statedump(struct lttng_session
*session
,
2950 const struct lttng_event_field
*field
,
2954 const char *length_name
;
2955 const struct lttng_type
*elem_type
;
2957 WARN_ON_ONCE(field
->type
.atype
!= atype_sequence_nestable
);
2959 length_name
= field
->type
.u
.sequence_nestable
.length_name
;
2961 if (field
->type
.u
.sequence_nestable
.alignment
) {
2962 ret
= print_tabs(session
, nesting
);
2965 ret
= lttng_metadata_printf(session
,
2966 "struct { } align(%u) _%s_padding;\n",
2967 field
->type
.u
.sequence_nestable
.alignment
* CHAR_BIT
,
2974 * Nested compound types: Only array of structures and variants are
2975 * currently supported.
2977 elem_type
= field
->type
.u
.sequence_nestable
.elem_type
;
2978 switch (elem_type
->atype
) {
2980 case atype_struct_nestable
:
2981 case atype_variant_nestable
:
2982 ret
= _lttng_type_statedump(session
, elem_type
, nesting
);
2990 ret
= lttng_metadata_printf(session
,
2993 field
->type
.u
.sequence_nestable
.length_name
);
2998 * Must be called with sessions_mutex held.
3001 int _lttng_enum_type_statedump(struct lttng_session
*session
,
3002 const struct lttng_type
*type
,
3005 const struct lttng_enum_desc
*enum_desc
;
3006 const struct lttng_type
*container_type
;
3008 unsigned int i
, nr_entries
;
3010 container_type
= type
->u
.enum_nestable
.container_type
;
3011 if (container_type
->atype
!= atype_integer
) {
3015 enum_desc
= type
->u
.enum_nestable
.desc
;
3016 nr_entries
= enum_desc
->nr_entries
;
3018 ret
= print_tabs(session
, nesting
);
3021 ret
= lttng_metadata_printf(session
, "enum : ");
3024 ret
= _lttng_integer_type_statedump(session
, container_type
, 0);
3027 ret
= lttng_metadata_printf(session
, " {\n");
3030 /* Dump all entries */
3031 for (i
= 0; i
< nr_entries
; i
++) {
3032 const struct lttng_enum_entry
*entry
= &enum_desc
->entries
[i
];
3035 ret
= print_tabs(session
, nesting
+ 1);
3038 ret
= lttng_metadata_printf(session
,
3042 len
= strlen(entry
->string
);
3043 /* Escape the character '"' */
3044 for (j
= 0; j
< len
; j
++) {
3045 char c
= entry
->string
[j
];
3049 ret
= lttng_metadata_printf(session
,
3053 ret
= lttng_metadata_printf(session
,
3057 ret
= lttng_metadata_printf(session
,
3064 ret
= lttng_metadata_printf(session
, "\"");
3068 if (entry
->options
.is_auto
) {
3069 ret
= lttng_metadata_printf(session
, ",\n");
3073 ret
= lttng_metadata_printf(session
,
3077 if (entry
->start
.signedness
)
3078 ret
= lttng_metadata_printf(session
,
3079 "%lld", (long long) entry
->start
.value
);
3081 ret
= lttng_metadata_printf(session
,
3082 "%llu", entry
->start
.value
);
3085 if (entry
->start
.signedness
== entry
->end
.signedness
&&
3087 == entry
->end
.value
) {
3088 ret
= lttng_metadata_printf(session
,
3091 if (entry
->end
.signedness
) {
3092 ret
= lttng_metadata_printf(session
,
3094 (long long) entry
->end
.value
);
3096 ret
= lttng_metadata_printf(session
,
3105 ret
= print_tabs(session
, nesting
);
3108 ret
= lttng_metadata_printf(session
, "}");
3114 * Must be called with sessions_mutex held.
3117 int _lttng_enum_field_statedump(struct lttng_session
*session
,
3118 const struct lttng_event_field
*field
,
3123 ret
= _lttng_enum_type_statedump(session
, &field
->type
, nesting
);
3126 return lttng_field_name_statedump(session
, field
, nesting
);
3130 int _lttng_integer_field_statedump(struct lttng_session
*session
,
3131 const struct lttng_event_field
*field
,
3136 ret
= _lttng_integer_type_statedump(session
, &field
->type
, nesting
);
3139 return lttng_field_name_statedump(session
, field
, nesting
);
3143 int _lttng_string_type_statedump(struct lttng_session
*session
,
3144 const struct lttng_type
*type
,
3149 WARN_ON_ONCE(type
->atype
!= atype_string
);
3150 /* Default encoding is UTF8 */
3151 ret
= print_tabs(session
, nesting
);
3154 ret
= lttng_metadata_printf(session
,
3156 type
->u
.string
.encoding
== lttng_encode_ASCII
?
3157 " { encoding = ASCII; }" : "");
3162 int _lttng_string_field_statedump(struct lttng_session
*session
,
3163 const struct lttng_event_field
*field
,
3168 WARN_ON_ONCE(field
->type
.atype
!= atype_string
);
3169 ret
= _lttng_string_type_statedump(session
, &field
->type
, nesting
);
3172 return lttng_field_name_statedump(session
, field
, nesting
);
3176 * Must be called with sessions_mutex held.
3179 int _lttng_type_statedump(struct lttng_session
*session
,
3180 const struct lttng_type
*type
,
3185 switch (type
->atype
) {
3187 ret
= _lttng_integer_type_statedump(session
, type
, nesting
);
3189 case atype_enum_nestable
:
3190 ret
= _lttng_enum_type_statedump(session
, type
, nesting
);
3193 ret
= _lttng_string_type_statedump(session
, type
, nesting
);
3195 case atype_struct_nestable
:
3196 ret
= _lttng_struct_type_statedump(session
, type
, nesting
);
3198 case atype_variant_nestable
:
3199 ret
= _lttng_variant_type_statedump(session
, type
, nesting
);
3202 /* Nested arrays and sequences are not supported yet. */
3203 case atype_array_nestable
:
3204 case atype_sequence_nestable
:
3213 * Must be called with sessions_mutex held.
3216 int _lttng_field_statedump(struct lttng_session
*session
,
3217 const struct lttng_event_field
*field
,
3222 switch (field
->type
.atype
) {
3224 ret
= _lttng_integer_field_statedump(session
, field
, nesting
);
3226 case atype_enum_nestable
:
3227 ret
= _lttng_enum_field_statedump(session
, field
, nesting
);
3230 ret
= _lttng_string_field_statedump(session
, field
, nesting
);
3232 case atype_struct_nestable
:
3233 ret
= _lttng_struct_field_statedump(session
, field
, nesting
);
3235 case atype_array_nestable
:
3236 ret
= _lttng_array_field_statedump(session
, field
, nesting
);
3238 case atype_sequence_nestable
:
3239 ret
= _lttng_sequence_field_statedump(session
, field
, nesting
);
3241 case atype_variant_nestable
:
3242 ret
= _lttng_variant_field_statedump(session
, field
, nesting
);
3253 int _lttng_context_metadata_statedump(struct lttng_session
*session
,
3254 struct lttng_ctx
*ctx
)
3261 for (i
= 0; i
< ctx
->nr_fields
; i
++) {
3262 const struct lttng_ctx_field
*field
= &ctx
->fields
[i
];
3264 ret
= _lttng_field_statedump(session
, &field
->event_field
, 2);
3272 int _lttng_fields_metadata_statedump(struct lttng_session
*session
,
3273 struct lttng_event
*event
)
3275 const struct lttng_event_desc
*desc
= event
->desc
;
3279 for (i
= 0; i
< desc
->nr_fields
; i
++) {
3280 const struct lttng_event_field
*field
= &desc
->fields
[i
];
3282 ret
= _lttng_field_statedump(session
, field
, 2);
3290 * Must be called with sessions_mutex held.
3291 * The entire event metadata is printed as a single atomic metadata
3295 int _lttng_event_metadata_statedump(struct lttng_session
*session
,
3296 struct lttng_channel
*chan
,
3297 struct lttng_event
*event
)
3301 if (event
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3303 if (chan
->channel_type
== METADATA_CHANNEL
)
3306 lttng_metadata_begin(session
);
3308 ret
= lttng_metadata_printf(session
,
3312 " stream_id = %u;\n",
3320 ret
= lttng_metadata_printf(session
,
3321 " context := struct {\n");
3325 ret
= _lttng_context_metadata_statedump(session
, event
->ctx
);
3329 ret
= lttng_metadata_printf(session
,
3335 ret
= lttng_metadata_printf(session
,
3336 " fields := struct {\n"
3341 ret
= _lttng_fields_metadata_statedump(session
, event
);
3346 * LTTng space reservation can only reserve multiples of the
3349 ret
= lttng_metadata_printf(session
,
3355 event
->metadata_dumped
= 1;
3357 lttng_metadata_end(session
);
3363 * Must be called with sessions_mutex held.
3364 * The entire channel metadata is printed as a single atomic metadata
3368 int _lttng_channel_metadata_statedump(struct lttng_session
*session
,
3369 struct lttng_channel
*chan
)
3373 if (chan
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3376 if (chan
->channel_type
== METADATA_CHANNEL
)
3379 lttng_metadata_begin(session
);
3381 WARN_ON_ONCE(!chan
->header_type
);
3382 ret
= lttng_metadata_printf(session
,
3385 " event.header := %s;\n"
3386 " packet.context := struct packet_context;\n",
3388 chan
->header_type
== 1 ? "struct event_header_compact" :
3389 "struct event_header_large");
3394 ret
= lttng_metadata_printf(session
,
3395 " event.context := struct {\n");
3399 ret
= _lttng_context_metadata_statedump(session
, chan
->ctx
);
3403 ret
= lttng_metadata_printf(session
,
3409 ret
= lttng_metadata_printf(session
,
3412 chan
->metadata_dumped
= 1;
3414 lttng_metadata_end(session
);
3419 * Must be called with sessions_mutex held.
3422 int _lttng_stream_packet_context_declare(struct lttng_session
*session
)
3424 return lttng_metadata_printf(session
,
3425 "struct packet_context {\n"
3426 " uint64_clock_monotonic_t timestamp_begin;\n"
3427 " uint64_clock_monotonic_t timestamp_end;\n"
3428 " uint64_t content_size;\n"
3429 " uint64_t packet_size;\n"
3430 " uint64_t packet_seq_num;\n"
3431 " unsigned long events_discarded;\n"
3432 " uint32_t cpu_id;\n"
3439 * id: range: 0 - 30.
3440 * id 31 is reserved to indicate an extended header.
3443 * id: range: 0 - 65534.
3444 * id 65535 is reserved to indicate an extended header.
3446 * Must be called with sessions_mutex held.
3449 int _lttng_event_header_declare(struct lttng_session
*session
)
3451 return lttng_metadata_printf(session
,
3452 "struct event_header_compact {\n"
3453 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3456 " uint27_clock_monotonic_t timestamp;\n"
3460 " uint64_clock_monotonic_t timestamp;\n"
3465 "struct event_header_large {\n"
3466 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3469 " uint32_clock_monotonic_t timestamp;\n"
3473 " uint64_clock_monotonic_t timestamp;\n"
3477 lttng_alignof(uint32_t) * CHAR_BIT
,
3478 lttng_alignof(uint16_t) * CHAR_BIT
3483 * Approximation of NTP time of day to clock monotonic correlation,
3484 * taken at start of trace.
3485 * Yes, this is only an approximation. Yes, we can (and will) do better
3486 * in future versions.
3487 * This function may return a negative offset. It may happen if the
3488 * system sets the REALTIME clock to 0 after boot.
3490 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3494 int64_t measure_clock_offset(void)
3496 uint64_t monotonic_avg
, monotonic
[2], realtime
;
3497 uint64_t tcf
= trace_clock_freq();
3499 unsigned long flags
;
3500 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3501 struct timespec64 rts
= { 0, 0 };
3503 struct timespec rts
= { 0, 0 };
3506 /* Disable interrupts to increase correlation precision. */
3507 local_irq_save(flags
);
3508 monotonic
[0] = trace_clock_read64();
3509 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3510 ktime_get_real_ts64(&rts
);
3512 getnstimeofday(&rts
);
3514 monotonic
[1] = trace_clock_read64();
3515 local_irq_restore(flags
);
3517 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
3518 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
3519 if (tcf
== NSEC_PER_SEC
) {
3520 realtime
+= rts
.tv_nsec
;
3522 uint64_t n
= rts
.tv_nsec
* tcf
;
3524 do_div(n
, NSEC_PER_SEC
);
3527 offset
= (int64_t) realtime
- monotonic_avg
;
3532 int print_escaped_ctf_string(struct lttng_session
*session
, const char *string
)
3540 while (cur
!= '\0') {
3543 ret
= lttng_metadata_printf(session
, "%s", "\\n");
3547 ret
= lttng_metadata_printf(session
, "%c", '\\');
3550 /* We still print the current char */
3553 ret
= lttng_metadata_printf(session
, "%c", cur
);
3567 int print_metadata_escaped_field(struct lttng_session
*session
, const char *field
,
3568 const char *field_value
)
3572 ret
= lttng_metadata_printf(session
, " %s = \"", field
);
3576 ret
= print_escaped_ctf_string(session
, field_value
);
3580 ret
= lttng_metadata_printf(session
, "\";\n");
3587 * Output metadata into this session's metadata buffers.
3588 * Must be called with sessions_mutex held.
3591 int _lttng_session_metadata_statedump(struct lttng_session
*session
)
3593 unsigned char *uuid_c
= session
->uuid
.b
;
3594 unsigned char uuid_s
[37], clock_uuid_s
[BOOT_ID_LEN
];
3595 const char *product_uuid
;
3596 struct lttng_channel
*chan
;
3597 struct lttng_event
*event
;
3600 if (!LTTNG_READ_ONCE(session
->active
))
3603 lttng_metadata_begin(session
);
3605 if (session
->metadata_dumped
)
3608 snprintf(uuid_s
, sizeof(uuid_s
),
3609 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3610 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
3611 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
3612 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
3613 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
3615 ret
= lttng_metadata_printf(session
,
3616 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3617 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3618 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3619 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
3620 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
3621 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
3622 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
3628 " byte_order = %s;\n"
3629 " packet.header := struct {\n"
3630 " uint32_t magic;\n"
3631 " uint8_t uuid[16];\n"
3632 " uint32_t stream_id;\n"
3633 " uint64_t stream_instance_id;\n"
3636 lttng_alignof(uint8_t) * CHAR_BIT
,
3637 lttng_alignof(uint16_t) * CHAR_BIT
,
3638 lttng_alignof(uint32_t) * CHAR_BIT
,
3639 lttng_alignof(uint64_t) * CHAR_BIT
,
3640 sizeof(unsigned long) * CHAR_BIT
,
3641 lttng_alignof(unsigned long) * CHAR_BIT
,
3645 #if __BYTE_ORDER == __BIG_ENDIAN
3654 ret
= lttng_metadata_printf(session
,
3656 " hostname = \"%s\";\n"
3657 " domain = \"kernel\";\n"
3658 " sysname = \"%s\";\n"
3659 " kernel_release = \"%s\";\n"
3660 " kernel_version = \"%s\";\n"
3661 " tracer_name = \"lttng-modules\";\n"
3662 " tracer_major = %d;\n"
3663 " tracer_minor = %d;\n"
3664 " tracer_patchlevel = %d;\n"
3665 " trace_buffering_scheme = \"global\";\n",
3666 current
->nsproxy
->uts_ns
->name
.nodename
,
3670 LTTNG_MODULES_MAJOR_VERSION
,
3671 LTTNG_MODULES_MINOR_VERSION
,
3672 LTTNG_MODULES_PATCHLEVEL_VERSION
3677 ret
= print_metadata_escaped_field(session
, "trace_name", session
->name
);
3680 ret
= print_metadata_escaped_field(session
, "trace_creation_datetime",
3681 session
->creation_time
);
3685 /* Add the product UUID to the 'env' section */
3686 product_uuid
= dmi_get_system_info(DMI_PRODUCT_UUID
);
3688 ret
= lttng_metadata_printf(session
,
3689 " product_uuid = \"%s\";\n",
3696 /* Close the 'env' section */
3697 ret
= lttng_metadata_printf(session
, "};\n\n");
3701 ret
= lttng_metadata_printf(session
,
3703 " name = \"%s\";\n",
3709 if (!trace_clock_uuid(clock_uuid_s
)) {
3710 ret
= lttng_metadata_printf(session
,
3711 " uuid = \"%s\";\n",
3718 ret
= lttng_metadata_printf(session
,
3719 " description = \"%s\";\n"
3720 " freq = %llu; /* Frequency, in Hz */\n"
3721 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
3724 trace_clock_description(),
3725 (unsigned long long) trace_clock_freq(),
3726 (long long) measure_clock_offset()
3731 ret
= lttng_metadata_printf(session
,
3732 "typealias integer {\n"
3733 " size = 27; align = 1; signed = false;\n"
3734 " map = clock.%s.value;\n"
3735 "} := uint27_clock_monotonic_t;\n"
3737 "typealias integer {\n"
3738 " size = 32; align = %u; signed = false;\n"
3739 " map = clock.%s.value;\n"
3740 "} := uint32_clock_monotonic_t;\n"
3742 "typealias integer {\n"
3743 " size = 64; align = %u; signed = false;\n"
3744 " map = clock.%s.value;\n"
3745 "} := uint64_clock_monotonic_t;\n\n",
3747 lttng_alignof(uint32_t) * CHAR_BIT
,
3749 lttng_alignof(uint64_t) * CHAR_BIT
,
3755 ret
= _lttng_stream_packet_context_declare(session
);
3759 ret
= _lttng_event_header_declare(session
);
3764 list_for_each_entry(chan
, &session
->chan
, list
) {
3765 ret
= _lttng_channel_metadata_statedump(session
, chan
);
3770 list_for_each_entry(event
, &session
->events
, list
) {
3771 ret
= _lttng_event_metadata_statedump(session
, event
->chan
, event
);
3775 session
->metadata_dumped
= 1;
3777 lttng_metadata_end(session
);
3782 * lttng_transport_register - LTT transport registration
3783 * @transport: transport structure
3785 * Registers a transport which can be used as output to extract the data out of
3786 * LTTng. The module calling this registration function must ensure that no
3787 * trap-inducing code will be executed by the transport functions. E.g.
3788 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
3789 * is made visible to the transport function. This registration acts as a
3790 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
3791 * after its registration must it synchronize the TLBs.
3793 void lttng_transport_register(struct lttng_transport
*transport
)
3796 * Make sure no page fault can be triggered by the module about to be
3797 * registered. We deal with this here so we don't have to call
3798 * vmalloc_sync_mappings() in each module's init.
3800 wrapper_vmalloc_sync_mappings();
3802 mutex_lock(&sessions_mutex
);
3803 list_add_tail(&transport
->node
, <tng_transport_list
);
3804 mutex_unlock(&sessions_mutex
);
3806 EXPORT_SYMBOL_GPL(lttng_transport_register
);
3809 * lttng_transport_unregister - LTT transport unregistration
3810 * @transport: transport structure
3812 void lttng_transport_unregister(struct lttng_transport
*transport
)
3814 mutex_lock(&sessions_mutex
);
3815 list_del(&transport
->node
);
3816 mutex_unlock(&sessions_mutex
);
3818 EXPORT_SYMBOL_GPL(lttng_transport_unregister
);
3820 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
3822 enum cpuhp_state lttng_hp_prepare
;
3823 enum cpuhp_state lttng_hp_online
;
3825 static int lttng_hotplug_prepare(unsigned int cpu
, struct hlist_node
*node
)
3827 struct lttng_cpuhp_node
*lttng_node
;
3829 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
3830 switch (lttng_node
->component
) {
3831 case LTTNG_RING_BUFFER_FRONTEND
:
3833 case LTTNG_RING_BUFFER_BACKEND
:
3834 return lttng_cpuhp_rb_backend_prepare(cpu
, lttng_node
);
3835 case LTTNG_RING_BUFFER_ITER
:
3837 case LTTNG_CONTEXT_PERF_COUNTERS
:
3844 static int lttng_hotplug_dead(unsigned int cpu
, struct hlist_node
*node
)
3846 struct lttng_cpuhp_node
*lttng_node
;
3848 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
3849 switch (lttng_node
->component
) {
3850 case LTTNG_RING_BUFFER_FRONTEND
:
3851 return lttng_cpuhp_rb_frontend_dead(cpu
, lttng_node
);
3852 case LTTNG_RING_BUFFER_BACKEND
:
3854 case LTTNG_RING_BUFFER_ITER
:
3856 case LTTNG_CONTEXT_PERF_COUNTERS
:
3857 return lttng_cpuhp_perf_counter_dead(cpu
, lttng_node
);
3863 static int lttng_hotplug_online(unsigned int cpu
, struct hlist_node
*node
)
3865 struct lttng_cpuhp_node
*lttng_node
;
3867 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
3868 switch (lttng_node
->component
) {
3869 case LTTNG_RING_BUFFER_FRONTEND
:
3870 return lttng_cpuhp_rb_frontend_online(cpu
, lttng_node
);
3871 case LTTNG_RING_BUFFER_BACKEND
:
3873 case LTTNG_RING_BUFFER_ITER
:
3874 return lttng_cpuhp_rb_iter_online(cpu
, lttng_node
);
3875 case LTTNG_CONTEXT_PERF_COUNTERS
:
3876 return lttng_cpuhp_perf_counter_online(cpu
, lttng_node
);
3882 static int lttng_hotplug_offline(unsigned int cpu
, struct hlist_node
*node
)
3884 struct lttng_cpuhp_node
*lttng_node
;
3886 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
3887 switch (lttng_node
->component
) {
3888 case LTTNG_RING_BUFFER_FRONTEND
:
3889 return lttng_cpuhp_rb_frontend_offline(cpu
, lttng_node
);
3890 case LTTNG_RING_BUFFER_BACKEND
:
3892 case LTTNG_RING_BUFFER_ITER
:
3894 case LTTNG_CONTEXT_PERF_COUNTERS
:
3901 static int __init
lttng_init_cpu_hotplug(void)
3905 ret
= cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN
, "lttng:prepare",
3906 lttng_hotplug_prepare
,
3907 lttng_hotplug_dead
);
3911 lttng_hp_prepare
= ret
;
3912 lttng_rb_set_hp_prepare(ret
);
3914 ret
= cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN
, "lttng:online",
3915 lttng_hotplug_online
,
3916 lttng_hotplug_offline
);
3918 cpuhp_remove_multi_state(lttng_hp_prepare
);
3919 lttng_hp_prepare
= 0;
3922 lttng_hp_online
= ret
;
3923 lttng_rb_set_hp_online(ret
);
3928 static void __exit
lttng_exit_cpu_hotplug(void)
3930 lttng_rb_set_hp_online(0);
3931 cpuhp_remove_multi_state(lttng_hp_online
);
3932 lttng_rb_set_hp_prepare(0);
3933 cpuhp_remove_multi_state(lttng_hp_prepare
);
3936 #else /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
3937 static int lttng_init_cpu_hotplug(void)
3941 static void lttng_exit_cpu_hotplug(void)
3944 #endif /* #else #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
3947 static int __init
lttng_events_init(void)
3951 ret
= wrapper_lttng_fixup_sig(THIS_MODULE
);
3954 ret
= wrapper_get_pfnblock_flags_mask_init();
3957 ret
= wrapper_get_pageblock_flags_mask_init();
3960 ret
= lttng_probes_init();
3963 ret
= lttng_context_init();
3966 ret
= lttng_tracepoint_init();
3969 event_cache
= KMEM_CACHE(lttng_event
, 0);
3972 goto error_kmem_event
;
3974 event_notifier_cache
= KMEM_CACHE(lttng_event_notifier
, 0);
3975 if (!event_notifier_cache
) {
3977 goto error_kmem_event_notifier
;
3979 ret
= lttng_abi_init();
3982 ret
= lttng_logger_init();
3985 ret
= lttng_init_cpu_hotplug();
3988 printk(KERN_NOTICE
"LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
3989 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
3990 __stringify(LTTNG_MODULES_MINOR_VERSION
),
3991 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
3992 LTTNG_MODULES_EXTRAVERSION
,
3994 #ifdef LTTNG_EXTRA_VERSION_GIT
3995 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
3999 #ifdef LTTNG_EXTRA_VERSION_NAME
4000 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4007 lttng_logger_exit();
4011 kmem_cache_destroy(event_notifier_cache
);
4012 error_kmem_event_notifier
:
4013 kmem_cache_destroy(event_cache
);
4015 lttng_tracepoint_exit();
4017 lttng_context_exit();
4018 printk(KERN_NOTICE
"LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4019 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4020 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4021 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4022 LTTNG_MODULES_EXTRAVERSION
,
4024 #ifdef LTTNG_EXTRA_VERSION_GIT
4025 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4029 #ifdef LTTNG_EXTRA_VERSION_NAME
4030 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4037 module_init(lttng_events_init
);
4039 static void __exit
lttng_events_exit(void)
4041 struct lttng_session
*session
, *tmpsession
;
4043 lttng_exit_cpu_hotplug();
4044 lttng_logger_exit();
4046 list_for_each_entry_safe(session
, tmpsession
, &sessions
, list
)
4047 lttng_session_destroy(session
);
4048 kmem_cache_destroy(event_cache
);
4049 kmem_cache_destroy(event_notifier_cache
);
4050 lttng_tracepoint_exit();
4051 lttng_context_exit();
4052 printk(KERN_NOTICE
"LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4053 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4054 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4055 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4056 LTTNG_MODULES_EXTRAVERSION
,
4058 #ifdef LTTNG_EXTRA_VERSION_GIT
4059 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4063 #ifdef LTTNG_EXTRA_VERSION_NAME
4064 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4070 module_exit(lttng_events_exit
);
4072 #include <generated/patches.h>
4073 #ifdef LTTNG_EXTRA_VERSION_GIT
4074 MODULE_INFO(extra_version_git
, LTTNG_EXTRA_VERSION_GIT
);
4076 #ifdef LTTNG_EXTRA_VERSION_NAME
4077 MODULE_INFO(extra_version_name
, LTTNG_EXTRA_VERSION_NAME
);
4079 MODULE_LICENSE("GPL and additional rights");
4080 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4081 MODULE_DESCRIPTION("LTTng tracer");
4082 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
4083 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
4084 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
4085 LTTNG_MODULES_EXTRAVERSION
);