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
,
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
)
295 int ret
= LTTNG_OK
, to_create
= 0;
296 struct ltt_ust_event
*uevent
;
304 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
305 event
->loglevel
, exclusion
);
306 if (uevent
== NULL
) {
307 uevent
= trace_ust_create_event(event
, filter_expression
,
309 /* We have passed ownership */
310 filter_expression
= NULL
;
313 if (uevent
== NULL
) {
314 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
318 /* Valid to set it after the goto error since uevent is still NULL */
322 if (uevent
->enabled
) {
323 /* It's already enabled so everything is OK */
324 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
331 /* Create event on all UST registered apps for session */
332 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
334 /* Enable event on all UST registered apps for session */
335 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
339 if (ret
== -LTTNG_UST_ERR_EXIST
) {
340 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
343 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
349 /* Add ltt ust event to channel */
350 add_unique_ust_event(uchan
->events
, uevent
);
353 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
354 to_create
? "created" : "enabled", uchan
->name
);
360 free(filter_expression
);
367 * Only destroy event on creation time (not enabling time) because if the
368 * event is found in the channel (to_create == 0), it means that at some
369 * point the enable_event worked and it's thus valid to keep it alive.
370 * Destroying it also implies that we also destroy it's shadow copy to sync
374 /* In this code path, the uevent was not added to the hash table */
375 trace_ust_destroy_event(uevent
);
378 free(filter_expression
);
385 * Disable UST tracepoint of a channel from a UST session.
387 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
388 struct ltt_ust_channel
*uchan
, char *event_name
)
391 struct ltt_ust_event
*uevent
;
392 struct lttng_ht_node_str
*node
;
393 struct lttng_ht_iter iter
;
405 * We use a custom lookup since we need the iterator for the next_duplicate
406 * call in the do while loop below.
408 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
409 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
410 node
= lttng_ht_iter_get_node_str(&iter
);
412 DBG2("Trace UST event NOT found by name %s", event_name
);
413 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
418 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
421 if (uevent
->enabled
== 0) {
422 /* It's already disabled so everything is OK */
426 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
427 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
428 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
433 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
437 /* Get next duplicate event by name. */
438 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
439 event_name
, &iter
.iter
);
440 node
= lttng_ht_iter_get_node_str(&iter
);
451 * Disable all UST tracepoints for a channel from a UST session.
453 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
454 struct ltt_ust_channel
*uchan
)
457 struct lttng_ht_iter iter
;
458 struct ltt_ust_event
*uevent
= NULL
;
459 struct lttng_event
*events
= NULL
;
466 /* Disabling existing events */
467 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
469 if (uevent
->enabled
== 1) {
470 ret
= event_ust_disable_tracepoint(usess
, uchan
,
478 /* Get all UST available events */
479 size
= ust_app_list_events(&events
);
481 ret
= LTTNG_ERR_UST_LIST_FAIL
;
485 for (i
= 0; i
< size
; i
++) {
486 ret
= event_ust_disable_tracepoint(usess
, uchan
,
488 if (ret
!= LTTNG_OK
) {
489 /* Continue to disable the rest... */
505 * Enable all agent event for a given UST session.
507 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
509 int event_agent_enable_all(struct ltt_ust_session
*usess
,
510 struct agent
*agt
, struct lttng_event
*event
,
511 struct lttng_filter_bytecode
*filter
)
514 struct agent_event
*aevent
;
515 struct lttng_ht_iter iter
;
519 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
521 /* Enable event on agent application through TCP socket. */
522 ret
= event_agent_enable(usess
, agt
, event
, filter
);
523 if (ret
!= LTTNG_OK
) {
527 /* Flag every event that they are now enabled. */
529 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
542 * Enable a single agent event for a given UST session.
544 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
546 int event_agent_enable(struct ltt_ust_session
*usess
,
547 struct agent
*agt
, struct lttng_event
*event
,
548 struct lttng_filter_bytecode
*filter
)
550 int ret
, created
= 0;
551 struct agent_event
*aevent
;
557 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
558 "and loglevel %d", event
->name
, usess
->id
, event
->loglevel_type
,
561 aevent
= agent_find_event(event
->name
, event
->loglevel
, agt
);
563 aevent
= agent_create_event(event
->name
, filter
);
565 ret
= LTTNG_ERR_NOMEM
;
568 aevent
->loglevel
= event
->loglevel
;
569 aevent
->loglevel_type
= event
->loglevel_type
;
573 /* Already enabled? */
574 if (aevent
->enabled
) {
578 ret
= agent_enable_event(aevent
, agt
->domain
);
579 if (ret
!= LTTNG_OK
) {
583 /* If the event was created prior to the enable, add it to the domain. */
585 agent_add_event(aevent
, agt
);
593 agent_destroy_event(aevent
);
599 * Return the agent default event name to use by testing if the process is root
600 * or not. Return NULL on error.
602 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
604 const char *default_event_name
= NULL
;
607 case LTTNG_DOMAIN_LOG4J
:
609 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
611 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
614 case LTTNG_DOMAIN_JUL
:
616 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
618 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
621 case LTTNG_DOMAIN_PYTHON
:
622 default_event_name
= DEFAULT_USER_PYTHON_EVENT_NAME
;
628 return default_event_name
;
632 * Disable a single agent event for a given UST session.
634 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
636 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
640 struct agent_event
*aevent
;
641 struct ltt_ust_event
*uevent
= NULL
;
642 struct ltt_ust_channel
*uchan
= NULL
;
643 const char *ust_event_name
, *ust_channel_name
;
649 DBG("Event agent disabling %s for session %" PRIu64
, event_name
, usess
->id
);
651 aevent
= agent_find_event_by_name(event_name
, agt
);
653 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
657 /* Already disabled? */
658 if (!aevent
->enabled
) {
662 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
663 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
664 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
665 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
666 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
667 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
669 ret
= LTTNG_ERR_INVALID
;
674 * Disable it on the UST side. First get the channel reference then find
675 * the event and finally disable it.
677 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
678 (char *) ust_channel_name
);
680 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
684 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
685 if (!ust_event_name
) {
686 ret
= LTTNG_ERR_FATAL
;
691 * The loglevel is hardcoded with 0 here since the agent ust event is set
692 * with the loglevel type to ALL thus the loglevel stays 0. The event's
693 * filter is the one handling the loglevel for agent.
695 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
696 aevent
->filter
, 0, NULL
);
697 /* If the agent event exists, it must be available on the UST side. */
700 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
701 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
702 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
707 * Flag event that it's disabled so the shadow copy on the ust app side
708 * will disable it if an application shows up.
712 ret
= agent_disable_event(aevent
, agt
->domain
);
713 if (ret
!= LTTNG_OK
) {
724 * Disable all agent event for a given UST session.
726 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
728 int event_agent_disable_all(struct ltt_ust_session
*usess
,
732 struct agent_event
*aevent
;
733 struct lttng_ht_iter iter
;
739 * Disable event on agent application. Continue to disable all other events
740 * if the * event is not found.
742 ret
= event_agent_disable(usess
, agt
, "*");
743 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
747 /* Flag every event that they are now enabled. */
749 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
751 if (!aevent
->enabled
) {
755 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
756 if (ret
!= LTTNG_OK
) {