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 event for a channel from the kernel session.
65 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
69 struct ltt_kernel_event
*kevent
;
73 kevent
= trace_kernel_get_event_by_name(event_name
, kchan
,
76 ret
= LTTNG_ERR_NO_EVENT
;
80 ret
= kernel_disable_event(kevent
);
82 ret
= LTTNG_ERR_KERN_DISABLE_FAIL
;
86 DBG("Kernel event %s disable for channel %s.",
87 kevent
->event
->name
, kchan
->channel
->name
);
96 * Disable kernel tracepoint events for a channel from the kernel session.
98 int event_kernel_disable_event_type(struct ltt_kernel_channel
*kchan
,
99 enum lttng_event_type type
)
102 struct ltt_kernel_event
*kevent
;
106 /* For each event in the kernel session */
107 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
108 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
110 ret
= kernel_disable_event(kevent
);
112 /* We continue disabling the rest */
121 * Disable all kernel event for a channel from the kernel session.
123 int event_kernel_disable_event_all(struct ltt_kernel_channel
*kchan
)
125 return event_kernel_disable_event_type(kchan
, LTTNG_EVENT_ALL
);
129 * Enable kernel tracepoint event for a channel from the kernel session.
130 * We own filter_expression and filter.
132 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
133 struct lttng_event
*event
, char *filter_expression
,
134 struct lttng_filter_bytecode
*filter
)
137 struct ltt_kernel_event
*kevent
;
142 kevent
= trace_kernel_find_event(event
->name
, kchan
,
143 event
->type
, filter
);
144 if (kevent
== NULL
) {
145 ret
= kernel_create_event(event
, kchan
,
146 filter_expression
, filter
);
147 /* We have passed ownership */
148 filter_expression
= NULL
;
153 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
156 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
159 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
164 } else if (kevent
->enabled
== 0) {
165 ret
= kernel_enable_event(kevent
);
167 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
171 /* At this point, the event is considered enabled */
172 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
178 free(filter_expression
);
184 * ============================
185 * UST : The Ultimate Frontier!
186 * ============================
190 * Enable UST tracepoint event for a channel from a UST session.
191 * We own filter_expression, filter, and exclusion.
193 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
194 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
195 char *filter_expression
,
196 struct lttng_filter_bytecode
*filter
,
197 struct lttng_event_exclusion
*exclusion
,
200 int ret
= LTTNG_OK
, to_create
= 0;
201 struct ltt_ust_event
*uevent
;
209 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
210 event
->loglevel_type
, event
->loglevel
, exclusion
);
212 uevent
= trace_ust_create_event(event
, filter_expression
,
213 filter
, exclusion
, internal_event
);
214 /* We have passed ownership */
215 filter_expression
= NULL
;
218 if (uevent
== NULL
) {
219 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
223 /* Valid to set it after the goto error since uevent is still NULL */
227 if (uevent
->enabled
) {
228 /* It's already enabled so everything is OK */
229 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
236 /* Create event on all UST registered apps for session */
237 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
239 /* Enable event on all UST registered apps for session */
240 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
244 if (ret
== -LTTNG_UST_ERR_EXIST
) {
245 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
248 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
254 /* Add ltt ust event to channel */
255 add_unique_ust_event(uchan
->events
, uevent
);
258 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
259 to_create
? "created" : "enabled", uchan
->name
);
265 free(filter_expression
);
272 * Only destroy event on creation time (not enabling time) because if the
273 * event is found in the channel (to_create == 0), it means that at some
274 * point the enable_event worked and it's thus valid to keep it alive.
275 * Destroying it also implies that we also destroy it's shadow copy to sync
279 /* In this code path, the uevent was not added to the hash table */
280 trace_ust_destroy_event(uevent
);
283 free(filter_expression
);
290 * Disable UST tracepoint of a channel from a UST session.
292 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
293 struct ltt_ust_channel
*uchan
, char *event_name
)
296 struct ltt_ust_event
*uevent
;
297 struct lttng_ht_node_str
*node
;
298 struct lttng_ht_iter iter
;
310 * We use a custom lookup since we need the iterator for the next_duplicate
311 * call in the do while loop below.
313 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
314 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
315 node
= lttng_ht_iter_get_node_str(&iter
);
317 DBG2("Trace UST event NOT found by name %s", event_name
);
318 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
323 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
326 if (uevent
->enabled
== 0) {
327 /* It's already disabled so everything is OK */
331 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
332 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
333 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
338 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
342 /* Get next duplicate event by name. */
343 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
344 event_name
, &iter
.iter
);
345 node
= lttng_ht_iter_get_node_str(&iter
);
356 * Disable all UST tracepoints for a channel from a UST session.
358 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
359 struct ltt_ust_channel
*uchan
)
361 int ret
, i
, size
, error
= 0;
362 struct lttng_ht_iter iter
;
363 struct ltt_ust_event
*uevent
= NULL
;
364 struct lttng_event
*events
= NULL
;
371 /* Disabling existing events */
372 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
374 if (uevent
->enabled
== 1) {
375 ret
= event_ust_disable_tracepoint(usess
, uchan
,
378 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
384 /* Get all UST available events */
385 size
= ust_app_list_events(&events
);
387 ret
= LTTNG_ERR_UST_LIST_FAIL
;
391 for (i
= 0; i
< size
; i
++) {
392 ret
= event_ust_disable_tracepoint(usess
, uchan
,
395 /* Continue to disable the rest... */
396 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
401 ret
= error
? error
: LTTNG_OK
;
409 * Enable all agent event for a given UST session.
411 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
413 int event_agent_enable_all(struct ltt_ust_session
*usess
,
414 struct agent
*agt
, struct lttng_event
*event
,
415 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
418 struct agent_event
*aevent
;
419 struct lttng_ht_iter iter
;
423 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
425 /* Enable event on agent application through TCP socket. */
426 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
427 if (ret
!= LTTNG_OK
) {
431 /* Flag every event that they are now enabled. */
433 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
446 * Enable a single agent event for a given UST session.
448 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
450 int event_agent_enable(struct ltt_ust_session
*usess
,
451 struct agent
*agt
, struct lttng_event
*event
,
452 struct lttng_filter_bytecode
*filter
,
453 char *filter_expression
)
455 int ret
, created
= 0;
456 struct agent_event
*aevent
;
462 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
463 ", loglevel %d and filter \"%s\"", event
->name
,
464 usess
->id
, event
->loglevel_type
, event
->loglevel
,
465 filter_expression
? filter_expression
: "NULL");
467 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
468 event
->loglevel
, agt
);
470 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
471 event
->loglevel
, filter
,
474 ret
= LTTNG_ERR_NOMEM
;
480 /* Already enabled? */
481 if (aevent
->enabled
) {
485 ret
= agent_enable_event(aevent
, agt
->domain
);
486 if (ret
!= LTTNG_OK
) {
490 /* If the event was created prior to the enable, add it to the domain. */
492 agent_add_event(aevent
, agt
);
500 agent_destroy_event(aevent
);
506 * Return the agent default event name to use by testing if the process is root
507 * or not. Return NULL on error.
509 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
511 const char *default_event_name
= NULL
;
514 case LTTNG_DOMAIN_LOG4J
:
516 default_event_name
= DEFAULT_SYS_LOG4J_EVENT_NAME
;
518 default_event_name
= DEFAULT_USER_LOG4J_EVENT_NAME
;
521 case LTTNG_DOMAIN_JUL
:
523 default_event_name
= DEFAULT_SYS_JUL_EVENT_NAME
;
525 default_event_name
= DEFAULT_USER_JUL_EVENT_NAME
;
528 case LTTNG_DOMAIN_PYTHON
:
529 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
535 return default_event_name
;
539 * Disable a given agent event for a given UST session.
541 * Must be called with the RCU read lock held.
542 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
544 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
545 struct agent
*agt
, struct agent_event
*aevent
)
548 struct ltt_ust_event
*uevent
= NULL
;
549 struct ltt_ust_channel
*uchan
= NULL
;
550 const char *ust_event_name
, *ust_channel_name
;
556 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
557 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
560 /* Already disabled? */
561 if (!aevent
->enabled
) {
565 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
566 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
567 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
568 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
569 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
570 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
572 ret
= LTTNG_ERR_INVALID
;
577 * Disable it on the UST side. First get the channel reference then find
578 * the event and finally disable it.
580 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
581 (char *) ust_channel_name
);
583 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
587 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
588 if (!ust_event_name
) {
589 ret
= LTTNG_ERR_FATAL
;
594 * Agent UST event has its loglevel type forced to
595 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
596 * happens thanks to an UST filter. The following -1 is actually
597 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
599 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
600 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
601 /* If the agent event exists, it must be available on the UST side. */
604 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
605 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
606 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
611 * Flag event that it's disabled so the shadow copy on the ust app side
612 * will disable it if an application shows up.
616 ret
= agent_disable_event(aevent
, agt
->domain
);
617 if (ret
!= LTTNG_OK
) {
629 * Disable all agent events matching a given name for a given UST session.
631 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
633 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
637 struct agent_event
*aevent
;
638 struct lttng_ht_iter iter
;
639 struct lttng_ht_node_str
*node
;
645 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
648 agent_find_events_by_name(event_name
, agt
, &iter
);
649 node
= lttng_ht_iter_get_node_str(&iter
);
652 DBG2("Event agent NOT found by name %s", event_name
);
653 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
658 aevent
= caa_container_of(node
, struct agent_event
, node
);
659 ret
= event_agent_disable_one(usess
, agt
, aevent
);
661 if (ret
!= LTTNG_OK
) {
665 /* Get next duplicate agent event by name. */
666 agent_event_next_duplicate(event_name
, agt
, &iter
);
667 node
= lttng_ht_iter_get_node_str(&iter
);
674 * Disable all agent event for a given UST session.
676 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
678 int event_agent_disable_all(struct ltt_ust_session
*usess
,
682 struct agent_event
*aevent
;
683 struct lttng_ht_iter iter
;
689 * Disable event on agent application. Continue to disable all other events
690 * if the * event is not found.
692 ret
= event_agent_disable(usess
, agt
, "*");
693 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
697 /* Disable every event. */
699 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
701 if (!aevent
->enabled
) {
705 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
706 if (ret
!= LTTNG_OK
) {