1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * This page_alloc.h wrapper needs to be included before gfpflags.h because it
12 * overrides a function with a define.
14 #include "wrapper/page_alloc.h"
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/jiffies.h>
21 #include <linux/utsname.h>
22 #include <linux/err.h>
23 #include <linux/seq_file.h>
24 #include <linux/file.h>
25 #include <linux/anon_inodes.h>
26 #include <wrapper/file.h>
27 #include <linux/uaccess.h>
28 #include <linux/vmalloc.h>
29 #include <linux/dmi.h>
31 #include <wrapper/uuid.h>
32 #include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */
33 #include <wrapper/random.h>
34 #include <wrapper/tracepoint.h>
35 #include <wrapper/list.h>
36 #include <wrapper/types.h>
37 #include <lttng/kernel-version.h>
38 #include <lttng/events.h>
39 #include <lttng/events-internal.h>
40 #include <lttng/lttng-bytecode.h>
41 #include <lttng/tracer.h>
42 #include <lttng/event-notifier-notification.h>
43 #include <lttng/abi-old.h>
44 #include <lttng/endian.h>
45 #include <lttng/string-utils.h>
46 #include <lttng/utils.h>
47 #include <ringbuffer/backend.h>
48 #include <ringbuffer/frontend.h>
49 #include <wrapper/time.h>
51 #define METADATA_CACHE_DEFAULT_SIZE 4096
53 static LIST_HEAD(sessions
);
54 static LIST_HEAD(event_notifier_groups
);
55 static LIST_HEAD(lttng_transport_list
);
56 static LIST_HEAD(lttng_counter_transport_list
);
58 * Protect the sessions and metadata caches.
60 static DEFINE_MUTEX(sessions_mutex
);
61 static struct kmem_cache
*event_recorder_cache
;
62 static struct kmem_cache
*event_recorder_private_cache
;
63 static struct kmem_cache
*event_notifier_cache
;
64 static struct kmem_cache
*event_notifier_private_cache
;
66 static void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
);
67 static void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
);
68 static void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
);
69 static void lttng_event_notifier_enabler_destroy(struct lttng_event_notifier_enabler
*event_notifier_enabler
);
70 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
);
72 static void _lttng_event_destroy(struct lttng_kernel_event_common
*event
);
73 static void _lttng_channel_destroy(struct lttng_channel
*chan
);
74 static int _lttng_event_unregister(struct lttng_kernel_event_recorder
*event
);
75 static int _lttng_event_notifier_unregister(struct lttng_kernel_event_notifier
*event_notifier
);
77 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
78 struct lttng_channel
*chan
,
79 struct lttng_kernel_event_recorder
*event
);
81 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
);
83 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
);
85 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
86 const struct lttng_kernel_type_common
*type
,
87 enum lttng_kernel_string_encoding parent_encoding
,
90 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
91 const struct lttng_kernel_event_field
*field
,
92 size_t nesting
, const char **prev_field_name_p
);
94 void synchronize_trace(void)
96 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,1,0))
102 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0))
103 #ifdef CONFIG_PREEMPT_RT_FULL
106 #else /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
107 #ifdef CONFIG_PREEMPT_RT
110 #endif /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
113 void lttng_lock_sessions(void)
115 mutex_lock(&sessions_mutex
);
118 void lttng_unlock_sessions(void)
120 mutex_unlock(&sessions_mutex
);
123 static struct lttng_transport
*lttng_transport_find(const char *name
)
125 struct lttng_transport
*transport
;
127 list_for_each_entry(transport
, <tng_transport_list
, node
) {
128 if (!strcmp(transport
->name
, name
))
135 * Called with sessions lock held.
137 int lttng_session_active(void)
139 struct lttng_kernel_session_private
*iter
;
141 list_for_each_entry(iter
, &sessions
, list
) {
142 if (iter
->pub
->active
)
148 struct lttng_kernel_session
*lttng_session_create(void)
150 struct lttng_kernel_session
*session
;
151 struct lttng_kernel_session_private
*session_priv
;
152 struct lttng_metadata_cache
*metadata_cache
;
155 mutex_lock(&sessions_mutex
);
156 session
= lttng_kvzalloc(sizeof(*session
), GFP_KERNEL
);
159 session_priv
= lttng_kvzalloc(sizeof(*session_priv
), GFP_KERNEL
);
161 goto err_free_session
;
162 session
->priv
= session_priv
;
163 session_priv
->pub
= session
;
165 INIT_LIST_HEAD(&session_priv
->chan
);
166 INIT_LIST_HEAD(&session_priv
->events
);
167 lttng_guid_gen(&session_priv
->uuid
);
169 metadata_cache
= kzalloc(sizeof(struct lttng_metadata_cache
),
172 goto err_free_session_private
;
173 metadata_cache
->data
= vzalloc(METADATA_CACHE_DEFAULT_SIZE
);
174 if (!metadata_cache
->data
)
176 metadata_cache
->cache_alloc
= METADATA_CACHE_DEFAULT_SIZE
;
177 kref_init(&metadata_cache
->refcount
);
178 mutex_init(&metadata_cache
->lock
);
179 session_priv
->metadata_cache
= metadata_cache
;
180 INIT_LIST_HEAD(&metadata_cache
->metadata_stream
);
181 memcpy(&metadata_cache
->uuid
, &session_priv
->uuid
,
182 sizeof(metadata_cache
->uuid
));
183 INIT_LIST_HEAD(&session_priv
->enablers_head
);
184 for (i
= 0; i
< LTTNG_EVENT_HT_SIZE
; i
++)
185 INIT_HLIST_HEAD(&session_priv
->events_ht
.table
[i
]);
186 list_add(&session_priv
->list
, &sessions
);
188 session
->pid_tracker
.session
= session
;
189 session
->pid_tracker
.tracker_type
= TRACKER_PID
;
190 session
->vpid_tracker
.session
= session
;
191 session
->vpid_tracker
.tracker_type
= TRACKER_VPID
;
192 session
->uid_tracker
.session
= session
;
193 session
->uid_tracker
.tracker_type
= TRACKER_UID
;
194 session
->vuid_tracker
.session
= session
;
195 session
->vuid_tracker
.tracker_type
= TRACKER_VUID
;
196 session
->gid_tracker
.session
= session
;
197 session
->gid_tracker
.tracker_type
= TRACKER_GID
;
198 session
->vgid_tracker
.session
= session
;
199 session
->vgid_tracker
.tracker_type
= TRACKER_VGID
;
200 mutex_unlock(&sessions_mutex
);
205 kfree(metadata_cache
);
206 err_free_session_private
:
207 lttng_kvfree(session_priv
);
209 lttng_kvfree(session
);
211 mutex_unlock(&sessions_mutex
);
216 struct lttng_counter_transport
*lttng_counter_transport_find(const char *name
)
218 struct lttng_counter_transport
*transport
;
220 list_for_each_entry(transport
, <tng_counter_transport_list
, node
) {
221 if (!strcmp(transport
->name
, name
))
227 struct lttng_counter
*lttng_kernel_counter_create(
228 const char *counter_transport_name
,
229 size_t number_dimensions
, const size_t *dimensions_sizes
)
231 struct lttng_counter
*counter
= NULL
;
232 struct lttng_counter_transport
*counter_transport
= NULL
;
234 counter_transport
= lttng_counter_transport_find(counter_transport_name
);
235 if (!counter_transport
) {
236 printk(KERN_WARNING
"LTTng: counter transport %s not found.\n",
237 counter_transport_name
);
240 if (!try_module_get(counter_transport
->owner
)) {
241 printk(KERN_WARNING
"LTTng: Can't lock counter transport module.\n");
245 counter
= lttng_kvzalloc(sizeof(struct lttng_counter
), GFP_KERNEL
);
249 /* Create event notifier error counter. */
250 counter
->ops
= &counter_transport
->ops
;
251 counter
->transport
= counter_transport
;
253 counter
->counter
= counter
->ops
->counter_create(
254 number_dimensions
, dimensions_sizes
, 0);
255 if (!counter
->counter
) {
262 lttng_kvfree(counter
);
264 if (counter_transport
)
265 module_put(counter_transport
->owner
);
270 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
272 struct lttng_transport
*transport
= NULL
;
273 struct lttng_event_notifier_group
*event_notifier_group
;
274 const char *transport_name
= "relay-event-notifier";
275 size_t subbuf_size
= 4096; //TODO
276 size_t num_subbuf
= 16; //TODO
277 unsigned int switch_timer_interval
= 0;
278 unsigned int read_timer_interval
= 0;
281 mutex_lock(&sessions_mutex
);
283 transport
= lttng_transport_find(transport_name
);
285 printk(KERN_WARNING
"LTTng: transport %s not found\n",
289 if (!try_module_get(transport
->owner
)) {
290 printk(KERN_WARNING
"LTTng: Can't lock transport %s module.\n",
295 event_notifier_group
= lttng_kvzalloc(sizeof(struct lttng_event_notifier_group
),
297 if (!event_notifier_group
)
301 * Initialize the ring buffer used to store event notifier
304 event_notifier_group
->ops
= &transport
->ops
;
305 event_notifier_group
->chan
= transport
->ops
.priv
->channel_create(
306 transport_name
, event_notifier_group
, NULL
,
307 subbuf_size
, num_subbuf
, switch_timer_interval
,
308 read_timer_interval
);
309 if (!event_notifier_group
->chan
)
312 event_notifier_group
->transport
= transport
;
314 INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
315 INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
316 for (i
= 0; i
< LTTNG_EVENT_NOTIFIER_HT_SIZE
; i
++)
317 INIT_HLIST_HEAD(&event_notifier_group
->event_notifiers_ht
.table
[i
]);
319 list_add(&event_notifier_group
->node
, &event_notifier_groups
);
321 mutex_unlock(&sessions_mutex
);
323 return event_notifier_group
;
326 lttng_kvfree(event_notifier_group
);
329 module_put(transport
->owner
);
331 mutex_unlock(&sessions_mutex
);
335 void metadata_cache_destroy(struct kref
*kref
)
337 struct lttng_metadata_cache
*cache
=
338 container_of(kref
, struct lttng_metadata_cache
, refcount
);
343 void lttng_session_destroy(struct lttng_kernel_session
*session
)
345 struct lttng_channel
*chan
, *tmpchan
;
346 struct lttng_kernel_event_recorder_private
*event_recorder_priv
, *tmpevent_recorder_priv
;
347 struct lttng_metadata_stream
*metadata_stream
;
348 struct lttng_event_enabler
*event_enabler
, *tmp_event_enabler
;
351 mutex_lock(&sessions_mutex
);
352 WRITE_ONCE(session
->active
, 0);
353 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
354 ret
= lttng_syscalls_unregister_channel(chan
);
357 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
358 ret
= _lttng_event_unregister(event_recorder_priv
->pub
);
361 synchronize_trace(); /* Wait for in-flight events to complete */
362 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
363 ret
= lttng_syscalls_destroy_event(chan
);
366 list_for_each_entry_safe(event_enabler
, tmp_event_enabler
,
367 &session
->priv
->enablers_head
, node
)
368 lttng_event_enabler_destroy(event_enabler
);
369 list_for_each_entry_safe(event_recorder_priv
, tmpevent_recorder_priv
, &session
->priv
->events
, node
)
370 _lttng_event_destroy(&event_recorder_priv
->pub
->parent
);
371 list_for_each_entry_safe(chan
, tmpchan
, &session
->priv
->chan
, list
) {
372 BUG_ON(chan
->channel_type
== METADATA_CHANNEL
);
373 _lttng_channel_destroy(chan
);
375 mutex_lock(&session
->priv
->metadata_cache
->lock
);
376 list_for_each_entry(metadata_stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
377 _lttng_metadata_channel_hangup(metadata_stream
);
378 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
379 lttng_id_tracker_destroy(&session
->pid_tracker
, false);
380 lttng_id_tracker_destroy(&session
->vpid_tracker
, false);
381 lttng_id_tracker_destroy(&session
->uid_tracker
, false);
382 lttng_id_tracker_destroy(&session
->vuid_tracker
, false);
383 lttng_id_tracker_destroy(&session
->gid_tracker
, false);
384 lttng_id_tracker_destroy(&session
->vgid_tracker
, false);
385 kref_put(&session
->priv
->metadata_cache
->refcount
, metadata_cache_destroy
);
386 list_del(&session
->priv
->list
);
387 mutex_unlock(&sessions_mutex
);
388 lttng_kvfree(session
->priv
);
389 lttng_kvfree(session
);
392 void lttng_event_notifier_group_destroy(
393 struct lttng_event_notifier_group
*event_notifier_group
)
395 struct lttng_event_notifier_enabler
*event_notifier_enabler
, *tmp_event_notifier_enabler
;
396 struct lttng_kernel_event_notifier_private
*event_notifier_priv
, *tmpevent_notifier_priv
;
399 if (!event_notifier_group
)
402 mutex_lock(&sessions_mutex
);
404 ret
= lttng_syscalls_unregister_event_notifier_group(event_notifier_group
);
407 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
408 &event_notifier_group
->event_notifiers_head
, node
) {
409 ret
= _lttng_event_notifier_unregister(event_notifier_priv
->pub
);
413 /* Wait for in-flight event notifier to complete */
416 irq_work_sync(&event_notifier_group
->wakeup_pending
);
418 kfree(event_notifier_group
->sc_filter
);
420 list_for_each_entry_safe(event_notifier_enabler
, tmp_event_notifier_enabler
,
421 &event_notifier_group
->enablers_head
, node
)
422 lttng_event_notifier_enabler_destroy(event_notifier_enabler
);
424 list_for_each_entry_safe(event_notifier_priv
, tmpevent_notifier_priv
,
425 &event_notifier_group
->event_notifiers_head
, node
)
426 _lttng_event_destroy(&event_notifier_priv
->pub
->parent
);
428 if (event_notifier_group
->error_counter
) {
429 struct lttng_counter
*error_counter
= event_notifier_group
->error_counter
;
431 error_counter
->ops
->counter_destroy(error_counter
->counter
);
432 module_put(error_counter
->transport
->owner
);
433 lttng_kvfree(error_counter
);
434 event_notifier_group
->error_counter
= NULL
;
437 event_notifier_group
->ops
->priv
->channel_destroy(event_notifier_group
->chan
);
438 module_put(event_notifier_group
->transport
->owner
);
439 list_del(&event_notifier_group
->node
);
441 mutex_unlock(&sessions_mutex
);
442 lttng_kvfree(event_notifier_group
);
445 int lttng_session_statedump(struct lttng_kernel_session
*session
)
449 mutex_lock(&sessions_mutex
);
450 ret
= lttng_statedump_start(session
);
451 mutex_unlock(&sessions_mutex
);
455 int lttng_session_enable(struct lttng_kernel_session
*session
)
458 struct lttng_channel
*chan
;
460 mutex_lock(&sessions_mutex
);
461 if (session
->active
) {
466 /* Set transient enabler state to "enabled" */
467 session
->priv
->tstate
= 1;
469 /* We need to sync enablers with session before activation. */
470 lttng_session_sync_event_enablers(session
);
473 * Snapshot the number of events per channel to know the type of header
476 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
477 if (chan
->header_type
)
478 continue; /* don't change it if session stop/restart */
479 if (chan
->free_event_id
< 31)
480 chan
->header_type
= 1; /* compact */
482 chan
->header_type
= 2; /* large */
485 /* Clear each stream's quiescent state. */
486 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
487 if (chan
->channel_type
!= METADATA_CHANNEL
)
488 lib_ring_buffer_clear_quiescent_channel(chan
->chan
);
491 WRITE_ONCE(session
->active
, 1);
492 WRITE_ONCE(session
->priv
->been_active
, 1);
493 ret
= _lttng_session_metadata_statedump(session
);
495 WRITE_ONCE(session
->active
, 0);
498 ret
= lttng_statedump_start(session
);
500 WRITE_ONCE(session
->active
, 0);
502 mutex_unlock(&sessions_mutex
);
506 int lttng_session_disable(struct lttng_kernel_session
*session
)
509 struct lttng_channel
*chan
;
511 mutex_lock(&sessions_mutex
);
512 if (!session
->active
) {
516 WRITE_ONCE(session
->active
, 0);
518 /* Set transient enabler state to "disabled" */
519 session
->priv
->tstate
= 0;
520 lttng_session_sync_event_enablers(session
);
522 /* Set each stream's quiescent state. */
523 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
524 if (chan
->channel_type
!= METADATA_CHANNEL
)
525 lib_ring_buffer_set_quiescent_channel(chan
->chan
);
528 mutex_unlock(&sessions_mutex
);
532 int lttng_session_metadata_regenerate(struct lttng_kernel_session
*session
)
535 struct lttng_channel
*chan
;
536 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
537 struct lttng_metadata_cache
*cache
= session
->priv
->metadata_cache
;
538 struct lttng_metadata_stream
*stream
;
540 mutex_lock(&sessions_mutex
);
541 if (!session
->active
) {
546 mutex_lock(&cache
->lock
);
547 memset(cache
->data
, 0, cache
->cache_alloc
);
548 cache
->metadata_written
= 0;
550 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
) {
551 stream
->metadata_out
= 0;
552 stream
->metadata_in
= 0;
554 mutex_unlock(&cache
->lock
);
556 session
->priv
->metadata_dumped
= 0;
557 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
558 chan
->metadata_dumped
= 0;
561 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
562 event_recorder_priv
->metadata_dumped
= 0;
565 ret
= _lttng_session_metadata_statedump(session
);
568 mutex_unlock(&sessions_mutex
);
572 int lttng_channel_enable(struct lttng_channel
*channel
)
576 mutex_lock(&sessions_mutex
);
577 if (channel
->channel_type
== METADATA_CHANNEL
) {
581 if (channel
->enabled
) {
585 /* Set transient enabler state to "enabled" */
587 lttng_session_sync_event_enablers(channel
->session
);
588 /* Set atomically the state to "enabled" */
589 WRITE_ONCE(channel
->enabled
, 1);
591 mutex_unlock(&sessions_mutex
);
595 int lttng_channel_disable(struct lttng_channel
*channel
)
599 mutex_lock(&sessions_mutex
);
600 if (channel
->channel_type
== METADATA_CHANNEL
) {
604 if (!channel
->enabled
) {
608 /* Set atomically the state to "disabled" */
609 WRITE_ONCE(channel
->enabled
, 0);
610 /* Set transient enabler state to "enabled" */
612 lttng_session_sync_event_enablers(channel
->session
);
614 mutex_unlock(&sessions_mutex
);
618 int lttng_event_enable(struct lttng_kernel_event_common
*event
)
622 mutex_lock(&sessions_mutex
);
623 switch (event
->type
) {
624 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
626 struct lttng_kernel_event_recorder
*event_recorder
=
627 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
629 if (event_recorder
->chan
->channel_type
== METADATA_CHANNEL
) {
635 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
636 switch (event
->priv
->instrumentation
) {
637 case LTTNG_KERNEL_ABI_KRETPROBE
:
648 if (event
->enabled
) {
652 switch (event
->priv
->instrumentation
) {
653 case LTTNG_KERNEL_ABI_TRACEPOINT
: /* Fall-through */
654 case LTTNG_KERNEL_ABI_SYSCALL
:
658 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
659 case LTTNG_KERNEL_ABI_UPROBE
:
660 WRITE_ONCE(event
->enabled
, 1);
663 case LTTNG_KERNEL_ABI_KRETPROBE
:
664 ret
= lttng_kretprobes_event_enable_state(event
, 1);
667 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
668 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
674 mutex_unlock(&sessions_mutex
);
678 int lttng_event_disable(struct lttng_kernel_event_common
*event
)
682 mutex_lock(&sessions_mutex
);
683 switch (event
->type
) {
684 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
686 struct lttng_kernel_event_recorder
*event_recorder
=
687 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
689 if (event_recorder
->chan
->channel_type
== METADATA_CHANNEL
) {
695 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
696 switch (event
->priv
->instrumentation
) {
697 case LTTNG_KERNEL_ABI_KRETPROBE
:
708 if (!event
->enabled
) {
712 switch (event
->priv
->instrumentation
) {
713 case LTTNG_KERNEL_ABI_TRACEPOINT
: /* Fall-through */
714 case LTTNG_KERNEL_ABI_SYSCALL
:
718 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
719 case LTTNG_KERNEL_ABI_UPROBE
:
720 WRITE_ONCE(event
->enabled
, 0);
723 case LTTNG_KERNEL_ABI_KRETPROBE
:
724 ret
= lttng_kretprobes_event_enable_state(event
, 0);
727 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
728 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
734 mutex_unlock(&sessions_mutex
);
738 struct lttng_channel
*lttng_channel_create(struct lttng_kernel_session
*session
,
739 const char *transport_name
,
741 size_t subbuf_size
, size_t num_subbuf
,
742 unsigned int switch_timer_interval
,
743 unsigned int read_timer_interval
,
744 enum channel_type channel_type
)
746 struct lttng_channel
*chan
;
747 struct lttng_transport
*transport
= NULL
;
749 mutex_lock(&sessions_mutex
);
750 if (session
->priv
->been_active
&& channel_type
!= METADATA_CHANNEL
)
751 goto active
; /* Refuse to add channel to active session */
752 transport
= lttng_transport_find(transport_name
);
754 printk(KERN_WARNING
"LTTng: transport %s not found\n",
758 if (!try_module_get(transport
->owner
)) {
759 printk(KERN_WARNING
"LTTng: Can't lock transport module.\n");
762 chan
= kzalloc(sizeof(struct lttng_channel
), GFP_KERNEL
);
765 chan
->session
= session
;
766 chan
->id
= session
->priv
->free_chan_id
++;
767 chan
->ops
= &transport
->ops
;
769 * Note: the channel creation op already writes into the packet
770 * headers. Therefore the "chan" information used as input
771 * should be already accessible.
773 chan
->chan
= transport
->ops
.priv
->channel_create(transport_name
,
774 chan
, buf_addr
, subbuf_size
, num_subbuf
,
775 switch_timer_interval
, read_timer_interval
);
780 chan
->transport
= transport
;
781 chan
->channel_type
= channel_type
;
782 list_add(&chan
->list
, &session
->priv
->chan
);
783 mutex_unlock(&sessions_mutex
);
790 module_put(transport
->owner
);
793 mutex_unlock(&sessions_mutex
);
798 * Only used internally at session destruction for per-cpu channels, and
799 * when metadata channel is released.
800 * Needs to be called with sessions mutex held.
803 void _lttng_channel_destroy(struct lttng_channel
*chan
)
805 chan
->ops
->priv
->channel_destroy(chan
->chan
);
806 module_put(chan
->transport
->owner
);
807 list_del(&chan
->list
);
808 lttng_kernel_destroy_context(chan
->ctx
);
812 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
)
814 BUG_ON(chan
->channel_type
!= METADATA_CHANNEL
);
816 /* Protect the metadata cache with the sessions_mutex. */
817 mutex_lock(&sessions_mutex
);
818 _lttng_channel_destroy(chan
);
819 mutex_unlock(&sessions_mutex
);
821 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy
);
824 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream
*stream
)
826 stream
->finalized
= 1;
827 wake_up_interruptible(&stream
->read_wait
);
832 * Supports event creation while tracing session is active.
833 * Needs to be called with sessions mutex held.
835 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_channel
*chan
,
836 struct lttng_kernel_abi_event
*event_param
,
837 const struct lttng_kernel_event_desc
*event_desc
,
838 enum lttng_kernel_abi_instrumentation itype
)
840 struct lttng_kernel_session
*session
= chan
->session
;
841 struct lttng_kernel_event_recorder
*event_recorder
;
842 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
843 const char *event_name
;
844 struct hlist_head
*head
;
847 if (chan
->free_event_id
== -1U) {
853 case LTTNG_KERNEL_ABI_TRACEPOINT
:
854 event_name
= event_desc
->event_name
;
857 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
858 case LTTNG_KERNEL_ABI_UPROBE
: /* Fall-through */
859 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
860 case LTTNG_KERNEL_ABI_SYSCALL
:
861 event_name
= event_param
->name
;
864 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
865 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
872 head
= utils_borrow_hash_table_bucket(session
->priv
->events_ht
.table
,
873 LTTNG_EVENT_HT_SIZE
, event_name
);
874 lttng_hlist_for_each_entry(event_recorder_priv
, head
, hlist
) {
875 WARN_ON_ONCE(!event_recorder_priv
->parent
.desc
);
876 if (!strncmp(event_recorder_priv
->parent
.desc
->event_name
, event_name
,
877 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
878 && chan
== event_recorder_priv
->pub
->chan
) {
884 event_recorder
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
885 if (!event_recorder
) {
889 event_recorder_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
890 if (!event_recorder_priv
) {
892 goto cache_private_error
;
894 event_recorder_priv
->pub
= event_recorder
;
895 event_recorder_priv
->parent
.pub
= &event_recorder
->parent
;
896 event_recorder
->priv
= event_recorder_priv
;
897 event_recorder
->parent
.priv
= &event_recorder_priv
->parent
;
898 event_recorder
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
900 event_recorder
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
901 event_recorder
->chan
= chan
;
902 event_recorder
->priv
->id
= chan
->free_event_id
++;
903 event_recorder
->priv
->parent
.instrumentation
= itype
;
904 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.filter_bytecode_runtime_head
);
905 INIT_LIST_HEAD(&event_recorder
->priv
->parent
.enablers_ref_head
);
908 case LTTNG_KERNEL_ABI_TRACEPOINT
:
909 /* Event will be enabled by enabler sync. */
910 event_recorder
->parent
.enabled
= 0;
911 event_recorder
->priv
->parent
.registered
= 0;
912 event_recorder
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
913 if (!event_recorder
->priv
->parent
.desc
) {
917 /* Populate lttng_event structure before event registration. */
921 case LTTNG_KERNEL_ABI_KPROBE
:
923 * Needs to be explicitly enabled after creation, since
924 * we may want to apply filters.
926 event_recorder
->parent
.enabled
= 0;
927 event_recorder
->priv
->parent
.registered
= 1;
929 * Populate lttng_event structure before event
933 ret
= lttng_kprobes_register_event(event_name
,
934 event_param
->u
.kprobe
.symbol_name
,
935 event_param
->u
.kprobe
.offset
,
936 event_param
->u
.kprobe
.addr
,
942 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
946 case LTTNG_KERNEL_ABI_KRETPROBE
:
948 struct lttng_kernel_event_recorder
*event_recorder_return
;
949 struct lttng_kernel_event_recorder_private
*event_recorder_return_priv
;
951 /* kretprobe defines 2 events */
953 * Needs to be explicitly enabled after creation, since
954 * we may want to apply filters.
956 event_recorder
->parent
.enabled
= 0;
957 event_recorder
->priv
->parent
.registered
= 1;
959 event_recorder_return
= kmem_cache_zalloc(event_recorder_cache
, GFP_KERNEL
);
960 if (!event_recorder_return
) {
964 event_recorder_return_priv
= kmem_cache_zalloc(event_recorder_private_cache
, GFP_KERNEL
);
965 if (!event_recorder_return_priv
) {
966 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
970 event_recorder_return_priv
->pub
= event_recorder_return
;
971 event_recorder_return_priv
->parent
.pub
= &event_recorder_return
->parent
;
972 event_recorder_return
->priv
= event_recorder_return_priv
;
973 event_recorder_return
->parent
.priv
= &event_recorder_return_priv
->parent
;
974 event_recorder_return
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_RECORDER
;
976 event_recorder_return
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
977 event_recorder_return
->chan
= chan
;
978 event_recorder_return
->priv
->id
= chan
->free_event_id
++;
979 event_recorder_return
->priv
->parent
.instrumentation
= itype
;
980 event_recorder_return
->parent
.enabled
= 0;
981 event_recorder_return
->priv
->parent
.registered
= 1;
982 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.filter_bytecode_runtime_head
);
983 INIT_LIST_HEAD(&event_recorder_return
->priv
->parent
.enablers_ref_head
);
985 * Populate lttng_event structure before kretprobe registration.
988 ret
= lttng_kretprobes_register(event_name
,
989 event_param
->u
.kretprobe
.symbol_name
,
990 event_param
->u
.kretprobe
.offset
,
991 event_param
->u
.kretprobe
.addr
,
992 event_recorder
, event_recorder_return
);
994 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
995 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
999 /* Take 2 refs on the module: one per event. */
1000 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1002 ret
= try_module_get(event_recorder_return
->priv
->parent
.desc
->owner
);
1004 ret
= _lttng_event_metadata_statedump(chan
->session
, chan
,
1005 event_recorder_return
);
1006 WARN_ON_ONCE(ret
> 0);
1008 kmem_cache_free(event_recorder_private_cache
, event_recorder_return_priv
);
1009 kmem_cache_free(event_recorder_cache
, event_recorder_return
);
1010 module_put(event_recorder_return
->priv
->parent
.desc
->owner
);
1011 module_put(event_recorder
->priv
->parent
.desc
->owner
);
1012 goto statedump_error
;
1014 list_add(&event_recorder_return
->priv
->node
, &chan
->session
->priv
->events
);
1018 case LTTNG_KERNEL_ABI_SYSCALL
:
1020 * Needs to be explicitly enabled after creation, since
1021 * we may want to apply filters.
1023 event_recorder
->parent
.enabled
= 0;
1024 event_recorder
->priv
->parent
.registered
= 0;
1025 event_recorder
->priv
->parent
.desc
= event_desc
;
1026 switch (event_param
->u
.syscall
.entryexit
) {
1027 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1029 goto register_error
;
1030 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1031 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1033 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1034 event_recorder
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1037 switch (event_param
->u
.syscall
.abi
) {
1038 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1040 goto register_error
;
1041 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1042 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1044 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1045 event_recorder
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1048 if (!event_recorder
->priv
->parent
.desc
) {
1050 goto register_error
;
1054 case LTTNG_KERNEL_ABI_UPROBE
:
1056 * Needs to be explicitly enabled after creation, since
1057 * we may want to apply filters.
1059 event_recorder
->parent
.enabled
= 0;
1060 event_recorder
->priv
->parent
.registered
= 1;
1063 * Populate lttng_event structure before event
1068 ret
= lttng_uprobes_register_event(event_param
->name
,
1069 event_param
->u
.uprobe
.fd
,
1072 goto register_error
;
1073 ret
= try_module_get(event_recorder
->priv
->parent
.desc
->owner
);
1077 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1078 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1082 goto register_error
;
1084 ret
= _lttng_event_metadata_statedump(chan
->session
, chan
, event_recorder
);
1085 WARN_ON_ONCE(ret
> 0);
1087 goto statedump_error
;
1089 hlist_add_head(&event_recorder
->priv
->hlist
, head
);
1090 list_add(&event_recorder
->priv
->node
, &chan
->session
->priv
->events
);
1091 return event_recorder
;
1094 /* If a statedump error occurs, events will not be readable. */
1096 kmem_cache_free(event_recorder_private_cache
, event_recorder_priv
);
1097 cache_private_error
:
1098 kmem_cache_free(event_recorder_cache
, event_recorder
);
1103 return ERR_PTR(ret
);
1106 struct lttng_kernel_event_notifier
*_lttng_event_notifier_create(
1107 const struct lttng_kernel_event_desc
*event_desc
,
1108 uint64_t token
, uint64_t error_counter_index
,
1109 struct lttng_event_notifier_group
*event_notifier_group
,
1110 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1111 enum lttng_kernel_abi_instrumentation itype
)
1113 struct lttng_kernel_event_notifier
*event_notifier
;
1114 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
1115 struct lttng_counter
*error_counter
;
1116 const char *event_name
;
1117 struct hlist_head
*head
;
1121 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1122 event_name
= event_desc
->event_name
;
1125 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
1126 case LTTNG_KERNEL_ABI_UPROBE
: /* Fall-through */
1127 case LTTNG_KERNEL_ABI_SYSCALL
:
1128 event_name
= event_notifier_param
->event
.name
;
1131 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
1132 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1133 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1140 head
= utils_borrow_hash_table_bucket(event_notifier_group
->event_notifiers_ht
.table
,
1141 LTTNG_EVENT_NOTIFIER_HT_SIZE
, event_name
);
1142 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
1143 WARN_ON_ONCE(!event_notifier_priv
->parent
.desc
);
1144 if (!strncmp(event_notifier_priv
->parent
.desc
->event_name
, event_name
,
1145 LTTNG_KERNEL_ABI_SYM_NAME_LEN
- 1)
1146 && event_notifier_group
== event_notifier_priv
->group
1147 && token
== event_notifier_priv
->parent
.user_token
) {
1153 event_notifier
= kmem_cache_zalloc(event_notifier_cache
, GFP_KERNEL
);
1154 if (!event_notifier
) {
1158 event_notifier_priv
= kmem_cache_zalloc(event_notifier_private_cache
, GFP_KERNEL
);
1159 if (!event_notifier_priv
) {
1161 goto cache_private_error
;
1163 event_notifier_priv
->pub
= event_notifier
;
1164 event_notifier_priv
->parent
.pub
= &event_notifier
->parent
;
1165 event_notifier
->priv
= event_notifier_priv
;
1166 event_notifier
->parent
.priv
= &event_notifier_priv
->parent
;
1167 event_notifier
->parent
.type
= LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
;
1169 event_notifier
->priv
->group
= event_notifier_group
;
1170 event_notifier
->priv
->parent
.user_token
= token
;
1171 event_notifier
->priv
->error_counter_index
= error_counter_index
;
1172 event_notifier
->priv
->num_captures
= 0;
1173 event_notifier
->priv
->parent
.instrumentation
= itype
;
1174 event_notifier
->notification_send
= lttng_event_notifier_notification_send
;
1175 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.filter_bytecode_runtime_head
);
1176 INIT_LIST_HEAD(&event_notifier
->priv
->parent
.enablers_ref_head
);
1177 INIT_LIST_HEAD(&event_notifier
->priv
->capture_bytecode_runtime_head
);
1178 event_notifier
->parent
.run_filter
= lttng_kernel_interpret_event_filter
;
1181 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1182 /* Event will be enabled by enabler sync. */
1183 event_notifier
->parent
.enabled
= 0;
1184 event_notifier
->priv
->parent
.registered
= 0;
1185 event_notifier
->priv
->parent
.desc
= lttng_event_desc_get(event_name
);
1186 if (!event_notifier
->priv
->parent
.desc
) {
1188 goto register_error
;
1190 /* Populate lttng_event_notifier structure before event registration. */
1194 case LTTNG_KERNEL_ABI_KPROBE
:
1196 * Needs to be explicitly enabled after creation, since
1197 * we may want to apply filters.
1199 event_notifier
->parent
.enabled
= 0;
1200 event_notifier
->priv
->parent
.registered
= 1;
1202 * Populate lttng_event_notifier structure before event
1206 ret
= lttng_kprobes_register_event_notifier(
1207 event_notifier_param
->event
.u
.kprobe
.symbol_name
,
1208 event_notifier_param
->event
.u
.kprobe
.offset
,
1209 event_notifier_param
->event
.u
.kprobe
.addr
,
1213 goto register_error
;
1215 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1219 case LTTNG_KERNEL_ABI_SYSCALL
:
1221 * Needs to be explicitly enabled after creation, since
1222 * we may want to apply filters.
1224 event_notifier
->parent
.enabled
= 0;
1225 event_notifier
->priv
->parent
.registered
= 0;
1226 event_notifier
->priv
->parent
.desc
= event_desc
;
1227 switch (event_notifier_param
->event
.u
.syscall
.entryexit
) {
1228 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1230 goto register_error
;
1231 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1232 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_ENTRY
;
1234 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1235 event_notifier
->priv
->parent
.u
.syscall
.entryexit
= LTTNG_SYSCALL_EXIT
;
1238 switch (event_notifier_param
->event
.u
.syscall
.abi
) {
1239 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1241 goto register_error
;
1242 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1243 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_NATIVE
;
1245 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1246 event_notifier
->priv
->parent
.u
.syscall
.abi
= LTTNG_SYSCALL_ABI_COMPAT
;
1250 if (!event_notifier
->priv
->parent
.desc
) {
1252 goto register_error
;
1256 case LTTNG_KERNEL_ABI_UPROBE
:
1258 * Needs to be explicitly enabled after creation, since
1259 * we may want to apply filters.
1261 event_notifier
->parent
.enabled
= 0;
1262 event_notifier
->priv
->parent
.registered
= 1;
1265 * Populate lttng_event_notifier structure before
1266 * event_notifier registration.
1270 ret
= lttng_uprobes_register_event_notifier(
1271 event_notifier_param
->event
.name
,
1272 event_notifier_param
->event
.u
.uprobe
.fd
,
1275 goto register_error
;
1276 ret
= try_module_get(event_notifier
->priv
->parent
.desc
->owner
);
1280 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
1281 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1282 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1286 goto register_error
;
1289 list_add(&event_notifier
->priv
->node
, &event_notifier_group
->event_notifiers_head
);
1290 hlist_add_head(&event_notifier
->priv
->hlist
, head
);
1293 * Clear the error counter bucket. The sessiond keeps track of which
1294 * bucket is currently in use. We trust it. The session lock
1295 * synchronizes against concurrent creation of the error
1298 error_counter
= event_notifier_group
->error_counter
;
1299 if (error_counter
) {
1300 size_t dimension_index
[1];
1303 * Check that the index is within the boundary of the counter.
1305 if (event_notifier
->priv
->error_counter_index
>= event_notifier_group
->error_counter_len
) {
1306 printk(KERN_INFO
"LTTng: event_notifier: Error counter index out-of-bound: counter-len=%zu, index=%llu\n",
1307 event_notifier_group
->error_counter_len
, event_notifier
->priv
->error_counter_index
);
1309 goto register_error
;
1312 dimension_index
[0] = event_notifier
->priv
->error_counter_index
;
1313 ret
= error_counter
->ops
->counter_clear(error_counter
->counter
, dimension_index
);
1315 printk(KERN_INFO
"LTTng: event_notifier: Unable to clear error counter bucket %llu\n",
1316 event_notifier
->priv
->error_counter_index
);
1317 goto register_error
;
1321 return event_notifier
;
1324 kmem_cache_free(event_notifier_private_cache
, event_notifier_priv
);
1325 cache_private_error
:
1326 kmem_cache_free(event_notifier_cache
, event_notifier
);
1330 return ERR_PTR(ret
);
1333 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1334 const size_t *dim_indexes
, int32_t cpu
,
1335 int64_t *val
, bool *overflow
, bool *underflow
)
1337 return counter
->ops
->counter_read(counter
->counter
, dim_indexes
,
1338 cpu
, val
, overflow
, underflow
);
1341 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1342 const size_t *dim_indexes
, int64_t *val
,
1343 bool *overflow
, bool *underflow
)
1345 return counter
->ops
->counter_aggregate(counter
->counter
, dim_indexes
,
1346 val
, overflow
, underflow
);
1349 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1350 const size_t *dim_indexes
)
1352 return counter
->ops
->counter_clear(counter
->counter
, dim_indexes
);
1355 struct lttng_kernel_event_recorder
*lttng_kernel_event_recorder_create(struct lttng_channel
*chan
,
1356 struct lttng_kernel_abi_event
*event_param
,
1357 const struct lttng_kernel_event_desc
*event_desc
,
1358 enum lttng_kernel_abi_instrumentation itype
)
1360 struct lttng_kernel_event_recorder
*event
;
1362 mutex_lock(&sessions_mutex
);
1363 event
= _lttng_kernel_event_recorder_create(chan
, event_param
, event_desc
, itype
);
1364 mutex_unlock(&sessions_mutex
);
1368 struct lttng_kernel_event_notifier
*lttng_event_notifier_create(
1369 const struct lttng_kernel_event_desc
*event_desc
,
1370 uint64_t id
, uint64_t error_counter_index
,
1371 struct lttng_event_notifier_group
*event_notifier_group
,
1372 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1373 enum lttng_kernel_abi_instrumentation itype
)
1375 struct lttng_kernel_event_notifier
*event_notifier
;
1377 mutex_lock(&sessions_mutex
);
1378 event_notifier
= _lttng_event_notifier_create(event_desc
, id
,
1379 error_counter_index
, event_notifier_group
,
1380 event_notifier_param
, itype
);
1381 mutex_unlock(&sessions_mutex
);
1382 return event_notifier
;
1385 /* Only used for tracepoints for now. */
1387 void register_event(struct lttng_kernel_event_recorder
*event_recorder
)
1389 const struct lttng_kernel_event_desc
*desc
;
1392 if (event_recorder
->priv
->parent
.registered
)
1395 desc
= event_recorder
->priv
->parent
.desc
;
1396 switch (event_recorder
->priv
->parent
.instrumentation
) {
1397 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1398 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1399 desc
->probe_callback
,
1403 case LTTNG_KERNEL_ABI_SYSCALL
:
1404 ret
= lttng_syscall_filter_enable_event(event_recorder
->chan
, event_recorder
);
1407 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
1408 case LTTNG_KERNEL_ABI_UPROBE
: /* Fall-through */
1409 case LTTNG_KERNEL_ABI_KRETPROBE
:
1413 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1414 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1419 event_recorder
->priv
->parent
.registered
= 1;
1423 * Only used internally at session destruction.
1425 int _lttng_event_unregister(struct lttng_kernel_event_recorder
*event_recorder
)
1427 struct lttng_kernel_event_common_private
*event_priv
= &event_recorder
->priv
->parent
;
1428 const struct lttng_kernel_event_desc
*desc
;
1431 if (!event_priv
->registered
)
1434 desc
= event_priv
->desc
;
1435 switch (event_priv
->instrumentation
) {
1436 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1437 ret
= lttng_wrapper_tracepoint_probe_unregister(event_priv
->desc
->event_kname
,
1438 event_priv
->desc
->probe_callback
,
1442 case LTTNG_KERNEL_ABI_KPROBE
:
1443 lttng_kprobes_unregister_event(event_recorder
);
1447 case LTTNG_KERNEL_ABI_KRETPROBE
:
1448 lttng_kretprobes_unregister(event_recorder
);
1452 case LTTNG_KERNEL_ABI_SYSCALL
:
1453 ret
= lttng_syscall_filter_disable_event(event_recorder
->chan
, event_recorder
);
1456 case LTTNG_KERNEL_ABI_NOOP
:
1460 case LTTNG_KERNEL_ABI_UPROBE
:
1461 lttng_uprobes_unregister_event(event_recorder
);
1465 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1470 event_priv
->registered
= 0;
1474 /* Only used for tracepoints for now. */
1476 void register_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1478 const struct lttng_kernel_event_desc
*desc
;
1481 if (event_notifier
->priv
->parent
.registered
)
1484 desc
= event_notifier
->priv
->parent
.desc
;
1485 switch (event_notifier
->priv
->parent
.instrumentation
) {
1486 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1487 ret
= lttng_wrapper_tracepoint_probe_register(desc
->event_kname
,
1488 desc
->probe_callback
,
1492 case LTTNG_KERNEL_ABI_SYSCALL
:
1493 ret
= lttng_syscall_filter_enable_event_notifier(event_notifier
);
1496 case LTTNG_KERNEL_ABI_KPROBE
: /* Fall-through */
1497 case LTTNG_KERNEL_ABI_UPROBE
:
1501 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
1502 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1503 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1508 event_notifier
->priv
->parent
.registered
= 1;
1512 int _lttng_event_notifier_unregister(
1513 struct lttng_kernel_event_notifier
*event_notifier
)
1515 const struct lttng_kernel_event_desc
*desc
;
1518 if (!event_notifier
->priv
->parent
.registered
)
1521 desc
= event_notifier
->priv
->parent
.desc
;
1522 switch (event_notifier
->priv
->parent
.instrumentation
) {
1523 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1524 ret
= lttng_wrapper_tracepoint_probe_unregister(event_notifier
->priv
->parent
.desc
->event_kname
,
1525 event_notifier
->priv
->parent
.desc
->probe_callback
,
1529 case LTTNG_KERNEL_ABI_KPROBE
:
1530 lttng_kprobes_unregister_event_notifier(event_notifier
);
1534 case LTTNG_KERNEL_ABI_UPROBE
:
1535 lttng_uprobes_unregister_event_notifier(event_notifier
);
1539 case LTTNG_KERNEL_ABI_SYSCALL
:
1540 ret
= lttng_syscall_filter_disable_event_notifier(event_notifier
);
1543 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
1544 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1545 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1550 event_notifier
->priv
->parent
.registered
= 0;
1555 * Only used internally at session destruction.
1558 void _lttng_event_destroy(struct lttng_kernel_event_common
*event
)
1560 struct lttng_kernel_event_common_private
*event_priv
= event
->priv
;
1561 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1563 lttng_free_event_filter_runtime(event
);
1564 /* Free event enabler refs */
1565 list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1566 &event_priv
->enablers_ref_head
, node
)
1569 switch (event
->type
) {
1570 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
1572 struct lttng_kernel_event_recorder
*event_recorder
=
1573 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
1575 switch (event_priv
->instrumentation
) {
1576 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1577 lttng_event_desc_put(event_priv
->desc
);
1580 case LTTNG_KERNEL_ABI_KPROBE
:
1581 module_put(event_priv
->desc
->owner
);
1582 lttng_kprobes_destroy_event_private(event_recorder
);
1585 case LTTNG_KERNEL_ABI_KRETPROBE
:
1586 module_put(event_priv
->desc
->owner
);
1587 lttng_kretprobes_destroy_private(event_recorder
);
1590 case LTTNG_KERNEL_ABI_SYSCALL
:
1593 case LTTNG_KERNEL_ABI_UPROBE
:
1594 module_put(event_priv
->desc
->owner
);
1595 lttng_uprobes_destroy_event_private(event_recorder
);
1598 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1599 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1603 list_del(&event_recorder
->priv
->node
);
1604 kmem_cache_free(event_recorder_private_cache
, event_recorder
->priv
);
1605 kmem_cache_free(event_recorder_cache
, event_recorder
);
1608 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
1610 struct lttng_kernel_event_notifier
*event_notifier
=
1611 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
1613 switch (event_notifier
->priv
->parent
.instrumentation
) {
1614 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1615 lttng_event_desc_put(event_notifier
->priv
->parent
.desc
);
1618 case LTTNG_KERNEL_ABI_KPROBE
:
1619 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1620 lttng_kprobes_destroy_event_notifier_private(event_notifier
);
1623 case LTTNG_KERNEL_ABI_SYSCALL
:
1626 case LTTNG_KERNEL_ABI_UPROBE
:
1627 module_put(event_notifier
->priv
->parent
.desc
->owner
);
1628 lttng_uprobes_destroy_event_notifier_private(event_notifier
);
1631 case LTTNG_KERNEL_ABI_KRETPROBE
: /* Fall-through */
1632 case LTTNG_KERNEL_ABI_FUNCTION
: /* Fall-through */
1633 case LTTNG_KERNEL_ABI_NOOP
: /* Fall-through */
1637 list_del(&event_notifier
->priv
->node
);
1638 kmem_cache_free(event_notifier_private_cache
, event_notifier
->priv
);
1639 kmem_cache_free(event_notifier_cache
, event_notifier
);
1647 struct lttng_id_tracker
*get_tracker(struct lttng_kernel_session
*session
,
1648 enum tracker_type tracker_type
)
1650 switch (tracker_type
) {
1652 return &session
->pid_tracker
;
1654 return &session
->vpid_tracker
;
1656 return &session
->uid_tracker
;
1658 return &session
->vuid_tracker
;
1660 return &session
->gid_tracker
;
1662 return &session
->vgid_tracker
;
1669 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1670 enum tracker_type tracker_type
, int id
)
1672 struct lttng_id_tracker
*tracker
;
1675 tracker
= get_tracker(session
, tracker_type
);
1680 mutex_lock(&sessions_mutex
);
1682 /* track all ids: destroy tracker. */
1683 lttng_id_tracker_destroy(tracker
, true);
1686 ret
= lttng_id_tracker_add(tracker
, id
);
1688 mutex_unlock(&sessions_mutex
);
1692 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1693 enum tracker_type tracker_type
, int id
)
1695 struct lttng_id_tracker
*tracker
;
1698 tracker
= get_tracker(session
, tracker_type
);
1703 mutex_lock(&sessions_mutex
);
1705 /* untrack all ids: replace by empty tracker. */
1706 ret
= lttng_id_tracker_empty_set(tracker
);
1708 ret
= lttng_id_tracker_del(tracker
, id
);
1710 mutex_unlock(&sessions_mutex
);
1715 void *id_list_start(struct seq_file
*m
, loff_t
*pos
)
1717 struct lttng_id_tracker
*id_tracker
= m
->private;
1718 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1719 struct lttng_id_hash_node
*e
;
1722 mutex_lock(&sessions_mutex
);
1724 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1725 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1727 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1733 /* ID tracker disabled. */
1734 if (iter
>= *pos
&& iter
== 0) {
1735 return id_tracker_p
; /* empty tracker */
1743 /* Called with sessions_mutex held. */
1745 void *id_list_next(struct seq_file
*m
, void *p
, loff_t
*ppos
)
1747 struct lttng_id_tracker
*id_tracker
= m
->private;
1748 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1749 struct lttng_id_hash_node
*e
;
1754 for (i
= 0; i
< LTTNG_ID_TABLE_SIZE
; i
++) {
1755 struct hlist_head
*head
= &id_tracker_p
->id_hash
[i
];
1757 lttng_hlist_for_each_entry(e
, head
, hlist
) {
1758 if (iter
++ >= *ppos
)
1763 /* ID tracker disabled. */
1764 if (iter
>= *ppos
&& iter
== 0)
1765 return p
; /* empty tracker */
1774 void id_list_stop(struct seq_file
*m
, void *p
)
1776 mutex_unlock(&sessions_mutex
);
1780 int id_list_show(struct seq_file
*m
, void *p
)
1782 struct lttng_id_tracker
*id_tracker
= m
->private;
1783 struct lttng_id_tracker_rcu
*id_tracker_p
= id_tracker
->p
;
1786 if (p
== id_tracker_p
) {
1787 /* Tracker disabled. */
1790 const struct lttng_id_hash_node
*e
= p
;
1792 id
= lttng_id_tracker_get_node_id(e
);
1794 switch (id_tracker
->tracker_type
) {
1796 seq_printf(m
, "process { pid = %d; };\n", id
);
1799 seq_printf(m
, "process { vpid = %d; };\n", id
);
1802 seq_printf(m
, "user { uid = %d; };\n", id
);
1805 seq_printf(m
, "user { vuid = %d; };\n", id
);
1808 seq_printf(m
, "group { gid = %d; };\n", id
);
1811 seq_printf(m
, "group { vgid = %d; };\n", id
);
1814 seq_printf(m
, "UNKNOWN { field = %d };\n", id
);
1820 const struct seq_operations lttng_tracker_ids_list_seq_ops
= {
1821 .start
= id_list_start
,
1822 .next
= id_list_next
,
1823 .stop
= id_list_stop
,
1824 .show
= id_list_show
,
1828 int lttng_tracker_ids_list_open(struct inode
*inode
, struct file
*file
)
1830 return seq_open(file
, <tng_tracker_ids_list_seq_ops
);
1834 int lttng_tracker_ids_list_release(struct inode
*inode
, struct file
*file
)
1836 struct seq_file
*m
= file
->private_data
;
1837 struct lttng_id_tracker
*id_tracker
= m
->private;
1840 WARN_ON_ONCE(!id_tracker
);
1841 ret
= seq_release(inode
, file
);
1843 fput(id_tracker
->session
->priv
->file
);
1847 const struct file_operations lttng_tracker_ids_list_fops
= {
1848 .owner
= THIS_MODULE
,
1849 .open
= lttng_tracker_ids_list_open
,
1851 .llseek
= seq_lseek
,
1852 .release
= lttng_tracker_ids_list_release
,
1855 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1856 enum tracker_type tracker_type
)
1858 struct file
*tracker_ids_list_file
;
1862 file_fd
= lttng_get_unused_fd();
1868 tracker_ids_list_file
= anon_inode_getfile("[lttng_tracker_ids_list]",
1869 <tng_tracker_ids_list_fops
,
1871 if (IS_ERR(tracker_ids_list_file
)) {
1872 ret
= PTR_ERR(tracker_ids_list_file
);
1875 if (!atomic_long_add_unless(&session
->priv
->file
->f_count
, 1, LONG_MAX
)) {
1877 goto refcount_error
;
1879 ret
= lttng_tracker_ids_list_fops
.open(NULL
, tracker_ids_list_file
);
1882 m
= tracker_ids_list_file
->private_data
;
1884 m
->private = get_tracker(session
, tracker_type
);
1885 BUG_ON(!m
->private);
1886 fd_install(file_fd
, tracker_ids_list_file
);
1891 atomic_long_dec(&session
->priv
->file
->f_count
);
1893 fput(tracker_ids_list_file
);
1895 put_unused_fd(file_fd
);
1901 * Enabler management.
1904 int lttng_match_enabler_star_glob(const char *desc_name
,
1905 const char *pattern
)
1907 if (!strutils_star_glob_match(pattern
, LTTNG_SIZE_MAX
,
1908 desc_name
, LTTNG_SIZE_MAX
))
1914 int lttng_match_enabler_name(const char *desc_name
,
1917 if (strcmp(desc_name
, name
))
1922 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
1923 struct lttng_enabler
*enabler
)
1925 const char *desc_name
, *enabler_name
;
1926 bool compat
= false, entry
= false;
1928 enabler_name
= enabler
->event_param
.name
;
1929 switch (enabler
->event_param
.instrumentation
) {
1930 case LTTNG_KERNEL_ABI_TRACEPOINT
:
1931 desc_name
= desc
->event_name
;
1932 switch (enabler
->format_type
) {
1933 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1934 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1935 case LTTNG_ENABLER_FORMAT_NAME
:
1936 return lttng_match_enabler_name(desc_name
, enabler_name
);
1942 case LTTNG_KERNEL_ABI_SYSCALL
:
1943 desc_name
= desc
->event_name
;
1944 if (!strncmp(desc_name
, "compat_", strlen("compat_"))) {
1945 desc_name
+= strlen("compat_");
1948 if (!strncmp(desc_name
, "syscall_exit_",
1949 strlen("syscall_exit_"))) {
1950 desc_name
+= strlen("syscall_exit_");
1951 } else if (!strncmp(desc_name
, "syscall_entry_",
1952 strlen("syscall_entry_"))) {
1953 desc_name
+= strlen("syscall_entry_");
1959 switch (enabler
->event_param
.u
.syscall
.entryexit
) {
1960 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
:
1962 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY
:
1966 case LTTNG_KERNEL_ABI_SYSCALL_EXIT
:
1973 switch (enabler
->event_param
.u
.syscall
.abi
) {
1974 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
:
1976 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE
:
1980 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT
:
1987 switch (enabler
->event_param
.u
.syscall
.match
) {
1988 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
:
1989 switch (enabler
->format_type
) {
1990 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1991 return lttng_match_enabler_star_glob(desc_name
, enabler_name
);
1992 case LTTNG_ENABLER_FORMAT_NAME
:
1993 return lttng_match_enabler_name(desc_name
, enabler_name
);
1998 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR
:
1999 return -EINVAL
; /* Not implemented. */
2012 int lttng_event_enabler_match_event(struct lttng_event_enabler
*event_enabler
,
2013 struct lttng_kernel_event_recorder
*event_recorder
)
2015 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(
2018 if (base_enabler
->event_param
.instrumentation
!= event_recorder
->priv
->parent
.instrumentation
)
2020 if (lttng_desc_match_enabler(event_recorder
->priv
->parent
.desc
, base_enabler
)
2021 && event_recorder
->chan
== event_enabler
->chan
)
2028 int lttng_event_notifier_enabler_match_event_notifier(struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2029 struct lttng_kernel_event_notifier
*event_notifier
)
2031 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(
2032 event_notifier_enabler
);
2034 if (base_enabler
->event_param
.instrumentation
!= event_notifier
->priv
->parent
.instrumentation
)
2036 if (lttng_desc_match_enabler(event_notifier
->priv
->parent
.desc
, base_enabler
)
2037 && event_notifier
->priv
->group
== event_notifier_enabler
->group
2038 && event_notifier
->priv
->parent
.user_token
== event_notifier_enabler
->base
.user_token
)
2045 struct lttng_enabler_ref
*lttng_enabler_ref(
2046 struct list_head
*enablers_ref_list
,
2047 struct lttng_enabler
*enabler
)
2049 struct lttng_enabler_ref
*enabler_ref
;
2051 list_for_each_entry(enabler_ref
, enablers_ref_list
, node
) {
2052 if (enabler_ref
->ref
== enabler
)
2059 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2061 struct lttng_kernel_session
*session
= event_enabler
->chan
->session
;
2062 struct lttng_kernel_probe_desc
*probe_desc
;
2063 const struct lttng_kernel_event_desc
*desc
;
2065 struct list_head
*probe_list
;
2067 probe_list
= lttng_get_probe_list_head();
2069 * For each probe event, if we find that a probe event matches
2070 * our enabler, create an associated lttng_event if not
2073 list_for_each_entry(probe_desc
, probe_list
, head
) {
2074 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2076 struct hlist_head
*head
;
2077 struct lttng_kernel_event_recorder_private
*event_recorder_private
;
2078 struct lttng_kernel_event_recorder
*event_recorder
;
2080 desc
= probe_desc
->event_desc
[i
];
2081 if (!lttng_desc_match_enabler(desc
,
2082 lttng_event_enabler_as_enabler(event_enabler
)))
2086 * Check if already created.
2088 head
= utils_borrow_hash_table_bucket(
2089 session
->priv
->events_ht
.table
, LTTNG_EVENT_HT_SIZE
,
2091 lttng_hlist_for_each_entry(event_recorder_private
, head
, hlist
) {
2092 if (event_recorder_private
->parent
.desc
== desc
2093 && event_recorder_private
->pub
->chan
== event_enabler
->chan
)
2100 * We need to create an event for this
2103 event_recorder
= _lttng_kernel_event_recorder_create(event_enabler
->chan
,
2104 NULL
, desc
, LTTNG_KERNEL_ABI_TRACEPOINT
);
2105 if (!event_recorder
) {
2106 printk(KERN_INFO
"LTTng: Unable to create event %s\n",
2107 probe_desc
->event_desc
[i
]->event_name
);
2114 void lttng_create_tracepoint_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2116 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2117 struct lttng_kernel_probe_desc
*probe_desc
;
2118 const struct lttng_kernel_event_desc
*desc
;
2120 struct list_head
*probe_list
;
2122 probe_list
= lttng_get_probe_list_head();
2124 * For each probe event, if we find that a probe event matches
2125 * our enabler, create an associated lttng_event_notifier if not
2128 list_for_each_entry(probe_desc
, probe_list
, head
) {
2129 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
2131 struct hlist_head
*head
;
2132 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2133 struct lttng_kernel_event_notifier
*event_notifier
;
2135 desc
= probe_desc
->event_desc
[i
];
2136 if (!lttng_desc_match_enabler(desc
,
2137 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)))
2141 * Check if already created.
2143 head
= utils_borrow_hash_table_bucket(
2144 event_notifier_group
->event_notifiers_ht
.table
,
2145 LTTNG_EVENT_NOTIFIER_HT_SIZE
, desc
->event_name
);
2146 lttng_hlist_for_each_entry(event_notifier_priv
, head
, hlist
) {
2147 if (event_notifier_priv
->parent
.desc
== desc
2148 && event_notifier_priv
->parent
.user_token
== event_notifier_enabler
->base
.user_token
)
2155 * We need to create a event_notifier for this event probe.
2157 event_notifier
= _lttng_event_notifier_create(desc
,
2158 event_notifier_enabler
->base
.user_token
,
2159 event_notifier_enabler
->error_counter_index
,
2160 event_notifier_group
, NULL
,
2161 LTTNG_KERNEL_ABI_TRACEPOINT
);
2162 if (IS_ERR(event_notifier
)) {
2163 printk(KERN_INFO
"Unable to create event_notifier %s\n",
2164 probe_desc
->event_desc
[i
]->event_name
);
2171 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2175 ret
= lttng_syscalls_register_event(event_enabler
);
2180 void lttng_create_syscall_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2184 ret
= lttng_syscalls_register_event_notifier(event_notifier_enabler
);
2186 ret
= lttng_syscalls_create_matching_event_notifiers(event_notifier_enabler
);
2191 * Create struct lttng_kernel_event_recorder if it is missing and present in the list of
2192 * tracepoint probes.
2193 * Should be called with sessions mutex held.
2196 void lttng_create_event_if_missing(struct lttng_event_enabler
*event_enabler
)
2198 switch (event_enabler
->base
.event_param
.instrumentation
) {
2199 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2200 lttng_create_tracepoint_event_if_missing(event_enabler
);
2203 case LTTNG_KERNEL_ABI_SYSCALL
:
2204 lttng_create_syscall_event_if_missing(event_enabler
);
2214 * Create events associated with an event_enabler (if not already present),
2215 * and add backward reference from the event to the enabler.
2216 * Should be called with sessions mutex held.
2219 int lttng_event_enabler_ref_events(struct lttng_event_enabler
*event_enabler
)
2221 struct lttng_channel
*chan
= event_enabler
->chan
;
2222 struct lttng_kernel_session
*session
= event_enabler
->chan
->session
;
2223 struct lttng_enabler
*base_enabler
= lttng_event_enabler_as_enabler(event_enabler
);
2224 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2226 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2227 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2228 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2229 !strcmp(base_enabler
->event_param
.name
, "*")) {
2230 int enabled
= base_enabler
->enabled
;
2231 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2233 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2234 WRITE_ONCE(chan
->syscall_all_entry
, enabled
);
2236 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2237 WRITE_ONCE(chan
->syscall_all_exit
, enabled
);
2240 /* First ensure that probe events are created for this enabler. */
2241 lttng_create_event_if_missing(event_enabler
);
2243 /* For each event matching event_enabler in session event list. */
2244 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2245 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2246 struct lttng_enabler_ref
*enabler_ref
;
2248 if (!lttng_event_enabler_match_event(event_enabler
, event_recorder
))
2250 enabler_ref
= lttng_enabler_ref(&event_recorder_priv
->parent
.enablers_ref_head
,
2251 lttng_event_enabler_as_enabler(event_enabler
));
2254 * If no backward ref, create it.
2255 * Add backward ref from event to event_enabler.
2257 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2260 enabler_ref
->ref
= lttng_event_enabler_as_enabler(event_enabler
);
2261 list_add(&enabler_ref
->node
,
2262 &event_recorder_priv
->parent
.enablers_ref_head
);
2266 * Link filter bytecodes if not linked yet.
2268 lttng_enabler_link_bytecode(event_recorder_priv
->parent
.desc
,
2270 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
,
2271 <tng_event_enabler_as_enabler(event_enabler
)->filter_bytecode_head
);
2277 * Create struct lttng_kernel_event_notifier if it is missing and present in the list of
2278 * tracepoint probes.
2279 * Should be called with sessions mutex held.
2282 void lttng_create_event_notifier_if_missing(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2284 switch (event_notifier_enabler
->base
.event_param
.instrumentation
) {
2285 case LTTNG_KERNEL_ABI_TRACEPOINT
:
2286 lttng_create_tracepoint_event_notifier_if_missing(event_notifier_enabler
);
2289 case LTTNG_KERNEL_ABI_SYSCALL
:
2290 lttng_create_syscall_event_notifier_if_missing(event_notifier_enabler
);
2300 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2303 int lttng_event_notifier_enabler_ref_event_notifiers(
2304 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2306 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2307 struct lttng_enabler
*base_enabler
= lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2308 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2310 if (base_enabler
->event_param
.instrumentation
== LTTNG_KERNEL_ABI_SYSCALL
&&
2311 base_enabler
->event_param
.u
.syscall
.abi
== LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL
&&
2312 base_enabler
->event_param
.u
.syscall
.match
== LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME
&&
2313 !strcmp(base_enabler
->event_param
.name
, "*")) {
2315 int enabled
= base_enabler
->enabled
;
2316 enum lttng_kernel_abi_syscall_entryexit entryexit
= base_enabler
->event_param
.u
.syscall
.entryexit
;
2318 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRY
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2319 WRITE_ONCE(event_notifier_group
->syscall_all_entry
, enabled
);
2321 if (entryexit
== LTTNG_KERNEL_ABI_SYSCALL_EXIT
|| entryexit
== LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT
)
2322 WRITE_ONCE(event_notifier_group
->syscall_all_exit
, enabled
);
2326 /* First ensure that probe event_notifiers are created for this enabler. */
2327 lttng_create_event_notifier_if_missing(event_notifier_enabler
);
2329 /* Link the created event_notifier with its associated enabler. */
2330 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2331 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2332 struct lttng_enabler_ref
*enabler_ref
;
2334 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler
, event_notifier
))
2337 enabler_ref
= lttng_enabler_ref(&event_notifier_priv
->parent
.enablers_ref_head
,
2338 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2341 * If no backward ref, create it.
2342 * Add backward ref from event_notifier to enabler.
2344 enabler_ref
= kzalloc(sizeof(*enabler_ref
), GFP_KERNEL
);
2348 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2349 event_notifier_enabler
);
2350 list_add(&enabler_ref
->node
,
2351 &event_notifier_priv
->parent
.enablers_ref_head
);
2355 * Link filter bytecodes if not linked yet.
2357 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2358 lttng_static_ctx
, &event_notifier_priv
->parent
.filter_bytecode_runtime_head
,
2359 <tng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->filter_bytecode_head
);
2361 /* Link capture bytecodes if not linked yet. */
2362 lttng_enabler_link_bytecode(event_notifier_priv
->parent
.desc
,
2363 lttng_static_ctx
, &event_notifier_priv
->capture_bytecode_runtime_head
,
2364 &event_notifier_enabler
->capture_bytecode_head
);
2366 event_notifier_priv
->num_captures
= event_notifier_enabler
->num_captures
;
2372 * Called at module load: connect the probe on all enablers matching
2374 * Called with sessions lock held.
2376 int lttng_fix_pending_events(void)
2378 struct lttng_kernel_session_private
*session_priv
;
2380 list_for_each_entry(session_priv
, &sessions
, list
)
2381 lttng_session_lazy_sync_event_enablers(session_priv
->pub
);
2385 static bool lttng_event_notifier_group_has_active_event_notifiers(
2386 struct lttng_event_notifier_group
*event_notifier_group
)
2388 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2390 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
,
2392 if (event_notifier_enabler
->base
.enabled
)
2398 bool lttng_event_notifier_active(void)
2400 struct lttng_event_notifier_group
*event_notifier_group
;
2402 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2403 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group
))
2409 int lttng_fix_pending_event_notifiers(void)
2411 struct lttng_event_notifier_group
*event_notifier_group
;
2413 list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
)
2414 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
2418 struct lttng_event_enabler
*lttng_event_enabler_create(
2419 enum lttng_enabler_format_type format_type
,
2420 struct lttng_kernel_abi_event
*event_param
,
2421 struct lttng_channel
*chan
)
2423 struct lttng_event_enabler
*event_enabler
;
2425 event_enabler
= kzalloc(sizeof(*event_enabler
), GFP_KERNEL
);
2428 event_enabler
->base
.format_type
= format_type
;
2429 INIT_LIST_HEAD(&event_enabler
->base
.filter_bytecode_head
);
2430 memcpy(&event_enabler
->base
.event_param
, event_param
,
2431 sizeof(event_enabler
->base
.event_param
));
2432 event_enabler
->chan
= chan
;
2434 event_enabler
->base
.enabled
= 0;
2435 mutex_lock(&sessions_mutex
);
2436 list_add(&event_enabler
->node
, &event_enabler
->chan
->session
->priv
->enablers_head
);
2437 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2438 mutex_unlock(&sessions_mutex
);
2439 return event_enabler
;
2442 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
)
2444 mutex_lock(&sessions_mutex
);
2445 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 1;
2446 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2447 mutex_unlock(&sessions_mutex
);
2451 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
)
2453 mutex_lock(&sessions_mutex
);
2454 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 0;
2455 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2456 mutex_unlock(&sessions_mutex
);
2461 int lttng_enabler_attach_filter_bytecode(struct lttng_enabler
*enabler
,
2462 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2464 struct lttng_kernel_bytecode_node
*bytecode_node
;
2465 uint32_t bytecode_len
;
2468 ret
= get_user(bytecode_len
, &bytecode
->len
);
2471 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2475 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2476 sizeof(*bytecode
) + bytecode_len
);
2480 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_FILTER
;
2481 bytecode_node
->enabler
= enabler
;
2482 /* Enforce length based on allocated size */
2483 bytecode_node
->bc
.len
= bytecode_len
;
2484 list_add_tail(&bytecode_node
->node
, &enabler
->filter_bytecode_head
);
2489 lttng_kvfree(bytecode_node
);
2493 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
2494 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2497 ret
= lttng_enabler_attach_filter_bytecode(
2498 lttng_event_enabler_as_enabler(event_enabler
), bytecode
);
2502 lttng_session_lazy_sync_event_enablers(event_enabler
->chan
->session
);
2509 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
2510 struct lttng_kernel_abi_event_callsite __user
*callsite
)
2513 switch (event
->priv
->instrumentation
) {
2514 case LTTNG_KERNEL_ABI_UPROBE
:
2515 return lttng_uprobes_event_add_callsite(event
, callsite
);
2522 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
2524 struct lttng_kernel_bytecode_node
*filter_node
, *tmp_filter_node
;
2526 /* Destroy filter bytecode */
2527 list_for_each_entry_safe(filter_node
, tmp_filter_node
,
2528 &enabler
->filter_bytecode_head
, node
) {
2529 lttng_kvfree(filter_node
);
2534 void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
)
2536 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler
));
2538 list_del(&event_enabler
->node
);
2539 kfree(event_enabler
);
2542 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
2543 struct lttng_event_notifier_group
*event_notifier_group
,
2544 enum lttng_enabler_format_type format_type
,
2545 struct lttng_kernel_abi_event_notifier
*event_notifier_param
)
2547 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2549 event_notifier_enabler
= kzalloc(sizeof(*event_notifier_enabler
), GFP_KERNEL
);
2550 if (!event_notifier_enabler
)
2553 event_notifier_enabler
->base
.format_type
= format_type
;
2554 INIT_LIST_HEAD(&event_notifier_enabler
->base
.filter_bytecode_head
);
2555 INIT_LIST_HEAD(&event_notifier_enabler
->capture_bytecode_head
);
2557 event_notifier_enabler
->error_counter_index
= event_notifier_param
->error_counter_index
;
2558 event_notifier_enabler
->num_captures
= 0;
2560 memcpy(&event_notifier_enabler
->base
.event_param
, &event_notifier_param
->event
,
2561 sizeof(event_notifier_enabler
->base
.event_param
));
2563 event_notifier_enabler
->base
.enabled
= 0;
2564 event_notifier_enabler
->base
.user_token
= event_notifier_param
->event
.token
;
2565 event_notifier_enabler
->group
= event_notifier_group
;
2567 mutex_lock(&sessions_mutex
);
2568 list_add(&event_notifier_enabler
->node
, &event_notifier_enabler
->group
->enablers_head
);
2569 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2571 mutex_unlock(&sessions_mutex
);
2573 return event_notifier_enabler
;
2576 int lttng_event_notifier_enabler_enable(
2577 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2579 mutex_lock(&sessions_mutex
);
2580 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
2581 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2582 mutex_unlock(&sessions_mutex
);
2586 int lttng_event_notifier_enabler_disable(
2587 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2589 mutex_lock(&sessions_mutex
);
2590 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
2591 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2592 mutex_unlock(&sessions_mutex
);
2596 int lttng_event_notifier_enabler_attach_filter_bytecode(
2597 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2598 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
)
2602 ret
= lttng_enabler_attach_filter_bytecode(
2603 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
2608 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2615 int lttng_event_notifier_enabler_attach_capture_bytecode(
2616 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
2617 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
)
2619 struct lttng_kernel_bytecode_node
*bytecode_node
;
2620 struct lttng_enabler
*enabler
=
2621 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
);
2622 uint32_t bytecode_len
;
2625 ret
= get_user(bytecode_len
, &bytecode
->len
);
2629 bytecode_node
= lttng_kvzalloc(sizeof(*bytecode_node
) + bytecode_len
,
2634 ret
= copy_from_user(&bytecode_node
->bc
, bytecode
,
2635 sizeof(*bytecode
) + bytecode_len
);
2639 bytecode_node
->type
= LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
;
2640 bytecode_node
->enabler
= enabler
;
2642 /* Enforce length based on allocated size */
2643 bytecode_node
->bc
.len
= bytecode_len
;
2644 list_add_tail(&bytecode_node
->node
, &event_notifier_enabler
->capture_bytecode_head
);
2646 event_notifier_enabler
->num_captures
++;
2648 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
2652 lttng_kvfree(bytecode_node
);
2658 void lttng_event_notifier_enabler_destroy(
2659 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2661 if (!event_notifier_enabler
) {
2665 list_del(&event_notifier_enabler
->node
);
2667 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2668 kfree(event_notifier_enabler
);
2672 * lttng_session_sync_event_enablers should be called just before starting a
2674 * Should be called with sessions mutex held.
2677 void lttng_session_sync_event_enablers(struct lttng_kernel_session
*session
)
2679 struct lttng_event_enabler
*event_enabler
;
2680 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
2682 list_for_each_entry(event_enabler
, &session
->priv
->enablers_head
, node
)
2683 lttng_event_enabler_ref_events(event_enabler
);
2685 * For each event, if at least one of its enablers is enabled,
2686 * and its channel and session transient states are enabled, we
2687 * enable the event, else we disable it.
2689 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
2690 struct lttng_kernel_event_recorder
*event_recorder
= event_recorder_priv
->pub
;
2691 struct lttng_enabler_ref
*enabler_ref
;
2692 struct lttng_kernel_bytecode_runtime
*runtime
;
2693 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2696 switch (event_recorder_priv
->parent
.instrumentation
) {
2697 case LTTNG_KERNEL_ABI_TRACEPOINT
: /* Fall-through */
2698 case LTTNG_KERNEL_ABI_SYSCALL
:
2700 list_for_each_entry(enabler_ref
,
2701 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2702 if (enabler_ref
->ref
->enabled
) {
2710 /* Not handled with lazy sync. */
2714 * Enabled state is based on union of enablers, with
2715 * intesection of session and channel transient enable
2718 enabled
= enabled
&& session
->priv
->tstate
&& event_recorder
->chan
->tstate
;
2720 WRITE_ONCE(event_recorder
->parent
.enabled
, enabled
);
2722 * Sync tracepoint registration with event enabled
2726 register_event(event_recorder
);
2728 _lttng_event_unregister(event_recorder
);
2731 /* Check if has enablers without bytecode enabled */
2732 list_for_each_entry(enabler_ref
,
2733 &event_recorder_priv
->parent
.enablers_ref_head
, node
) {
2734 if (enabler_ref
->ref
->enabled
2735 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2736 has_enablers_without_filter_bytecode
= 1;
2740 event_recorder_priv
->parent
.has_enablers_without_filter_bytecode
=
2741 has_enablers_without_filter_bytecode
;
2743 /* Enable filters */
2744 list_for_each_entry(runtime
,
2745 &event_recorder_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2746 lttng_bytecode_sync_state(runtime
);
2749 WRITE_ONCE(event_recorder_priv
->parent
.pub
->eval_filter
,
2750 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2755 * Apply enablers to session events, adding events to session if need
2756 * be. It is required after each modification applied to an active
2757 * session, and right before session "start".
2758 * "lazy" sync means we only sync if required.
2759 * Should be called with sessions mutex held.
2762 void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session
*session
)
2764 /* We can skip if session is not active */
2765 if (!session
->active
)
2767 lttng_session_sync_event_enablers(session
);
2771 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2773 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2774 struct lttng_kernel_event_notifier_private
*event_notifier_priv
;
2776 list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2777 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2780 * For each event_notifier, if at least one of its enablers is enabled,
2781 * we enable the event_notifier, else we disable it.
2783 list_for_each_entry(event_notifier_priv
, &event_notifier_group
->event_notifiers_head
, node
) {
2784 struct lttng_kernel_event_notifier
*event_notifier
= event_notifier_priv
->pub
;
2785 struct lttng_enabler_ref
*enabler_ref
;
2786 struct lttng_kernel_bytecode_runtime
*runtime
;
2787 int enabled
= 0, has_enablers_without_filter_bytecode
= 0;
2788 int nr_filters
= 0, nr_captures
= 0;
2790 switch (event_notifier_priv
->parent
.instrumentation
) {
2791 case LTTNG_KERNEL_ABI_TRACEPOINT
: /* Fall-through */
2792 case LTTNG_KERNEL_ABI_SYSCALL
:
2793 /* Enable event_notifiers */
2794 list_for_each_entry(enabler_ref
,
2795 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2796 if (enabler_ref
->ref
->enabled
) {
2804 /* Not handled with sync. */
2808 WRITE_ONCE(event_notifier
->parent
.enabled
, enabled
);
2810 * Sync tracepoint registration with event_notifier enabled
2814 if (!event_notifier_priv
->parent
.registered
)
2815 register_event_notifier(event_notifier
);
2817 if (event_notifier_priv
->parent
.registered
)
2818 _lttng_event_notifier_unregister(event_notifier
);
2821 /* Check if has enablers without bytecode enabled */
2822 list_for_each_entry(enabler_ref
,
2823 &event_notifier_priv
->parent
.enablers_ref_head
, node
) {
2824 if (enabler_ref
->ref
->enabled
2825 && list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2826 has_enablers_without_filter_bytecode
= 1;
2830 event_notifier_priv
->parent
.has_enablers_without_filter_bytecode
=
2831 has_enablers_without_filter_bytecode
;
2833 /* Enable filters */
2834 list_for_each_entry(runtime
,
2835 &event_notifier_priv
->parent
.filter_bytecode_runtime_head
, node
) {
2836 lttng_bytecode_sync_state(runtime
);
2839 WRITE_ONCE(event_notifier_priv
->parent
.pub
->eval_filter
,
2840 !(has_enablers_without_filter_bytecode
|| !nr_filters
));
2842 /* Enable captures */
2843 list_for_each_entry(runtime
,
2844 &event_notifier_priv
->capture_bytecode_runtime_head
, node
) {
2845 lttng_bytecode_sync_state(runtime
);
2848 WRITE_ONCE(event_notifier
->eval_capture
, !!nr_captures
);
2853 * Serialize at most one packet worth of metadata into a metadata
2855 * We grab the metadata cache mutex to get exclusive access to our metadata
2856 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2857 * allows us to do racy operations such as looking for remaining space left in
2858 * packet and write, since mutual exclusion protects us from concurrent writes.
2859 * Mutual exclusion on the metadata cache allow us to read the cache content
2860 * without racing against reallocation of the cache by updates.
2861 * Returns the number of bytes written in the channel, 0 if no data
2862 * was written and a negative value on error.
2864 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
2865 struct channel
*chan
, bool *coherent
)
2867 struct lttng_kernel_ring_buffer_ctx ctx
;
2869 size_t len
, reserve_len
;
2872 * Ensure we support mutiple get_next / put sequences followed by
2873 * put_next. The metadata cache lock protects reading the metadata
2874 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2875 * "flush" operations on the buffer invoked by different processes.
2876 * Moreover, since the metadata cache memory can be reallocated, we
2877 * need to have exclusive access against updates even though we only
2880 mutex_lock(&stream
->metadata_cache
->lock
);
2881 WARN_ON(stream
->metadata_in
< stream
->metadata_out
);
2882 if (stream
->metadata_in
!= stream
->metadata_out
)
2885 /* Metadata regenerated, change the version. */
2886 if (stream
->metadata_cache
->version
!= stream
->version
)
2887 stream
->version
= stream
->metadata_cache
->version
;
2889 len
= stream
->metadata_cache
->metadata_written
-
2890 stream
->metadata_in
;
2893 reserve_len
= min_t(size_t,
2894 stream
->transport
->ops
.priv
->packet_avail_size(chan
),
2896 lib_ring_buffer_ctx_init(&ctx
, chan
, reserve_len
,
2897 sizeof(char), NULL
);
2899 * If reservation failed, return an error to the caller.
2901 ret
= stream
->transport
->ops
.event_reserve(&ctx
);
2903 printk(KERN_WARNING
"LTTng: Metadata event reservation failed\n");
2904 stream
->coherent
= false;
2907 stream
->transport
->ops
.event_write(&ctx
,
2908 stream
->metadata_cache
->data
+ stream
->metadata_in
,
2910 stream
->transport
->ops
.event_commit(&ctx
);
2911 stream
->metadata_in
+= reserve_len
;
2912 if (reserve_len
< len
)
2913 stream
->coherent
= false;
2915 stream
->coherent
= true;
2920 *coherent
= stream
->coherent
;
2921 mutex_unlock(&stream
->metadata_cache
->lock
);
2926 void lttng_metadata_begin(struct lttng_kernel_session
*session
)
2928 if (atomic_inc_return(&session
->priv
->metadata_cache
->producing
) == 1)
2929 mutex_lock(&session
->priv
->metadata_cache
->lock
);
2933 void lttng_metadata_end(struct lttng_kernel_session
*session
)
2935 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
2936 if (atomic_dec_return(&session
->priv
->metadata_cache
->producing
) == 0) {
2937 struct lttng_metadata_stream
*stream
;
2939 list_for_each_entry(stream
, &session
->priv
->metadata_cache
->metadata_stream
, list
)
2940 wake_up_interruptible(&stream
->read_wait
);
2941 mutex_unlock(&session
->priv
->metadata_cache
->lock
);
2946 * Write the metadata to the metadata cache.
2947 * Must be called with sessions_mutex held.
2948 * The metadata cache lock protects us from concurrent read access from
2949 * thread outputting metadata content to ring buffer.
2950 * The content of the printf is printed as a single atomic metadata
2953 int lttng_metadata_printf(struct lttng_kernel_session
*session
,
2954 const char *fmt
, ...)
2960 WARN_ON_ONCE(!LTTNG_READ_ONCE(session
->active
));
2963 str
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
2969 WARN_ON_ONCE(!atomic_read(&session
->priv
->metadata_cache
->producing
));
2970 if (session
->priv
->metadata_cache
->metadata_written
+ len
>
2971 session
->priv
->metadata_cache
->cache_alloc
) {
2972 char *tmp_cache_realloc
;
2973 unsigned int tmp_cache_alloc_size
;
2975 tmp_cache_alloc_size
= max_t(unsigned int,
2976 session
->priv
->metadata_cache
->cache_alloc
+ len
,
2977 session
->priv
->metadata_cache
->cache_alloc
<< 1);
2978 tmp_cache_realloc
= vzalloc(tmp_cache_alloc_size
);
2979 if (!tmp_cache_realloc
)
2981 if (session
->priv
->metadata_cache
->data
) {
2982 memcpy(tmp_cache_realloc
,
2983 session
->priv
->metadata_cache
->data
,
2984 session
->priv
->metadata_cache
->cache_alloc
);
2985 vfree(session
->priv
->metadata_cache
->data
);
2988 session
->priv
->metadata_cache
->cache_alloc
= tmp_cache_alloc_size
;
2989 session
->priv
->metadata_cache
->data
= tmp_cache_realloc
;
2991 memcpy(session
->priv
->metadata_cache
->data
+
2992 session
->priv
->metadata_cache
->metadata_written
,
2994 session
->priv
->metadata_cache
->metadata_written
+= len
;
3005 int print_tabs(struct lttng_kernel_session
*session
, size_t nesting
)
3009 for (i
= 0; i
< nesting
; i
++) {
3012 ret
= lttng_metadata_printf(session
, " ");
3021 int lttng_field_name_statedump(struct lttng_kernel_session
*session
,
3022 const struct lttng_kernel_event_field
*field
,
3025 return lttng_metadata_printf(session
, " _%s;\n", field
->name
);
3029 int _lttng_integer_type_statedump(struct lttng_kernel_session
*session
,
3030 const struct lttng_kernel_type_integer
*type
,
3031 enum lttng_kernel_string_encoding parent_encoding
,
3036 ret
= print_tabs(session
, nesting
);
3039 ret
= lttng_metadata_printf(session
,
3040 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
3044 (parent_encoding
== lttng_kernel_string_encoding_none
)
3046 : (parent_encoding
== lttng_kernel_string_encoding_UTF8
)
3050 #if __BYTE_ORDER == __BIG_ENDIAN
3051 type
->reverse_byte_order
? " byte_order = le;" : ""
3053 type
->reverse_byte_order
? " byte_order = be;" : ""
3060 * Must be called with sessions_mutex held.
3063 int _lttng_struct_type_statedump(struct lttng_kernel_session
*session
,
3064 const struct lttng_kernel_type_struct
*type
,
3067 const char *prev_field_name
= NULL
;
3069 uint32_t i
, nr_fields
;
3070 unsigned int alignment
;
3072 ret
= print_tabs(session
, nesting
);
3075 ret
= lttng_metadata_printf(session
,
3079 nr_fields
= type
->nr_fields
;
3080 for (i
= 0; i
< nr_fields
; i
++) {
3081 const struct lttng_kernel_event_field
*iter_field
;
3083 iter_field
= type
->fields
[i
];
3084 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, &prev_field_name
);
3088 ret
= print_tabs(session
, nesting
);
3091 alignment
= type
->alignment
;
3093 ret
= lttng_metadata_printf(session
,
3097 ret
= lttng_metadata_printf(session
,
3104 * Must be called with sessions_mutex held.
3107 int _lttng_struct_field_statedump(struct lttng_kernel_session
*session
,
3108 const struct lttng_kernel_event_field
*field
,
3113 ret
= _lttng_struct_type_statedump(session
,
3114 lttng_kernel_get_type_struct(field
->type
), nesting
);
3117 return lttng_field_name_statedump(session
, field
, nesting
);
3121 * Must be called with sessions_mutex held.
3124 int _lttng_variant_type_statedump(struct lttng_kernel_session
*session
,
3125 const struct lttng_kernel_type_variant
*type
,
3127 const char *prev_field_name
)
3129 const char *tag_name
;
3131 uint32_t i
, nr_choices
;
3133 tag_name
= type
->tag_name
;
3135 tag_name
= prev_field_name
;
3139 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
3141 if (type
->alignment
!= 0)
3143 ret
= print_tabs(session
, nesting
);
3146 ret
= lttng_metadata_printf(session
,
3147 "variant <_%s> {\n",
3151 nr_choices
= type
->nr_choices
;
3152 for (i
= 0; i
< nr_choices
; i
++) {
3153 const struct lttng_kernel_event_field
*iter_field
;
3155 iter_field
= type
->choices
[i
];
3156 ret
= _lttng_field_statedump(session
, iter_field
, nesting
+ 1, NULL
);
3160 ret
= print_tabs(session
, nesting
);
3163 ret
= lttng_metadata_printf(session
,
3169 * Must be called with sessions_mutex held.
3172 int _lttng_variant_field_statedump(struct lttng_kernel_session
*session
,
3173 const struct lttng_kernel_event_field
*field
,
3175 const char *prev_field_name
)
3179 ret
= _lttng_variant_type_statedump(session
,
3180 lttng_kernel_get_type_variant(field
->type
), nesting
,
3184 return lttng_field_name_statedump(session
, field
, nesting
);
3188 * Must be called with sessions_mutex held.
3191 int _lttng_array_field_statedump(struct lttng_kernel_session
*session
,
3192 const struct lttng_kernel_event_field
*field
,
3196 const struct lttng_kernel_type_array
*array_type
;
3197 const struct lttng_kernel_type_common
*elem_type
;
3199 array_type
= lttng_kernel_get_type_array(field
->type
);
3200 WARN_ON_ONCE(!array_type
);
3202 if (array_type
->alignment
) {
3203 ret
= print_tabs(session
, nesting
);
3206 ret
= lttng_metadata_printf(session
,
3207 "struct { } align(%u) _%s_padding;\n",
3208 array_type
->alignment
* CHAR_BIT
,
3214 * Nested compound types: Only array of structures and variants are
3215 * currently supported.
3217 elem_type
= array_type
->elem_type
;
3218 switch (elem_type
->type
) {
3219 case lttng_kernel_type_integer
:
3220 case lttng_kernel_type_struct
:
3221 case lttng_kernel_type_variant
:
3222 ret
= _lttng_type_statedump(session
, elem_type
,
3223 array_type
->encoding
, nesting
);
3231 ret
= lttng_metadata_printf(session
,
3234 array_type
->length
);
3239 * Must be called with sessions_mutex held.
3242 int _lttng_sequence_field_statedump(struct lttng_kernel_session
*session
,
3243 const struct lttng_kernel_event_field
*field
,
3245 const char *prev_field_name
)
3248 const char *length_name
;
3249 const struct lttng_kernel_type_sequence
*sequence_type
;
3250 const struct lttng_kernel_type_common
*elem_type
;
3252 sequence_type
= lttng_kernel_get_type_sequence(field
->type
);
3253 WARN_ON_ONCE(!sequence_type
);
3255 length_name
= sequence_type
->length_name
;
3257 length_name
= prev_field_name
;
3261 if (sequence_type
->alignment
) {
3262 ret
= print_tabs(session
, nesting
);
3265 ret
= lttng_metadata_printf(session
,
3266 "struct { } align(%u) _%s_padding;\n",
3267 sequence_type
->alignment
* CHAR_BIT
,
3274 * Nested compound types: Only array of structures and variants are
3275 * currently supported.
3277 elem_type
= sequence_type
->elem_type
;
3278 switch (elem_type
->type
) {
3279 case lttng_kernel_type_integer
:
3280 case lttng_kernel_type_struct
:
3281 case lttng_kernel_type_variant
:
3282 ret
= _lttng_type_statedump(session
, elem_type
,
3283 sequence_type
->encoding
, nesting
);
3291 ret
= lttng_metadata_printf(session
,
3299 * Must be called with sessions_mutex held.
3302 int _lttng_enum_type_statedump(struct lttng_kernel_session
*session
,
3303 const struct lttng_kernel_type_enum
*type
,
3306 const struct lttng_kernel_enum_desc
*enum_desc
;
3307 const struct lttng_kernel_type_common
*container_type
;
3309 unsigned int i
, nr_entries
;
3311 container_type
= type
->container_type
;
3312 if (container_type
->type
!= lttng_kernel_type_integer
) {
3316 enum_desc
= type
->desc
;
3317 nr_entries
= enum_desc
->nr_entries
;
3319 ret
= print_tabs(session
, nesting
);
3322 ret
= lttng_metadata_printf(session
, "enum : ");
3325 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(container_type
),
3326 lttng_kernel_string_encoding_none
, 0);
3329 ret
= lttng_metadata_printf(session
, " {\n");
3332 /* Dump all entries */
3333 for (i
= 0; i
< nr_entries
; i
++) {
3334 const struct lttng_kernel_enum_entry
*entry
= enum_desc
->entries
[i
];
3337 ret
= print_tabs(session
, nesting
+ 1);
3340 ret
= lttng_metadata_printf(session
,
3344 len
= strlen(entry
->string
);
3345 /* Escape the character '"' */
3346 for (j
= 0; j
< len
; j
++) {
3347 char c
= entry
->string
[j
];
3351 ret
= lttng_metadata_printf(session
,
3355 ret
= lttng_metadata_printf(session
,
3359 ret
= lttng_metadata_printf(session
,
3366 ret
= lttng_metadata_printf(session
, "\"");
3370 if (entry
->options
.is_auto
) {
3371 ret
= lttng_metadata_printf(session
, ",\n");
3375 ret
= lttng_metadata_printf(session
,
3379 if (entry
->start
.signedness
)
3380 ret
= lttng_metadata_printf(session
,
3381 "%lld", (long long) entry
->start
.value
);
3383 ret
= lttng_metadata_printf(session
,
3384 "%llu", entry
->start
.value
);
3387 if (entry
->start
.signedness
== entry
->end
.signedness
&&
3389 == entry
->end
.value
) {
3390 ret
= lttng_metadata_printf(session
,
3393 if (entry
->end
.signedness
) {
3394 ret
= lttng_metadata_printf(session
,
3396 (long long) entry
->end
.value
);
3398 ret
= lttng_metadata_printf(session
,
3407 ret
= print_tabs(session
, nesting
);
3410 ret
= lttng_metadata_printf(session
, "}");
3416 * Must be called with sessions_mutex held.
3419 int _lttng_enum_field_statedump(struct lttng_kernel_session
*session
,
3420 const struct lttng_kernel_event_field
*field
,
3424 const struct lttng_kernel_type_enum
*enum_type
;
3426 enum_type
= lttng_kernel_get_type_enum(field
->type
);
3427 WARN_ON_ONCE(!enum_type
);
3428 ret
= _lttng_enum_type_statedump(session
, enum_type
, nesting
);
3431 return lttng_field_name_statedump(session
, field
, nesting
);
3435 int _lttng_integer_field_statedump(struct lttng_kernel_session
*session
,
3436 const struct lttng_kernel_event_field
*field
,
3441 ret
= _lttng_integer_type_statedump(session
, lttng_kernel_get_type_integer(field
->type
),
3442 lttng_kernel_string_encoding_none
, nesting
);
3445 return lttng_field_name_statedump(session
, field
, nesting
);
3449 int _lttng_string_type_statedump(struct lttng_kernel_session
*session
,
3450 const struct lttng_kernel_type_string
*type
,
3455 /* Default encoding is UTF8 */
3456 ret
= print_tabs(session
, nesting
);
3459 ret
= lttng_metadata_printf(session
,
3461 type
->encoding
== lttng_kernel_string_encoding_ASCII
?
3462 " { encoding = ASCII; }" : "");
3467 int _lttng_string_field_statedump(struct lttng_kernel_session
*session
,
3468 const struct lttng_kernel_event_field
*field
,
3471 const struct lttng_kernel_type_string
*string_type
;
3474 string_type
= lttng_kernel_get_type_string(field
->type
);
3475 WARN_ON_ONCE(!string_type
);
3476 ret
= _lttng_string_type_statedump(session
, string_type
, nesting
);
3479 return lttng_field_name_statedump(session
, field
, nesting
);
3483 * Must be called with sessions_mutex held.
3486 int _lttng_type_statedump(struct lttng_kernel_session
*session
,
3487 const struct lttng_kernel_type_common
*type
,
3488 enum lttng_kernel_string_encoding parent_encoding
,
3493 switch (type
->type
) {
3494 case lttng_kernel_type_integer
:
3495 ret
= _lttng_integer_type_statedump(session
,
3496 lttng_kernel_get_type_integer(type
),
3497 parent_encoding
, nesting
);
3499 case lttng_kernel_type_enum
:
3500 ret
= _lttng_enum_type_statedump(session
,
3501 lttng_kernel_get_type_enum(type
),
3504 case lttng_kernel_type_string
:
3505 ret
= _lttng_string_type_statedump(session
,
3506 lttng_kernel_get_type_string(type
),
3509 case lttng_kernel_type_struct
:
3510 ret
= _lttng_struct_type_statedump(session
,
3511 lttng_kernel_get_type_struct(type
),
3514 case lttng_kernel_type_variant
:
3515 ret
= _lttng_variant_type_statedump(session
,
3516 lttng_kernel_get_type_variant(type
),
3520 /* Nested arrays and sequences are not supported yet. */
3521 case lttng_kernel_type_array
:
3522 case lttng_kernel_type_sequence
:
3531 * Must be called with sessions_mutex held.
3534 int _lttng_field_statedump(struct lttng_kernel_session
*session
,
3535 const struct lttng_kernel_event_field
*field
,
3537 const char **prev_field_name_p
)
3539 const char *prev_field_name
= NULL
;
3542 if (prev_field_name_p
)
3543 prev_field_name
= *prev_field_name_p
;
3544 switch (field
->type
->type
) {
3545 case lttng_kernel_type_integer
:
3546 ret
= _lttng_integer_field_statedump(session
, field
, nesting
);
3548 case lttng_kernel_type_enum
:
3549 ret
= _lttng_enum_field_statedump(session
, field
, nesting
);
3551 case lttng_kernel_type_string
:
3552 ret
= _lttng_string_field_statedump(session
, field
, nesting
);
3554 case lttng_kernel_type_struct
:
3555 ret
= _lttng_struct_field_statedump(session
, field
, nesting
);
3557 case lttng_kernel_type_array
:
3558 ret
= _lttng_array_field_statedump(session
, field
, nesting
);
3560 case lttng_kernel_type_sequence
:
3561 ret
= _lttng_sequence_field_statedump(session
, field
, nesting
, prev_field_name
);
3563 case lttng_kernel_type_variant
:
3564 ret
= _lttng_variant_field_statedump(session
, field
, nesting
, prev_field_name
);
3571 if (prev_field_name_p
)
3572 *prev_field_name_p
= field
->name
;
3577 int _lttng_context_metadata_statedump(struct lttng_kernel_session
*session
,
3578 struct lttng_kernel_ctx
*ctx
)
3580 const char *prev_field_name
= NULL
;
3586 for (i
= 0; i
< ctx
->nr_fields
; i
++) {
3587 const struct lttng_kernel_ctx_field
*field
= &ctx
->fields
[i
];
3589 ret
= _lttng_field_statedump(session
, field
->event_field
, 2, &prev_field_name
);
3597 int _lttng_fields_metadata_statedump(struct lttng_kernel_session
*session
,
3598 struct lttng_kernel_event_recorder
*event_recorder
)
3600 const char *prev_field_name
= NULL
;
3601 const struct lttng_kernel_event_desc
*desc
= event_recorder
->priv
->parent
.desc
;
3605 for (i
= 0; i
< desc
->nr_fields
; i
++) {
3606 const struct lttng_kernel_event_field
*field
= desc
->fields
[i
];
3608 ret
= _lttng_field_statedump(session
, field
, 2, &prev_field_name
);
3616 * Must be called with sessions_mutex held.
3617 * The entire event metadata is printed as a single atomic metadata
3621 int _lttng_event_metadata_statedump(struct lttng_kernel_session
*session
,
3622 struct lttng_channel
*chan
,
3623 struct lttng_kernel_event_recorder
*event_recorder
)
3627 if (event_recorder
->priv
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3629 if (chan
->channel_type
== METADATA_CHANNEL
)
3632 lttng_metadata_begin(session
);
3634 ret
= lttng_metadata_printf(session
,
3638 " stream_id = %u;\n",
3639 event_recorder
->priv
->parent
.desc
->event_name
,
3640 event_recorder
->priv
->id
,
3641 event_recorder
->chan
->id
);
3645 ret
= lttng_metadata_printf(session
,
3646 " fields := struct {\n"
3651 ret
= _lttng_fields_metadata_statedump(session
, event_recorder
);
3656 * LTTng space reservation can only reserve multiples of the
3659 ret
= lttng_metadata_printf(session
,
3665 event_recorder
->priv
->metadata_dumped
= 1;
3667 lttng_metadata_end(session
);
3673 * Must be called with sessions_mutex held.
3674 * The entire channel metadata is printed as a single atomic metadata
3678 int _lttng_channel_metadata_statedump(struct lttng_kernel_session
*session
,
3679 struct lttng_channel
*chan
)
3683 if (chan
->metadata_dumped
|| !LTTNG_READ_ONCE(session
->active
))
3686 if (chan
->channel_type
== METADATA_CHANNEL
)
3689 lttng_metadata_begin(session
);
3691 WARN_ON_ONCE(!chan
->header_type
);
3692 ret
= lttng_metadata_printf(session
,
3695 " event.header := %s;\n"
3696 " packet.context := struct packet_context;\n",
3698 chan
->header_type
== 1 ? "struct event_header_compact" :
3699 "struct event_header_large");
3704 ret
= lttng_metadata_printf(session
,
3705 " event.context := struct {\n");
3709 ret
= _lttng_context_metadata_statedump(session
, chan
->ctx
);
3713 ret
= lttng_metadata_printf(session
,
3719 ret
= lttng_metadata_printf(session
,
3722 chan
->metadata_dumped
= 1;
3724 lttng_metadata_end(session
);
3729 * Must be called with sessions_mutex held.
3732 int _lttng_stream_packet_context_declare(struct lttng_kernel_session
*session
)
3734 return lttng_metadata_printf(session
,
3735 "struct packet_context {\n"
3736 " uint64_clock_monotonic_t timestamp_begin;\n"
3737 " uint64_clock_monotonic_t timestamp_end;\n"
3738 " uint64_t content_size;\n"
3739 " uint64_t packet_size;\n"
3740 " uint64_t packet_seq_num;\n"
3741 " unsigned long events_discarded;\n"
3742 " uint32_t cpu_id;\n"
3749 * id: range: 0 - 30.
3750 * id 31 is reserved to indicate an extended header.
3753 * id: range: 0 - 65534.
3754 * id 65535 is reserved to indicate an extended header.
3756 * Must be called with sessions_mutex held.
3759 int _lttng_event_header_declare(struct lttng_kernel_session
*session
)
3761 return lttng_metadata_printf(session
,
3762 "struct event_header_compact {\n"
3763 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3766 " uint27_clock_monotonic_t timestamp;\n"
3770 " uint64_clock_monotonic_t timestamp;\n"
3775 "struct event_header_large {\n"
3776 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3779 " uint32_clock_monotonic_t timestamp;\n"
3783 " uint64_clock_monotonic_t timestamp;\n"
3787 lttng_alignof(uint32_t) * CHAR_BIT
,
3788 lttng_alignof(uint16_t) * CHAR_BIT
3793 * Approximation of NTP time of day to clock monotonic correlation,
3794 * taken at start of trace.
3795 * Yes, this is only an approximation. Yes, we can (and will) do better
3796 * in future versions.
3797 * This function may return a negative offset. It may happen if the
3798 * system sets the REALTIME clock to 0 after boot.
3800 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3804 int64_t measure_clock_offset(void)
3806 uint64_t monotonic_avg
, monotonic
[2], realtime
;
3807 uint64_t tcf
= trace_clock_freq();
3809 unsigned long flags
;
3810 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3811 struct timespec64 rts
= { 0, 0 };
3813 struct timespec rts
= { 0, 0 };
3816 /* Disable interrupts to increase correlation precision. */
3817 local_irq_save(flags
);
3818 monotonic
[0] = trace_clock_read64();
3819 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3820 ktime_get_real_ts64(&rts
);
3822 getnstimeofday(&rts
);
3824 monotonic
[1] = trace_clock_read64();
3825 local_irq_restore(flags
);
3827 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
3828 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
3829 if (tcf
== NSEC_PER_SEC
) {
3830 realtime
+= rts
.tv_nsec
;
3832 uint64_t n
= rts
.tv_nsec
* tcf
;
3834 do_div(n
, NSEC_PER_SEC
);
3837 offset
= (int64_t) realtime
- monotonic_avg
;
3842 int print_escaped_ctf_string(struct lttng_kernel_session
*session
, const char *string
)
3850 while (cur
!= '\0') {
3853 ret
= lttng_metadata_printf(session
, "%s", "\\n");
3857 ret
= lttng_metadata_printf(session
, "%c", '\\');
3860 /* We still print the current char */
3863 ret
= lttng_metadata_printf(session
, "%c", cur
);
3877 int print_metadata_escaped_field(struct lttng_kernel_session
*session
, const char *field
,
3878 const char *field_value
)
3882 ret
= lttng_metadata_printf(session
, " %s = \"", field
);
3886 ret
= print_escaped_ctf_string(session
, field_value
);
3890 ret
= lttng_metadata_printf(session
, "\";\n");
3897 * Output metadata into this session's metadata buffers.
3898 * Must be called with sessions_mutex held.
3901 int _lttng_session_metadata_statedump(struct lttng_kernel_session
*session
)
3903 unsigned char *uuid_c
= session
->priv
->uuid
.b
;
3904 unsigned char uuid_s
[37], clock_uuid_s
[BOOT_ID_LEN
];
3905 const char *product_uuid
;
3906 struct lttng_channel
*chan
;
3907 struct lttng_kernel_event_recorder_private
*event_recorder_priv
;
3910 if (!LTTNG_READ_ONCE(session
->active
))
3913 lttng_metadata_begin(session
);
3915 if (session
->priv
->metadata_dumped
)
3918 snprintf(uuid_s
, sizeof(uuid_s
),
3919 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3920 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
3921 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
3922 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
3923 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
3925 ret
= lttng_metadata_printf(session
,
3926 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3927 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3928 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3929 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
3930 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
3931 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
3932 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
3938 " byte_order = %s;\n"
3939 " packet.header := struct {\n"
3940 " uint32_t magic;\n"
3941 " uint8_t uuid[16];\n"
3942 " uint32_t stream_id;\n"
3943 " uint64_t stream_instance_id;\n"
3946 lttng_alignof(uint8_t) * CHAR_BIT
,
3947 lttng_alignof(uint16_t) * CHAR_BIT
,
3948 lttng_alignof(uint32_t) * CHAR_BIT
,
3949 lttng_alignof(uint64_t) * CHAR_BIT
,
3950 sizeof(unsigned long) * CHAR_BIT
,
3951 lttng_alignof(unsigned long) * CHAR_BIT
,
3955 #if __BYTE_ORDER == __BIG_ENDIAN
3964 ret
= lttng_metadata_printf(session
,
3966 " hostname = \"%s\";\n"
3967 " domain = \"kernel\";\n"
3968 " sysname = \"%s\";\n"
3969 " kernel_release = \"%s\";\n"
3970 " kernel_version = \"%s\";\n"
3971 " tracer_name = \"lttng-modules\";\n"
3972 " tracer_major = %d;\n"
3973 " tracer_minor = %d;\n"
3974 " tracer_patchlevel = %d;\n"
3975 " trace_buffering_scheme = \"global\";\n",
3976 current
->nsproxy
->uts_ns
->name
.nodename
,
3980 LTTNG_MODULES_MAJOR_VERSION
,
3981 LTTNG_MODULES_MINOR_VERSION
,
3982 LTTNG_MODULES_PATCHLEVEL_VERSION
3987 ret
= print_metadata_escaped_field(session
, "trace_name", session
->priv
->name
);
3990 ret
= print_metadata_escaped_field(session
, "trace_creation_datetime",
3991 session
->priv
->creation_time
);
3995 /* Add the product UUID to the 'env' section */
3996 product_uuid
= dmi_get_system_info(DMI_PRODUCT_UUID
);
3998 ret
= lttng_metadata_printf(session
,
3999 " product_uuid = \"%s\";\n",
4006 /* Close the 'env' section */
4007 ret
= lttng_metadata_printf(session
, "};\n\n");
4011 ret
= lttng_metadata_printf(session
,
4013 " name = \"%s\";\n",
4019 if (!trace_clock_uuid(clock_uuid_s
)) {
4020 ret
= lttng_metadata_printf(session
,
4021 " uuid = \"%s\";\n",
4028 ret
= lttng_metadata_printf(session
,
4029 " description = \"%s\";\n"
4030 " freq = %llu; /* Frequency, in Hz */\n"
4031 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
4034 trace_clock_description(),
4035 (unsigned long long) trace_clock_freq(),
4036 (long long) measure_clock_offset()
4041 ret
= lttng_metadata_printf(session
,
4042 "typealias integer {\n"
4043 " size = 27; align = 1; signed = false;\n"
4044 " map = clock.%s.value;\n"
4045 "} := uint27_clock_monotonic_t;\n"
4047 "typealias integer {\n"
4048 " size = 32; align = %u; signed = false;\n"
4049 " map = clock.%s.value;\n"
4050 "} := uint32_clock_monotonic_t;\n"
4052 "typealias integer {\n"
4053 " size = 64; align = %u; signed = false;\n"
4054 " map = clock.%s.value;\n"
4055 "} := uint64_clock_monotonic_t;\n\n",
4057 lttng_alignof(uint32_t) * CHAR_BIT
,
4059 lttng_alignof(uint64_t) * CHAR_BIT
,
4065 ret
= _lttng_stream_packet_context_declare(session
);
4069 ret
= _lttng_event_header_declare(session
);
4074 list_for_each_entry(chan
, &session
->priv
->chan
, list
) {
4075 ret
= _lttng_channel_metadata_statedump(session
, chan
);
4080 list_for_each_entry(event_recorder_priv
, &session
->priv
->events
, node
) {
4081 ret
= _lttng_event_metadata_statedump(session
, event_recorder_priv
->pub
->chan
,
4082 event_recorder_priv
->pub
);
4086 session
->priv
->metadata_dumped
= 1;
4088 lttng_metadata_end(session
);
4093 * lttng_transport_register - LTT transport registration
4094 * @transport: transport structure
4096 * Registers a transport which can be used as output to extract the data out of
4097 * LTTng. The module calling this registration function must ensure that no
4098 * trap-inducing code will be executed by the transport functions. E.g.
4099 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
4100 * is made visible to the transport function. This registration acts as a
4101 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
4102 * after its registration must it synchronize the TLBs.
4104 void lttng_transport_register(struct lttng_transport
*transport
)
4107 * Make sure no page fault can be triggered by the module about to be
4108 * registered. We deal with this here so we don't have to call
4109 * vmalloc_sync_mappings() in each module's init.
4111 wrapper_vmalloc_sync_mappings();
4113 mutex_lock(&sessions_mutex
);
4114 list_add_tail(&transport
->node
, <tng_transport_list
);
4115 mutex_unlock(&sessions_mutex
);
4117 EXPORT_SYMBOL_GPL(lttng_transport_register
);
4120 * lttng_transport_unregister - LTT transport unregistration
4121 * @transport: transport structure
4123 void lttng_transport_unregister(struct lttng_transport
*transport
)
4125 mutex_lock(&sessions_mutex
);
4126 list_del(&transport
->node
);
4127 mutex_unlock(&sessions_mutex
);
4129 EXPORT_SYMBOL_GPL(lttng_transport_unregister
);
4131 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
)
4134 * Make sure no page fault can be triggered by the module about to be
4135 * registered. We deal with this here so we don't have to call
4136 * vmalloc_sync_mappings() in each module's init.
4138 wrapper_vmalloc_sync_mappings();
4140 mutex_lock(&sessions_mutex
);
4141 list_add_tail(&transport
->node
, <tng_counter_transport_list
);
4142 mutex_unlock(&sessions_mutex
);
4144 EXPORT_SYMBOL_GPL(lttng_counter_transport_register
);
4146 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
)
4148 mutex_lock(&sessions_mutex
);
4149 list_del(&transport
->node
);
4150 mutex_unlock(&sessions_mutex
);
4152 EXPORT_SYMBOL_GPL(lttng_counter_transport_unregister
);
4154 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
4156 enum cpuhp_state lttng_hp_prepare
;
4157 enum cpuhp_state lttng_hp_online
;
4159 static int lttng_hotplug_prepare(unsigned int cpu
, struct hlist_node
*node
)
4161 struct lttng_cpuhp_node
*lttng_node
;
4163 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4164 switch (lttng_node
->component
) {
4165 case LTTNG_RING_BUFFER_FRONTEND
:
4167 case LTTNG_RING_BUFFER_BACKEND
:
4168 return lttng_cpuhp_rb_backend_prepare(cpu
, lttng_node
);
4169 case LTTNG_RING_BUFFER_ITER
:
4171 case LTTNG_CONTEXT_PERF_COUNTERS
:
4178 static int lttng_hotplug_dead(unsigned int cpu
, struct hlist_node
*node
)
4180 struct lttng_cpuhp_node
*lttng_node
;
4182 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4183 switch (lttng_node
->component
) {
4184 case LTTNG_RING_BUFFER_FRONTEND
:
4185 return lttng_cpuhp_rb_frontend_dead(cpu
, lttng_node
);
4186 case LTTNG_RING_BUFFER_BACKEND
:
4188 case LTTNG_RING_BUFFER_ITER
:
4190 case LTTNG_CONTEXT_PERF_COUNTERS
:
4191 return lttng_cpuhp_perf_counter_dead(cpu
, lttng_node
);
4197 static int lttng_hotplug_online(unsigned int cpu
, struct hlist_node
*node
)
4199 struct lttng_cpuhp_node
*lttng_node
;
4201 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4202 switch (lttng_node
->component
) {
4203 case LTTNG_RING_BUFFER_FRONTEND
:
4204 return lttng_cpuhp_rb_frontend_online(cpu
, lttng_node
);
4205 case LTTNG_RING_BUFFER_BACKEND
:
4207 case LTTNG_RING_BUFFER_ITER
:
4208 return lttng_cpuhp_rb_iter_online(cpu
, lttng_node
);
4209 case LTTNG_CONTEXT_PERF_COUNTERS
:
4210 return lttng_cpuhp_perf_counter_online(cpu
, lttng_node
);
4216 static int lttng_hotplug_offline(unsigned int cpu
, struct hlist_node
*node
)
4218 struct lttng_cpuhp_node
*lttng_node
;
4220 lttng_node
= container_of(node
, struct lttng_cpuhp_node
, node
);
4221 switch (lttng_node
->component
) {
4222 case LTTNG_RING_BUFFER_FRONTEND
:
4223 return lttng_cpuhp_rb_frontend_offline(cpu
, lttng_node
);
4224 case LTTNG_RING_BUFFER_BACKEND
:
4226 case LTTNG_RING_BUFFER_ITER
:
4228 case LTTNG_CONTEXT_PERF_COUNTERS
:
4235 static int __init
lttng_init_cpu_hotplug(void)
4239 ret
= cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN
, "lttng:prepare",
4240 lttng_hotplug_prepare
,
4241 lttng_hotplug_dead
);
4245 lttng_hp_prepare
= ret
;
4246 lttng_rb_set_hp_prepare(ret
);
4248 ret
= cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN
, "lttng:online",
4249 lttng_hotplug_online
,
4250 lttng_hotplug_offline
);
4252 cpuhp_remove_multi_state(lttng_hp_prepare
);
4253 lttng_hp_prepare
= 0;
4256 lttng_hp_online
= ret
;
4257 lttng_rb_set_hp_online(ret
);
4262 static void __exit
lttng_exit_cpu_hotplug(void)
4264 lttng_rb_set_hp_online(0);
4265 cpuhp_remove_multi_state(lttng_hp_online
);
4266 lttng_rb_set_hp_prepare(0);
4267 cpuhp_remove_multi_state(lttng_hp_prepare
);
4270 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4271 static int lttng_init_cpu_hotplug(void)
4275 static void lttng_exit_cpu_hotplug(void)
4278 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4281 static int __init
lttng_events_init(void)
4285 ret
= wrapper_lttng_fixup_sig(THIS_MODULE
);
4288 ret
= wrapper_get_pfnblock_flags_mask_init();
4291 ret
= wrapper_get_pageblock_flags_mask_init();
4294 ret
= lttng_probes_init();
4297 ret
= lttng_context_init();
4300 ret
= lttng_tracepoint_init();
4303 event_recorder_cache
= KMEM_CACHE(lttng_kernel_event_recorder
, 0);
4304 if (!event_recorder_cache
) {
4306 goto error_kmem_event_recorder
;
4308 event_recorder_private_cache
= KMEM_CACHE(lttng_kernel_event_recorder_private
, 0);
4309 if (!event_recorder_private_cache
) {
4311 goto error_kmem_event_recorder_private
;
4313 event_notifier_cache
= KMEM_CACHE(lttng_kernel_event_notifier
, 0);
4314 if (!event_notifier_cache
) {
4316 goto error_kmem_event_notifier
;
4318 event_notifier_private_cache
= KMEM_CACHE(lttng_kernel_event_notifier_private
, 0);
4319 if (!event_notifier_private_cache
) {
4321 goto error_kmem_event_notifier_private
;
4323 ret
= lttng_abi_init();
4326 ret
= lttng_logger_init();
4329 ret
= lttng_init_cpu_hotplug();
4332 printk(KERN_NOTICE
"LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
4333 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4334 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4335 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4336 LTTNG_MODULES_EXTRAVERSION
,
4338 #ifdef LTTNG_EXTRA_VERSION_GIT
4339 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4343 #ifdef LTTNG_EXTRA_VERSION_NAME
4344 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4351 lttng_logger_exit();
4355 kmem_cache_destroy(event_notifier_private_cache
);
4356 error_kmem_event_notifier_private
:
4357 kmem_cache_destroy(event_notifier_cache
);
4358 error_kmem_event_notifier
:
4359 kmem_cache_destroy(event_recorder_private_cache
);
4360 error_kmem_event_recorder_private
:
4361 kmem_cache_destroy(event_recorder_cache
);
4362 error_kmem_event_recorder
:
4363 lttng_tracepoint_exit();
4365 lttng_context_exit();
4366 printk(KERN_NOTICE
"LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4367 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4368 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4369 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4370 LTTNG_MODULES_EXTRAVERSION
,
4372 #ifdef LTTNG_EXTRA_VERSION_GIT
4373 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4377 #ifdef LTTNG_EXTRA_VERSION_NAME
4378 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4385 module_init(lttng_events_init
);
4387 static void __exit
lttng_events_exit(void)
4389 struct lttng_kernel_session_private
*session_priv
, *tmpsession_priv
;
4391 lttng_exit_cpu_hotplug();
4392 lttng_logger_exit();
4394 list_for_each_entry_safe(session_priv
, tmpsession_priv
, &sessions
, list
)
4395 lttng_session_destroy(session_priv
->pub
);
4396 kmem_cache_destroy(event_recorder_cache
);
4397 kmem_cache_destroy(event_recorder_private_cache
);
4398 kmem_cache_destroy(event_notifier_cache
);
4399 kmem_cache_destroy(event_notifier_private_cache
);
4400 lttng_tracepoint_exit();
4401 lttng_context_exit();
4402 printk(KERN_NOTICE
"LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4403 __stringify(LTTNG_MODULES_MAJOR_VERSION
),
4404 __stringify(LTTNG_MODULES_MINOR_VERSION
),
4405 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
),
4406 LTTNG_MODULES_EXTRAVERSION
,
4408 #ifdef LTTNG_EXTRA_VERSION_GIT
4409 LTTNG_EXTRA_VERSION_GIT
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT
,
4413 #ifdef LTTNG_EXTRA_VERSION_NAME
4414 LTTNG_EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME
);
4420 module_exit(lttng_events_exit
);
4422 #include <generated/patches.h>
4423 #ifdef LTTNG_EXTRA_VERSION_GIT
4424 MODULE_INFO(extra_version_git
, LTTNG_EXTRA_VERSION_GIT
);
4426 #ifdef LTTNG_EXTRA_VERSION_NAME
4427 MODULE_INFO(extra_version_name
, LTTNG_EXTRA_VERSION_NAME
);
4429 MODULE_LICENSE("GPL and additional rights");
4430 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4431 MODULE_DESCRIPTION("LTTng tracer");
4432 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
4433 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
4434 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
4435 LTTNG_MODULES_EXTRAVERSION
);