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
)
135 struct ltt_kernel_event
*kevent
;
140 kevent
= trace_kernel_get_event_by_name(event
->name
, kchan
,
142 if (kevent
== NULL
) {
143 ret
= kernel_create_event(event
, kchan
);
147 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
150 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
153 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
158 } else if (kevent
->enabled
== 0) {
159 ret
= kernel_enable_event(kevent
);
161 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
165 /* At this point, the event is considered enabled */
166 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
176 * ============================
177 * UST : The Ultimate Frontier!
178 * ============================
182 * Enable all UST tracepoints for a channel from a UST session.
184 int event_ust_enable_all_tracepoints(struct ltt_ust_session
*usess
,
185 struct ltt_ust_channel
*uchan
,
186 char *filter_expression
,
187 struct lttng_filter_bytecode
*filter
)
190 struct lttng_ht_iter iter
;
191 struct ltt_ust_event
*uevent
= NULL
;
192 struct lttng_event
*events
= NULL
;
199 /* Enable existing events */
200 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
202 if (uevent
->enabled
== 0) {
203 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
211 /* Get all UST available events */
212 size
= ust_app_list_events(&events
);
214 ret
= LTTNG_ERR_UST_LIST_FAIL
;
218 for (i
= 0; i
< size
; i
++) {
220 * Check if event exist and if so, continue since it was enable
223 uevent
= trace_ust_find_event(uchan
->events
, events
[i
].name
, filter
,
224 events
[i
].loglevel
, NULL
);
225 if (uevent
!= NULL
) {
226 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
229 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
230 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
237 /* Create ust event */
238 uevent
= trace_ust_create_event(&events
[i
], filter_expression
,
240 if (uevent
== NULL
) {
241 ret
= LTTNG_ERR_FATAL
;
245 /* Create event for the specific PID */
246 ret
= ust_app_enable_event_pid(usess
, uchan
, uevent
,
249 if (ret
== -LTTNG_UST_ERR_EXIST
) {
250 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
253 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
259 /* Add ltt ust event to channel */
261 add_unique_ust_event(uchan
->events
, uevent
);
270 trace_ust_destroy_event(uevent
);
279 * Enable UST tracepoint event for a channel from a UST session.
280 * We own filter_expression, filter, and exclusion.
282 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
283 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
284 char *filter_expression
,
285 struct lttng_filter_bytecode
*filter
,
286 struct lttng_event_exclusion
*exclusion
)
288 int ret
= LTTNG_OK
, to_create
= 0;
289 struct ltt_ust_event
*uevent
;
297 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
298 event
->loglevel
, exclusion
);
299 if (uevent
== NULL
) {
300 uevent
= trace_ust_create_event(event
, filter_expression
,
302 /* We have passed ownership */
303 filter_expression
= NULL
;
306 if (uevent
== NULL
) {
307 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
311 /* Valid to set it after the goto error since uevent is still NULL */
315 if (uevent
->enabled
) {
316 /* It's already enabled so everything is OK */
317 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
324 /* Create event on all UST registered apps for session */
325 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
327 /* Enable event on all UST registered apps for session */
328 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
332 if (ret
== -LTTNG_UST_ERR_EXIST
) {
333 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
336 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
342 /* Add ltt ust event to channel */
343 add_unique_ust_event(uchan
->events
, uevent
);
346 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
347 to_create
? "created" : "enabled", uchan
->name
);
353 free(filter_expression
);
360 * Only destroy event on creation time (not enabling time) because if the
361 * event is found in the channel (to_create == 0), it means that at some
362 * point the enable_event worked and it's thus valid to keep it alive.
363 * Destroying it also implies that we also destroy it's shadow copy to sync
367 /* In this code path, the uevent was not added to the hash table */
368 trace_ust_destroy_event(uevent
);
371 free(filter_expression
);
378 * Disable UST tracepoint of a channel from a UST session.
380 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
381 struct ltt_ust_channel
*uchan
, char *event_name
)
384 struct ltt_ust_event
*uevent
;
385 struct lttng_ht_node_str
*node
;
386 struct lttng_ht_iter iter
;
398 * We use a custom lookup since we need the iterator for the next_duplicate
399 * call in the do while loop below.
401 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
402 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
403 node
= lttng_ht_iter_get_node_str(&iter
);
405 DBG2("Trace UST event NOT found by name %s", event_name
);
406 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
411 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
414 if (uevent
->enabled
== 0) {
415 /* It's already disabled so everything is OK */
419 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
420 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
421 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
426 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
430 /* Get next duplicate event by name. */
431 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
432 event_name
, &iter
.iter
);
433 node
= lttng_ht_iter_get_node_str(&iter
);
444 * Disable all UST tracepoints for a channel from a UST session.
446 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
447 struct ltt_ust_channel
*uchan
)
450 struct lttng_ht_iter iter
;
451 struct ltt_ust_event
*uevent
= NULL
;
452 struct lttng_event
*events
= NULL
;
459 /* Disabling existing events */
460 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
462 if (uevent
->enabled
== 1) {
463 ret
= event_ust_disable_tracepoint(usess
, uchan
,
471 /* Get all UST available events */
472 size
= ust_app_list_events(&events
);
474 ret
= LTTNG_ERR_UST_LIST_FAIL
;
478 for (i
= 0; i
< size
; i
++) {
479 ret
= event_ust_disable_tracepoint(usess
, uchan
,
481 if (ret
!= LTTNG_OK
) {
482 /* Continue to disable the rest... */
498 * Enable all agent event for a given UST session.
500 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
502 int event_agent_enable_all(struct ltt_ust_session
*usess
,
503 struct agent
*agt
, struct lttng_event
*event
,
504 struct lttng_filter_bytecode
*filter
)
507 struct agent_event
*aevent
;
508 struct lttng_ht_iter iter
;
512 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
514 /* Enable event on agent application through TCP socket. */
515 ret
= event_agent_enable(usess
, agt
, event
, filter
);
516 if (ret
!= LTTNG_OK
) {
520 /* Flag every event that they are now enabled. */
522 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
535 * Enable a single agent event for a given UST session.
537 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
539 int event_agent_enable(struct ltt_ust_session
*usess
,
540 struct agent
*agt
, struct lttng_event
*event
,
541 struct lttng_filter_bytecode
*filter
)
543 int ret
, created
= 0;
544 struct agent_event
*aevent
;
550 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
551 "and loglevel %d", event
->name
, usess
->id
, event
->loglevel_type
,
554 aevent
= agent_find_event(event
->name
, event
->loglevel
, agt
);
556 aevent
= agent_create_event(event
->name
, filter
);
558 ret
= LTTNG_ERR_NOMEM
;
561 aevent
->loglevel
= event
->loglevel
;
562 aevent
->loglevel_type
= event
->loglevel_type
;
566 /* Already enabled? */
567 if (aevent
->enabled
) {
571 ret
= agent_enable_event(aevent
, agt
->domain
);
572 if (ret
!= LTTNG_OK
) {
576 /* If the event was created prior to the enable, add it to the domain. */
578 agent_add_event(aevent
, agt
);
586 agent_destroy_event(aevent
);
592 * Return the agent default event name to use by testing if the process is root
593 * or not. Return NULL on error.
595 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
597 const char *default_event_name
= NULL
;
600 case LTTNG_DOMAIN_LOG4J
:
602 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
604 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
607 case LTTNG_DOMAIN_JUL
:
609 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
611 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
614 case LTTNG_DOMAIN_PYTHON
:
615 default_event_name
= DEFAULT_USER_PYTHON_EVENT_NAME
;
621 return default_event_name
;
625 * Disable a single agent event for a given UST session.
627 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
629 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
633 struct agent_event
*aevent
;
634 struct ltt_ust_event
*uevent
= NULL
;
635 struct ltt_ust_channel
*uchan
= NULL
;
636 const char *ust_event_name
, *ust_channel_name
;
642 DBG("Event agent disabling %s for session %" PRIu64
, event_name
, usess
->id
);
644 aevent
= agent_find_event_by_name(event_name
, agt
);
646 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
650 /* Already disabled? */
651 if (!aevent
->enabled
) {
655 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
656 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
657 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
658 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
659 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
660 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
662 ret
= LTTNG_ERR_INVALID
;
667 * Disable it on the UST side. First get the channel reference then find
668 * the event and finally disable it.
670 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
671 (char *) ust_channel_name
);
673 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
677 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
678 if (!ust_event_name
) {
679 ret
= LTTNG_ERR_FATAL
;
684 * The loglevel is hardcoded with 0 here since the agent ust event is set
685 * with the loglevel type to ALL thus the loglevel stays 0. The event's
686 * filter is the one handling the loglevel for agent.
688 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
689 aevent
->filter
, 0, NULL
);
690 /* If the agent event exists, it must be available on the UST side. */
693 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
694 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
695 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
700 * Flag event that it's disabled so the shadow copy on the ust app side
701 * will disable it if an application shows up.
705 ret
= agent_disable_event(aevent
, agt
->domain
);
706 if (ret
!= LTTNG_OK
) {
717 * Disable all agent event for a given UST session.
719 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
721 int event_agent_disable_all(struct ltt_ust_session
*usess
,
725 struct agent_event
*aevent
;
726 struct lttng_ht_iter iter
;
732 * Disable event on agent application. Continue to disable all other events
733 * if the * event is not found.
735 ret
= event_agent_disable(usess
, agt
, "*");
736 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
740 /* Flag every event that they are now enabled. */
742 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
744 if (!aevent
->enabled
) {
748 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
749 if (ret
!= LTTNG_OK
) {