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/compiler_attributes.h>
32 #include <wrapper/uuid.h>
33 #include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */
34 #include <wrapper/random.h>
35 #include <wrapper/tracepoint.h>
36 #include <wrapper/list.h>
37 #include <wrapper/types.h>
38 #include <lttng/kernel-version.h>
39 #include <lttng/events.h>
40 #include <lttng/events-internal.h>
41 #include <lttng/lttng-bytecode.h>
42 #include <lttng/tracer.h>
43 #include <lttng/event-notifier-notification.h>
44 #include <lttng/abi-old.h>
45 #include <lttng/endian.h>
46 #include <lttng/string-utils.h>
47 #include <lttng/utils.h>
48 #include <ringbuffer/backend.h>
49 #include <ringbuffer/frontend.h>
50 #include <wrapper/time.h>
52 #define METADATA_CACHE_DEFAULT_SIZE 4096
54 static LIST_HEAD(sessions
);
55 static LIST_HEAD(event_notifier_groups
);
56 static LIST_HEAD(lttng_transport_list
);
57 static LIST_HEAD(lttng_counter_transport_list
);
59 * Protect the sessions and metadata caches.
61 static DEFINE_MUTEX(sessions_mutex
);
62 static struct kmem_cache
*event_recorder_cache
;
63 static struct kmem_cache
*event_recorder_private_cache
;
64 static struct kmem_cache
*event_notifier_cache
;
65 static struct kmem_cache
*event_notifier_private_cache
;
67 static void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
);
68 static void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
);
69 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
);
70 static void lttng_event_enabler_sync(struct lttng_event_enabler_common
*event_enabler
);
72 static void _lttng_event_destroy(struct lttng_kernel_event_common
*event
);
73 static void _lttng_channel_destroy(struct lttng_kernel_channel_buffer
*chan
);
74 static int _lttng_event_unregister(struct lttng_kernel_event_common
*event
);
76 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
77 struct lttng_kernel_channel_buffer
*chan
,
78 struct lttng_kernel_event_recorder
*event
);
80 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
);
82 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
);
84 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
85 const struct lttng_kernel_type_common
*type
,
86 enum lttng_kernel_string_encoding parent_encoding
,
89 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
90 const struct lttng_kernel_event_field
*field
,
91 size_t nesting
, const char **prev_field_name_p
);
93 void synchronize_trace(void)
95 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,1,0) || \
96 LTTNG_RHEL_KERNEL_RANGE(4,18,0,193,0,0, 4,19,0,0,0,0))
102 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0))
103 #ifdef CONFIG_PREEMPT_RT_FULL
106 #else /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
107 #ifdef CONFIG_PREEMPT_RT
110 #endif /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
113 void lttng_lock_sessions(void)
115 mutex_lock(&sessions_mutex
);
118 void lttng_unlock_sessions(void)
120 mutex_unlock(&sessions_mutex
);
123 static struct lttng_transport
*lttng_transport_find(const char *name
)
125 struct lttng_transport
*transport
;
127 list_for_each_entry(transport
, <tng_transport_list
, node
) {
128 if (!strcmp(transport
->name
, name
))
135 * Called with sessions lock held.
137 int lttng_session_active(void)
139 struct lttng_kernel_session_private
*iter
;
141 list_for_each_entry(iter
, &sessions
, list
) {
142 if (iter
->pub
->active
)
148 struct lttng_kernel_session
*lttng_session_create(void)
150 struct lttng_kernel_session
*session
;
151 struct lttng_kernel_session_private
*session_priv
;
152 struct lttng_metadata_cache
*metadata_cache
;
155 mutex_lock(&sessions_mutex
);
156 session
= lttng_kvzalloc(sizeof(*session
), GFP_KERNEL
);
159 session_priv
= lttng_kvzalloc(sizeof(*session_priv
), GFP_KERNEL
);
161 goto err_free_session
;
162 session
->priv
= session_priv
;
163 session_priv
->pub
= session
;
165 INIT_LIST_HEAD(&session_priv
->chan
);
166 INIT_LIST_HEAD(&session_priv
->events
);
167 lttng_guid_gen(&session_priv
->uuid
);
169 metadata_cache
= kzalloc(sizeof(struct lttng_metadata_cache
),
172 goto err_free_session_private
;
173 metadata_cache
->data
= vzalloc(METADATA_CACHE_DEFAULT_SIZE
);
174 if (!metadata_cache
->data
)
176 metadata_cache
->cache_alloc
= METADATA_CACHE_DEFAULT_SIZE
;
177 kref_init(&metadata_cache
->refcount
);
178 mutex_init(&metadata_cache
->lock
);
179 session_priv
->metadata_cache
= metadata_cache
;
180 INIT_LIST_HEAD(&metadata_cache
->metadata_stream
);
181 memcpy(&metadata_cache
->uuid
, &session_priv
->uuid
,
182 sizeof(metadata_cache
->uuid
));
183 INIT_LIST_HEAD(&session_priv
->enablers_head
);
184 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
185 INIT_HLIST_HEAD(&session_priv
->events_ht
.table
[i
]);
186 list_add(&session_priv
->list
, &sessions
);
188 if (lttng_id_tracker_init(&session
->pid_tracker
, session
, TRACKER_PID
))
189 goto tracker_alloc_error
;
190 if (lttng_id_tracker_init(&session
->vpid_tracker
, session
, TRACKER_VPID
))
191 goto tracker_alloc_error
;
192 if (lttng_id_tracker_init(&session
->uid_tracker
, session
, TRACKER_UID
))
193 goto tracker_alloc_error
;
194 if (lttng_id_tracker_init(&session
->vuid_tracker
, session
, TRACKER_VUID
))
195 goto tracker_alloc_error
;
196 if (lttng_id_tracker_init(&session
->gid_tracker
, session
, TRACKER_GID
))
197 goto tracker_alloc_error
;
198 if (lttng_id_tracker_init(&session
->vgid_tracker
, session
, TRACKER_VGID
))
199 goto tracker_alloc_error
;
201 mutex_unlock(&sessions_mutex
);
206 lttng_id_tracker_fini(&session
->pid_tracker
);
207 lttng_id_tracker_fini(&session
->vpid_tracker
);
208 lttng_id_tracker_fini(&session
->uid_tracker
);
209 lttng_id_tracker_fini(&session
->vuid_tracker
);
210 lttng_id_tracker_fini(&session
->gid_tracker
);
211 lttng_id_tracker_fini(&session
->vgid_tracker
);
213 kfree(metadata_cache
);
214 err_free_session_private
:
215 lttng_kvfree(session_priv
);
217 lttng_kvfree(session
);
219 mutex_unlock(&sessions_mutex
);
224 struct lttng_counter_transport
*lttng_counter_transport_find(const char *name
)
226 struct lttng_counter_transport
*transport
;
228 list_for_each_entry(transport
, <tng_counter_transport_list
, node
) {
229 if (!strcmp(transport
->name
, name
))
235 struct lttng_counter
*lttng_kernel_counter_create(
236 const char *counter_transport_name
,
237 size_t number_dimensions
, const size_t *dimensions_sizes
)
239 struct lttng_counter
*counter
= NULL
;
240 struct lttng_counter_transport
*counter_transport
= NULL
;
242 counter_transport
= lttng_counter_transport_find(counter_transport_name
);
243 if (!counter_transport
) {
244 printk(KERN_WARNING
"LTTng: counter transport %s not found.\n",
245 counter_transport_name
);
248 if (!try_module_get(counter_transport
->owner
)) {
249 printk(KERN_WARNING
"LTTng: Can't lock counter transport module.\n");
253 counter
= lttng_kvzalloc(sizeof(struct lttng_counter
), GFP_KERNEL
);
257 /* Create event notifier error counter. */
258 counter
->ops
= &counter_transport
->ops
;
259 counter
->transport
= counter_transport
;
261 counter
->counter
= counter
->ops
->counter_create(
262 number_dimensions
, dimensions_sizes
, 0);
263 if (!counter
->counter
) {
270 lttng_kvfree(counter
);
272 if (counter_transport
)
273 module_put(counter_transport
->owner
);
278 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
280 struct lttng_transport
*transport
= NULL
;
281 struct lttng_event_notifier_group
*event_notifier_group
;
282 const char *transport_name
= "relay-event-notifier";
283 size_t subbuf_size
= 4096; //TODO
284 size_t num_subbuf
= 16; //TODO
285 unsigned int switch_timer_interval
= 0;
286 unsigned int read_timer_interval
= 0;
289 mutex_lock(&sessions_mutex
);
291 transport
= lttng_transport_find(transport_name
);
293 printk(KERN_WARNING
"LTTng: transport %s not found\n",
297 if (!try_module_get(transport
->owner
)) {
298 printk(KERN_WARNING
"LTTng: Can't lock transport %s module.\n",
303 event_notifier_group
= lttng_kvzalloc(sizeof(struct lttng_event_notifier_group
),
305 if (!event_notifier_group
)
309 * Initialize the ring buffer used to store event notifier
312 event_notifier_group
->ops
= &transport
->ops
;
313 event_notifier_group
->chan
= transport
->ops
.priv
->channel_create(
314 transport_name
, event_notifier_group
, NULL
,
315 subbuf_size
, num_subbuf
, switch_timer_interval
,
316 read_timer_interval
);
317 if (!event_notifier_group
->chan
)
320 event_notifier_group
->transport
= transport
;
322 INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
323 INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
324 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
325 INIT_HLIST_HEAD(&event_notifier_group
->events_ht
.table
[i
]);
327 list_add(&event_notifier_group
->node
, &event_notifier_groups
);
329 mutex_unlock(&sessions_mutex
);
331 return event_notifier_group
;
334 lttng_kvfree(event_notifier_group
);
337 module_put(transport
->owner
);
339 mutex_unlock(&sessions_mutex
);
343 void metadata_cache_destroy(struct kref
*kref
)
345 struct lttng_metadata_cache
*cache
=
346 container_of(kref
, struct lttng_metadata_cache
, refcount
);
351 void lttng_session_destroy(struct lttng_kernel_session
*session
)
353 struct lttng_kernel_channel_buffer_private
*chan_priv
, *tmpchan_priv
;
354 struct lttng_kernel_event_recorder_private
*event_recorder_priv
, *tmpevent_recorder_priv
;
355 struct lttng_metadata_stream
*metadata_stream
;
356 struct lttng_event_recorder_enabler
*event_recorder_enabler
, *tmp_event_recorder_enabler
;
359 mutex_lock(&sessions_mutex
);
360 WRITE_ONCE(session
->active
, 0);
361 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
362 ret
= lttng_syscalls_unregister_syscall_table(&chan_priv
->parent
.syscall_table
);
365 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, parent
.node
) {
366 ret
= _lttng_event_unregister(&event_recorder_priv
->pub
->parent
);
369 synchronize_trace(); /* Wait for in-flight events to complete */
370 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
371 ret
= lttng_syscalls_destroy_syscall_table(&chan_priv
->parent
.syscall_table
);
374 list_for_each_entry_safe(event_recorder_enabler
, tmp_event_recorder_enabler
,
375 &session
->priv
->enablers_head
, node
)
376 lttng_event_enabler_destroy(&event_recorder_enabler
->parent
);
377 list_for_each_entry_safe(event_recorder_priv
, tmpevent_recorder_priv
, &session
->priv
->events
, parent
.node
)
378 _lttng_event_destroy(&event_recorder_priv
->pub
->parent
);
379 list_for_each_entry_safe(chan_priv
, tmpchan_priv
, &session
->priv
->chan
, node
) {
380 BUG_ON(chan_priv
->channel_type
== METADATA_CHANNEL
);
381 _lttng_channel_destroy(chan_priv
->pub
);
383 mutex_lock(&session
->priv
->metadata_cache
->lock
);
384 list_for_each_entry(metadata_stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
385 _lttng_metadata_channel_hangup(metadata_stream
);
386 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
387 lttng_id_tracker_fini(&session
->pid_tracker
);
388 lttng_id_tracker_fini(&session
->vpid_tracker
);
389 lttng_id_tracker_fini(&session
->uid_tracker
);
390 lttng_id_tracker_fini(&session
->vuid_tracker
);
391 lttng_id_tracker_fini(&session
->gid_tracker
);
392 lttng_id_tracker_fini(&session
->vgid_tracker
);
393 kref_put(&session
->priv
->metadata_cache
->refcount
, metadata_cache_destroy
);
394 list_del(&session
->priv
->list
);
395 mutex_unlock(&sessions_mutex
);
396 lttng_kvfree(session
->priv
);
397 lttng_kvfree(session
);
400 void lttng_event_notifier_group_destroy(
401 struct lttng_event_notifier_group
*event_notifier_group
)
403 struct lttng_event_notifier_enabler
*event_notifier_enabler
, *tmp_event_notifier_enabler
;
404 struct lttng_kernel_event_notifier_private
*event_notifier_priv
, *tmpevent_notifier_priv
;
407 if (!event_notifier_group
)
410 mutex_lock(&sessions_mutex
);
412 ret
= lttng_syscalls_unregister_syscall_table(&event_notifier_group
->syscall_table
);
415 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
416 &event_notifier_group
->event_notifiers_head
, parent
.node
) {
417 ret
= _lttng_event_unregister(&event_notifier_priv
->pub
->parent
);
421 /* Wait for in-flight event notifier to complete */
424 irq_work_sync(&event_notifier_group
->wakeup_pending
);
426 ret
= lttng_syscalls_destroy_syscall_table(&event_notifier_group
->syscall_table
);
429 list_for_each_entry_safe(event_notifier_enabler
, tmp_event_notifier_enabler
,
430 &event_notifier_group
->enablers_head
, node
)
431 lttng_event_enabler_destroy(&event_notifier_enabler
->parent
);
433 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
434 &event_notifier_group
->event_notifiers_head
, parent
.node
)
435 _lttng_event_destroy(&event_notifier_priv
->pub
->parent
);
437 if (event_notifier_group
->error_counter
) {
438 struct lttng_counter
*error_counter
= event_notifier_group
->error_counter
;
440 error_counter
->ops
->counter_destroy(error_counter
->counter
);
441 module_put(error_counter
->transport
->owner
);
442 lttng_kvfree(error_counter
);
443 event_notifier_group
->error_counter
= NULL
;
446 event_notifier_group
->ops
->priv
->channel_destroy(event_notifier_group
->chan
);
447 module_put(event_notifier_group
->transport
->owner
);
448 list_del(&event_notifier_group
->node
);
450 mutex_unlock(&sessions_mutex
);
451 lttng_kvfree(event_notifier_group
);
454 int lttng_session_statedump(struct lttng_kernel_session
*session
)
458 mutex_lock(&sessions_mutex
);
459 ret
= lttng_statedump_start(session
);
460 mutex_unlock(&sessions_mutex
);
464 int lttng_session_enable(struct lttng_kernel_session
*session
)
467 struct lttng_kernel_channel_buffer_private
*chan_priv
;
469 mutex_lock(&sessions_mutex
);
470 if (session
->active
) {
475 /* Set transient enabler state to "enabled" */
476 session
->priv
->tstate
= 1;
478 /* We need to sync enablers with session before activation. */
479 lttng_session_sync_event_enablers(session
);
482 * Snapshot the number of events per channel to know the type of header
485 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
486 if (chan_priv
->header_type
)
487 continue; /* don't change it if session stop/restart */
488 if (chan_priv
->free_event_id
< 31)
489 chan_priv
->header_type
= 1; /* compact */
491 chan_priv
->header_type
= 2; /* large */
494 /* Clear each stream's quiescent state. */
495 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
496 if (chan_priv
->channel_type
!= METADATA_CHANNEL
)
497 lib_ring_buffer_clear_quiescent_channel(chan_priv
->rb_chan
);
500 WRITE_ONCE(session
->active
, 1);
501 WRITE_ONCE(session
->priv
->been_active
, 1);
502 ret
= _lttng_session_metadata_statedump(session
);
504 WRITE_ONCE(session
->active
, 0);
507 ret
= lttng_statedump_start(session
);
509 WRITE_ONCE(session
->active
, 0);
511 mutex_unlock(&sessions_mutex
);
515 int lttng_session_disable(struct lttng_kernel_session
*session
)
518 struct lttng_kernel_channel_buffer_private
*chan_priv
;
520 mutex_lock(&sessions_mutex
);
521 if (!session
->active
) {
525 WRITE_ONCE(session
->active
, 0);
527 /* Set transient enabler state to "disabled" */
528 session
->priv
->tstate
= 0;
529 lttng_session_sync_event_enablers(session
);
531 /* Set each stream's quiescent state. */
532 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
533 if (chan_priv
->channel_type
!= METADATA_CHANNEL
)
534 lib_ring_buffer_set_quiescent_channel(chan_priv
->rb_chan
);
537 mutex_unlock(&sessions_mutex
);
541 int lttng_session_metadata_regenerate(struct lttng_kernel_session
*session
)
544 struct lttng_kernel_channel_buffer_private
*chan_priv
;
545 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
546 struct lttng_metadata_cache
*cache
= session
->priv
->metadata_cache
;
547 struct lttng_metadata_stream
*stream
;
549 mutex_lock(&sessions_mutex
);
550 if (!session
->active
) {
555 mutex_lock(&cache
->lock
);
556 memset(cache
->data
, 0, cache
->cache_alloc
);
557 cache
->metadata_written
= 0;
559 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
) {
560 stream
->metadata_out
= 0;
561 stream
->metadata_in
= 0;
563 mutex_unlock(&cache
->lock
);
565 session
->priv
->metadata_dumped
= 0;
566 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
567 chan_priv
->metadata_dumped
= 0;
570 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, parent
.node
) {
571 event_recorder_priv
->metadata_dumped
= 0;
574 ret
= _lttng_session_metadata_statedump(session
);
577 mutex_unlock(&sessions_mutex
);
582 bool is_channel_buffer_metadata(struct lttng_kernel_channel_common
*channel
)
584 struct lttng_kernel_channel_buffer
*chan_buf
;
586 if (channel
->type
!= LTTNG_KERNEL_CHANNEL_TYPE_BUFFER
)
588 chan_buf
= container_of(channel
, struct lttng_kernel_channel_buffer
, parent
);
589 if (chan_buf
->priv
->channel_type
== METADATA_CHANNEL
)
594 int lttng_channel_enable(struct lttng_kernel_channel_common
*channel
)
598 mutex_lock(&sessions_mutex
);
599 if (is_channel_buffer_metadata(channel
)) {
603 if (channel
->enabled
) {
607 /* Set transient enabler state to "enabled" */
608 channel
->priv
->tstate
= 1;
609 lttng_session_sync_event_enablers(channel
->session
);
610 /* Set atomically the state to "enabled" */
611 WRITE_ONCE(channel
->enabled
, 1);
613 mutex_unlock(&sessions_mutex
);
617 int lttng_channel_disable(struct lttng_kernel_channel_common
*channel
)
621 mutex_lock(&sessions_mutex
);
622 if (is_channel_buffer_metadata(channel
)) {
626 if (!channel
->enabled
) {
630 /* Set atomically the state to "disabled" */
631 WRITE_ONCE(channel
->enabled
, 0);
632 /* Set transient enabler state to "enabled" */
633 channel
->priv
->tstate
= 0;
634 lttng_session_sync_event_enablers(channel
->session
);
636 mutex_unlock(&sessions_mutex
);
640 int lttng_event_enable(struct lttng_kernel_event_common
*event
)
644 mutex_lock(&sessions_mutex
);
645 switch (event
->type
) {
646 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
648 struct lttng_kernel_event_recorder
*event_recorder
=
649 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
651 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
657 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
658 switch (event
->priv
->instrumentation
) {
659 case LTTNG_KERNEL_ABI_KRETPROBE
:
670 if (event
->enabled
) {
674 switch (event
->priv
->instrumentation
) {
675 case LTTNG_KERNEL_ABI_TRACEPOINT
:
677 case LTTNG_KERNEL_ABI_SYSCALL
:
681 case LTTNG_KERNEL_ABI_KPROBE
:
683 case LTTNG_KERNEL_ABI_UPROBE
:
684 WRITE_ONCE(event
->enabled
, 1);
687 case LTTNG_KERNEL_ABI_KRETPROBE
:
688 ret
= lttng_kretprobes_event_enable_state(event
, 1);
691 case LTTNG_KERNEL_ABI_FUNCTION
:
693 case LTTNG_KERNEL_ABI_NOOP
:
700 mutex_unlock(&sessions_mutex
);
704 int lttng_event_disable(struct lttng_kernel_event_common
*event
)
708 mutex_lock(&sessions_mutex
);
709 switch (event
->type
) {
710 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
712 struct lttng_kernel_event_recorder
*event_recorder
=
713 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
715 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
721 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
722 switch (event
->priv
->instrumentation
) {
723 case LTTNG_KERNEL_ABI_KRETPROBE
:
734 if (!event
->enabled
) {
738 switch (event
->priv
->instrumentation
) {
739 case LTTNG_KERNEL_ABI_TRACEPOINT
:
741 case LTTNG_KERNEL_ABI_SYSCALL
:
745 case LTTNG_KERNEL_ABI_KPROBE
:
747 case LTTNG_KERNEL_ABI_UPROBE
:
748 WRITE_ONCE(event
->enabled
, 0);
751 case LTTNG_KERNEL_ABI_KRETPROBE
:
752 ret
= lttng_kretprobes_event_enable_state(event
, 0);
755 case LTTNG_KERNEL_ABI_FUNCTION
:
757 case LTTNG_KERNEL_ABI_NOOP
:
764 mutex_unlock(&sessions_mutex
);
768 struct lttng_kernel_channel_buffer
*lttng_channel_buffer_create(struct lttng_kernel_session
*session
,
769 const char *transport_name
,
771 size_t subbuf_size
, size_t num_subbuf
,
772 unsigned int switch_timer_interval
,
773 unsigned int read_timer_interval
,
774 enum channel_type channel_type
)
776 struct lttng_kernel_channel_buffer
*chan
;
777 struct lttng_kernel_channel_buffer_private
*chan_priv
;
778 struct lttng_transport
*transport
= NULL
;
780 mutex_lock(&sessions_mutex
);
781 if (session
->priv
->been_active
&& channel_type
!= METADATA_CHANNEL
)
782 goto active
; /* Refuse to add channel to active session */
783 transport
= lttng_transport_find(transport_name
);
785 printk(KERN_WARNING
"LTTng: transport %s not found\n",
789 if (!try_module_get(transport
->owner
)) {
790 printk(KERN_WARNING
"LTTng: Can't lock transport module.\n");
793 chan
= kzalloc(sizeof(struct lttng_kernel_channel_buffer
), GFP_KERNEL
);
796 chan_priv
= kzalloc(sizeof(struct lttng_kernel_channel_buffer_private
), GFP_KERNEL
);
799 chan
->priv
= chan_priv
;
800 chan_priv
->pub
= chan
;
801 chan
->parent
.type
= LTTNG_KERNEL_CHANNEL_TYPE_BUFFER
;
802 chan
->parent
.session
= session
;
803 chan
->priv
->id
= session
->priv
->free_chan_id
++;
804 chan
->ops
= &transport
->ops
;
806 * Note: the channel creation op already writes into the packet
807 * headers. Therefore the "chan" information used as input
808 * should be already accessible.
810 chan
->priv
->rb_chan
= transport
->ops
.priv
->channel_create(transport_name
,
811 chan
, buf_addr
, subbuf_size
, num_subbuf
,
812 switch_timer_interval
, read_timer_interval
);
813 if (!chan
->priv
->rb_chan
)
815 chan
->priv
->parent
.tstate
= 1;
816 chan
->parent
.enabled
= 1;
817 chan
->priv
->transport
= transport
;
818 chan
->priv
->channel_type
= channel_type
;
819 list_add(&chan
->priv
->node
, &session
->priv
->chan
);
820 mutex_unlock(&sessions_mutex
);
829 module_put(transport
->owner
);
832 mutex_unlock(&sessions_mutex
);
837 * Only used internally at session destruction for per-cpu channels, and
838 * when metadata channel is released.
839 * Needs to be called with sessions mutex held.
842 void _lttng_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
844 chan
->ops
->priv
->channel_destroy(chan
->priv
->rb_chan
);
845 module_put(chan
->priv
->transport
->owner
);
846 list_del(&chan
->priv
->node
);
847 lttng_kernel_destroy_context(chan
->priv
->ctx
);
852 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
854 BUG_ON(chan
->priv
->channel_type
!= METADATA_CHANNEL
);
856 /* Protect the metadata cache with the sessions_mutex. */
857 mutex_lock(&sessions_mutex
);
858 _lttng_channel_destroy(chan
);
859 mutex_unlock(&sessions_mutex
);
861 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy
);
864 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
)
866 stream
->finalized
= 1;
867 wake_up_interruptible(&stream
->read_wait
);
872 * Supports event creation while tracing session is active.
873 * Needs to be called with sessions mutex held.
876 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler
*event_enabler
,
877 const struct lttng_kernel_event_desc
*event_desc
)
879 struct lttng_event_ht
*events_ht
= lttng_get_event_ht_from_enabler(&event_enabler
->parent
);
880 struct lttng_kernel_channel_buffer
*chan
= event_enabler
->chan
;
881 struct lttng_kernel_abi_event
*event_param
= &event_enabler
->parent
.event_param
;
882 enum lttng_kernel_abi_instrumentation itype
= event_param
->instrumentation
;
883 struct lttng_kernel_event_recorder
*event_recorder
;
884 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
885 struct lttng_kernel_event_common_private
*event_priv
;
886 const char *event_name
;
887 struct hlist_head
*head
;
890 if (chan
->priv
->free_event_id
== -1U) {
896 case LTTNG_KERNEL_ABI_TRACEPOINT
:
897 event_name
= event_desc
->event_name
;
900 case LTTNG_KERNEL_ABI_KPROBE
:
902 case LTTNG_KERNEL_ABI_UPROBE
:
904 case LTTNG_KERNEL_ABI_KRETPROBE
:
906 case LTTNG_KERNEL_ABI_SYSCALL
:
907 event_name
= event_param
->name
;
910 case LTTNG_KERNEL_ABI_FUNCTION
:
912 case LTTNG_KERNEL_ABI_NOOP
:
920 head
= utils_borrow_hash_table_bucket(events_ht
->table
, LTTNG_EVENT_HT_SIZE
, event_name
);
921 lttng_hlist_for_each_entry(event_priv
, head
, hlist_node
) {
922 event_recorder_priv
= container_of(event_priv
, struct lttng_kernel_event_recorder_private
, parent
);
924 WARN_ON_ONCE(!event_priv
->desc
);
925 if (!strncmp(event_priv
->desc
->event_name
, event_name
,
926 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
927 && chan
== event_recorder_priv
->pub
->chan
) {
933 event_recorder
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
934 if (!event_recorder
) {
938 event_recorder_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
939 if (!event_recorder_priv
) {
941 goto cache_private_error
;
943 event_recorder_priv
->pub
= event_recorder
;
944 event_recorder_priv
->parent
.pub
= &event_recorder
->parent
;
945 event_recorder
->priv
= event_recorder_priv
;
946 event_recorder
->parent
.priv
= &event_recorder_priv
->parent
;
947 event_recorder
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
949 event_recorder
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
950 event_recorder
->chan
= chan
;
951 event_recorder
->priv
->id
= chan
->priv
->free_event_id
++;
952 event_recorder
->priv
->parent
.instrumentation
= itype
;
953 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.filter_bytecode_runtime_head
);
954 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.enablers_ref_head
);
957 case LTTNG_KERNEL_ABI_TRACEPOINT
:
958 /* Event will be enabled by enabler sync. */
959 event_recorder
->parent
.enabled
= 0;
960 event_recorder
->priv
->parent
.registered
= 0;
961 event_recorder
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
962 if (!event_recorder
->priv
->parent
.desc
) {
966 /* Populate lttng_event structure before event registration. */
970 case LTTNG_KERNEL_ABI_KPROBE
:
972 * Needs to be explicitly enabled after creation, since
973 * we may want to apply filters.
975 event_recorder
->parent
.enabled
= 0;
976 event_recorder
->priv
->parent
.registered
= 1;
978 * Populate lttng_event structure before event
982 ret
= lttng_kprobes_register_event(event_name
,
983 event_param
->u
.kprobe
.symbol_name
,
984 event_param
->u
.kprobe
.offset
,
985 event_param
->u
.kprobe
.addr
,
986 &event_recorder
->parent
);
991 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
995 case LTTNG_KERNEL_ABI_KRETPROBE
:
997 struct lttng_kernel_event_recorder
*event_recorder_return
;
998 struct lttng_kernel_event_recorder_private
*event_recorder_return_priv
;
1000 /* kretprobe defines 2 events */
1002 * Needs to be explicitly enabled after creation, since
1003 * we may want to apply filters.
1005 event_recorder
->parent
.enabled
= 0;
1006 event_recorder
->priv
->parent
.registered
= 1;
1008 event_recorder_return
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
1009 if (!event_recorder_return
) {
1011 goto register_error
;
1013 event_recorder_return_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
1014 if (!event_recorder_return_priv
) {
1015 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1017 goto register_error
;
1019 event_recorder_return_priv
->pub
= event_recorder_return
;
1020 event_recorder_return_priv
->parent
.pub
= &event_recorder_return
->parent
;
1021 event_recorder_return
->priv
= event_recorder_return_priv
;
1022 event_recorder_return
->parent
.priv
= &event_recorder_return_priv
->parent
;
1023 event_recorder_return
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
1025 event_recorder_return
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1026 event_recorder_return
->chan
= chan
;
1027 event_recorder_return
->priv
->id
= chan
->priv
->free_event_id
++;
1028 event_recorder_return
->priv
->parent
.instrumentation
= itype
;
1029 event_recorder_return
->parent
.enabled
= 0;
1030 event_recorder_return
->priv
->parent
.registered
= 1;
1031 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.filter_bytecode_runtime_head
);
1032 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.enablers_ref_head
);
1034 * Populate lttng_event structure before kretprobe registration.
1037 ret
= lttng_kretprobes_register(event_name
,
1038 event_param
->u
.kretprobe
.symbol_name
,
1039 event_param
->u
.kretprobe
.offset
,
1040 event_param
->u
.kretprobe
.addr
,
1041 &event_recorder
->parent
, &event_recorder_return
->parent
);
1043 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1044 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1046 goto register_error
;
1048 /* Take 2 refs on the module: one per event. */
1049 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1051 ret
= try_module_get(event_recorder_return
->priv
->parent
.desc
->owner
);
1053 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
,
1054 event_recorder_return
);
1055 WARN_ON_ONCE(ret
> 0);
1057 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1058 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1059 module_put(event_recorder_return
->priv
->parent
.desc
->owner
);
1060 module_put(event_recorder
->priv
->parent
.desc
->owner
);
1061 goto statedump_error
;
1063 list_add(&event_recorder_return
->priv
->parent
.node
, &chan
->parent
.session
->priv
->events
);
1067 case LTTNG_KERNEL_ABI_SYSCALL
:
1069 * Needs to be explicitly enabled after creation, since
1070 * we may want to apply filters.
1072 event_recorder
->parent
.enabled
= 0;
1073 event_recorder
->priv
->parent
.registered
= 0;
1074 event_recorder
->priv
->parent
.desc
= event_desc
;
1075 switch (event_param
->u
.syscall
.entryexit
) {
1076 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1078 goto register_error
;
1079 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1080 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1082 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1083 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1086 switch (event_param
->u
.syscall
.abi
) {
1087 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1089 goto register_error
;
1090 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1091 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1093 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1094 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1097 if (!event_recorder
->priv
->parent
.desc
) {
1099 goto register_error
;
1103 case LTTNG_KERNEL_ABI_UPROBE
:
1105 * Needs to be explicitly enabled after creation, since
1106 * we may want to apply filters.
1108 event_recorder
->parent
.enabled
= 0;
1109 event_recorder
->priv
->parent
.registered
= 1;
1112 * Populate lttng_event structure before event
1117 ret
= lttng_uprobes_register_event(event_param
->name
,
1118 event_param
->u
.uprobe
.fd
,
1119 &event_recorder
->parent
);
1121 goto register_error
;
1122 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1126 case LTTNG_KERNEL_ABI_FUNCTION
:
1128 case LTTNG_KERNEL_ABI_NOOP
:
1133 goto register_error
;
1135 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
, event_recorder
);
1136 WARN_ON_ONCE(ret
> 0);
1138 goto statedump_error
;
1140 hlist_add_head(&event_recorder
->priv
->parent
.hlist_node
, head
);
1141 list_add(&event_recorder
->priv
->parent
.node
, &chan
->parent
.session
->priv
->events
);
1142 return event_recorder
;
1145 /* If a statedump error occurs, events will not be readable. */
1147 kmem_cache_free(event_recorder_private_cache
, event_recorder_priv
);
1148 cache_private_error
:
1149 kmem_cache_free(event_recorder_cache
, event_recorder
);
1154 return ERR_PTR(ret
);
1158 struct lttng_kernel_event_notifier
*_lttng_kernel_event_notifier_create(struct lttng_event_notifier_enabler
*event_enabler
,
1159 const struct lttng_kernel_event_desc
*event_desc
)
1161 struct lttng_event_ht
*events_ht
= lttng_get_event_ht_from_enabler(&event_enabler
->parent
);
1162 struct lttng_event_notifier_group
*event_notifier_group
= event_enabler
->group
;
1163 struct lttng_kernel_abi_event
*event_param
= &event_enabler
->parent
.event_param
;
1164 uint64_t token
= event_enabler
->parent
.user_token
;
1165 enum lttng_kernel_abi_instrumentation itype
= event_param
->instrumentation
;
1166 struct lttng_kernel_event_notifier
*event_notifier
;
1167 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
1168 struct lttng_kernel_event_common_private
*event_priv
;
1169 struct lttng_counter
*error_counter
;
1170 const char *event_name
;
1171 struct hlist_head
*head
;
1175 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1176 event_name
= event_desc
->event_name
;
1179 case LTTNG_KERNEL_ABI_KPROBE
:
1181 case LTTNG_KERNEL_ABI_UPROBE
:
1183 case LTTNG_KERNEL_ABI_SYSCALL
:
1184 event_name
= event_param
->name
;
1187 case LTTNG_KERNEL_ABI_KRETPROBE
:
1189 case LTTNG_KERNEL_ABI_FUNCTION
:
1191 case LTTNG_KERNEL_ABI_NOOP
:
1199 head
= utils_borrow_hash_table_bucket(events_ht
->table
, LTTNG_EVENT_HT_SIZE
, event_name
);
1200 lttng_hlist_for_each_entry(event_priv
, head
, hlist_node
) {
1201 event_notifier_priv
= container_of(event_priv
, struct lttng_kernel_event_notifier_private
, parent
);
1203 WARN_ON_ONCE(!event_priv
->desc
);
1204 if (!strncmp(event_priv
->desc
->event_name
, event_name
,
1205 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
1206 && event_notifier_group
== event_notifier_priv
->group
1207 && token
== event_priv
->user_token
) {
1213 event_notifier
= kmem_cache_zalloc(event_notifier_cache
, GFP_KERNEL
);
1214 if (!event_notifier
) {
1218 event_notifier_priv
= kmem_cache_zalloc(event_notifier_private_cache
, GFP_KERNEL
);
1219 if (!event_notifier_priv
) {
1221 goto cache_private_error
;
1223 event_notifier_priv
->pub
= event_notifier
;
1224 event_notifier_priv
->parent
.pub
= &event_notifier
->parent
;
1225 event_notifier
->priv
= event_notifier_priv
;
1226 event_notifier
->parent
.priv
= &event_notifier_priv
->parent
;
1227 event_notifier
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
;
1229 event_notifier
->priv
->group
= event_notifier_group
;
1230 event_notifier
->priv
->parent
.user_token
= event_enabler
->parent
.user_token
;
1231 event_notifier
->priv
->error_counter_index
= event_enabler
->error_counter_index
;
1232 event_notifier
->priv
->num_captures
= 0;
1233 event_notifier
->priv
->parent
.instrumentation
= itype
;
1234 event_notifier
->notification_send
= lttng_event_notifier_notification_send
;
1235 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.filter_bytecode_runtime_head
);
1236 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.enablers_ref_head
);
1237 INIT_LIST_HEAD(&event_notifier
->priv
->capture_bytecode_runtime_head
);
1238 event_notifier
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1241 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1242 /* Event will be enabled by enabler sync. */
1243 event_notifier
->parent
.enabled
= 0;
1244 event_notifier
->priv
->parent
.registered
= 0;
1245 event_notifier
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
1246 if (!event_notifier
->priv
->parent
.desc
) {
1248 goto register_error
;
1250 /* Populate lttng_event_notifier structure before event registration. */
1254 case LTTNG_KERNEL_ABI_KPROBE
:
1256 * Needs to be explicitly enabled after creation, since
1257 * we may want to apply filters.
1259 event_notifier
->parent
.enabled
= 0;
1260 event_notifier
->priv
->parent
.registered
= 1;
1262 * Populate lttng_event_notifier structure before event
1266 ret
= lttng_kprobes_register_event(event_param
->u
.kprobe
.symbol_name
,
1267 event_param
->u
.kprobe
.symbol_name
,
1268 event_param
->u
.kprobe
.offset
,
1269 event_param
->u
.kprobe
.addr
,
1270 &event_notifier
->parent
);
1273 goto register_error
;
1275 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1279 case LTTNG_KERNEL_ABI_SYSCALL
:
1281 * Needs to be explicitly enabled after creation, since
1282 * we may want to apply filters.
1284 event_notifier
->parent
.enabled
= 0;
1285 event_notifier
->priv
->parent
.registered
= 0;
1286 event_notifier
->priv
->parent
.desc
= event_desc
;
1287 switch (event_param
->u
.syscall
.entryexit
) {
1288 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1290 goto register_error
;
1291 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1292 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1294 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1295 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1298 switch (event_param
->u
.syscall
.abi
) {
1299 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1301 goto register_error
;
1302 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1303 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1305 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1306 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1310 if (!event_notifier
->priv
->parent
.desc
) {
1312 goto register_error
;
1316 case LTTNG_KERNEL_ABI_UPROBE
:
1318 * Needs to be explicitly enabled after creation, since
1319 * we may want to apply filters.
1321 event_notifier
->parent
.enabled
= 0;
1322 event_notifier
->priv
->parent
.registered
= 1;
1325 * Populate lttng_event_notifier structure before
1326 * event_notifier registration.
1330 ret
= lttng_uprobes_register_event(event_param
->name
,
1331 event_param
->u
.uprobe
.fd
,
1332 &event_notifier
->parent
);
1334 goto register_error
;
1335 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1339 case LTTNG_KERNEL_ABI_KRETPROBE
:
1341 case LTTNG_KERNEL_ABI_FUNCTION
:
1343 case LTTNG_KERNEL_ABI_NOOP
:
1348 goto register_error
;
1351 list_add(&event_notifier
->priv
->parent
.node
, &event_notifier_group
->event_notifiers_head
);
1352 hlist_add_head(&event_notifier
->priv
->parent
.hlist_node
, head
);
1355 * Clear the error counter bucket. The sessiond keeps track of which
1356 * bucket is currently in use. We trust it. The session lock
1357 * synchronizes against concurrent creation of the error
1360 error_counter
= event_notifier_group
->error_counter
;
1361 if (error_counter
) {
1362 size_t dimension_index
[1];
1365 * Check that the index is within the boundary of the counter.
1367 if (event_notifier
->priv
->error_counter_index
>= event_notifier_group
->error_counter_len
) {
1368 printk(KERN_INFO
"LTTng: event_notifier: Error counter index out-of-bound: counter-len=%zu, index=%llu\n",
1369 event_notifier_group
->error_counter_len
, event_notifier
->priv
->error_counter_index
);
1371 goto register_error
;
1374 dimension_index
[0] = event_notifier
->priv
->error_counter_index
;
1375 ret
= error_counter
->ops
->counter_clear(error_counter
->counter
, dimension_index
);
1377 printk(KERN_INFO
"LTTng: event_notifier: Unable to clear error counter bucket %llu\n",
1378 event_notifier
->priv
->error_counter_index
);
1379 goto register_error
;
1383 return event_notifier
;
1386 kmem_cache_free(event_notifier_private_cache
, event_notifier_priv
);
1387 cache_private_error
:
1388 kmem_cache_free(event_notifier_cache
, event_notifier
);
1392 return ERR_PTR(ret
);
1395 struct lttng_kernel_event_common
*_lttng_kernel_event_create(struct lttng_event_enabler_common
*event_enabler
,
1396 const struct lttng_kernel_event_desc
*event_desc
)
1398 switch (event_enabler
->enabler_type
) {
1399 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
1401 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
1402 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
1403 struct lttng_kernel_event_recorder
*event_recorder
;
1405 event_recorder
= _lttng_kernel_event_recorder_create(event_recorder_enabler
, event_desc
);
1406 if (!event_recorder
)
1408 return &event_recorder
->parent
;
1410 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
1412 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
1413 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
1414 struct lttng_kernel_event_notifier
*event_notifier
;
1416 event_notifier
= _lttng_kernel_event_notifier_create(event_notifier_enabler
, event_desc
);
1417 if (!event_notifier
)
1419 return &event_notifier
->parent
;
1426 struct lttng_kernel_event_common
*lttng_kernel_event_create(struct lttng_event_enabler_common
*event_enabler
,
1427 const struct lttng_kernel_event_desc
*event_desc
)
1429 struct lttng_kernel_event_common
*event
;
1431 mutex_lock(&sessions_mutex
);
1432 event
= _lttng_kernel_event_create(event_enabler
, event_desc
);
1433 mutex_unlock(&sessions_mutex
);
1439 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1440 const size_t *dim_indexes
, int32_t cpu
,
1441 int64_t *val
, bool *overflow
, bool *underflow
)
1443 return counter
->ops
->counter_read(counter
->counter
, dim_indexes
,
1444 cpu
, val
, overflow
, underflow
);
1447 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1448 const size_t *dim_indexes
, int64_t *val
,
1449 bool *overflow
, bool *underflow
)
1451 return counter
->ops
->counter_aggregate(counter
->counter
, dim_indexes
,
1452 val
, overflow
, underflow
);
1455 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1456 const size_t *dim_indexes
)
1458 return counter
->ops
->counter_clear(counter
->counter
, dim_indexes
);
1461 /* Only used for tracepoints for now. */
1463 void register_event(struct lttng_kernel_event_common
*event
)
1465 const struct lttng_kernel_event_desc
*desc
;
1468 if (event
->priv
->registered
)
1471 desc
= event
->priv
->desc
;
1472 switch (event
->priv
->instrumentation
) {
1473 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1474 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1475 desc
->tp_class
->probe_callback
,
1479 case LTTNG_KERNEL_ABI_SYSCALL
:
1480 ret
= lttng_syscall_filter_enable_event(event
);
1483 case LTTNG_KERNEL_ABI_KPROBE
:
1485 case LTTNG_KERNEL_ABI_UPROBE
:
1489 case LTTNG_KERNEL_ABI_KRETPROBE
:
1490 switch (event
->type
) {
1491 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1494 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1500 case LTTNG_KERNEL_ABI_FUNCTION
:
1502 case LTTNG_KERNEL_ABI_NOOP
:
1508 event
->priv
->registered
= 1;
1511 int _lttng_event_unregister(struct lttng_kernel_event_common
*event
)
1513 struct lttng_kernel_event_common_private
*event_priv
= event
->priv
;
1514 const struct lttng_kernel_event_desc
*desc
;
1517 if (!event_priv
->registered
)
1520 desc
= event_priv
->desc
;
1521 switch (event_priv
->instrumentation
) {
1522 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1523 ret
= lttng_wrapper_tracepoint_probe_unregister(event_priv
->desc
->event_kname
,
1524 event_priv
->desc
->tp_class
->probe_callback
,
1528 case LTTNG_KERNEL_ABI_KPROBE
:
1529 lttng_kprobes_unregister_event(event
);
1533 case LTTNG_KERNEL_ABI_KRETPROBE
:
1534 switch (event
->type
) {
1535 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1536 lttng_kretprobes_unregister(event
);
1539 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1545 case LTTNG_KERNEL_ABI_SYSCALL
:
1546 ret
= lttng_syscall_filter_disable_event(event
);
1549 case LTTNG_KERNEL_ABI_NOOP
:
1550 switch (event
->type
) {
1551 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1554 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1560 case LTTNG_KERNEL_ABI_UPROBE
:
1561 lttng_uprobes_unregister_event(event
);
1565 case LTTNG_KERNEL_ABI_FUNCTION
:
1571 event_priv
->registered
= 0;
1576 * Only used internally at session destruction.
1579 void _lttng_event_destroy(struct lttng_kernel_event_common
*event
)
1581 struct lttng_kernel_event_common_private
*event_priv
= event
->priv
;
1582 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1584 lttng_free_event_filter_runtime(event
);
1585 /* Free event enabler refs */
1586 list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1587 &event_priv
->enablers_ref_head
, node
)
1590 switch (event
->type
) {
1591 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1593 struct lttng_kernel_event_recorder
*event_recorder
=
1594 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
1596 switch (event_priv
->instrumentation
) {
1597 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1598 lttng_event_desc_put(event_priv
->desc
);
1601 case LTTNG_KERNEL_ABI_KPROBE
:
1602 module_put(event_priv
->desc
->owner
);
1603 lttng_kprobes_destroy_event_private(&event_recorder
->parent
);
1606 case LTTNG_KERNEL_ABI_KRETPROBE
:
1607 module_put(event_priv
->desc
->owner
);
1608 lttng_kretprobes_destroy_private(&event_recorder
->parent
);
1611 case LTTNG_KERNEL_ABI_SYSCALL
:
1614 case LTTNG_KERNEL_ABI_UPROBE
:
1615 module_put(event_priv
->desc
->owner
);
1616 lttng_uprobes_destroy_event_private(&event_recorder
->parent
);
1619 case LTTNG_KERNEL_ABI_FUNCTION
:
1621 case LTTNG_KERNEL_ABI_NOOP
:
1626 list_del(&event_recorder
->priv
->parent
.node
);
1627 kmem_cache_free(event_recorder_private_cache
, event_recorder
->priv
);
1628 kmem_cache_free(event_recorder_cache
, event_recorder
);
1631 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1633 struct lttng_kernel_event_notifier
*event_notifier
=
1634 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
1636 switch (event_notifier
->priv
->parent
.instrumentation
) {
1637 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1638 lttng_event_desc_put(event_notifier
->priv
->parent
.desc
);
1641 case LTTNG_KERNEL_ABI_KPROBE
:
1642 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1643 lttng_kprobes_destroy_event_private(&event_notifier
->parent
);
1646 case LTTNG_KERNEL_ABI_SYSCALL
:
1649 case LTTNG_KERNEL_ABI_UPROBE
:
1650 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1651 lttng_uprobes_destroy_event_private(&event_notifier
->parent
);
1654 case LTTNG_KERNEL_ABI_KRETPROBE
:
1656 case LTTNG_KERNEL_ABI_FUNCTION
:
1658 case LTTNG_KERNEL_ABI_NOOP
:
1663 list_del(&event_notifier
->priv
->parent
.node
);
1664 kmem_cache_free(event_notifier_private_cache
, event_notifier
->priv
);
1665 kmem_cache_free(event_notifier_cache
, event_notifier
);
1673 struct lttng_kernel_id_tracker
*get_tracker(struct lttng_kernel_session
*session
,
1674 enum tracker_type tracker_type
)
1676 switch (tracker_type
) {
1678 return &session
->pid_tracker
;
1680 return &session
->vpid_tracker
;
1682 return &session
->uid_tracker
;
1684 return &session
->vuid_tracker
;
1686 return &session
->gid_tracker
;
1688 return &session
->vgid_tracker
;
1695 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1696 enum tracker_type tracker_type
, int id
)
1698 struct lttng_kernel_id_tracker
*tracker
;
1701 tracker
= get_tracker(session
, tracker_type
);
1706 mutex_lock(&sessions_mutex
);
1708 /* track all ids: destroy tracker. */
1709 lttng_id_tracker_destroy(tracker
, true);
1712 ret
= lttng_id_tracker_add(tracker
, id
);
1714 mutex_unlock(&sessions_mutex
);
1718 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1719 enum tracker_type tracker_type
, int id
)
1721 struct lttng_kernel_id_tracker
*tracker
;
1724 tracker
= get_tracker(session
, tracker_type
);
1729 mutex_lock(&sessions_mutex
);
1731 /* untrack all ids: replace by empty tracker. */
1732 ret
= lttng_id_tracker_empty_set(tracker
);
1734 ret
= lttng_id_tracker_del(tracker
, id
);
1736 mutex_unlock(&sessions_mutex
);
1741 void *id_list_start(struct seq_file
*m
, loff_t
*pos
)
1743 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1744 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1745 struct lttng_id_hash_node
*e
;
1748 mutex_lock(&sessions_mutex
);
1750 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1751 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1753 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1759 /* ID tracker disabled. */
1760 if (iter
>= *pos
&& iter
== 0) {
1761 return id_tracker_p
; /* empty tracker */
1769 /* Called with sessions_mutex held. */
1771 void *id_list_next(struct seq_file
*m
, void *p
, loff_t
*ppos
)
1773 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1774 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1775 struct lttng_id_hash_node
*e
;
1780 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1781 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1783 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1784 if (iter
++ >= *ppos
)
1789 /* ID tracker disabled. */
1790 if (iter
>= *ppos
&& iter
== 0)
1791 return p
; /* empty tracker */
1800 void id_list_stop(struct seq_file
*m
, void *p
)
1802 mutex_unlock(&sessions_mutex
);
1806 int id_list_show(struct seq_file
*m
, void *p
)
1808 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1809 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1812 if (p
== id_tracker_p
) {
1813 /* Tracker disabled. */
1816 const struct lttng_id_hash_node
*e
= p
;
1818 id
= lttng_id_tracker_get_node_id(e
);
1820 switch (id_tracker
->priv
->tracker_type
) {
1822 seq_printf(m
, "process { pid = %d; };\n", id
);
1825 seq_printf(m
, "process { vpid = %d; };\n", id
);
1828 seq_printf(m
, "user { uid = %d; };\n", id
);
1831 seq_printf(m
, "user { vuid = %d; };\n", id
);
1834 seq_printf(m
, "group { gid = %d; };\n", id
);
1837 seq_printf(m
, "group { vgid = %d; };\n", id
);
1840 seq_printf(m
, "UNKNOWN { field = %d };\n", id
);
1846 const struct seq_operations lttng_tracker_ids_list_seq_ops
= {
1847 .start
= id_list_start
,
1848 .next
= id_list_next
,
1849 .stop
= id_list_stop
,
1850 .show
= id_list_show
,
1854 int lttng_tracker_ids_list_open(struct inode
*inode
, struct file
*file
)
1856 return seq_open(file
, <tng_tracker_ids_list_seq_ops
);
1860 int lttng_tracker_ids_list_release(struct inode
*inode
, struct file
*file
)
1862 struct seq_file
*m
= file
->private_data
;
1863 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1866 WARN_ON_ONCE(!id_tracker
);
1867 ret
= seq_release(inode
, file
);
1869 fput(id_tracker
->priv
->session
->priv
->file
);
1873 const struct file_operations lttng_tracker_ids_list_fops
= {
1874 .owner
= THIS_MODULE
,
1875 .open
= lttng_tracker_ids_list_open
,
1877 .llseek
= seq_lseek
,
1878 .release
= lttng_tracker_ids_list_release
,
1881 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1882 enum tracker_type tracker_type
)
1884 struct file
*tracker_ids_list_file
;
1888 file_fd
= lttng_get_unused_fd();
1894 tracker_ids_list_file
= anon_inode_getfile("[lttng_tracker_ids_list]",
1895 <tng_tracker_ids_list_fops
,
1897 if (IS_ERR(tracker_ids_list_file
)) {
1898 ret
= PTR_ERR(tracker_ids_list_file
);
1901 if (!atomic_long_add_unless(&session
->priv
->file
->f_count
, 1, LONG_MAX
)) {
1903 goto refcount_error
;
1905 ret
= lttng_tracker_ids_list_fops
.open(NULL
, tracker_ids_list_file
);
1908 m
= tracker_ids_list_file
->private_data
;
1910 m
->private = get_tracker(session
, tracker_type
);
1911 BUG_ON(!m
->private);
1912 fd_install(file_fd
, tracker_ids_list_file
);
1917 atomic_long_dec(&session
->priv
->file
->f_count
);
1919 fput(tracker_ids_list_file
);
1921 put_unused_fd(file_fd
);
1927 * Enabler management.
1930 int lttng_match_enabler_star_glob(const char *desc_name
,
1931 const char *pattern
)
1933 if (!strutils_star_glob_match(pattern
, LTTNG_SIZE_MAX
,
1934 desc_name
, LTTNG_SIZE_MAX
))
1940 int lttng_match_enabler_name(const char *desc_name
,
1943 if (strcmp(desc_name
, name
))
1949 int lttng_desc_match_enabler_check(const struct lttng_kernel_event_desc
*desc
,
1950 struct lttng_event_enabler_common
*enabler
)
1952 const char *desc_name
, *enabler_name
;
1953 bool compat
= false, entry
= false;
1955 enabler_name
= enabler
->event_param
.name
;
1956 switch (enabler
->event_param
.instrumentation
) {
1957 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1958 desc_name
= desc
->event_name
;
1959 switch (enabler
->format_type
) {
1960 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1961 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1962 case LTTNG_ENABLER_FORMAT_NAME
:
1963 return lttng_match_enabler_name(desc_name
, enabler_name
);
1969 case LTTNG_KERNEL_ABI_SYSCALL
:
1970 desc_name
= desc
->event_name
;
1971 if (!strncmp(desc_name
, "compat_", strlen("compat_"))) {
1972 desc_name
+= strlen("compat_");
1975 if (!strncmp(desc_name
, "syscall_exit_",
1976 strlen("syscall_exit_"))) {
1977 desc_name
+= strlen("syscall_exit_");
1978 } else if (!strncmp(desc_name
, "syscall_entry_",
1979 strlen("syscall_entry_"))) {
1980 desc_name
+= strlen("syscall_entry_");
1986 switch (enabler
->event_param
.u
.syscall
.entryexit
) {
1987 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1989 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1993 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
2000 switch (enabler
->event_param
.u
.syscall
.abi
) {
2001 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
2003 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
2007 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
2014 switch (enabler
->event_param
.u
.syscall
.match
) {
2015 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
:
2016 switch (enabler
->format_type
) {
2017 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
2018 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
2019 case LTTNG_ENABLER_FORMAT_NAME
:
2020 return lttng_match_enabler_name(desc_name
, enabler_name
);
2025 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR
:
2026 return -EINVAL
; /* Not implemented. */
2038 bool lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
2039 struct lttng_event_enabler_common
*enabler
)
2043 ret
= lttng_desc_match_enabler_check(desc
, enabler
);
2051 bool lttng_event_enabler_match_event(struct lttng_event_enabler_common
*event_enabler
,
2052 struct lttng_kernel_event_common
*event
)
2054 if (event_enabler
->event_param
.instrumentation
!= event
->priv
->instrumentation
)
2057 switch (event_enabler
->enabler_type
) {
2058 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
2060 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
2061 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
2062 struct lttng_kernel_event_recorder
*event_recorder
=
2063 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
2065 if (lttng_desc_match_enabler(event
->priv
->desc
, event_enabler
)
2066 && event_recorder
->chan
== event_recorder_enabler
->chan
)
2071 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
2073 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
2074 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
2075 struct lttng_kernel_event_notifier
*event_notifier
=
2076 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
2078 if (lttng_desc_match_enabler(event
->priv
->desc
, event_enabler
)
2079 && event_notifier
->priv
->group
== event_notifier_enabler
->group
2080 && event
->priv
->user_token
== event_enabler
->user_token
)
2091 bool lttng_event_enabler_desc_match_event(struct lttng_event_enabler_common
*event_enabler
,
2092 const struct lttng_kernel_event_desc
*desc
,
2093 struct lttng_kernel_event_common
*event
)
2095 if (event_enabler
->event_param
.instrumentation
!= event
->priv
->instrumentation
)
2098 switch (event_enabler
->enabler_type
) {
2099 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
2101 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
2102 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
2103 struct lttng_kernel_event_recorder
*event_recorder
=
2104 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
2106 if (event
->priv
->desc
== desc
&& event_recorder
->chan
== event_recorder_enabler
->chan
)
2111 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
2113 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
2114 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
2115 struct lttng_kernel_event_notifier
*event_notifier
=
2116 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
2118 if (event
->priv
->desc
== desc
2119 && event_notifier
->priv
->group
== event_notifier_enabler
->group
2120 && event
->priv
->user_token
== event_enabler
->user_token
)
2132 struct lttng_enabler_ref
*lttng_enabler_ref(
2133 struct list_head
*enablers_ref_list
,
2134 struct lttng_event_enabler_common
*enabler
)
2136 struct lttng_enabler_ref
*enabler_ref
;
2138 list_for_each_entry(enabler_ref
, enablers_ref_list
, node
) {
2139 if (enabler_ref
->ref
== enabler
)
2146 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler_common
*event_enabler
)
2148 struct lttng_event_ht
*events_ht
= lttng_get_event_ht_from_enabler(event_enabler
);
2149 struct lttng_kernel_probe_desc
*probe_desc
;
2150 const struct lttng_kernel_event_desc
*desc
;
2151 struct list_head
*probe_list
;
2154 probe_list
= lttng_get_probe_list_head();
2156 * For each probe event, if we find that a probe event matches
2157 * our enabler, create an associated lttng_event if not
2160 list_for_each_entry(probe_desc
, probe_list
, head
) {
2161 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2163 struct hlist_head
*head
;
2164 struct lttng_kernel_event_common
*event
;
2165 struct lttng_kernel_event_common_private
*event_priv
;
2167 desc
= probe_desc
->event_desc
[i
];
2168 if (!lttng_desc_match_enabler(desc
, event_enabler
))
2172 * Check if already created.
2174 head
= utils_borrow_hash_table_bucket(events_ht
->table
, LTTNG_EVENT_HT_SIZE
, desc
->event_name
);
2175 lttng_hlist_for_each_entry(event_priv
, head
, hlist_node
) {
2176 if (lttng_event_enabler_desc_match_event(event_enabler
, desc
, event_priv
->pub
))
2183 * We need to create an event for this event probe.
2185 event
= _lttng_kernel_event_create(event_enabler
, desc
);
2187 printk(KERN_INFO
"LTTng: Unable to create event %s\n",
2188 probe_desc
->event_desc
[i
]->event_name
);
2195 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler_common
*event_enabler
)
2199 ret
= lttng_syscalls_register_event(event_enabler
);
2204 * Create event if it is missing and present in the list of tracepoint probes.
2205 * Should be called with sessions mutex held.
2208 void lttng_create_event_if_missing(struct lttng_event_enabler_common
*event_enabler
)
2210 switch (event_enabler
->event_param
.instrumentation
) {
2211 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2212 lttng_create_tracepoint_event_if_missing(event_enabler
);
2215 case LTTNG_KERNEL_ABI_SYSCALL
:
2216 lttng_create_syscall_event_if_missing(event_enabler
);
2226 * Create events associated with an event_enabler (if not already present),
2227 * and add backward reference from the event to the enabler.
2228 * Should be called with sessions mutex held.
2231 int lttng_event_enabler_ref_events(struct lttng_event_recorder_enabler
*event_enabler
)
2233 struct lttng_kernel_channel_buffer
*chan
= event_enabler
->chan
;
2234 struct lttng_event_enabler_common
*base_enabler
= lttng_event_recorder_enabler_as_enabler(event_enabler
);
2235 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2236 struct list_head
*event_list_head
= lttng_get_event_list_head_from_enabler(&event_enabler
->parent
);
2238 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2239 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2240 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2241 !strcmp(base_enabler
->event_param
.name
, "*")) {
2242 int enabled
= base_enabler
->enabled
;
2243 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2245 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2246 WRITE_ONCE(chan
->priv
->parent
.syscall_table
.syscall_all_entry
, enabled
);
2248 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2249 WRITE_ONCE(chan
->priv
->parent
.syscall_table
.syscall_all_exit
, enabled
);
2252 /* First ensure that probe events are created for this enabler. */
2253 lttng_create_event_if_missing(&event_enabler
->parent
);
2255 /* For each event matching event_enabler in session event list. */
2256 list_for_each_entry(event_recorder_priv
, event_list_head
, parent
.node
) {
2257 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2258 struct lttng_enabler_ref
*enabler_ref
;
2260 if (!lttng_event_enabler_match_event(&event_enabler
->parent
, &event_recorder
->parent
))
2262 enabler_ref
= lttng_enabler_ref(&event_recorder_priv
->parent
.enablers_ref_head
,
2263 lttng_event_recorder_enabler_as_enabler(event_enabler
));
2266 * If no backward ref, create it.
2267 * Add backward ref from event to event_enabler.
2269 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2272 enabler_ref
->ref
= lttng_event_recorder_enabler_as_enabler(event_enabler
);
2273 list_add(&enabler_ref
->node
,
2274 &event_recorder_priv
->parent
.enablers_ref_head
);
2278 * Link filter bytecodes if not linked yet.
2280 lttng_enabler_link_bytecode(event_recorder_priv
->parent
.desc
,
2282 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
,
2283 <tng_event_recorder_enabler_as_enabler(event_enabler
)->filter_bytecode_head
);
2289 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2292 int lttng_event_notifier_enabler_ref_event_notifiers(
2293 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2295 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2296 struct lttng_event_enabler_common
*base_enabler
= lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2297 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2298 struct list_head
*event_list_head
= lttng_get_event_list_head_from_enabler(&event_notifier_enabler
->parent
);
2300 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2301 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2302 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2303 !strcmp(base_enabler
->event_param
.name
, "*")) {
2305 int enabled
= base_enabler
->enabled
;
2306 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2308 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2309 WRITE_ONCE(event_notifier_group
->syscall_table
.syscall_all_entry
, enabled
);
2311 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2312 WRITE_ONCE(event_notifier_group
->syscall_table
.syscall_all_exit
, enabled
);
2316 /* First ensure that probe event_notifiers are created for this enabler. */
2317 lttng_create_event_if_missing(&event_notifier_enabler
->parent
);
2319 /* Link the created event_notifier with its associated enabler. */
2320 list_for_each_entry(event_notifier_priv
, event_list_head
, parent
.node
) {
2321 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2322 struct lttng_enabler_ref
*enabler_ref
;
2324 if (!lttng_event_enabler_match_event(&event_notifier_enabler
->parent
, &event_notifier
->parent
))
2327 enabler_ref
= lttng_enabler_ref(&event_notifier_priv
->parent
.enablers_ref_head
,
2328 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2331 * If no backward ref, create it.
2332 * Add backward ref from event_notifier to enabler.
2334 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2338 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2339 event_notifier_enabler
);
2340 list_add(&enabler_ref
->node
,
2341 &event_notifier_priv
->parent
.enablers_ref_head
);
2345 * Link filter bytecodes if not linked yet.
2347 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2348 lttng_static_ctx
, &event_notifier_priv
->parent
.filter_bytecode_runtime_head
,
2349 <tng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->filter_bytecode_head
);
2351 /* Link capture bytecodes if not linked yet. */
2352 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2353 lttng_static_ctx
, &event_notifier_priv
->capture_bytecode_runtime_head
,
2354 &event_notifier_enabler
->capture_bytecode_head
);
2356 event_notifier_priv
->num_captures
= event_notifier_enabler
->num_captures
;
2362 * Called at module load: connect the probe on all enablers matching
2364 * Called with sessions lock held.
2366 int lttng_fix_pending_events(void)
2368 struct lttng_kernel_session_private
*session_priv
;
2370 list_for_each_entry(session_priv
, &sessions
, list
)
2371 lttng_session_lazy_sync_event_enablers(session_priv
->pub
);
2375 static bool lttng_event_notifier_group_has_active_event_notifiers(
2376 struct lttng_event_notifier_group
*event_notifier_group
)
2378 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2380 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
,
2382 if (event_notifier_enabler
->parent
.enabled
)
2388 bool lttng_event_notifier_active(void)
2390 struct lttng_event_notifier_group
*event_notifier_group
;
2392 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2393 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group
))
2399 int lttng_fix_pending_event_notifiers(void)
2401 struct lttng_event_notifier_group
*event_notifier_group
;
2403 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
)
2404 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
2408 struct lttng_event_recorder_enabler
*lttng_event_recorder_enabler_create(
2409 enum lttng_enabler_format_type format_type
,
2410 struct lttng_kernel_abi_event
*event_param
,
2411 struct lttng_kernel_channel_buffer
*chan
)
2413 struct lttng_event_recorder_enabler
*event_enabler
;
2415 event_enabler
= kzalloc(sizeof(*event_enabler
), GFP_KERNEL
);
2418 event_enabler
->parent
.enabler_type
= LTTNG_EVENT_ENABLER_TYPE_RECORDER
;
2419 event_enabler
->parent
.format_type
= format_type
;
2420 INIT_LIST_HEAD(&event_enabler
->parent
.filter_bytecode_head
);
2421 memcpy(&event_enabler
->parent
.event_param
, event_param
,
2422 sizeof(event_enabler
->parent
.event_param
));
2423 event_enabler
->chan
= chan
;
2425 event_enabler
->parent
.enabled
= 0;
2426 return event_enabler
;
2429 void lttng_event_enabler_session_add(struct lttng_kernel_session
*session
,
2430 struct lttng_event_recorder_enabler
*event_enabler
)
2432 mutex_lock(&sessions_mutex
);
2433 list_add(&event_enabler
->node
, &session
->priv
->enablers_head
);
2434 event_enabler
->published
= true;
2435 lttng_session_lazy_sync_event_enablers(session
);
2436 mutex_unlock(&sessions_mutex
);
2439 int lttng_event_enabler_enable(struct lttng_event_enabler_common
*event_enabler
)
2441 mutex_lock(&sessions_mutex
);
2442 event_enabler
->enabled
= 1;
2443 lttng_event_enabler_sync(event_enabler
);
2444 mutex_unlock(&sessions_mutex
);
2448 int lttng_event_enabler_disable(struct lttng_event_enabler_common
*event_enabler
)
2450 mutex_lock(&sessions_mutex
);
2451 event_enabler
->enabled
= 0;
2452 lttng_event_enabler_sync(event_enabler
);
2453 mutex_unlock(&sessions_mutex
);
2458 int lttng_enabler_attach_filter_bytecode(struct lttng_event_enabler_common
*enabler
,
2459 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2461 struct lttng_kernel_bytecode_node
*bytecode_node
;
2462 uint32_t bytecode_len
;
2465 ret
= get_user(bytecode_len
, &bytecode
->len
);
2468 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2472 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2473 sizeof(*bytecode
) + bytecode_len
);
2477 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_FILTER
;
2478 bytecode_node
->enabler
= enabler
;
2479 /* Enforce length based on allocated size */
2480 bytecode_node
->bc
.len
= bytecode_len
;
2481 list_add_tail(&bytecode_node
->node
, &enabler
->filter_bytecode_head
);
2486 lttng_kvfree(bytecode_node
);
2490 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common
*event_enabler
,
2491 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2494 ret
= lttng_enabler_attach_filter_bytecode(event_enabler
, bytecode
);
2497 lttng_event_enabler_sync(event_enabler
);
2504 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
2505 struct lttng_kernel_abi_event_callsite __user
*callsite
)
2508 switch (event
->priv
->instrumentation
) {
2509 case LTTNG_KERNEL_ABI_UPROBE
:
2510 return lttng_uprobes_event_add_callsite(event
, callsite
);
2517 void lttng_enabler_destroy(struct lttng_event_enabler_common
*enabler
)
2519 struct lttng_kernel_bytecode_node
*filter_node
, *tmp_filter_node
;
2521 /* Destroy filter bytecode */
2522 list_for_each_entry_safe(filter_node
, tmp_filter_node
,
2523 &enabler
->filter_bytecode_head
, node
) {
2524 lttng_kvfree(filter_node
);
2528 void lttng_event_enabler_destroy(struct lttng_event_enabler_common
*event_enabler
)
2530 switch (event_enabler
->enabler_type
) {
2531 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
2533 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
2534 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
2536 lttng_enabler_destroy(event_enabler
);
2537 if (event_recorder_enabler
->published
)
2538 list_del(&event_recorder_enabler
->node
);
2539 kfree(event_recorder_enabler
);
2542 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
2544 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
2545 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
2547 lttng_enabler_destroy(event_enabler
);
2548 if (event_notifier_enabler
->published
)
2549 list_del(&event_notifier_enabler
->node
);
2550 kfree(event_notifier_enabler
);
2558 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
2559 enum lttng_enabler_format_type format_type
,
2560 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
2561 struct lttng_event_notifier_group
*event_notifier_group
)
2563 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2565 event_notifier_enabler
= kzalloc(sizeof(*event_notifier_enabler
), GFP_KERNEL
);
2566 if (!event_notifier_enabler
)
2569 event_notifier_enabler
->parent
.enabler_type
= LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
;
2570 event_notifier_enabler
->parent
.format_type
= format_type
;
2571 INIT_LIST_HEAD(&event_notifier_enabler
->parent
.filter_bytecode_head
);
2572 INIT_LIST_HEAD(&event_notifier_enabler
->capture_bytecode_head
);
2574 event_notifier_enabler
->error_counter_index
= event_notifier_param
->error_counter_index
;
2575 event_notifier_enabler
->num_captures
= 0;
2577 memcpy(&event_notifier_enabler
->parent
.event_param
, &event_notifier_param
->event
,
2578 sizeof(event_notifier_enabler
->parent
.event_param
));
2580 event_notifier_enabler
->parent
.enabled
= 0;
2581 event_notifier_enabler
->parent
.user_token
= event_notifier_param
->event
.token
;
2582 event_notifier_enabler
->group
= event_notifier_group
;
2583 return event_notifier_enabler
;
2586 void lttng_event_notifier_enabler_group_add(struct lttng_event_notifier_group
*event_notifier_group
,
2587 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2589 mutex_lock(&sessions_mutex
);
2590 list_add(&event_notifier_enabler
->node
, &event_notifier_enabler
->group
->enablers_head
);
2591 event_notifier_enabler
->published
= true;
2592 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2593 mutex_unlock(&sessions_mutex
);
2596 int lttng_event_notifier_enabler_enable(
2597 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2599 mutex_lock(&sessions_mutex
);
2600 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
2601 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2602 mutex_unlock(&sessions_mutex
);
2606 int lttng_event_notifier_enabler_disable(
2607 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2609 mutex_lock(&sessions_mutex
);
2610 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
2611 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2612 mutex_unlock(&sessions_mutex
);
2616 int lttng_event_notifier_enabler_attach_capture_bytecode(
2617 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2618 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
)
2620 struct lttng_kernel_bytecode_node
*bytecode_node
;
2621 struct lttng_event_enabler_common
*enabler
=
2622 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2623 uint32_t bytecode_len
;
2626 ret
= get_user(bytecode_len
, &bytecode
->len
);
2630 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2635 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2636 sizeof(*bytecode
) + bytecode_len
);
2640 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
;
2641 bytecode_node
->enabler
= enabler
;
2643 /* Enforce length based on allocated size */
2644 bytecode_node
->bc
.len
= bytecode_len
;
2645 list_add_tail(&bytecode_node
->node
, &event_notifier_enabler
->capture_bytecode_head
);
2647 event_notifier_enabler
->num_captures
++;
2649 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2653 lttng_kvfree(bytecode_node
);
2659 * lttng_session_sync_event_enablers should be called just before starting a
2661 * Should be called with sessions mutex held.
2664 void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
)
2666 struct lttng_event_recorder_enabler
*event_enabler
;
2667 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2669 list_for_each_entry(event_enabler
, &session
->priv
->enablers_head
, node
)
2670 lttng_event_enabler_ref_events(event_enabler
);
2672 * For each event, if at least one of its enablers is enabled,
2673 * and its channel and session transient states are enabled, we
2674 * enable the event, else we disable it.
2676 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, parent
.node
) {
2677 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2678 struct lttng_enabler_ref
*enabler_ref
;
2679 struct lttng_kernel_bytecode_runtime
*runtime
;
2680 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2683 switch (event_recorder_priv
->parent
.instrumentation
) {
2684 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2686 case LTTNG_KERNEL_ABI_SYSCALL
:
2688 list_for_each_entry(enabler_ref
,
2689 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2690 if (enabler_ref
->ref
->enabled
) {
2698 /* Not handled with lazy sync. */
2702 * Enabled state is based on union of enablers, with
2703 * intesection of session and channel transient enable
2706 enabled
= enabled
&& session
->priv
->tstate
&& event_recorder
->chan
->priv
->parent
.tstate
;
2708 WRITE_ONCE(event_recorder
->parent
.enabled
, enabled
);
2710 * Sync tracepoint registration with event enabled
2714 register_event(&event_recorder
->parent
);
2716 _lttng_event_unregister(&event_recorder
->parent
);
2719 /* Check if has enablers without bytecode enabled */
2720 list_for_each_entry(enabler_ref
,
2721 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2722 if (enabler_ref
->ref
->enabled
2723 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2724 has_enablers_without_filter_bytecode
= 1;
2728 event_recorder_priv
->parent
.has_enablers_without_filter_bytecode
=
2729 has_enablers_without_filter_bytecode
;
2731 /* Enable filters */
2732 list_for_each_entry(runtime
,
2733 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2734 lttng_bytecode_sync_state(runtime
);
2737 WRITE_ONCE(event_recorder_priv
->parent
.pub
->eval_filter
,
2738 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2743 * Apply enablers to session events, adding events to session if need
2744 * be. It is required after each modification applied to an active
2745 * session, and right before session "start".
2746 * "lazy" sync means we only sync if required.
2747 * Should be called with sessions mutex held.
2750 void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
)
2752 /* We can skip if session is not active */
2753 if (!session
->active
)
2755 lttng_session_sync_event_enablers(session
);
2759 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2761 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2762 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2764 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2765 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2768 * For each event_notifier, if at least one of its enablers is enabled,
2769 * we enable the event_notifier, else we disable it.
2771 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, parent
.node
) {
2772 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2773 struct lttng_enabler_ref
*enabler_ref
;
2774 struct lttng_kernel_bytecode_runtime
*runtime
;
2775 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2776 int nr_filters
= 0, nr_captures
= 0;
2778 switch (event_notifier_priv
->parent
.instrumentation
) {
2779 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2781 case LTTNG_KERNEL_ABI_SYSCALL
:
2782 /* Enable event_notifiers */
2783 list_for_each_entry(enabler_ref
,
2784 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2785 if (enabler_ref
->ref
->enabled
) {
2793 /* Not handled with sync. */
2797 WRITE_ONCE(event_notifier
->parent
.enabled
, enabled
);
2799 * Sync tracepoint registration with event_notifier enabled
2803 if (!event_notifier_priv
->parent
.registered
)
2804 register_event(&event_notifier
->parent
);
2806 if (event_notifier_priv
->parent
.registered
)
2807 _lttng_event_unregister(&event_notifier
->parent
);
2810 /* Check if has enablers without bytecode enabled */
2811 list_for_each_entry(enabler_ref
,
2812 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2813 if (enabler_ref
->ref
->enabled
2814 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2815 has_enablers_without_filter_bytecode
= 1;
2819 event_notifier_priv
->parent
.has_enablers_without_filter_bytecode
=
2820 has_enablers_without_filter_bytecode
;
2822 /* Enable filters */
2823 list_for_each_entry(runtime
,
2824 &event_notifier_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2825 lttng_bytecode_sync_state(runtime
);
2828 WRITE_ONCE(event_notifier_priv
->parent
.pub
->eval_filter
,
2829 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2831 /* Enable captures */
2832 list_for_each_entry(runtime
,
2833 &event_notifier_priv
->capture_bytecode_runtime_head
, node
) {
2834 lttng_bytecode_sync_state(runtime
);
2837 WRITE_ONCE(event_notifier
->eval_capture
, !!nr_captures
);
2842 void lttng_event_enabler_sync(struct lttng_event_enabler_common
*event_enabler
)
2844 switch (event_enabler
->enabler_type
) {
2845 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
2847 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
2848 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
2849 lttng_session_lazy_sync_event_enablers(event_recorder_enabler
->chan
->parent
.session
);
2852 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
2854 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
2855 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
2856 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2865 * Serialize at most one packet worth of metadata into a metadata
2867 * We grab the metadata cache mutex to get exclusive access to our metadata
2868 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2869 * allows us to do racy operations such as looking for remaining space left in
2870 * packet and write, since mutual exclusion protects us from concurrent writes.
2871 * Mutual exclusion on the metadata cache allow us to read the cache content
2872 * without racing against reallocation of the cache by updates.
2873 * Returns the number of bytes written in the channel, 0 if no data
2874 * was written and a negative value on error.
2876 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
2877 struct lttng_kernel_ring_buffer_channel
*chan
, bool *coherent
)
2879 struct lttng_kernel_ring_buffer_ctx ctx
;
2881 size_t len
, reserve_len
;
2884 * Ensure we support mutiple get_next / put sequences followed by
2885 * put_next. The metadata cache lock protects reading the metadata
2886 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2887 * "flush" operations on the buffer invoked by different processes.
2888 * Moreover, since the metadata cache memory can be reallocated, we
2889 * need to have exclusive access against updates even though we only
2892 mutex_lock(&stream
->metadata_cache
->lock
);
2893 WARN_ON(stream
->metadata_in
< stream
->metadata_out
);
2894 if (stream
->metadata_in
!= stream
->metadata_out
)
2897 /* Metadata regenerated, change the version. */
2898 if (stream
->metadata_cache
->version
!= stream
->version
)
2899 stream
->version
= stream
->metadata_cache
->version
;
2901 len
= stream
->metadata_cache
->metadata_written
-
2902 stream
->metadata_in
;
2905 reserve_len
= min_t(size_t,
2906 stream
->transport
->ops
.priv
->packet_avail_size(chan
),
2908 lib_ring_buffer_ctx_init(&ctx
, chan
, reserve_len
,
2909 sizeof(char), NULL
);
2911 * If reservation failed, return an error to the caller.
2913 ret
= stream
->transport
->ops
.event_reserve(&ctx
);
2915 printk(KERN_WARNING
"LTTng: Metadata event reservation failed\n");
2916 stream
->coherent
= false;
2919 stream
->transport
->ops
.event_write(&ctx
,
2920 stream
->metadata_cache
->data
+ stream
->metadata_in
,
2922 stream
->transport
->ops
.event_commit(&ctx
);
2923 stream
->metadata_in
+= reserve_len
;
2924 if (reserve_len
< len
)
2925 stream
->coherent
= false;
2927 stream
->coherent
= true;
2932 *coherent
= stream
->coherent
;
2933 mutex_unlock(&stream
->metadata_cache
->lock
);
2938 void lttng_metadata_begin(struct lttng_kernel_session
*session
)
2940 if (atomic_inc_return(&session
->priv
->metadata_cache
->producing
) == 1)
2941 mutex_lock(&session
->priv
->metadata_cache
->lock
);
2945 void lttng_metadata_end(struct lttng_kernel_session
*session
)
2947 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
2948 if (atomic_dec_return(&session
->priv
->metadata_cache
->producing
) == 0) {
2949 struct lttng_metadata_stream
*stream
;
2951 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
2952 wake_up_interruptible(&stream
->read_wait
);
2953 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
2958 * Write the metadata to the metadata cache.
2959 * Must be called with sessions_mutex held.
2960 * The metadata cache lock protects us from concurrent read access from
2961 * thread outputting metadata content to ring buffer.
2962 * The content of the printf is printed as a single atomic metadata
2965 int lttng_metadata_printf(struct lttng_kernel_session
*session
,
2966 const char *fmt
, ...)
2972 WARN_ON_ONCE(!LTTNG_READ_ONCE(session
->active
));
2975 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
2981 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
2982 if (session
->priv
->metadata_cache
->metadata_written
+ len
>
2983 session
->priv
->metadata_cache
->cache_alloc
) {
2984 char *tmp_cache_realloc
;
2985 unsigned int tmp_cache_alloc_size
;
2987 tmp_cache_alloc_size
= max_t(unsigned int,
2988 session
->priv
->metadata_cache
->cache_alloc
+ len
,
2989 session
->priv
->metadata_cache
->cache_alloc
<< 1);
2990 tmp_cache_realloc
= vzalloc(tmp_cache_alloc_size
);
2991 if (!tmp_cache_realloc
)
2993 if (session
->priv
->metadata_cache
->data
) {
2994 memcpy(tmp_cache_realloc
,
2995 session
->priv
->metadata_cache
->data
,
2996 session
->priv
->metadata_cache
->cache_alloc
);
2997 vfree(session
->priv
->metadata_cache
->data
);
3000 session
->priv
->metadata_cache
->cache_alloc
= tmp_cache_alloc_size
;
3001 session
->priv
->metadata_cache
->data
= tmp_cache_realloc
;
3003 memcpy(session
->priv
->metadata_cache
->data
+
3004 session
->priv
->metadata_cache
->metadata_written
,
3006 session
->priv
->metadata_cache
->metadata_written
+= len
;
3017 int print_tabs(struct lttng_kernel_session
*session
, size_t nesting
)
3021 for (i
= 0; i
< nesting
; i
++) {
3024 ret
= lttng_metadata_printf(session
, " ");
3033 int lttng_field_name_statedump(struct lttng_kernel_session
*session
,
3034 const struct lttng_kernel_event_field
*field
,
3037 return lttng_metadata_printf(session
, " _%s;\n", field
->name
);
3041 int _lttng_integer_type_statedump(struct lttng_kernel_session
*session
,
3042 const struct lttng_kernel_type_integer
*type
,
3043 enum lttng_kernel_string_encoding parent_encoding
,
3048 ret
= print_tabs(session
, nesting
);
3051 ret
= lttng_metadata_printf(session
,
3052 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
3056 (parent_encoding
== lttng_kernel_string_encoding_none
)
3058 : (parent_encoding
== lttng_kernel_string_encoding_UTF8
)
3062 #if __BYTE_ORDER == __BIG_ENDIAN
3063 type
->reverse_byte_order
? " byte_order = le;" : ""
3065 type
->reverse_byte_order
? " byte_order = be;" : ""
3072 * Must be called with sessions_mutex held.
3075 int _lttng_struct_type_statedump(struct lttng_kernel_session
*session
,
3076 const struct lttng_kernel_type_struct
*type
,
3079 const char *prev_field_name
= NULL
;
3081 uint32_t i
, nr_fields
;
3082 unsigned int alignment
;
3084 ret
= print_tabs(session
, nesting
);
3087 ret
= lttng_metadata_printf(session
,
3091 nr_fields
= type
->nr_fields
;
3092 for (i
= 0; i
< nr_fields
; i
++) {
3093 const struct lttng_kernel_event_field
*iter_field
;
3095 iter_field
= type
->fields
[i
];
3096 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, &prev_field_name
);
3100 ret
= print_tabs(session
, nesting
);
3103 alignment
= type
->alignment
;
3105 ret
= lttng_metadata_printf(session
,
3109 ret
= lttng_metadata_printf(session
,
3116 * Must be called with sessions_mutex held.
3119 int _lttng_struct_field_statedump(struct lttng_kernel_session
*session
,
3120 const struct lttng_kernel_event_field
*field
,
3125 ret
= _lttng_struct_type_statedump(session
,
3126 lttng_kernel_get_type_struct(field
->type
), nesting
);
3129 return lttng_field_name_statedump(session
, field
, nesting
);
3133 * Must be called with sessions_mutex held.
3136 int _lttng_variant_type_statedump(struct lttng_kernel_session
*session
,
3137 const struct lttng_kernel_type_variant
*type
,
3139 const char *prev_field_name
)
3141 const char *tag_name
;
3143 uint32_t i
, nr_choices
;
3145 tag_name
= type
->tag_name
;
3147 tag_name
= prev_field_name
;
3151 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
3153 if (type
->alignment
!= 0)
3155 ret
= print_tabs(session
, nesting
);
3158 ret
= lttng_metadata_printf(session
,
3159 "variant <_%s> {\n",
3163 nr_choices
= type
->nr_choices
;
3164 for (i
= 0; i
< nr_choices
; i
++) {
3165 const struct lttng_kernel_event_field
*iter_field
;
3167 iter_field
= type
->choices
[i
];
3168 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, NULL
);
3172 ret
= print_tabs(session
, nesting
);
3175 ret
= lttng_metadata_printf(session
,
3181 * Must be called with sessions_mutex held.
3184 int _lttng_variant_field_statedump(struct lttng_kernel_session
*session
,
3185 const struct lttng_kernel_event_field
*field
,
3187 const char *prev_field_name
)
3191 ret
= _lttng_variant_type_statedump(session
,
3192 lttng_kernel_get_type_variant(field
->type
), nesting
,
3196 return lttng_field_name_statedump(session
, field
, nesting
);
3200 * Must be called with sessions_mutex held.
3203 int _lttng_array_field_statedump(struct lttng_kernel_session
*session
,
3204 const struct lttng_kernel_event_field
*field
,
3208 const struct lttng_kernel_type_array
*array_type
;
3209 const struct lttng_kernel_type_common
*elem_type
;
3211 array_type
= lttng_kernel_get_type_array(field
->type
);
3212 WARN_ON_ONCE(!array_type
);
3214 if (array_type
->alignment
) {
3215 ret
= print_tabs(session
, nesting
);
3218 ret
= lttng_metadata_printf(session
,
3219 "struct { } align(%u) _%s_padding;\n",
3220 array_type
->alignment
* CHAR_BIT
,
3226 * Nested compound types: Only array of structures and variants are
3227 * currently supported.
3229 elem_type
= array_type
->elem_type
;
3230 switch (elem_type
->type
) {
3231 case lttng_kernel_type_integer
:
3232 case lttng_kernel_type_struct
:
3233 case lttng_kernel_type_variant
:
3234 ret
= _lttng_type_statedump(session
, elem_type
,
3235 array_type
->encoding
, nesting
);
3243 ret
= lttng_metadata_printf(session
,
3246 array_type
->length
);
3251 * Must be called with sessions_mutex held.
3254 int _lttng_sequence_field_statedump(struct lttng_kernel_session
*session
,
3255 const struct lttng_kernel_event_field
*field
,
3257 const char *prev_field_name
)
3260 const char *length_name
;
3261 const struct lttng_kernel_type_sequence
*sequence_type
;
3262 const struct lttng_kernel_type_common
*elem_type
;
3264 sequence_type
= lttng_kernel_get_type_sequence(field
->type
);
3265 WARN_ON_ONCE(!sequence_type
);
3267 length_name
= sequence_type
->length_name
;
3269 length_name
= prev_field_name
;
3273 if (sequence_type
->alignment
) {
3274 ret
= print_tabs(session
, nesting
);
3277 ret
= lttng_metadata_printf(session
,
3278 "struct { } align(%u) _%s_padding;\n",
3279 sequence_type
->alignment
* CHAR_BIT
,
3286 * Nested compound types: Only array of structures and variants are
3287 * currently supported.
3289 elem_type
= sequence_type
->elem_type
;
3290 switch (elem_type
->type
) {
3291 case lttng_kernel_type_integer
:
3292 case lttng_kernel_type_struct
:
3293 case lttng_kernel_type_variant
:
3294 ret
= _lttng_type_statedump(session
, elem_type
,
3295 sequence_type
->encoding
, nesting
);
3303 ret
= lttng_metadata_printf(session
,
3311 * Must be called with sessions_mutex held.
3314 int _lttng_enum_type_statedump(struct lttng_kernel_session
*session
,
3315 const struct lttng_kernel_type_enum
*type
,
3318 const struct lttng_kernel_enum_desc
*enum_desc
;
3319 const struct lttng_kernel_type_common
*container_type
;
3321 unsigned int i
, nr_entries
;
3323 container_type
= type
->container_type
;
3324 if (container_type
->type
!= lttng_kernel_type_integer
) {
3328 enum_desc
= type
->desc
;
3329 nr_entries
= enum_desc
->nr_entries
;
3331 ret
= print_tabs(session
, nesting
);
3334 ret
= lttng_metadata_printf(session
, "enum : ");
3337 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(container_type
),
3338 lttng_kernel_string_encoding_none
, 0);
3341 ret
= lttng_metadata_printf(session
, " {\n");
3344 /* Dump all entries */
3345 for (i
= 0; i
< nr_entries
; i
++) {
3346 const struct lttng_kernel_enum_entry
*entry
= enum_desc
->entries
[i
];
3349 ret
= print_tabs(session
, nesting
+ 1);
3352 ret
= lttng_metadata_printf(session
,
3356 len
= strlen(entry
->string
);
3357 /* Escape the character '"' */
3358 for (j
= 0; j
< len
; j
++) {
3359 char c
= entry
->string
[j
];
3363 ret
= lttng_metadata_printf(session
,
3367 ret
= lttng_metadata_printf(session
,
3371 ret
= lttng_metadata_printf(session
,
3378 ret
= lttng_metadata_printf(session
, "\"");
3382 if (entry
->options
.is_auto
) {
3383 ret
= lttng_metadata_printf(session
, ",\n");
3387 ret
= lttng_metadata_printf(session
,
3391 if (entry
->start
.signedness
)
3392 ret
= lttng_metadata_printf(session
,
3393 "%lld", (long long) entry
->start
.value
);
3395 ret
= lttng_metadata_printf(session
,
3396 "%llu", entry
->start
.value
);
3399 if (entry
->start
.signedness
== entry
->end
.signedness
&&
3401 == entry
->end
.value
) {
3402 ret
= lttng_metadata_printf(session
,
3405 if (entry
->end
.signedness
) {
3406 ret
= lttng_metadata_printf(session
,
3408 (long long) entry
->end
.value
);
3410 ret
= lttng_metadata_printf(session
,
3419 ret
= print_tabs(session
, nesting
);
3422 ret
= lttng_metadata_printf(session
, "}");
3428 * Must be called with sessions_mutex held.
3431 int _lttng_enum_field_statedump(struct lttng_kernel_session
*session
,
3432 const struct lttng_kernel_event_field
*field
,
3436 const struct lttng_kernel_type_enum
*enum_type
;
3438 enum_type
= lttng_kernel_get_type_enum(field
->type
);
3439 WARN_ON_ONCE(!enum_type
);
3440 ret
= _lttng_enum_type_statedump(session
, enum_type
, nesting
);
3443 return lttng_field_name_statedump(session
, field
, nesting
);
3447 int _lttng_integer_field_statedump(struct lttng_kernel_session
*session
,
3448 const struct lttng_kernel_event_field
*field
,
3453 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(field
->type
),
3454 lttng_kernel_string_encoding_none
, nesting
);
3457 return lttng_field_name_statedump(session
, field
, nesting
);
3461 int _lttng_string_type_statedump(struct lttng_kernel_session
*session
,
3462 const struct lttng_kernel_type_string
*type
,
3467 /* Default encoding is UTF8 */
3468 ret
= print_tabs(session
, nesting
);
3471 ret
= lttng_metadata_printf(session
,
3473 type
->encoding
== lttng_kernel_string_encoding_ASCII
?
3474 " { encoding = ASCII; }" : "");
3479 int _lttng_string_field_statedump(struct lttng_kernel_session
*session
,
3480 const struct lttng_kernel_event_field
*field
,
3483 const struct lttng_kernel_type_string
*string_type
;
3486 string_type
= lttng_kernel_get_type_string(field
->type
);
3487 WARN_ON_ONCE(!string_type
);
3488 ret
= _lttng_string_type_statedump(session
, string_type
, nesting
);
3491 return lttng_field_name_statedump(session
, field
, nesting
);
3495 * Must be called with sessions_mutex held.
3498 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
3499 const struct lttng_kernel_type_common
*type
,
3500 enum lttng_kernel_string_encoding parent_encoding
,
3505 switch (type
->type
) {
3506 case lttng_kernel_type_integer
:
3507 ret
= _lttng_integer_type_statedump(session
,
3508 lttng_kernel_get_type_integer(type
),
3509 parent_encoding
, nesting
);
3511 case lttng_kernel_type_enum
:
3512 ret
= _lttng_enum_type_statedump(session
,
3513 lttng_kernel_get_type_enum(type
),
3516 case lttng_kernel_type_string
:
3517 ret
= _lttng_string_type_statedump(session
,
3518 lttng_kernel_get_type_string(type
),
3521 case lttng_kernel_type_struct
:
3522 ret
= _lttng_struct_type_statedump(session
,
3523 lttng_kernel_get_type_struct(type
),
3526 case lttng_kernel_type_variant
:
3527 ret
= _lttng_variant_type_statedump(session
,
3528 lttng_kernel_get_type_variant(type
),
3532 /* Nested arrays and sequences are not supported yet. */
3533 case lttng_kernel_type_array
:
3534 case lttng_kernel_type_sequence
:
3543 * Must be called with sessions_mutex held.
3546 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
3547 const struct lttng_kernel_event_field
*field
,
3549 const char **prev_field_name_p
)
3551 const char *prev_field_name
= NULL
;
3554 if (prev_field_name_p
)
3555 prev_field_name
= *prev_field_name_p
;
3556 switch (field
->type
->type
) {
3557 case lttng_kernel_type_integer
:
3558 ret
= _lttng_integer_field_statedump(session
, field
, nesting
);
3560 case lttng_kernel_type_enum
:
3561 ret
= _lttng_enum_field_statedump(session
, field
, nesting
);
3563 case lttng_kernel_type_string
:
3564 ret
= _lttng_string_field_statedump(session
, field
, nesting
);
3566 case lttng_kernel_type_struct
:
3567 ret
= _lttng_struct_field_statedump(session
, field
, nesting
);
3569 case lttng_kernel_type_array
:
3570 ret
= _lttng_array_field_statedump(session
, field
, nesting
);
3572 case lttng_kernel_type_sequence
:
3573 ret
= _lttng_sequence_field_statedump(session
, field
, nesting
, prev_field_name
);
3575 case lttng_kernel_type_variant
:
3576 ret
= _lttng_variant_field_statedump(session
, field
, nesting
, prev_field_name
);
3583 if (prev_field_name_p
)
3584 *prev_field_name_p
= field
->name
;
3589 int _lttng_context_metadata_statedump(struct lttng_kernel_session
*session
,
3590 struct lttng_kernel_ctx
*ctx
)
3592 const char *prev_field_name
= NULL
;
3598 for (i
= 0; i
< ctx
->nr_fields
; i
++) {
3599 const struct lttng_kernel_ctx_field
*field
= &ctx
->fields
[i
];
3601 ret
= _lttng_field_statedump(session
, field
->event_field
, 2, &prev_field_name
);
3609 int _lttng_fields_metadata_statedump(struct lttng_kernel_session
*session
,
3610 struct lttng_kernel_event_recorder
*event_recorder
)
3612 const char *prev_field_name
= NULL
;
3613 const struct lttng_kernel_event_desc
*desc
= event_recorder
->priv
->parent
.desc
;
3617 for (i
= 0; i
< desc
->tp_class
->nr_fields
; i
++) {
3618 const struct lttng_kernel_event_field
*field
= desc
->tp_class
->fields
[i
];
3620 ret
= _lttng_field_statedump(session
, field
, 2, &prev_field_name
);
3628 * Must be called with sessions_mutex held.
3629 * The entire event metadata is printed as a single atomic metadata
3633 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
3634 struct lttng_kernel_channel_buffer
*chan
,
3635 struct lttng_kernel_event_recorder
*event_recorder
)
3639 if (event_recorder
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3641 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3644 lttng_metadata_begin(session
);
3646 ret
= lttng_metadata_printf(session
,
3650 " stream_id = %u;\n",
3651 event_recorder
->priv
->parent
.desc
->event_name
,
3652 event_recorder
->priv
->id
,
3653 event_recorder
->chan
->priv
->id
);
3657 ret
= lttng_metadata_printf(session
,
3658 " fields := struct {\n"
3663 ret
= _lttng_fields_metadata_statedump(session
, event_recorder
);
3668 * LTTng space reservation can only reserve multiples of the
3671 ret
= lttng_metadata_printf(session
,
3677 event_recorder
->priv
->metadata_dumped
= 1;
3679 lttng_metadata_end(session
);
3685 * Must be called with sessions_mutex held.
3686 * The entire channel metadata is printed as a single atomic metadata
3690 int _lttng_channel_metadata_statedump(struct lttng_kernel_session
*session
,
3691 struct lttng_kernel_channel_buffer
*chan
)
3695 if (chan
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3698 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3701 lttng_metadata_begin(session
);
3703 WARN_ON_ONCE(!chan
->priv
->header_type
);
3704 ret
= lttng_metadata_printf(session
,
3707 " event.header := %s;\n"
3708 " packet.context := struct packet_context;\n",
3710 chan
->priv
->header_type
== 1 ? "struct event_header_compact" :
3711 "struct event_header_large");
3715 if (chan
->priv
->ctx
) {
3716 ret
= lttng_metadata_printf(session
,
3717 " event.context := struct {\n");
3721 ret
= _lttng_context_metadata_statedump(session
, chan
->priv
->ctx
);
3724 if (chan
->priv
->ctx
) {
3725 ret
= lttng_metadata_printf(session
,
3731 ret
= lttng_metadata_printf(session
,
3734 chan
->priv
->metadata_dumped
= 1;
3736 lttng_metadata_end(session
);
3741 * Must be called with sessions_mutex held.
3744 int _lttng_stream_packet_context_declare(struct lttng_kernel_session
*session
)
3746 return lttng_metadata_printf(session
,
3747 "struct packet_context {\n"
3748 " uint64_clock_monotonic_t timestamp_begin;\n"
3749 " uint64_clock_monotonic_t timestamp_end;\n"
3750 " uint64_t content_size;\n"
3751 " uint64_t packet_size;\n"
3752 " uint64_t packet_seq_num;\n"
3753 " unsigned long events_discarded;\n"
3754 " uint32_t cpu_id;\n"
3761 * id: range: 0 - 30.
3762 * id 31 is reserved to indicate an extended header.
3765 * id: range: 0 - 65534.
3766 * id 65535 is reserved to indicate an extended header.
3768 * Must be called with sessions_mutex held.
3771 int _lttng_event_header_declare(struct lttng_kernel_session
*session
)
3773 return lttng_metadata_printf(session
,
3774 "struct event_header_compact {\n"
3775 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3778 " uint27_clock_monotonic_t timestamp;\n"
3782 " uint64_clock_monotonic_t timestamp;\n"
3787 "struct event_header_large {\n"
3788 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3791 " uint32_clock_monotonic_t timestamp;\n"
3795 " uint64_clock_monotonic_t timestamp;\n"
3799 lttng_alignof(uint32_t) * CHAR_BIT
,
3800 lttng_alignof(uint16_t) * CHAR_BIT
3805 * Approximation of NTP time of day to clock monotonic correlation,
3806 * taken at start of trace.
3807 * Yes, this is only an approximation. Yes, we can (and will) do better
3808 * in future versions.
3809 * This function may return a negative offset. It may happen if the
3810 * system sets the REALTIME clock to 0 after boot.
3812 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3816 int64_t measure_clock_offset(void)
3818 uint64_t monotonic_avg
, monotonic
[2], realtime
;
3819 uint64_t tcf
= trace_clock_freq();
3821 unsigned long flags
;
3822 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3823 struct timespec64 rts
= { 0, 0 };
3825 struct timespec rts
= { 0, 0 };
3828 /* Disable interrupts to increase correlation precision. */
3829 local_irq_save(flags
);
3830 monotonic
[0] = trace_clock_read64();
3831 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3832 ktime_get_real_ts64(&rts
);
3834 getnstimeofday(&rts
);
3836 monotonic
[1] = trace_clock_read64();
3837 local_irq_restore(flags
);
3839 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
3840 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
3841 if (tcf
== NSEC_PER_SEC
) {
3842 realtime
+= rts
.tv_nsec
;
3844 uint64_t n
= rts
.tv_nsec
* tcf
;
3846 do_div(n
, NSEC_PER_SEC
);
3849 offset
= (int64_t) realtime
- monotonic_avg
;
3854 int print_escaped_ctf_string(struct lttng_kernel_session
*session
, const char *string
)
3862 while (cur
!= '\0') {
3865 ret
= lttng_metadata_printf(session
, "%s", "\\n");
3869 ret
= lttng_metadata_printf(session
, "%c", '\\');
3872 /* We still print the current char */
3875 ret
= lttng_metadata_printf(session
, "%c", cur
);
3889 int print_metadata_escaped_field(struct lttng_kernel_session
*session
, const char *field
,
3890 const char *field_value
)
3894 ret
= lttng_metadata_printf(session
, " %s = \"", field
);
3898 ret
= print_escaped_ctf_string(session
, field_value
);
3902 ret
= lttng_metadata_printf(session
, "\";\n");
3909 * Output metadata into this session's metadata buffers.
3910 * Must be called with sessions_mutex held.
3913 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
)
3915 unsigned char *uuid_c
= session
->priv
->uuid
.b
;
3916 unsigned char uuid_s
[37], clock_uuid_s
[BOOT_ID_LEN
];
3917 const char *product_uuid
;
3918 struct lttng_kernel_channel_buffer_private
*chan_priv
;
3919 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
3922 if (!LTTNG_READ_ONCE(session
->active
))
3925 lttng_metadata_begin(session
);
3927 if (session
->priv
->metadata_dumped
)
3930 snprintf(uuid_s
, sizeof(uuid_s
),
3931 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3932 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
3933 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
3934 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
3935 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
3937 ret
= lttng_metadata_printf(session
,
3938 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3939 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3940 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3941 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
3942 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
3943 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
3944 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
3950 " byte_order = %s;\n"
3951 " packet.header := struct {\n"
3952 " uint32_t magic;\n"
3953 " uint8_t uuid[16];\n"
3954 " uint32_t stream_id;\n"
3955 " uint64_t stream_instance_id;\n"
3958 lttng_alignof(uint8_t) * CHAR_BIT
,
3959 lttng_alignof(uint16_t) * CHAR_BIT
,
3960 lttng_alignof(uint32_t) * CHAR_BIT
,
3961 lttng_alignof(uint64_t) * CHAR_BIT
,
3962 sizeof(unsigned long) * CHAR_BIT
,
3963 lttng_alignof(unsigned long) * CHAR_BIT
,
3967 #if __BYTE_ORDER == __BIG_ENDIAN
3976 ret
= lttng_metadata_printf(session
,
3978 " hostname = \"%s\";\n"
3979 " domain = \"kernel\";\n"
3980 " sysname = \"%s\";\n"
3981 " kernel_release = \"%s\";\n"
3982 " kernel_version = \"%s\";\n"
3983 " tracer_name = \"lttng-modules\";\n"
3984 " tracer_major = %d;\n"
3985 " tracer_minor = %d;\n"
3986 " tracer_patchlevel = %d;\n"
3987 " trace_buffering_scheme = \"global\";\n",
3988 current
->nsproxy
->uts_ns
->name
.nodename
,
3992 LTTNG_MODULES_MAJOR_VERSION
,
3993 LTTNG_MODULES_MINOR_VERSION
,
3994 LTTNG_MODULES_PATCHLEVEL_VERSION
3999 ret
= print_metadata_escaped_field(session
, "trace_name", session
->priv
->name
);
4002 ret
= print_metadata_escaped_field(session
, "trace_creation_datetime",
4003 session
->priv
->creation_time
);
4007 /* Add the product UUID to the 'env' section */
4008 product_uuid
= dmi_get_system_info(DMI_PRODUCT_UUID
);
4010 ret
= lttng_metadata_printf(session
,
4011 " product_uuid = \"%s\";\n",
4018 /* Close the 'env' section */
4019 ret
= lttng_metadata_printf(session
, "};\n\n");
4023 ret
= lttng_metadata_printf(session
,
4025 " name = \"%s\";\n",
4031 if (!trace_clock_uuid(clock_uuid_s
)) {
4032 ret
= lttng_metadata_printf(session
,
4033 " uuid = \"%s\";\n",
4040 ret
= lttng_metadata_printf(session
,
4041 " description = \"%s\";\n"
4042 " freq = %llu; /* Frequency, in Hz */\n"
4043 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
4046 trace_clock_description(),
4047 (unsigned long long) trace_clock_freq(),
4048 (long long) measure_clock_offset()
4053 ret
= lttng_metadata_printf(session
,
4054 "typealias integer {\n"
4055 " size = 27; align = 1; signed = false;\n"
4056 " map = clock.%s.value;\n"
4057 "} := uint27_clock_monotonic_t;\n"
4059 "typealias integer {\n"
4060 " size = 32; align = %u; signed = false;\n"
4061 " map = clock.%s.value;\n"
4062 "} := uint32_clock_monotonic_t;\n"
4064 "typealias integer {\n"
4065 " size = 64; align = %u; signed = false;\n"
4066 " map = clock.%s.value;\n"
4067 "} := uint64_clock_monotonic_t;\n\n",
4069 lttng_alignof(uint32_t) * CHAR_BIT
,
4071 lttng_alignof(uint64_t) * CHAR_BIT
,
4077 ret
= _lttng_stream_packet_context_declare(session
);
4081 ret
= _lttng_event_header_declare(session
);
4086 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
4087 ret
= _lttng_channel_metadata_statedump(session
, chan_priv
->pub
);
4092 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, parent
.node
) {
4093 ret
= _lttng_event_metadata_statedump(session
, event_recorder_priv
->pub
->chan
,
4094 event_recorder_priv
->pub
);
4098 session
->priv
->metadata_dumped
= 1;
4100 lttng_metadata_end(session
);
4105 * lttng_transport_register - LTT transport registration
4106 * @transport: transport structure
4108 * Registers a transport which can be used as output to extract the data out of
4109 * LTTng. The module calling this registration function must ensure that no
4110 * trap-inducing code will be executed by the transport functions. E.g.
4111 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
4112 * is made visible to the transport function. This registration acts as a
4113 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
4114 * after its registration must it synchronize the TLBs.
4116 void lttng_transport_register(struct lttng_transport
*transport
)
4119 * Make sure no page fault can be triggered by the module about to be
4120 * registered. We deal with this here so we don't have to call
4121 * vmalloc_sync_mappings() in each module's init.
4123 wrapper_vmalloc_sync_mappings();
4125 mutex_lock(&sessions_mutex
);
4126 list_add_tail(&transport
->node
, <tng_transport_list
);
4127 mutex_unlock(&sessions_mutex
);
4129 EXPORT_SYMBOL_GPL(lttng_transport_register
);
4132 * lttng_transport_unregister - LTT transport unregistration
4133 * @transport: transport structure
4135 void lttng_transport_unregister(struct lttng_transport
*transport
)
4137 mutex_lock(&sessions_mutex
);
4138 list_del(&transport
->node
);
4139 mutex_unlock(&sessions_mutex
);
4141 EXPORT_SYMBOL_GPL(lttng_transport_unregister
);
4143 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
)
4146 * Make sure no page fault can be triggered by the module about to be
4147 * registered. We deal with this here so we don't have to call
4148 * vmalloc_sync_mappings() in each module's init.
4150 wrapper_vmalloc_sync_mappings();
4152 mutex_lock(&sessions_mutex
);
4153 list_add_tail(&transport
->node
, <tng_counter_transport_list
);
4154 mutex_unlock(&sessions_mutex
);
4156 EXPORT_SYMBOL_GPL(lttng_counter_transport_register
);
4158 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
)
4160 mutex_lock(&sessions_mutex
);
4161 list_del(&transport
->node
);
4162 mutex_unlock(&sessions_mutex
);
4164 EXPORT_SYMBOL_GPL(lttng_counter_transport_unregister
);
4166 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
4168 enum cpuhp_state lttng_hp_prepare
;
4169 enum cpuhp_state lttng_hp_online
;
4171 static int lttng_hotplug_prepare(unsigned int cpu
, struct hlist_node
*node
)
4173 struct lttng_cpuhp_node
*lttng_node
;
4175 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4176 switch (lttng_node
->component
) {
4177 case LTTNG_RING_BUFFER_FRONTEND
:
4179 case LTTNG_RING_BUFFER_BACKEND
:
4180 return lttng_cpuhp_rb_backend_prepare(cpu
, lttng_node
);
4181 case LTTNG_RING_BUFFER_ITER
:
4183 case LTTNG_CONTEXT_PERF_COUNTERS
:
4190 static int lttng_hotplug_dead(unsigned int cpu
, struct hlist_node
*node
)
4192 struct lttng_cpuhp_node
*lttng_node
;
4194 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4195 switch (lttng_node
->component
) {
4196 case LTTNG_RING_BUFFER_FRONTEND
:
4197 return lttng_cpuhp_rb_frontend_dead(cpu
, lttng_node
);
4198 case LTTNG_RING_BUFFER_BACKEND
:
4200 case LTTNG_RING_BUFFER_ITER
:
4202 case LTTNG_CONTEXT_PERF_COUNTERS
:
4203 return lttng_cpuhp_perf_counter_dead(cpu
, lttng_node
);
4209 static int lttng_hotplug_online(unsigned int cpu
, struct hlist_node
*node
)
4211 struct lttng_cpuhp_node
*lttng_node
;
4213 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4214 switch (lttng_node
->component
) {
4215 case LTTNG_RING_BUFFER_FRONTEND
:
4216 return lttng_cpuhp_rb_frontend_online(cpu
, lttng_node
);
4217 case LTTNG_RING_BUFFER_BACKEND
:
4219 case LTTNG_RING_BUFFER_ITER
:
4220 return lttng_cpuhp_rb_iter_online(cpu
, lttng_node
);
4221 case LTTNG_CONTEXT_PERF_COUNTERS
:
4222 return lttng_cpuhp_perf_counter_online(cpu
, lttng_node
);
4228 static int lttng_hotplug_offline(unsigned int cpu
, struct hlist_node
*node
)
4230 struct lttng_cpuhp_node
*lttng_node
;
4232 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4233 switch (lttng_node
->component
) {
4234 case LTTNG_RING_BUFFER_FRONTEND
:
4235 return lttng_cpuhp_rb_frontend_offline(cpu
, lttng_node
);
4236 case LTTNG_RING_BUFFER_BACKEND
:
4238 case LTTNG_RING_BUFFER_ITER
:
4240 case LTTNG_CONTEXT_PERF_COUNTERS
:
4247 static int __init
lttng_init_cpu_hotplug(void)
4251 ret
= cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN
, "lttng:prepare",
4252 lttng_hotplug_prepare
,
4253 lttng_hotplug_dead
);
4257 lttng_hp_prepare
= ret
;
4258 lttng_rb_set_hp_prepare(ret
);
4260 ret
= cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN
, "lttng:online",
4261 lttng_hotplug_online
,
4262 lttng_hotplug_offline
);
4264 cpuhp_remove_multi_state(lttng_hp_prepare
);
4265 lttng_hp_prepare
= 0;
4268 lttng_hp_online
= ret
;
4269 lttng_rb_set_hp_online(ret
);
4274 static void __exit
lttng_exit_cpu_hotplug(void)
4276 lttng_rb_set_hp_online(0);
4277 cpuhp_remove_multi_state(lttng_hp_online
);
4278 lttng_rb_set_hp_prepare(0);
4279 cpuhp_remove_multi_state(lttng_hp_prepare
);
4282 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4283 static int lttng_init_cpu_hotplug(void)
4287 static void lttng_exit_cpu_hotplug(void)
4290 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4292 static int __init
lttng_events_init(void)
4296 ret
= wrapper_lttng_fixup_sig(THIS_MODULE
);
4299 ret
= wrapper_get_pfnblock_flags_mask_init();
4302 ret
= wrapper_get_pageblock_flags_mask_init();
4305 ret
= lttng_probes_init();
4308 ret
= lttng_context_init();
4311 ret
= lttng_tracepoint_init();
4314 event_recorder_cache
= KMEM_CACHE(lttng_kernel_event_recorder
, 0);
4315 if (!event_recorder_cache
) {
4317 goto error_kmem_event_recorder
;
4319 event_recorder_private_cache
= KMEM_CACHE(lttng_kernel_event_recorder_private
, 0);
4320 if (!event_recorder_private_cache
) {
4322 goto error_kmem_event_recorder_private
;
4324 event_notifier_cache
= KMEM_CACHE(lttng_kernel_event_notifier
, 0);
4325 if (!event_notifier_cache
) {
4327 goto error_kmem_event_notifier
;
4329 event_notifier_private_cache
= KMEM_CACHE(lttng_kernel_event_notifier_private
, 0);
4330 if (!event_notifier_private_cache
) {
4332 goto error_kmem_event_notifier_private
;
4334 ret
= lttng_abi_init();
4337 ret
= lttng_logger_init();
4340 ret
= lttng_init_cpu_hotplug();
4343 printk(KERN_NOTICE
"LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
4344 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4345 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4346 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4347 LTTNG_MODULES_EXTRAVERSION
,
4349 #ifdef LTTNG_EXTRA_VERSION_GIT
4350 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4354 #ifdef LTTNG_EXTRA_VERSION_NAME
4355 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4359 #ifdef CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM
4360 printk(KERN_NOTICE
"LTTng: Experimental bitwise enum enabled.\n");
4361 #endif /* CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM */
4365 lttng_logger_exit();
4369 kmem_cache_destroy(event_notifier_private_cache
);
4370 error_kmem_event_notifier_private
:
4371 kmem_cache_destroy(event_notifier_cache
);
4372 error_kmem_event_notifier
:
4373 kmem_cache_destroy(event_recorder_private_cache
);
4374 error_kmem_event_recorder_private
:
4375 kmem_cache_destroy(event_recorder_cache
);
4376 error_kmem_event_recorder
:
4377 lttng_tracepoint_exit();
4379 lttng_context_exit();
4380 printk(KERN_NOTICE
"LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4381 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4382 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4383 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4384 LTTNG_MODULES_EXTRAVERSION
,
4386 #ifdef LTTNG_EXTRA_VERSION_GIT
4387 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4391 #ifdef LTTNG_EXTRA_VERSION_NAME
4392 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4399 module_init(lttng_events_init
);
4401 static void __exit
lttng_events_exit(void)
4403 struct lttng_kernel_session_private
*session_priv
, *tmpsession_priv
;
4405 lttng_exit_cpu_hotplug();
4406 lttng_logger_exit();
4408 list_for_each_entry_safe(session_priv
, tmpsession_priv
, &sessions
, list
)
4409 lttng_session_destroy(session_priv
->pub
);
4410 kmem_cache_destroy(event_recorder_cache
);
4411 kmem_cache_destroy(event_recorder_private_cache
);
4412 kmem_cache_destroy(event_notifier_cache
);
4413 kmem_cache_destroy(event_notifier_private_cache
);
4414 lttng_tracepoint_exit();
4415 lttng_context_exit();
4416 printk(KERN_NOTICE
"LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4417 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4418 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4419 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4420 LTTNG_MODULES_EXTRAVERSION
,
4422 #ifdef LTTNG_EXTRA_VERSION_GIT
4423 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4427 #ifdef LTTNG_EXTRA_VERSION_NAME
4428 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4434 module_exit(lttng_events_exit
);
4436 #include <generated/patches.h>
4437 #ifdef LTTNG_EXTRA_VERSION_GIT
4438 MODULE_INFO(extra_version_git
, LTTNG_EXTRA_VERSION_GIT
);
4440 #ifdef LTTNG_EXTRA_VERSION_NAME
4441 MODULE_INFO(extra_version_name
, LTTNG_EXTRA_VERSION_NAME
);
4443 MODULE_LICENSE("GPL and additional rights");
4444 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4445 MODULE_DESCRIPTION("LTTng tracer");
4446 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
4447 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
4448 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
4449 LTTNG_MODULES_EXTRAVERSION
);