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_enabler_destroy(struct lttng_event_notifier_enabler
*event_notifier_enabler
);
70 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
);
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_recorder
*event
);
75 static int _lttng_event_notifier_unregister(struct lttng_kernel_event_notifier
*event_notifier
);
77 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
78 struct lttng_kernel_channel_buffer
*chan
,
79 struct lttng_kernel_event_recorder
*event
);
81 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
);
83 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
);
85 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
86 const struct lttng_kernel_type_common
*type
,
87 enum lttng_kernel_string_encoding parent_encoding
,
90 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
91 const struct lttng_kernel_event_field
*field
,
92 size_t nesting
, const char **prev_field_name_p
);
94 void synchronize_trace(void)
96 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,1,0) || \
97 LTTNG_RHEL_KERNEL_RANGE(4,18,0,193,0,0, 4,19,0,0,0,0))
103 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0))
104 #ifdef CONFIG_PREEMPT_RT_FULL
107 #else /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
108 #ifdef CONFIG_PREEMPT_RT
111 #endif /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
114 void lttng_lock_sessions(void)
116 mutex_lock(&sessions_mutex
);
119 void lttng_unlock_sessions(void)
121 mutex_unlock(&sessions_mutex
);
124 static struct lttng_transport
*lttng_transport_find(const char *name
)
126 struct lttng_transport
*transport
;
128 list_for_each_entry(transport
, <tng_transport_list
, node
) {
129 if (!strcmp(transport
->name
, name
))
136 * Called with sessions lock held.
138 int lttng_session_active(void)
140 struct lttng_kernel_session_private
*iter
;
142 list_for_each_entry(iter
, &sessions
, list
) {
143 if (iter
->pub
->active
)
149 struct lttng_kernel_session
*lttng_session_create(void)
151 struct lttng_kernel_session
*session
;
152 struct lttng_kernel_session_private
*session_priv
;
153 struct lttng_metadata_cache
*metadata_cache
;
156 mutex_lock(&sessions_mutex
);
157 session
= lttng_kvzalloc(sizeof(*session
), GFP_KERNEL
);
160 session_priv
= lttng_kvzalloc(sizeof(*session_priv
), GFP_KERNEL
);
162 goto err_free_session
;
163 session
->priv
= session_priv
;
164 session_priv
->pub
= session
;
166 INIT_LIST_HEAD(&session_priv
->chan
);
167 INIT_LIST_HEAD(&session_priv
->events
);
168 lttng_guid_gen(&session_priv
->uuid
);
170 metadata_cache
= kzalloc(sizeof(struct lttng_metadata_cache
),
173 goto err_free_session_private
;
174 metadata_cache
->data
= vzalloc(METADATA_CACHE_DEFAULT_SIZE
);
175 if (!metadata_cache
->data
)
177 metadata_cache
->cache_alloc
= METADATA_CACHE_DEFAULT_SIZE
;
178 kref_init(&metadata_cache
->refcount
);
179 mutex_init(&metadata_cache
->lock
);
180 session_priv
->metadata_cache
= metadata_cache
;
181 INIT_LIST_HEAD(&metadata_cache
->metadata_stream
);
182 memcpy(&metadata_cache
->uuid
, &session_priv
->uuid
,
183 sizeof(metadata_cache
->uuid
));
184 INIT_LIST_HEAD(&session_priv
->enablers_head
);
185 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
186 INIT_HLIST_HEAD(&session_priv
->events_ht
.table
[i
]);
187 list_add(&session_priv
->list
, &sessions
);
189 if (lttng_id_tracker_init(&session
->pid_tracker
, session
, TRACKER_PID
))
190 goto tracker_alloc_error
;
191 if (lttng_id_tracker_init(&session
->vpid_tracker
, session
, TRACKER_VPID
))
192 goto tracker_alloc_error
;
193 if (lttng_id_tracker_init(&session
->uid_tracker
, session
, TRACKER_UID
))
194 goto tracker_alloc_error
;
195 if (lttng_id_tracker_init(&session
->vuid_tracker
, session
, TRACKER_VUID
))
196 goto tracker_alloc_error
;
197 if (lttng_id_tracker_init(&session
->gid_tracker
, session
, TRACKER_GID
))
198 goto tracker_alloc_error
;
199 if (lttng_id_tracker_init(&session
->vgid_tracker
, session
, TRACKER_VGID
))
200 goto tracker_alloc_error
;
202 mutex_unlock(&sessions_mutex
);
207 lttng_id_tracker_fini(&session
->pid_tracker
);
208 lttng_id_tracker_fini(&session
->vpid_tracker
);
209 lttng_id_tracker_fini(&session
->uid_tracker
);
210 lttng_id_tracker_fini(&session
->vuid_tracker
);
211 lttng_id_tracker_fini(&session
->gid_tracker
);
212 lttng_id_tracker_fini(&session
->vgid_tracker
);
214 kfree(metadata_cache
);
215 err_free_session_private
:
216 lttng_kvfree(session_priv
);
218 lttng_kvfree(session
);
220 mutex_unlock(&sessions_mutex
);
225 struct lttng_counter_transport
*lttng_counter_transport_find(const char *name
)
227 struct lttng_counter_transport
*transport
;
229 list_for_each_entry(transport
, <tng_counter_transport_list
, node
) {
230 if (!strcmp(transport
->name
, name
))
236 struct lttng_counter
*lttng_kernel_counter_create(
237 const char *counter_transport_name
,
238 size_t number_dimensions
, const size_t *dimensions_sizes
)
240 struct lttng_counter
*counter
= NULL
;
241 struct lttng_counter_transport
*counter_transport
= NULL
;
243 counter_transport
= lttng_counter_transport_find(counter_transport_name
);
244 if (!counter_transport
) {
245 printk(KERN_WARNING
"LTTng: counter transport %s not found.\n",
246 counter_transport_name
);
249 if (!try_module_get(counter_transport
->owner
)) {
250 printk(KERN_WARNING
"LTTng: Can't lock counter transport module.\n");
254 counter
= lttng_kvzalloc(sizeof(struct lttng_counter
), GFP_KERNEL
);
258 /* Create event notifier error counter. */
259 counter
->ops
= &counter_transport
->ops
;
260 counter
->transport
= counter_transport
;
262 counter
->counter
= counter
->ops
->counter_create(
263 number_dimensions
, dimensions_sizes
, 0);
264 if (!counter
->counter
) {
271 lttng_kvfree(counter
);
273 if (counter_transport
)
274 module_put(counter_transport
->owner
);
279 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
281 struct lttng_transport
*transport
= NULL
;
282 struct lttng_event_notifier_group
*event_notifier_group
;
283 const char *transport_name
= "relay-event-notifier";
284 size_t subbuf_size
= 4096; //TODO
285 size_t num_subbuf
= 16; //TODO
286 unsigned int switch_timer_interval
= 0;
287 unsigned int read_timer_interval
= 0;
290 mutex_lock(&sessions_mutex
);
292 transport
= lttng_transport_find(transport_name
);
294 printk(KERN_WARNING
"LTTng: transport %s not found\n",
298 if (!try_module_get(transport
->owner
)) {
299 printk(KERN_WARNING
"LTTng: Can't lock transport %s module.\n",
304 event_notifier_group
= lttng_kvzalloc(sizeof(struct lttng_event_notifier_group
),
306 if (!event_notifier_group
)
310 * Initialize the ring buffer used to store event notifier
313 event_notifier_group
->ops
= &transport
->ops
;
314 event_notifier_group
->chan
= transport
->ops
.priv
->channel_create(
315 transport_name
, event_notifier_group
, NULL
,
316 subbuf_size
, num_subbuf
, switch_timer_interval
,
317 read_timer_interval
);
318 if (!event_notifier_group
->chan
)
321 event_notifier_group
->transport
= transport
;
323 INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
324 INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
325 for (i
= 0; i
< LTTNG_EVENT_NOTIFIER_HT_SIZE
; i
++)
326 INIT_HLIST_HEAD(&event_notifier_group
->event_notifiers_ht
.table
[i
]);
328 list_add(&event_notifier_group
->node
, &event_notifier_groups
);
330 mutex_unlock(&sessions_mutex
);
332 return event_notifier_group
;
335 lttng_kvfree(event_notifier_group
);
338 module_put(transport
->owner
);
340 mutex_unlock(&sessions_mutex
);
344 void metadata_cache_destroy(struct kref
*kref
)
346 struct lttng_metadata_cache
*cache
=
347 container_of(kref
, struct lttng_metadata_cache
, refcount
);
352 void lttng_session_destroy(struct lttng_kernel_session
*session
)
354 struct lttng_kernel_channel_buffer_private
*chan_priv
, *tmpchan_priv
;
355 struct lttng_kernel_event_recorder_private
*event_recorder_priv
, *tmpevent_recorder_priv
;
356 struct lttng_metadata_stream
*metadata_stream
;
357 struct lttng_event_enabler
*event_enabler
, *tmp_event_enabler
;
360 mutex_lock(&sessions_mutex
);
361 WRITE_ONCE(session
->active
, 0);
362 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
363 ret
= lttng_syscalls_unregister_channel(chan_priv
->pub
);
366 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
367 ret
= _lttng_event_unregister(event_recorder_priv
->pub
);
370 synchronize_trace(); /* Wait for in-flight events to complete */
371 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
372 ret
= lttng_syscalls_destroy_event(chan_priv
->pub
);
375 list_for_each_entry_safe(event_enabler
, tmp_event_enabler
,
376 &session
->priv
->enablers_head
, node
)
377 lttng_event_enabler_destroy(event_enabler
);
378 list_for_each_entry_safe(event_recorder_priv
, tmpevent_recorder_priv
, &session
->priv
->events
, node
)
379 _lttng_event_destroy(&event_recorder_priv
->pub
->parent
);
380 list_for_each_entry_safe(chan_priv
, tmpchan_priv
, &session
->priv
->chan
, node
) {
381 BUG_ON(chan_priv
->channel_type
== METADATA_CHANNEL
);
382 _lttng_channel_destroy(chan_priv
->pub
);
384 mutex_lock(&session
->priv
->metadata_cache
->lock
);
385 list_for_each_entry(metadata_stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
386 _lttng_metadata_channel_hangup(metadata_stream
);
387 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
388 lttng_id_tracker_fini(&session
->pid_tracker
);
389 lttng_id_tracker_fini(&session
->vpid_tracker
);
390 lttng_id_tracker_fini(&session
->uid_tracker
);
391 lttng_id_tracker_fini(&session
->vuid_tracker
);
392 lttng_id_tracker_fini(&session
->gid_tracker
);
393 lttng_id_tracker_fini(&session
->vgid_tracker
);
394 kref_put(&session
->priv
->metadata_cache
->refcount
, metadata_cache_destroy
);
395 list_del(&session
->priv
->list
);
396 mutex_unlock(&sessions_mutex
);
397 lttng_kvfree(session
->priv
);
398 lttng_kvfree(session
);
401 void lttng_event_notifier_group_destroy(
402 struct lttng_event_notifier_group
*event_notifier_group
)
404 struct lttng_event_notifier_enabler
*event_notifier_enabler
, *tmp_event_notifier_enabler
;
405 struct lttng_kernel_event_notifier_private
*event_notifier_priv
, *tmpevent_notifier_priv
;
408 if (!event_notifier_group
)
411 mutex_lock(&sessions_mutex
);
413 ret
= lttng_syscalls_unregister_event_notifier_group(event_notifier_group
);
416 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
417 &event_notifier_group
->event_notifiers_head
, node
) {
418 ret
= _lttng_event_notifier_unregister(event_notifier_priv
->pub
);
422 /* Wait for in-flight event notifier to complete */
425 irq_work_sync(&event_notifier_group
->wakeup_pending
);
427 kfree(event_notifier_group
->syscall_table
.sc_filter
);
429 list_for_each_entry_safe(event_notifier_enabler
, tmp_event_notifier_enabler
,
430 &event_notifier_group
->enablers_head
, node
)
431 lttng_event_notifier_enabler_destroy(event_notifier_enabler
);
433 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
434 &event_notifier_group
->event_notifiers_head
, 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
, node
) {
571 event_recorder_priv
->metadata_dumped
= 0;
574 ret
= _lttng_session_metadata_statedump(session
);
577 mutex_unlock(&sessions_mutex
);
581 int lttng_channel_enable(struct lttng_kernel_channel_buffer
*channel
)
585 mutex_lock(&sessions_mutex
);
586 if (channel
->priv
->channel_type
== METADATA_CHANNEL
) {
590 if (channel
->parent
.enabled
) {
594 /* Set transient enabler state to "enabled" */
595 channel
->priv
->parent
.tstate
= 1;
596 lttng_session_sync_event_enablers(channel
->parent
.session
);
597 /* Set atomically the state to "enabled" */
598 WRITE_ONCE(channel
->parent
.enabled
, 1);
600 mutex_unlock(&sessions_mutex
);
604 int lttng_channel_disable(struct lttng_kernel_channel_buffer
*channel
)
608 mutex_lock(&sessions_mutex
);
609 if (channel
->priv
->channel_type
== METADATA_CHANNEL
) {
613 if (!channel
->parent
.enabled
) {
617 /* Set atomically the state to "disabled" */
618 WRITE_ONCE(channel
->parent
.enabled
, 0);
619 /* Set transient enabler state to "enabled" */
620 channel
->priv
->parent
.tstate
= 0;
621 lttng_session_sync_event_enablers(channel
->parent
.session
);
623 mutex_unlock(&sessions_mutex
);
627 int lttng_event_enable(struct lttng_kernel_event_common
*event
)
631 mutex_lock(&sessions_mutex
);
632 switch (event
->type
) {
633 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
635 struct lttng_kernel_event_recorder
*event_recorder
=
636 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
638 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
644 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
645 switch (event
->priv
->instrumentation
) {
646 case LTTNG_KERNEL_ABI_KRETPROBE
:
657 if (event
->enabled
) {
661 switch (event
->priv
->instrumentation
) {
662 case LTTNG_KERNEL_ABI_TRACEPOINT
:
664 case LTTNG_KERNEL_ABI_SYSCALL
:
668 case LTTNG_KERNEL_ABI_KPROBE
:
670 case LTTNG_KERNEL_ABI_UPROBE
:
671 WRITE_ONCE(event
->enabled
, 1);
674 case LTTNG_KERNEL_ABI_KRETPROBE
:
675 ret
= lttng_kretprobes_event_enable_state(event
, 1);
678 case LTTNG_KERNEL_ABI_FUNCTION
:
680 case LTTNG_KERNEL_ABI_NOOP
:
687 mutex_unlock(&sessions_mutex
);
691 int lttng_event_disable(struct lttng_kernel_event_common
*event
)
695 mutex_lock(&sessions_mutex
);
696 switch (event
->type
) {
697 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
699 struct lttng_kernel_event_recorder
*event_recorder
=
700 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
702 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
708 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
709 switch (event
->priv
->instrumentation
) {
710 case LTTNG_KERNEL_ABI_KRETPROBE
:
721 if (!event
->enabled
) {
725 switch (event
->priv
->instrumentation
) {
726 case LTTNG_KERNEL_ABI_TRACEPOINT
:
728 case LTTNG_KERNEL_ABI_SYSCALL
:
732 case LTTNG_KERNEL_ABI_KPROBE
:
734 case LTTNG_KERNEL_ABI_UPROBE
:
735 WRITE_ONCE(event
->enabled
, 0);
738 case LTTNG_KERNEL_ABI_KRETPROBE
:
739 ret
= lttng_kretprobes_event_enable_state(event
, 0);
742 case LTTNG_KERNEL_ABI_FUNCTION
:
744 case LTTNG_KERNEL_ABI_NOOP
:
751 mutex_unlock(&sessions_mutex
);
755 struct lttng_kernel_channel_buffer
*lttng_channel_create(struct lttng_kernel_session
*session
,
756 const char *transport_name
,
758 size_t subbuf_size
, size_t num_subbuf
,
759 unsigned int switch_timer_interval
,
760 unsigned int read_timer_interval
,
761 enum channel_type channel_type
)
763 struct lttng_kernel_channel_buffer
*chan
;
764 struct lttng_kernel_channel_buffer_private
*chan_priv
;
765 struct lttng_transport
*transport
= NULL
;
767 mutex_lock(&sessions_mutex
);
768 if (session
->priv
->been_active
&& channel_type
!= METADATA_CHANNEL
)
769 goto active
; /* Refuse to add channel to active session */
770 transport
= lttng_transport_find(transport_name
);
772 printk(KERN_WARNING
"LTTng: transport %s not found\n",
776 if (!try_module_get(transport
->owner
)) {
777 printk(KERN_WARNING
"LTTng: Can't lock transport module.\n");
780 chan
= kzalloc(sizeof(struct lttng_kernel_channel_buffer
), GFP_KERNEL
);
783 chan_priv
= kzalloc(sizeof(struct lttng_kernel_channel_buffer_private
), GFP_KERNEL
);
786 chan
->priv
= chan_priv
;
787 chan_priv
->pub
= chan
;
788 chan
->parent
.type
= LTTNG_KERNEL_CHANNEL_TYPE_BUFFER
;
789 chan
->parent
.session
= session
;
790 chan
->priv
->id
= session
->priv
->free_chan_id
++;
791 chan
->ops
= &transport
->ops
;
793 * Note: the channel creation op already writes into the packet
794 * headers. Therefore the "chan" information used as input
795 * should be already accessible.
797 chan
->priv
->rb_chan
= transport
->ops
.priv
->channel_create(transport_name
,
798 chan
, buf_addr
, subbuf_size
, num_subbuf
,
799 switch_timer_interval
, read_timer_interval
);
800 if (!chan
->priv
->rb_chan
)
802 chan
->priv
->parent
.tstate
= 1;
803 chan
->parent
.enabled
= 1;
804 chan
->priv
->transport
= transport
;
805 chan
->priv
->channel_type
= channel_type
;
806 list_add(&chan
->priv
->node
, &session
->priv
->chan
);
807 mutex_unlock(&sessions_mutex
);
816 module_put(transport
->owner
);
819 mutex_unlock(&sessions_mutex
);
824 * Only used internally at session destruction for per-cpu channels, and
825 * when metadata channel is released.
826 * Needs to be called with sessions mutex held.
829 void _lttng_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
831 chan
->ops
->priv
->channel_destroy(chan
->priv
->rb_chan
);
832 module_put(chan
->priv
->transport
->owner
);
833 list_del(&chan
->priv
->node
);
834 lttng_kernel_destroy_context(chan
->priv
->ctx
);
839 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
841 BUG_ON(chan
->priv
->channel_type
!= METADATA_CHANNEL
);
843 /* Protect the metadata cache with the sessions_mutex. */
844 mutex_lock(&sessions_mutex
);
845 _lttng_channel_destroy(chan
);
846 mutex_unlock(&sessions_mutex
);
848 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy
);
851 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
)
853 stream
->finalized
= 1;
854 wake_up_interruptible(&stream
->read_wait
);
859 * Supports event creation while tracing session is active.
860 * Needs to be called with sessions mutex held.
862 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_event_enabler
*event_enabler
,
863 const struct lttng_kernel_event_desc
*event_desc
)
865 struct lttng_kernel_channel_buffer
*chan
= event_enabler
->chan
;
866 struct lttng_kernel_abi_event
*event_param
= &event_enabler
->parent
.event_param
;
867 enum lttng_kernel_abi_instrumentation itype
= event_param
->instrumentation
;
868 struct lttng_kernel_session
*session
= chan
->parent
.session
;
869 struct lttng_kernel_event_recorder
*event_recorder
;
870 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
871 const char *event_name
;
872 struct hlist_head
*head
;
875 if (chan
->priv
->free_event_id
== -1U) {
881 case LTTNG_KERNEL_ABI_TRACEPOINT
:
882 event_name
= event_desc
->event_name
;
885 case LTTNG_KERNEL_ABI_KPROBE
:
887 case LTTNG_KERNEL_ABI_UPROBE
:
889 case LTTNG_KERNEL_ABI_KRETPROBE
:
891 case LTTNG_KERNEL_ABI_SYSCALL
:
892 event_name
= event_param
->name
;
895 case LTTNG_KERNEL_ABI_FUNCTION
:
897 case LTTNG_KERNEL_ABI_NOOP
:
905 head
= utils_borrow_hash_table_bucket(session
->priv
->events_ht
.table
,
906 LTTNG_EVENT_HT_SIZE
, event_name
);
907 lttng_hlist_for_each_entry(event_recorder_priv
, head
, hlist
) {
908 WARN_ON_ONCE(!event_recorder_priv
->parent
.desc
);
909 if (!strncmp(event_recorder_priv
->parent
.desc
->event_name
, event_name
,
910 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
911 && chan
== event_recorder_priv
->pub
->chan
) {
917 event_recorder
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
918 if (!event_recorder
) {
922 event_recorder_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
923 if (!event_recorder_priv
) {
925 goto cache_private_error
;
927 event_recorder_priv
->pub
= event_recorder
;
928 event_recorder_priv
->parent
.pub
= &event_recorder
->parent
;
929 event_recorder
->priv
= event_recorder_priv
;
930 event_recorder
->parent
.priv
= &event_recorder_priv
->parent
;
931 event_recorder
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
933 event_recorder
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
934 event_recorder
->chan
= chan
;
935 event_recorder
->priv
->id
= chan
->priv
->free_event_id
++;
936 event_recorder
->priv
->parent
.instrumentation
= itype
;
937 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.filter_bytecode_runtime_head
);
938 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.enablers_ref_head
);
941 case LTTNG_KERNEL_ABI_TRACEPOINT
:
942 /* Event will be enabled by enabler sync. */
943 event_recorder
->parent
.enabled
= 0;
944 event_recorder
->priv
->parent
.registered
= 0;
945 event_recorder
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
946 if (!event_recorder
->priv
->parent
.desc
) {
950 /* Populate lttng_event structure before event registration. */
954 case LTTNG_KERNEL_ABI_KPROBE
:
956 * Needs to be explicitly enabled after creation, since
957 * we may want to apply filters.
959 event_recorder
->parent
.enabled
= 0;
960 event_recorder
->priv
->parent
.registered
= 1;
962 * Populate lttng_event structure before event
966 ret
= lttng_kprobes_register_event(event_name
,
967 event_param
->u
.kprobe
.symbol_name
,
968 event_param
->u
.kprobe
.offset
,
969 event_param
->u
.kprobe
.addr
,
975 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
979 case LTTNG_KERNEL_ABI_KRETPROBE
:
981 struct lttng_kernel_event_recorder
*event_recorder_return
;
982 struct lttng_kernel_event_recorder_private
*event_recorder_return_priv
;
984 /* kretprobe defines 2 events */
986 * Needs to be explicitly enabled after creation, since
987 * we may want to apply filters.
989 event_recorder
->parent
.enabled
= 0;
990 event_recorder
->priv
->parent
.registered
= 1;
992 event_recorder_return
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
993 if (!event_recorder_return
) {
997 event_recorder_return_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
998 if (!event_recorder_return_priv
) {
999 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1001 goto register_error
;
1003 event_recorder_return_priv
->pub
= event_recorder_return
;
1004 event_recorder_return_priv
->parent
.pub
= &event_recorder_return
->parent
;
1005 event_recorder_return
->priv
= event_recorder_return_priv
;
1006 event_recorder_return
->parent
.priv
= &event_recorder_return_priv
->parent
;
1007 event_recorder_return
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
1009 event_recorder_return
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1010 event_recorder_return
->chan
= chan
;
1011 event_recorder_return
->priv
->id
= chan
->priv
->free_event_id
++;
1012 event_recorder_return
->priv
->parent
.instrumentation
= itype
;
1013 event_recorder_return
->parent
.enabled
= 0;
1014 event_recorder_return
->priv
->parent
.registered
= 1;
1015 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.filter_bytecode_runtime_head
);
1016 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.enablers_ref_head
);
1018 * Populate lttng_event structure before kretprobe registration.
1021 ret
= lttng_kretprobes_register(event_name
,
1022 event_param
->u
.kretprobe
.symbol_name
,
1023 event_param
->u
.kretprobe
.offset
,
1024 event_param
->u
.kretprobe
.addr
,
1025 event_recorder
, event_recorder_return
);
1027 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1028 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1030 goto register_error
;
1032 /* Take 2 refs on the module: one per event. */
1033 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1035 ret
= try_module_get(event_recorder_return
->priv
->parent
.desc
->owner
);
1037 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
,
1038 event_recorder_return
);
1039 WARN_ON_ONCE(ret
> 0);
1041 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1042 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1043 module_put(event_recorder_return
->priv
->parent
.desc
->owner
);
1044 module_put(event_recorder
->priv
->parent
.desc
->owner
);
1045 goto statedump_error
;
1047 list_add(&event_recorder_return
->priv
->node
, &chan
->parent
.session
->priv
->events
);
1051 case LTTNG_KERNEL_ABI_SYSCALL
:
1053 * Needs to be explicitly enabled after creation, since
1054 * we may want to apply filters.
1056 event_recorder
->parent
.enabled
= 0;
1057 event_recorder
->priv
->parent
.registered
= 0;
1058 event_recorder
->priv
->parent
.desc
= event_desc
;
1059 switch (event_param
->u
.syscall
.entryexit
) {
1060 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1062 goto register_error
;
1063 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1064 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1066 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1067 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1070 switch (event_param
->u
.syscall
.abi
) {
1071 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1073 goto register_error
;
1074 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1075 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1077 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1078 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1081 if (!event_recorder
->priv
->parent
.desc
) {
1083 goto register_error
;
1087 case LTTNG_KERNEL_ABI_UPROBE
:
1089 * Needs to be explicitly enabled after creation, since
1090 * we may want to apply filters.
1092 event_recorder
->parent
.enabled
= 0;
1093 event_recorder
->priv
->parent
.registered
= 1;
1096 * Populate lttng_event structure before event
1101 ret
= lttng_uprobes_register_event(event_param
->name
,
1102 event_param
->u
.uprobe
.fd
,
1105 goto register_error
;
1106 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1110 case LTTNG_KERNEL_ABI_FUNCTION
:
1112 case LTTNG_KERNEL_ABI_NOOP
:
1117 goto register_error
;
1119 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
, event_recorder
);
1120 WARN_ON_ONCE(ret
> 0);
1122 goto statedump_error
;
1124 hlist_add_head(&event_recorder
->priv
->hlist
, head
);
1125 list_add(&event_recorder
->priv
->node
, &chan
->parent
.session
->priv
->events
);
1126 return event_recorder
;
1129 /* If a statedump error occurs, events will not be readable. */
1131 kmem_cache_free(event_recorder_private_cache
, event_recorder_priv
);
1132 cache_private_error
:
1133 kmem_cache_free(event_recorder_cache
, event_recorder
);
1138 return ERR_PTR(ret
);
1141 struct lttng_kernel_event_notifier
*_lttng_event_notifier_create(
1142 const struct lttng_kernel_event_desc
*event_desc
,
1143 uint64_t token
, uint64_t error_counter_index
,
1144 struct lttng_event_notifier_group
*event_notifier_group
,
1145 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1146 enum lttng_kernel_abi_instrumentation itype
)
1148 struct lttng_kernel_event_notifier
*event_notifier
;
1149 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
1150 struct lttng_counter
*error_counter
;
1151 const char *event_name
;
1152 struct hlist_head
*head
;
1156 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1157 event_name
= event_desc
->event_name
;
1160 case LTTNG_KERNEL_ABI_KPROBE
:
1162 case LTTNG_KERNEL_ABI_UPROBE
:
1164 case LTTNG_KERNEL_ABI_SYSCALL
:
1165 event_name
= event_notifier_param
->event
.name
;
1168 case LTTNG_KERNEL_ABI_KRETPROBE
:
1170 case LTTNG_KERNEL_ABI_FUNCTION
:
1172 case LTTNG_KERNEL_ABI_NOOP
:
1180 head
= utils_borrow_hash_table_bucket(event_notifier_group
->event_notifiers_ht
.table
,
1181 LTTNG_EVENT_NOTIFIER_HT_SIZE
, event_name
);
1182 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
1183 WARN_ON_ONCE(!event_notifier_priv
->parent
.desc
);
1184 if (!strncmp(event_notifier_priv
->parent
.desc
->event_name
, event_name
,
1185 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
1186 && event_notifier_group
== event_notifier_priv
->group
1187 && token
== event_notifier_priv
->parent
.user_token
) {
1193 event_notifier
= kmem_cache_zalloc(event_notifier_cache
, GFP_KERNEL
);
1194 if (!event_notifier
) {
1198 event_notifier_priv
= kmem_cache_zalloc(event_notifier_private_cache
, GFP_KERNEL
);
1199 if (!event_notifier_priv
) {
1201 goto cache_private_error
;
1203 event_notifier_priv
->pub
= event_notifier
;
1204 event_notifier_priv
->parent
.pub
= &event_notifier
->parent
;
1205 event_notifier
->priv
= event_notifier_priv
;
1206 event_notifier
->parent
.priv
= &event_notifier_priv
->parent
;
1207 event_notifier
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
;
1209 event_notifier
->priv
->group
= event_notifier_group
;
1210 event_notifier
->priv
->parent
.user_token
= token
;
1211 event_notifier
->priv
->error_counter_index
= error_counter_index
;
1212 event_notifier
->priv
->num_captures
= 0;
1213 event_notifier
->priv
->parent
.instrumentation
= itype
;
1214 event_notifier
->notification_send
= lttng_event_notifier_notification_send
;
1215 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.filter_bytecode_runtime_head
);
1216 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.enablers_ref_head
);
1217 INIT_LIST_HEAD(&event_notifier
->priv
->capture_bytecode_runtime_head
);
1218 event_notifier
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1221 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1222 /* Event will be enabled by enabler sync. */
1223 event_notifier
->parent
.enabled
= 0;
1224 event_notifier
->priv
->parent
.registered
= 0;
1225 event_notifier
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
1226 if (!event_notifier
->priv
->parent
.desc
) {
1228 goto register_error
;
1230 /* Populate lttng_event_notifier structure before event registration. */
1234 case LTTNG_KERNEL_ABI_KPROBE
:
1236 * Needs to be explicitly enabled after creation, since
1237 * we may want to apply filters.
1239 event_notifier
->parent
.enabled
= 0;
1240 event_notifier
->priv
->parent
.registered
= 1;
1242 * Populate lttng_event_notifier structure before event
1246 ret
= lttng_kprobes_register_event_notifier(
1247 event_notifier_param
->event
.u
.kprobe
.symbol_name
,
1248 event_notifier_param
->event
.u
.kprobe
.offset
,
1249 event_notifier_param
->event
.u
.kprobe
.addr
,
1253 goto register_error
;
1255 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1259 case LTTNG_KERNEL_ABI_SYSCALL
:
1261 * Needs to be explicitly enabled after creation, since
1262 * we may want to apply filters.
1264 event_notifier
->parent
.enabled
= 0;
1265 event_notifier
->priv
->parent
.registered
= 0;
1266 event_notifier
->priv
->parent
.desc
= event_desc
;
1267 switch (event_notifier_param
->event
.u
.syscall
.entryexit
) {
1268 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1270 goto register_error
;
1271 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1272 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1274 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1275 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1278 switch (event_notifier_param
->event
.u
.syscall
.abi
) {
1279 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1281 goto register_error
;
1282 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1283 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1285 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1286 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1290 if (!event_notifier
->priv
->parent
.desc
) {
1292 goto register_error
;
1296 case LTTNG_KERNEL_ABI_UPROBE
:
1298 * Needs to be explicitly enabled after creation, since
1299 * we may want to apply filters.
1301 event_notifier
->parent
.enabled
= 0;
1302 event_notifier
->priv
->parent
.registered
= 1;
1305 * Populate lttng_event_notifier structure before
1306 * event_notifier registration.
1310 ret
= lttng_uprobes_register_event_notifier(
1311 event_notifier_param
->event
.name
,
1312 event_notifier_param
->event
.u
.uprobe
.fd
,
1315 goto register_error
;
1316 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1320 case LTTNG_KERNEL_ABI_KRETPROBE
:
1322 case LTTNG_KERNEL_ABI_FUNCTION
:
1324 case LTTNG_KERNEL_ABI_NOOP
:
1329 goto register_error
;
1332 list_add(&event_notifier
->priv
->node
, &event_notifier_group
->event_notifiers_head
);
1333 hlist_add_head(&event_notifier
->priv
->hlist
, head
);
1336 * Clear the error counter bucket. The sessiond keeps track of which
1337 * bucket is currently in use. We trust it. The session lock
1338 * synchronizes against concurrent creation of the error
1341 error_counter
= event_notifier_group
->error_counter
;
1342 if (error_counter
) {
1343 size_t dimension_index
[1];
1346 * Check that the index is within the boundary of the counter.
1348 if (event_notifier
->priv
->error_counter_index
>= event_notifier_group
->error_counter_len
) {
1349 printk(KERN_INFO
"LTTng: event_notifier: Error counter index out-of-bound: counter-len=%zu, index=%llu\n",
1350 event_notifier_group
->error_counter_len
, event_notifier
->priv
->error_counter_index
);
1352 goto register_error
;
1355 dimension_index
[0] = event_notifier
->priv
->error_counter_index
;
1356 ret
= error_counter
->ops
->counter_clear(error_counter
->counter
, dimension_index
);
1358 printk(KERN_INFO
"LTTng: event_notifier: Unable to clear error counter bucket %llu\n",
1359 event_notifier
->priv
->error_counter_index
);
1360 goto register_error
;
1364 return event_notifier
;
1367 kmem_cache_free(event_notifier_private_cache
, event_notifier_priv
);
1368 cache_private_error
:
1369 kmem_cache_free(event_notifier_cache
, event_notifier
);
1373 return ERR_PTR(ret
);
1376 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1377 const size_t *dim_indexes
, int32_t cpu
,
1378 int64_t *val
, bool *overflow
, bool *underflow
)
1380 return counter
->ops
->counter_read(counter
->counter
, dim_indexes
,
1381 cpu
, val
, overflow
, underflow
);
1384 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1385 const size_t *dim_indexes
, int64_t *val
,
1386 bool *overflow
, bool *underflow
)
1388 return counter
->ops
->counter_aggregate(counter
->counter
, dim_indexes
,
1389 val
, overflow
, underflow
);
1392 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1393 const size_t *dim_indexes
)
1395 return counter
->ops
->counter_clear(counter
->counter
, dim_indexes
);
1398 struct lttng_kernel_event_recorder
*lttng_kernel_event_recorder_create(struct lttng_event_enabler
*event_enabler
,
1399 const struct lttng_kernel_event_desc
*event_desc
)
1401 struct lttng_kernel_event_recorder
*event
;
1403 mutex_lock(&sessions_mutex
);
1404 event
= _lttng_kernel_event_recorder_create(event_enabler
, event_desc
);
1405 mutex_unlock(&sessions_mutex
);
1409 struct lttng_kernel_event_notifier
*lttng_event_notifier_create(
1410 const struct lttng_kernel_event_desc
*event_desc
,
1411 uint64_t id
, uint64_t error_counter_index
,
1412 struct lttng_event_notifier_group
*event_notifier_group
,
1413 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1414 enum lttng_kernel_abi_instrumentation itype
)
1416 struct lttng_kernel_event_notifier
*event_notifier
;
1418 mutex_lock(&sessions_mutex
);
1419 event_notifier
= _lttng_event_notifier_create(event_desc
, id
,
1420 error_counter_index
, event_notifier_group
,
1421 event_notifier_param
, itype
);
1422 mutex_unlock(&sessions_mutex
);
1423 return event_notifier
;
1426 /* Only used for tracepoints for now. */
1428 void register_event(struct lttng_kernel_event_recorder
*event_recorder
)
1430 const struct lttng_kernel_event_desc
*desc
;
1433 if (event_recorder
->priv
->parent
.registered
)
1436 desc
= event_recorder
->priv
->parent
.desc
;
1437 switch (event_recorder
->priv
->parent
.instrumentation
) {
1438 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1439 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1440 desc
->tp_class
->probe_callback
,
1444 case LTTNG_KERNEL_ABI_SYSCALL
:
1445 ret
= lttng_syscall_filter_enable_event(event_recorder
->chan
, event_recorder
);
1448 case LTTNG_KERNEL_ABI_KPROBE
:
1450 case LTTNG_KERNEL_ABI_UPROBE
:
1452 case LTTNG_KERNEL_ABI_KRETPROBE
:
1456 case LTTNG_KERNEL_ABI_FUNCTION
:
1458 case LTTNG_KERNEL_ABI_NOOP
:
1464 event_recorder
->priv
->parent
.registered
= 1;
1468 * Only used internally at session destruction.
1470 int _lttng_event_unregister(struct lttng_kernel_event_recorder
*event_recorder
)
1472 struct lttng_kernel_event_common_private
*event_priv
= &event_recorder
->priv
->parent
;
1473 const struct lttng_kernel_event_desc
*desc
;
1476 if (!event_priv
->registered
)
1479 desc
= event_priv
->desc
;
1480 switch (event_priv
->instrumentation
) {
1481 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1482 ret
= lttng_wrapper_tracepoint_probe_unregister(event_priv
->desc
->event_kname
,
1483 event_priv
->desc
->tp_class
->probe_callback
,
1487 case LTTNG_KERNEL_ABI_KPROBE
:
1488 lttng_kprobes_unregister_event(event_recorder
);
1492 case LTTNG_KERNEL_ABI_KRETPROBE
:
1493 lttng_kretprobes_unregister(event_recorder
);
1497 case LTTNG_KERNEL_ABI_SYSCALL
:
1498 ret
= lttng_syscall_filter_disable_event(event_recorder
->chan
, event_recorder
);
1501 case LTTNG_KERNEL_ABI_NOOP
:
1505 case LTTNG_KERNEL_ABI_UPROBE
:
1506 lttng_uprobes_unregister_event(event_recorder
);
1510 case LTTNG_KERNEL_ABI_FUNCTION
:
1516 event_priv
->registered
= 0;
1520 /* Only used for tracepoints for now. */
1522 void register_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1524 const struct lttng_kernel_event_desc
*desc
;
1527 if (event_notifier
->priv
->parent
.registered
)
1530 desc
= event_notifier
->priv
->parent
.desc
;
1531 switch (event_notifier
->priv
->parent
.instrumentation
) {
1532 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1533 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1534 desc
->tp_class
->probe_callback
,
1538 case LTTNG_KERNEL_ABI_SYSCALL
:
1539 ret
= lttng_syscall_filter_enable_event_notifier(event_notifier
);
1542 case LTTNG_KERNEL_ABI_KPROBE
:
1544 case LTTNG_KERNEL_ABI_UPROBE
:
1548 case LTTNG_KERNEL_ABI_KRETPROBE
:
1550 case LTTNG_KERNEL_ABI_FUNCTION
:
1552 case LTTNG_KERNEL_ABI_NOOP
:
1558 event_notifier
->priv
->parent
.registered
= 1;
1562 int _lttng_event_notifier_unregister(
1563 struct lttng_kernel_event_notifier
*event_notifier
)
1565 const struct lttng_kernel_event_desc
*desc
;
1568 if (!event_notifier
->priv
->parent
.registered
)
1571 desc
= event_notifier
->priv
->parent
.desc
;
1572 switch (event_notifier
->priv
->parent
.instrumentation
) {
1573 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1574 ret
= lttng_wrapper_tracepoint_probe_unregister(event_notifier
->priv
->parent
.desc
->event_kname
,
1575 event_notifier
->priv
->parent
.desc
->tp_class
->probe_callback
,
1579 case LTTNG_KERNEL_ABI_KPROBE
:
1580 lttng_kprobes_unregister_event_notifier(event_notifier
);
1584 case LTTNG_KERNEL_ABI_UPROBE
:
1585 lttng_uprobes_unregister_event_notifier(event_notifier
);
1589 case LTTNG_KERNEL_ABI_SYSCALL
:
1590 ret
= lttng_syscall_filter_disable_event_notifier(event_notifier
);
1593 case LTTNG_KERNEL_ABI_KRETPROBE
:
1595 case LTTNG_KERNEL_ABI_FUNCTION
:
1597 case LTTNG_KERNEL_ABI_NOOP
:
1603 event_notifier
->priv
->parent
.registered
= 0;
1608 * Only used internally at session destruction.
1611 void _lttng_event_destroy(struct lttng_kernel_event_common
*event
)
1613 struct lttng_kernel_event_common_private
*event_priv
= event
->priv
;
1614 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1616 lttng_free_event_filter_runtime(event
);
1617 /* Free event enabler refs */
1618 list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1619 &event_priv
->enablers_ref_head
, node
)
1622 switch (event
->type
) {
1623 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1625 struct lttng_kernel_event_recorder
*event_recorder
=
1626 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
1628 switch (event_priv
->instrumentation
) {
1629 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1630 lttng_event_desc_put(event_priv
->desc
);
1633 case LTTNG_KERNEL_ABI_KPROBE
:
1634 module_put(event_priv
->desc
->owner
);
1635 lttng_kprobes_destroy_event_private(event_recorder
);
1638 case LTTNG_KERNEL_ABI_KRETPROBE
:
1639 module_put(event_priv
->desc
->owner
);
1640 lttng_kretprobes_destroy_private(event_recorder
);
1643 case LTTNG_KERNEL_ABI_SYSCALL
:
1646 case LTTNG_KERNEL_ABI_UPROBE
:
1647 module_put(event_priv
->desc
->owner
);
1648 lttng_uprobes_destroy_event_private(event_recorder
);
1651 case LTTNG_KERNEL_ABI_FUNCTION
:
1653 case LTTNG_KERNEL_ABI_NOOP
:
1658 list_del(&event_recorder
->priv
->node
);
1659 kmem_cache_free(event_recorder_private_cache
, event_recorder
->priv
);
1660 kmem_cache_free(event_recorder_cache
, event_recorder
);
1663 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1665 struct lttng_kernel_event_notifier
*event_notifier
=
1666 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
1668 switch (event_notifier
->priv
->parent
.instrumentation
) {
1669 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1670 lttng_event_desc_put(event_notifier
->priv
->parent
.desc
);
1673 case LTTNG_KERNEL_ABI_KPROBE
:
1674 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1675 lttng_kprobes_destroy_event_notifier_private(event_notifier
);
1678 case LTTNG_KERNEL_ABI_SYSCALL
:
1681 case LTTNG_KERNEL_ABI_UPROBE
:
1682 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1683 lttng_uprobes_destroy_event_notifier_private(event_notifier
);
1686 case LTTNG_KERNEL_ABI_KRETPROBE
:
1688 case LTTNG_KERNEL_ABI_FUNCTION
:
1690 case LTTNG_KERNEL_ABI_NOOP
:
1695 list_del(&event_notifier
->priv
->node
);
1696 kmem_cache_free(event_notifier_private_cache
, event_notifier
->priv
);
1697 kmem_cache_free(event_notifier_cache
, event_notifier
);
1705 struct lttng_kernel_id_tracker
*get_tracker(struct lttng_kernel_session
*session
,
1706 enum tracker_type tracker_type
)
1708 switch (tracker_type
) {
1710 return &session
->pid_tracker
;
1712 return &session
->vpid_tracker
;
1714 return &session
->uid_tracker
;
1716 return &session
->vuid_tracker
;
1718 return &session
->gid_tracker
;
1720 return &session
->vgid_tracker
;
1727 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1728 enum tracker_type tracker_type
, int id
)
1730 struct lttng_kernel_id_tracker
*tracker
;
1733 tracker
= get_tracker(session
, tracker_type
);
1738 mutex_lock(&sessions_mutex
);
1740 /* track all ids: destroy tracker. */
1741 lttng_id_tracker_destroy(tracker
, true);
1744 ret
= lttng_id_tracker_add(tracker
, id
);
1746 mutex_unlock(&sessions_mutex
);
1750 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1751 enum tracker_type tracker_type
, int id
)
1753 struct lttng_kernel_id_tracker
*tracker
;
1756 tracker
= get_tracker(session
, tracker_type
);
1761 mutex_lock(&sessions_mutex
);
1763 /* untrack all ids: replace by empty tracker. */
1764 ret
= lttng_id_tracker_empty_set(tracker
);
1766 ret
= lttng_id_tracker_del(tracker
, id
);
1768 mutex_unlock(&sessions_mutex
);
1773 void *id_list_start(struct seq_file
*m
, loff_t
*pos
)
1775 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1776 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1777 struct lttng_id_hash_node
*e
;
1780 mutex_lock(&sessions_mutex
);
1782 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1783 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1785 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1791 /* ID tracker disabled. */
1792 if (iter
>= *pos
&& iter
== 0) {
1793 return id_tracker_p
; /* empty tracker */
1801 /* Called with sessions_mutex held. */
1803 void *id_list_next(struct seq_file
*m
, void *p
, loff_t
*ppos
)
1805 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1806 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1807 struct lttng_id_hash_node
*e
;
1812 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1813 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1815 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1816 if (iter
++ >= *ppos
)
1821 /* ID tracker disabled. */
1822 if (iter
>= *ppos
&& iter
== 0)
1823 return p
; /* empty tracker */
1832 void id_list_stop(struct seq_file
*m
, void *p
)
1834 mutex_unlock(&sessions_mutex
);
1838 int id_list_show(struct seq_file
*m
, void *p
)
1840 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1841 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1844 if (p
== id_tracker_p
) {
1845 /* Tracker disabled. */
1848 const struct lttng_id_hash_node
*e
= p
;
1850 id
= lttng_id_tracker_get_node_id(e
);
1852 switch (id_tracker
->priv
->tracker_type
) {
1854 seq_printf(m
, "process { pid = %d; };\n", id
);
1857 seq_printf(m
, "process { vpid = %d; };\n", id
);
1860 seq_printf(m
, "user { uid = %d; };\n", id
);
1863 seq_printf(m
, "user { vuid = %d; };\n", id
);
1866 seq_printf(m
, "group { gid = %d; };\n", id
);
1869 seq_printf(m
, "group { vgid = %d; };\n", id
);
1872 seq_printf(m
, "UNKNOWN { field = %d };\n", id
);
1878 const struct seq_operations lttng_tracker_ids_list_seq_ops
= {
1879 .start
= id_list_start
,
1880 .next
= id_list_next
,
1881 .stop
= id_list_stop
,
1882 .show
= id_list_show
,
1886 int lttng_tracker_ids_list_open(struct inode
*inode
, struct file
*file
)
1888 return seq_open(file
, <tng_tracker_ids_list_seq_ops
);
1892 int lttng_tracker_ids_list_release(struct inode
*inode
, struct file
*file
)
1894 struct seq_file
*m
= file
->private_data
;
1895 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1898 WARN_ON_ONCE(!id_tracker
);
1899 ret
= seq_release(inode
, file
);
1901 fput(id_tracker
->priv
->session
->priv
->file
);
1905 const struct file_operations lttng_tracker_ids_list_fops
= {
1906 .owner
= THIS_MODULE
,
1907 .open
= lttng_tracker_ids_list_open
,
1909 .llseek
= seq_lseek
,
1910 .release
= lttng_tracker_ids_list_release
,
1913 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1914 enum tracker_type tracker_type
)
1916 struct file
*tracker_ids_list_file
;
1920 file_fd
= lttng_get_unused_fd();
1926 tracker_ids_list_file
= anon_inode_getfile("[lttng_tracker_ids_list]",
1927 <tng_tracker_ids_list_fops
,
1929 if (IS_ERR(tracker_ids_list_file
)) {
1930 ret
= PTR_ERR(tracker_ids_list_file
);
1933 if (!atomic_long_add_unless(&session
->priv
->file
->f_count
, 1, LONG_MAX
)) {
1935 goto refcount_error
;
1937 ret
= lttng_tracker_ids_list_fops
.open(NULL
, tracker_ids_list_file
);
1940 m
= tracker_ids_list_file
->private_data
;
1942 m
->private = get_tracker(session
, tracker_type
);
1943 BUG_ON(!m
->private);
1944 fd_install(file_fd
, tracker_ids_list_file
);
1949 atomic_long_dec(&session
->priv
->file
->f_count
);
1951 fput(tracker_ids_list_file
);
1953 put_unused_fd(file_fd
);
1959 * Enabler management.
1962 int lttng_match_enabler_star_glob(const char *desc_name
,
1963 const char *pattern
)
1965 if (!strutils_star_glob_match(pattern
, LTTNG_SIZE_MAX
,
1966 desc_name
, LTTNG_SIZE_MAX
))
1972 int lttng_match_enabler_name(const char *desc_name
,
1975 if (strcmp(desc_name
, name
))
1980 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
1981 struct lttng_event_enabler_common
*enabler
)
1983 const char *desc_name
, *enabler_name
;
1984 bool compat
= false, entry
= false;
1986 enabler_name
= enabler
->event_param
.name
;
1987 switch (enabler
->event_param
.instrumentation
) {
1988 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1989 desc_name
= desc
->event_name
;
1990 switch (enabler
->format_type
) {
1991 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1992 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1993 case LTTNG_ENABLER_FORMAT_NAME
:
1994 return lttng_match_enabler_name(desc_name
, enabler_name
);
2000 case LTTNG_KERNEL_ABI_SYSCALL
:
2001 desc_name
= desc
->event_name
;
2002 if (!strncmp(desc_name
, "compat_", strlen("compat_"))) {
2003 desc_name
+= strlen("compat_");
2006 if (!strncmp(desc_name
, "syscall_exit_",
2007 strlen("syscall_exit_"))) {
2008 desc_name
+= strlen("syscall_exit_");
2009 } else if (!strncmp(desc_name
, "syscall_entry_",
2010 strlen("syscall_entry_"))) {
2011 desc_name
+= strlen("syscall_entry_");
2017 switch (enabler
->event_param
.u
.syscall
.entryexit
) {
2018 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
2020 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
2024 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
2031 switch (enabler
->event_param
.u
.syscall
.abi
) {
2032 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
2034 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
2038 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
2045 switch (enabler
->event_param
.u
.syscall
.match
) {
2046 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
:
2047 switch (enabler
->format_type
) {
2048 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
2049 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
2050 case LTTNG_ENABLER_FORMAT_NAME
:
2051 return lttng_match_enabler_name(desc_name
, enabler_name
);
2056 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR
:
2057 return -EINVAL
; /* Not implemented. */
2070 int lttng_event_enabler_match_event(struct lttng_event_enabler
*event_enabler
,
2071 struct lttng_kernel_event_recorder
*event_recorder
)
2073 struct lttng_event_enabler_common
*base_enabler
= lttng_event_enabler_as_enabler(
2076 if (base_enabler
->event_param
.instrumentation
!= event_recorder
->priv
->parent
.instrumentation
)
2078 if (lttng_desc_match_enabler(event_recorder
->priv
->parent
.desc
, base_enabler
)
2079 && event_recorder
->chan
== event_enabler
->chan
)
2086 int lttng_event_notifier_enabler_match_event_notifier(struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2087 struct lttng_kernel_event_notifier
*event_notifier
)
2089 struct lttng_event_enabler_common
*base_enabler
= lttng_event_notifier_enabler_as_enabler(
2090 event_notifier_enabler
);
2092 if (base_enabler
->event_param
.instrumentation
!= event_notifier
->priv
->parent
.instrumentation
)
2094 if (lttng_desc_match_enabler(event_notifier
->priv
->parent
.desc
, base_enabler
)
2095 && event_notifier
->priv
->group
== event_notifier_enabler
->group
2096 && event_notifier
->priv
->parent
.user_token
== event_notifier_enabler
->parent
.user_token
)
2103 struct lttng_enabler_ref
*lttng_enabler_ref(
2104 struct list_head
*enablers_ref_list
,
2105 struct lttng_event_enabler_common
*enabler
)
2107 struct lttng_enabler_ref
*enabler_ref
;
2109 list_for_each_entry(enabler_ref
, enablers_ref_list
, node
) {
2110 if (enabler_ref
->ref
== enabler
)
2117 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2119 struct lttng_kernel_session
*session
= event_enabler
->chan
->parent
.session
;
2120 struct lttng_kernel_probe_desc
*probe_desc
;
2121 const struct lttng_kernel_event_desc
*desc
;
2123 struct list_head
*probe_list
;
2125 probe_list
= lttng_get_probe_list_head();
2127 * For each probe event, if we find that a probe event matches
2128 * our enabler, create an associated lttng_event if not
2131 list_for_each_entry(probe_desc
, probe_list
, head
) {
2132 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2134 struct hlist_head
*head
;
2135 struct lttng_kernel_event_recorder_private
*event_recorder_private
;
2136 struct lttng_kernel_event_recorder
*event_recorder
;
2138 desc
= probe_desc
->event_desc
[i
];
2139 if (!lttng_desc_match_enabler(desc
,
2140 lttng_event_enabler_as_enabler(event_enabler
)))
2144 * Check if already created.
2146 head
= utils_borrow_hash_table_bucket(
2147 session
->priv
->events_ht
.table
, LTTNG_EVENT_HT_SIZE
,
2149 lttng_hlist_for_each_entry(event_recorder_private
, head
, hlist
) {
2150 if (event_recorder_private
->parent
.desc
== desc
2151 && event_recorder_private
->pub
->chan
== event_enabler
->chan
)
2158 * We need to create an event for this
2161 event_recorder
= _lttng_kernel_event_recorder_create(event_enabler
, desc
);
2162 if (!event_recorder
) {
2163 printk(KERN_INFO
"LTTng: Unable to create event %s\n",
2164 probe_desc
->event_desc
[i
]->event_name
);
2171 void lttng_create_tracepoint_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2173 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2174 struct lttng_kernel_probe_desc
*probe_desc
;
2175 const struct lttng_kernel_event_desc
*desc
;
2177 struct list_head
*probe_list
;
2179 probe_list
= lttng_get_probe_list_head();
2181 * For each probe event, if we find that a probe event matches
2182 * our enabler, create an associated lttng_event_notifier if not
2185 list_for_each_entry(probe_desc
, probe_list
, head
) {
2186 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2188 struct hlist_head
*head
;
2189 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2190 struct lttng_kernel_event_notifier
*event_notifier
;
2192 desc
= probe_desc
->event_desc
[i
];
2193 if (!lttng_desc_match_enabler(desc
,
2194 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)))
2198 * Check if already created.
2200 head
= utils_borrow_hash_table_bucket(
2201 event_notifier_group
->event_notifiers_ht
.table
,
2202 LTTNG_EVENT_NOTIFIER_HT_SIZE
, desc
->event_name
);
2203 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
2204 if (event_notifier_priv
->parent
.desc
== desc
2205 && event_notifier_priv
->parent
.user_token
== event_notifier_enabler
->parent
.user_token
)
2212 * We need to create a event_notifier for this event probe.
2214 event_notifier
= _lttng_event_notifier_create(desc
,
2215 event_notifier_enabler
->parent
.user_token
,
2216 event_notifier_enabler
->error_counter_index
,
2217 event_notifier_group
, NULL
,
2218 LTTNG_KERNEL_ABI_TRACEPOINT
);
2219 if (IS_ERR(event_notifier
)) {
2220 printk(KERN_INFO
"Unable to create event_notifier %s\n",
2221 probe_desc
->event_desc
[i
]->event_name
);
2228 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2232 ret
= lttng_syscalls_register_event(event_enabler
);
2237 void lttng_create_syscall_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2241 ret
= lttng_syscalls_register_event_notifier(event_notifier_enabler
);
2243 ret
= lttng_syscalls_create_matching_event_notifiers(event_notifier_enabler
);
2248 * Create struct lttng_kernel_event_recorder if it is missing and present in the list of
2249 * tracepoint probes.
2250 * Should be called with sessions mutex held.
2253 void lttng_create_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2255 switch (event_enabler
->parent
.event_param
.instrumentation
) {
2256 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2257 lttng_create_tracepoint_event_if_missing(event_enabler
);
2260 case LTTNG_KERNEL_ABI_SYSCALL
:
2261 lttng_create_syscall_event_if_missing(event_enabler
);
2271 * Create events associated with an event_enabler (if not already present),
2272 * and add backward reference from the event to the enabler.
2273 * Should be called with sessions mutex held.
2276 int lttng_event_enabler_ref_events(struct lttng_event_enabler
*event_enabler
)
2278 struct lttng_kernel_channel_buffer
*chan
= event_enabler
->chan
;
2279 struct lttng_kernel_session
*session
= event_enabler
->chan
->parent
.session
;
2280 struct lttng_event_enabler_common
*base_enabler
= lttng_event_enabler_as_enabler(event_enabler
);
2281 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2283 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2284 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2285 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2286 !strcmp(base_enabler
->event_param
.name
, "*")) {
2287 int enabled
= base_enabler
->enabled
;
2288 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2290 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2291 WRITE_ONCE(chan
->priv
->parent
.syscall_table
.syscall_all_entry
, enabled
);
2293 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2294 WRITE_ONCE(chan
->priv
->parent
.syscall_table
.syscall_all_exit
, enabled
);
2297 /* First ensure that probe events are created for this enabler. */
2298 lttng_create_event_if_missing(event_enabler
);
2300 /* For each event matching event_enabler in session event list. */
2301 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2302 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2303 struct lttng_enabler_ref
*enabler_ref
;
2305 if (!lttng_event_enabler_match_event(event_enabler
, event_recorder
))
2307 enabler_ref
= lttng_enabler_ref(&event_recorder_priv
->parent
.enablers_ref_head
,
2308 lttng_event_enabler_as_enabler(event_enabler
));
2311 * If no backward ref, create it.
2312 * Add backward ref from event to event_enabler.
2314 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2317 enabler_ref
->ref
= lttng_event_enabler_as_enabler(event_enabler
);
2318 list_add(&enabler_ref
->node
,
2319 &event_recorder_priv
->parent
.enablers_ref_head
);
2323 * Link filter bytecodes if not linked yet.
2325 lttng_enabler_link_bytecode(event_recorder_priv
->parent
.desc
,
2327 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
,
2328 <tng_event_enabler_as_enabler(event_enabler
)->filter_bytecode_head
);
2334 * Create struct lttng_kernel_event_notifier if it is missing and present in the list of
2335 * tracepoint probes.
2336 * Should be called with sessions mutex held.
2339 void lttng_create_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2341 switch (event_notifier_enabler
->parent
.event_param
.instrumentation
) {
2342 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2343 lttng_create_tracepoint_event_notifier_if_missing(event_notifier_enabler
);
2346 case LTTNG_KERNEL_ABI_SYSCALL
:
2347 lttng_create_syscall_event_notifier_if_missing(event_notifier_enabler
);
2357 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2360 int lttng_event_notifier_enabler_ref_event_notifiers(
2361 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2363 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2364 struct lttng_event_enabler_common
*base_enabler
= lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2365 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2367 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2368 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2369 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2370 !strcmp(base_enabler
->event_param
.name
, "*")) {
2372 int enabled
= base_enabler
->enabled
;
2373 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2375 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2376 WRITE_ONCE(event_notifier_group
->syscall_table
.syscall_all_entry
, enabled
);
2378 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2379 WRITE_ONCE(event_notifier_group
->syscall_table
.syscall_all_exit
, enabled
);
2383 /* First ensure that probe event_notifiers are created for this enabler. */
2384 lttng_create_event_notifier_if_missing(event_notifier_enabler
);
2386 /* Link the created event_notifier with its associated enabler. */
2387 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2388 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2389 struct lttng_enabler_ref
*enabler_ref
;
2391 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler
, event_notifier
))
2394 enabler_ref
= lttng_enabler_ref(&event_notifier_priv
->parent
.enablers_ref_head
,
2395 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2398 * If no backward ref, create it.
2399 * Add backward ref from event_notifier to enabler.
2401 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2405 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2406 event_notifier_enabler
);
2407 list_add(&enabler_ref
->node
,
2408 &event_notifier_priv
->parent
.enablers_ref_head
);
2412 * Link filter bytecodes if not linked yet.
2414 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2415 lttng_static_ctx
, &event_notifier_priv
->parent
.filter_bytecode_runtime_head
,
2416 <tng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->filter_bytecode_head
);
2418 /* Link capture bytecodes if not linked yet. */
2419 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2420 lttng_static_ctx
, &event_notifier_priv
->capture_bytecode_runtime_head
,
2421 &event_notifier_enabler
->capture_bytecode_head
);
2423 event_notifier_priv
->num_captures
= event_notifier_enabler
->num_captures
;
2429 * Called at module load: connect the probe on all enablers matching
2431 * Called with sessions lock held.
2433 int lttng_fix_pending_events(void)
2435 struct lttng_kernel_session_private
*session_priv
;
2437 list_for_each_entry(session_priv
, &sessions
, list
)
2438 lttng_session_lazy_sync_event_enablers(session_priv
->pub
);
2442 static bool lttng_event_notifier_group_has_active_event_notifiers(
2443 struct lttng_event_notifier_group
*event_notifier_group
)
2445 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2447 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
,
2449 if (event_notifier_enabler
->parent
.enabled
)
2455 bool lttng_event_notifier_active(void)
2457 struct lttng_event_notifier_group
*event_notifier_group
;
2459 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2460 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group
))
2466 int lttng_fix_pending_event_notifiers(void)
2468 struct lttng_event_notifier_group
*event_notifier_group
;
2470 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
)
2471 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
2475 struct lttng_event_enabler
*lttng_event_enabler_create(
2476 enum lttng_enabler_format_type format_type
,
2477 struct lttng_kernel_abi_event
*event_param
,
2478 struct lttng_kernel_channel_buffer
*chan
)
2480 struct lttng_event_enabler
*event_enabler
;
2482 event_enabler
= kzalloc(sizeof(*event_enabler
), GFP_KERNEL
);
2485 event_enabler
->parent
.enabler_type
= LTTNG_EVENT_ENABLER_TYPE_RECORDER
;
2486 event_enabler
->parent
.format_type
= format_type
;
2487 INIT_LIST_HEAD(&event_enabler
->parent
.filter_bytecode_head
);
2488 memcpy(&event_enabler
->parent
.event_param
, event_param
,
2489 sizeof(event_enabler
->parent
.event_param
));
2490 event_enabler
->chan
= chan
;
2492 event_enabler
->parent
.enabled
= 0;
2493 return event_enabler
;
2496 void lttng_event_enabler_session_add(struct lttng_kernel_session
*session
,
2497 struct lttng_event_enabler
*event_enabler
)
2499 mutex_lock(&sessions_mutex
);
2500 list_add(&event_enabler
->node
, &session
->priv
->enablers_head
);
2501 event_enabler
->published
= true;
2502 lttng_session_lazy_sync_event_enablers(session
);
2503 mutex_unlock(&sessions_mutex
);
2506 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
)
2508 mutex_lock(&sessions_mutex
);
2509 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 1;
2510 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2511 mutex_unlock(&sessions_mutex
);
2515 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
)
2517 mutex_lock(&sessions_mutex
);
2518 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 0;
2519 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2520 mutex_unlock(&sessions_mutex
);
2525 int lttng_enabler_attach_filter_bytecode(struct lttng_event_enabler_common
*enabler
,
2526 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2528 struct lttng_kernel_bytecode_node
*bytecode_node
;
2529 uint32_t bytecode_len
;
2532 ret
= get_user(bytecode_len
, &bytecode
->len
);
2535 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2539 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2540 sizeof(*bytecode
) + bytecode_len
);
2544 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_FILTER
;
2545 bytecode_node
->enabler
= enabler
;
2546 /* Enforce length based on allocated size */
2547 bytecode_node
->bc
.len
= bytecode_len
;
2548 list_add_tail(&bytecode_node
->node
, &enabler
->filter_bytecode_head
);
2553 lttng_kvfree(bytecode_node
);
2557 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
2558 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2561 ret
= lttng_enabler_attach_filter_bytecode(
2562 lttng_event_enabler_as_enabler(event_enabler
), bytecode
);
2566 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2573 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
2574 struct lttng_kernel_abi_event_callsite __user
*callsite
)
2577 switch (event
->priv
->instrumentation
) {
2578 case LTTNG_KERNEL_ABI_UPROBE
:
2579 return lttng_uprobes_event_add_callsite(event
, callsite
);
2586 void lttng_enabler_destroy(struct lttng_event_enabler_common
*enabler
)
2588 struct lttng_kernel_bytecode_node
*filter_node
, *tmp_filter_node
;
2590 /* Destroy filter bytecode */
2591 list_for_each_entry_safe(filter_node
, tmp_filter_node
,
2592 &enabler
->filter_bytecode_head
, node
) {
2593 lttng_kvfree(filter_node
);
2597 void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
)
2599 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler
));
2601 if (event_enabler
->published
)
2602 list_del(&event_enabler
->node
);
2603 kfree(event_enabler
);
2606 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
2607 struct lttng_event_notifier_group
*event_notifier_group
,
2608 enum lttng_enabler_format_type format_type
,
2609 struct lttng_kernel_abi_event_notifier
*event_notifier_param
)
2611 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2613 event_notifier_enabler
= kzalloc(sizeof(*event_notifier_enabler
), GFP_KERNEL
);
2614 if (!event_notifier_enabler
)
2617 event_notifier_enabler
->parent
.enabler_type
= LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
;
2618 event_notifier_enabler
->parent
.format_type
= format_type
;
2619 INIT_LIST_HEAD(&event_notifier_enabler
->parent
.filter_bytecode_head
);
2620 INIT_LIST_HEAD(&event_notifier_enabler
->capture_bytecode_head
);
2622 event_notifier_enabler
->error_counter_index
= event_notifier_param
->error_counter_index
;
2623 event_notifier_enabler
->num_captures
= 0;
2625 memcpy(&event_notifier_enabler
->parent
.event_param
, &event_notifier_param
->event
,
2626 sizeof(event_notifier_enabler
->parent
.event_param
));
2628 event_notifier_enabler
->parent
.enabled
= 0;
2629 event_notifier_enabler
->parent
.user_token
= event_notifier_param
->event
.token
;
2630 event_notifier_enabler
->group
= event_notifier_group
;
2632 mutex_lock(&sessions_mutex
);
2633 list_add(&event_notifier_enabler
->node
, &event_notifier_enabler
->group
->enablers_head
);
2634 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2636 mutex_unlock(&sessions_mutex
);
2638 return event_notifier_enabler
;
2641 int lttng_event_notifier_enabler_enable(
2642 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2644 mutex_lock(&sessions_mutex
);
2645 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
2646 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2647 mutex_unlock(&sessions_mutex
);
2651 int lttng_event_notifier_enabler_disable(
2652 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2654 mutex_lock(&sessions_mutex
);
2655 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
2656 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2657 mutex_unlock(&sessions_mutex
);
2661 int lttng_event_notifier_enabler_attach_filter_bytecode(
2662 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2663 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2667 ret
= lttng_enabler_attach_filter_bytecode(
2668 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
2673 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2680 int lttng_event_notifier_enabler_attach_capture_bytecode(
2681 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2682 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
)
2684 struct lttng_kernel_bytecode_node
*bytecode_node
;
2685 struct lttng_event_enabler_common
*enabler
=
2686 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2687 uint32_t bytecode_len
;
2690 ret
= get_user(bytecode_len
, &bytecode
->len
);
2694 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2699 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2700 sizeof(*bytecode
) + bytecode_len
);
2704 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
;
2705 bytecode_node
->enabler
= enabler
;
2707 /* Enforce length based on allocated size */
2708 bytecode_node
->bc
.len
= bytecode_len
;
2709 list_add_tail(&bytecode_node
->node
, &event_notifier_enabler
->capture_bytecode_head
);
2711 event_notifier_enabler
->num_captures
++;
2713 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2717 lttng_kvfree(bytecode_node
);
2723 void lttng_event_notifier_enabler_destroy(
2724 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2726 if (!event_notifier_enabler
) {
2730 list_del(&event_notifier_enabler
->node
);
2732 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2733 kfree(event_notifier_enabler
);
2737 * lttng_session_sync_event_enablers should be called just before starting a
2739 * Should be called with sessions mutex held.
2742 void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
)
2744 struct lttng_event_enabler
*event_enabler
;
2745 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2747 list_for_each_entry(event_enabler
, &session
->priv
->enablers_head
, node
)
2748 lttng_event_enabler_ref_events(event_enabler
);
2750 * For each event, if at least one of its enablers is enabled,
2751 * and its channel and session transient states are enabled, we
2752 * enable the event, else we disable it.
2754 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2755 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2756 struct lttng_enabler_ref
*enabler_ref
;
2757 struct lttng_kernel_bytecode_runtime
*runtime
;
2758 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2761 switch (event_recorder_priv
->parent
.instrumentation
) {
2762 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2764 case LTTNG_KERNEL_ABI_SYSCALL
:
2766 list_for_each_entry(enabler_ref
,
2767 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2768 if (enabler_ref
->ref
->enabled
) {
2776 /* Not handled with lazy sync. */
2780 * Enabled state is based on union of enablers, with
2781 * intesection of session and channel transient enable
2784 enabled
= enabled
&& session
->priv
->tstate
&& event_recorder
->chan
->priv
->parent
.tstate
;
2786 WRITE_ONCE(event_recorder
->parent
.enabled
, enabled
);
2788 * Sync tracepoint registration with event enabled
2792 register_event(event_recorder
);
2794 _lttng_event_unregister(event_recorder
);
2797 /* Check if has enablers without bytecode enabled */
2798 list_for_each_entry(enabler_ref
,
2799 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2800 if (enabler_ref
->ref
->enabled
2801 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2802 has_enablers_without_filter_bytecode
= 1;
2806 event_recorder_priv
->parent
.has_enablers_without_filter_bytecode
=
2807 has_enablers_without_filter_bytecode
;
2809 /* Enable filters */
2810 list_for_each_entry(runtime
,
2811 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2812 lttng_bytecode_sync_state(runtime
);
2815 WRITE_ONCE(event_recorder_priv
->parent
.pub
->eval_filter
,
2816 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2821 * Apply enablers to session events, adding events to session if need
2822 * be. It is required after each modification applied to an active
2823 * session, and right before session "start".
2824 * "lazy" sync means we only sync if required.
2825 * Should be called with sessions mutex held.
2828 void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
)
2830 /* We can skip if session is not active */
2831 if (!session
->active
)
2833 lttng_session_sync_event_enablers(session
);
2837 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2839 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2840 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2842 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2843 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2846 * For each event_notifier, if at least one of its enablers is enabled,
2847 * we enable the event_notifier, else we disable it.
2849 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2850 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2851 struct lttng_enabler_ref
*enabler_ref
;
2852 struct lttng_kernel_bytecode_runtime
*runtime
;
2853 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2854 int nr_filters
= 0, nr_captures
= 0;
2856 switch (event_notifier_priv
->parent
.instrumentation
) {
2857 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2859 case LTTNG_KERNEL_ABI_SYSCALL
:
2860 /* Enable event_notifiers */
2861 list_for_each_entry(enabler_ref
,
2862 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2863 if (enabler_ref
->ref
->enabled
) {
2871 /* Not handled with sync. */
2875 WRITE_ONCE(event_notifier
->parent
.enabled
, enabled
);
2877 * Sync tracepoint registration with event_notifier enabled
2881 if (!event_notifier_priv
->parent
.registered
)
2882 register_event_notifier(event_notifier
);
2884 if (event_notifier_priv
->parent
.registered
)
2885 _lttng_event_notifier_unregister(event_notifier
);
2888 /* Check if has enablers without bytecode enabled */
2889 list_for_each_entry(enabler_ref
,
2890 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2891 if (enabler_ref
->ref
->enabled
2892 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2893 has_enablers_without_filter_bytecode
= 1;
2897 event_notifier_priv
->parent
.has_enablers_without_filter_bytecode
=
2898 has_enablers_without_filter_bytecode
;
2900 /* Enable filters */
2901 list_for_each_entry(runtime
,
2902 &event_notifier_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2903 lttng_bytecode_sync_state(runtime
);
2906 WRITE_ONCE(event_notifier_priv
->parent
.pub
->eval_filter
,
2907 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2909 /* Enable captures */
2910 list_for_each_entry(runtime
,
2911 &event_notifier_priv
->capture_bytecode_runtime_head
, node
) {
2912 lttng_bytecode_sync_state(runtime
);
2915 WRITE_ONCE(event_notifier
->eval_capture
, !!nr_captures
);
2920 * Serialize at most one packet worth of metadata into a metadata
2922 * We grab the metadata cache mutex to get exclusive access to our metadata
2923 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2924 * allows us to do racy operations such as looking for remaining space left in
2925 * packet and write, since mutual exclusion protects us from concurrent writes.
2926 * Mutual exclusion on the metadata cache allow us to read the cache content
2927 * without racing against reallocation of the cache by updates.
2928 * Returns the number of bytes written in the channel, 0 if no data
2929 * was written and a negative value on error.
2931 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
2932 struct lttng_kernel_ring_buffer_channel
*chan
, bool *coherent
)
2934 struct lttng_kernel_ring_buffer_ctx ctx
;
2936 size_t len
, reserve_len
;
2939 * Ensure we support mutiple get_next / put sequences followed by
2940 * put_next. The metadata cache lock protects reading the metadata
2941 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2942 * "flush" operations on the buffer invoked by different processes.
2943 * Moreover, since the metadata cache memory can be reallocated, we
2944 * need to have exclusive access against updates even though we only
2947 mutex_lock(&stream
->metadata_cache
->lock
);
2948 WARN_ON(stream
->metadata_in
< stream
->metadata_out
);
2949 if (stream
->metadata_in
!= stream
->metadata_out
)
2952 /* Metadata regenerated, change the version. */
2953 if (stream
->metadata_cache
->version
!= stream
->version
)
2954 stream
->version
= stream
->metadata_cache
->version
;
2956 len
= stream
->metadata_cache
->metadata_written
-
2957 stream
->metadata_in
;
2960 reserve_len
= min_t(size_t,
2961 stream
->transport
->ops
.priv
->packet_avail_size(chan
),
2963 lib_ring_buffer_ctx_init(&ctx
, chan
, reserve_len
,
2964 sizeof(char), NULL
);
2966 * If reservation failed, return an error to the caller.
2968 ret
= stream
->transport
->ops
.event_reserve(&ctx
);
2970 printk(KERN_WARNING
"LTTng: Metadata event reservation failed\n");
2971 stream
->coherent
= false;
2974 stream
->transport
->ops
.event_write(&ctx
,
2975 stream
->metadata_cache
->data
+ stream
->metadata_in
,
2977 stream
->transport
->ops
.event_commit(&ctx
);
2978 stream
->metadata_in
+= reserve_len
;
2979 if (reserve_len
< len
)
2980 stream
->coherent
= false;
2982 stream
->coherent
= true;
2987 *coherent
= stream
->coherent
;
2988 mutex_unlock(&stream
->metadata_cache
->lock
);
2993 void lttng_metadata_begin(struct lttng_kernel_session
*session
)
2995 if (atomic_inc_return(&session
->priv
->metadata_cache
->producing
) == 1)
2996 mutex_lock(&session
->priv
->metadata_cache
->lock
);
3000 void lttng_metadata_end(struct lttng_kernel_session
*session
)
3002 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
3003 if (atomic_dec_return(&session
->priv
->metadata_cache
->producing
) == 0) {
3004 struct lttng_metadata_stream
*stream
;
3006 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
3007 wake_up_interruptible(&stream
->read_wait
);
3008 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
3013 * Write the metadata to the metadata cache.
3014 * Must be called with sessions_mutex held.
3015 * The metadata cache lock protects us from concurrent read access from
3016 * thread outputting metadata content to ring buffer.
3017 * The content of the printf is printed as a single atomic metadata
3020 int lttng_metadata_printf(struct lttng_kernel_session
*session
,
3021 const char *fmt
, ...)
3027 WARN_ON_ONCE(!LTTNG_READ_ONCE(session
->active
));
3030 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
3036 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
3037 if (session
->priv
->metadata_cache
->metadata_written
+ len
>
3038 session
->priv
->metadata_cache
->cache_alloc
) {
3039 char *tmp_cache_realloc
;
3040 unsigned int tmp_cache_alloc_size
;
3042 tmp_cache_alloc_size
= max_t(unsigned int,
3043 session
->priv
->metadata_cache
->cache_alloc
+ len
,
3044 session
->priv
->metadata_cache
->cache_alloc
<< 1);
3045 tmp_cache_realloc
= vzalloc(tmp_cache_alloc_size
);
3046 if (!tmp_cache_realloc
)
3048 if (session
->priv
->metadata_cache
->data
) {
3049 memcpy(tmp_cache_realloc
,
3050 session
->priv
->metadata_cache
->data
,
3051 session
->priv
->metadata_cache
->cache_alloc
);
3052 vfree(session
->priv
->metadata_cache
->data
);
3055 session
->priv
->metadata_cache
->cache_alloc
= tmp_cache_alloc_size
;
3056 session
->priv
->metadata_cache
->data
= tmp_cache_realloc
;
3058 memcpy(session
->priv
->metadata_cache
->data
+
3059 session
->priv
->metadata_cache
->metadata_written
,
3061 session
->priv
->metadata_cache
->metadata_written
+= len
;
3072 int print_tabs(struct lttng_kernel_session
*session
, size_t nesting
)
3076 for (i
= 0; i
< nesting
; i
++) {
3079 ret
= lttng_metadata_printf(session
, " ");
3088 int lttng_field_name_statedump(struct lttng_kernel_session
*session
,
3089 const struct lttng_kernel_event_field
*field
,
3092 return lttng_metadata_printf(session
, " _%s;\n", field
->name
);
3096 int _lttng_integer_type_statedump(struct lttng_kernel_session
*session
,
3097 const struct lttng_kernel_type_integer
*type
,
3098 enum lttng_kernel_string_encoding parent_encoding
,
3103 ret
= print_tabs(session
, nesting
);
3106 ret
= lttng_metadata_printf(session
,
3107 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
3111 (parent_encoding
== lttng_kernel_string_encoding_none
)
3113 : (parent_encoding
== lttng_kernel_string_encoding_UTF8
)
3117 #if __BYTE_ORDER == __BIG_ENDIAN
3118 type
->reverse_byte_order
? " byte_order = le;" : ""
3120 type
->reverse_byte_order
? " byte_order = be;" : ""
3127 * Must be called with sessions_mutex held.
3130 int _lttng_struct_type_statedump(struct lttng_kernel_session
*session
,
3131 const struct lttng_kernel_type_struct
*type
,
3134 const char *prev_field_name
= NULL
;
3136 uint32_t i
, nr_fields
;
3137 unsigned int alignment
;
3139 ret
= print_tabs(session
, nesting
);
3142 ret
= lttng_metadata_printf(session
,
3146 nr_fields
= type
->nr_fields
;
3147 for (i
= 0; i
< nr_fields
; i
++) {
3148 const struct lttng_kernel_event_field
*iter_field
;
3150 iter_field
= type
->fields
[i
];
3151 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, &prev_field_name
);
3155 ret
= print_tabs(session
, nesting
);
3158 alignment
= type
->alignment
;
3160 ret
= lttng_metadata_printf(session
,
3164 ret
= lttng_metadata_printf(session
,
3171 * Must be called with sessions_mutex held.
3174 int _lttng_struct_field_statedump(struct lttng_kernel_session
*session
,
3175 const struct lttng_kernel_event_field
*field
,
3180 ret
= _lttng_struct_type_statedump(session
,
3181 lttng_kernel_get_type_struct(field
->type
), nesting
);
3184 return lttng_field_name_statedump(session
, field
, nesting
);
3188 * Must be called with sessions_mutex held.
3191 int _lttng_variant_type_statedump(struct lttng_kernel_session
*session
,
3192 const struct lttng_kernel_type_variant
*type
,
3194 const char *prev_field_name
)
3196 const char *tag_name
;
3198 uint32_t i
, nr_choices
;
3200 tag_name
= type
->tag_name
;
3202 tag_name
= prev_field_name
;
3206 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
3208 if (type
->alignment
!= 0)
3210 ret
= print_tabs(session
, nesting
);
3213 ret
= lttng_metadata_printf(session
,
3214 "variant <_%s> {\n",
3218 nr_choices
= type
->nr_choices
;
3219 for (i
= 0; i
< nr_choices
; i
++) {
3220 const struct lttng_kernel_event_field
*iter_field
;
3222 iter_field
= type
->choices
[i
];
3223 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, NULL
);
3227 ret
= print_tabs(session
, nesting
);
3230 ret
= lttng_metadata_printf(session
,
3236 * Must be called with sessions_mutex held.
3239 int _lttng_variant_field_statedump(struct lttng_kernel_session
*session
,
3240 const struct lttng_kernel_event_field
*field
,
3242 const char *prev_field_name
)
3246 ret
= _lttng_variant_type_statedump(session
,
3247 lttng_kernel_get_type_variant(field
->type
), nesting
,
3251 return lttng_field_name_statedump(session
, field
, nesting
);
3255 * Must be called with sessions_mutex held.
3258 int _lttng_array_field_statedump(struct lttng_kernel_session
*session
,
3259 const struct lttng_kernel_event_field
*field
,
3263 const struct lttng_kernel_type_array
*array_type
;
3264 const struct lttng_kernel_type_common
*elem_type
;
3266 array_type
= lttng_kernel_get_type_array(field
->type
);
3267 WARN_ON_ONCE(!array_type
);
3269 if (array_type
->alignment
) {
3270 ret
= print_tabs(session
, nesting
);
3273 ret
= lttng_metadata_printf(session
,
3274 "struct { } align(%u) _%s_padding;\n",
3275 array_type
->alignment
* CHAR_BIT
,
3281 * Nested compound types: Only array of structures and variants are
3282 * currently supported.
3284 elem_type
= array_type
->elem_type
;
3285 switch (elem_type
->type
) {
3286 case lttng_kernel_type_integer
:
3287 case lttng_kernel_type_struct
:
3288 case lttng_kernel_type_variant
:
3289 ret
= _lttng_type_statedump(session
, elem_type
,
3290 array_type
->encoding
, nesting
);
3298 ret
= lttng_metadata_printf(session
,
3301 array_type
->length
);
3306 * Must be called with sessions_mutex held.
3309 int _lttng_sequence_field_statedump(struct lttng_kernel_session
*session
,
3310 const struct lttng_kernel_event_field
*field
,
3312 const char *prev_field_name
)
3315 const char *length_name
;
3316 const struct lttng_kernel_type_sequence
*sequence_type
;
3317 const struct lttng_kernel_type_common
*elem_type
;
3319 sequence_type
= lttng_kernel_get_type_sequence(field
->type
);
3320 WARN_ON_ONCE(!sequence_type
);
3322 length_name
= sequence_type
->length_name
;
3324 length_name
= prev_field_name
;
3328 if (sequence_type
->alignment
) {
3329 ret
= print_tabs(session
, nesting
);
3332 ret
= lttng_metadata_printf(session
,
3333 "struct { } align(%u) _%s_padding;\n",
3334 sequence_type
->alignment
* CHAR_BIT
,
3341 * Nested compound types: Only array of structures and variants are
3342 * currently supported.
3344 elem_type
= sequence_type
->elem_type
;
3345 switch (elem_type
->type
) {
3346 case lttng_kernel_type_integer
:
3347 case lttng_kernel_type_struct
:
3348 case lttng_kernel_type_variant
:
3349 ret
= _lttng_type_statedump(session
, elem_type
,
3350 sequence_type
->encoding
, nesting
);
3358 ret
= lttng_metadata_printf(session
,
3366 * Must be called with sessions_mutex held.
3369 int _lttng_enum_type_statedump(struct lttng_kernel_session
*session
,
3370 const struct lttng_kernel_type_enum
*type
,
3373 const struct lttng_kernel_enum_desc
*enum_desc
;
3374 const struct lttng_kernel_type_common
*container_type
;
3376 unsigned int i
, nr_entries
;
3378 container_type
= type
->container_type
;
3379 if (container_type
->type
!= lttng_kernel_type_integer
) {
3383 enum_desc
= type
->desc
;
3384 nr_entries
= enum_desc
->nr_entries
;
3386 ret
= print_tabs(session
, nesting
);
3389 ret
= lttng_metadata_printf(session
, "enum : ");
3392 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(container_type
),
3393 lttng_kernel_string_encoding_none
, 0);
3396 ret
= lttng_metadata_printf(session
, " {\n");
3399 /* Dump all entries */
3400 for (i
= 0; i
< nr_entries
; i
++) {
3401 const struct lttng_kernel_enum_entry
*entry
= enum_desc
->entries
[i
];
3404 ret
= print_tabs(session
, nesting
+ 1);
3407 ret
= lttng_metadata_printf(session
,
3411 len
= strlen(entry
->string
);
3412 /* Escape the character '"' */
3413 for (j
= 0; j
< len
; j
++) {
3414 char c
= entry
->string
[j
];
3418 ret
= lttng_metadata_printf(session
,
3422 ret
= lttng_metadata_printf(session
,
3426 ret
= lttng_metadata_printf(session
,
3433 ret
= lttng_metadata_printf(session
, "\"");
3437 if (entry
->options
.is_auto
) {
3438 ret
= lttng_metadata_printf(session
, ",\n");
3442 ret
= lttng_metadata_printf(session
,
3446 if (entry
->start
.signedness
)
3447 ret
= lttng_metadata_printf(session
,
3448 "%lld", (long long) entry
->start
.value
);
3450 ret
= lttng_metadata_printf(session
,
3451 "%llu", entry
->start
.value
);
3454 if (entry
->start
.signedness
== entry
->end
.signedness
&&
3456 == entry
->end
.value
) {
3457 ret
= lttng_metadata_printf(session
,
3460 if (entry
->end
.signedness
) {
3461 ret
= lttng_metadata_printf(session
,
3463 (long long) entry
->end
.value
);
3465 ret
= lttng_metadata_printf(session
,
3474 ret
= print_tabs(session
, nesting
);
3477 ret
= lttng_metadata_printf(session
, "}");
3483 * Must be called with sessions_mutex held.
3486 int _lttng_enum_field_statedump(struct lttng_kernel_session
*session
,
3487 const struct lttng_kernel_event_field
*field
,
3491 const struct lttng_kernel_type_enum
*enum_type
;
3493 enum_type
= lttng_kernel_get_type_enum(field
->type
);
3494 WARN_ON_ONCE(!enum_type
);
3495 ret
= _lttng_enum_type_statedump(session
, enum_type
, nesting
);
3498 return lttng_field_name_statedump(session
, field
, nesting
);
3502 int _lttng_integer_field_statedump(struct lttng_kernel_session
*session
,
3503 const struct lttng_kernel_event_field
*field
,
3508 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(field
->type
),
3509 lttng_kernel_string_encoding_none
, nesting
);
3512 return lttng_field_name_statedump(session
, field
, nesting
);
3516 int _lttng_string_type_statedump(struct lttng_kernel_session
*session
,
3517 const struct lttng_kernel_type_string
*type
,
3522 /* Default encoding is UTF8 */
3523 ret
= print_tabs(session
, nesting
);
3526 ret
= lttng_metadata_printf(session
,
3528 type
->encoding
== lttng_kernel_string_encoding_ASCII
?
3529 " { encoding = ASCII; }" : "");
3534 int _lttng_string_field_statedump(struct lttng_kernel_session
*session
,
3535 const struct lttng_kernel_event_field
*field
,
3538 const struct lttng_kernel_type_string
*string_type
;
3541 string_type
= lttng_kernel_get_type_string(field
->type
);
3542 WARN_ON_ONCE(!string_type
);
3543 ret
= _lttng_string_type_statedump(session
, string_type
, nesting
);
3546 return lttng_field_name_statedump(session
, field
, nesting
);
3550 * Must be called with sessions_mutex held.
3553 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
3554 const struct lttng_kernel_type_common
*type
,
3555 enum lttng_kernel_string_encoding parent_encoding
,
3560 switch (type
->type
) {
3561 case lttng_kernel_type_integer
:
3562 ret
= _lttng_integer_type_statedump(session
,
3563 lttng_kernel_get_type_integer(type
),
3564 parent_encoding
, nesting
);
3566 case lttng_kernel_type_enum
:
3567 ret
= _lttng_enum_type_statedump(session
,
3568 lttng_kernel_get_type_enum(type
),
3571 case lttng_kernel_type_string
:
3572 ret
= _lttng_string_type_statedump(session
,
3573 lttng_kernel_get_type_string(type
),
3576 case lttng_kernel_type_struct
:
3577 ret
= _lttng_struct_type_statedump(session
,
3578 lttng_kernel_get_type_struct(type
),
3581 case lttng_kernel_type_variant
:
3582 ret
= _lttng_variant_type_statedump(session
,
3583 lttng_kernel_get_type_variant(type
),
3587 /* Nested arrays and sequences are not supported yet. */
3588 case lttng_kernel_type_array
:
3589 case lttng_kernel_type_sequence
:
3598 * Must be called with sessions_mutex held.
3601 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
3602 const struct lttng_kernel_event_field
*field
,
3604 const char **prev_field_name_p
)
3606 const char *prev_field_name
= NULL
;
3609 if (prev_field_name_p
)
3610 prev_field_name
= *prev_field_name_p
;
3611 switch (field
->type
->type
) {
3612 case lttng_kernel_type_integer
:
3613 ret
= _lttng_integer_field_statedump(session
, field
, nesting
);
3615 case lttng_kernel_type_enum
:
3616 ret
= _lttng_enum_field_statedump(session
, field
, nesting
);
3618 case lttng_kernel_type_string
:
3619 ret
= _lttng_string_field_statedump(session
, field
, nesting
);
3621 case lttng_kernel_type_struct
:
3622 ret
= _lttng_struct_field_statedump(session
, field
, nesting
);
3624 case lttng_kernel_type_array
:
3625 ret
= _lttng_array_field_statedump(session
, field
, nesting
);
3627 case lttng_kernel_type_sequence
:
3628 ret
= _lttng_sequence_field_statedump(session
, field
, nesting
, prev_field_name
);
3630 case lttng_kernel_type_variant
:
3631 ret
= _lttng_variant_field_statedump(session
, field
, nesting
, prev_field_name
);
3638 if (prev_field_name_p
)
3639 *prev_field_name_p
= field
->name
;
3644 int _lttng_context_metadata_statedump(struct lttng_kernel_session
*session
,
3645 struct lttng_kernel_ctx
*ctx
)
3647 const char *prev_field_name
= NULL
;
3653 for (i
= 0; i
< ctx
->nr_fields
; i
++) {
3654 const struct lttng_kernel_ctx_field
*field
= &ctx
->fields
[i
];
3656 ret
= _lttng_field_statedump(session
, field
->event_field
, 2, &prev_field_name
);
3664 int _lttng_fields_metadata_statedump(struct lttng_kernel_session
*session
,
3665 struct lttng_kernel_event_recorder
*event_recorder
)
3667 const char *prev_field_name
= NULL
;
3668 const struct lttng_kernel_event_desc
*desc
= event_recorder
->priv
->parent
.desc
;
3672 for (i
= 0; i
< desc
->tp_class
->nr_fields
; i
++) {
3673 const struct lttng_kernel_event_field
*field
= desc
->tp_class
->fields
[i
];
3675 ret
= _lttng_field_statedump(session
, field
, 2, &prev_field_name
);
3683 * Must be called with sessions_mutex held.
3684 * The entire event metadata is printed as a single atomic metadata
3688 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
3689 struct lttng_kernel_channel_buffer
*chan
,
3690 struct lttng_kernel_event_recorder
*event_recorder
)
3694 if (event_recorder
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3696 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3699 lttng_metadata_begin(session
);
3701 ret
= lttng_metadata_printf(session
,
3705 " stream_id = %u;\n",
3706 event_recorder
->priv
->parent
.desc
->event_name
,
3707 event_recorder
->priv
->id
,
3708 event_recorder
->chan
->priv
->id
);
3712 ret
= lttng_metadata_printf(session
,
3713 " fields := struct {\n"
3718 ret
= _lttng_fields_metadata_statedump(session
, event_recorder
);
3723 * LTTng space reservation can only reserve multiples of the
3726 ret
= lttng_metadata_printf(session
,
3732 event_recorder
->priv
->metadata_dumped
= 1;
3734 lttng_metadata_end(session
);
3740 * Must be called with sessions_mutex held.
3741 * The entire channel metadata is printed as a single atomic metadata
3745 int _lttng_channel_metadata_statedump(struct lttng_kernel_session
*session
,
3746 struct lttng_kernel_channel_buffer
*chan
)
3750 if (chan
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3753 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3756 lttng_metadata_begin(session
);
3758 WARN_ON_ONCE(!chan
->priv
->header_type
);
3759 ret
= lttng_metadata_printf(session
,
3762 " event.header := %s;\n"
3763 " packet.context := struct packet_context;\n",
3765 chan
->priv
->header_type
== 1 ? "struct event_header_compact" :
3766 "struct event_header_large");
3770 if (chan
->priv
->ctx
) {
3771 ret
= lttng_metadata_printf(session
,
3772 " event.context := struct {\n");
3776 ret
= _lttng_context_metadata_statedump(session
, chan
->priv
->ctx
);
3779 if (chan
->priv
->ctx
) {
3780 ret
= lttng_metadata_printf(session
,
3786 ret
= lttng_metadata_printf(session
,
3789 chan
->priv
->metadata_dumped
= 1;
3791 lttng_metadata_end(session
);
3796 * Must be called with sessions_mutex held.
3799 int _lttng_stream_packet_context_declare(struct lttng_kernel_session
*session
)
3801 return lttng_metadata_printf(session
,
3802 "struct packet_context {\n"
3803 " uint64_clock_monotonic_t timestamp_begin;\n"
3804 " uint64_clock_monotonic_t timestamp_end;\n"
3805 " uint64_t content_size;\n"
3806 " uint64_t packet_size;\n"
3807 " uint64_t packet_seq_num;\n"
3808 " unsigned long events_discarded;\n"
3809 " uint32_t cpu_id;\n"
3816 * id: range: 0 - 30.
3817 * id 31 is reserved to indicate an extended header.
3820 * id: range: 0 - 65534.
3821 * id 65535 is reserved to indicate an extended header.
3823 * Must be called with sessions_mutex held.
3826 int _lttng_event_header_declare(struct lttng_kernel_session
*session
)
3828 return lttng_metadata_printf(session
,
3829 "struct event_header_compact {\n"
3830 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3833 " uint27_clock_monotonic_t timestamp;\n"
3837 " uint64_clock_monotonic_t timestamp;\n"
3842 "struct event_header_large {\n"
3843 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3846 " uint32_clock_monotonic_t timestamp;\n"
3850 " uint64_clock_monotonic_t timestamp;\n"
3854 lttng_alignof(uint32_t) * CHAR_BIT
,
3855 lttng_alignof(uint16_t) * CHAR_BIT
3860 * Approximation of NTP time of day to clock monotonic correlation,
3861 * taken at start of trace.
3862 * Yes, this is only an approximation. Yes, we can (and will) do better
3863 * in future versions.
3864 * This function may return a negative offset. It may happen if the
3865 * system sets the REALTIME clock to 0 after boot.
3867 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3871 int64_t measure_clock_offset(void)
3873 uint64_t monotonic_avg
, monotonic
[2], realtime
;
3874 uint64_t tcf
= trace_clock_freq();
3876 unsigned long flags
;
3877 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3878 struct timespec64 rts
= { 0, 0 };
3880 struct timespec rts
= { 0, 0 };
3883 /* Disable interrupts to increase correlation precision. */
3884 local_irq_save(flags
);
3885 monotonic
[0] = trace_clock_read64();
3886 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3887 ktime_get_real_ts64(&rts
);
3889 getnstimeofday(&rts
);
3891 monotonic
[1] = trace_clock_read64();
3892 local_irq_restore(flags
);
3894 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
3895 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
3896 if (tcf
== NSEC_PER_SEC
) {
3897 realtime
+= rts
.tv_nsec
;
3899 uint64_t n
= rts
.tv_nsec
* tcf
;
3901 do_div(n
, NSEC_PER_SEC
);
3904 offset
= (int64_t) realtime
- monotonic_avg
;
3909 int print_escaped_ctf_string(struct lttng_kernel_session
*session
, const char *string
)
3917 while (cur
!= '\0') {
3920 ret
= lttng_metadata_printf(session
, "%s", "\\n");
3924 ret
= lttng_metadata_printf(session
, "%c", '\\');
3927 /* We still print the current char */
3930 ret
= lttng_metadata_printf(session
, "%c", cur
);
3944 int print_metadata_escaped_field(struct lttng_kernel_session
*session
, const char *field
,
3945 const char *field_value
)
3949 ret
= lttng_metadata_printf(session
, " %s = \"", field
);
3953 ret
= print_escaped_ctf_string(session
, field_value
);
3957 ret
= lttng_metadata_printf(session
, "\";\n");
3964 * Output metadata into this session's metadata buffers.
3965 * Must be called with sessions_mutex held.
3968 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
)
3970 unsigned char *uuid_c
= session
->priv
->uuid
.b
;
3971 unsigned char uuid_s
[37], clock_uuid_s
[BOOT_ID_LEN
];
3972 const char *product_uuid
;
3973 struct lttng_kernel_channel_buffer_private
*chan_priv
;
3974 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
3977 if (!LTTNG_READ_ONCE(session
->active
))
3980 lttng_metadata_begin(session
);
3982 if (session
->priv
->metadata_dumped
)
3985 snprintf(uuid_s
, sizeof(uuid_s
),
3986 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3987 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
3988 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
3989 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
3990 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
3992 ret
= lttng_metadata_printf(session
,
3993 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3994 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3995 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3996 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
3997 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
3998 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
3999 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
4005 " byte_order = %s;\n"
4006 " packet.header := struct {\n"
4007 " uint32_t magic;\n"
4008 " uint8_t uuid[16];\n"
4009 " uint32_t stream_id;\n"
4010 " uint64_t stream_instance_id;\n"
4013 lttng_alignof(uint8_t) * CHAR_BIT
,
4014 lttng_alignof(uint16_t) * CHAR_BIT
,
4015 lttng_alignof(uint32_t) * CHAR_BIT
,
4016 lttng_alignof(uint64_t) * CHAR_BIT
,
4017 sizeof(unsigned long) * CHAR_BIT
,
4018 lttng_alignof(unsigned long) * CHAR_BIT
,
4022 #if __BYTE_ORDER == __BIG_ENDIAN
4031 ret
= lttng_metadata_printf(session
,
4033 " hostname = \"%s\";\n"
4034 " domain = \"kernel\";\n"
4035 " sysname = \"%s\";\n"
4036 " kernel_release = \"%s\";\n"
4037 " kernel_version = \"%s\";\n"
4038 " tracer_name = \"lttng-modules\";\n"
4039 " tracer_major = %d;\n"
4040 " tracer_minor = %d;\n"
4041 " tracer_patchlevel = %d;\n"
4042 " trace_buffering_scheme = \"global\";\n",
4043 current
->nsproxy
->uts_ns
->name
.nodename
,
4047 LTTNG_MODULES_MAJOR_VERSION
,
4048 LTTNG_MODULES_MINOR_VERSION
,
4049 LTTNG_MODULES_PATCHLEVEL_VERSION
4054 ret
= print_metadata_escaped_field(session
, "trace_name", session
->priv
->name
);
4057 ret
= print_metadata_escaped_field(session
, "trace_creation_datetime",
4058 session
->priv
->creation_time
);
4062 /* Add the product UUID to the 'env' section */
4063 product_uuid
= dmi_get_system_info(DMI_PRODUCT_UUID
);
4065 ret
= lttng_metadata_printf(session
,
4066 " product_uuid = \"%s\";\n",
4073 /* Close the 'env' section */
4074 ret
= lttng_metadata_printf(session
, "};\n\n");
4078 ret
= lttng_metadata_printf(session
,
4080 " name = \"%s\";\n",
4086 if (!trace_clock_uuid(clock_uuid_s
)) {
4087 ret
= lttng_metadata_printf(session
,
4088 " uuid = \"%s\";\n",
4095 ret
= lttng_metadata_printf(session
,
4096 " description = \"%s\";\n"
4097 " freq = %llu; /* Frequency, in Hz */\n"
4098 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
4101 trace_clock_description(),
4102 (unsigned long long) trace_clock_freq(),
4103 (long long) measure_clock_offset()
4108 ret
= lttng_metadata_printf(session
,
4109 "typealias integer {\n"
4110 " size = 27; align = 1; signed = false;\n"
4111 " map = clock.%s.value;\n"
4112 "} := uint27_clock_monotonic_t;\n"
4114 "typealias integer {\n"
4115 " size = 32; align = %u; signed = false;\n"
4116 " map = clock.%s.value;\n"
4117 "} := uint32_clock_monotonic_t;\n"
4119 "typealias integer {\n"
4120 " size = 64; align = %u; signed = false;\n"
4121 " map = clock.%s.value;\n"
4122 "} := uint64_clock_monotonic_t;\n\n",
4124 lttng_alignof(uint32_t) * CHAR_BIT
,
4126 lttng_alignof(uint64_t) * CHAR_BIT
,
4132 ret
= _lttng_stream_packet_context_declare(session
);
4136 ret
= _lttng_event_header_declare(session
);
4141 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
4142 ret
= _lttng_channel_metadata_statedump(session
, chan_priv
->pub
);
4147 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
4148 ret
= _lttng_event_metadata_statedump(session
, event_recorder_priv
->pub
->chan
,
4149 event_recorder_priv
->pub
);
4153 session
->priv
->metadata_dumped
= 1;
4155 lttng_metadata_end(session
);
4160 * lttng_transport_register - LTT transport registration
4161 * @transport: transport structure
4163 * Registers a transport which can be used as output to extract the data out of
4164 * LTTng. The module calling this registration function must ensure that no
4165 * trap-inducing code will be executed by the transport functions. E.g.
4166 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
4167 * is made visible to the transport function. This registration acts as a
4168 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
4169 * after its registration must it synchronize the TLBs.
4171 void lttng_transport_register(struct lttng_transport
*transport
)
4174 * Make sure no page fault can be triggered by the module about to be
4175 * registered. We deal with this here so we don't have to call
4176 * vmalloc_sync_mappings() in each module's init.
4178 wrapper_vmalloc_sync_mappings();
4180 mutex_lock(&sessions_mutex
);
4181 list_add_tail(&transport
->node
, <tng_transport_list
);
4182 mutex_unlock(&sessions_mutex
);
4184 EXPORT_SYMBOL_GPL(lttng_transport_register
);
4187 * lttng_transport_unregister - LTT transport unregistration
4188 * @transport: transport structure
4190 void lttng_transport_unregister(struct lttng_transport
*transport
)
4192 mutex_lock(&sessions_mutex
);
4193 list_del(&transport
->node
);
4194 mutex_unlock(&sessions_mutex
);
4196 EXPORT_SYMBOL_GPL(lttng_transport_unregister
);
4198 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
)
4201 * Make sure no page fault can be triggered by the module about to be
4202 * registered. We deal with this here so we don't have to call
4203 * vmalloc_sync_mappings() in each module's init.
4205 wrapper_vmalloc_sync_mappings();
4207 mutex_lock(&sessions_mutex
);
4208 list_add_tail(&transport
->node
, <tng_counter_transport_list
);
4209 mutex_unlock(&sessions_mutex
);
4211 EXPORT_SYMBOL_GPL(lttng_counter_transport_register
);
4213 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
)
4215 mutex_lock(&sessions_mutex
);
4216 list_del(&transport
->node
);
4217 mutex_unlock(&sessions_mutex
);
4219 EXPORT_SYMBOL_GPL(lttng_counter_transport_unregister
);
4221 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
4223 enum cpuhp_state lttng_hp_prepare
;
4224 enum cpuhp_state lttng_hp_online
;
4226 static int lttng_hotplug_prepare(unsigned int cpu
, struct hlist_node
*node
)
4228 struct lttng_cpuhp_node
*lttng_node
;
4230 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4231 switch (lttng_node
->component
) {
4232 case LTTNG_RING_BUFFER_FRONTEND
:
4234 case LTTNG_RING_BUFFER_BACKEND
:
4235 return lttng_cpuhp_rb_backend_prepare(cpu
, lttng_node
);
4236 case LTTNG_RING_BUFFER_ITER
:
4238 case LTTNG_CONTEXT_PERF_COUNTERS
:
4245 static int lttng_hotplug_dead(unsigned int cpu
, struct hlist_node
*node
)
4247 struct lttng_cpuhp_node
*lttng_node
;
4249 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4250 switch (lttng_node
->component
) {
4251 case LTTNG_RING_BUFFER_FRONTEND
:
4252 return lttng_cpuhp_rb_frontend_dead(cpu
, lttng_node
);
4253 case LTTNG_RING_BUFFER_BACKEND
:
4255 case LTTNG_RING_BUFFER_ITER
:
4257 case LTTNG_CONTEXT_PERF_COUNTERS
:
4258 return lttng_cpuhp_perf_counter_dead(cpu
, lttng_node
);
4264 static int lttng_hotplug_online(unsigned int cpu
, struct hlist_node
*node
)
4266 struct lttng_cpuhp_node
*lttng_node
;
4268 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4269 switch (lttng_node
->component
) {
4270 case LTTNG_RING_BUFFER_FRONTEND
:
4271 return lttng_cpuhp_rb_frontend_online(cpu
, lttng_node
);
4272 case LTTNG_RING_BUFFER_BACKEND
:
4274 case LTTNG_RING_BUFFER_ITER
:
4275 return lttng_cpuhp_rb_iter_online(cpu
, lttng_node
);
4276 case LTTNG_CONTEXT_PERF_COUNTERS
:
4277 return lttng_cpuhp_perf_counter_online(cpu
, lttng_node
);
4283 static int lttng_hotplug_offline(unsigned int cpu
, struct hlist_node
*node
)
4285 struct lttng_cpuhp_node
*lttng_node
;
4287 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4288 switch (lttng_node
->component
) {
4289 case LTTNG_RING_BUFFER_FRONTEND
:
4290 return lttng_cpuhp_rb_frontend_offline(cpu
, lttng_node
);
4291 case LTTNG_RING_BUFFER_BACKEND
:
4293 case LTTNG_RING_BUFFER_ITER
:
4295 case LTTNG_CONTEXT_PERF_COUNTERS
:
4302 static int __init
lttng_init_cpu_hotplug(void)
4306 ret
= cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN
, "lttng:prepare",
4307 lttng_hotplug_prepare
,
4308 lttng_hotplug_dead
);
4312 lttng_hp_prepare
= ret
;
4313 lttng_rb_set_hp_prepare(ret
);
4315 ret
= cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN
, "lttng:online",
4316 lttng_hotplug_online
,
4317 lttng_hotplug_offline
);
4319 cpuhp_remove_multi_state(lttng_hp_prepare
);
4320 lttng_hp_prepare
= 0;
4323 lttng_hp_online
= ret
;
4324 lttng_rb_set_hp_online(ret
);
4329 static void __exit
lttng_exit_cpu_hotplug(void)
4331 lttng_rb_set_hp_online(0);
4332 cpuhp_remove_multi_state(lttng_hp_online
);
4333 lttng_rb_set_hp_prepare(0);
4334 cpuhp_remove_multi_state(lttng_hp_prepare
);
4337 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4338 static int lttng_init_cpu_hotplug(void)
4342 static void lttng_exit_cpu_hotplug(void)
4345 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4347 static int __init
lttng_events_init(void)
4351 ret
= wrapper_lttng_fixup_sig(THIS_MODULE
);
4354 ret
= wrapper_get_pfnblock_flags_mask_init();
4357 ret
= wrapper_get_pageblock_flags_mask_init();
4360 ret
= lttng_probes_init();
4363 ret
= lttng_context_init();
4366 ret
= lttng_tracepoint_init();
4369 event_recorder_cache
= KMEM_CACHE(lttng_kernel_event_recorder
, 0);
4370 if (!event_recorder_cache
) {
4372 goto error_kmem_event_recorder
;
4374 event_recorder_private_cache
= KMEM_CACHE(lttng_kernel_event_recorder_private
, 0);
4375 if (!event_recorder_private_cache
) {
4377 goto error_kmem_event_recorder_private
;
4379 event_notifier_cache
= KMEM_CACHE(lttng_kernel_event_notifier
, 0);
4380 if (!event_notifier_cache
) {
4382 goto error_kmem_event_notifier
;
4384 event_notifier_private_cache
= KMEM_CACHE(lttng_kernel_event_notifier_private
, 0);
4385 if (!event_notifier_private_cache
) {
4387 goto error_kmem_event_notifier_private
;
4389 ret
= lttng_abi_init();
4392 ret
= lttng_logger_init();
4395 ret
= lttng_init_cpu_hotplug();
4398 printk(KERN_NOTICE
"LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
4399 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4400 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4401 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4402 LTTNG_MODULES_EXTRAVERSION
,
4404 #ifdef LTTNG_EXTRA_VERSION_GIT
4405 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4409 #ifdef LTTNG_EXTRA_VERSION_NAME
4410 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4414 #ifdef CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM
4415 printk(KERN_NOTICE
"LTTng: Experimental bitwise enum enabled.\n");
4416 #endif /* CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM */
4420 lttng_logger_exit();
4424 kmem_cache_destroy(event_notifier_private_cache
);
4425 error_kmem_event_notifier_private
:
4426 kmem_cache_destroy(event_notifier_cache
);
4427 error_kmem_event_notifier
:
4428 kmem_cache_destroy(event_recorder_private_cache
);
4429 error_kmem_event_recorder_private
:
4430 kmem_cache_destroy(event_recorder_cache
);
4431 error_kmem_event_recorder
:
4432 lttng_tracepoint_exit();
4434 lttng_context_exit();
4435 printk(KERN_NOTICE
"LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4436 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4437 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4438 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4439 LTTNG_MODULES_EXTRAVERSION
,
4441 #ifdef LTTNG_EXTRA_VERSION_GIT
4442 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4446 #ifdef LTTNG_EXTRA_VERSION_NAME
4447 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4454 module_init(lttng_events_init
);
4456 static void __exit
lttng_events_exit(void)
4458 struct lttng_kernel_session_private
*session_priv
, *tmpsession_priv
;
4460 lttng_exit_cpu_hotplug();
4461 lttng_logger_exit();
4463 list_for_each_entry_safe(session_priv
, tmpsession_priv
, &sessions
, list
)
4464 lttng_session_destroy(session_priv
->pub
);
4465 kmem_cache_destroy(event_recorder_cache
);
4466 kmem_cache_destroy(event_recorder_private_cache
);
4467 kmem_cache_destroy(event_notifier_cache
);
4468 kmem_cache_destroy(event_notifier_private_cache
);
4469 lttng_tracepoint_exit();
4470 lttng_context_exit();
4471 printk(KERN_NOTICE
"LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4472 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4473 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4474 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4475 LTTNG_MODULES_EXTRAVERSION
,
4477 #ifdef LTTNG_EXTRA_VERSION_GIT
4478 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4482 #ifdef LTTNG_EXTRA_VERSION_NAME
4483 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4489 module_exit(lttng_events_exit
);
4491 #include <generated/patches.h>
4492 #ifdef LTTNG_EXTRA_VERSION_GIT
4493 MODULE_INFO(extra_version_git
, LTTNG_EXTRA_VERSION_GIT
);
4495 #ifdef LTTNG_EXTRA_VERSION_NAME
4496 MODULE_INFO(extra_version_name
, LTTNG_EXTRA_VERSION_NAME
);
4498 MODULE_LICENSE("GPL and additional rights");
4499 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4500 MODULE_DESCRIPTION("LTTng tracer");
4501 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
4502 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
4503 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
4504 LTTNG_MODULES_EXTRAVERSION
);