2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <urcu/list.h>
24 #include <lttng/lttng.h>
25 #include <common/error.h>
26 #include <common/sessiond-comm/sessiond-comm.h>
31 #include "lttng-sessiond.h"
34 #include "trace-kernel.h"
35 #include "trace-ust.h"
38 * Add unique UST event based on the event name, filter bytecode and loglevel.
40 static void add_unique_ust_event(struct lttng_ht
*ht
,
41 struct ltt_ust_event
*event
)
43 struct cds_lfht_node
*node_ptr
;
44 struct ltt_ust_ht_key key
;
50 key
.name
= event
->attr
.name
;
51 key
.filter
= (struct lttng_filter_bytecode
*) event
->filter
;
52 key
.loglevel
= 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 event for a channel from the kernel session.
64 int event_kernel_disable_tracepoint(struct ltt_kernel_channel
*kchan
,
68 struct ltt_kernel_event
*kevent
;
72 kevent
= trace_kernel_get_event_by_name(event_name
, kchan
);
74 ret
= LTTNG_ERR_NO_EVENT
;
78 ret
= kernel_disable_event(kevent
);
80 ret
= LTTNG_ERR_KERN_DISABLE_FAIL
;
84 DBG("Kernel event %s disable for channel %s.",
85 kevent
->event
->name
, kchan
->channel
->name
);
94 * Enable kernel system call for a channel from the kernel session.
96 int event_kernel_enable_syscall(struct ltt_kernel_channel
*kchan
,
103 ret
= kernel_enable_syscall(syscall_name
, kchan
);
105 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
109 DBG("Kernel event %s enable for channel %s.",
110 syscall_name
, kchan
->channel
->name
);
119 * Disable kernel system call for a channel from the kernel session.
121 int event_kernel_disable_syscall(struct ltt_kernel_channel
*kchan
,
128 ret
= kernel_disable_syscall(syscall_name
, kchan
);
130 ret
= LTTNG_ERR_KERN_DISABLE_FAIL
;
134 DBG("Kernel syscall %s disable for channel %s.",
135 syscall_name
[0] == '\0' ? "<all>" : syscall_name
,
136 kchan
->channel
->name
);
145 * Disable kernel tracepoint events for a channel from the kernel session.
147 int event_kernel_disable_all_tracepoints(struct ltt_kernel_channel
*kchan
)
150 struct ltt_kernel_event
*kevent
;
154 /* For each event in the kernel session */
155 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
156 ret
= kernel_disable_event(kevent
);
158 /* We continue disabling the rest */
167 * Disable all kernel event for a channel from the kernel session.
169 int event_kernel_disable_all(struct ltt_kernel_channel
*kchan
)
175 ret
= event_kernel_disable_all_tracepoints(kchan
);
178 ret
= event_kernel_disable_syscall(kchan
, "");
183 * Enable kernel tracepoint event for a channel from the kernel session.
185 int event_kernel_enable_tracepoint(struct ltt_kernel_channel
*kchan
,
186 struct lttng_event
*event
)
189 struct ltt_kernel_event
*kevent
;
194 kevent
= trace_kernel_get_event_by_name(event
->name
, kchan
);
195 if (kevent
== NULL
) {
196 ret
= kernel_create_event(event
, kchan
);
200 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
203 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
206 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
211 } else if (kevent
->enabled
== 0) {
212 ret
= kernel_enable_event(kevent
);
214 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
218 /* At this point, the event is considered enabled */
219 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
229 * Enable all kernel tracepoint events of a channel of the kernel session.
231 int event_kernel_enable_all_tracepoints(struct ltt_kernel_channel
*kchan
,
232 int kernel_tracer_fd
)
235 struct ltt_kernel_event
*kevent
;
236 struct lttng_event
*event_list
= NULL
;
240 /* For each event in the kernel session */
241 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
242 if (kevent
->enabled
== 0) {
243 ret
= kernel_enable_event(kevent
);
245 /* Enable failed but still continue */
251 size
= kernel_list_events(kernel_tracer_fd
, &event_list
);
253 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
257 for (i
= 0; i
< size
; i
++) {
258 kevent
= trace_kernel_get_event_by_name(event_list
[i
].name
, kchan
);
259 if (kevent
== NULL
) {
260 /* Default event type for enable all */
261 event_list
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
262 /* Enable each single tracepoint event */
263 ret
= kernel_create_event(&event_list
[i
], kchan
);
265 /* Ignore error here and continue */
277 * Enable all kernel events of a channel of the kernel session.
279 int event_kernel_enable_all(struct ltt_kernel_channel
*kchan
,
280 int kernel_tracer_fd
)
286 tp_ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
287 if (tp_ret
!= LTTNG_OK
) {
292 * Reaching this code path means that all tracepoints were enabled without
293 * errors so we ignore the error value of syscalls.
295 * At the moment, failing to enable syscalls on "lttng enable-event -a -k"
296 * is not considered an error that need to be returned to the client since
297 * tracepoints did not fail. Future work will allow us to send back
298 * multiple errors to the client in one API call.
300 (void) event_kernel_enable_syscall(kchan
, "");
307 * ============================
308 * UST : The Ultimate Frontier!
309 * ============================
313 * Enable all UST tracepoints for a channel from a UST session.
315 int event_ust_enable_all_tracepoints(struct ltt_ust_session
*usess
,
316 struct ltt_ust_channel
*uchan
,
317 char *filter_expression
,
318 struct lttng_filter_bytecode
*filter
)
321 struct lttng_ht_iter iter
;
322 struct ltt_ust_event
*uevent
= NULL
;
323 struct lttng_event
*events
= NULL
;
330 /* Enable existing events */
331 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
333 if (uevent
->enabled
== 0) {
334 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
342 /* Get all UST available events */
343 size
= ust_app_list_events(&events
);
345 ret
= LTTNG_ERR_UST_LIST_FAIL
;
349 for (i
= 0; i
< size
; i
++) {
351 * Check if event exist and if so, continue since it was enable
354 uevent
= trace_ust_find_event(uchan
->events
, events
[i
].name
, filter
,
355 events
[i
].loglevel
, NULL
);
356 if (uevent
!= NULL
) {
357 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
360 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
361 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
368 /* Create ust event */
369 uevent
= trace_ust_create_event(&events
[i
], filter_expression
,
371 if (uevent
== NULL
) {
372 ret
= LTTNG_ERR_FATAL
;
376 /* Create event for the specific PID */
377 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
380 if (ret
== -LTTNG_UST_ERR_EXIST
) {
381 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
384 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
390 /* Add ltt ust event to channel */
392 add_unique_ust_event(uchan
->events
, uevent
);
401 trace_ust_destroy_event(uevent
);
410 * Enable UST tracepoint event for a channel from a UST session.
412 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
413 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
414 char *filter_expression
,
415 struct lttng_filter_bytecode
*filter
,
416 struct lttng_event_exclusion
*exclusion
)
418 int ret
= LTTNG_OK
, to_create
= 0;
419 struct ltt_ust_event
*uevent
;
427 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
428 event
->loglevel
, exclusion
);
429 if (uevent
== NULL
) {
430 uevent
= trace_ust_create_event(event
, filter_expression
,
432 if (uevent
== NULL
) {
433 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
437 /* Valid to set it after the goto error since uevent is still NULL */
441 if (uevent
->enabled
) {
442 /* It's already enabled so everything is OK */
443 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
450 /* Create event on all UST registered apps for session */
451 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
453 /* Enable event on all UST registered apps for session */
454 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
458 if (ret
== -LTTNG_UST_ERR_EXIST
) {
459 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
462 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
468 /* Add ltt ust event to channel */
469 add_unique_ust_event(uchan
->events
, uevent
);
472 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
473 to_create
? "created" : "enabled", uchan
->name
);
483 * Only destroy event on creation time (not enabling time) because if the
484 * event is found in the channel (to_create == 0), it means that at some
485 * point the enable_event worked and it's thus valid to keep it alive.
486 * Destroying it also implies that we also destroy it's shadow copy to sync
490 /* In this code path, the uevent was not added to the hash table */
491 trace_ust_destroy_event(uevent
);
498 * Disable UST tracepoint of a channel from a UST session.
500 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
501 struct ltt_ust_channel
*uchan
, char *event_name
)
504 struct ltt_ust_event
*uevent
;
505 struct lttng_ht_node_str
*node
;
506 struct lttng_ht_iter iter
;
518 * We use a custom lookup since we need the iterator for the next_duplicate
519 * call in the do while loop below.
521 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
522 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
523 node
= lttng_ht_iter_get_node_str(&iter
);
525 DBG2("Trace UST event NOT found by name %s", event_name
);
526 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
531 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
534 if (uevent
->enabled
== 0) {
535 /* It's already disabled so everything is OK */
539 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
540 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
541 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
546 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
550 /* Get next duplicate event by name. */
551 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
552 event_name
, &iter
.iter
);
553 node
= lttng_ht_iter_get_node_str(&iter
);
564 * Disable all UST tracepoints for a channel from a UST session.
566 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
567 struct ltt_ust_channel
*uchan
)
570 struct lttng_ht_iter iter
;
571 struct ltt_ust_event
*uevent
= NULL
;
572 struct lttng_event
*events
= NULL
;
579 /* Disabling existing events */
580 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
582 if (uevent
->enabled
== 1) {
583 ret
= event_ust_disable_tracepoint(usess
, uchan
,
591 /* Get all UST available events */
592 size
= ust_app_list_events(&events
);
594 ret
= LTTNG_ERR_UST_LIST_FAIL
;
598 for (i
= 0; i
< size
; i
++) {
599 ret
= event_ust_disable_tracepoint(usess
, uchan
,
601 if (ret
!= LTTNG_OK
) {
602 /* Continue to disable the rest... */
618 * Enable all agent event for a given UST session.
620 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
622 int event_agent_enable_all(struct ltt_ust_session
*usess
,
623 struct agent
*agt
, struct lttng_event
*event
,
624 struct lttng_filter_bytecode
*filter
)
627 struct agent_event
*aevent
;
628 struct lttng_ht_iter iter
;
632 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
634 /* Enable event on agent application through TCP socket. */
635 ret
= event_agent_enable(usess
, agt
, event
, filter
);
636 if (ret
!= LTTNG_OK
) {
640 /* Flag every event that they are now enabled. */
642 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
655 * Enable a single agent event for a given UST session.
657 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
659 int event_agent_enable(struct ltt_ust_session
*usess
,
660 struct agent
*agt
, struct lttng_event
*event
,
661 struct lttng_filter_bytecode
*filter
)
663 int ret
, created
= 0;
664 struct agent_event
*aevent
;
670 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
671 "and loglevel %d", event
->name
, usess
->id
, event
->loglevel_type
,
674 aevent
= agent_find_event(event
->name
, event
->loglevel
, agt
);
676 aevent
= agent_create_event(event
->name
, filter
);
678 ret
= LTTNG_ERR_NOMEM
;
681 aevent
->loglevel
= event
->loglevel
;
682 aevent
->loglevel_type
= event
->loglevel_type
;
686 /* Already enabled? */
687 if (aevent
->enabled
) {
691 ret
= agent_enable_event(aevent
, agt
->domain
);
692 if (ret
!= LTTNG_OK
) {
696 /* If the event was created prior to the enable, add it to the domain. */
698 agent_add_event(aevent
, agt
);
706 agent_destroy_event(aevent
);
712 * Return the agent default event name to use by testing if the process is root
713 * or not. Return NULL on error.
715 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
717 const char *default_event_name
= NULL
;
720 case LTTNG_DOMAIN_LOG4J
:
722 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
724 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
727 case LTTNG_DOMAIN_JUL
:
729 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
731 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
734 case LTTNG_DOMAIN_PYTHON
:
735 default_event_name
= DEFAULT_USER_PYTHON_EVENT_NAME
;
741 return default_event_name
;
745 * Disable a single agent event for a given UST session.
747 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
749 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
753 struct agent_event
*aevent
;
754 struct ltt_ust_event
*uevent
= NULL
;
755 struct ltt_ust_channel
*uchan
= NULL
;
756 const char *ust_event_name
, *ust_channel_name
;
762 DBG("Event agent disabling %s for session %" PRIu64
, event_name
, usess
->id
);
764 aevent
= agent_find_event_by_name(event_name
, agt
);
766 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
770 /* Already disabled? */
771 if (!aevent
->enabled
) {
775 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
776 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
777 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
778 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
779 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
780 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
782 ret
= LTTNG_ERR_INVALID
;
787 * Disable it on the UST side. First get the channel reference then find
788 * the event and finally disable it.
790 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
791 (char *) ust_channel_name
);
793 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
797 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
798 if (!ust_event_name
) {
799 ret
= LTTNG_ERR_FATAL
;
804 * The loglevel is hardcoded with 0 here since the agent ust event is set
805 * with the loglevel type to ALL thus the loglevel stays 0. The event's
806 * filter is the one handling the loglevel for agent.
808 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
809 aevent
->filter
, 0, NULL
);
810 /* If the agent event exists, it must be available on the UST side. */
813 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
814 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
815 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
820 * Flag event that it's disabled so the shadow copy on the ust app side
821 * will disable it if an application shows up.
825 ret
= agent_disable_event(aevent
, agt
->domain
);
826 if (ret
!= LTTNG_OK
) {
837 * Disable all agent event for a given UST session.
839 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
841 int event_agent_disable_all(struct ltt_ust_session
*usess
,
845 struct agent_event
*aevent
;
846 struct lttng_ht_iter iter
;
852 * Disable event on agent application. Continue to disable all other events
853 * if the * event is not found.
855 ret
= event_agent_disable(usess
, agt
, "*");
856 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
860 /* Flag every event that they are now enabled. */
862 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
864 if (!aevent
->enabled
) {
868 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
869 if (ret
!= LTTNG_OK
) {