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_enabler_destroy(struct lttng_event_enabler
*event_enabler
);
70 static void lttng_event_notifier_enabler_destroy(struct lttng_event_notifier_enabler
*event_notifier_enabler
);
71 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
);
73 static void _lttng_event_destroy(struct lttng_kernel_event_common
*event
);
74 static void _lttng_channel_destroy(struct lttng_kernel_channel_buffer
*chan
);
75 static void _lttng_event_unregister(struct lttng_kernel_event_recorder
*event
);
76 static void _lttng_event_notifier_unregister(struct lttng_kernel_event_notifier
*event_notifier
);
78 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
79 struct lttng_kernel_channel_buffer
*chan
,
80 struct lttng_kernel_event_recorder
*event
);
82 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
);
84 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
);
86 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
87 const struct lttng_kernel_type_common
*type
,
88 enum lttng_kernel_string_encoding parent_encoding
,
91 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
92 const struct lttng_kernel_event_field
*field
,
93 size_t nesting
, const char **prev_field_name_p
);
95 void synchronize_trace(void)
97 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,1,0) || \
98 LTTNG_RHEL_KERNEL_RANGE(4,18,0,193,0,0, 4,19,0,0,0,0))
104 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0))
105 #ifdef CONFIG_PREEMPT_RT_FULL
108 #else /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
109 #ifdef CONFIG_PREEMPT_RT
112 #endif /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
115 void lttng_lock_sessions(void)
117 mutex_lock(&sessions_mutex
);
120 void lttng_unlock_sessions(void)
122 mutex_unlock(&sessions_mutex
);
125 static struct lttng_transport
*lttng_transport_find(const char *name
)
127 struct lttng_transport
*transport
;
129 list_for_each_entry(transport
, <tng_transport_list
, node
) {
130 if (!strcmp(transport
->name
, name
))
137 * Called with sessions lock held.
139 int lttng_session_active(void)
141 struct lttng_kernel_session_private
*iter
;
143 list_for_each_entry(iter
, &sessions
, list
) {
144 if (iter
->pub
->active
)
150 struct lttng_kernel_session
*lttng_session_create(void)
152 struct lttng_kernel_session
*session
;
153 struct lttng_kernel_session_private
*session_priv
;
154 struct lttng_metadata_cache
*metadata_cache
;
157 mutex_lock(&sessions_mutex
);
158 session
= lttng_kvzalloc(sizeof(*session
), GFP_KERNEL
);
161 session_priv
= lttng_kvzalloc(sizeof(*session_priv
), GFP_KERNEL
);
163 goto err_free_session
;
164 session
->priv
= session_priv
;
165 session_priv
->pub
= session
;
167 INIT_LIST_HEAD(&session_priv
->chan
);
168 INIT_LIST_HEAD(&session_priv
->events
);
169 lttng_guid_gen(&session_priv
->uuid
);
171 metadata_cache
= kzalloc(sizeof(struct lttng_metadata_cache
),
174 goto err_free_session_private
;
175 metadata_cache
->data
= vzalloc(METADATA_CACHE_DEFAULT_SIZE
);
176 if (!metadata_cache
->data
)
178 metadata_cache
->cache_alloc
= METADATA_CACHE_DEFAULT_SIZE
;
179 kref_init(&metadata_cache
->refcount
);
180 mutex_init(&metadata_cache
->lock
);
181 session_priv
->metadata_cache
= metadata_cache
;
182 INIT_LIST_HEAD(&metadata_cache
->metadata_stream
);
183 memcpy(&metadata_cache
->uuid
, &session_priv
->uuid
,
184 sizeof(metadata_cache
->uuid
));
185 INIT_LIST_HEAD(&session_priv
->enablers_head
);
186 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
187 INIT_HLIST_HEAD(&session_priv
->events_ht
.table
[i
]);
188 list_add(&session_priv
->list
, &sessions
);
190 if (lttng_id_tracker_init(&session
->pid_tracker
, session
, TRACKER_PID
))
191 goto tracker_alloc_error
;
192 if (lttng_id_tracker_init(&session
->vpid_tracker
, session
, TRACKER_VPID
))
193 goto tracker_alloc_error
;
194 if (lttng_id_tracker_init(&session
->uid_tracker
, session
, TRACKER_UID
))
195 goto tracker_alloc_error
;
196 if (lttng_id_tracker_init(&session
->vuid_tracker
, session
, TRACKER_VUID
))
197 goto tracker_alloc_error
;
198 if (lttng_id_tracker_init(&session
->gid_tracker
, session
, TRACKER_GID
))
199 goto tracker_alloc_error
;
200 if (lttng_id_tracker_init(&session
->vgid_tracker
, session
, TRACKER_VGID
))
201 goto tracker_alloc_error
;
203 mutex_unlock(&sessions_mutex
);
208 lttng_id_tracker_fini(&session
->pid_tracker
);
209 lttng_id_tracker_fini(&session
->vpid_tracker
);
210 lttng_id_tracker_fini(&session
->uid_tracker
);
211 lttng_id_tracker_fini(&session
->vuid_tracker
);
212 lttng_id_tracker_fini(&session
->gid_tracker
);
213 lttng_id_tracker_fini(&session
->vgid_tracker
);
215 kfree(metadata_cache
);
216 err_free_session_private
:
217 lttng_kvfree(session_priv
);
219 lttng_kvfree(session
);
221 mutex_unlock(&sessions_mutex
);
226 struct lttng_counter_transport
*lttng_counter_transport_find(const char *name
)
228 struct lttng_counter_transport
*transport
;
230 list_for_each_entry(transport
, <tng_counter_transport_list
, node
) {
231 if (!strcmp(transport
->name
, name
))
237 struct lttng_counter
*lttng_kernel_counter_create(
238 const char *counter_transport_name
,
239 size_t number_dimensions
, const size_t *dimensions_sizes
)
241 struct lttng_counter
*counter
= NULL
;
242 struct lttng_counter_transport
*counter_transport
= NULL
;
244 counter_transport
= lttng_counter_transport_find(counter_transport_name
);
245 if (!counter_transport
) {
246 printk(KERN_WARNING
"LTTng: counter transport %s not found.\n",
247 counter_transport_name
);
250 if (!try_module_get(counter_transport
->owner
)) {
251 printk(KERN_WARNING
"LTTng: Can't lock counter transport module.\n");
255 counter
= lttng_kvzalloc(sizeof(struct lttng_counter
), GFP_KERNEL
);
259 /* Create event notifier error counter. */
260 counter
->ops
= &counter_transport
->ops
;
261 counter
->transport
= counter_transport
;
263 counter
->counter
= counter
->ops
->counter_create(
264 number_dimensions
, dimensions_sizes
, 0);
265 if (!counter
->counter
) {
272 lttng_kvfree(counter
);
274 if (counter_transport
)
275 module_put(counter_transport
->owner
);
280 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
282 struct lttng_transport
*transport
= NULL
;
283 struct lttng_event_notifier_group
*event_notifier_group
;
284 const char *transport_name
= "relay-event-notifier";
285 size_t subbuf_size
= 4096; //TODO
286 size_t num_subbuf
= 16; //TODO
287 unsigned int switch_timer_interval
= 0;
288 unsigned int read_timer_interval
= 0;
291 mutex_lock(&sessions_mutex
);
293 transport
= lttng_transport_find(transport_name
);
295 printk(KERN_WARNING
"LTTng: transport %s not found\n",
299 if (!try_module_get(transport
->owner
)) {
300 printk(KERN_WARNING
"LTTng: Can't lock transport %s module.\n",
305 event_notifier_group
= lttng_kvzalloc(sizeof(struct lttng_event_notifier_group
),
307 if (!event_notifier_group
)
311 * Initialize the ring buffer used to store event notifier
314 event_notifier_group
->ops
= &transport
->ops
;
315 event_notifier_group
->chan
= transport
->ops
.priv
->channel_create(
316 transport_name
, event_notifier_group
, NULL
,
317 subbuf_size
, num_subbuf
, switch_timer_interval
,
318 read_timer_interval
);
319 if (!event_notifier_group
->chan
)
322 event_notifier_group
->transport
= transport
;
324 INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
325 INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
326 for (i
= 0; i
< LTTNG_EVENT_NOTIFIER_HT_SIZE
; i
++)
327 INIT_HLIST_HEAD(&event_notifier_group
->event_notifiers_ht
.table
[i
]);
329 list_add(&event_notifier_group
->node
, &event_notifier_groups
);
331 mutex_unlock(&sessions_mutex
);
333 return event_notifier_group
;
336 lttng_kvfree(event_notifier_group
);
339 module_put(transport
->owner
);
341 mutex_unlock(&sessions_mutex
);
345 void metadata_cache_destroy(struct kref
*kref
)
347 struct lttng_metadata_cache
*cache
=
348 container_of(kref
, struct lttng_metadata_cache
, refcount
);
353 void lttng_session_destroy(struct lttng_kernel_session
*session
)
355 struct lttng_kernel_channel_buffer_private
*chan_priv
, *tmpchan_priv
;
356 struct lttng_kernel_event_recorder_private
*event_recorder_priv
, *tmpevent_recorder_priv
;
357 struct lttng_metadata_stream
*metadata_stream
;
358 struct lttng_event_enabler
*event_enabler
, *tmp_event_enabler
;
361 mutex_lock(&sessions_mutex
);
362 WRITE_ONCE(session
->active
, 0);
363 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
364 ret
= lttng_syscalls_unregister_channel(chan_priv
->pub
);
367 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
)
368 _lttng_event_unregister(event_recorder_priv
->pub
);
369 synchronize_trace(); /* Wait for in-flight events to complete */
370 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
371 ret
= lttng_syscalls_destroy_event(chan_priv
->pub
);
374 list_for_each_entry_safe(event_enabler
, tmp_event_enabler
,
375 &session
->priv
->enablers_head
, node
)
376 lttng_event_enabler_destroy(event_enabler
);
377 list_for_each_entry_safe(event_recorder_priv
, tmpevent_recorder_priv
, &session
->priv
->events
, node
)
378 _lttng_event_destroy(&event_recorder_priv
->pub
->parent
);
379 list_for_each_entry_safe(chan_priv
, tmpchan_priv
, &session
->priv
->chan
, node
) {
380 BUG_ON(chan_priv
->channel_type
== METADATA_CHANNEL
);
381 _lttng_channel_destroy(chan_priv
->pub
);
383 mutex_lock(&session
->priv
->metadata_cache
->lock
);
384 list_for_each_entry(metadata_stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
385 _lttng_metadata_channel_hangup(metadata_stream
);
386 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
387 lttng_id_tracker_fini(&session
->pid_tracker
);
388 lttng_id_tracker_fini(&session
->vpid_tracker
);
389 lttng_id_tracker_fini(&session
->uid_tracker
);
390 lttng_id_tracker_fini(&session
->vuid_tracker
);
391 lttng_id_tracker_fini(&session
->gid_tracker
);
392 lttng_id_tracker_fini(&session
->vgid_tracker
);
393 kref_put(&session
->priv
->metadata_cache
->refcount
, metadata_cache_destroy
);
394 list_del(&session
->priv
->list
);
395 mutex_unlock(&sessions_mutex
);
396 lttng_kvfree(session
->priv
);
397 lttng_kvfree(session
);
400 void lttng_event_notifier_group_destroy(
401 struct lttng_event_notifier_group
*event_notifier_group
)
403 struct lttng_event_notifier_enabler
*event_notifier_enabler
, *tmp_event_notifier_enabler
;
404 struct lttng_kernel_event_notifier_private
*event_notifier_priv
, *tmpevent_notifier_priv
;
407 if (!event_notifier_group
)
410 mutex_lock(&sessions_mutex
);
412 ret
= lttng_syscalls_unregister_event_notifier_group(event_notifier_group
);
415 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
416 &event_notifier_group
->event_notifiers_head
, node
)
417 _lttng_event_notifier_unregister(event_notifier_priv
->pub
);
419 /* Wait for in-flight event notifier to complete */
422 irq_work_sync(&event_notifier_group
->wakeup_pending
);
424 kfree(event_notifier_group
->sc_filter
);
426 list_for_each_entry_safe(event_notifier_enabler
, tmp_event_notifier_enabler
,
427 &event_notifier_group
->enablers_head
, node
)
428 lttng_event_notifier_enabler_destroy(event_notifier_enabler
);
430 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
431 &event_notifier_group
->event_notifiers_head
, node
)
432 _lttng_event_destroy(&event_notifier_priv
->pub
->parent
);
434 if (event_notifier_group
->error_counter
) {
435 struct lttng_counter
*error_counter
= event_notifier_group
->error_counter
;
437 error_counter
->ops
->counter_destroy(error_counter
->counter
);
438 module_put(error_counter
->transport
->owner
);
439 lttng_kvfree(error_counter
);
440 event_notifier_group
->error_counter
= NULL
;
443 event_notifier_group
->ops
->priv
->channel_destroy(event_notifier_group
->chan
);
444 module_put(event_notifier_group
->transport
->owner
);
445 list_del(&event_notifier_group
->node
);
447 mutex_unlock(&sessions_mutex
);
448 lttng_kvfree(event_notifier_group
);
451 int lttng_session_statedump(struct lttng_kernel_session
*session
)
455 mutex_lock(&sessions_mutex
);
456 ret
= lttng_statedump_start(session
);
457 mutex_unlock(&sessions_mutex
);
461 int lttng_session_enable(struct lttng_kernel_session
*session
)
464 struct lttng_kernel_channel_buffer_private
*chan_priv
;
466 mutex_lock(&sessions_mutex
);
467 if (session
->active
) {
472 /* Set transient enabler state to "enabled" */
473 session
->priv
->tstate
= 1;
475 /* We need to sync enablers with session before activation. */
476 lttng_session_sync_event_enablers(session
);
479 * Snapshot the number of events per channel to know the type of header
482 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
483 if (chan_priv
->header_type
)
484 continue; /* don't change it if session stop/restart */
485 if (chan_priv
->free_event_id
< 31)
486 chan_priv
->header_type
= 1; /* compact */
488 chan_priv
->header_type
= 2; /* large */
491 /* Clear each stream's quiescent state. */
492 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
493 if (chan_priv
->channel_type
!= METADATA_CHANNEL
)
494 lib_ring_buffer_clear_quiescent_channel(chan_priv
->rb_chan
);
497 WRITE_ONCE(session
->active
, 1);
498 WRITE_ONCE(session
->priv
->been_active
, 1);
499 ret
= _lttng_session_metadata_statedump(session
);
501 WRITE_ONCE(session
->active
, 0);
504 ret
= lttng_statedump_start(session
);
506 WRITE_ONCE(session
->active
, 0);
508 mutex_unlock(&sessions_mutex
);
512 int lttng_session_disable(struct lttng_kernel_session
*session
)
515 struct lttng_kernel_channel_buffer_private
*chan_priv
;
517 mutex_lock(&sessions_mutex
);
518 if (!session
->active
) {
522 WRITE_ONCE(session
->active
, 0);
524 /* Set transient enabler state to "disabled" */
525 session
->priv
->tstate
= 0;
526 lttng_session_sync_event_enablers(session
);
528 /* Set each stream's quiescent state. */
529 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
530 if (chan_priv
->channel_type
!= METADATA_CHANNEL
)
531 lib_ring_buffer_set_quiescent_channel(chan_priv
->rb_chan
);
534 mutex_unlock(&sessions_mutex
);
538 int lttng_session_metadata_regenerate(struct lttng_kernel_session
*session
)
541 struct lttng_kernel_channel_buffer_private
*chan_priv
;
542 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
543 struct lttng_metadata_cache
*cache
= session
->priv
->metadata_cache
;
544 struct lttng_metadata_stream
*stream
;
546 mutex_lock(&sessions_mutex
);
547 if (!session
->active
) {
552 mutex_lock(&cache
->lock
);
553 memset(cache
->data
, 0, cache
->cache_alloc
);
554 cache
->metadata_written
= 0;
556 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
) {
557 stream
->metadata_out
= 0;
558 stream
->metadata_in
= 0;
560 mutex_unlock(&cache
->lock
);
562 session
->priv
->metadata_dumped
= 0;
563 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
564 chan_priv
->metadata_dumped
= 0;
567 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
568 event_recorder_priv
->metadata_dumped
= 0;
571 ret
= _lttng_session_metadata_statedump(session
);
574 mutex_unlock(&sessions_mutex
);
578 int lttng_channel_enable(struct lttng_kernel_channel_buffer
*channel
)
582 mutex_lock(&sessions_mutex
);
583 if (channel
->priv
->channel_type
== METADATA_CHANNEL
) {
587 if (channel
->parent
.enabled
) {
591 /* Set transient enabler state to "enabled" */
592 channel
->priv
->parent
.tstate
= 1;
593 lttng_session_sync_event_enablers(channel
->parent
.session
);
594 /* Set atomically the state to "enabled" */
595 WRITE_ONCE(channel
->parent
.enabled
, 1);
597 mutex_unlock(&sessions_mutex
);
601 int lttng_channel_disable(struct lttng_kernel_channel_buffer
*channel
)
605 mutex_lock(&sessions_mutex
);
606 if (channel
->priv
->channel_type
== METADATA_CHANNEL
) {
610 if (!channel
->parent
.enabled
) {
614 /* Set atomically the state to "disabled" */
615 WRITE_ONCE(channel
->parent
.enabled
, 0);
616 /* Set transient enabler state to "enabled" */
617 channel
->priv
->parent
.tstate
= 0;
618 lttng_session_sync_event_enablers(channel
->parent
.session
);
620 mutex_unlock(&sessions_mutex
);
624 int lttng_event_enable(struct lttng_kernel_event_common
*event
)
628 mutex_lock(&sessions_mutex
);
629 switch (event
->type
) {
630 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
632 struct lttng_kernel_event_recorder
*event_recorder
=
633 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
635 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
641 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
642 switch (event
->priv
->instrumentation
) {
643 case LTTNG_KERNEL_ABI_KRETPROBE
:
654 if (event
->enabled
) {
658 switch (event
->priv
->instrumentation
) {
659 case LTTNG_KERNEL_ABI_TRACEPOINT
:
661 case LTTNG_KERNEL_ABI_SYSCALL
:
665 case LTTNG_KERNEL_ABI_KPROBE
:
667 case LTTNG_KERNEL_ABI_UPROBE
:
668 WRITE_ONCE(event
->enabled
, 1);
671 case LTTNG_KERNEL_ABI_KRETPROBE
:
672 ret
= lttng_kretprobes_event_enable_state(event
, 1);
675 case LTTNG_KERNEL_ABI_FUNCTION
:
677 case LTTNG_KERNEL_ABI_NOOP
:
684 mutex_unlock(&sessions_mutex
);
688 int lttng_event_disable(struct lttng_kernel_event_common
*event
)
692 mutex_lock(&sessions_mutex
);
693 switch (event
->type
) {
694 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
696 struct lttng_kernel_event_recorder
*event_recorder
=
697 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
699 if (event_recorder
->chan
->priv
->channel_type
== METADATA_CHANNEL
) {
705 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
706 switch (event
->priv
->instrumentation
) {
707 case LTTNG_KERNEL_ABI_KRETPROBE
:
718 if (!event
->enabled
) {
722 switch (event
->priv
->instrumentation
) {
723 case LTTNG_KERNEL_ABI_TRACEPOINT
:
725 case LTTNG_KERNEL_ABI_SYSCALL
:
729 case LTTNG_KERNEL_ABI_KPROBE
:
731 case LTTNG_KERNEL_ABI_UPROBE
:
732 WRITE_ONCE(event
->enabled
, 0);
735 case LTTNG_KERNEL_ABI_KRETPROBE
:
736 ret
= lttng_kretprobes_event_enable_state(event
, 0);
739 case LTTNG_KERNEL_ABI_FUNCTION
:
741 case LTTNG_KERNEL_ABI_NOOP
:
748 mutex_unlock(&sessions_mutex
);
752 struct lttng_kernel_channel_buffer
*lttng_channel_create(struct lttng_kernel_session
*session
,
753 const char *transport_name
,
755 size_t subbuf_size
, size_t num_subbuf
,
756 unsigned int switch_timer_interval
,
757 unsigned int read_timer_interval
,
758 enum channel_type channel_type
)
760 struct lttng_kernel_channel_buffer
*chan
;
761 struct lttng_kernel_channel_buffer_private
*chan_priv
;
762 struct lttng_transport
*transport
= NULL
;
764 mutex_lock(&sessions_mutex
);
765 if (session
->priv
->been_active
&& channel_type
!= METADATA_CHANNEL
)
766 goto active
; /* Refuse to add channel to active session */
767 transport
= lttng_transport_find(transport_name
);
769 printk(KERN_WARNING
"LTTng: transport %s not found\n",
773 if (!try_module_get(transport
->owner
)) {
774 printk(KERN_WARNING
"LTTng: Can't lock transport module.\n");
777 chan
= kzalloc(sizeof(struct lttng_kernel_channel_buffer
), GFP_KERNEL
);
780 chan_priv
= kzalloc(sizeof(struct lttng_kernel_channel_buffer_private
), GFP_KERNEL
);
783 chan
->priv
= chan_priv
;
784 chan_priv
->pub
= chan
;
785 chan
->parent
.type
= LTTNG_KERNEL_CHANNEL_TYPE_BUFFER
;
786 chan
->parent
.session
= session
;
787 chan
->priv
->id
= session
->priv
->free_chan_id
++;
788 chan
->ops
= &transport
->ops
;
790 * Note: the channel creation op already writes into the packet
791 * headers. Therefore the "chan" information used as input
792 * should be already accessible.
794 chan
->priv
->rb_chan
= transport
->ops
.priv
->channel_create(transport_name
,
795 chan
, buf_addr
, subbuf_size
, num_subbuf
,
796 switch_timer_interval
, read_timer_interval
);
797 if (!chan
->priv
->rb_chan
)
799 chan
->priv
->parent
.tstate
= 1;
800 chan
->parent
.enabled
= 1;
801 chan
->priv
->transport
= transport
;
802 chan
->priv
->channel_type
= channel_type
;
803 list_add(&chan
->priv
->node
, &session
->priv
->chan
);
804 mutex_unlock(&sessions_mutex
);
813 module_put(transport
->owner
);
816 mutex_unlock(&sessions_mutex
);
821 * Only used internally at session destruction for per-cpu channels, and
822 * when metadata channel is released.
823 * Needs to be called with sessions mutex held.
826 void _lttng_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
828 chan
->ops
->priv
->channel_destroy(chan
->priv
->rb_chan
);
829 module_put(chan
->priv
->transport
->owner
);
830 list_del(&chan
->priv
->node
);
831 lttng_kernel_destroy_context(chan
->priv
->ctx
);
836 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer
*chan
)
838 BUG_ON(chan
->priv
->channel_type
!= METADATA_CHANNEL
);
840 /* Protect the metadata cache with the sessions_mutex. */
841 mutex_lock(&sessions_mutex
);
842 _lttng_channel_destroy(chan
);
843 mutex_unlock(&sessions_mutex
);
845 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy
);
848 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
)
850 stream
->finalized
= 1;
851 wake_up_interruptible(&stream
->read_wait
);
856 * Supports event creation while tracing session is active.
857 * Needs to be called with sessions mutex held.
859 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_kernel_channel_buffer
*chan
,
860 struct lttng_kernel_abi_event
*event_param
,
861 const struct lttng_kernel_event_desc
*event_desc
,
862 enum lttng_kernel_abi_instrumentation itype
)
864 struct lttng_kernel_session
*session
= chan
->parent
.session
;
865 struct lttng_kernel_event_recorder
*event_recorder
;
866 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
867 const char *event_name
;
868 struct hlist_head
*head
;
871 if (chan
->priv
->free_event_id
== -1U) {
877 case LTTNG_KERNEL_ABI_TRACEPOINT
:
878 event_name
= event_desc
->event_name
;
881 case LTTNG_KERNEL_ABI_KPROBE
:
883 case LTTNG_KERNEL_ABI_UPROBE
:
885 case LTTNG_KERNEL_ABI_KRETPROBE
:
887 case LTTNG_KERNEL_ABI_SYSCALL
:
888 event_name
= event_param
->name
;
891 case LTTNG_KERNEL_ABI_FUNCTION
:
893 case LTTNG_KERNEL_ABI_NOOP
:
901 head
= utils_borrow_hash_table_bucket(session
->priv
->events_ht
.table
,
902 LTTNG_EVENT_HT_SIZE
, event_name
);
903 lttng_hlist_for_each_entry(event_recorder_priv
, head
, hlist
) {
904 WARN_ON_ONCE(!event_recorder_priv
->parent
.desc
);
905 if (!strncmp(event_recorder_priv
->parent
.desc
->event_name
, event_name
,
906 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
907 && chan
== event_recorder_priv
->pub
->chan
) {
913 event_recorder
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
914 if (!event_recorder
) {
918 event_recorder_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
919 if (!event_recorder_priv
) {
921 goto cache_private_error
;
923 event_recorder_priv
->pub
= event_recorder
;
924 event_recorder_priv
->parent
.pub
= &event_recorder
->parent
;
925 event_recorder
->priv
= event_recorder_priv
;
926 event_recorder
->parent
.priv
= &event_recorder_priv
->parent
;
927 event_recorder
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
929 event_recorder
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
930 event_recorder
->chan
= chan
;
931 event_recorder
->priv
->id
= chan
->priv
->free_event_id
++;
932 event_recorder
->priv
->parent
.instrumentation
= itype
;
933 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.filter_bytecode_runtime_head
);
934 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.enablers_ref_head
);
937 case LTTNG_KERNEL_ABI_TRACEPOINT
:
938 /* Event will be enabled by enabler sync. */
939 event_recorder
->parent
.enabled
= 0;
940 event_recorder
->priv
->parent
.registered
= 0;
941 event_recorder
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
942 if (!event_recorder
->priv
->parent
.desc
) {
946 /* Populate lttng_event structure before event registration. */
950 case LTTNG_KERNEL_ABI_KPROBE
:
952 * Needs to be explicitly enabled after creation, since
953 * we may want to apply filters.
955 event_recorder
->parent
.enabled
= 0;
956 event_recorder
->priv
->parent
.registered
= 1;
958 * Populate lttng_event structure before event
962 ret
= lttng_kprobes_register_event(event_name
,
963 event_param
->u
.kprobe
.symbol_name
,
964 event_param
->u
.kprobe
.offset
,
965 event_param
->u
.kprobe
.addr
,
971 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
975 case LTTNG_KERNEL_ABI_KRETPROBE
:
977 struct lttng_kernel_event_recorder
*event_recorder_return
;
978 struct lttng_kernel_event_recorder_private
*event_recorder_return_priv
;
980 /* kretprobe defines 2 events */
982 * Needs to be explicitly enabled after creation, since
983 * we may want to apply filters.
985 event_recorder
->parent
.enabled
= 0;
986 event_recorder
->priv
->parent
.registered
= 1;
988 event_recorder_return
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
989 if (!event_recorder_return
) {
993 event_recorder_return_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
994 if (!event_recorder_return_priv
) {
995 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
999 event_recorder_return_priv
->pub
= event_recorder_return
;
1000 event_recorder_return_priv
->parent
.pub
= &event_recorder_return
->parent
;
1001 event_recorder_return
->priv
= event_recorder_return_priv
;
1002 event_recorder_return
->parent
.priv
= &event_recorder_return_priv
->parent
;
1003 event_recorder_return
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
1005 event_recorder_return
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1006 event_recorder_return
->chan
= chan
;
1007 event_recorder_return
->priv
->id
= chan
->priv
->free_event_id
++;
1008 event_recorder_return
->priv
->parent
.instrumentation
= itype
;
1009 event_recorder_return
->parent
.enabled
= 0;
1010 event_recorder_return
->priv
->parent
.registered
= 1;
1011 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.filter_bytecode_runtime_head
);
1012 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.enablers_ref_head
);
1014 * Populate lttng_event structure before kretprobe registration.
1017 ret
= lttng_kretprobes_register(event_name
,
1018 event_param
->u
.kretprobe
.symbol_name
,
1019 event_param
->u
.kretprobe
.offset
,
1020 event_param
->u
.kretprobe
.addr
,
1021 event_recorder
, event_recorder_return
);
1023 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1024 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1026 goto register_error
;
1028 /* Take 2 refs on the module: one per event. */
1029 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1031 ret
= try_module_get(event_recorder_return
->priv
->parent
.desc
->owner
);
1033 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
,
1034 event_recorder_return
);
1035 WARN_ON_ONCE(ret
> 0);
1037 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1038 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1039 module_put(event_recorder_return
->priv
->parent
.desc
->owner
);
1040 module_put(event_recorder
->priv
->parent
.desc
->owner
);
1041 goto statedump_error
;
1043 list_add(&event_recorder_return
->priv
->node
, &chan
->parent
.session
->priv
->events
);
1047 case LTTNG_KERNEL_ABI_SYSCALL
:
1049 * Needs to be explicitly enabled after creation, since
1050 * we may want to apply filters.
1052 event_recorder
->parent
.enabled
= 0;
1053 event_recorder
->priv
->parent
.registered
= 0;
1054 event_recorder
->priv
->parent
.desc
= event_desc
;
1055 switch (event_param
->u
.syscall
.entryexit
) {
1056 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1058 goto register_error
;
1059 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1060 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1062 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1063 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1066 switch (event_param
->u
.syscall
.abi
) {
1067 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1069 goto register_error
;
1070 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1071 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1073 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1074 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1077 if (!event_recorder
->priv
->parent
.desc
) {
1079 goto register_error
;
1083 case LTTNG_KERNEL_ABI_UPROBE
:
1085 * Needs to be explicitly enabled after creation, since
1086 * we may want to apply filters.
1088 event_recorder
->parent
.enabled
= 0;
1089 event_recorder
->priv
->parent
.registered
= 1;
1092 * Populate lttng_event structure before event
1097 ret
= lttng_uprobes_register_event(event_param
->name
,
1098 event_param
->u
.uprobe
.fd
,
1101 goto register_error
;
1102 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1106 case LTTNG_KERNEL_ABI_FUNCTION
:
1108 case LTTNG_KERNEL_ABI_NOOP
:
1113 goto register_error
;
1115 ret
= _lttng_event_metadata_statedump(chan
->parent
.session
, chan
, event_recorder
);
1116 WARN_ON_ONCE(ret
> 0);
1118 goto statedump_error
;
1120 hlist_add_head(&event_recorder
->priv
->hlist
, head
);
1121 list_add(&event_recorder
->priv
->node
, &chan
->parent
.session
->priv
->events
);
1122 return event_recorder
;
1125 /* If a statedump error occurs, events will not be readable. */
1127 kmem_cache_free(event_recorder_private_cache
, event_recorder_priv
);
1128 cache_private_error
:
1129 kmem_cache_free(event_recorder_cache
, event_recorder
);
1134 return ERR_PTR(ret
);
1137 struct lttng_kernel_event_notifier
*_lttng_event_notifier_create(
1138 const struct lttng_kernel_event_desc
*event_desc
,
1139 uint64_t token
, uint64_t error_counter_index
,
1140 struct lttng_event_notifier_group
*event_notifier_group
,
1141 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1142 enum lttng_kernel_abi_instrumentation itype
)
1144 struct lttng_kernel_event_notifier
*event_notifier
;
1145 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
1146 struct lttng_counter
*error_counter
;
1147 const char *event_name
;
1148 struct hlist_head
*head
;
1152 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1153 event_name
= event_desc
->event_name
;
1156 case LTTNG_KERNEL_ABI_KPROBE
:
1158 case LTTNG_KERNEL_ABI_UPROBE
:
1160 case LTTNG_KERNEL_ABI_SYSCALL
:
1161 event_name
= event_notifier_param
->event
.name
;
1164 case LTTNG_KERNEL_ABI_KRETPROBE
:
1166 case LTTNG_KERNEL_ABI_FUNCTION
:
1168 case LTTNG_KERNEL_ABI_NOOP
:
1176 head
= utils_borrow_hash_table_bucket(event_notifier_group
->event_notifiers_ht
.table
,
1177 LTTNG_EVENT_NOTIFIER_HT_SIZE
, event_name
);
1178 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
1179 WARN_ON_ONCE(!event_notifier_priv
->parent
.desc
);
1180 if (!strncmp(event_notifier_priv
->parent
.desc
->event_name
, event_name
,
1181 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
1182 && event_notifier_group
== event_notifier_priv
->group
1183 && token
== event_notifier_priv
->parent
.user_token
) {
1189 event_notifier
= kmem_cache_zalloc(event_notifier_cache
, GFP_KERNEL
);
1190 if (!event_notifier
) {
1194 event_notifier_priv
= kmem_cache_zalloc(event_notifier_private_cache
, GFP_KERNEL
);
1195 if (!event_notifier_priv
) {
1197 goto cache_private_error
;
1199 event_notifier_priv
->pub
= event_notifier
;
1200 event_notifier_priv
->parent
.pub
= &event_notifier
->parent
;
1201 event_notifier
->priv
= event_notifier_priv
;
1202 event_notifier
->parent
.priv
= &event_notifier_priv
->parent
;
1203 event_notifier
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
;
1205 event_notifier
->priv
->group
= event_notifier_group
;
1206 event_notifier
->priv
->parent
.user_token
= token
;
1207 event_notifier
->priv
->error_counter_index
= error_counter_index
;
1208 event_notifier
->priv
->num_captures
= 0;
1209 event_notifier
->priv
->parent
.instrumentation
= itype
;
1210 event_notifier
->notification_send
= lttng_event_notifier_notification_send
;
1211 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.filter_bytecode_runtime_head
);
1212 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.enablers_ref_head
);
1213 INIT_LIST_HEAD(&event_notifier
->priv
->capture_bytecode_runtime_head
);
1214 event_notifier
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1217 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1218 /* Event will be enabled by enabler sync. */
1219 event_notifier
->parent
.enabled
= 0;
1220 event_notifier
->priv
->parent
.registered
= 0;
1221 event_notifier
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
1222 if (!event_notifier
->priv
->parent
.desc
) {
1224 goto register_error
;
1226 /* Populate lttng_event_notifier structure before event registration. */
1230 case LTTNG_KERNEL_ABI_KPROBE
:
1232 * Needs to be explicitly enabled after creation, since
1233 * we may want to apply filters.
1235 event_notifier
->parent
.enabled
= 0;
1236 event_notifier
->priv
->parent
.registered
= 1;
1238 * Populate lttng_event_notifier structure before event
1242 ret
= lttng_kprobes_register_event_notifier(
1243 event_notifier_param
->event
.u
.kprobe
.symbol_name
,
1244 event_notifier_param
->event
.u
.kprobe
.offset
,
1245 event_notifier_param
->event
.u
.kprobe
.addr
,
1249 goto register_error
;
1251 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1255 case LTTNG_KERNEL_ABI_SYSCALL
:
1257 * Needs to be explicitly enabled after creation, since
1258 * we may want to apply filters.
1260 event_notifier
->parent
.enabled
= 0;
1261 event_notifier
->priv
->parent
.registered
= 0;
1262 event_notifier
->priv
->parent
.desc
= event_desc
;
1263 switch (event_notifier_param
->event
.u
.syscall
.entryexit
) {
1264 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1266 goto register_error
;
1267 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1268 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1270 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1271 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1274 switch (event_notifier_param
->event
.u
.syscall
.abi
) {
1275 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1277 goto register_error
;
1278 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1279 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1281 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1282 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1286 if (!event_notifier
->priv
->parent
.desc
) {
1288 goto register_error
;
1292 case LTTNG_KERNEL_ABI_UPROBE
:
1294 * Needs to be explicitly enabled after creation, since
1295 * we may want to apply filters.
1297 event_notifier
->parent
.enabled
= 0;
1298 event_notifier
->priv
->parent
.registered
= 1;
1301 * Populate lttng_event_notifier structure before
1302 * event_notifier registration.
1306 ret
= lttng_uprobes_register_event_notifier(
1307 event_notifier_param
->event
.name
,
1308 event_notifier_param
->event
.u
.uprobe
.fd
,
1311 goto register_error
;
1312 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1316 case LTTNG_KERNEL_ABI_KRETPROBE
:
1318 case LTTNG_KERNEL_ABI_FUNCTION
:
1320 case LTTNG_KERNEL_ABI_NOOP
:
1325 goto register_error
;
1328 list_add(&event_notifier
->priv
->node
, &event_notifier_group
->event_notifiers_head
);
1329 hlist_add_head(&event_notifier
->priv
->hlist
, head
);
1332 * Clear the error counter bucket. The sessiond keeps track of which
1333 * bucket is currently in use. We trust it. The session lock
1334 * synchronizes against concurrent creation of the error
1337 error_counter
= event_notifier_group
->error_counter
;
1338 if (error_counter
) {
1339 size_t dimension_index
[1];
1342 * Check that the index is within the boundary of the counter.
1344 if (event_notifier
->priv
->error_counter_index
>= event_notifier_group
->error_counter_len
) {
1345 printk(KERN_INFO
"LTTng: event_notifier: Error counter index out-of-bound: counter-len=%zu, index=%llu\n",
1346 event_notifier_group
->error_counter_len
, event_notifier
->priv
->error_counter_index
);
1348 goto register_error
;
1351 dimension_index
[0] = event_notifier
->priv
->error_counter_index
;
1352 ret
= error_counter
->ops
->counter_clear(error_counter
->counter
, dimension_index
);
1354 printk(KERN_INFO
"LTTng: event_notifier: Unable to clear error counter bucket %llu\n",
1355 event_notifier
->priv
->error_counter_index
);
1356 goto register_error
;
1360 return event_notifier
;
1363 kmem_cache_free(event_notifier_private_cache
, event_notifier_priv
);
1364 cache_private_error
:
1365 kmem_cache_free(event_notifier_cache
, event_notifier
);
1369 return ERR_PTR(ret
);
1372 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1373 const size_t *dim_indexes
, int32_t cpu
,
1374 int64_t *val
, bool *overflow
, bool *underflow
)
1376 return counter
->ops
->counter_read(counter
->counter
, dim_indexes
,
1377 cpu
, val
, overflow
, underflow
);
1380 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1381 const size_t *dim_indexes
, int64_t *val
,
1382 bool *overflow
, bool *underflow
)
1384 return counter
->ops
->counter_aggregate(counter
->counter
, dim_indexes
,
1385 val
, overflow
, underflow
);
1388 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1389 const size_t *dim_indexes
)
1391 return counter
->ops
->counter_clear(counter
->counter
, dim_indexes
);
1394 struct lttng_kernel_event_recorder
*lttng_kernel_event_recorder_create(struct lttng_kernel_channel_buffer
*chan
,
1395 struct lttng_kernel_abi_event
*event_param
,
1396 const struct lttng_kernel_event_desc
*event_desc
,
1397 enum lttng_kernel_abi_instrumentation itype
)
1399 struct lttng_kernel_event_recorder
*event
;
1401 mutex_lock(&sessions_mutex
);
1402 event
= _lttng_kernel_event_recorder_create(chan
, event_param
, event_desc
, itype
);
1403 mutex_unlock(&sessions_mutex
);
1407 struct lttng_kernel_event_notifier
*lttng_event_notifier_create(
1408 const struct lttng_kernel_event_desc
*event_desc
,
1409 uint64_t id
, uint64_t error_counter_index
,
1410 struct lttng_event_notifier_group
*event_notifier_group
,
1411 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1412 enum lttng_kernel_abi_instrumentation itype
)
1414 struct lttng_kernel_event_notifier
*event_notifier
;
1416 mutex_lock(&sessions_mutex
);
1417 event_notifier
= _lttng_event_notifier_create(event_desc
, id
,
1418 error_counter_index
, event_notifier_group
,
1419 event_notifier_param
, itype
);
1420 mutex_unlock(&sessions_mutex
);
1421 return event_notifier
;
1424 /* Only used for tracepoints for now. */
1426 void register_event(struct lttng_kernel_event_recorder
*event_recorder
)
1428 const struct lttng_kernel_event_desc
*desc
;
1431 WARN_ON_ONCE(event_recorder
->priv
->parent
.registered
);
1433 desc
= event_recorder
->priv
->parent
.desc
;
1434 switch (event_recorder
->priv
->parent
.instrumentation
) {
1435 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1436 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1437 desc
->tp_class
->probe_callback
,
1441 case LTTNG_KERNEL_ABI_SYSCALL
:
1442 ret
= lttng_syscall_filter_enable_event(event_recorder
->chan
, event_recorder
);
1445 case LTTNG_KERNEL_ABI_KPROBE
:
1447 case LTTNG_KERNEL_ABI_UPROBE
:
1449 case LTTNG_KERNEL_ABI_KRETPROBE
:
1453 case LTTNG_KERNEL_ABI_FUNCTION
:
1455 case LTTNG_KERNEL_ABI_NOOP
:
1461 event_recorder
->priv
->parent
.registered
= 1;
1465 * Only used internally at session destruction.
1468 void unregister_event(struct lttng_kernel_event_recorder
*event_recorder
)
1470 struct lttng_kernel_event_common_private
*event_priv
= &event_recorder
->priv
->parent
;
1471 const struct lttng_kernel_event_desc
*desc
;
1474 WARN_ON_ONCE(!event_priv
->registered
);
1476 desc
= event_priv
->desc
;
1477 switch (event_priv
->instrumentation
) {
1478 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1479 ret
= lttng_wrapper_tracepoint_probe_unregister(event_priv
->desc
->event_kname
,
1480 event_priv
->desc
->tp_class
->probe_callback
,
1484 case LTTNG_KERNEL_ABI_KPROBE
:
1485 lttng_kprobes_unregister_event(event_recorder
);
1489 case LTTNG_KERNEL_ABI_KRETPROBE
:
1490 lttng_kretprobes_unregister(event_recorder
);
1494 case LTTNG_KERNEL_ABI_SYSCALL
:
1495 ret
= lttng_syscall_filter_disable_event(event_recorder
->chan
, event_recorder
);
1498 case LTTNG_KERNEL_ABI_NOOP
:
1502 case LTTNG_KERNEL_ABI_UPROBE
:
1503 lttng_uprobes_unregister_event(event_recorder
);
1507 case LTTNG_KERNEL_ABI_FUNCTION
:
1514 event_priv
->registered
= 0;
1518 void _lttng_event_unregister(struct lttng_kernel_event_recorder
*event_recorder
)
1520 if (event_recorder
->priv
->parent
.registered
)
1521 unregister_event(event_recorder
);
1524 /* Only used for tracepoints for now. */
1526 void register_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1528 const struct lttng_kernel_event_desc
*desc
;
1531 WARN_ON_ONCE(event_notifier
->priv
->parent
.registered
);
1533 desc
= event_notifier
->priv
->parent
.desc
;
1534 switch (event_notifier
->priv
->parent
.instrumentation
) {
1535 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1536 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1537 desc
->tp_class
->probe_callback
,
1541 case LTTNG_KERNEL_ABI_SYSCALL
:
1542 ret
= lttng_syscall_filter_enable_event_notifier(event_notifier
);
1545 case LTTNG_KERNEL_ABI_KPROBE
:
1547 case LTTNG_KERNEL_ABI_UPROBE
:
1551 case LTTNG_KERNEL_ABI_KRETPROBE
:
1553 case LTTNG_KERNEL_ABI_FUNCTION
:
1555 case LTTNG_KERNEL_ABI_NOOP
:
1561 event_notifier
->priv
->parent
.registered
= 1;
1565 int unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1567 const struct lttng_kernel_event_desc
*desc
;
1570 WARN_ON_ONCE(!event_notifier
->priv
->parent
.registered
);
1572 desc
= event_notifier
->priv
->parent
.desc
;
1573 switch (event_notifier
->priv
->parent
.instrumentation
) {
1574 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1575 ret
= lttng_wrapper_tracepoint_probe_unregister(event_notifier
->priv
->parent
.desc
->event_kname
,
1576 event_notifier
->priv
->parent
.desc
->tp_class
->probe_callback
,
1580 case LTTNG_KERNEL_ABI_KPROBE
:
1581 lttng_kprobes_unregister_event_notifier(event_notifier
);
1585 case LTTNG_KERNEL_ABI_UPROBE
:
1586 lttng_uprobes_unregister_event_notifier(event_notifier
);
1590 case LTTNG_KERNEL_ABI_SYSCALL
:
1591 ret
= lttng_syscall_filter_disable_event_notifier(event_notifier
);
1594 case LTTNG_KERNEL_ABI_KRETPROBE
:
1596 case LTTNG_KERNEL_ABI_FUNCTION
:
1598 case LTTNG_KERNEL_ABI_NOOP
:
1604 event_notifier
->priv
->parent
.registered
= 0;
1609 void _lttng_event_notifier_unregister(struct lttng_kernel_event_notifier
*event_notifier
)
1611 if (event_notifier
->priv
->parent
.registered
)
1612 unregister_event_notifier(event_notifier
);
1616 * Only used internally at session destruction.
1619 void _lttng_event_destroy(struct lttng_kernel_event_common
*event
)
1621 struct lttng_kernel_event_common_private
*event_priv
= event
->priv
;
1622 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1624 lttng_free_event_filter_runtime(event
);
1625 /* Free event enabler refs */
1626 list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1627 &event_priv
->enablers_ref_head
, node
)
1630 switch (event
->type
) {
1631 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1633 struct lttng_kernel_event_recorder
*event_recorder
=
1634 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
1636 switch (event_priv
->instrumentation
) {
1637 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1638 lttng_event_desc_put(event_priv
->desc
);
1641 case LTTNG_KERNEL_ABI_KPROBE
:
1642 module_put(event_priv
->desc
->owner
);
1643 lttng_kprobes_destroy_event_private(event_recorder
);
1646 case LTTNG_KERNEL_ABI_KRETPROBE
:
1647 module_put(event_priv
->desc
->owner
);
1648 lttng_kretprobes_destroy_private(event_recorder
);
1651 case LTTNG_KERNEL_ABI_SYSCALL
:
1654 case LTTNG_KERNEL_ABI_UPROBE
:
1655 module_put(event_priv
->desc
->owner
);
1656 lttng_uprobes_destroy_event_private(event_recorder
);
1659 case LTTNG_KERNEL_ABI_FUNCTION
:
1661 case LTTNG_KERNEL_ABI_NOOP
:
1666 list_del(&event_recorder
->priv
->node
);
1667 kmem_cache_free(event_recorder_private_cache
, event_recorder
->priv
);
1668 kmem_cache_free(event_recorder_cache
, event_recorder
);
1671 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1673 struct lttng_kernel_event_notifier
*event_notifier
=
1674 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
1676 switch (event_notifier
->priv
->parent
.instrumentation
) {
1677 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1678 lttng_event_desc_put(event_notifier
->priv
->parent
.desc
);
1681 case LTTNG_KERNEL_ABI_KPROBE
:
1682 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1683 lttng_kprobes_destroy_event_notifier_private(event_notifier
);
1686 case LTTNG_KERNEL_ABI_SYSCALL
:
1689 case LTTNG_KERNEL_ABI_UPROBE
:
1690 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1691 lttng_uprobes_destroy_event_notifier_private(event_notifier
);
1694 case LTTNG_KERNEL_ABI_KRETPROBE
:
1696 case LTTNG_KERNEL_ABI_FUNCTION
:
1698 case LTTNG_KERNEL_ABI_NOOP
:
1703 list_del(&event_notifier
->priv
->node
);
1704 kmem_cache_free(event_notifier_private_cache
, event_notifier
->priv
);
1705 kmem_cache_free(event_notifier_cache
, event_notifier
);
1713 struct lttng_kernel_id_tracker
*get_tracker(struct lttng_kernel_session
*session
,
1714 enum tracker_type tracker_type
)
1716 switch (tracker_type
) {
1718 return &session
->pid_tracker
;
1720 return &session
->vpid_tracker
;
1722 return &session
->uid_tracker
;
1724 return &session
->vuid_tracker
;
1726 return &session
->gid_tracker
;
1728 return &session
->vgid_tracker
;
1735 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1736 enum tracker_type tracker_type
, int id
)
1738 struct lttng_kernel_id_tracker
*tracker
;
1741 tracker
= get_tracker(session
, tracker_type
);
1746 mutex_lock(&sessions_mutex
);
1748 /* track all ids: destroy tracker. */
1749 lttng_id_tracker_destroy(tracker
, true);
1752 ret
= lttng_id_tracker_add(tracker
, id
);
1754 mutex_unlock(&sessions_mutex
);
1758 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1759 enum tracker_type tracker_type
, int id
)
1761 struct lttng_kernel_id_tracker
*tracker
;
1764 tracker
= get_tracker(session
, tracker_type
);
1769 mutex_lock(&sessions_mutex
);
1771 /* untrack all ids: replace by empty tracker. */
1772 ret
= lttng_id_tracker_empty_set(tracker
);
1774 ret
= lttng_id_tracker_del(tracker
, id
);
1776 mutex_unlock(&sessions_mutex
);
1781 void *id_list_start(struct seq_file
*m
, loff_t
*pos
)
1783 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1784 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1785 struct lttng_id_hash_node
*e
;
1788 mutex_lock(&sessions_mutex
);
1790 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1791 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1793 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1799 /* ID tracker disabled. */
1800 if (iter
>= *pos
&& iter
== 0) {
1801 return id_tracker_p
; /* empty tracker */
1809 /* Called with sessions_mutex held. */
1811 void *id_list_next(struct seq_file
*m
, void *p
, loff_t
*ppos
)
1813 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1814 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1815 struct lttng_id_hash_node
*e
;
1820 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1821 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1823 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1824 if (iter
++ >= *ppos
)
1829 /* ID tracker disabled. */
1830 if (iter
>= *ppos
&& iter
== 0)
1831 return p
; /* empty tracker */
1840 void id_list_stop(struct seq_file
*m
, void *p
)
1842 mutex_unlock(&sessions_mutex
);
1846 int id_list_show(struct seq_file
*m
, void *p
)
1848 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1849 struct lttng_kernel_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1852 if (p
== id_tracker_p
) {
1853 /* Tracker disabled. */
1856 const struct lttng_id_hash_node
*e
= p
;
1858 id
= lttng_id_tracker_get_node_id(e
);
1860 switch (id_tracker
->priv
->tracker_type
) {
1862 seq_printf(m
, "process { pid = %d; };\n", id
);
1865 seq_printf(m
, "process { vpid = %d; };\n", id
);
1868 seq_printf(m
, "user { uid = %d; };\n", id
);
1871 seq_printf(m
, "user { vuid = %d; };\n", id
);
1874 seq_printf(m
, "group { gid = %d; };\n", id
);
1877 seq_printf(m
, "group { vgid = %d; };\n", id
);
1880 seq_printf(m
, "UNKNOWN { field = %d };\n", id
);
1886 const struct seq_operations lttng_tracker_ids_list_seq_ops
= {
1887 .start
= id_list_start
,
1888 .next
= id_list_next
,
1889 .stop
= id_list_stop
,
1890 .show
= id_list_show
,
1894 int lttng_tracker_ids_list_open(struct inode
*inode
, struct file
*file
)
1896 return seq_open(file
, <tng_tracker_ids_list_seq_ops
);
1900 int lttng_tracker_ids_list_release(struct inode
*inode
, struct file
*file
)
1902 struct seq_file
*m
= file
->private_data
;
1903 struct lttng_kernel_id_tracker
*id_tracker
= m
->private;
1906 WARN_ON_ONCE(!id_tracker
);
1907 ret
= seq_release(inode
, file
);
1909 fput(id_tracker
->priv
->session
->priv
->file
);
1913 const struct file_operations lttng_tracker_ids_list_fops
= {
1914 .owner
= THIS_MODULE
,
1915 .open
= lttng_tracker_ids_list_open
,
1917 .llseek
= seq_lseek
,
1918 .release
= lttng_tracker_ids_list_release
,
1921 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1922 enum tracker_type tracker_type
)
1924 struct file
*tracker_ids_list_file
;
1928 file_fd
= lttng_get_unused_fd();
1934 tracker_ids_list_file
= anon_inode_getfile("[lttng_tracker_ids_list]",
1935 <tng_tracker_ids_list_fops
,
1937 if (IS_ERR(tracker_ids_list_file
)) {
1938 ret
= PTR_ERR(tracker_ids_list_file
);
1941 if (!atomic_long_add_unless(&session
->priv
->file
->f_count
, 1, LONG_MAX
)) {
1943 goto refcount_error
;
1945 ret
= lttng_tracker_ids_list_fops
.open(NULL
, tracker_ids_list_file
);
1948 m
= tracker_ids_list_file
->private_data
;
1950 m
->private = get_tracker(session
, tracker_type
);
1951 BUG_ON(!m
->private);
1952 fd_install(file_fd
, tracker_ids_list_file
);
1957 atomic_long_dec(&session
->priv
->file
->f_count
);
1959 fput(tracker_ids_list_file
);
1961 put_unused_fd(file_fd
);
1967 * Enabler management.
1970 int lttng_match_enabler_star_glob(const char *desc_name
,
1971 const char *pattern
)
1973 if (!strutils_star_glob_match(pattern
, LTTNG_SIZE_MAX
,
1974 desc_name
, LTTNG_SIZE_MAX
))
1980 int lttng_match_enabler_name(const char *desc_name
,
1983 if (strcmp(desc_name
, name
))
1988 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
1989 struct lttng_enabler
*enabler
)
1991 const char *desc_name
, *enabler_name
;
1992 bool compat
= false, entry
= false;
1994 enabler_name
= enabler
->event_param
.name
;
1995 switch (enabler
->event_param
.instrumentation
) {
1996 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1997 desc_name
= desc
->event_name
;
1998 switch (enabler
->format_type
) {
1999 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
2000 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
2001 case LTTNG_ENABLER_FORMAT_NAME
:
2002 return lttng_match_enabler_name(desc_name
, enabler_name
);
2008 case LTTNG_KERNEL_ABI_SYSCALL
:
2009 desc_name
= desc
->event_name
;
2010 if (!strncmp(desc_name
, "compat_", strlen("compat_"))) {
2011 desc_name
+= strlen("compat_");
2014 if (!strncmp(desc_name
, "syscall_exit_",
2015 strlen("syscall_exit_"))) {
2016 desc_name
+= strlen("syscall_exit_");
2017 } else if (!strncmp(desc_name
, "syscall_entry_",
2018 strlen("syscall_entry_"))) {
2019 desc_name
+= strlen("syscall_entry_");
2025 switch (enabler
->event_param
.u
.syscall
.entryexit
) {
2026 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
2028 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
2032 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
2039 switch (enabler
->event_param
.u
.syscall
.abi
) {
2040 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
2042 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
2046 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
2053 switch (enabler
->event_param
.u
.syscall
.match
) {
2054 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
:
2055 switch (enabler
->format_type
) {
2056 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
2057 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
2058 case LTTNG_ENABLER_FORMAT_NAME
:
2059 return lttng_match_enabler_name(desc_name
, enabler_name
);
2064 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR
:
2065 return -EINVAL
; /* Not implemented. */
2078 int lttng_event_enabler_match_event(struct lttng_event_enabler
*event_enabler
,
2079 struct lttng_kernel_event_recorder
*event_recorder
)
2081 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(
2084 if (base_enabler
->event_param
.instrumentation
!= event_recorder
->priv
->parent
.instrumentation
)
2086 if (lttng_desc_match_enabler(event_recorder
->priv
->parent
.desc
, base_enabler
)
2087 && event_recorder
->chan
== event_enabler
->chan
)
2094 int lttng_event_notifier_enabler_match_event_notifier(struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2095 struct lttng_kernel_event_notifier
*event_notifier
)
2097 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(
2098 event_notifier_enabler
);
2100 if (base_enabler
->event_param
.instrumentation
!= event_notifier
->priv
->parent
.instrumentation
)
2102 if (lttng_desc_match_enabler(event_notifier
->priv
->parent
.desc
, base_enabler
)
2103 && event_notifier
->priv
->group
== event_notifier_enabler
->group
2104 && event_notifier
->priv
->parent
.user_token
== event_notifier_enabler
->base
.user_token
)
2111 struct lttng_enabler_ref
*lttng_enabler_ref(
2112 struct list_head
*enablers_ref_list
,
2113 struct lttng_enabler
*enabler
)
2115 struct lttng_enabler_ref
*enabler_ref
;
2117 list_for_each_entry(enabler_ref
, enablers_ref_list
, node
) {
2118 if (enabler_ref
->ref
== enabler
)
2125 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2127 struct lttng_kernel_session
*session
= event_enabler
->chan
->parent
.session
;
2128 struct lttng_kernel_probe_desc
*probe_desc
;
2129 const struct lttng_kernel_event_desc
*desc
;
2131 struct list_head
*probe_list
;
2133 probe_list
= lttng_get_probe_list_head();
2135 * For each probe event, if we find that a probe event matches
2136 * our enabler, create an associated lttng_event if not
2139 list_for_each_entry(probe_desc
, probe_list
, head
) {
2140 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2142 struct hlist_head
*head
;
2143 struct lttng_kernel_event_recorder_private
*event_recorder_private
;
2144 struct lttng_kernel_event_recorder
*event_recorder
;
2146 desc
= probe_desc
->event_desc
[i
];
2147 if (!lttng_desc_match_enabler(desc
,
2148 lttng_event_enabler_as_enabler(event_enabler
)))
2152 * Check if already created.
2154 head
= utils_borrow_hash_table_bucket(
2155 session
->priv
->events_ht
.table
, LTTNG_EVENT_HT_SIZE
,
2157 lttng_hlist_for_each_entry(event_recorder_private
, head
, hlist
) {
2158 if (event_recorder_private
->parent
.desc
== desc
2159 && event_recorder_private
->pub
->chan
== event_enabler
->chan
)
2166 * We need to create an event for this
2169 event_recorder
= _lttng_kernel_event_recorder_create(event_enabler
->chan
,
2170 NULL
, desc
, LTTNG_KERNEL_ABI_TRACEPOINT
);
2171 if (!event_recorder
) {
2172 printk(KERN_INFO
"LTTng: Unable to create event %s\n",
2173 probe_desc
->event_desc
[i
]->event_name
);
2180 void lttng_create_tracepoint_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2182 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2183 struct lttng_kernel_probe_desc
*probe_desc
;
2184 const struct lttng_kernel_event_desc
*desc
;
2186 struct list_head
*probe_list
;
2188 probe_list
= lttng_get_probe_list_head();
2190 * For each probe event, if we find that a probe event matches
2191 * our enabler, create an associated lttng_event_notifier if not
2194 list_for_each_entry(probe_desc
, probe_list
, head
) {
2195 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2197 struct hlist_head
*head
;
2198 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2199 struct lttng_kernel_event_notifier
*event_notifier
;
2201 desc
= probe_desc
->event_desc
[i
];
2202 if (!lttng_desc_match_enabler(desc
,
2203 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)))
2207 * Check if already created.
2209 head
= utils_borrow_hash_table_bucket(
2210 event_notifier_group
->event_notifiers_ht
.table
,
2211 LTTNG_EVENT_NOTIFIER_HT_SIZE
, desc
->event_name
);
2212 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
2213 if (event_notifier_priv
->parent
.desc
== desc
2214 && event_notifier_priv
->parent
.user_token
== event_notifier_enabler
->base
.user_token
)
2221 * We need to create a event_notifier for this event probe.
2223 event_notifier
= _lttng_event_notifier_create(desc
,
2224 event_notifier_enabler
->base
.user_token
,
2225 event_notifier_enabler
->error_counter_index
,
2226 event_notifier_group
, NULL
,
2227 LTTNG_KERNEL_ABI_TRACEPOINT
);
2228 if (IS_ERR(event_notifier
)) {
2229 printk(KERN_INFO
"Unable to create event_notifier %s\n",
2230 probe_desc
->event_desc
[i
]->event_name
);
2237 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2241 ret
= lttng_syscalls_register_event(event_enabler
);
2246 void lttng_create_syscall_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2250 ret
= lttng_syscalls_register_event_notifier(event_notifier_enabler
);
2252 ret
= lttng_syscalls_create_matching_event_notifiers(event_notifier_enabler
);
2257 * Create struct lttng_kernel_event_recorder if it is missing and present in the list of
2258 * tracepoint probes.
2259 * Should be called with sessions mutex held.
2262 void lttng_create_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2264 switch (event_enabler
->base
.event_param
.instrumentation
) {
2265 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2266 lttng_create_tracepoint_event_if_missing(event_enabler
);
2269 case LTTNG_KERNEL_ABI_SYSCALL
:
2270 lttng_create_syscall_event_if_missing(event_enabler
);
2280 * Create events associated with an event_enabler (if not already present),
2281 * and add backward reference from the event to the enabler.
2282 * Should be called with sessions mutex held.
2285 int lttng_event_enabler_ref_events(struct lttng_event_enabler
*event_enabler
)
2287 struct lttng_kernel_channel_buffer
*chan
= event_enabler
->chan
;
2288 struct lttng_kernel_session
*session
= event_enabler
->chan
->parent
.session
;
2289 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(event_enabler
);
2290 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2292 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2293 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2294 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2295 !strcmp(base_enabler
->event_param
.name
, "*")) {
2296 int enabled
= base_enabler
->enabled
;
2297 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2299 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2300 WRITE_ONCE(chan
->priv
->parent
.syscall_all_entry
, enabled
);
2302 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2303 WRITE_ONCE(chan
->priv
->parent
.syscall_all_exit
, enabled
);
2306 /* First ensure that probe events are created for this enabler. */
2307 lttng_create_event_if_missing(event_enabler
);
2309 /* For each event matching event_enabler in session event list. */
2310 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2311 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2312 struct lttng_enabler_ref
*enabler_ref
;
2314 if (!lttng_event_enabler_match_event(event_enabler
, event_recorder
))
2316 enabler_ref
= lttng_enabler_ref(&event_recorder_priv
->parent
.enablers_ref_head
,
2317 lttng_event_enabler_as_enabler(event_enabler
));
2320 * If no backward ref, create it.
2321 * Add backward ref from event to event_enabler.
2323 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2326 enabler_ref
->ref
= lttng_event_enabler_as_enabler(event_enabler
);
2327 list_add(&enabler_ref
->node
,
2328 &event_recorder_priv
->parent
.enablers_ref_head
);
2332 * Link filter bytecodes if not linked yet.
2334 lttng_enabler_link_bytecode(event_recorder_priv
->parent
.desc
,
2336 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
,
2337 <tng_event_enabler_as_enabler(event_enabler
)->filter_bytecode_head
);
2343 * Create struct lttng_kernel_event_notifier if it is missing and present in the list of
2344 * tracepoint probes.
2345 * Should be called with sessions mutex held.
2348 void lttng_create_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2350 switch (event_notifier_enabler
->base
.event_param
.instrumentation
) {
2351 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2352 lttng_create_tracepoint_event_notifier_if_missing(event_notifier_enabler
);
2355 case LTTNG_KERNEL_ABI_SYSCALL
:
2356 lttng_create_syscall_event_notifier_if_missing(event_notifier_enabler
);
2366 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2369 int lttng_event_notifier_enabler_ref_event_notifiers(
2370 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2372 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2373 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2374 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2376 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2377 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2378 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2379 !strcmp(base_enabler
->event_param
.name
, "*")) {
2381 int enabled
= base_enabler
->enabled
;
2382 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2384 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2385 WRITE_ONCE(event_notifier_group
->syscall_all_entry
, enabled
);
2387 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2388 WRITE_ONCE(event_notifier_group
->syscall_all_exit
, enabled
);
2392 /* First ensure that probe event_notifiers are created for this enabler. */
2393 lttng_create_event_notifier_if_missing(event_notifier_enabler
);
2395 /* Link the created event_notifier with its associated enabler. */
2396 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2397 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2398 struct lttng_enabler_ref
*enabler_ref
;
2400 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler
, event_notifier
))
2403 enabler_ref
= lttng_enabler_ref(&event_notifier_priv
->parent
.enablers_ref_head
,
2404 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2407 * If no backward ref, create it.
2408 * Add backward ref from event_notifier to enabler.
2410 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2414 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2415 event_notifier_enabler
);
2416 list_add(&enabler_ref
->node
,
2417 &event_notifier_priv
->parent
.enablers_ref_head
);
2421 * Link filter bytecodes if not linked yet.
2423 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2424 lttng_static_ctx
, &event_notifier_priv
->parent
.filter_bytecode_runtime_head
,
2425 <tng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->filter_bytecode_head
);
2427 /* Link capture bytecodes if not linked yet. */
2428 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2429 lttng_static_ctx
, &event_notifier_priv
->capture_bytecode_runtime_head
,
2430 &event_notifier_enabler
->capture_bytecode_head
);
2432 event_notifier_priv
->num_captures
= event_notifier_enabler
->num_captures
;
2438 * Called at module load: connect the probe on all enablers matching
2440 * Called with sessions lock held.
2442 int lttng_fix_pending_events(void)
2444 struct lttng_kernel_session_private
*session_priv
;
2446 list_for_each_entry(session_priv
, &sessions
, list
)
2447 lttng_session_lazy_sync_event_enablers(session_priv
->pub
);
2451 static bool lttng_event_notifier_group_has_active_event_notifiers(
2452 struct lttng_event_notifier_group
*event_notifier_group
)
2454 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2456 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
,
2458 if (event_notifier_enabler
->base
.enabled
)
2464 bool lttng_event_notifier_active(void)
2466 struct lttng_event_notifier_group
*event_notifier_group
;
2468 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2469 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group
))
2475 int lttng_fix_pending_event_notifiers(void)
2477 struct lttng_event_notifier_group
*event_notifier_group
;
2479 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
)
2480 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
2484 struct lttng_event_enabler
*lttng_event_enabler_create(
2485 enum lttng_enabler_format_type format_type
,
2486 struct lttng_kernel_abi_event
*event_param
,
2487 struct lttng_kernel_channel_buffer
*chan
)
2489 struct lttng_event_enabler
*event_enabler
;
2491 event_enabler
= kzalloc(sizeof(*event_enabler
), GFP_KERNEL
);
2494 event_enabler
->base
.format_type
= format_type
;
2495 INIT_LIST_HEAD(&event_enabler
->base
.filter_bytecode_head
);
2496 memcpy(&event_enabler
->base
.event_param
, event_param
,
2497 sizeof(event_enabler
->base
.event_param
));
2498 event_enabler
->chan
= chan
;
2500 event_enabler
->base
.enabled
= 0;
2501 mutex_lock(&sessions_mutex
);
2502 list_add(&event_enabler
->node
, &event_enabler
->chan
->parent
.session
->priv
->enablers_head
);
2503 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2504 mutex_unlock(&sessions_mutex
);
2505 return event_enabler
;
2508 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
)
2510 mutex_lock(&sessions_mutex
);
2511 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 1;
2512 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2513 mutex_unlock(&sessions_mutex
);
2517 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
)
2519 mutex_lock(&sessions_mutex
);
2520 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 0;
2521 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2522 mutex_unlock(&sessions_mutex
);
2527 int lttng_enabler_attach_filter_bytecode(struct lttng_enabler
*enabler
,
2528 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2530 struct lttng_kernel_bytecode_node
*bytecode_node
;
2531 uint32_t bytecode_len
;
2534 ret
= get_user(bytecode_len
, &bytecode
->len
);
2537 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2541 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2542 sizeof(*bytecode
) + bytecode_len
);
2546 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_FILTER
;
2547 bytecode_node
->enabler
= enabler
;
2548 /* Enforce length based on allocated size */
2549 bytecode_node
->bc
.len
= bytecode_len
;
2550 list_add_tail(&bytecode_node
->node
, &enabler
->filter_bytecode_head
);
2555 lttng_kvfree(bytecode_node
);
2559 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
2560 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2563 ret
= lttng_enabler_attach_filter_bytecode(
2564 lttng_event_enabler_as_enabler(event_enabler
), bytecode
);
2568 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->parent
.session
);
2575 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
2576 struct lttng_kernel_abi_event_callsite __user
*callsite
)
2579 switch (event
->priv
->instrumentation
) {
2580 case LTTNG_KERNEL_ABI_UPROBE
:
2581 return lttng_uprobes_event_add_callsite(event
, callsite
);
2588 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
2590 struct lttng_kernel_bytecode_node
*filter_node
, *tmp_filter_node
;
2592 /* Destroy filter bytecode */
2593 list_for_each_entry_safe(filter_node
, tmp_filter_node
,
2594 &enabler
->filter_bytecode_head
, node
) {
2595 lttng_kvfree(filter_node
);
2600 void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
)
2602 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler
));
2604 list_del(&event_enabler
->node
);
2605 kfree(event_enabler
);
2608 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
2609 struct lttng_event_notifier_group
*event_notifier_group
,
2610 enum lttng_enabler_format_type format_type
,
2611 struct lttng_kernel_abi_event_notifier
*event_notifier_param
)
2613 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2615 event_notifier_enabler
= kzalloc(sizeof(*event_notifier_enabler
), GFP_KERNEL
);
2616 if (!event_notifier_enabler
)
2619 event_notifier_enabler
->base
.format_type
= format_type
;
2620 INIT_LIST_HEAD(&event_notifier_enabler
->base
.filter_bytecode_head
);
2621 INIT_LIST_HEAD(&event_notifier_enabler
->capture_bytecode_head
);
2623 event_notifier_enabler
->error_counter_index
= event_notifier_param
->error_counter_index
;
2624 event_notifier_enabler
->num_captures
= 0;
2626 memcpy(&event_notifier_enabler
->base
.event_param
, &event_notifier_param
->event
,
2627 sizeof(event_notifier_enabler
->base
.event_param
));
2629 event_notifier_enabler
->base
.enabled
= 0;
2630 event_notifier_enabler
->base
.user_token
= event_notifier_param
->event
.token
;
2631 event_notifier_enabler
->group
= event_notifier_group
;
2633 mutex_lock(&sessions_mutex
);
2634 list_add(&event_notifier_enabler
->node
, &event_notifier_enabler
->group
->enablers_head
);
2635 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2637 mutex_unlock(&sessions_mutex
);
2639 return event_notifier_enabler
;
2642 int lttng_event_notifier_enabler_enable(
2643 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2645 mutex_lock(&sessions_mutex
);
2646 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
2647 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2648 mutex_unlock(&sessions_mutex
);
2652 int lttng_event_notifier_enabler_disable(
2653 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2655 mutex_lock(&sessions_mutex
);
2656 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
2657 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2658 mutex_unlock(&sessions_mutex
);
2662 int lttng_event_notifier_enabler_attach_filter_bytecode(
2663 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2664 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2668 ret
= lttng_enabler_attach_filter_bytecode(
2669 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
2674 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2681 int lttng_event_notifier_enabler_attach_capture_bytecode(
2682 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2683 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
)
2685 struct lttng_kernel_bytecode_node
*bytecode_node
;
2686 struct lttng_enabler
*enabler
=
2687 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2688 uint32_t bytecode_len
;
2691 ret
= get_user(bytecode_len
, &bytecode
->len
);
2695 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2700 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2701 sizeof(*bytecode
) + bytecode_len
);
2705 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
;
2706 bytecode_node
->enabler
= enabler
;
2708 /* Enforce length based on allocated size */
2709 bytecode_node
->bc
.len
= bytecode_len
;
2710 list_add_tail(&bytecode_node
->node
, &event_notifier_enabler
->capture_bytecode_head
);
2712 event_notifier_enabler
->num_captures
++;
2714 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2718 lttng_kvfree(bytecode_node
);
2724 void lttng_event_notifier_enabler_destroy(
2725 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2727 if (!event_notifier_enabler
) {
2731 list_del(&event_notifier_enabler
->node
);
2733 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2734 kfree(event_notifier_enabler
);
2738 * lttng_session_sync_event_enablers should be called just before starting a
2740 * Should be called with sessions mutex held.
2743 void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
)
2745 struct lttng_event_enabler
*event_enabler
;
2746 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2748 list_for_each_entry(event_enabler
, &session
->priv
->enablers_head
, node
)
2749 lttng_event_enabler_ref_events(event_enabler
);
2751 * For each event, if at least one of its enablers is enabled,
2752 * and its channel and session transient states are enabled, we
2753 * enable the event, else we disable it.
2755 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2756 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2757 struct lttng_enabler_ref
*enabler_ref
;
2758 struct lttng_kernel_bytecode_runtime
*runtime
;
2759 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2762 switch (event_recorder_priv
->parent
.instrumentation
) {
2763 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2765 case LTTNG_KERNEL_ABI_SYSCALL
:
2767 list_for_each_entry(enabler_ref
,
2768 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2769 if (enabler_ref
->ref
->enabled
) {
2777 /* Not handled with lazy sync. */
2781 * Enabled state is based on union of enablers, with
2782 * intesection of session and channel transient enable
2785 enabled
= enabled
&& session
->priv
->tstate
&& event_recorder
->chan
->priv
->parent
.tstate
;
2787 WRITE_ONCE(event_recorder
->parent
.enabled
, enabled
);
2789 * Sync tracepoint registration with event enabled
2793 if (!event_recorder_priv
->parent
.registered
)
2794 register_event(event_recorder
);
2796 if (event_recorder_priv
->parent
.registered
)
2797 _lttng_event_unregister(event_recorder
);
2800 /* Check if has enablers without bytecode enabled */
2801 list_for_each_entry(enabler_ref
,
2802 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2803 if (enabler_ref
->ref
->enabled
2804 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2805 has_enablers_without_filter_bytecode
= 1;
2809 event_recorder_priv
->parent
.has_enablers_without_filter_bytecode
=
2810 has_enablers_without_filter_bytecode
;
2812 /* Enable filters */
2813 list_for_each_entry(runtime
,
2814 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2815 lttng_bytecode_sync_state(runtime
);
2818 WRITE_ONCE(event_recorder_priv
->parent
.pub
->eval_filter
,
2819 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2824 * Apply enablers to session events, adding events to session if need
2825 * be. It is required after each modification applied to an active
2826 * session, and right before session "start".
2827 * "lazy" sync means we only sync if required.
2828 * Should be called with sessions mutex held.
2831 void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
)
2833 /* We can skip if session is not active */
2834 if (!session
->active
)
2836 lttng_session_sync_event_enablers(session
);
2840 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2842 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2843 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2845 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2846 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2849 * For each event_notifier, if at least one of its enablers is enabled,
2850 * we enable the event_notifier, else we disable it.
2852 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2853 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2854 struct lttng_enabler_ref
*enabler_ref
;
2855 struct lttng_kernel_bytecode_runtime
*runtime
;
2856 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2857 int nr_filters
= 0, nr_captures
= 0;
2859 switch (event_notifier_priv
->parent
.instrumentation
) {
2860 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2862 case LTTNG_KERNEL_ABI_SYSCALL
:
2863 /* Enable event_notifiers */
2864 list_for_each_entry(enabler_ref
,
2865 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2866 if (enabler_ref
->ref
->enabled
) {
2874 /* Not handled with sync. */
2878 WRITE_ONCE(event_notifier
->parent
.enabled
, enabled
);
2880 * Sync tracepoint registration with event_notifier enabled
2884 if (!event_notifier_priv
->parent
.registered
)
2885 register_event_notifier(event_notifier
);
2887 if (event_notifier_priv
->parent
.registered
)
2888 unregister_event_notifier(event_notifier
);
2891 /* Check if has enablers without bytecode enabled */
2892 list_for_each_entry(enabler_ref
,
2893 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2894 if (enabler_ref
->ref
->enabled
2895 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2896 has_enablers_without_filter_bytecode
= 1;
2900 event_notifier_priv
->parent
.has_enablers_without_filter_bytecode
=
2901 has_enablers_without_filter_bytecode
;
2903 /* Enable filters */
2904 list_for_each_entry(runtime
,
2905 &event_notifier_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2906 lttng_bytecode_sync_state(runtime
);
2909 WRITE_ONCE(event_notifier_priv
->parent
.pub
->eval_filter
,
2910 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2912 /* Enable captures */
2913 list_for_each_entry(runtime
,
2914 &event_notifier_priv
->capture_bytecode_runtime_head
, node
) {
2915 lttng_bytecode_sync_state(runtime
);
2918 WRITE_ONCE(event_notifier
->eval_capture
, !!nr_captures
);
2923 * Serialize at most one packet worth of metadata into a metadata
2925 * We grab the metadata cache mutex to get exclusive access to our metadata
2926 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2927 * allows us to do racy operations such as looking for remaining space left in
2928 * packet and write, since mutual exclusion protects us from concurrent writes.
2929 * Mutual exclusion on the metadata cache allow us to read the cache content
2930 * without racing against reallocation of the cache by updates.
2931 * Returns the number of bytes written in the channel, 0 if no data
2932 * was written and a negative value on error.
2934 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
2935 struct lttng_kernel_ring_buffer_channel
*chan
, bool *coherent
)
2937 struct lttng_kernel_ring_buffer_ctx ctx
;
2939 size_t len
, reserve_len
;
2942 * Ensure we support mutiple get_next / put sequences followed by
2943 * put_next. The metadata cache lock protects reading the metadata
2944 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2945 * "flush" operations on the buffer invoked by different processes.
2946 * Moreover, since the metadata cache memory can be reallocated, we
2947 * need to have exclusive access against updates even though we only
2950 mutex_lock(&stream
->metadata_cache
->lock
);
2951 WARN_ON(stream
->metadata_in
< stream
->metadata_out
);
2952 if (stream
->metadata_in
!= stream
->metadata_out
)
2955 /* Metadata regenerated, change the version. */
2956 if (stream
->metadata_cache
->version
!= stream
->version
)
2957 stream
->version
= stream
->metadata_cache
->version
;
2959 len
= stream
->metadata_cache
->metadata_written
-
2960 stream
->metadata_in
;
2963 reserve_len
= min_t(size_t,
2964 stream
->transport
->ops
.priv
->packet_avail_size(chan
),
2966 lib_ring_buffer_ctx_init(&ctx
, chan
, reserve_len
,
2967 sizeof(char), NULL
);
2969 * If reservation failed, return an error to the caller.
2971 ret
= stream
->transport
->ops
.event_reserve(&ctx
);
2973 printk(KERN_WARNING
"LTTng: Metadata event reservation failed\n");
2974 stream
->coherent
= false;
2977 stream
->transport
->ops
.event_write(&ctx
,
2978 stream
->metadata_cache
->data
+ stream
->metadata_in
,
2980 stream
->transport
->ops
.event_commit(&ctx
);
2981 stream
->metadata_in
+= reserve_len
;
2982 if (reserve_len
< len
)
2983 stream
->coherent
= false;
2985 stream
->coherent
= true;
2990 *coherent
= stream
->coherent
;
2991 mutex_unlock(&stream
->metadata_cache
->lock
);
2996 void lttng_metadata_begin(struct lttng_kernel_session
*session
)
2998 if (atomic_inc_return(&session
->priv
->metadata_cache
->producing
) == 1)
2999 mutex_lock(&session
->priv
->metadata_cache
->lock
);
3003 void lttng_metadata_end(struct lttng_kernel_session
*session
)
3005 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
3006 if (atomic_dec_return(&session
->priv
->metadata_cache
->producing
) == 0) {
3007 struct lttng_metadata_stream
*stream
;
3009 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
3010 wake_up_interruptible(&stream
->read_wait
);
3011 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
3016 * Write the metadata to the metadata cache.
3017 * Must be called with sessions_mutex held.
3018 * The metadata cache lock protects us from concurrent read access from
3019 * thread outputting metadata content to ring buffer.
3020 * The content of the printf is printed as a single atomic metadata
3023 int lttng_metadata_printf(struct lttng_kernel_session
*session
,
3024 const char *fmt
, ...)
3030 WARN_ON_ONCE(!LTTNG_READ_ONCE(session
->active
));
3033 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
3039 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
3040 if (session
->priv
->metadata_cache
->metadata_written
+ len
>
3041 session
->priv
->metadata_cache
->cache_alloc
) {
3042 char *tmp_cache_realloc
;
3043 unsigned int tmp_cache_alloc_size
;
3045 tmp_cache_alloc_size
= max_t(unsigned int,
3046 session
->priv
->metadata_cache
->cache_alloc
+ len
,
3047 session
->priv
->metadata_cache
->cache_alloc
<< 1);
3048 tmp_cache_realloc
= vzalloc(tmp_cache_alloc_size
);
3049 if (!tmp_cache_realloc
)
3051 if (session
->priv
->metadata_cache
->data
) {
3052 memcpy(tmp_cache_realloc
,
3053 session
->priv
->metadata_cache
->data
,
3054 session
->priv
->metadata_cache
->cache_alloc
);
3055 vfree(session
->priv
->metadata_cache
->data
);
3058 session
->priv
->metadata_cache
->cache_alloc
= tmp_cache_alloc_size
;
3059 session
->priv
->metadata_cache
->data
= tmp_cache_realloc
;
3061 memcpy(session
->priv
->metadata_cache
->data
+
3062 session
->priv
->metadata_cache
->metadata_written
,
3064 session
->priv
->metadata_cache
->metadata_written
+= len
;
3075 int print_tabs(struct lttng_kernel_session
*session
, size_t nesting
)
3079 for (i
= 0; i
< nesting
; i
++) {
3082 ret
= lttng_metadata_printf(session
, " ");
3091 int lttng_field_name_statedump(struct lttng_kernel_session
*session
,
3092 const struct lttng_kernel_event_field
*field
,
3095 return lttng_metadata_printf(session
, " _%s;\n", field
->name
);
3099 int _lttng_integer_type_statedump(struct lttng_kernel_session
*session
,
3100 const struct lttng_kernel_type_integer
*type
,
3101 enum lttng_kernel_string_encoding parent_encoding
,
3106 ret
= print_tabs(session
, nesting
);
3109 ret
= lttng_metadata_printf(session
,
3110 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
3114 (parent_encoding
== lttng_kernel_string_encoding_none
)
3116 : (parent_encoding
== lttng_kernel_string_encoding_UTF8
)
3120 #if __BYTE_ORDER == __BIG_ENDIAN
3121 type
->reverse_byte_order
? " byte_order = le;" : ""
3123 type
->reverse_byte_order
? " byte_order = be;" : ""
3130 * Must be called with sessions_mutex held.
3133 int _lttng_struct_type_statedump(struct lttng_kernel_session
*session
,
3134 const struct lttng_kernel_type_struct
*type
,
3137 const char *prev_field_name
= NULL
;
3139 uint32_t i
, nr_fields
;
3140 unsigned int alignment
;
3142 ret
= print_tabs(session
, nesting
);
3145 ret
= lttng_metadata_printf(session
,
3149 nr_fields
= type
->nr_fields
;
3150 for (i
= 0; i
< nr_fields
; i
++) {
3151 const struct lttng_kernel_event_field
*iter_field
;
3153 iter_field
= type
->fields
[i
];
3154 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, &prev_field_name
);
3158 ret
= print_tabs(session
, nesting
);
3161 alignment
= type
->alignment
;
3163 ret
= lttng_metadata_printf(session
,
3167 ret
= lttng_metadata_printf(session
,
3174 * Must be called with sessions_mutex held.
3177 int _lttng_struct_field_statedump(struct lttng_kernel_session
*session
,
3178 const struct lttng_kernel_event_field
*field
,
3183 ret
= _lttng_struct_type_statedump(session
,
3184 lttng_kernel_get_type_struct(field
->type
), nesting
);
3187 return lttng_field_name_statedump(session
, field
, nesting
);
3191 * Must be called with sessions_mutex held.
3194 int _lttng_variant_type_statedump(struct lttng_kernel_session
*session
,
3195 const struct lttng_kernel_type_variant
*type
,
3197 const char *prev_field_name
)
3199 const char *tag_name
;
3201 uint32_t i
, nr_choices
;
3203 tag_name
= type
->tag_name
;
3205 tag_name
= prev_field_name
;
3209 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
3211 if (type
->alignment
!= 0)
3213 ret
= print_tabs(session
, nesting
);
3216 ret
= lttng_metadata_printf(session
,
3217 "variant <_%s> {\n",
3221 nr_choices
= type
->nr_choices
;
3222 for (i
= 0; i
< nr_choices
; i
++) {
3223 const struct lttng_kernel_event_field
*iter_field
;
3225 iter_field
= type
->choices
[i
];
3226 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, NULL
);
3230 ret
= print_tabs(session
, nesting
);
3233 ret
= lttng_metadata_printf(session
,
3239 * Must be called with sessions_mutex held.
3242 int _lttng_variant_field_statedump(struct lttng_kernel_session
*session
,
3243 const struct lttng_kernel_event_field
*field
,
3245 const char *prev_field_name
)
3249 ret
= _lttng_variant_type_statedump(session
,
3250 lttng_kernel_get_type_variant(field
->type
), nesting
,
3254 return lttng_field_name_statedump(session
, field
, nesting
);
3258 * Must be called with sessions_mutex held.
3261 int _lttng_array_field_statedump(struct lttng_kernel_session
*session
,
3262 const struct lttng_kernel_event_field
*field
,
3266 const struct lttng_kernel_type_array
*array_type
;
3267 const struct lttng_kernel_type_common
*elem_type
;
3269 array_type
= lttng_kernel_get_type_array(field
->type
);
3270 WARN_ON_ONCE(!array_type
);
3272 if (array_type
->alignment
) {
3273 ret
= print_tabs(session
, nesting
);
3276 ret
= lttng_metadata_printf(session
,
3277 "struct { } align(%u) _%s_padding;\n",
3278 array_type
->alignment
* CHAR_BIT
,
3284 * Nested compound types: Only array of structures and variants are
3285 * currently supported.
3287 elem_type
= array_type
->elem_type
;
3288 switch (elem_type
->type
) {
3289 case lttng_kernel_type_integer
:
3290 case lttng_kernel_type_struct
:
3291 case lttng_kernel_type_variant
:
3292 ret
= _lttng_type_statedump(session
, elem_type
,
3293 array_type
->encoding
, nesting
);
3301 ret
= lttng_metadata_printf(session
,
3304 array_type
->length
);
3309 * Must be called with sessions_mutex held.
3312 int _lttng_sequence_field_statedump(struct lttng_kernel_session
*session
,
3313 const struct lttng_kernel_event_field
*field
,
3315 const char *prev_field_name
)
3318 const char *length_name
;
3319 const struct lttng_kernel_type_sequence
*sequence_type
;
3320 const struct lttng_kernel_type_common
*elem_type
;
3322 sequence_type
= lttng_kernel_get_type_sequence(field
->type
);
3323 WARN_ON_ONCE(!sequence_type
);
3325 length_name
= sequence_type
->length_name
;
3327 length_name
= prev_field_name
;
3331 if (sequence_type
->alignment
) {
3332 ret
= print_tabs(session
, nesting
);
3335 ret
= lttng_metadata_printf(session
,
3336 "struct { } align(%u) _%s_padding;\n",
3337 sequence_type
->alignment
* CHAR_BIT
,
3344 * Nested compound types: Only array of structures and variants are
3345 * currently supported.
3347 elem_type
= sequence_type
->elem_type
;
3348 switch (elem_type
->type
) {
3349 case lttng_kernel_type_integer
:
3350 case lttng_kernel_type_struct
:
3351 case lttng_kernel_type_variant
:
3352 ret
= _lttng_type_statedump(session
, elem_type
,
3353 sequence_type
->encoding
, nesting
);
3361 ret
= lttng_metadata_printf(session
,
3369 * Must be called with sessions_mutex held.
3372 int _lttng_enum_type_statedump(struct lttng_kernel_session
*session
,
3373 const struct lttng_kernel_type_enum
*type
,
3376 const struct lttng_kernel_enum_desc
*enum_desc
;
3377 const struct lttng_kernel_type_common
*container_type
;
3379 unsigned int i
, nr_entries
;
3381 container_type
= type
->container_type
;
3382 if (container_type
->type
!= lttng_kernel_type_integer
) {
3386 enum_desc
= type
->desc
;
3387 nr_entries
= enum_desc
->nr_entries
;
3389 ret
= print_tabs(session
, nesting
);
3392 ret
= lttng_metadata_printf(session
, "enum : ");
3395 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(container_type
),
3396 lttng_kernel_string_encoding_none
, 0);
3399 ret
= lttng_metadata_printf(session
, " {\n");
3402 /* Dump all entries */
3403 for (i
= 0; i
< nr_entries
; i
++) {
3404 const struct lttng_kernel_enum_entry
*entry
= enum_desc
->entries
[i
];
3407 ret
= print_tabs(session
, nesting
+ 1);
3410 ret
= lttng_metadata_printf(session
,
3414 len
= strlen(entry
->string
);
3415 /* Escape the character '"' */
3416 for (j
= 0; j
< len
; j
++) {
3417 char c
= entry
->string
[j
];
3421 ret
= lttng_metadata_printf(session
,
3425 ret
= lttng_metadata_printf(session
,
3429 ret
= lttng_metadata_printf(session
,
3436 ret
= lttng_metadata_printf(session
, "\"");
3440 if (entry
->options
.is_auto
) {
3441 ret
= lttng_metadata_printf(session
, ",\n");
3445 ret
= lttng_metadata_printf(session
,
3449 if (entry
->start
.signedness
)
3450 ret
= lttng_metadata_printf(session
,
3451 "%lld", (long long) entry
->start
.value
);
3453 ret
= lttng_metadata_printf(session
,
3454 "%llu", entry
->start
.value
);
3457 if (entry
->start
.signedness
== entry
->end
.signedness
&&
3459 == entry
->end
.value
) {
3460 ret
= lttng_metadata_printf(session
,
3463 if (entry
->end
.signedness
) {
3464 ret
= lttng_metadata_printf(session
,
3466 (long long) entry
->end
.value
);
3468 ret
= lttng_metadata_printf(session
,
3477 ret
= print_tabs(session
, nesting
);
3480 ret
= lttng_metadata_printf(session
, "}");
3486 * Must be called with sessions_mutex held.
3489 int _lttng_enum_field_statedump(struct lttng_kernel_session
*session
,
3490 const struct lttng_kernel_event_field
*field
,
3494 const struct lttng_kernel_type_enum
*enum_type
;
3496 enum_type
= lttng_kernel_get_type_enum(field
->type
);
3497 WARN_ON_ONCE(!enum_type
);
3498 ret
= _lttng_enum_type_statedump(session
, enum_type
, nesting
);
3501 return lttng_field_name_statedump(session
, field
, nesting
);
3505 int _lttng_integer_field_statedump(struct lttng_kernel_session
*session
,
3506 const struct lttng_kernel_event_field
*field
,
3511 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(field
->type
),
3512 lttng_kernel_string_encoding_none
, nesting
);
3515 return lttng_field_name_statedump(session
, field
, nesting
);
3519 int _lttng_string_type_statedump(struct lttng_kernel_session
*session
,
3520 const struct lttng_kernel_type_string
*type
,
3525 /* Default encoding is UTF8 */
3526 ret
= print_tabs(session
, nesting
);
3529 ret
= lttng_metadata_printf(session
,
3531 type
->encoding
== lttng_kernel_string_encoding_ASCII
?
3532 " { encoding = ASCII; }" : "");
3537 int _lttng_string_field_statedump(struct lttng_kernel_session
*session
,
3538 const struct lttng_kernel_event_field
*field
,
3541 const struct lttng_kernel_type_string
*string_type
;
3544 string_type
= lttng_kernel_get_type_string(field
->type
);
3545 WARN_ON_ONCE(!string_type
);
3546 ret
= _lttng_string_type_statedump(session
, string_type
, nesting
);
3549 return lttng_field_name_statedump(session
, field
, nesting
);
3553 * Must be called with sessions_mutex held.
3556 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
3557 const struct lttng_kernel_type_common
*type
,
3558 enum lttng_kernel_string_encoding parent_encoding
,
3563 switch (type
->type
) {
3564 case lttng_kernel_type_integer
:
3565 ret
= _lttng_integer_type_statedump(session
,
3566 lttng_kernel_get_type_integer(type
),
3567 parent_encoding
, nesting
);
3569 case lttng_kernel_type_enum
:
3570 ret
= _lttng_enum_type_statedump(session
,
3571 lttng_kernel_get_type_enum(type
),
3574 case lttng_kernel_type_string
:
3575 ret
= _lttng_string_type_statedump(session
,
3576 lttng_kernel_get_type_string(type
),
3579 case lttng_kernel_type_struct
:
3580 ret
= _lttng_struct_type_statedump(session
,
3581 lttng_kernel_get_type_struct(type
),
3584 case lttng_kernel_type_variant
:
3585 ret
= _lttng_variant_type_statedump(session
,
3586 lttng_kernel_get_type_variant(type
),
3590 /* Nested arrays and sequences are not supported yet. */
3591 case lttng_kernel_type_array
:
3592 case lttng_kernel_type_sequence
:
3601 * Must be called with sessions_mutex held.
3604 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
3605 const struct lttng_kernel_event_field
*field
,
3607 const char **prev_field_name_p
)
3609 const char *prev_field_name
= NULL
;
3612 if (prev_field_name_p
)
3613 prev_field_name
= *prev_field_name_p
;
3614 switch (field
->type
->type
) {
3615 case lttng_kernel_type_integer
:
3616 ret
= _lttng_integer_field_statedump(session
, field
, nesting
);
3618 case lttng_kernel_type_enum
:
3619 ret
= _lttng_enum_field_statedump(session
, field
, nesting
);
3621 case lttng_kernel_type_string
:
3622 ret
= _lttng_string_field_statedump(session
, field
, nesting
);
3624 case lttng_kernel_type_struct
:
3625 ret
= _lttng_struct_field_statedump(session
, field
, nesting
);
3627 case lttng_kernel_type_array
:
3628 ret
= _lttng_array_field_statedump(session
, field
, nesting
);
3630 case lttng_kernel_type_sequence
:
3631 ret
= _lttng_sequence_field_statedump(session
, field
, nesting
, prev_field_name
);
3633 case lttng_kernel_type_variant
:
3634 ret
= _lttng_variant_field_statedump(session
, field
, nesting
, prev_field_name
);
3641 if (prev_field_name_p
)
3642 *prev_field_name_p
= field
->name
;
3647 int _lttng_context_metadata_statedump(struct lttng_kernel_session
*session
,
3648 struct lttng_kernel_ctx
*ctx
)
3650 const char *prev_field_name
= NULL
;
3656 for (i
= 0; i
< ctx
->nr_fields
; i
++) {
3657 const struct lttng_kernel_ctx_field
*field
= &ctx
->fields
[i
];
3659 ret
= _lttng_field_statedump(session
, field
->event_field
, 2, &prev_field_name
);
3667 int _lttng_fields_metadata_statedump(struct lttng_kernel_session
*session
,
3668 struct lttng_kernel_event_recorder
*event_recorder
)
3670 const char *prev_field_name
= NULL
;
3671 const struct lttng_kernel_event_desc
*desc
= event_recorder
->priv
->parent
.desc
;
3675 for (i
= 0; i
< desc
->tp_class
->nr_fields
; i
++) {
3676 const struct lttng_kernel_event_field
*field
= desc
->tp_class
->fields
[i
];
3678 ret
= _lttng_field_statedump(session
, field
, 2, &prev_field_name
);
3686 * Must be called with sessions_mutex held.
3687 * The entire event metadata is printed as a single atomic metadata
3691 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
3692 struct lttng_kernel_channel_buffer
*chan
,
3693 struct lttng_kernel_event_recorder
*event_recorder
)
3697 if (event_recorder
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3699 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3702 lttng_metadata_begin(session
);
3704 ret
= lttng_metadata_printf(session
,
3708 " stream_id = %u;\n",
3709 event_recorder
->priv
->parent
.desc
->event_name
,
3710 event_recorder
->priv
->id
,
3711 event_recorder
->chan
->priv
->id
);
3715 ret
= lttng_metadata_printf(session
,
3716 " fields := struct {\n"
3721 ret
= _lttng_fields_metadata_statedump(session
, event_recorder
);
3726 * LTTng space reservation can only reserve multiples of the
3729 ret
= lttng_metadata_printf(session
,
3735 event_recorder
->priv
->metadata_dumped
= 1;
3737 lttng_metadata_end(session
);
3743 * Must be called with sessions_mutex held.
3744 * The entire channel metadata is printed as a single atomic metadata
3748 int _lttng_channel_metadata_statedump(struct lttng_kernel_session
*session
,
3749 struct lttng_kernel_channel_buffer
*chan
)
3753 if (chan
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3756 if (chan
->priv
->channel_type
== METADATA_CHANNEL
)
3759 lttng_metadata_begin(session
);
3761 WARN_ON_ONCE(!chan
->priv
->header_type
);
3762 ret
= lttng_metadata_printf(session
,
3765 " event.header := %s;\n"
3766 " packet.context := struct packet_context;\n",
3768 chan
->priv
->header_type
== 1 ? "struct event_header_compact" :
3769 "struct event_header_large");
3773 if (chan
->priv
->ctx
) {
3774 ret
= lttng_metadata_printf(session
,
3775 " event.context := struct {\n");
3779 ret
= _lttng_context_metadata_statedump(session
, chan
->priv
->ctx
);
3782 if (chan
->priv
->ctx
) {
3783 ret
= lttng_metadata_printf(session
,
3789 ret
= lttng_metadata_printf(session
,
3792 chan
->priv
->metadata_dumped
= 1;
3794 lttng_metadata_end(session
);
3799 * Must be called with sessions_mutex held.
3802 int _lttng_stream_packet_context_declare(struct lttng_kernel_session
*session
)
3804 return lttng_metadata_printf(session
,
3805 "struct packet_context {\n"
3806 " uint64_clock_monotonic_t timestamp_begin;\n"
3807 " uint64_clock_monotonic_t timestamp_end;\n"
3808 " uint64_t content_size;\n"
3809 " uint64_t packet_size;\n"
3810 " uint64_t packet_seq_num;\n"
3811 " unsigned long events_discarded;\n"
3812 " uint32_t cpu_id;\n"
3819 * id: range: 0 - 30.
3820 * id 31 is reserved to indicate an extended header.
3823 * id: range: 0 - 65534.
3824 * id 65535 is reserved to indicate an extended header.
3826 * Must be called with sessions_mutex held.
3829 int _lttng_event_header_declare(struct lttng_kernel_session
*session
)
3831 return lttng_metadata_printf(session
,
3832 "struct event_header_compact {\n"
3833 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3836 " uint27_clock_monotonic_t timestamp;\n"
3840 " uint64_clock_monotonic_t timestamp;\n"
3845 "struct event_header_large {\n"
3846 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3849 " uint32_clock_monotonic_t timestamp;\n"
3853 " uint64_clock_monotonic_t timestamp;\n"
3857 lttng_alignof(uint32_t) * CHAR_BIT
,
3858 lttng_alignof(uint16_t) * CHAR_BIT
3863 * Approximation of NTP time of day to clock monotonic correlation,
3864 * taken at start of trace.
3865 * Yes, this is only an approximation. Yes, we can (and will) do better
3866 * in future versions.
3867 * This function may return a negative offset. It may happen if the
3868 * system sets the REALTIME clock to 0 after boot.
3870 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3874 int64_t measure_clock_offset(void)
3876 uint64_t monotonic_avg
, monotonic
[2], realtime
;
3877 uint64_t tcf
= trace_clock_freq();
3879 unsigned long flags
;
3880 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3881 struct timespec64 rts
= { 0, 0 };
3883 struct timespec rts
= { 0, 0 };
3886 /* Disable interrupts to increase correlation precision. */
3887 local_irq_save(flags
);
3888 monotonic
[0] = trace_clock_read64();
3889 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3890 ktime_get_real_ts64(&rts
);
3892 getnstimeofday(&rts
);
3894 monotonic
[1] = trace_clock_read64();
3895 local_irq_restore(flags
);
3897 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
3898 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
3899 if (tcf
== NSEC_PER_SEC
) {
3900 realtime
+= rts
.tv_nsec
;
3902 uint64_t n
= rts
.tv_nsec
* tcf
;
3904 do_div(n
, NSEC_PER_SEC
);
3907 offset
= (int64_t) realtime
- monotonic_avg
;
3912 int print_escaped_ctf_string(struct lttng_kernel_session
*session
, const char *string
)
3920 while (cur
!= '\0') {
3923 ret
= lttng_metadata_printf(session
, "%s", "\\n");
3927 ret
= lttng_metadata_printf(session
, "%c", '\\');
3930 /* We still print the current char */
3933 ret
= lttng_metadata_printf(session
, "%c", cur
);
3947 int print_metadata_escaped_field(struct lttng_kernel_session
*session
, const char *field
,
3948 const char *field_value
)
3952 ret
= lttng_metadata_printf(session
, " %s = \"", field
);
3956 ret
= print_escaped_ctf_string(session
, field_value
);
3960 ret
= lttng_metadata_printf(session
, "\";\n");
3967 * Output metadata into this session's metadata buffers.
3968 * Must be called with sessions_mutex held.
3971 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
)
3973 unsigned char *uuid_c
= session
->priv
->uuid
.b
;
3974 unsigned char uuid_s
[37], clock_uuid_s
[BOOT_ID_LEN
];
3975 const char *product_uuid
;
3976 struct lttng_kernel_channel_buffer_private
*chan_priv
;
3977 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
3980 if (!LTTNG_READ_ONCE(session
->active
))
3983 lttng_metadata_begin(session
);
3985 if (session
->priv
->metadata_dumped
)
3988 snprintf(uuid_s
, sizeof(uuid_s
),
3989 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3990 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
3991 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
3992 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
3993 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
3995 ret
= lttng_metadata_printf(session
,
3996 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3997 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3998 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3999 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
4000 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
4001 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
4002 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
4008 " byte_order = %s;\n"
4009 " packet.header := struct {\n"
4010 " uint32_t magic;\n"
4011 " uint8_t uuid[16];\n"
4012 " uint32_t stream_id;\n"
4013 " uint64_t stream_instance_id;\n"
4016 lttng_alignof(uint8_t) * CHAR_BIT
,
4017 lttng_alignof(uint16_t) * CHAR_BIT
,
4018 lttng_alignof(uint32_t) * CHAR_BIT
,
4019 lttng_alignof(uint64_t) * CHAR_BIT
,
4020 sizeof(unsigned long) * CHAR_BIT
,
4021 lttng_alignof(unsigned long) * CHAR_BIT
,
4025 #if __BYTE_ORDER == __BIG_ENDIAN
4034 ret
= lttng_metadata_printf(session
,
4036 " hostname = \"%s\";\n"
4037 " domain = \"kernel\";\n"
4038 " sysname = \"%s\";\n"
4039 " kernel_release = \"%s\";\n"
4040 " kernel_version = \"%s\";\n"
4041 " tracer_name = \"lttng-modules\";\n"
4042 " tracer_major = %d;\n"
4043 " tracer_minor = %d;\n"
4044 " tracer_patchlevel = %d;\n"
4045 " trace_buffering_scheme = \"global\";\n",
4046 current
->nsproxy
->uts_ns
->name
.nodename
,
4050 LTTNG_MODULES_MAJOR_VERSION
,
4051 LTTNG_MODULES_MINOR_VERSION
,
4052 LTTNG_MODULES_PATCHLEVEL_VERSION
4057 ret
= print_metadata_escaped_field(session
, "trace_name", session
->priv
->name
);
4060 ret
= print_metadata_escaped_field(session
, "trace_creation_datetime",
4061 session
->priv
->creation_time
);
4065 /* Add the product UUID to the 'env' section */
4066 product_uuid
= dmi_get_system_info(DMI_PRODUCT_UUID
);
4068 ret
= lttng_metadata_printf(session
,
4069 " product_uuid = \"%s\";\n",
4076 /* Close the 'env' section */
4077 ret
= lttng_metadata_printf(session
, "};\n\n");
4081 ret
= lttng_metadata_printf(session
,
4083 " name = \"%s\";\n",
4089 if (!trace_clock_uuid(clock_uuid_s
)) {
4090 ret
= lttng_metadata_printf(session
,
4091 " uuid = \"%s\";\n",
4098 ret
= lttng_metadata_printf(session
,
4099 " description = \"%s\";\n"
4100 " freq = %llu; /* Frequency, in Hz */\n"
4101 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
4104 trace_clock_description(),
4105 (unsigned long long) trace_clock_freq(),
4106 (long long) measure_clock_offset()
4111 ret
= lttng_metadata_printf(session
,
4112 "typealias integer {\n"
4113 " size = 27; align = 1; signed = false;\n"
4114 " map = clock.%s.value;\n"
4115 "} := uint27_clock_monotonic_t;\n"
4117 "typealias integer {\n"
4118 " size = 32; align = %u; signed = false;\n"
4119 " map = clock.%s.value;\n"
4120 "} := uint32_clock_monotonic_t;\n"
4122 "typealias integer {\n"
4123 " size = 64; align = %u; signed = false;\n"
4124 " map = clock.%s.value;\n"
4125 "} := uint64_clock_monotonic_t;\n\n",
4127 lttng_alignof(uint32_t) * CHAR_BIT
,
4129 lttng_alignof(uint64_t) * CHAR_BIT
,
4135 ret
= _lttng_stream_packet_context_declare(session
);
4139 ret
= _lttng_event_header_declare(session
);
4144 list_for_each_entry(chan_priv
, &session
->priv
->chan
, node
) {
4145 ret
= _lttng_channel_metadata_statedump(session
, chan_priv
->pub
);
4150 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
4151 ret
= _lttng_event_metadata_statedump(session
, event_recorder_priv
->pub
->chan
,
4152 event_recorder_priv
->pub
);
4156 session
->priv
->metadata_dumped
= 1;
4158 lttng_metadata_end(session
);
4163 * lttng_transport_register - LTT transport registration
4164 * @transport: transport structure
4166 * Registers a transport which can be used as output to extract the data out of
4167 * LTTng. The module calling this registration function must ensure that no
4168 * trap-inducing code will be executed by the transport functions. E.g.
4169 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
4170 * is made visible to the transport function. This registration acts as a
4171 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
4172 * after its registration must it synchronize the TLBs.
4174 void lttng_transport_register(struct lttng_transport
*transport
)
4177 * Make sure no page fault can be triggered by the module about to be
4178 * registered. We deal with this here so we don't have to call
4179 * vmalloc_sync_mappings() in each module's init.
4181 wrapper_vmalloc_sync_mappings();
4183 mutex_lock(&sessions_mutex
);
4184 list_add_tail(&transport
->node
, <tng_transport_list
);
4185 mutex_unlock(&sessions_mutex
);
4187 EXPORT_SYMBOL_GPL(lttng_transport_register
);
4190 * lttng_transport_unregister - LTT transport unregistration
4191 * @transport: transport structure
4193 void lttng_transport_unregister(struct lttng_transport
*transport
)
4195 mutex_lock(&sessions_mutex
);
4196 list_del(&transport
->node
);
4197 mutex_unlock(&sessions_mutex
);
4199 EXPORT_SYMBOL_GPL(lttng_transport_unregister
);
4201 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
)
4204 * Make sure no page fault can be triggered by the module about to be
4205 * registered. We deal with this here so we don't have to call
4206 * vmalloc_sync_mappings() in each module's init.
4208 wrapper_vmalloc_sync_mappings();
4210 mutex_lock(&sessions_mutex
);
4211 list_add_tail(&transport
->node
, <tng_counter_transport_list
);
4212 mutex_unlock(&sessions_mutex
);
4214 EXPORT_SYMBOL_GPL(lttng_counter_transport_register
);
4216 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
)
4218 mutex_lock(&sessions_mutex
);
4219 list_del(&transport
->node
);
4220 mutex_unlock(&sessions_mutex
);
4222 EXPORT_SYMBOL_GPL(lttng_counter_transport_unregister
);
4224 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
4226 enum cpuhp_state lttng_hp_prepare
;
4227 enum cpuhp_state lttng_hp_online
;
4229 static int lttng_hotplug_prepare(unsigned int cpu
, struct hlist_node
*node
)
4231 struct lttng_cpuhp_node
*lttng_node
;
4233 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4234 switch (lttng_node
->component
) {
4235 case LTTNG_RING_BUFFER_FRONTEND
:
4237 case LTTNG_RING_BUFFER_BACKEND
:
4238 return lttng_cpuhp_rb_backend_prepare(cpu
, lttng_node
);
4239 case LTTNG_RING_BUFFER_ITER
:
4241 case LTTNG_CONTEXT_PERF_COUNTERS
:
4248 static int lttng_hotplug_dead(unsigned int cpu
, struct hlist_node
*node
)
4250 struct lttng_cpuhp_node
*lttng_node
;
4252 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4253 switch (lttng_node
->component
) {
4254 case LTTNG_RING_BUFFER_FRONTEND
:
4255 return lttng_cpuhp_rb_frontend_dead(cpu
, lttng_node
);
4256 case LTTNG_RING_BUFFER_BACKEND
:
4258 case LTTNG_RING_BUFFER_ITER
:
4260 case LTTNG_CONTEXT_PERF_COUNTERS
:
4261 return lttng_cpuhp_perf_counter_dead(cpu
, lttng_node
);
4267 static int lttng_hotplug_online(unsigned int cpu
, struct hlist_node
*node
)
4269 struct lttng_cpuhp_node
*lttng_node
;
4271 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4272 switch (lttng_node
->component
) {
4273 case LTTNG_RING_BUFFER_FRONTEND
:
4274 return lttng_cpuhp_rb_frontend_online(cpu
, lttng_node
);
4275 case LTTNG_RING_BUFFER_BACKEND
:
4277 case LTTNG_RING_BUFFER_ITER
:
4278 return lttng_cpuhp_rb_iter_online(cpu
, lttng_node
);
4279 case LTTNG_CONTEXT_PERF_COUNTERS
:
4280 return lttng_cpuhp_perf_counter_online(cpu
, lttng_node
);
4286 static int lttng_hotplug_offline(unsigned int cpu
, struct hlist_node
*node
)
4288 struct lttng_cpuhp_node
*lttng_node
;
4290 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4291 switch (lttng_node
->component
) {
4292 case LTTNG_RING_BUFFER_FRONTEND
:
4293 return lttng_cpuhp_rb_frontend_offline(cpu
, lttng_node
);
4294 case LTTNG_RING_BUFFER_BACKEND
:
4296 case LTTNG_RING_BUFFER_ITER
:
4298 case LTTNG_CONTEXT_PERF_COUNTERS
:
4305 static int __init
lttng_init_cpu_hotplug(void)
4309 ret
= cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN
, "lttng:prepare",
4310 lttng_hotplug_prepare
,
4311 lttng_hotplug_dead
);
4315 lttng_hp_prepare
= ret
;
4316 lttng_rb_set_hp_prepare(ret
);
4318 ret
= cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN
, "lttng:online",
4319 lttng_hotplug_online
,
4320 lttng_hotplug_offline
);
4322 cpuhp_remove_multi_state(lttng_hp_prepare
);
4323 lttng_hp_prepare
= 0;
4326 lttng_hp_online
= ret
;
4327 lttng_rb_set_hp_online(ret
);
4332 static void __exit
lttng_exit_cpu_hotplug(void)
4334 lttng_rb_set_hp_online(0);
4335 cpuhp_remove_multi_state(lttng_hp_online
);
4336 lttng_rb_set_hp_prepare(0);
4337 cpuhp_remove_multi_state(lttng_hp_prepare
);
4340 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4341 static int lttng_init_cpu_hotplug(void)
4345 static void lttng_exit_cpu_hotplug(void)
4348 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4350 static int __init
lttng_events_init(void)
4354 ret
= wrapper_lttng_fixup_sig(THIS_MODULE
);
4357 ret
= wrapper_get_pfnblock_flags_mask_init();
4360 ret
= wrapper_get_pageblock_flags_mask_init();
4363 ret
= lttng_probes_init();
4366 ret
= lttng_context_init();
4369 ret
= lttng_tracepoint_init();
4372 event_recorder_cache
= KMEM_CACHE(lttng_kernel_event_recorder
, 0);
4373 if (!event_recorder_cache
) {
4375 goto error_kmem_event_recorder
;
4377 event_recorder_private_cache
= KMEM_CACHE(lttng_kernel_event_recorder_private
, 0);
4378 if (!event_recorder_private_cache
) {
4380 goto error_kmem_event_recorder_private
;
4382 event_notifier_cache
= KMEM_CACHE(lttng_kernel_event_notifier
, 0);
4383 if (!event_notifier_cache
) {
4385 goto error_kmem_event_notifier
;
4387 event_notifier_private_cache
= KMEM_CACHE(lttng_kernel_event_notifier_private
, 0);
4388 if (!event_notifier_private_cache
) {
4390 goto error_kmem_event_notifier_private
;
4392 ret
= lttng_abi_init();
4395 ret
= lttng_logger_init();
4398 ret
= lttng_init_cpu_hotplug();
4401 printk(KERN_NOTICE
"LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
4402 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4403 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4404 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4405 LTTNG_MODULES_EXTRAVERSION
,
4407 #ifdef LTTNG_EXTRA_VERSION_GIT
4408 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4412 #ifdef LTTNG_EXTRA_VERSION_NAME
4413 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4417 #ifdef CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM
4418 printk(KERN_NOTICE
"LTTng: Experimental bitwise enum enabled.\n");
4419 #endif /* CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM */
4423 lttng_logger_exit();
4427 kmem_cache_destroy(event_notifier_private_cache
);
4428 error_kmem_event_notifier_private
:
4429 kmem_cache_destroy(event_notifier_cache
);
4430 error_kmem_event_notifier
:
4431 kmem_cache_destroy(event_recorder_private_cache
);
4432 error_kmem_event_recorder_private
:
4433 kmem_cache_destroy(event_recorder_cache
);
4434 error_kmem_event_recorder
:
4435 lttng_tracepoint_exit();
4437 lttng_context_exit();
4438 printk(KERN_NOTICE
"LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4439 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4440 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4441 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4442 LTTNG_MODULES_EXTRAVERSION
,
4444 #ifdef LTTNG_EXTRA_VERSION_GIT
4445 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4449 #ifdef LTTNG_EXTRA_VERSION_NAME
4450 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4457 module_init(lttng_events_init
);
4459 static void __exit
lttng_events_exit(void)
4461 struct lttng_kernel_session_private
*session_priv
, *tmpsession_priv
;
4463 lttng_exit_cpu_hotplug();
4464 lttng_logger_exit();
4466 list_for_each_entry_safe(session_priv
, tmpsession_priv
, &sessions
, list
)
4467 lttng_session_destroy(session_priv
->pub
);
4468 kmem_cache_destroy(event_recorder_cache
);
4469 kmem_cache_destroy(event_recorder_private_cache
);
4470 kmem_cache_destroy(event_notifier_cache
);
4471 kmem_cache_destroy(event_notifier_private_cache
);
4472 lttng_tracepoint_exit();
4473 lttng_context_exit();
4474 printk(KERN_NOTICE
"LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4475 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4476 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4477 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4478 LTTNG_MODULES_EXTRAVERSION
,
4480 #ifdef LTTNG_EXTRA_VERSION_GIT
4481 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4485 #ifdef LTTNG_EXTRA_VERSION_NAME
4486 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4492 module_exit(lttng_events_exit
);
4494 #include <generated/patches.h>
4495 #ifdef LTTNG_EXTRA_VERSION_GIT
4496 MODULE_INFO(extra_version_git
, LTTNG_EXTRA_VERSION_GIT
);
4498 #ifdef LTTNG_EXTRA_VERSION_NAME
4499 MODULE_INFO(extra_version_name
, LTTNG_EXTRA_VERSION_NAME
);
4501 MODULE_LICENSE("GPL and additional rights");
4502 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4503 MODULE_DESCRIPTION("LTTng tracer");
4504 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
4505 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
4506 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
4507 LTTNG_MODULES_EXTRAVERSION
);