2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 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>
27 #include <common/filter.h>
28 #include <common/context.h>
33 #include "lttng-sessiond.h"
36 #include "trace-kernel.h"
37 #include "trace-ust.h"
41 * Add unique UST event based on the event name, filter bytecode and loglevel.
43 static void add_unique_ust_event(struct lttng_ht
*ht
,
44 struct ltt_ust_event
*event
)
46 struct cds_lfht_node
*node_ptr
;
47 struct ltt_ust_ht_key key
;
53 key
.name
= event
->attr
.name
;
54 key
.filter
= (struct lttng_filter_bytecode
*) event
->filter
;
55 key
.loglevel_type
= event
->attr
.loglevel_type
;
56 key
.loglevel_value
= event
->attr
.loglevel
;
57 key
.exclusion
= event
->exclusion
;
59 node_ptr
= cds_lfht_add_unique(ht
->ht
,
60 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
61 trace_ust_ht_match_event
, &key
, &event
->node
.node
);
62 assert(node_ptr
== &event
->node
.node
);
66 * Disable kernel tracepoint events for a channel from the kernel session of
67 * a specified event_name and event type.
68 * On type LTTNG_EVENT_ALL all events with event_name are disabled.
69 * If event_name is NULL all events of the specified type are disabled.
71 int event_kernel_disable_event(struct ltt_kernel_channel
*kchan
,
72 char *event_name
, enum lttng_event_type type
)
74 int ret
, error
= 0, found
= 0;
75 struct ltt_kernel_event
*kevent
;
79 /* For each event in the kernel session */
80 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
81 if (type
!= LTTNG_EVENT_ALL
&& kevent
->type
!= type
)
83 if (event_name
!= NULL
&& strcmp(event_name
, kevent
->event
->name
)) {
87 ret
= kernel_disable_event(kevent
);
93 DBG("Disable kernel event: found %d events with name: %s and type: %d",
94 found
, event_name
? event_name
: "NULL", type
);
96 if (event_name
!= NULL
&& !found
) {
97 ret
= LTTNG_ERR_NO_EVENT
;
99 ret
= error
? LTTNG_ERR_KERN_DISABLE_FAIL
: LTTNG_OK
;
106 * Enable kernel tracepoint event for a channel from the kernel session.
107 * We own filter_expression and filter.
109 int event_kernel_enable_event(struct ltt_kernel_channel
*kchan
,
110 struct lttng_event
*event
, char *filter_expression
,
111 struct lttng_filter_bytecode
*filter
)
114 struct ltt_kernel_event
*kevent
;
119 kevent
= trace_kernel_find_event(event
->name
, kchan
,
120 event
->type
, filter
);
121 if (kevent
== NULL
) {
122 ret
= kernel_create_event(event
, kchan
, filter_expression
, filter
);
123 /* We have passed ownership */
124 filter_expression
= NULL
;
129 } else if (kevent
->enabled
== 0) {
130 ret
= kernel_enable_event(kevent
);
132 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
136 /* At this point, the event is considered enabled */
137 ret
= LTTNG_ERR_KERN_EVENT_EXIST
;
143 free(filter_expression
);
149 * ============================
150 * UST : The Ultimate Frontier!
151 * ============================
155 * Enable UST tracepoint event for a channel from a UST session.
156 * We own filter_expression, filter, and exclusion.
158 int event_ust_enable_tracepoint(struct ltt_ust_session
*usess
,
159 struct ltt_ust_channel
*uchan
, struct lttng_event
*event
,
160 char *filter_expression
,
161 struct lttng_filter_bytecode
*filter
,
162 struct lttng_event_exclusion
*exclusion
,
165 int ret
, to_create
= 0;
166 struct ltt_ust_event
*uevent
;
174 uevent
= trace_ust_find_event(uchan
->events
, event
->name
, filter
,
175 event
->loglevel_type
, event
->loglevel
, exclusion
);
177 ret
= trace_ust_create_event(event
, filter_expression
,
178 filter
, exclusion
, internal_event
, &uevent
);
179 /* We have passed ownership */
180 filter_expression
= NULL
;
183 if (ret
!= LTTNG_OK
) {
187 /* Valid to set it after the goto error since uevent is still NULL */
191 if (uevent
->enabled
) {
192 /* It's already enabled so everything is OK */
193 ret
= LTTNG_ERR_UST_EVENT_ENABLED
;
200 /* Create event on all UST registered apps for session */
201 ret
= ust_app_create_event_glb(usess
, uchan
, uevent
);
203 /* Enable event on all UST registered apps for session */
204 ret
= ust_app_enable_event_glb(usess
, uchan
, uevent
);
208 if (ret
== -LTTNG_UST_ERR_EXIST
) {
209 ret
= LTTNG_ERR_UST_EVENT_EXIST
;
212 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
218 /* Add ltt ust event to channel */
219 add_unique_ust_event(uchan
->events
, uevent
);
222 DBG("Event UST %s %s in channel %s", uevent
->attr
.name
,
223 to_create
? "created" : "enabled", uchan
->name
);
229 free(filter_expression
);
236 * Only destroy event on creation time (not enabling time) because if the
237 * event is found in the channel (to_create == 0), it means that at some
238 * point the enable_event worked and it's thus valid to keep it alive.
239 * Destroying it also implies that we also destroy it's shadow copy to sync
243 /* In this code path, the uevent was not added to the hash table */
244 trace_ust_destroy_event(uevent
);
247 free(filter_expression
);
254 * Disable UST tracepoint of a channel from a UST session.
256 int event_ust_disable_tracepoint(struct ltt_ust_session
*usess
,
257 struct ltt_ust_channel
*uchan
, char *event_name
)
260 struct ltt_ust_event
*uevent
;
261 struct lttng_ht_node_str
*node
;
262 struct lttng_ht_iter iter
;
274 * We use a custom lookup since we need the iterator for the next_duplicate
275 * call in the do while loop below.
277 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) event_name
, lttng_ht_seed
),
278 trace_ust_ht_match_event_by_name
, event_name
, &iter
.iter
);
279 node
= lttng_ht_iter_get_node_str(&iter
);
281 DBG2("Trace UST event NOT found by name %s", event_name
);
282 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
287 uevent
= caa_container_of(node
, struct ltt_ust_event
, node
);
290 if (uevent
->enabled
== 0) {
291 /* It's already disabled so everything is OK */
295 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
296 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
297 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
302 DBG2("Event UST %s disabled in channel %s", uevent
->attr
.name
,
306 /* Get next duplicate event by name. */
307 cds_lfht_next_duplicate(ht
->ht
, trace_ust_ht_match_event_by_name
,
308 event_name
, &iter
.iter
);
309 node
= lttng_ht_iter_get_node_str(&iter
);
320 * Disable all UST tracepoints for a channel from a UST session.
322 int event_ust_disable_all_tracepoints(struct ltt_ust_session
*usess
,
323 struct ltt_ust_channel
*uchan
)
325 int ret
, i
, size
, error
= 0;
326 struct lttng_ht_iter iter
;
327 struct ltt_ust_event
*uevent
= NULL
;
328 struct lttng_event
*events
= NULL
;
335 /* Disabling existing events */
336 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
,
338 if (uevent
->enabled
== 1) {
339 ret
= event_ust_disable_tracepoint(usess
, uchan
,
342 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
348 /* Get all UST available events */
349 size
= ust_app_list_events(&events
);
351 ret
= LTTNG_ERR_UST_LIST_FAIL
;
355 for (i
= 0; i
< size
; i
++) {
356 ret
= event_ust_disable_tracepoint(usess
, uchan
,
359 /* Continue to disable the rest... */
360 error
= LTTNG_ERR_UST_DISABLE_FAIL
;
365 ret
= error
? error
: LTTNG_OK
;
373 * Enable all agent event for a given UST session.
375 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
377 int event_agent_enable_all(struct ltt_ust_session
*usess
,
378 struct agent
*agt
, struct lttng_event
*event
,
379 struct lttng_filter_bytecode
*filter
,char *filter_expression
)
382 struct agent_event
*aevent
;
383 struct lttng_ht_iter iter
;
387 DBG("Event agent enabling ALL events for session %" PRIu64
, usess
->id
);
389 /* Enable event on agent application through TCP socket. */
390 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
391 if (ret
!= LTTNG_OK
) {
395 /* Flag every event that they are now enabled. */
397 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
410 * Check if this event's filter requires the activation of application contexts
411 * and enable them in the agent.
412 * TODO: bytecode iterator does not support non-legacy application
413 * contexts yet. Not an issue for now, since they are not generated by
414 * the lttng-ctl library.
416 static int add_filter_app_ctx(struct lttng_filter_bytecode
*bytecode
,
417 const char *filter_expression
, struct agent
*agt
)
420 char *provider_name
= NULL
, *ctx_name
= NULL
;
421 struct bytecode_symbol_iterator
*it
=
422 bytecode_symbol_iterator_create(bytecode
);
425 ret
= LTTNG_ERR_NOMEM
;
430 struct lttng_event_context ctx
;
431 const char *symbol_name
=
432 bytecode_symbol_iterator_get_name(it
);
434 if (parse_application_context(symbol_name
, &provider_name
,
436 /* Not an application context. */
440 ctx
.ctx
= LTTNG_EVENT_CONTEXT_APP_CONTEXT
;
441 ctx
.u
.app_ctx
.provider_name
= provider_name
;
442 ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
444 /* Recognized an application context. */
445 DBG("Enabling event with filter expression \"%s\" requires enabling the %s:%s application context.",
446 filter_expression
, provider_name
, ctx_name
);
448 ret
= agent_add_context(&ctx
, agt
);
449 if (ret
!= LTTNG_OK
) {
450 ERR("Failed to add application context %s:%s.",
451 provider_name
, ctx_name
);
455 ret
= agent_enable_context(&ctx
, agt
->domain
);
456 if (ret
!= LTTNG_OK
) {
457 ERR("Failed to enable application context %s:%s.",
458 provider_name
, ctx_name
);
464 provider_name
= ctx_name
= NULL
;
465 } while (bytecode_symbol_iterator_next(it
) == 0);
469 bytecode_symbol_iterator_destroy(it
);
474 * Enable a single agent event for a given UST session.
476 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
478 int event_agent_enable(struct ltt_ust_session
*usess
,
479 struct agent
*agt
, struct lttng_event
*event
,
480 struct lttng_filter_bytecode
*filter
,
481 char *filter_expression
)
483 int ret
, created
= 0;
484 struct agent_event
*aevent
;
490 DBG("Event agent enabling %s for session %" PRIu64
" with loglevel type %d "
491 ", loglevel %d and filter \"%s\"", event
->name
,
492 usess
->id
, event
->loglevel_type
, event
->loglevel
,
493 filter_expression
? filter_expression
: "NULL");
495 aevent
= agent_find_event(event
->name
, event
->loglevel_type
,
496 event
->loglevel
, filter_expression
, agt
);
498 aevent
= agent_create_event(event
->name
, event
->loglevel_type
,
499 event
->loglevel
, filter
,
502 ret
= LTTNG_ERR_NOMEM
;
509 /* Already enabled? */
510 if (aevent
->enabled
) {
514 if (created
&& filter
) {
515 ret
= add_filter_app_ctx(filter
, filter_expression
, agt
);
516 if (ret
!= LTTNG_OK
) {
521 ret
= agent_enable_event(aevent
, agt
->domain
);
522 if (ret
!= LTTNG_OK
) {
526 /* If the event was created prior to the enable, add it to the domain. */
528 agent_add_event(aevent
, agt
);
536 agent_destroy_event(aevent
);
542 * Return the default event name associated with the provided UST domain. Return
545 const char *event_get_default_agent_ust_name(enum lttng_domain_type domain
)
547 const char *default_event_name
= NULL
;
550 case LTTNG_DOMAIN_LOG4J
:
551 default_event_name
= DEFAULT_LOG4J_EVENT_NAME
;
553 case LTTNG_DOMAIN_JUL
:
554 default_event_name
= DEFAULT_JUL_EVENT_NAME
;
556 case LTTNG_DOMAIN_PYTHON
:
557 default_event_name
= DEFAULT_PYTHON_EVENT_NAME
;
563 return default_event_name
;
567 * Disable a given agent event for a given UST session.
569 * Must be called with the RCU read lock held.
570 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
572 static int event_agent_disable_one(struct ltt_ust_session
*usess
,
573 struct agent
*agt
, struct agent_event
*aevent
)
576 struct ltt_ust_event
*uevent
= NULL
;
577 struct ltt_ust_channel
*uchan
= NULL
;
578 const char *ust_event_name
, *ust_channel_name
;
584 DBG("Event agent disabling %s (loglevel type %d, loglevel value %d) for session %" PRIu64
,
585 aevent
->name
, aevent
->loglevel_type
, aevent
->loglevel_value
,
588 /* Already disabled? */
589 if (!aevent
->enabled
) {
593 if (agt
->domain
== LTTNG_DOMAIN_JUL
) {
594 ust_channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
595 } else if (agt
->domain
== LTTNG_DOMAIN_LOG4J
) {
596 ust_channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
597 } else if (agt
->domain
== LTTNG_DOMAIN_PYTHON
) {
598 ust_channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
600 ret
= LTTNG_ERR_INVALID
;
605 * Disable it on the UST side. First get the channel reference then find
606 * the event and finally disable it.
608 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
609 (char *) ust_channel_name
);
611 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
615 ust_event_name
= event_get_default_agent_ust_name(agt
->domain
);
616 if (!ust_event_name
) {
617 ret
= LTTNG_ERR_FATAL
;
622 * Agent UST event has its loglevel type forced to
623 * LTTNG_UST_LOGLEVEL_ALL. The actual loglevel type/value filtering
624 * happens thanks to an UST filter. The following -1 is actually
625 * ignored since the type is LTTNG_UST_LOGLEVEL_ALL.
627 uevent
= trace_ust_find_event(uchan
->events
, (char *) ust_event_name
,
628 aevent
->filter
, LTTNG_UST_LOGLEVEL_ALL
, -1, NULL
);
629 /* If the agent event exists, it must be available on the UST side. */
632 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
633 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
634 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
639 * Flag event that it's disabled so the shadow copy on the ust app side
640 * will disable it if an application shows up.
644 ret
= agent_disable_event(aevent
, agt
->domain
);
645 if (ret
!= LTTNG_OK
) {
657 * Disable all agent events matching a given name for a given UST session.
659 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
661 int event_agent_disable(struct ltt_ust_session
*usess
, struct agent
*agt
,
665 struct agent_event
*aevent
;
666 struct lttng_ht_iter iter
;
667 struct lttng_ht_node_str
*node
;
673 DBG("Event agent disabling %s (all loglevels) for session %" PRIu64
, event_name
, usess
->id
);
676 agent_find_events_by_name(event_name
, agt
, &iter
);
677 node
= lttng_ht_iter_get_node_str(&iter
);
680 DBG2("Event agent NOT found by name %s", event_name
);
681 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
686 aevent
= caa_container_of(node
, struct agent_event
, node
);
687 ret
= event_agent_disable_one(usess
, agt
, aevent
);
689 if (ret
!= LTTNG_OK
) {
693 /* Get next duplicate agent event by name. */
694 agent_event_next_duplicate(event_name
, agt
, &iter
);
695 node
= lttng_ht_iter_get_node_str(&iter
);
702 * Disable all agent event for a given UST session.
704 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
706 int event_agent_disable_all(struct ltt_ust_session
*usess
,
710 struct agent_event
*aevent
;
711 struct lttng_ht_iter iter
;
717 * Disable event on agent application. Continue to disable all other events
718 * if the * event is not found.
720 ret
= event_agent_disable(usess
, agt
, "*");
721 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_NOT_FOUND
) {
725 /* Disable every event. */
727 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, aevent
,
729 if (!aevent
->enabled
) {
733 ret
= event_agent_disable(usess
, agt
, aevent
->name
);
734 if (ret
!= LTTNG_OK
) {