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_type
= event
->attr
.loglevel_type
;
53 key
.loglevel_value
= event
->attr
.loglevel
;
54 key
.exclusion
= event
->exclusion
;
56 node_ptr
= cds_lfht_add_unique(ht
->ht
,
57 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
58 trace_ust_ht_match_event
, &key
, &event
->node
.node
);
59 assert(node_ptr
== &event
->node
.node
);
63 * Disable kernel tracepoint events for a channel from the kernel session of
64 * a specified event_name and event type.
65 * On type LTTNG_EVENT_ALL all events with event_name are disabled.
66 * If event_name is NULL all events of the specified type are disabled.
68 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
69 char *event_name
, enum lttng_event_type type
)
71 int ret
, error
= 0, found
= 0;
72 struct ltt_kernel_event
*kevent
;
76 /* For each event in the kernel session */
77 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
78 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
80 if (event_name
!= NULL
&& strcmp(event_name
, kevent
->event
->name
)) {
84 ret
= kernel_disable_event(kevent
);
90 DBG("Disable kernel event: found %d events with name: %s and type: %d",
91 found
, event_name
? event_name
: "NULL", type
);
93 if (event_name
!= NULL
&& !found
) {
94 ret
= LTTNG_ERR_NO_EVENT
;
96 ret
= error
? LTTNG_ERR_KERN_DISABLE_FAIL
: LTTNG_OK
;
103 * Enable kernel tracepoint event for a channel from the kernel session.
104 * We own filter_expression and filter.
106 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
107 struct lttng_event
*event
, char *filter_expression
,
108 struct lttng_filter_bytecode
*filter
)
111 struct ltt_kernel_event
*kevent
;
116 kevent
= trace_kernel_find_event(event
->name
, kchan
,
117 event
->type
, filter
);
118 if (kevent
== NULL
) {
119 ret
= kernel_create_event(event
, kchan
,
120 filter_expression
, filter
);
121 /* We have passed ownership */
122 filter_expression
= NULL
;
127 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
130 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
133 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
138 } else if (kevent
->enabled
== 0) {
139 ret
= kernel_enable_event(kevent
);
141 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
145 /* At this point, the event is considered enabled */
146 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
152 free(filter_expression
);
158 * ============================
159 * UST : The Ultimate Frontier!
160 * ============================
164 * Enable UST tracepoint event for a channel from a UST session.
165 * We own filter_expression, filter, and exclusion.
167 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
168 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
169 char *filter_expression
,
170 struct lttng_filter_bytecode
*filter
,
171 struct lttng_event_exclusion
*exclusion
,
174 int ret
= LTTNG_OK
, to_create
= 0;
175 struct ltt_ust_event
*uevent
;
183 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
184 event
->loglevel_type
, event
->loglevel
, exclusion
);
186 uevent
= trace_ust_create_event(event
, filter_expression
,
187 filter
, exclusion
, internal_event
);
188 /* We have passed ownership */
189 filter_expression
= NULL
;
192 if (uevent
== NULL
) {
193 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
197 /* Valid to set it after the goto error since uevent is still NULL */
201 if (uevent
->enabled
) {
202 /* It's already enabled so everything is OK */
203 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
210 /* Create event on all UST registered apps for session */
211 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
213 /* Enable event on all UST registered apps for session */
214 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
218 if (ret
== -LTTNG_UST_ERR_EXIST
) {
219 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
222 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
228 /* Add ltt ust event to channel */
229 add_unique_ust_event(uchan
->events
, uevent
);
232 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
233 to_create
? "created" : "enabled", uchan
->name
);
239 free(filter_expression
);
246 * Only destroy event on creation time (not enabling time) because if the
247 * event is found in the channel (to_create == 0), it means that at some
248 * point the enable_event worked and it's thus valid to keep it alive.
249 * Destroying it also implies that we also destroy it's shadow copy to sync
253 /* In this code path, the uevent was not added to the hash table */
254 trace_ust_destroy_event(uevent
);
257 free(filter_expression
);
264 * Disable UST tracepoint of a channel from a UST session.
266 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
267 struct ltt_ust_channel
*uchan
, char *event_name
)
270 struct ltt_ust_event
*uevent
;
271 struct lttng_ht_node_str
*node
;
272 struct lttng_ht_iter iter
;
284 * We use a custom lookup since we need the iterator for the next_duplicate
285 * call in the do while loop below.
287 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
288 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
289 node
= lttng_ht_iter_get_node_str(&iter
);
291 DBG2("Trace UST event NOT found by name %s", event_name
);
292 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
297 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
300 if (uevent
->enabled
== 0) {
301 /* It's already disabled so everything is OK */
305 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
306 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
307 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
312 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
316 /* Get next duplicate event by name. */
317 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
318 event_name
, &iter
.iter
);
319 node
= lttng_ht_iter_get_node_str(&iter
);
330 * Disable all UST tracepoints for a channel from a UST session.
332 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
333 struct ltt_ust_channel
*uchan
)
335 int ret
, i
, size
, error
= 0;
336 struct lttng_ht_iter iter
;
337 struct ltt_ust_event
*uevent
= NULL
;
338 struct lttng_event
*events
= NULL
;
345 /* Disabling existing events */
346 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
348 if (uevent
->enabled
== 1) {
349 ret
= event_ust_disable_tracepoint(usess
, uchan
,
352 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
358 /* Get all UST available events */
359 size
= ust_app_list_events(&events
);
361 ret
= LTTNG_ERR_UST_LIST_FAIL
;
365 for (i
= 0; i
< size
; i
++) {
366 ret
= event_ust_disable_tracepoint(usess
, uchan
,
369 /* Continue to disable the rest... */
370 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
375 ret
= error
? error
: LTTNG_OK
;
383 * Enable all agent event for a given UST session.
385 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
387 int event_agent_enable_all(struct ltt_ust_session
*usess
,
388 struct agent
*agt
, struct lttng_event
*event
,
389 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
392 struct agent_event
*aevent
;
393 struct lttng_ht_iter iter
;
397 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
399 /* Enable event on agent application through TCP socket. */
400 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
401 if (ret
!= LTTNG_OK
) {
405 /* Flag every event that they are now enabled. */
407 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
420 * Enable a single agent event for a given UST session.
422 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
424 int event_agent_enable(struct ltt_ust_session
*usess
,
425 struct agent
*agt
, struct lttng_event
*event
,
426 struct lttng_filter_bytecode
*filter
,
427 char *filter_expression
)
429 int ret
, created
= 0;
430 struct agent_event
*aevent
;
436 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
437 ", loglevel %d and filter \"%s\"", event
->name
,
438 usess
->id
, event
->loglevel_type
, event
->loglevel
,
439 filter_expression
? filter_expression
: "NULL");
441 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
442 event
->loglevel
, filter_expression
, agt
);
444 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
445 event
->loglevel
, filter
,
448 ret
= LTTNG_ERR_NOMEM
;
454 /* Already enabled? */
455 if (aevent
->enabled
) {
459 ret
= agent_enable_event(aevent
, agt
->domain
);
460 if (ret
!= LTTNG_OK
) {
464 /* If the event was created prior to the enable, add it to the domain. */
466 agent_add_event(aevent
, agt
);
474 agent_destroy_event(aevent
);
480 * Return the agent default event name to use by testing if the process is root
481 * or not. Return NULL on error.
483 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
485 const char *default_event_name
= NULL
;
488 case LTTNG_DOMAIN_LOG4J
:
490 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
492 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
495 case LTTNG_DOMAIN_JUL
:
497 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
499 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
502 case LTTNG_DOMAIN_PYTHON
:
503 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
509 return default_event_name
;
513 * Disable a given agent event for a given UST session.
515 * Must be called with the RCU read lock held.
516 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
518 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
519 struct agent
*agt
, struct agent_event
*aevent
)
522 struct ltt_ust_event
*uevent
= NULL
;
523 struct ltt_ust_channel
*uchan
= NULL
;
524 const char *ust_event_name
, *ust_channel_name
;
530 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
531 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
534 /* Already disabled? */
535 if (!aevent
->enabled
) {
539 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
540 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
541 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
542 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
543 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
544 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
546 ret
= LTTNG_ERR_INVALID
;
551 * Disable it on the UST side. First get the channel reference then find
552 * the event and finally disable it.
554 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
555 (char *) ust_channel_name
);
557 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
561 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
562 if (!ust_event_name
) {
563 ret
= LTTNG_ERR_FATAL
;
568 * Agent UST event has its loglevel type forced to
569 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
570 * happens thanks to an UST filter. The following -1 is actually
571 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
573 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
574 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
575 /* If the agent event exists, it must be available on the UST side. */
578 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
579 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
580 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
585 * Flag event that it's disabled so the shadow copy on the ust app side
586 * will disable it if an application shows up.
590 ret
= agent_disable_event(aevent
, agt
->domain
);
591 if (ret
!= LTTNG_OK
) {
603 * Disable all agent events matching a given name for a given UST session.
605 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
607 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
611 struct agent_event
*aevent
;
612 struct lttng_ht_iter iter
;
613 struct lttng_ht_node_str
*node
;
619 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
622 agent_find_events_by_name(event_name
, agt
, &iter
);
623 node
= lttng_ht_iter_get_node_str(&iter
);
626 DBG2("Event agent NOT found by name %s", event_name
);
627 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
632 aevent
= caa_container_of(node
, struct agent_event
, node
);
633 ret
= event_agent_disable_one(usess
, agt
, aevent
);
635 if (ret
!= LTTNG_OK
) {
639 /* Get next duplicate agent event by name. */
640 agent_event_next_duplicate(event_name
, agt
, &iter
);
641 node
= lttng_ht_iter_get_node_str(&iter
);
648 * Disable all agent event for a given UST session.
650 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
652 int event_agent_disable_all(struct ltt_ust_session
*usess
,
656 struct agent_event
*aevent
;
657 struct lttng_ht_iter iter
;
663 * Disable event on agent application. Continue to disable all other events
664 * if the * event is not found.
666 ret
= event_agent_disable(usess
, agt
, "*");
667 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
671 /* Disable every event. */
673 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
675 if (!aevent
->enabled
) {
679 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
680 if (ret
!= LTTNG_OK
) {