2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
10 #include <urcu/list.h>
13 #include <common/compat/errno.h>
14 #include <lttng/lttng.h>
15 #include <lttng/condition/condition.h>
16 #include <lttng/condition/event-rule.h>
17 #include <lttng/event-rule/event-rule.h>
18 #include <lttng/event-rule/event-rule-internal.h>
19 #include <common/error.h>
20 #include <common/sessiond-comm/sessiond-comm.h>
21 #include <common/filter.h>
22 #include <common/context.h>
27 #include "lttng-sessiond.h"
28 #include "lttng-ust-ctl.h"
29 #include "lttng-ust-error.h"
31 #include "trace-kernel.h"
32 #include "trace-ust.h"
37 * Add unique UST event based on the event name, filter bytecode and loglevel.
39 static void add_unique_ust_event(struct lttng_ht
*ht
,
40 struct ltt_ust_event
*event
)
42 struct cds_lfht_node
*node_ptr
;
43 struct ltt_ust_ht_key key
;
49 key
.name
= event
->attr
.name
;
50 key
.filter
= (struct lttng_filter_bytecode
*) event
->filter
;
51 key
.loglevel_type
= event
->attr
.loglevel_type
;
52 key
.loglevel_value
= event
->attr
.loglevel
;
53 key
.exclusion
= event
->exclusion
;
55 node_ptr
= cds_lfht_add_unique(ht
->ht
,
56 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
57 trace_ust_ht_match_event
, &key
, &event
->node
.node
);
58 assert(node_ptr
== &event
->node
.node
);
62 * Disable kernel tracepoint events for a channel from the kernel session of
63 * a specified event_name and event type.
64 * On type LTTNG_EVENT_ALL all events with event_name are disabled.
65 * If event_name is NULL all events of the specified type are disabled.
67 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
68 const char *event_name
, enum lttng_event_type type
)
70 int ret
, error
= 0, found
= 0;
71 struct ltt_kernel_event
*kevent
;
75 /* For each event in the kernel session */
76 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
77 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
79 if (event_name
!= NULL
&& strcmp(event_name
, kevent
->event
->name
)) {
83 ret
= kernel_disable_event(kevent
);
89 DBG("Disable kernel event: found %d events with name: %s and type: %d",
90 found
, event_name
? event_name
: "NULL", type
);
92 if (event_name
!= NULL
&& !found
) {
93 ret
= LTTNG_ERR_NO_EVENT
;
95 ret
= error
? LTTNG_ERR_KERN_DISABLE_FAIL
: LTTNG_OK
;
102 * Enable kernel tracepoint event for a channel from the kernel session.
103 * We own filter_expression and filter.
105 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
106 struct lttng_event
*event
, char *filter_expression
,
107 struct lttng_filter_bytecode
*filter
)
110 struct ltt_kernel_event
*kevent
;
115 kevent
= trace_kernel_find_event(event
->name
, kchan
,
116 event
->type
, filter
);
117 if (kevent
== NULL
) {
118 ret
= kernel_create_event(event
, kchan
, filter_expression
, filter
);
119 /* We have passed ownership */
120 filter_expression
= NULL
;
125 } else if (kevent
->enabled
== 0) {
126 ret
= kernel_enable_event(kevent
);
128 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
132 /* At this point, the event is considered enabled */
133 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
139 free(filter_expression
);
145 * ============================
146 * UST : The Ultimate Frontier!
147 * ============================
151 * Enable UST tracepoint event for a channel from a UST session.
152 * We own filter_expression, filter, and exclusion.
154 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
155 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
156 char *filter_expression
,
157 struct lttng_filter_bytecode
*filter
,
158 struct lttng_event_exclusion
*exclusion
,
161 int ret
= LTTNG_OK
, to_create
= 0;
162 struct ltt_ust_event
*uevent
;
170 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
171 (enum lttng_ust_loglevel_type
) event
->loglevel_type
,
172 event
->loglevel
, exclusion
);
174 ret
= trace_ust_create_event(event
, filter_expression
,
175 filter
, exclusion
, internal_event
, &uevent
);
176 /* We have passed ownership */
177 filter_expression
= NULL
;
180 if (ret
!= LTTNG_OK
) {
184 /* Valid to set it after the goto error since uevent is still NULL */
188 if (uevent
->enabled
) {
189 /* It's already enabled so everything is OK */
191 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
197 /* Add ltt ust event to channel */
198 add_unique_ust_event(uchan
->events
, uevent
);
201 if (!usess
->active
) {
206 /* Create event on all UST registered apps for session */
207 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
209 /* Enable event on all UST registered apps for session */
210 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
214 if (ret
== -LTTNG_UST_ERR_EXIST
) {
215 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
218 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
223 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
224 to_create
? "created" : "enabled", uchan
->name
);
230 free(filter_expression
);
237 * Only destroy event on creation time (not enabling time) because if the
238 * event is found in the channel (to_create == 0), it means that at some
239 * point the enable_event worked and it's thus valid to keep it alive.
240 * Destroying it also implies that we also destroy it's shadow copy to sync
244 /* In this code path, the uevent was not added to the hash table */
245 trace_ust_destroy_event(uevent
);
248 free(filter_expression
);
255 * Disable UST tracepoint of a channel from a UST session.
257 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
258 struct ltt_ust_channel
*uchan
, const char *event_name
)
261 struct ltt_ust_event
*uevent
;
262 struct lttng_ht_node_str
*node
;
263 struct lttng_ht_iter iter
;
275 * We use a custom lookup since we need the iterator for the next_duplicate
276 * call in the do while loop below.
278 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
279 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
280 node
= lttng_ht_iter_get_node_str(&iter
);
282 DBG2("Trace UST event NOT found by name %s", event_name
);
283 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
288 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
291 if (uevent
->enabled
== 0) {
292 /* It's already disabled so everything is OK */
296 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
299 if (!usess
->active
) {
302 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
303 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
304 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
308 /* Get next duplicate event by name. */
309 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
310 event_name
, &iter
.iter
);
311 node
= lttng_ht_iter_get_node_str(&iter
);
322 * Disable all UST tracepoints for a channel from a UST session.
324 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
325 struct ltt_ust_channel
*uchan
)
327 int ret
, i
, size
, error
= 0;
328 struct lttng_ht_iter iter
;
329 struct ltt_ust_event
*uevent
= NULL
;
330 struct lttng_event
*events
= NULL
;
337 /* Disabling existing events */
338 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
340 if (uevent
->enabled
== 1) {
341 ret
= event_ust_disable_tracepoint(usess
, uchan
,
344 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
350 /* Get all UST available events */
351 size
= ust_app_list_events(&events
);
353 ret
= LTTNG_ERR_UST_LIST_FAIL
;
357 for (i
= 0; i
< size
; i
++) {
358 ret
= event_ust_disable_tracepoint(usess
, uchan
,
361 /* Continue to disable the rest... */
362 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
367 ret
= error
? error
: LTTNG_OK
;
374 static void agent_enable_all(struct agent
*agt
)
376 struct agent_event
*aevent
;
377 struct lttng_ht_iter iter
;
379 /* Flag every event as enabled. */
381 cds_lfht_for_each_entry (
382 agt
->events
->ht
, &iter
.iter
, aevent
, node
.node
) {
383 aevent
->enabled_count
++;
389 * Enable all agent event for a given UST session.
391 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
393 int event_agent_enable_all(struct ltt_ust_session
*usess
,
394 struct agent
*agt
, struct lttng_event
*event
,
395 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
401 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
403 /* Enable event on agent application through TCP socket. */
404 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
405 if (ret
!= LTTNG_OK
) {
409 agent_enable_all(agt
);
418 * Check if this event's filter requires the activation of application contexts
419 * and enable them in the agent.
420 * TODO: bytecode iterator does not support non-legacy application
421 * contexts yet. Not an issue for now, since they are not generated by
422 * the lttng-ctl library.
424 static int add_filter_app_ctx(struct lttng_filter_bytecode
*bytecode
,
425 const char *filter_expression
, struct agent
*agt
)
428 char *provider_name
= NULL
, *ctx_name
= NULL
;
429 struct bytecode_symbol_iterator
*it
=
430 bytecode_symbol_iterator_create(bytecode
);
433 ret
= LTTNG_ERR_NOMEM
;
438 struct lttng_event_context ctx
;
439 const char *symbol_name
=
440 bytecode_symbol_iterator_get_name(it
);
442 if (parse_application_context(symbol_name
, &provider_name
,
444 /* Not an application context. */
448 ctx
.ctx
= LTTNG_EVENT_CONTEXT_APP_CONTEXT
;
449 ctx
.u
.app_ctx
.provider_name
= provider_name
;
450 ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
452 /* Recognized an application context. */
453 DBG("Enabling event with filter expression \"%s\" requires enabling the %s:%s application context.",
454 filter_expression
, provider_name
, ctx_name
);
456 ret
= agent_add_context(&ctx
, agt
);
457 if (ret
!= LTTNG_OK
) {
458 ERR("Failed to add application context %s:%s.",
459 provider_name
, ctx_name
);
463 ret
= agent_enable_context(&ctx
, agt
->domain
);
464 if (ret
!= LTTNG_OK
) {
465 ERR("Failed to enable application context %s:%s.",
466 provider_name
, ctx_name
);
472 provider_name
= ctx_name
= NULL
;
473 } while (bytecode_symbol_iterator_next(it
) == 0);
477 bytecode_symbol_iterator_destroy(it
);
481 static int agent_enable(struct agent
*agt
,
482 struct lttng_event
*event
,
483 struct lttng_filter_bytecode
*filter
,
484 char *filter_expression
)
486 int ret
, created
= 0;
487 struct agent_event
*aevent
;
492 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
493 event
->loglevel
, filter_expression
, agt
);
495 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
496 event
->loglevel
, filter
,
499 ret
= LTTNG_ERR_NOMEM
;
503 filter_expression
= NULL
;
505 assert(!AGENT_EVENT_IS_ENABLED(aevent
));
508 if (created
&& aevent
->filter
) {
509 ret
= add_filter_app_ctx(
510 aevent
->filter
, aevent
->filter_expression
, agt
);
511 if (ret
!= LTTNG_OK
) {
516 /* Already enabled? */
517 if (AGENT_EVENT_IS_ENABLED(aevent
)) {
522 ret
= agent_enable_event(aevent
, agt
->domain
);
523 if (ret
!= LTTNG_OK
) {
527 /* If the event was created prior to the enable, add it to the domain. */
529 agent_add_event(aevent
, agt
);
537 agent_destroy_event(aevent
);
541 free(filter_expression
);
546 * Enable a single agent event for a given UST session.
548 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
550 int event_agent_enable(struct ltt_ust_session
*usess
,
552 struct lttng_event
*event
,
553 struct lttng_filter_bytecode
*filter
,
554 char *filter_expression
)
560 DBG("Enabling agent event: event pattern = '%s', session id = %" PRIu64
", loglevel type = %d, loglevel = %d, filter expression = '%s'",
561 event
->name
, usess
->id
, event
->loglevel_type
,
563 filter_expression
? filter_expression
: "(none)");
565 return agent_enable(agt
, event
, filter
, filter_expression
);
569 * Enable a single agent event for a trigger.
571 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
573 int trigger_agent_enable(const struct lttng_trigger
*trigger
, struct agent
*agt
)
576 enum lttng_condition_status c_status
;
577 enum lttng_trigger_status t_status
;
578 enum lttng_domain_type d_type
;
579 const struct lttng_condition
*condition
;
580 const struct lttng_event_rule
*rule
;
581 const char *filter_expression
;
582 char *filter_expression_copy
= NULL
;
583 const struct lttng_filter_bytecode
*filter_bytecode
;
584 struct lttng_filter_bytecode
*filter_bytecode_copy
= NULL
;
585 struct lttng_event
*event
= NULL
;
586 uid_t trigger_owner_uid
= 0;
587 const char *trigger_name
;
592 t_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
593 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
594 trigger_name
= "(unnamed)";
597 t_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner_uid
);
598 assert(t_status
== LTTNG_TRIGGER_STATUS_OK
);
600 condition
= lttng_trigger_get_const_condition(trigger
);
602 assert(lttng_condition_get_type(condition
) ==
603 LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
605 c_status
= lttng_condition_event_rule_get_rule(condition
, &rule
);
606 assert(c_status
== LTTNG_CONDITION_STATUS_OK
);
608 assert(lttng_event_rule_get_type(rule
) ==
609 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
611 d_type
= lttng_event_rule_get_domain_type(rule
);
612 assert(d_type
== agt
->domain
);
614 event
= lttng_event_rule_generate_lttng_event(rule
);
616 ret
= LTTNG_ERR_NOMEM
;
620 /* Get the internal filter expression and bytecode. */
621 filter_expression
= lttng_event_rule_get_filter(rule
);
622 if (filter_expression
) {
623 filter_expression_copy
= strdup(filter_expression
);
624 if (!filter_expression_copy
) {
625 ret
= LTTNG_ERR_NOMEM
;
629 /* Get the filter bytecode */
630 filter_bytecode
= lttng_event_rule_get_filter_bytecode(rule
);
631 if (filter_bytecode
) {
632 filter_bytecode_copy
=
633 lttng_filter_bytecode_copy(filter_bytecode
);
634 if (!filter_bytecode_copy
) {
635 ret
= LTTNG_ERR_NOMEM
;
641 DBG("Enabling agent event from trigger: trigger name = '%s', trigger owner uid = %d, token = %" PRIu64
,
642 trigger_name
, trigger_owner_uid
,
643 lttng_trigger_get_tracer_token(trigger
));
645 ret
= agent_enable(agt
, event
, filter_bytecode_copy
,
646 filter_expression_copy
);
647 /* Ownership was passed even in case of error. */
648 filter_expression_copy
= NULL
;
649 filter_bytecode_copy
= NULL
;
652 free(filter_expression_copy
);
653 free(filter_bytecode_copy
);
659 * Return the default event name associated with the provided UST domain. Return
662 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
664 const char *default_event_name
= NULL
;
667 case LTTNG_DOMAIN_LOG4J
:
668 default_event_name
= DEFAULT_LOG4J_EVENT_NAME
;
670 case LTTNG_DOMAIN_JUL
:
671 default_event_name
= DEFAULT_JUL_EVENT_NAME
;
673 case LTTNG_DOMAIN_PYTHON
:
674 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
680 return default_event_name
;
683 static int trigger_agent_disable_one(const struct lttng_trigger
*trigger
,
685 struct agent_event
*aevent
)
695 * Actual ust event un-registration happens on the trigger
696 * un-registration at that point.
699 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for trigger %" PRIu64
,
700 aevent
->name
, aevent
->loglevel_type
,
701 aevent
->loglevel_value
, lttng_trigger_get_tracer_token(trigger
));
703 /* Already disabled? */
704 if (!AGENT_EVENT_IS_ENABLED(aevent
)) {
708 ret
= agent_disable_event(aevent
, agt
->domain
);
709 if (ret
!= LTTNG_OK
) {
721 * Disable a given agent event for a given UST session.
723 * Must be called with the RCU read lock held.
724 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
726 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
727 struct agent
*agt
, struct agent_event
*aevent
)
730 struct ltt_ust_event
*uevent
= NULL
;
731 struct ltt_ust_channel
*uchan
= NULL
;
732 const char *ust_event_name
, *ust_channel_name
;
738 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
739 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
742 /* Already disabled? */
743 if (!AGENT_EVENT_IS_ENABLED(aevent
)) {
747 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
748 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
749 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
750 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
751 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
752 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
754 ret
= LTTNG_ERR_INVALID
;
759 * Disable it on the UST side. First get the channel reference then find
760 * the event and finally disable it.
762 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
763 (char *) ust_channel_name
);
765 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
769 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
770 if (!ust_event_name
) {
771 ret
= LTTNG_ERR_FATAL
;
776 * Agent UST event has its loglevel type forced to
777 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
778 * happens thanks to an UST filter. The following -1 is actually
779 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
781 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
782 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
783 /* If the agent event exists, it must be available on the UST side. */
787 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
788 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
789 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
795 * Flag event that it's disabled so the shadow copy on the ust app side
796 * will disable it if an application shows up.
800 ret
= agent_disable_event(aevent
, agt
->domain
);
801 if (ret
!= LTTNG_OK
) {
813 * Disable agent event matching a given trigger.
815 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
817 int trigger_agent_disable(
818 const struct lttng_trigger
*trigger
, struct agent
*agt
)
821 struct agent_event
*aevent
;
826 DBG("Event agent disabling for trigger %" PRIu64
,
827 lttng_trigger_get_tracer_token(trigger
));
830 aevent
= agent_find_event_by_trigger(trigger
, agt
);
832 if (aevent
== NULL
) {
833 DBG2("Event agent NOT found by trigger %" PRIu64
,
834 lttng_trigger_get_tracer_token(trigger
));
835 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
839 ret
= trigger_agent_disable_one(trigger
, agt
, aevent
);
841 if (ret
!= LTTNG_OK
) {
851 * Disable all agent events matching a given name for a given UST session.
853 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
855 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
856 const char *event_name
)
859 struct agent_event
*aevent
;
860 struct lttng_ht_iter iter
;
861 struct lttng_ht_node_str
*node
;
867 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
870 agent_find_events_by_name(event_name
, agt
, &iter
);
871 node
= lttng_ht_iter_get_node_str(&iter
);
874 DBG2("Event agent NOT found by name %s", event_name
);
875 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
880 aevent
= caa_container_of(node
, struct agent_event
, node
);
881 ret
= event_agent_disable_one(usess
, agt
, aevent
);
883 if (ret
!= LTTNG_OK
) {
887 /* Get next duplicate agent event by name. */
888 agent_event_next_duplicate(event_name
, agt
, &iter
);
889 node
= lttng_ht_iter_get_node_str(&iter
);
896 * Disable all agent event for a given UST session.
898 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
900 int event_agent_disable_all(struct ltt_ust_session
*usess
,
904 struct agent_event
*aevent
;
905 struct lttng_ht_iter iter
;
911 * Disable event on agent application. Continue to disable all other events
912 * if the * event is not found.
914 ret
= event_agent_disable(usess
, agt
, "*");
915 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
919 /* Disable every event. */
921 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
923 if (!AGENT_EVENT_IS_ENABLED(aevent
)) {
927 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
928 if (ret
!= LTTNG_OK
) {