2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Holds LTTng per-session event registry.
24 #include <lttng/ust-endian.h>
26 #include <urcu/arch.h>
27 #include <urcu/compiler.h>
28 #include <urcu/hlist.h>
29 #include <urcu/list.h>
30 #include <urcu/uatomic.h>
32 #include <lttng/tracepoint.h>
33 #include <lttng/ust-events.h>
35 #include <usterr-signal-safe.h>
37 #include <lttng/ust-ctl.h>
40 #include <lttng/ust-dynamic-type.h>
41 #include <lttng/ust-context-provider.h>
44 #include "lttng-ust-uuid.h"
46 #include "tracepoint-internal.h"
47 #include "string-utils.h"
48 #include "lttng-bytecode.h"
49 #include "lttng-tracer.h"
50 #include "lttng-tracer-core.h"
51 #include "lttng-ust-statedump.h"
52 #include "context-internal.h"
53 #include "ust-events-internal.h"
55 #include "../libringbuffer/shm.h"
56 #include "../libcounter/counter.h"
58 #include <lttng/ust-abi.h>
61 * All operations within this file are called by the communication
62 * thread, under ust_lock protection.
65 static CDS_LIST_HEAD(sessions
);
66 static CDS_LIST_HEAD(event_notifier_groups
);
68 struct cds_list_head
*_lttng_get_sessions(void)
73 static void _lttng_event_destroy(struct lttng_event
*event
);
74 static void _lttng_event_notifier_destroy(
75 struct lttng_event_notifier
*event_notifier
);
76 static void _lttng_enum_destroy(struct lttng_enum
*_enum
);
79 void lttng_session_lazy_sync_event_enablers(struct lttng_session
*session
);
81 void lttng_session_sync_event_enablers(struct lttng_session
*session
);
83 void lttng_event_notifier_group_sync_enablers(
84 struct lttng_event_notifier_group
*event_notifier_group
);
86 void lttng_enabler_destroy(struct lttng_enabler
*enabler
);
89 * @buf must hold at least LTTNG_UST_SYM_NAME_LEN bytes.
92 int lttng_split_provider_event_name(const char *full_name
,
93 char *buf
, const char **event_name
,
94 const char **provider_name
)
98 if (strlen(full_name
) >= LTTNG_UST_SYM_NAME_LEN
)
100 strcpy(buf
, full_name
);
101 *provider_name
= strtok_r(buf
, ":", &saveptr
); /* Stops at ':' or '\0'. */
104 *event_name
= strtok_r(NULL
, ":", &saveptr
); /* Stops at ':' or '\0'. */
108 * Ensure we don't have leftover characters. Stops at '\0'. It validates
109 * that neither the provider nor event name contain ':'.
111 if (strtok_r(NULL
, "", &saveptr
))
117 * Called with ust lock held.
119 int lttng_session_active(void)
121 struct lttng_session
*iter
;
123 cds_list_for_each_entry(iter
, &sessions
, node
) {
131 int lttng_loglevel_match(int loglevel
,
132 unsigned int has_loglevel
,
133 enum lttng_ust_loglevel_type req_type
,
137 loglevel
= TRACE_DEFAULT
;
139 case LTTNG_UST_LOGLEVEL_RANGE
:
140 if (loglevel
<= req_loglevel
141 || (req_loglevel
== -1 && loglevel
<= TRACE_DEBUG
))
145 case LTTNG_UST_LOGLEVEL_SINGLE
:
146 if (loglevel
== req_loglevel
147 || (req_loglevel
== -1 && loglevel
<= TRACE_DEBUG
))
151 case LTTNG_UST_LOGLEVEL_ALL
:
153 if (loglevel
<= TRACE_DEBUG
)
160 struct lttng_session
*lttng_session_create(void)
162 struct lttng_session
*session
;
165 session
= zmalloc(sizeof(struct lttng_session
));
168 if (lttng_context_init_all(&session
->ctx
)) {
172 CDS_INIT_LIST_HEAD(&session
->chan_head
);
173 CDS_INIT_LIST_HEAD(&session
->events_head
);
174 CDS_INIT_LIST_HEAD(&session
->enums_head
);
175 CDS_INIT_LIST_HEAD(&session
->enablers_head
);
176 CDS_INIT_LIST_HEAD(&session
->counters
);
177 for (i
= 0; i
< LTTNG_UST_EVENT_HT_SIZE
; i
++)
178 CDS_INIT_HLIST_HEAD(&session
->events_name_ht
.table
[i
]);
179 for (i
= 0; i
< LTTNG_UST_EVENT_HT_SIZE
; i
++)
180 CDS_INIT_HLIST_HEAD(&session
->enums_ht
.table
[i
]);
181 cds_list_add(&session
->node
, &sessions
);
185 struct lttng_counter
*lttng_ust_counter_create(
186 const char *counter_transport_name
,
187 size_t number_dimensions
,
188 const size_t *max_nr_elem
,
189 int64_t global_sum_step
,
192 struct lttng_counter_transport
*counter_transport
= NULL
;
193 struct lttng_counter
*counter
= NULL
;
195 counter_transport
= lttng_counter_transport_find(counter_transport_name
);
196 if (!counter_transport
)
198 counter
= zmalloc(sizeof(struct lttng_counter
));
202 counter
->ops
= &counter_transport
->ops
;
203 counter
->transport
= counter_transport
;
205 counter
->counter
= counter
->ops
->counter_create(
206 number_dimensions
, max_nr_elem
, global_sum_step
,
208 if (!counter
->counter
) {
211 counter
->parent
.coalesce_hits
= coalesce_hits
;
223 void lttng_ust_counter_destroy(struct lttng_counter
*counter
)
225 counter
->ops
->counter_destroy(counter
->counter
);
229 struct lttng_counter
*lttng_session_create_counter(
230 struct lttng_session
*session
,
231 const char *counter_transport_name
,
232 size_t number_dimensions
, const size_t *dimensions_sizes
,
233 int64_t global_sum_step
, bool coalesce_hits
)
235 struct lttng_counter
*counter
;
236 struct lttng_event_container
*container
;
238 counter
= lttng_ust_counter_create(counter_transport_name
,
239 number_dimensions
, dimensions_sizes
, global_sum_step
,
244 container
= lttng_counter_get_event_container(counter
);
245 container
->type
= LTTNG_EVENT_CONTAINER_COUNTER
;
247 container
->session
= session
;
248 cds_list_add(&counter
->node
, &session
->counters
);
256 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void)
258 struct lttng_event_notifier_group
*event_notifier_group
;
261 event_notifier_group
= zmalloc(sizeof(struct lttng_event_notifier_group
));
262 if (!event_notifier_group
)
265 /* Add all contexts. */
266 if (lttng_context_init_all(&event_notifier_group
->ctx
)) {
267 free(event_notifier_group
);
271 CDS_INIT_LIST_HEAD(&event_notifier_group
->enablers_head
);
272 CDS_INIT_LIST_HEAD(&event_notifier_group
->event_notifiers_head
);
273 for (i
= 0; i
< LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
; i
++)
274 CDS_INIT_HLIST_HEAD(&event_notifier_group
->event_notifiers_ht
.table
[i
]);
276 cds_list_add(&event_notifier_group
->node
, &event_notifier_groups
);
278 return event_notifier_group
;
282 * Only used internally at session destruction.
285 void _lttng_channel_unmap(struct lttng_channel
*lttng_chan
)
287 struct channel
*chan
;
288 struct lttng_ust_shm_handle
*handle
;
290 cds_list_del(<tng_chan
->node
);
291 lttng_destroy_context(lttng_chan
->ctx
);
292 chan
= lttng_chan
->chan
;
293 handle
= lttng_chan
->handle
;
295 * note: lttng_chan is private data contained within handle. It
296 * will be freed along with the handle.
298 channel_destroy(chan
, handle
, 0);
302 void register_event(struct lttng_event
*event
)
305 const struct lttng_event_desc
*desc
;
307 assert(event
->registered
== 0);
309 ret
= __tracepoint_probe_register_queue_release(desc
->name
,
310 desc
->probe_callback
,
311 event
, desc
->signature
);
314 event
->registered
= 1;
318 void register_event_notifier(struct lttng_event_notifier
*event_notifier
)
321 const struct lttng_event_desc
*desc
;
323 assert(event_notifier
->registered
== 0);
324 desc
= event_notifier
->desc
;
325 ret
= __tracepoint_probe_register_queue_release(desc
->name
,
326 desc
->u
.ext
.event_notifier_callback
, event_notifier
, desc
->signature
);
329 event_notifier
->registered
= 1;
333 void unregister_event(struct lttng_event
*event
)
336 const struct lttng_event_desc
*desc
;
338 assert(event
->registered
== 1);
340 ret
= __tracepoint_probe_unregister_queue_release(desc
->name
,
341 desc
->probe_callback
,
345 event
->registered
= 0;
349 void unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
352 const struct lttng_event_desc
*desc
;
354 assert(event_notifier
->registered
== 1);
355 desc
= event_notifier
->desc
;
356 ret
= __tracepoint_probe_unregister_queue_release(desc
->name
,
357 desc
->u
.ext
.event_notifier_callback
, event_notifier
);
360 event_notifier
->registered
= 0;
364 * Only used internally at session destruction.
367 void _lttng_event_unregister(struct lttng_event
*event
)
369 if (event
->registered
)
370 unregister_event(event
);
374 * Only used internally at session destruction.
377 void _lttng_event_notifier_unregister(struct lttng_event_notifier
*event_notifier
)
379 if (event_notifier
->registered
)
380 unregister_event_notifier(event_notifier
);
383 void lttng_session_destroy(struct lttng_session
*session
)
385 struct lttng_channel
*chan
, *tmpchan
;
386 struct lttng_event
*event
, *tmpevent
;
387 struct lttng_enum
*_enum
, *tmp_enum
;
388 struct lttng_event_enabler
*event_enabler
, *event_tmpenabler
;
390 CMM_ACCESS_ONCE(session
->active
) = 0;
391 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
392 _lttng_event_unregister(event
);
394 lttng_ust_synchronize_trace(); /* Wait for in-flight events to complete */
395 __tracepoint_probe_prune_release_queue();
396 cds_list_for_each_entry_safe(event_enabler
, event_tmpenabler
,
397 &session
->enablers_head
, node
)
398 lttng_event_enabler_destroy(event_enabler
);
399 cds_list_for_each_entry_safe(event
, tmpevent
,
400 &session
->events_head
, node
)
401 _lttng_event_destroy(event
);
402 cds_list_for_each_entry_safe(_enum
, tmp_enum
,
403 &session
->enums_head
, node
)
404 _lttng_enum_destroy(_enum
);
405 cds_list_for_each_entry_safe(chan
, tmpchan
, &session
->chan_head
, node
)
406 _lttng_channel_unmap(chan
);
407 cds_list_del(&session
->node
);
408 lttng_destroy_context(session
->ctx
);
412 void lttng_event_notifier_group_destroy(
413 struct lttng_event_notifier_group
*event_notifier_group
)
416 struct lttng_event_notifier_enabler
*notifier_enabler
, *tmpnotifier_enabler
;
417 struct lttng_event_notifier
*notifier
, *tmpnotifier
;
419 if (!event_notifier_group
) {
423 cds_list_for_each_entry(notifier
,
424 &event_notifier_group
->event_notifiers_head
, node
)
425 _lttng_event_notifier_unregister(notifier
);
427 lttng_ust_synchronize_trace();
429 cds_list_for_each_entry_safe(notifier_enabler
, tmpnotifier_enabler
,
430 &event_notifier_group
->enablers_head
, node
)
431 lttng_event_notifier_enabler_destroy(notifier_enabler
);
433 cds_list_for_each_entry_safe(notifier
, tmpnotifier
,
434 &event_notifier_group
->event_notifiers_head
, node
)
435 _lttng_event_notifier_destroy(notifier
);
437 if (event_notifier_group
->error_counter
)
438 lttng_ust_counter_destroy(event_notifier_group
->error_counter
);
440 /* Close the notification fd to the listener of event_notifiers. */
442 lttng_ust_lock_fd_tracker();
443 close_ret
= close(event_notifier_group
->notification_fd
);
445 lttng_ust_delete_fd_from_tracker(
446 event_notifier_group
->notification_fd
);
451 lttng_ust_unlock_fd_tracker();
453 cds_list_del(&event_notifier_group
->node
);
455 free(event_notifier_group
);
459 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
461 struct lttng_ust_bytecode_node
*filter_node
, *tmp_filter_node
;
462 struct lttng_ust_excluder_node
*excluder_node
, *tmp_excluder_node
;
468 /* Destroy filter bytecode */
469 cds_list_for_each_entry_safe(filter_node
, tmp_filter_node
,
470 &enabler
->filter_bytecode_head
, node
) {
474 /* Destroy excluders */
475 cds_list_for_each_entry_safe(excluder_node
, tmp_excluder_node
,
476 &enabler
->excluder_head
, node
) {
481 void lttng_event_notifier_enabler_destroy(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
483 if (!event_notifier_enabler
) {
487 cds_list_del(&event_notifier_enabler
->node
);
489 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
491 free(event_notifier_enabler
);
495 int lttng_enum_create(const struct lttng_enum_desc
*desc
,
496 struct lttng_session
*session
)
498 const char *enum_name
= desc
->name
;
499 struct lttng_enum
*_enum
;
500 struct cds_hlist_head
*head
;
502 size_t name_len
= strlen(enum_name
);
506 /* Check if this enum is already registered for this session. */
507 hash
= jhash(enum_name
, name_len
, 0);
508 head
= &session
->enums_ht
.table
[hash
& (LTTNG_UST_ENUM_HT_SIZE
- 1)];
510 _enum
= lttng_ust_enum_get_from_desc(session
, desc
);
516 notify_socket
= lttng_get_notify_socket(session
->owner
);
517 if (notify_socket
< 0) {
522 _enum
= zmalloc(sizeof(*_enum
));
527 _enum
->session
= session
;
530 ret
= ustcomm_register_enum(notify_socket
,
537 DBG("Error (%d) registering enumeration to sessiond", ret
);
538 goto sessiond_register_error
;
540 cds_list_add(&_enum
->node
, &session
->enums_head
);
541 cds_hlist_add_head(&_enum
->hlist
, head
);
544 sessiond_register_error
:
553 int lttng_create_enum_check(const struct lttng_type
*type
,
554 struct lttng_session
*session
)
556 switch (type
->atype
) {
559 const struct lttng_enum_desc
*enum_desc
;
562 enum_desc
= type
->u
.legacy
.basic
.enumeration
.desc
;
563 ret
= lttng_enum_create(enum_desc
, session
);
564 if (ret
&& ret
!= -EEXIST
) {
565 DBG("Unable to create enum error: (%d)", ret
);
570 case atype_enum_nestable
:
572 const struct lttng_enum_desc
*enum_desc
;
575 enum_desc
= type
->u
.enum_nestable
.desc
;
576 ret
= lttng_enum_create(enum_desc
, session
);
577 if (ret
&& ret
!= -EEXIST
) {
578 DBG("Unable to create enum error: (%d)", ret
);
585 const struct lttng_event_field
*tag_field_generic
;
586 const struct lttng_enum_desc
*enum_desc
;
589 tag_field_generic
= lttng_ust_dynamic_type_tag_field();
590 enum_desc
= tag_field_generic
->type
.u
.enum_nestable
.desc
;
591 ret
= lttng_enum_create(enum_desc
, session
);
592 if (ret
&& ret
!= -EEXIST
) {
593 DBG("Unable to create enum error: (%d)", ret
);
599 /* TODO: nested types when they become supported. */
606 int lttng_create_all_event_enums(size_t nr_fields
,
607 const struct lttng_event_field
*event_fields
,
608 struct lttng_session
*session
)
613 /* For each field, ensure enum is part of the session. */
614 for (i
= 0; i
< nr_fields
; i
++) {
615 const struct lttng_type
*type
= &event_fields
[i
].type
;
617 ret
= lttng_create_enum_check(type
, session
);
625 int lttng_create_all_ctx_enums(size_t nr_fields
,
626 const struct lttng_ctx_field
*ctx_fields
,
627 struct lttng_session
*session
)
632 /* For each field, ensure enum is part of the session. */
633 for (i
= 0; i
< nr_fields
; i
++) {
634 const struct lttng_type
*type
= &ctx_fields
[i
].event_field
.type
;
636 ret
= lttng_create_enum_check(type
, session
);
644 * Ensure that a state-dump will be performed for this session at the end
645 * of the current handle_message().
647 int lttng_session_statedump(struct lttng_session
*session
)
649 session
->statedump_pending
= 1;
650 lttng_ust_sockinfo_session_enabled(session
->owner
);
654 int lttng_session_enable(struct lttng_session
*session
)
657 struct lttng_channel
*chan
;
660 if (session
->active
) {
665 notify_socket
= lttng_get_notify_socket(session
->owner
);
666 if (notify_socket
< 0)
667 return notify_socket
;
669 /* Set transient enabler state to "enabled" */
672 /* We need to sync enablers with session before activation. */
673 lttng_session_sync_event_enablers(session
);
676 * Snapshot the number of events per channel to know the type of header
679 cds_list_for_each_entry(chan
, &session
->chan_head
, node
) {
680 const struct lttng_ctx
*ctx
;
681 const struct lttng_ctx_field
*fields
= NULL
;
682 size_t nr_fields
= 0;
685 /* don't change it if session stop/restart */
686 if (chan
->header_type
)
690 nr_fields
= ctx
->nr_fields
;
691 fields
= ctx
->fields
;
692 ret
= lttng_create_all_ctx_enums(nr_fields
, fields
,
695 DBG("Error (%d) adding enum to session", ret
);
699 ret
= ustcomm_register_channel(notify_socket
,
708 DBG("Error (%d) registering channel to sessiond", ret
);
711 if (chan_id
!= chan
->id
) {
712 DBG("Error: channel registration id (%u) does not match id assigned at creation (%u)",
718 /* Set atomically the state to "active" */
719 CMM_ACCESS_ONCE(session
->active
) = 1;
720 CMM_ACCESS_ONCE(session
->been_active
) = 1;
722 ret
= lttng_session_statedump(session
);
729 int lttng_session_disable(struct lttng_session
*session
)
733 if (!session
->active
) {
737 /* Set atomically the state to "inactive" */
738 CMM_ACCESS_ONCE(session
->active
) = 0;
740 /* Set transient enabler state to "disabled" */
742 lttng_session_sync_event_enablers(session
);
747 int lttng_event_container_enable(struct lttng_event_container
*container
)
751 if (container
->enabled
) {
755 /* Set transient enabler state to "enabled" */
756 container
->tstate
= 1;
757 lttng_session_sync_event_enablers(container
->session
);
758 /* Atomically set the state to "enabled" */
759 switch (container
->type
) {
760 case LTTNG_EVENT_CONTAINER_CHANNEL
:
762 struct lttng_channel
*channel
= caa_container_of(container
,
763 struct lttng_channel
, parent
);
765 CMM_ACCESS_ONCE(channel
->enabled
) = 1; /* Backward compatibility */
771 CMM_ACCESS_ONCE(container
->enabled
) = 1;
776 int lttng_event_container_disable(struct lttng_event_container
*container
)
780 if (!container
->enabled
) {
784 /* Atomically set the state to "disabled" */
785 CMM_ACCESS_ONCE(container
->enabled
) = 0;
786 switch (container
->type
) {
787 case LTTNG_EVENT_CONTAINER_CHANNEL
:
789 struct lttng_channel
*channel
= caa_container_of(container
,
790 struct lttng_channel
, parent
);
792 CMM_ACCESS_ONCE(channel
->enabled
) = 0; /* Backward compatibility */
798 /* Set transient enabler state to "enabled" */
799 container
->tstate
= 0;
800 lttng_session_sync_event_enablers(container
->session
);
806 struct cds_hlist_head
*borrow_hash_table_bucket(
807 struct cds_hlist_head
*hash_table
,
808 unsigned int hash_table_size
,
814 name_len
= strlen(name
);
816 hash
= jhash(name
, name_len
, 0);
817 return &hash_table
[hash
& (hash_table_size
- 1)];
821 int format_event_key(char *key_string
, const struct lttng_counter_key
*key
,
822 const char *full_name
)
824 const struct lttng_counter_key_dimension
*dim
;
825 size_t i
, left
= LTTNG_KEY_TOKEN_STRING_LEN_MAX
;
826 char buf
[LTTNG_UST_SYM_NAME_LEN
];
827 const char *provider_name
, *event_name
;
829 if (lttng_split_provider_event_name(full_name
, buf
, &provider_name
, &event_name
))
831 key_string
[0] = '\0';
832 if (!key
|| !key
->nr_dimensions
)
834 /* Currently event keys can only be specified on a single dimension. */
835 if (key
->nr_dimensions
!= 1)
837 dim
= &key
->key_dimensions
[0];
838 for (i
= 0; i
< dim
->nr_key_tokens
; i
++) {
839 const struct lttng_key_token
*token
= &dim
->key_tokens
[i
];
843 switch (token
->type
) {
844 case LTTNG_KEY_TOKEN_STRING
:
845 str
= token
->arg
.string
;
847 case LTTNG_KEY_TOKEN_EVENT_NAME
:
850 case LTTNG_KEY_TOKEN_PROVIDER_NAME
:
856 token_len
= strlen(str
);
857 if (token_len
>= left
)
859 strcat(key_string
, str
);
866 bool match_event_token(struct lttng_event_container
*container
,
867 struct lttng_event
*event
, uint64_t token
)
869 if (container
->coalesce_hits
)
871 if (event
->user_token
== token
)
877 * Supports event creation while tracing session is active.
880 int lttng_event_create(struct lttng_event_enabler
*event_enabler
,
881 const struct lttng_event_desc
*event_desc
,
882 const struct lttng_counter_key
*key
)
884 struct lttng_event_container
*container
= event_enabler
->container
;
885 struct lttng_event
*event
;
886 struct lttng_session
*session
= container
->session
;
887 const char *event_name
;
888 struct cds_hlist_head
*name_head
;
889 char key_string
[LTTNG_KEY_TOKEN_STRING_LEN_MAX
];
891 int notify_socket
, loglevel
;
894 event_name
= event_desc
->name
;
895 if (format_event_key(key_string
, key
, event_name
)) {
900 name_head
= borrow_hash_table_bucket(session
->events_name_ht
.table
,
901 LTTNG_UST_EVENT_HT_SIZE
, event_name
);
902 cds_hlist_for_each_entry_2(event
, name_head
, name_hlist
) {
903 bool same_event
= false, same_container
= false, same_key
= false,
906 WARN_ON_ONCE(!event
->desc
);
908 if (event
->desc
== event_desc
)
911 if (!strcmp(event_name
, event
->desc
->name
))
914 if (container
== event
->container
) {
915 same_container
= true;
916 if (match_event_token(container
, event
,
917 event_enabler
->base
.user_token
))
920 if (key_string
[0] == '\0' || !strcmp(key_string
, event
->key
))
922 if (same_event
&& same_container
&& same_key
&& same_token
) {
928 notify_socket
= lttng_get_notify_socket(session
->owner
);
929 if (notify_socket
< 0) {
934 ret
= lttng_create_all_event_enums(event_desc
->nr_fields
, event_desc
->fields
,
937 DBG("Error (%d) adding enum to session", ret
);
938 goto create_enum_error
;
942 * Check if loglevel match. Refuse to connect event if not.
944 event
= zmalloc(sizeof(struct lttng_event
));
949 /* for backward compatibility */
950 event
->chan
= lttng_event_container_get_channel(container
);
952 /* Event will be enabled by enabler sync. */
954 event
->registered
= 0;
955 CDS_INIT_LIST_HEAD(&event
->filter_bytecode_runtime_head
);
956 CDS_INIT_LIST_HEAD(&event
->enablers_ref_head
);
957 event
->desc
= event_desc
;
958 event
->container
= container
;
959 strcpy(event
->key
, key_string
);
960 if (!container
->coalesce_hits
)
961 event
->user_token
= event_enabler
->base
.user_token
;
963 if (event_desc
->loglevel
)
964 loglevel
= *(*event
->desc
->loglevel
);
966 loglevel
= TRACE_DEFAULT
;
967 if (event_desc
->u
.ext
.model_emf_uri
)
968 uri
= *(event_desc
->u
.ext
.model_emf_uri
);
972 /* Fetch event ID from sessiond */
973 ret
= ustcomm_register_event(notify_socket
,
979 event_desc
->signature
,
980 event_desc
->nr_fields
,
983 event_enabler
->base
.user_token
,
985 &event
->counter_index
);
987 DBG("Error (%d) registering event to sessiond", ret
);
988 goto sessiond_register_error
;
991 cds_list_add(&event
->node
, &session
->events_head
);
992 cds_hlist_add_head(&event
->name_hlist
, name_head
);
995 sessiond_register_error
:
1006 int lttng_event_notifier_create(const struct lttng_event_desc
*desc
,
1007 uint64_t token
, uint64_t error_counter_index
,
1008 struct lttng_event_notifier_group
*event_notifier_group
)
1010 struct lttng_event_notifier
*event_notifier
;
1011 struct cds_hlist_head
*head
;
1015 * Get the hashtable bucket the created lttng_event_notifier object
1016 * should be inserted.
1018 head
= borrow_hash_table_bucket(
1019 event_notifier_group
->event_notifiers_ht
.table
,
1020 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
, desc
->name
);
1022 event_notifier
= zmalloc(sizeof(struct lttng_event_notifier
));
1023 if (!event_notifier
) {
1028 event_notifier
->group
= event_notifier_group
;
1029 event_notifier
->user_token
= token
;
1030 event_notifier
->error_counter_index
= error_counter_index
;
1032 /* Event notifier will be enabled by enabler sync. */
1033 event_notifier
->enabled
= 0;
1034 event_notifier
->registered
= 0;
1036 CDS_INIT_LIST_HEAD(&event_notifier
->filter_bytecode_runtime_head
);
1037 CDS_INIT_LIST_HEAD(&event_notifier
->capture_bytecode_runtime_head
);
1038 CDS_INIT_LIST_HEAD(&event_notifier
->enablers_ref_head
);
1039 event_notifier
->desc
= desc
;
1040 event_notifier
->notification_send
= lttng_event_notifier_notification_send
;
1042 cds_list_add(&event_notifier
->node
,
1043 &event_notifier_group
->event_notifiers_head
);
1044 cds_hlist_add_head(&event_notifier
->hlist
, head
);
1053 void _lttng_event_notifier_destroy(struct lttng_event_notifier
*event_notifier
)
1055 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1057 /* Remove from event_notifier list. */
1058 cds_list_del(&event_notifier
->node
);
1059 /* Remove from event_notifier hash table. */
1060 cds_hlist_del(&event_notifier
->hlist
);
1062 lttng_free_event_notifier_filter_runtime(event_notifier
);
1064 /* Free event_notifier enabler refs */
1065 cds_list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1066 &event_notifier
->enablers_ref_head
, node
)
1068 free(event_notifier
);
1072 int lttng_desc_match_star_glob_enabler(const struct lttng_event_desc
*desc
,
1073 struct lttng_enabler
*enabler
)
1076 unsigned int has_loglevel
= 0;
1078 assert(enabler
->format_type
== LTTNG_ENABLER_FORMAT_STAR_GLOB
);
1079 if (!strutils_star_glob_match(enabler
->event_param
.name
, SIZE_MAX
,
1080 desc
->name
, SIZE_MAX
))
1082 if (desc
->loglevel
) {
1083 loglevel
= *(*desc
->loglevel
);
1086 if (!lttng_loglevel_match(loglevel
,
1088 enabler
->event_param
.loglevel_type
,
1089 enabler
->event_param
.loglevel
))
1095 int lttng_desc_match_event_enabler(const struct lttng_event_desc
*desc
,
1096 struct lttng_enabler
*enabler
)
1099 unsigned int has_loglevel
= 0;
1101 assert(enabler
->format_type
== LTTNG_ENABLER_FORMAT_EVENT
);
1102 if (strcmp(desc
->name
, enabler
->event_param
.name
))
1104 if (desc
->loglevel
) {
1105 loglevel
= *(*desc
->loglevel
);
1108 if (!lttng_loglevel_match(loglevel
,
1110 enabler
->event_param
.loglevel_type
,
1111 enabler
->event_param
.loglevel
))
1117 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
1118 struct lttng_enabler
*enabler
)
1120 switch (enabler
->format_type
) {
1121 case LTTNG_ENABLER_FORMAT_STAR_GLOB
:
1123 struct lttng_ust_excluder_node
*excluder
;
1125 if (!lttng_desc_match_star_glob_enabler(desc
, enabler
)) {
1130 * If the matching event matches with an excluder,
1131 * return 'does not match'
1133 cds_list_for_each_entry(excluder
, &enabler
->excluder_head
, node
) {
1136 for (count
= 0; count
< excluder
->excluder
.count
; count
++) {
1138 char *excluder_name
;
1140 excluder_name
= (char *) (excluder
->excluder
.names
)
1141 + count
* LTTNG_UST_SYM_NAME_LEN
;
1142 len
= strnlen(excluder_name
, LTTNG_UST_SYM_NAME_LEN
);
1143 if (len
> 0 && strutils_star_glob_match(excluder_name
, len
, desc
->name
, SIZE_MAX
))
1149 case LTTNG_ENABLER_FORMAT_EVENT
:
1150 return lttng_desc_match_event_enabler(desc
, enabler
);
1157 bool lttng_event_enabler_match_event(struct lttng_event_enabler
*event_enabler
,
1158 struct lttng_event
*event
)
1160 if (lttng_desc_match_enabler(event
->desc
,
1161 lttng_event_enabler_as_enabler(event_enabler
)) > 0
1162 && event
->container
== event_enabler
->container
1163 && match_event_token(event
->container
, event
, event_enabler
->base
.user_token
))
1170 int lttng_event_notifier_enabler_match_event_notifier(
1171 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
1172 struct lttng_event_notifier
*event_notifier
)
1174 bool desc_matches
= lttng_desc_match_enabler(event_notifier
->desc
,
1175 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)) > 0;
1177 if (desc_matches
&& event_notifier
->group
== event_notifier_enabler
->group
&&
1178 event_notifier
->user_token
== event_notifier_enabler
->base
.user_token
)
1185 struct lttng_enabler_ref
*lttng_enabler_ref(
1186 struct cds_list_head
*enabler_ref_list
,
1187 struct lttng_enabler
*enabler
)
1189 struct lttng_enabler_ref
*enabler_ref
;
1191 cds_list_for_each_entry(enabler_ref
, enabler_ref_list
, node
) {
1192 if (enabler_ref
->ref
== enabler
)
1199 * Create struct lttng_event if it is missing and present in the list of
1200 * tracepoint probes.
1203 void lttng_create_event_if_missing(struct lttng_event_enabler
*event_enabler
)
1205 struct lttng_probe_desc
*probe_desc
;
1206 const struct lttng_event_desc
*desc
;
1208 struct cds_list_head
*probe_list
;
1210 probe_list
= lttng_get_probe_list_head();
1212 * For each probe event, if we find that a probe event matches
1213 * our enabler, create an associated lttng_event if not
1216 cds_list_for_each_entry(probe_desc
, probe_list
, head
) {
1217 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
1220 desc
= probe_desc
->event_desc
[i
];
1221 if (lttng_desc_match_enabler(desc
,
1222 lttng_event_enabler_as_enabler(event_enabler
)) <= 0)
1225 /* Try to create an event for this event probe. */
1226 ret
= lttng_event_create(event_enabler
,
1227 probe_desc
->event_desc
[i
],
1228 &event_enabler
->key
);
1229 /* Skip if event is already found. */
1233 DBG("Unable to create event %s, error %d\n",
1234 probe_desc
->event_desc
[i
]->name
, ret
);
1241 void probe_provider_event_for_each(struct lttng_probe_desc
*provider_desc
,
1242 void (*event_func
)(struct lttng_session
*session
,
1243 struct lttng_event
*event
),
1244 void (*event_notifier_func
)(struct lttng_event_notifier
*event_notifier
))
1246 struct cds_hlist_node
*node
, *tmp_node
;
1247 struct cds_list_head
*sessionsp
;
1250 /* Get handle on list of sessions. */
1251 sessionsp
= _lttng_get_sessions();
1254 * Iterate over all events in the probe provider descriptions and
1255 * sessions to queue the unregistration of the events.
1257 for (i
= 0; i
< provider_desc
->nr_events
; i
++) {
1258 const struct lttng_event_desc
*event_desc
;
1259 struct lttng_event_notifier_group
*event_notifier_group
;
1260 struct lttng_event_notifier
*event_notifier
;
1261 struct lttng_session
*session
;
1262 struct cds_hlist_head
*head
;
1263 struct lttng_event
*event
;
1265 event_desc
= provider_desc
->event_desc
[i
];
1268 * Iterate over all session to find the current event
1271 cds_list_for_each_entry(session
, sessionsp
, node
) {
1273 * Get the list of events in the hashtable bucket and
1274 * iterate to find the event matching this descriptor.
1276 head
= borrow_hash_table_bucket(
1277 session
->events_name_ht
.table
,
1278 LTTNG_UST_EVENT_HT_SIZE
, event_desc
->name
);
1280 cds_hlist_for_each_entry_safe(event
, node
, tmp_node
, head
, name_hlist
) {
1281 if (event_desc
== event
->desc
) {
1282 event_func(session
, event
);
1289 * Iterate over all event_notifier groups to find the current event
1292 cds_list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
1294 * Get the list of event_notifiers in the hashtable bucket and
1295 * iterate to find the event_notifier matching this
1298 head
= borrow_hash_table_bucket(
1299 event_notifier_group
->event_notifiers_ht
.table
,
1300 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
, event_desc
->name
);
1302 cds_hlist_for_each_entry_safe(event_notifier
, node
, tmp_node
, head
, hlist
) {
1303 if (event_desc
== event_notifier
->desc
) {
1304 event_notifier_func(event_notifier
);
1313 void _unregister_event(struct lttng_session
*session
,
1314 struct lttng_event
*event
)
1316 _lttng_event_unregister(event
);
1320 void _event_enum_destroy(struct lttng_session
*session
,
1321 struct lttng_event
*event
)
1325 /* Destroy enums of the current event. */
1326 for (i
= 0; i
< event
->desc
->nr_fields
; i
++) {
1327 const struct lttng_enum_desc
*enum_desc
;
1328 const struct lttng_event_field
*field
;
1329 struct lttng_enum
*curr_enum
;
1331 field
= &(event
->desc
->fields
[i
]);
1332 switch (field
->type
.atype
) {
1334 enum_desc
= field
->type
.u
.legacy
.basic
.enumeration
.desc
;
1336 case atype_enum_nestable
:
1337 enum_desc
= field
->type
.u
.enum_nestable
.desc
;
1343 curr_enum
= lttng_ust_enum_get_from_desc(session
, enum_desc
);
1345 _lttng_enum_destroy(curr_enum
);
1349 /* Destroy event. */
1350 _lttng_event_destroy(event
);
1354 * Iterate over all the UST sessions to unregister and destroy all probes from
1355 * the probe provider descriptor received as argument. Must me called with the
1358 void lttng_probe_provider_unregister_events(
1359 struct lttng_probe_desc
*provider_desc
)
1362 * Iterate over all events in the probe provider descriptions and sessions
1363 * to queue the unregistration of the events.
1365 probe_provider_event_for_each(provider_desc
, _unregister_event
,
1366 _lttng_event_notifier_unregister
);
1368 /* Wait for grace period. */
1369 lttng_ust_synchronize_trace();
1370 /* Prune the unregistration queue. */
1371 __tracepoint_probe_prune_release_queue();
1374 * It is now safe to destroy the events and remove them from the event list
1377 probe_provider_event_for_each(provider_desc
, _event_enum_destroy
,
1378 _lttng_event_notifier_destroy
);
1382 * Create events associated with an event enabler (if not already present),
1383 * and add backward reference from the event to the enabler.
1386 int lttng_event_enabler_ref_events(struct lttng_event_enabler
*event_enabler
)
1388 struct lttng_session
*session
= event_enabler
->container
->session
;
1389 struct lttng_event
*event
;
1391 if (!lttng_event_enabler_as_enabler(event_enabler
)->enabled
)
1394 /* First ensure that probe events are created for this enabler. */
1395 lttng_create_event_if_missing(event_enabler
);
1397 /* For each event matching enabler in session event list. */
1398 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
1399 struct lttng_enabler_ref
*enabler_ref
;
1401 if (!lttng_event_enabler_match_event(event_enabler
, event
))
1404 enabler_ref
= lttng_enabler_ref(&event
->enablers_ref_head
,
1405 lttng_event_enabler_as_enabler(event_enabler
));
1408 * If no backward ref, create it.
1409 * Add backward ref from event to enabler.
1411 enabler_ref
= zmalloc(sizeof(*enabler_ref
));
1414 enabler_ref
->ref
= lttng_event_enabler_as_enabler(
1416 cds_list_add(&enabler_ref
->node
,
1417 &event
->enablers_ref_head
);
1421 * Link filter bytecodes if not linked yet.
1423 lttng_enabler_link_bytecode(event
->desc
,
1425 &event
->filter_bytecode_runtime_head
,
1426 <tng_event_enabler_as_enabler(event_enabler
)->filter_bytecode_head
);
1428 /* TODO: merge event context. */
1435 * Called at library load: connect the probe on all enablers matching
1437 * Called with session mutex held.
1439 int lttng_fix_pending_events(void)
1441 struct lttng_session
*session
;
1443 cds_list_for_each_entry(session
, &sessions
, node
) {
1444 lttng_session_lazy_sync_event_enablers(session
);
1449 int lttng_fix_pending_event_notifiers(void)
1451 struct lttng_event_notifier_group
*event_notifier_group
;
1453 cds_list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
1454 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
1460 * For each session of the owner thread, execute pending statedump.
1461 * Only dump state for the sessions owned by the caller thread, because
1462 * we don't keep ust_lock across the entire iteration.
1464 void lttng_handle_pending_statedump(void *owner
)
1466 struct lttng_session
*session
;
1468 /* Execute state dump */
1469 do_lttng_ust_statedump(owner
);
1471 /* Clear pending state dump */
1475 cds_list_for_each_entry(session
, &sessions
, node
) {
1476 if (session
->owner
!= owner
)
1478 if (!session
->statedump_pending
)
1480 session
->statedump_pending
= 0;
1488 * Only used internally at session destruction.
1491 void _lttng_event_destroy(struct lttng_event
*event
)
1493 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
1495 /* Remove from event list. */
1496 cds_list_del(&event
->node
);
1497 /* Remove from event hash table. */
1498 cds_hlist_del(&event
->name_hlist
);
1500 lttng_destroy_context(event
->ctx
);
1501 lttng_free_event_filter_runtime(event
);
1502 /* Free event enabler refs */
1503 cds_list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
1504 &event
->enablers_ref_head
, node
)
1510 void _lttng_enum_destroy(struct lttng_enum
*_enum
)
1512 cds_list_del(&_enum
->node
);
1513 cds_hlist_del(&_enum
->hlist
);
1517 void lttng_ust_events_exit(void)
1519 struct lttng_session
*session
, *tmpsession
;
1521 cds_list_for_each_entry_safe(session
, tmpsession
, &sessions
, node
)
1522 lttng_session_destroy(session
);
1526 int copy_counter_key(struct lttng_counter_key
*key
,
1527 const struct lttng_ust_counter_key
*key_param
)
1529 size_t i
, j
, nr_dimensions
;
1531 nr_dimensions
= key_param
->nr_dimensions
;
1532 if (nr_dimensions
> LTTNG_COUNTER_DIMENSION_MAX
)
1534 key
->nr_dimensions
= nr_dimensions
;
1535 for (i
= 0; i
< nr_dimensions
; i
++) {
1536 const struct lttng_ust_counter_key_dimension
*udim
=
1537 &key_param
->key_dimensions
[i
];
1538 struct lttng_counter_key_dimension
*dim
=
1539 &key
->key_dimensions
[i
];
1540 size_t nr_key_tokens
;
1542 nr_key_tokens
= udim
->nr_key_tokens
;
1543 if (!nr_key_tokens
|| nr_key_tokens
> LTTNG_NR_KEY_TOKEN
)
1545 dim
->nr_key_tokens
= nr_key_tokens
;
1546 for (j
= 0; j
< nr_key_tokens
; j
++) {
1547 const struct lttng_ust_key_token
*utoken
=
1548 &udim
->key_tokens
[j
];
1549 struct lttng_key_token
*token
=
1550 &dim
->key_tokens
[j
];
1552 switch (utoken
->type
) {
1553 case LTTNG_UST_KEY_TOKEN_STRING
:
1557 token
->type
= LTTNG_KEY_TOKEN_STRING
;
1558 len
= strnlen(utoken
->arg
.string
, LTTNG_KEY_TOKEN_STRING_LEN_MAX
);
1559 if (!len
|| len
>= LTTNG_KEY_TOKEN_STRING_LEN_MAX
)
1561 strcpy(token
->arg
.string
, utoken
->arg
.string
);
1564 case LTTNG_UST_KEY_TOKEN_EVENT_NAME
:
1565 token
->type
= LTTNG_KEY_TOKEN_EVENT_NAME
;
1567 case LTTNG_UST_KEY_TOKEN_PROVIDER_NAME
:
1568 token
->type
= LTTNG_KEY_TOKEN_PROVIDER_NAME
;
1579 * Enabler management.
1581 struct lttng_event_enabler
*lttng_event_enabler_create(
1582 enum lttng_enabler_format_type format_type
,
1583 struct lttng_ust_event
*event_param
,
1584 const struct lttng_ust_counter_key
*key
,
1585 struct lttng_event_container
*container
)
1587 struct lttng_event_enabler
*event_enabler
;
1589 event_enabler
= zmalloc(sizeof(*event_enabler
));
1592 event_enabler
->base
.format_type
= format_type
;
1593 event_enabler
->base
.user_token
= event_param
->token
;
1594 CDS_INIT_LIST_HEAD(&event_enabler
->base
.filter_bytecode_head
);
1595 CDS_INIT_LIST_HEAD(&event_enabler
->base
.excluder_head
);
1596 memcpy(&event_enabler
->base
.event_param
, event_param
,
1597 sizeof(event_enabler
->base
.event_param
));
1598 event_enabler
->container
= container
;
1600 if (copy_counter_key(&event_enabler
->key
, key
))
1604 event_enabler
->base
.enabled
= 0;
1605 cds_list_add(&event_enabler
->node
, &event_enabler
->container
->session
->enablers_head
);
1606 lttng_session_lazy_sync_event_enablers(event_enabler
->container
->session
);
1608 return event_enabler
;
1611 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
1612 struct lttng_event_notifier_group
*event_notifier_group
,
1613 enum lttng_enabler_format_type format_type
,
1614 struct lttng_ust_event_notifier
*event_notifier_param
)
1616 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
1618 event_notifier_enabler
= zmalloc(sizeof(*event_notifier_enabler
));
1619 if (!event_notifier_enabler
)
1621 event_notifier_enabler
->base
.format_type
= format_type
;
1622 CDS_INIT_LIST_HEAD(&event_notifier_enabler
->base
.filter_bytecode_head
);
1623 CDS_INIT_LIST_HEAD(&event_notifier_enabler
->capture_bytecode_head
);
1624 CDS_INIT_LIST_HEAD(&event_notifier_enabler
->base
.excluder_head
);
1626 event_notifier_enabler
->error_counter_index
= event_notifier_param
->error_counter_index
;
1627 event_notifier_enabler
->num_captures
= 0;
1629 event_notifier_enabler
->base
.user_token
= event_notifier_param
->event
.token
;
1630 memcpy(&event_notifier_enabler
->base
.event_param
.name
,
1631 event_notifier_param
->event
.name
,
1632 sizeof(event_notifier_enabler
->base
.event_param
.name
));
1633 event_notifier_enabler
->base
.event_param
.instrumentation
=
1634 event_notifier_param
->event
.instrumentation
;
1635 event_notifier_enabler
->base
.event_param
.loglevel
=
1636 event_notifier_param
->event
.loglevel
;
1637 event_notifier_enabler
->base
.event_param
.loglevel_type
=
1638 event_notifier_param
->event
.loglevel_type
;
1640 event_notifier_enabler
->base
.enabled
= 0;
1641 event_notifier_enabler
->group
= event_notifier_group
;
1643 cds_list_add(&event_notifier_enabler
->node
,
1644 &event_notifier_group
->enablers_head
);
1646 lttng_event_notifier_group_sync_enablers(event_notifier_group
);
1648 return event_notifier_enabler
;
1651 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
)
1653 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 1;
1654 lttng_session_lazy_sync_event_enablers(event_enabler
->container
->session
);
1659 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
)
1661 lttng_event_enabler_as_enabler(event_enabler
)->enabled
= 0;
1662 lttng_session_lazy_sync_event_enablers(event_enabler
->container
->session
);
1668 void _lttng_enabler_attach_filter_bytecode(struct lttng_enabler
*enabler
,
1669 struct lttng_ust_bytecode_node
**bytecode
)
1671 (*bytecode
)->enabler
= enabler
;
1672 cds_list_add_tail(&(*bytecode
)->node
, &enabler
->filter_bytecode_head
);
1673 /* Take ownership of bytecode */
1677 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
1678 struct lttng_ust_bytecode_node
**bytecode
)
1680 _lttng_enabler_attach_filter_bytecode(
1681 lttng_event_enabler_as_enabler(event_enabler
), bytecode
);
1683 lttng_session_lazy_sync_event_enablers(event_enabler
->container
->session
);
1688 void _lttng_enabler_attach_exclusion(struct lttng_enabler
*enabler
,
1689 struct lttng_ust_excluder_node
**excluder
)
1691 (*excluder
)->enabler
= enabler
;
1692 cds_list_add_tail(&(*excluder
)->node
, &enabler
->excluder_head
);
1693 /* Take ownership of excluder */
1697 int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler
*event_enabler
,
1698 struct lttng_ust_excluder_node
**excluder
)
1700 _lttng_enabler_attach_exclusion(
1701 lttng_event_enabler_as_enabler(event_enabler
), excluder
);
1703 lttng_session_lazy_sync_event_enablers(event_enabler
->container
->session
);
1707 int lttng_event_notifier_enabler_enable(
1708 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
1710 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 1;
1711 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
1716 int lttng_event_notifier_enabler_disable(
1717 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
1719 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
= 0;
1720 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
1725 int lttng_event_notifier_enabler_attach_filter_bytecode(
1726 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
1727 struct lttng_ust_bytecode_node
**bytecode
)
1729 _lttng_enabler_attach_filter_bytecode(
1730 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
1733 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
1737 int lttng_event_notifier_enabler_attach_capture_bytecode(
1738 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
1739 struct lttng_ust_bytecode_node
**bytecode
)
1741 (*bytecode
)->enabler
= lttng_event_notifier_enabler_as_enabler(
1742 event_notifier_enabler
);
1743 cds_list_add_tail(&(*bytecode
)->node
,
1744 &event_notifier_enabler
->capture_bytecode_head
);
1745 /* Take ownership of bytecode */
1747 event_notifier_enabler
->num_captures
++;
1749 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
1753 int lttng_event_notifier_enabler_attach_exclusion(
1754 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
1755 struct lttng_ust_excluder_node
**excluder
)
1757 _lttng_enabler_attach_exclusion(
1758 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
),
1761 lttng_event_notifier_group_sync_enablers(event_notifier_enabler
->group
);
1765 int lttng_attach_context(struct lttng_ust_context
*context_param
,
1766 union ust_args
*uargs
,
1767 struct lttng_ctx
**ctx
, struct lttng_session
*session
)
1770 * We cannot attach a context after trace has been started for a
1771 * session because the metadata does not allow expressing this
1772 * information outside of the original channel scope.
1774 if (session
->been_active
)
1777 switch (context_param
->ctx
) {
1778 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
1779 return lttng_add_pthread_id_to_ctx(ctx
);
1780 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
1782 struct lttng_ust_perf_counter_ctx
*perf_ctx_param
;
1784 perf_ctx_param
= &context_param
->u
.perf_counter
;
1785 return lttng_add_perf_counter_to_ctx(
1786 perf_ctx_param
->type
,
1787 perf_ctx_param
->config
,
1788 perf_ctx_param
->name
,
1791 case LTTNG_UST_CONTEXT_VTID
:
1792 return lttng_add_vtid_to_ctx(ctx
);
1793 case LTTNG_UST_CONTEXT_VPID
:
1794 return lttng_add_vpid_to_ctx(ctx
);
1795 case LTTNG_UST_CONTEXT_PROCNAME
:
1796 return lttng_add_procname_to_ctx(ctx
);
1797 case LTTNG_UST_CONTEXT_IP
:
1798 return lttng_add_ip_to_ctx(ctx
);
1799 case LTTNG_UST_CONTEXT_CPU_ID
:
1800 return lttng_add_cpu_id_to_ctx(ctx
);
1801 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
1802 return lttng_ust_add_app_context_to_ctx_rcu(uargs
->app_context
.ctxname
,
1804 case LTTNG_UST_CONTEXT_CGROUP_NS
:
1805 return lttng_add_cgroup_ns_to_ctx(ctx
);
1806 case LTTNG_UST_CONTEXT_IPC_NS
:
1807 return lttng_add_ipc_ns_to_ctx(ctx
);
1808 case LTTNG_UST_CONTEXT_MNT_NS
:
1809 return lttng_add_mnt_ns_to_ctx(ctx
);
1810 case LTTNG_UST_CONTEXT_NET_NS
:
1811 return lttng_add_net_ns_to_ctx(ctx
);
1812 case LTTNG_UST_CONTEXT_PID_NS
:
1813 return lttng_add_pid_ns_to_ctx(ctx
);
1814 case LTTNG_UST_CONTEXT_TIME_NS
:
1815 return lttng_add_time_ns_to_ctx(ctx
);
1816 case LTTNG_UST_CONTEXT_USER_NS
:
1817 return lttng_add_user_ns_to_ctx(ctx
);
1818 case LTTNG_UST_CONTEXT_UTS_NS
:
1819 return lttng_add_uts_ns_to_ctx(ctx
);
1820 case LTTNG_UST_CONTEXT_VUID
:
1821 return lttng_add_vuid_to_ctx(ctx
);
1822 case LTTNG_UST_CONTEXT_VEUID
:
1823 return lttng_add_veuid_to_ctx(ctx
);
1824 case LTTNG_UST_CONTEXT_VSUID
:
1825 return lttng_add_vsuid_to_ctx(ctx
);
1826 case LTTNG_UST_CONTEXT_VGID
:
1827 return lttng_add_vgid_to_ctx(ctx
);
1828 case LTTNG_UST_CONTEXT_VEGID
:
1829 return lttng_add_vegid_to_ctx(ctx
);
1830 case LTTNG_UST_CONTEXT_VSGID
:
1831 return lttng_add_vsgid_to_ctx(ctx
);
1837 int lttng_event_enabler_attach_context(struct lttng_event_enabler
*enabler
,
1838 struct lttng_ust_context
*context_param
)
1843 void lttng_event_enabler_destroy(struct lttng_event_enabler
*event_enabler
)
1845 if (!event_enabler
) {
1848 cds_list_del(&event_enabler
->node
);
1850 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler
));
1852 lttng_destroy_context(event_enabler
->ctx
);
1853 free(event_enabler
);
1857 * lttng_session_sync_event_enablers should be called just before starting a
1861 void lttng_session_sync_event_enablers(struct lttng_session
*session
)
1863 struct lttng_event_enabler
*event_enabler
;
1864 struct lttng_event
*event
;
1866 cds_list_for_each_entry(event_enabler
, &session
->enablers_head
, node
)
1867 lttng_event_enabler_ref_events(event_enabler
);
1869 * For each event, if at least one of its enablers is enabled,
1870 * and its channel and session transient states are enabled, we
1871 * enable the event, else we disable it.
1873 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
1874 struct lttng_enabler_ref
*enabler_ref
;
1875 struct lttng_bytecode_runtime
*runtime
;
1876 int enabled
= 0, has_enablers_without_bytecode
= 0;
1879 cds_list_for_each_entry(enabler_ref
,
1880 &event
->enablers_ref_head
, node
) {
1881 if (enabler_ref
->ref
->enabled
) {
1887 * Enabled state is based on union of enablers, with
1888 * intesection of session and channel transient enable
1891 enabled
= enabled
&& session
->tstate
&& event
->container
->tstate
;
1893 CMM_STORE_SHARED(event
->enabled
, enabled
);
1895 * Sync tracepoint registration with event enabled
1899 if (!event
->registered
)
1900 register_event(event
);
1902 if (event
->registered
)
1903 unregister_event(event
);
1906 /* Check if has enablers without bytecode enabled */
1907 cds_list_for_each_entry(enabler_ref
,
1908 &event
->enablers_ref_head
, node
) {
1909 if (enabler_ref
->ref
->enabled
1910 && cds_list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
1911 has_enablers_without_bytecode
= 1;
1915 event
->has_enablers_without_bytecode
=
1916 has_enablers_without_bytecode
;
1918 /* Enable filters */
1919 cds_list_for_each_entry(runtime
,
1920 &event
->filter_bytecode_runtime_head
, node
) {
1921 lttng_bytecode_filter_sync_state(runtime
);
1924 __tracepoint_probe_prune_release_queue();
1927 /* Support for event notifier is introduced by probe provider major version 2. */
1929 bool lttng_ust_probe_supports_event_notifier(struct lttng_probe_desc
*probe_desc
)
1931 return probe_desc
->major
>= 2;
1935 void lttng_create_event_notifier_if_missing(
1936 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
1938 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
1939 struct lttng_probe_desc
*probe_desc
;
1940 struct cds_list_head
*probe_list
;
1943 probe_list
= lttng_get_probe_list_head();
1945 cds_list_for_each_entry(probe_desc
, probe_list
, head
) {
1946 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
1949 const struct lttng_event_desc
*desc
;
1950 struct lttng_event_notifier
*event_notifier
;
1951 struct cds_hlist_head
*head
;
1952 struct cds_hlist_node
*node
;
1954 desc
= probe_desc
->event_desc
[i
];
1956 if (lttng_desc_match_enabler(desc
,
1957 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)) <= 0)
1961 * Given the current event_notifier group, get the bucket that
1962 * the target event_notifier would be if it was already
1965 head
= borrow_hash_table_bucket(
1966 event_notifier_group
->event_notifiers_ht
.table
,
1967 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
, desc
->name
);
1969 cds_hlist_for_each_entry(event_notifier
, node
, head
, hlist
) {
1971 * Check if event_notifier already exists by checking
1972 * if the event_notifier and enabler share the same
1973 * description and id.
1975 if (event_notifier
->desc
== desc
&&
1976 event_notifier
->user_token
== event_notifier_enabler
->base
.user_token
) {
1985 /* Check that the probe supports event notifiers, else report the error. */
1986 if (!lttng_ust_probe_supports_event_notifier(probe_desc
)) {
1987 ERR("Probe \"%s\" contains event \"%s\" which matches an enabled event notifier, "
1988 "but its version (%u.%u) is too old and does not implement event notifiers. "
1989 "It needs to be recompiled against a newer version of LTTng-UST, otherwise "
1990 "this event will not generate any notification.",
1991 probe_desc
->provider
,
1998 * We need to create a event_notifier for this event probe.
2000 ret
= lttng_event_notifier_create(desc
,
2001 event_notifier_enabler
->base
.user_token
,
2002 event_notifier_enabler
->error_counter_index
,
2003 event_notifier_group
);
2005 DBG("Unable to create event_notifier %s, error %d\n",
2006 probe_desc
->event_desc
[i
]->name
, ret
);
2013 * Create event_notifiers associated with a event_notifier enabler (if not already present).
2016 int lttng_event_notifier_enabler_ref_event_notifiers(
2017 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
2019 struct lttng_event_notifier_group
*event_notifier_group
= event_notifier_enabler
->group
;
2020 struct lttng_event_notifier
*event_notifier
;
2023 * Only try to create event_notifiers for enablers that are enabled, the user
2024 * might still be attaching filter or exclusion to the
2025 * event_notifier_enabler.
2027 if (!lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->enabled
)
2030 /* First, ensure that probe event_notifiers are created for this enabler. */
2031 lttng_create_event_notifier_if_missing(event_notifier_enabler
);
2033 /* Link the created event_notifier with its associated enabler. */
2034 cds_list_for_each_entry(event_notifier
, &event_notifier_group
->event_notifiers_head
, node
) {
2035 struct lttng_enabler_ref
*enabler_ref
;
2037 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler
, event_notifier
))
2040 enabler_ref
= lttng_enabler_ref(&event_notifier
->enablers_ref_head
,
2041 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler
));
2044 * If no backward ref, create it.
2045 * Add backward ref from event_notifier to enabler.
2047 enabler_ref
= zmalloc(sizeof(*enabler_ref
));
2051 enabler_ref
->ref
= lttng_event_notifier_enabler_as_enabler(
2052 event_notifier_enabler
);
2053 cds_list_add(&enabler_ref
->node
,
2054 &event_notifier
->enablers_ref_head
);
2058 * Link filter bytecodes if not linked yet.
2060 lttng_enabler_link_bytecode(event_notifier
->desc
,
2061 &event_notifier_group
->ctx
,
2062 &event_notifier
->filter_bytecode_runtime_head
,
2063 <tng_event_notifier_enabler_as_enabler(event_notifier_enabler
)->filter_bytecode_head
);
2066 * Link capture bytecodes if not linked yet.
2068 lttng_enabler_link_bytecode(event_notifier
->desc
,
2069 &event_notifier_group
->ctx
, &event_notifier
->capture_bytecode_runtime_head
,
2070 &event_notifier_enabler
->capture_bytecode_head
);
2072 event_notifier
->num_captures
= event_notifier_enabler
->num_captures
;
2079 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group
*event_notifier_group
)
2081 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
2082 struct lttng_event_notifier
*event_notifier
;
2084 cds_list_for_each_entry(event_notifier_enabler
, &event_notifier_group
->enablers_head
, node
)
2085 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler
);
2088 * For each event_notifier, if at least one of its enablers is enabled,
2089 * we enable the event_notifier, else we disable it.
2091 cds_list_for_each_entry(event_notifier
, &event_notifier_group
->event_notifiers_head
, node
) {
2092 struct lttng_enabler_ref
*enabler_ref
;
2093 struct lttng_bytecode_runtime
*runtime
;
2094 int enabled
= 0, has_enablers_without_bytecode
= 0;
2096 /* Enable event_notifiers */
2097 cds_list_for_each_entry(enabler_ref
,
2098 &event_notifier
->enablers_ref_head
, node
) {
2099 if (enabler_ref
->ref
->enabled
) {
2105 CMM_STORE_SHARED(event_notifier
->enabled
, enabled
);
2107 * Sync tracepoint registration with event_notifier enabled
2111 if (!event_notifier
->registered
)
2112 register_event_notifier(event_notifier
);
2114 if (event_notifier
->registered
)
2115 unregister_event_notifier(event_notifier
);
2118 /* Check if has enablers without bytecode enabled */
2119 cds_list_for_each_entry(enabler_ref
,
2120 &event_notifier
->enablers_ref_head
, node
) {
2121 if (enabler_ref
->ref
->enabled
2122 && cds_list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
2123 has_enablers_without_bytecode
= 1;
2127 event_notifier
->has_enablers_without_bytecode
=
2128 has_enablers_without_bytecode
;
2130 /* Enable filters */
2131 cds_list_for_each_entry(runtime
,
2132 &event_notifier
->filter_bytecode_runtime_head
, node
) {
2133 lttng_bytecode_filter_sync_state(runtime
);
2136 /* Enable captures. */
2137 cds_list_for_each_entry(runtime
,
2138 &event_notifier
->capture_bytecode_runtime_head
, node
) {
2139 lttng_bytecode_capture_sync_state(runtime
);
2142 __tracepoint_probe_prune_release_queue();
2146 * Apply enablers to session events, adding events to session if need
2147 * be. It is required after each modification applied to an active
2148 * session, and right before session "start".
2149 * "lazy" sync means we only sync if required.
2152 void lttng_session_lazy_sync_event_enablers(struct lttng_session
*session
)
2154 /* We can skip if session is not active */
2155 if (!session
->active
)
2157 lttng_session_sync_event_enablers(session
);
2161 * Update all sessions with the given app context.
2162 * Called with ust lock held.
2163 * This is invoked when an application context gets loaded/unloaded. It
2164 * ensures the context callbacks are in sync with the application
2165 * context (either app context callbacks, or dummy callbacks).
2167 void lttng_ust_context_set_session_provider(const char *name
,
2168 size_t (*get_size
)(struct lttng_ctx_field
*field
, size_t offset
),
2169 void (*record
)(struct lttng_ctx_field
*field
,
2170 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
2171 struct lttng_channel
*chan
),
2172 void (*get_value
)(struct lttng_ctx_field
*field
,
2173 struct lttng_ctx_value
*value
))
2175 struct lttng_session
*session
;
2177 cds_list_for_each_entry(session
, &sessions
, node
) {
2178 struct lttng_channel
*chan
;
2179 struct lttng_event
*event
;
2182 ret
= lttng_ust_context_set_provider_rcu(&session
->ctx
,
2183 name
, get_size
, record
, get_value
);
2186 cds_list_for_each_entry(chan
, &session
->chan_head
, node
) {
2187 ret
= lttng_ust_context_set_provider_rcu(&chan
->ctx
,
2188 name
, get_size
, record
, get_value
);
2192 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
2193 ret
= lttng_ust_context_set_provider_rcu(&event
->ctx
,
2194 name
, get_size
, record
, get_value
);
2202 * Update all event_notifier groups with the given app context.
2203 * Called with ust lock held.
2204 * This is invoked when an application context gets loaded/unloaded. It
2205 * ensures the context callbacks are in sync with the application
2206 * context (either app context callbacks, or dummy callbacks).
2208 void lttng_ust_context_set_event_notifier_group_provider(const char *name
,
2209 size_t (*get_size
)(struct lttng_ctx_field
*field
, size_t offset
),
2210 void (*record
)(struct lttng_ctx_field
*field
,
2211 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
2212 struct lttng_channel
*chan
),
2213 void (*get_value
)(struct lttng_ctx_field
*field
,
2214 struct lttng_ctx_value
*value
))
2216 struct lttng_event_notifier_group
*event_notifier_group
;
2218 cds_list_for_each_entry(event_notifier_group
, &event_notifier_groups
, node
) {
2221 ret
= lttng_ust_context_set_provider_rcu(
2222 &event_notifier_group
->ctx
,
2223 name
, get_size
, record
, get_value
);