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"
39 * Add unique UST event based on the event name, filter bytecode and loglevel.
41 static void add_unique_ust_event(struct lttng_ht
*ht
,
42 struct ltt_ust_event
*event
)
44 struct cds_lfht_node
*node_ptr
;
45 struct ltt_ust_ht_key key
;
51 key
.name
= event
->attr
.name
;
52 key
.filter
= (struct lttng_filter_bytecode
*) event
->filter
;
53 key
.loglevel_type
= event
->attr
.loglevel_type
;
54 key
.loglevel_value
= event
->attr
.loglevel
;
55 key
.exclusion
= event
->exclusion
;
57 node_ptr
= cds_lfht_add_unique(ht
->ht
,
58 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
59 trace_ust_ht_match_event
, &key
, &event
->node
.node
);
60 assert(node_ptr
== &event
->node
.node
);
64 * Disable kernel tracepoint events for a channel from the kernel session of
65 * a specified event_name and event type.
66 * On type LTTNG_EVENT_ALL all events with event_name are disabled.
67 * If event_name is NULL all events of the specified type are disabled.
69 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
70 char *event_name
, enum lttng_event_type type
)
72 int ret
, error
= 0, found
= 0;
73 struct ltt_kernel_event
*kevent
;
77 /* For each event in the kernel session */
78 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
79 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
81 if (event_name
!= NULL
&& strcmp(event_name
, kevent
->event
->name
)) {
85 ret
= kernel_disable_event(kevent
);
91 DBG("Disable kernel event: found %d events with name: %s and type: %d",
92 found
, event_name
? event_name
: "NULL", type
);
94 if (event_name
!= NULL
&& !found
) {
95 ret
= LTTNG_ERR_NO_EVENT
;
97 ret
= error
? LTTNG_ERR_KERN_DISABLE_FAIL
: LTTNG_OK
;
104 * Enable kernel tracepoint event for a channel from the kernel session.
105 * We own filter_expression and filter.
107 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
108 struct lttng_event
*event
, char *filter_expression
,
109 struct lttng_filter_bytecode
*filter
)
112 struct ltt_kernel_event
*kevent
;
117 kevent
= trace_kernel_find_event(event
->name
, kchan
,
118 event
->type
, filter
);
119 if (kevent
== NULL
) {
120 ret
= kernel_create_event(event
, kchan
,
121 filter_expression
, filter
);
122 /* We have passed ownership */
123 filter_expression
= NULL
;
128 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
131 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
134 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
139 } else if (kevent
->enabled
== 0) {
140 ret
= kernel_enable_event(kevent
);
142 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
146 /* At this point, the event is considered enabled */
147 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
153 free(filter_expression
);
159 * ============================
160 * UST : The Ultimate Frontier!
161 * ============================
165 * Enable UST tracepoint event for a channel from a UST session.
166 * We own filter_expression, filter, and exclusion.
168 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
169 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
170 char *filter_expression
,
171 struct lttng_filter_bytecode
*filter
,
172 struct lttng_event_exclusion
*exclusion
,
175 int ret
= LTTNG_OK
, to_create
= 0;
176 struct ltt_ust_event
*uevent
;
184 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
185 event
->loglevel_type
, event
->loglevel
, exclusion
);
187 uevent
= trace_ust_create_event(event
, filter_expression
,
188 filter
, exclusion
, internal_event
);
189 /* We have passed ownership */
190 filter_expression
= NULL
;
193 if (uevent
== NULL
) {
194 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
198 /* Valid to set it after the goto error since uevent is still NULL */
202 if (uevent
->enabled
) {
203 /* It's already enabled so everything is OK */
204 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
211 /* Create event on all UST registered apps for session */
212 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
214 /* Enable event on all UST registered apps for session */
215 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
219 if (ret
== -LTTNG_UST_ERR_EXIST
) {
220 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
223 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
229 /* Add ltt ust event to channel */
230 add_unique_ust_event(uchan
->events
, uevent
);
233 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
234 to_create
? "created" : "enabled", uchan
->name
);
240 free(filter_expression
);
247 * Only destroy event on creation time (not enabling time) because if the
248 * event is found in the channel (to_create == 0), it means that at some
249 * point the enable_event worked and it's thus valid to keep it alive.
250 * Destroying it also implies that we also destroy it's shadow copy to sync
254 /* In this code path, the uevent was not added to the hash table */
255 trace_ust_destroy_event(uevent
);
258 free(filter_expression
);
265 * Disable UST tracepoint of a channel from a UST session.
267 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
268 struct ltt_ust_channel
*uchan
, char *event_name
)
271 struct ltt_ust_event
*uevent
;
272 struct lttng_ht_node_str
*node
;
273 struct lttng_ht_iter iter
;
285 * We use a custom lookup since we need the iterator for the next_duplicate
286 * call in the do while loop below.
288 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
289 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
290 node
= lttng_ht_iter_get_node_str(&iter
);
292 DBG2("Trace UST event NOT found by name %s", event_name
);
293 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
298 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
301 if (uevent
->enabled
== 0) {
302 /* It's already disabled so everything is OK */
306 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
307 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
308 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
313 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
317 /* Get next duplicate event by name. */
318 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
319 event_name
, &iter
.iter
);
320 node
= lttng_ht_iter_get_node_str(&iter
);
331 * Disable all UST tracepoints for a channel from a UST session.
333 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
334 struct ltt_ust_channel
*uchan
)
336 int ret
, i
, size
, error
= 0;
337 struct lttng_ht_iter iter
;
338 struct ltt_ust_event
*uevent
= NULL
;
339 struct lttng_event
*events
= NULL
;
346 /* Disabling existing events */
347 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
349 if (uevent
->enabled
== 1) {
350 ret
= event_ust_disable_tracepoint(usess
, uchan
,
353 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
359 /* Get all UST available events */
360 size
= ust_app_list_events(&events
);
362 ret
= LTTNG_ERR_UST_LIST_FAIL
;
366 for (i
= 0; i
< size
; i
++) {
367 ret
= event_ust_disable_tracepoint(usess
, uchan
,
370 /* Continue to disable the rest... */
371 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
376 ret
= error
? error
: LTTNG_OK
;
384 * Enable all agent event for a given UST session.
386 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
388 int event_agent_enable_all(struct ltt_ust_session
*usess
,
389 struct agent
*agt
, struct lttng_event
*event
,
390 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
393 struct agent_event
*aevent
;
394 struct lttng_ht_iter iter
;
398 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
400 /* Enable event on agent application through TCP socket. */
401 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
402 if (ret
!= LTTNG_OK
) {
406 /* Flag every event that they are now enabled. */
408 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
421 * Enable a single agent event for a given UST session.
423 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
425 int event_agent_enable(struct ltt_ust_session
*usess
,
426 struct agent
*agt
, struct lttng_event
*event
,
427 struct lttng_filter_bytecode
*filter
,
428 char *filter_expression
)
430 int ret
, created
= 0;
431 struct agent_event
*aevent
;
437 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
438 ", loglevel %d and filter \"%s\"", event
->name
,
439 usess
->id
, event
->loglevel_type
, event
->loglevel
,
440 filter_expression
? filter_expression
: "NULL");
442 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
443 event
->loglevel
, agt
);
445 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
446 event
->loglevel
, filter
,
449 ret
= LTTNG_ERR_NOMEM
;
455 /* Already enabled? */
456 if (aevent
->enabled
) {
460 ret
= agent_enable_event(aevent
, agt
->domain
);
461 if (ret
!= LTTNG_OK
) {
465 /* If the event was created prior to the enable, add it to the domain. */
467 agent_add_event(aevent
, agt
);
475 agent_destroy_event(aevent
);
481 * Return the default event name associated with the provided UST domain. Return
484 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
486 const char *default_event_name
= NULL
;
489 case LTTNG_DOMAIN_LOG4J
:
490 default_event_name
= DEFAULT_LOG4J_EVENT_NAME
;
492 case LTTNG_DOMAIN_JUL
:
493 default_event_name
= DEFAULT_JUL_EVENT_NAME
;
495 case LTTNG_DOMAIN_PYTHON
:
496 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
502 return default_event_name
;
506 * Disable a given agent event for a given UST session.
508 * Must be called with the RCU read lock held.
509 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
511 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
512 struct agent
*agt
, struct agent_event
*aevent
)
515 struct ltt_ust_event
*uevent
= NULL
;
516 struct ltt_ust_channel
*uchan
= NULL
;
517 const char *ust_event_name
, *ust_channel_name
;
523 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
524 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
527 /* Already disabled? */
528 if (!aevent
->enabled
) {
532 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
533 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
534 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
535 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
536 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
537 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
539 ret
= LTTNG_ERR_INVALID
;
544 * Disable it on the UST side. First get the channel reference then find
545 * the event and finally disable it.
547 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
548 (char *) ust_channel_name
);
550 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
554 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
555 if (!ust_event_name
) {
556 ret
= LTTNG_ERR_FATAL
;
561 * Agent UST event has its loglevel type forced to
562 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
563 * happens thanks to an UST filter. The following -1 is actually
564 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
566 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
567 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
568 /* If the agent event exists, it must be available on the UST side. */
571 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
572 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
573 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
578 * Flag event that it's disabled so the shadow copy on the ust app side
579 * will disable it if an application shows up.
583 ret
= agent_disable_event(aevent
, agt
->domain
);
584 if (ret
!= LTTNG_OK
) {
596 * Disable all agent events matching a given name for a given UST session.
598 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
600 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
604 struct agent_event
*aevent
;
605 struct lttng_ht_iter iter
;
606 struct lttng_ht_node_str
*node
;
612 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
615 agent_find_events_by_name(event_name
, agt
, &iter
);
616 node
= lttng_ht_iter_get_node_str(&iter
);
619 DBG2("Event agent NOT found by name %s", event_name
);
620 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
625 aevent
= caa_container_of(node
, struct agent_event
, node
);
626 ret
= event_agent_disable_one(usess
, agt
, aevent
);
628 if (ret
!= LTTNG_OK
) {
632 /* Get next duplicate agent event by name. */
633 agent_event_next_duplicate(event_name
, agt
, &iter
);
634 node
= lttng_ht_iter_get_node_str(&iter
);
641 * Disable all agent event for a given UST session.
643 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
645 int event_agent_disable_all(struct ltt_ust_session
*usess
,
649 struct agent_event
*aevent
;
650 struct lttng_ht_iter iter
;
656 * Disable event on agent application. Continue to disable all other events
657 * if the * event is not found.
659 ret
= event_agent_disable(usess
, agt
, "*");
660 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
664 /* Disable every event. */
666 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
668 if (!aevent
->enabled
) {
672 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
673 if (ret
!= LTTNG_OK
) {