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.
20 #include <urcu/list.h>
23 #include <lttng/lttng.h>
24 #include <common/error.h>
25 #include <common/sessiond-comm/sessiond-comm.h>
26 #include <common/filter.h>
27 #include <common/context.h>
32 #include "lttng-sessiond.h"
35 #include "trace-kernel.h"
36 #include "trace-ust.h"
40 * Add unique UST event based on the event name, filter bytecode and loglevel.
42 static void add_unique_ust_event(struct lttng_ht
*ht
,
43 struct ltt_ust_event
*event
)
45 struct cds_lfht_node
*node_ptr
;
46 struct ltt_ust_ht_key key
;
52 key
.name
= event
->attr
.name
;
53 key
.filter
= (struct lttng_filter_bytecode
*) event
->filter
;
54 key
.loglevel_type
= event
->attr
.loglevel_type
;
55 key
.loglevel_value
= event
->attr
.loglevel
;
56 key
.exclusion
= event
->exclusion
;
58 node_ptr
= cds_lfht_add_unique(ht
->ht
,
59 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
60 trace_ust_ht_match_event
, &key
, &event
->node
.node
);
61 assert(node_ptr
== &event
->node
.node
);
65 * Disable kernel tracepoint events for a channel from the kernel session of
66 * a specified event_name and event type.
67 * On type LTTNG_EVENT_ALL all events with event_name are disabled.
68 * If event_name is NULL all events of the specified type are disabled.
70 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
71 char *event_name
, enum lttng_event_type type
)
73 int ret
, error
= 0, found
= 0;
74 struct ltt_kernel_event
*kevent
;
78 /* For each event in the kernel session */
79 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
80 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
82 if (event_name
!= NULL
&& strcmp(event_name
, kevent
->event
->name
)) {
86 ret
= kernel_disable_event(kevent
);
92 DBG("Disable kernel event: found %d events with name: %s and type: %d",
93 found
, event_name
? event_name
: "NULL", type
);
95 if (event_name
!= NULL
&& !found
) {
96 ret
= LTTNG_ERR_NO_EVENT
;
98 ret
= error
? LTTNG_ERR_KERN_DISABLE_FAIL
: LTTNG_OK
;
105 * Enable kernel tracepoint event for a channel from the kernel session.
106 * We own filter_expression and filter.
108 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
109 struct lttng_event
*event
, char *filter_expression
,
110 struct lttng_filter_bytecode
*filter
)
113 struct ltt_kernel_event
*kevent
;
118 kevent
= trace_kernel_find_event(event
->name
, kchan
,
119 event
->type
, filter
);
120 if (kevent
== NULL
) {
121 ret
= kernel_create_event(event
, kchan
,
122 filter_expression
, filter
);
123 /* We have passed ownership */
124 filter_expression
= NULL
;
129 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
132 ret
= LTTNG_ERR_KERN_EVENT_ENOSYS
;
135 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
140 } else if (kevent
->enabled
== 0) {
141 ret
= kernel_enable_event(kevent
);
143 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
147 /* At this point, the event is considered enabled */
148 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
154 free(filter_expression
);
160 * ============================
161 * UST : The Ultimate Frontier!
162 * ============================
166 * Enable UST tracepoint event for a channel from a UST session.
167 * We own filter_expression, filter, and exclusion.
169 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
170 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
171 char *filter_expression
,
172 struct lttng_filter_bytecode
*filter
,
173 struct lttng_event_exclusion
*exclusion
,
176 int ret
= LTTNG_OK
, to_create
= 0;
177 struct ltt_ust_event
*uevent
;
185 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
186 event
->loglevel_type
, event
->loglevel
, exclusion
);
188 uevent
= trace_ust_create_event(event
, filter_expression
,
189 filter
, exclusion
, internal_event
);
190 /* We have passed ownership */
191 filter_expression
= NULL
;
194 if (uevent
== NULL
) {
195 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
199 /* Valid to set it after the goto error since uevent is still NULL */
203 if (uevent
->enabled
) {
204 /* It's already enabled so everything is OK */
205 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
212 /* Create event on all UST registered apps for session */
213 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
215 /* Enable event on all UST registered apps for session */
216 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
220 if (ret
== -LTTNG_UST_ERR_EXIST
) {
221 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
224 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
230 /* Add ltt ust event to channel */
231 add_unique_ust_event(uchan
->events
, uevent
);
234 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
235 to_create
? "created" : "enabled", uchan
->name
);
241 free(filter_expression
);
248 * Only destroy event on creation time (not enabling time) because if the
249 * event is found in the channel (to_create == 0), it means that at some
250 * point the enable_event worked and it's thus valid to keep it alive.
251 * Destroying it also implies that we also destroy it's shadow copy to sync
255 /* In this code path, the uevent was not added to the hash table */
256 trace_ust_destroy_event(uevent
);
259 free(filter_expression
);
266 * Disable UST tracepoint of a channel from a UST session.
268 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
269 struct ltt_ust_channel
*uchan
, char *event_name
)
272 struct ltt_ust_event
*uevent
;
273 struct lttng_ht_node_str
*node
;
274 struct lttng_ht_iter iter
;
286 * We use a custom lookup since we need the iterator for the next_duplicate
287 * call in the do while loop below.
289 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
290 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
291 node
= lttng_ht_iter_get_node_str(&iter
);
293 DBG2("Trace UST event NOT found by name %s", event_name
);
294 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
299 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
302 if (uevent
->enabled
== 0) {
303 /* It's already disabled so everything is OK */
307 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
308 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
309 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
314 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
318 /* Get next duplicate event by name. */
319 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
320 event_name
, &iter
.iter
);
321 node
= lttng_ht_iter_get_node_str(&iter
);
332 * Disable all UST tracepoints for a channel from a UST session.
334 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
335 struct ltt_ust_channel
*uchan
)
337 int ret
, i
, size
, error
= 0;
338 struct lttng_ht_iter iter
;
339 struct ltt_ust_event
*uevent
= NULL
;
340 struct lttng_event
*events
= NULL
;
347 /* Disabling existing events */
348 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
350 if (uevent
->enabled
== 1) {
351 ret
= event_ust_disable_tracepoint(usess
, uchan
,
354 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
360 /* Get all UST available events */
361 size
= ust_app_list_events(&events
);
363 ret
= LTTNG_ERR_UST_LIST_FAIL
;
367 for (i
= 0; i
< size
; i
++) {
368 ret
= event_ust_disable_tracepoint(usess
, uchan
,
371 /* Continue to disable the rest... */
372 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
377 ret
= error
? error
: LTTNG_OK
;
385 * Enable all agent event for a given UST session.
387 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
389 int event_agent_enable_all(struct ltt_ust_session
*usess
,
390 struct agent
*agt
, struct lttng_event
*event
,
391 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
394 struct agent_event
*aevent
;
395 struct lttng_ht_iter iter
;
399 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
401 /* Enable event on agent application through TCP socket. */
402 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
403 if (ret
!= LTTNG_OK
) {
407 /* Flag every event that they are now enabled. */
409 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
422 * Check if this event's filter requires the activation of application contexts
423 * and enable them in the agent.
425 static int add_filter_app_ctx(struct lttng_filter_bytecode
*bytecode
,
426 const char *filter_expression
, struct agent
*agt
)
429 char *provider_name
= NULL
, *ctx_name
= NULL
;
430 struct bytecode_symbol_iterator
*it
=
431 bytecode_symbol_iterator_create(bytecode
);
434 ret
= LTTNG_ERR_NOMEM
;
439 struct lttng_event_context ctx
;
440 const char *symbol_name
=
441 bytecode_symbol_iterator_get_name(it
);
443 if (parse_application_context(symbol_name
, &provider_name
,
445 /* Not an application context. */
449 ctx
.ctx
= LTTNG_EVENT_CONTEXT_APP_CONTEXT
;
450 ctx
.u
.app_ctx
.provider_name
= provider_name
;
451 ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
453 /* Recognized an application context. */
454 DBG("Enabling event with filter expression \"%s\" requires enabling the %s:%s application context.",
455 filter_expression
, provider_name
, ctx_name
);
457 ret
= agent_add_context(&ctx
, agt
);
458 if (ret
!= LTTNG_OK
) {
459 ERR("Failed to add application context %s:%s.",
460 provider_name
, ctx_name
);
464 ret
= agent_enable_context(&ctx
, agt
->domain
);
465 if (ret
!= LTTNG_OK
) {
466 ERR("Failed to enable application context %s:%s.",
467 provider_name
, ctx_name
);
473 provider_name
= ctx_name
= NULL
;
474 } while (bytecode_symbol_iterator_next(it
) == 0);
478 bytecode_symbol_iterator_destroy(it
);
483 * Enable a single agent event for a given UST session.
485 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
487 int event_agent_enable(struct ltt_ust_session
*usess
,
488 struct agent
*agt
, struct lttng_event
*event
,
489 struct lttng_filter_bytecode
*filter
,
490 char *filter_expression
)
492 int ret
, created
= 0;
493 struct agent_event
*aevent
;
499 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
500 ", loglevel %d and filter \"%s\"", event
->name
,
501 usess
->id
, event
->loglevel_type
, event
->loglevel
,
502 filter_expression
? filter_expression
: "NULL");
504 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
505 event
->loglevel
, filter_expression
, agt
);
507 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
508 event
->loglevel
, filter
,
511 ret
= LTTNG_ERR_NOMEM
;
518 /* Already enabled? */
519 if (aevent
->enabled
) {
523 if (created
&& filter
) {
524 ret
= add_filter_app_ctx(filter
, filter_expression
, agt
);
525 if (ret
!= LTTNG_OK
) {
530 ret
= agent_enable_event(aevent
, agt
->domain
);
531 if (ret
!= LTTNG_OK
) {
535 /* If the event was created prior to the enable, add it to the domain. */
537 agent_add_event(aevent
, agt
);
545 agent_destroy_event(aevent
);
551 * Return the default event name associated with the provided UST domain. Return
554 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
556 const char *default_event_name
= NULL
;
559 case LTTNG_DOMAIN_LOG4J
:
560 default_event_name
= DEFAULT_LOG4J_EVENT_NAME
;
562 case LTTNG_DOMAIN_JUL
:
563 default_event_name
= DEFAULT_JUL_EVENT_NAME
;
565 case LTTNG_DOMAIN_PYTHON
:
566 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
572 return default_event_name
;
576 * Disable a given agent event for a given UST session.
578 * Must be called with the RCU read lock held.
579 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
581 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
582 struct agent
*agt
, struct agent_event
*aevent
)
585 struct ltt_ust_event
*uevent
= NULL
;
586 struct ltt_ust_channel
*uchan
= NULL
;
587 const char *ust_event_name
, *ust_channel_name
;
593 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
594 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
597 /* Already disabled? */
598 if (!aevent
->enabled
) {
602 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
603 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
604 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
605 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
606 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
607 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
609 ret
= LTTNG_ERR_INVALID
;
614 * Disable it on the UST side. First get the channel reference then find
615 * the event and finally disable it.
617 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
618 (char *) ust_channel_name
);
620 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
624 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
625 if (!ust_event_name
) {
626 ret
= LTTNG_ERR_FATAL
;
631 * Agent UST event has its loglevel type forced to
632 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
633 * happens thanks to an UST filter. The following -1 is actually
634 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
636 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
637 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
638 /* If the agent event exists, it must be available on the UST side. */
641 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
642 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
643 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
648 * Flag event that it's disabled so the shadow copy on the ust app side
649 * will disable it if an application shows up.
653 ret
= agent_disable_event(aevent
, agt
->domain
);
654 if (ret
!= LTTNG_OK
) {
666 * Disable all agent events matching a given name for a given UST session.
668 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
670 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
674 struct agent_event
*aevent
;
675 struct lttng_ht_iter iter
;
676 struct lttng_ht_node_str
*node
;
682 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
685 agent_find_events_by_name(event_name
, agt
, &iter
);
686 node
= lttng_ht_iter_get_node_str(&iter
);
689 DBG2("Event agent NOT found by name %s", event_name
);
690 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
695 aevent
= caa_container_of(node
, struct agent_event
, node
);
696 ret
= event_agent_disable_one(usess
, agt
, aevent
);
698 if (ret
!= LTTNG_OK
) {
702 /* Get next duplicate agent event by name. */
703 agent_event_next_duplicate(event_name
, agt
, &iter
);
704 node
= lttng_ht_iter_get_node_str(&iter
);
711 * Disable all agent event for a given UST session.
713 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
715 int event_agent_disable_all(struct ltt_ust_session
*usess
,
719 struct agent_event
*aevent
;
720 struct lttng_ht_iter iter
;
726 * Disable event on agent application. Continue to disable all other events
727 * if the * event is not found.
729 ret
= event_agent_disable(usess
, agt
, "*");
730 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
734 /* Disable every event. */
736 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
738 if (!aevent
->enabled
) {
742 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
743 if (ret
!= LTTNG_OK
) {