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_event(struct ltt_kernel_channel
*kchan
,
68 struct ltt_kernel_event
*kevent
;
72 kevent
= trace_kernel_get_event_by_name(event_name
, kchan
,
75 ret
= LTTNG_ERR_NO_EVENT
;
79 ret
= kernel_disable_event(kevent
);
81 ret
= LTTNG_ERR_KERN_DISABLE_FAIL
;
85 DBG("Kernel event %s disable for channel %s.",
86 kevent
->event
->name
, kchan
->channel
->name
);
95 * Disable kernel tracepoint events for a channel from the kernel session.
97 int event_kernel_disable_event_type(struct ltt_kernel_channel
*kchan
,
98 enum lttng_event_type type
)
101 struct ltt_kernel_event
*kevent
;
105 /* For each event in the kernel session */
106 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
107 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
109 ret
= kernel_disable_event(kevent
);
111 /* We continue disabling the rest */
120 * Disable all kernel event for a channel from the kernel session.
122 int event_kernel_disable_event_all(struct ltt_kernel_channel
*kchan
)
124 return event_kernel_disable_event_type(kchan
, LTTNG_EVENT_ALL
);
128 * Enable kernel tracepoint event for a channel from the kernel session.
129 * We own filter_expression and filter.
131 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
132 struct lttng_event
*event
, char *filter_expression
,
133 struct lttng_filter_bytecode
*filter
)
136 struct ltt_kernel_event
*kevent
;
141 kevent
= trace_kernel_find_event(event
->name
, kchan
,
142 event
->type
, filter
);
143 if (kevent
== NULL
) {
144 ret
= kernel_create_event(event
, kchan
,
145 filter_expression
, filter
);
146 /* We have passed ownership */
147 filter_expression
= NULL
;
152 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
155 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
158 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
163 } else if (kevent
->enabled
== 0) {
164 ret
= kernel_enable_event(kevent
);
166 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
170 /* At this point, the event is considered enabled */
171 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
177 free(filter_expression
);
183 * ============================
184 * UST : The Ultimate Frontier!
185 * ============================
189 * Enable all UST tracepoints for a channel from a UST session.
191 int event_ust_enable_all_tracepoints(struct ltt_ust_session
*usess
,
192 struct ltt_ust_channel
*uchan
,
193 char *filter_expression
,
194 struct lttng_filter_bytecode
*filter
)
197 struct lttng_ht_iter iter
;
198 struct ltt_ust_event
*uevent
= NULL
;
199 struct lttng_event
*events
= NULL
;
206 /* Enable existing events */
207 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
209 if (uevent
->enabled
== 0) {
210 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
218 /* Get all UST available events */
219 size
= ust_app_list_events(&events
);
221 ret
= LTTNG_ERR_UST_LIST_FAIL
;
225 for (i
= 0; i
< size
; i
++) {
227 * Check if event exist and if so, continue since it was enable
230 uevent
= trace_ust_find_event(uchan
->events
, events
[i
].name
, filter
,
231 events
[i
].loglevel
, NULL
);
232 if (uevent
!= NULL
) {
233 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
236 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
237 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
244 /* Create ust event */
245 uevent
= trace_ust_create_event(&events
[i
], filter_expression
,
246 filter
, NULL
, false);
247 if (uevent
== NULL
) {
248 ret
= LTTNG_ERR_FATAL
;
252 /* Create event for the specific PID */
253 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
256 if (ret
== -LTTNG_UST_ERR_EXIST
) {
257 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
260 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
266 /* Add ltt ust event to channel */
268 add_unique_ust_event(uchan
->events
, uevent
);
277 trace_ust_destroy_event(uevent
);
286 * Enable UST tracepoint event for a channel from a UST session.
287 * We own filter_expression, filter, and exclusion.
289 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
290 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
291 char *filter_expression
,
292 struct lttng_filter_bytecode
*filter
,
293 struct lttng_event_exclusion
*exclusion
,
296 int ret
= LTTNG_OK
, to_create
= 0;
297 struct ltt_ust_event
*uevent
;
305 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
306 event
->loglevel
, exclusion
);
307 if (uevent
== NULL
) {
308 uevent
= trace_ust_create_event(event
, filter_expression
,
309 filter
, exclusion
, internal_event
);
310 /* We have passed ownership */
311 filter_expression
= NULL
;
314 if (uevent
== NULL
) {
315 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
319 /* Valid to set it after the goto error since uevent is still NULL */
323 if (uevent
->enabled
) {
324 /* It's already enabled so everything is OK */
325 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
332 /* Create event on all UST registered apps for session */
333 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
335 /* Enable event on all UST registered apps for session */
336 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
340 if (ret
== -LTTNG_UST_ERR_EXIST
) {
341 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
344 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
350 /* Add ltt ust event to channel */
351 add_unique_ust_event(uchan
->events
, uevent
);
354 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
355 to_create
? "created" : "enabled", uchan
->name
);
361 free(filter_expression
);
368 * Only destroy event on creation time (not enabling time) because if the
369 * event is found in the channel (to_create == 0), it means that at some
370 * point the enable_event worked and it's thus valid to keep it alive.
371 * Destroying it also implies that we also destroy it's shadow copy to sync
375 /* In this code path, the uevent was not added to the hash table */
376 trace_ust_destroy_event(uevent
);
379 free(filter_expression
);
386 * Disable UST tracepoint of a channel from a UST session.
388 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
389 struct ltt_ust_channel
*uchan
, char *event_name
)
392 struct ltt_ust_event
*uevent
;
393 struct lttng_ht_node_str
*node
;
394 struct lttng_ht_iter iter
;
406 * We use a custom lookup since we need the iterator for the next_duplicate
407 * call in the do while loop below.
409 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
410 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
411 node
= lttng_ht_iter_get_node_str(&iter
);
413 DBG2("Trace UST event NOT found by name %s", event_name
);
414 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
419 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
422 if (uevent
->enabled
== 0) {
423 /* It's already disabled so everything is OK */
427 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
428 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
429 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
434 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
438 /* Get next duplicate event by name. */
439 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
440 event_name
, &iter
.iter
);
441 node
= lttng_ht_iter_get_node_str(&iter
);
452 * Disable all UST tracepoints for a channel from a UST session.
454 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
455 struct ltt_ust_channel
*uchan
)
458 struct lttng_ht_iter iter
;
459 struct ltt_ust_event
*uevent
= NULL
;
460 struct lttng_event
*events
= NULL
;
467 /* Disabling existing events */
468 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
470 if (uevent
->enabled
== 1) {
471 ret
= event_ust_disable_tracepoint(usess
, uchan
,
479 /* Get all UST available events */
480 size
= ust_app_list_events(&events
);
482 ret
= LTTNG_ERR_UST_LIST_FAIL
;
486 for (i
= 0; i
< size
; i
++) {
487 ret
= event_ust_disable_tracepoint(usess
, uchan
,
489 if (ret
!= LTTNG_OK
) {
490 /* Continue to disable the rest... */
506 * Enable all agent event for a given UST session.
508 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
510 int event_agent_enable_all(struct ltt_ust_session
*usess
,
511 struct agent
*agt
, struct lttng_event
*event
,
512 struct lttng_filter_bytecode
*filter
,
513 char *filter_expression
)
516 struct agent_event
*aevent
;
517 struct lttng_ht_iter iter
;
521 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
523 /* Enable event on agent application through TCP socket. */
524 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
525 if (ret
!= LTTNG_OK
) {
529 /* Flag every event that they are now enabled. */
531 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
544 * Enable a single agent event for a given UST session.
546 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
548 int event_agent_enable(struct ltt_ust_session
*usess
,
549 struct agent
*agt
, struct lttng_event
*event
,
550 struct lttng_filter_bytecode
*filter
,
551 char *filter_expression
)
553 int ret
, created
= 0;
554 struct agent_event
*aevent
;
560 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
561 "and loglevel %d", event
->name
, usess
->id
, event
->loglevel_type
,
564 aevent
= agent_find_event(event
->name
, event
->loglevel
, agt
);
566 aevent
= agent_create_event(event
->name
, filter
);
568 ret
= LTTNG_ERR_NOMEM
;
571 aevent
->loglevel
= event
->loglevel
;
572 aevent
->loglevel_type
= event
->loglevel_type
;
576 /* Already enabled? */
577 if (aevent
->enabled
) {
581 ret
= agent_enable_event(aevent
, agt
->domain
);
582 if (ret
!= LTTNG_OK
) {
586 /* If the event was created prior to the enable, add it to the domain. */
588 agent_add_event(aevent
, agt
);
596 agent_destroy_event(aevent
);
602 * Return the agent default event name to use by testing if the process is root
603 * or not. Return NULL on error.
605 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
607 const char *default_event_name
= NULL
;
610 case LTTNG_DOMAIN_LOG4J
:
612 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
614 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
617 case LTTNG_DOMAIN_JUL
:
619 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
621 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
624 case LTTNG_DOMAIN_PYTHON
:
625 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
631 return default_event_name
;
635 * Disable a single agent event for a given UST session.
637 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
639 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
643 struct agent_event
*aevent
;
644 struct ltt_ust_event
*uevent
= NULL
;
645 struct ltt_ust_channel
*uchan
= NULL
;
646 const char *ust_event_name
, *ust_channel_name
;
652 DBG("Event agent disabling %s for session %" PRIu64
, event_name
, usess
->id
);
654 aevent
= agent_find_event_by_name(event_name
, agt
);
656 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
660 /* Already disabled? */
661 if (!aevent
->enabled
) {
665 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
666 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
667 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
668 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
669 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
670 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
672 ret
= LTTNG_ERR_INVALID
;
677 * Disable it on the UST side. First get the channel reference then find
678 * the event and finally disable it.
680 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
681 (char *) ust_channel_name
);
683 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
687 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
688 if (!ust_event_name
) {
689 ret
= LTTNG_ERR_FATAL
;
694 * The loglevel is hardcoded with 0 here since the agent ust event is set
695 * with the loglevel type to ALL thus the loglevel stays 0. The event's
696 * filter is the one handling the loglevel for agent.
698 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
699 aevent
->filter
, 0, NULL
);
700 /* If the agent event exists, it must be available on the UST side. */
703 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
704 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
705 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
710 * Flag event that it's disabled so the shadow copy on the ust app side
711 * will disable it if an application shows up.
715 ret
= agent_disable_event(aevent
, agt
->domain
);
716 if (ret
!= LTTNG_OK
) {
727 * Disable all agent event for a given UST session.
729 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
731 int event_agent_disable_all(struct ltt_ust_session
*usess
,
735 struct agent_event
*aevent
;
736 struct lttng_ht_iter iter
;
742 * Disable event on agent application. Continue to disable all other events
743 * if the * event is not found.
745 ret
= event_agent_disable(usess
, agt
, "*");
746 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
750 /* Flag every event that they are now enabled. */
752 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
754 if (!aevent
->enabled
) {
758 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
759 if (ret
!= LTTNG_OK
) {