2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #include "bin/lttng-sessiond/tracker.h"
10 #include "lttng/lttng-error.h"
11 #include "lttng/tracker.h"
15 #include <urcu/list.h>
16 #include <urcu/uatomic.h>
20 #include <common/buffer-view.h>
21 #include <common/common.h>
22 #include <common/compat/string.h>
23 #include <common/defaults.h>
24 #include <common/dynamic-buffer.h>
25 #include <common/kernel-ctl/kernel-ctl.h>
26 #include <common/relayd/relayd.h>
27 #include <common/sessiond-comm/sessiond-comm.h>
28 #include <common/string-utils/string-utils.h>
29 #include <common/trace-chunk.h>
30 #include <common/utils.h>
31 #include <lttng/action/action.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/channel.h>
34 #include <lttng/condition/condition.h>
35 #include <lttng/event-internal.h>
36 #include <lttng/location-internal.h>
37 #include <lttng/rotate-internal.h>
38 #include <lttng/session-descriptor-internal.h>
39 #include <lttng/session-internal.h>
40 #include <lttng/trigger/trigger-internal.h>
41 #include <lttng/userspace-probe-internal.h>
46 #include "health-sessiond.h"
48 #include "kernel-consumer.h"
49 #include "lttng-sessiond.h"
51 #include "lttng-syscall.h"
53 #include "buffer-registry.h"
54 #include "notification-thread.h"
55 #include "notification-thread-commands.h"
57 #include "rotation-thread.h"
59 #include "agent-thread.h"
63 /* Sleep for 100ms between each check for the shm path's deletion. */
64 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
66 struct cmd_destroy_session_reply_context
{
68 bool implicit_rotation_on_destroy
;
70 * Indicates whether or not an error occurred while launching the
71 * destruction of a session.
73 enum lttng_error_code destruction_status
;
76 static enum lttng_error_code
wait_on_path(void *path
);
79 * Command completion handler that is used by the destroy command
80 * when a session that has a non-default shm_path is being destroyed.
82 * See comment in cmd_destroy_session() for the rationale.
84 static struct destroy_completion_handler
{
85 struct cmd_completion_handler handler
;
86 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
87 } destroy_completion_handler
= {
90 .data
= destroy_completion_handler
.shm_path
95 static struct cmd_completion_handler
*current_completion_handler
;
98 * Used to keep a unique index for each relayd socket created where this value
99 * is associated with streams on the consumer so it can match the right relayd
100 * to send to. It must be accessed with the relayd_net_seq_idx_lock
103 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
104 static uint64_t relayd_net_seq_idx
;
106 static int validate_ust_event_name(const char *);
107 static int cmd_enable_event_internal(struct ltt_session
*session
,
108 const struct lttng_domain
*domain
,
109 char *channel_name
, struct lttng_event
*event
,
110 char *filter_expression
,
111 struct lttng_filter_bytecode
*filter
,
112 struct lttng_event_exclusion
*exclusion
,
114 static int cmd_enable_channel_internal(struct ltt_session
*session
,
115 const struct lttng_domain
*domain
,
116 const struct lttng_channel
*_attr
,
120 * Create a session path used by list_lttng_sessions for the case that the
121 * session consumer is on the network.
123 static int build_network_session_path(char *dst
, size_t size
,
124 struct ltt_session
*session
)
126 int ret
, kdata_port
, udata_port
;
127 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
128 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
133 memset(tmp_urls
, 0, sizeof(tmp_urls
));
134 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
136 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
138 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
139 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
140 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
143 if (session
->ust_session
&& session
->ust_session
->consumer
) {
144 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
145 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
148 if (uuri
== NULL
&& kuri
== NULL
) {
149 uri
= &session
->consumer
->dst
.net
.control
;
150 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
151 } else if (kuri
&& uuri
) {
152 ret
= uri_compare(kuri
, uuri
);
156 /* Build uuri URL string */
157 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
164 } else if (kuri
&& uuri
== NULL
) {
166 } else if (uuri
&& kuri
== NULL
) {
170 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
176 * Do we have a UST url set. If yes, this means we have both kernel and UST
179 if (*tmp_uurl
!= '\0') {
180 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
181 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
184 if (kuri
|| (!kuri
&& !uuri
)) {
187 /* No kernel URI, use the UST port. */
190 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
198 * Get run-time attributes if the session has been started (discarded events,
201 static int get_kernel_runtime_stats(struct ltt_session
*session
,
202 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
203 uint64_t *lost_packets
)
207 if (!session
->has_been_started
) {
209 *discarded_events
= 0;
214 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
215 session
->kernel_session
->consumer
,
221 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
222 session
->kernel_session
->consumer
,
233 * Get run-time attributes if the session has been started (discarded events,
236 static int get_ust_runtime_stats(struct ltt_session
*session
,
237 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
238 uint64_t *lost_packets
)
241 struct ltt_ust_session
*usess
;
243 if (!discarded_events
|| !lost_packets
) {
248 usess
= session
->ust_session
;
249 assert(discarded_events
);
250 assert(lost_packets
);
252 if (!usess
|| !session
->has_been_started
) {
253 *discarded_events
= 0;
259 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
260 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
261 &usess
->buffer_reg_uid_list
,
262 usess
->consumer
, uchan
->id
,
263 uchan
->attr
.overwrite
,
266 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
267 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
268 uchan
, usess
->consumer
,
269 uchan
->attr
.overwrite
,
275 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
276 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
278 ERR("Unsupported buffer type");
289 * Create a list of agent domain events.
291 * Return number of events in list on success or else a negative value.
293 static enum lttng_error_code
list_lttng_agent_events(
294 struct agent
*agt
, struct lttng_dynamic_buffer
*buffer
,
295 unsigned int *nb_events
)
297 enum lttng_error_code ret_code
;
299 unsigned int local_nb_events
= 0;
300 struct agent_event
*event
;
301 struct lttng_ht_iter iter
;
307 DBG3("Listing agent events");
310 tmp
= lttng_ht_get_count(agt
->events
);
316 if (tmp
> UINT_MAX
) {
317 ret_code
= LTTNG_ERR_OVERFLOW
;
321 local_nb_events
= (unsigned int) tmp
;
323 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
324 struct lttng_event
*tmp
= lttng_event_create();
327 ret_code
= LTTNG_ERR_NOMEM
;
331 if(lttng_strncpy(tmp
->name
, event
->name
, sizeof(tmp
->name
))) {
332 lttng_event_destroy(tmp
);
333 ret_code
= LTTNG_ERR_FATAL
;
337 tmp
->name
[sizeof(tmp
->name
) - 1] = '\0';
338 tmp
->enabled
= event
->enabled
;
339 tmp
->loglevel
= event
->loglevel_value
;
340 tmp
->loglevel_type
= event
->loglevel_type
;
342 ret
= lttng_event_serialize(tmp
, 0, NULL
,
343 event
->filter_expression
, 0, NULL
, buffer
,
345 lttng_event_destroy(tmp
);
347 ret_code
= LTTNG_ERR_FATAL
;
354 *nb_events
= local_nb_events
;
361 * Create a list of ust global domain events.
363 static enum lttng_error_code
list_lttng_ust_global_events(char *channel_name
,
364 struct ltt_ust_domain_global
*ust_global
,
365 struct lttng_dynamic_buffer
*buffer
,
366 unsigned int *nb_events
)
368 enum lttng_error_code ret_code
;
370 struct lttng_ht_iter iter
;
371 struct lttng_ht_node_str
*node
;
372 struct ltt_ust_channel
*uchan
;
373 struct ltt_ust_event
*uevent
;
375 unsigned int local_nb_events
= 0;
376 char **exclusion_list
= NULL
;
382 DBG("Listing UST global events for channel %s", channel_name
);
386 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
387 node
= lttng_ht_iter_get_node_str(&iter
);
389 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
393 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
395 tmp
= lttng_ht_get_count(uchan
->events
);
402 if (tmp
> UINT_MAX
) {
403 ret_code
= LTTNG_ERR_OVERFLOW
;
407 local_nb_events
= (unsigned int) tmp
;
409 DBG3("Listing UST global %d events", *nb_events
);
411 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
412 struct lttng_event
*tmp
= NULL
;
414 if (uevent
->internal
) {
415 /* This event should remain hidden from clients */
420 /* Prepare exclusion list. */
421 if (uevent
->exclusion
&& uevent
->exclusion
->count
> 0) {
422 exclusion_list
= zmalloc(sizeof(char *) * uevent
->exclusion
->count
);
423 if (!exclusion_list
) {
426 for (i
= 0; i
< uevent
->exclusion
->count
; i
++) {
427 exclusion_list
[i
] = (char *) &(uevent
->exclusion
->names
[i
]);
431 tmp
= lttng_event_create();
433 ret_code
= LTTNG_ERR_NOMEM
;
437 if (lttng_strncpy(tmp
->name
, uevent
->attr
.name
,
438 LTTNG_SYMBOL_NAME_LEN
)) {
439 ret_code
= LTTNG_ERR_FATAL
;
440 lttng_event_destroy(tmp
);
444 tmp
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
445 tmp
->enabled
= uevent
->enabled
;
447 switch (uevent
->attr
.instrumentation
) {
448 case LTTNG_UST_TRACEPOINT
:
449 tmp
->type
= LTTNG_EVENT_TRACEPOINT
;
451 case LTTNG_UST_PROBE
:
452 tmp
->type
= LTTNG_EVENT_PROBE
;
454 case LTTNG_UST_FUNCTION
:
455 tmp
->type
= LTTNG_EVENT_FUNCTION
;
459 tmp
->loglevel
= uevent
->attr
.loglevel
;
460 switch (uevent
->attr
.loglevel_type
) {
461 case LTTNG_UST_LOGLEVEL_ALL
:
462 tmp
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
464 case LTTNG_UST_LOGLEVEL_RANGE
:
465 tmp
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
467 case LTTNG_UST_LOGLEVEL_SINGLE
:
468 tmp
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
471 if (uevent
->filter
) {
474 if (uevent
->exclusion
) {
479 * We do not care about the filter bytecode and the fd from the
480 * userspace_probe_location.
482 ret
= lttng_event_serialize(tmp
,
483 exclusion_list
? uevent
->exclusion
->count
: 0,
484 exclusion_list
, uevent
->filter_expression
, 0,
486 lttng_event_destroy(tmp
);
487 free(exclusion_list
);
488 exclusion_list
= NULL
;
490 ret_code
= LTTNG_ERR_FATAL
;
496 /* nb_events is already set at this point. */
498 *nb_events
= local_nb_events
;
500 free(exclusion_list
);
506 * Fill lttng_event array of all kernel events in the channel.
508 static enum lttng_error_code
list_lttng_kernel_events(char *channel_name
,
509 struct ltt_kernel_session
*kernel_session
,
510 struct lttng_dynamic_buffer
*payload
,
511 unsigned int *nb_events
)
513 enum lttng_error_code ret_code
;
515 struct ltt_kernel_event
*event
;
516 struct ltt_kernel_channel
*kchan
;
520 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
522 ret_code
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
526 *nb_events
= kchan
->event_count
;
528 DBG("Listing events for channel %s", kchan
->channel
->name
);
530 if (*nb_events
== 0) {
535 /* Kernel channels */
536 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
537 struct lttng_event
*tmp
= lttng_event_create();
540 ret_code
= LTTNG_ERR_NOMEM
;
544 if (lttng_strncpy(tmp
->name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
)) {
545 lttng_event_destroy(tmp
);
546 ret_code
= LTTNG_ERR_FATAL
;
551 tmp
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
552 tmp
->enabled
= event
->enabled
;
553 tmp
->filter
= (unsigned char) !!event
->filter_expression
;
555 switch (event
->event
->instrumentation
) {
556 case LTTNG_KERNEL_TRACEPOINT
:
557 tmp
->type
= LTTNG_EVENT_TRACEPOINT
;
559 case LTTNG_KERNEL_KRETPROBE
:
560 tmp
->type
= LTTNG_EVENT_FUNCTION
;
561 memcpy(&tmp
->attr
.probe
, &event
->event
->u
.kprobe
,
562 sizeof(struct lttng_kernel_kprobe
));
564 case LTTNG_KERNEL_KPROBE
:
565 tmp
->type
= LTTNG_EVENT_PROBE
;
566 memcpy(&tmp
->attr
.probe
, &event
->event
->u
.kprobe
,
567 sizeof(struct lttng_kernel_kprobe
));
569 case LTTNG_KERNEL_UPROBE
:
570 tmp
->type
= LTTNG_EVENT_USERSPACE_PROBE
;
572 case LTTNG_KERNEL_FUNCTION
:
573 tmp
->type
= LTTNG_EVENT_FUNCTION
;
574 memcpy(&(tmp
->attr
.ftrace
), &event
->event
->u
.ftrace
,
575 sizeof(struct lttng_kernel_function
));
577 case LTTNG_KERNEL_NOOP
:
578 tmp
->type
= LTTNG_EVENT_NOOP
;
580 case LTTNG_KERNEL_SYSCALL
:
581 tmp
->type
= LTTNG_EVENT_SYSCALL
;
583 case LTTNG_KERNEL_ALL
:
590 if (event
->userspace_probe_location
) {
591 struct lttng_userspace_probe_location
*location_copy
=
592 lttng_userspace_probe_location_copy(
593 event
->userspace_probe_location
);
594 if (!location_copy
) {
595 lttng_event_destroy(tmp
);
596 ret_code
= LTTNG_ERR_NOMEM
;
599 ret
= lttng_event_set_userspace_probe_location(
602 lttng_event_destroy(tmp
);
603 lttng_userspace_probe_location_destroy(
605 ret_code
= LTTNG_ERR_INVALID
;
610 ret
= lttng_event_serialize(tmp
, 0, NULL
,
611 event
->filter_expression
, 0, NULL
, payload
,
613 lttng_event_destroy(tmp
);
615 ret_code
= LTTNG_ERR_FATAL
;
626 * Add URI so the consumer output object. Set the correct path depending on the
627 * domain adding the default trace directory.
629 static enum lttng_error_code
add_uri_to_consumer(
630 const struct ltt_session
*session
,
631 struct consumer_output
*consumer
,
632 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
635 enum lttng_error_code ret_code
= LTTNG_OK
;
639 if (consumer
== NULL
) {
640 DBG("No consumer detected. Don't add URI. Stopping.");
641 ret_code
= LTTNG_ERR_NO_CONSUMER
;
646 case LTTNG_DOMAIN_KERNEL
:
647 ret
= lttng_strncpy(consumer
->domain_subdir
,
648 DEFAULT_KERNEL_TRACE_DIR
,
649 sizeof(consumer
->domain_subdir
));
651 case LTTNG_DOMAIN_UST
:
652 ret
= lttng_strncpy(consumer
->domain_subdir
,
653 DEFAULT_UST_TRACE_DIR
,
654 sizeof(consumer
->domain_subdir
));
658 * This case is possible is we try to add the URI to the global
659 * tracing session consumer object which in this case there is
662 memset(consumer
->domain_subdir
, 0,
663 sizeof(consumer
->domain_subdir
));
667 ERR("Failed to initialize consumer output domain subdirectory");
668 ret_code
= LTTNG_ERR_FATAL
;
672 switch (uri
->dtype
) {
675 DBG2("Setting network URI to consumer");
677 if (consumer
->type
== CONSUMER_DST_NET
) {
678 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
679 consumer
->dst
.net
.control_isset
) ||
680 (uri
->stype
== LTTNG_STREAM_DATA
&&
681 consumer
->dst
.net
.data_isset
)) {
682 ret_code
= LTTNG_ERR_URL_EXIST
;
686 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
689 /* Set URI into consumer output object */
690 ret
= consumer_set_network_uri(session
, consumer
, uri
);
694 } else if (ret
== 1) {
696 * URI was the same in the consumer so we do not append the subdir
697 * again so to not duplicate output dir.
704 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
705 ret_code
= LTTNG_ERR_INVALID
;
708 DBG2("Setting trace directory path from URI to %s",
710 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
712 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
714 sizeof(consumer
->dst
.session_root_path
));
716 ret_code
= LTTNG_ERR_FATAL
;
719 consumer
->type
= CONSUMER_DST_LOCAL
;
729 * Init tracing by creating trace directory and sending fds kernel consumer.
731 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
734 struct lttng_ht_iter iter
;
735 struct consumer_socket
*socket
;
741 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
742 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
744 pthread_mutex_lock(socket
->lock
);
745 ret
= kernel_consumer_send_session(socket
, session
);
746 pthread_mutex_unlock(socket
->lock
);
748 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
760 * Create a socket to the relayd using the URI.
762 * On success, the relayd_sock pointer is set to the created socket.
763 * Else, it remains untouched and an LTTng error code is returned.
765 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
766 struct lttcomm_relayd_sock
**relayd_sock
,
767 struct consumer_output
*consumer
)
770 enum lttng_error_code status
= LTTNG_OK
;
771 struct lttcomm_relayd_sock
*rsock
;
773 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
774 RELAYD_VERSION_COMM_MINOR
);
776 status
= LTTNG_ERR_FATAL
;
781 * Connect to relayd so we can proceed with a session creation. This call
782 * can possibly block for an arbitrary amount of time to set the health
783 * state to be in poll execution.
786 ret
= relayd_connect(rsock
);
789 ERR("Unable to reach lttng-relayd");
790 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
794 /* Create socket for control stream. */
795 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
796 uint64_t result_flags
;
798 DBG3("Creating relayd stream socket from URI");
800 /* Check relayd version */
801 ret
= relayd_version_check(rsock
);
802 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
803 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
805 } else if (ret
< 0) {
806 ERR("Unable to reach lttng-relayd");
807 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
810 consumer
->relay_major_version
= rsock
->major
;
811 consumer
->relay_minor_version
= rsock
->minor
;
812 ret
= relayd_get_configuration(rsock
, 0,
815 ERR("Unable to get relayd configuration");
816 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
819 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
820 consumer
->relay_allows_clear
= true;
822 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
823 DBG3("Creating relayd data socket from URI");
825 /* Command is not valid */
826 ERR("Relayd invalid stream type: %d", uri
->stype
);
827 status
= LTTNG_ERR_INVALID
;
831 *relayd_sock
= rsock
;
836 /* The returned value is not useful since we are on an error path. */
837 (void) relayd_close(rsock
);
845 * Connect to the relayd using URI and send the socket to the right consumer.
847 * The consumer socket lock must be held by the caller.
849 * Returns LTTNG_OK on success or an LTTng error code on failure.
851 static enum lttng_error_code
send_consumer_relayd_socket(
852 unsigned int session_id
,
853 struct lttng_uri
*relayd_uri
,
854 struct consumer_output
*consumer
,
855 struct consumer_socket
*consumer_sock
,
856 const char *session_name
, const char *hostname
,
857 const char *base_path
, int session_live_timer
,
858 const uint64_t *current_chunk_id
,
859 time_t session_creation_time
,
860 bool session_name_contains_creation_time
)
863 struct lttcomm_relayd_sock
*rsock
= NULL
;
864 enum lttng_error_code status
;
866 /* Connect to relayd and make version check if uri is the control. */
867 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
868 if (status
!= LTTNG_OK
) {
869 goto relayd_comm_error
;
873 /* Set the network sequence index if not set. */
874 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
875 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
877 * Increment net_seq_idx because we are about to transfer the
878 * new relayd socket to the consumer.
879 * Assign unique key so the consumer can match streams.
881 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
882 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
885 /* Send relayd socket to consumer. */
886 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
887 relayd_uri
->stype
, session_id
,
888 session_name
, hostname
, base_path
,
889 session_live_timer
, current_chunk_id
,
890 session_creation_time
, session_name_contains_creation_time
);
892 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
896 /* Flag that the corresponding socket was sent. */
897 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
898 consumer_sock
->control_sock_sent
= 1;
899 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
900 consumer_sock
->data_sock_sent
= 1;
904 * Close socket which was dup on the consumer side. The session daemon does
905 * NOT keep track of the relayd socket(s) once transfer to the consumer.
909 if (status
!= LTTNG_OK
) {
911 * The consumer output for this session should not be used anymore
912 * since the relayd connection failed thus making any tracing or/and
913 * streaming not usable.
915 consumer
->enabled
= 0;
917 (void) relayd_close(rsock
);
925 * Send both relayd sockets to a specific consumer and domain. This is a
926 * helper function to facilitate sending the information to the consumer for a
929 * The consumer socket lock must be held by the caller.
931 * Returns LTTNG_OK, or an LTTng error code on failure.
933 static enum lttng_error_code
send_consumer_relayd_sockets(
934 enum lttng_domain_type domain
,
935 unsigned int session_id
, struct consumer_output
*consumer
,
936 struct consumer_socket
*sock
, const char *session_name
,
937 const char *hostname
, const char *base_path
, int session_live_timer
,
938 const uint64_t *current_chunk_id
, time_t session_creation_time
,
939 bool session_name_contains_creation_time
)
941 enum lttng_error_code status
= LTTNG_OK
;
946 /* Sending control relayd socket. */
947 if (!sock
->control_sock_sent
) {
948 status
= send_consumer_relayd_socket(session_id
,
949 &consumer
->dst
.net
.control
, consumer
, sock
,
950 session_name
, hostname
, base_path
, session_live_timer
,
951 current_chunk_id
, session_creation_time
,
952 session_name_contains_creation_time
);
953 if (status
!= LTTNG_OK
) {
958 /* Sending data relayd socket. */
959 if (!sock
->data_sock_sent
) {
960 status
= send_consumer_relayd_socket(session_id
,
961 &consumer
->dst
.net
.data
, consumer
, sock
,
962 session_name
, hostname
, base_path
, session_live_timer
,
963 current_chunk_id
, session_creation_time
,
964 session_name_contains_creation_time
);
965 if (status
!= LTTNG_OK
) {
975 * Setup relayd connections for a tracing session. First creates the socket to
976 * the relayd and send them to the right domain consumer. Consumer type MUST be
979 int cmd_setup_relayd(struct ltt_session
*session
)
982 struct ltt_ust_session
*usess
;
983 struct ltt_kernel_session
*ksess
;
984 struct consumer_socket
*socket
;
985 struct lttng_ht_iter iter
;
986 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
990 usess
= session
->ust_session
;
991 ksess
= session
->kernel_session
;
993 DBG("Setting relayd for session %s", session
->name
);
996 if (session
->current_trace_chunk
) {
997 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
998 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1000 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1001 current_chunk_id
.is_set
= true;
1003 ERR("Failed to get current trace chunk id");
1004 ret
= LTTNG_ERR_UNK
;
1009 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1010 && usess
->consumer
->enabled
) {
1011 /* For each consumer socket, send relayd sockets */
1012 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1013 socket
, node
.node
) {
1014 pthread_mutex_lock(socket
->lock
);
1015 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1016 usess
->consumer
, socket
,
1017 session
->name
, session
->hostname
,
1019 session
->live_timer
,
1020 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1021 session
->creation_time
,
1022 session
->name_contains_creation_time
);
1023 pthread_mutex_unlock(socket
->lock
);
1024 if (ret
!= LTTNG_OK
) {
1027 /* Session is now ready for network streaming. */
1028 session
->net_handle
= 1;
1030 session
->consumer
->relay_major_version
=
1031 usess
->consumer
->relay_major_version
;
1032 session
->consumer
->relay_minor_version
=
1033 usess
->consumer
->relay_minor_version
;
1034 session
->consumer
->relay_allows_clear
=
1035 usess
->consumer
->relay_allows_clear
;
1038 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1039 && ksess
->consumer
->enabled
) {
1040 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1041 socket
, node
.node
) {
1042 pthread_mutex_lock(socket
->lock
);
1043 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1044 ksess
->consumer
, socket
,
1045 session
->name
, session
->hostname
,
1047 session
->live_timer
,
1048 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1049 session
->creation_time
,
1050 session
->name_contains_creation_time
);
1051 pthread_mutex_unlock(socket
->lock
);
1052 if (ret
!= LTTNG_OK
) {
1055 /* Session is now ready for network streaming. */
1056 session
->net_handle
= 1;
1058 session
->consumer
->relay_major_version
=
1059 ksess
->consumer
->relay_major_version
;
1060 session
->consumer
->relay_minor_version
=
1061 ksess
->consumer
->relay_minor_version
;
1062 session
->consumer
->relay_allows_clear
=
1063 ksess
->consumer
->relay_allows_clear
;
1072 * Start a kernel session by opening all necessary streams.
1074 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1077 struct ltt_kernel_channel
*kchan
;
1079 /* Open kernel metadata */
1080 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1081 ret
= kernel_open_metadata(ksess
);
1083 ret
= LTTNG_ERR_KERN_META_FAIL
;
1088 /* Open kernel metadata stream */
1089 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1090 ret
= kernel_open_metadata_stream(ksess
);
1092 ERR("Kernel create metadata stream failed");
1093 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1098 /* For each channel */
1099 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1100 if (kchan
->stream_count
== 0) {
1101 ret
= kernel_open_channel_stream(kchan
);
1103 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1106 /* Update the stream global counter */
1107 ksess
->stream_count_global
+= ret
;
1111 /* Setup kernel consumer socket and send fds to it */
1112 ret
= init_kernel_tracing(ksess
);
1114 ret
= LTTNG_ERR_KERN_START_FAIL
;
1118 /* This start the kernel tracing */
1119 ret
= kernel_start_session(ksess
);
1121 ret
= LTTNG_ERR_KERN_START_FAIL
;
1125 /* Quiescent wait after starting trace */
1126 kernel_wait_quiescent();
1136 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1138 struct ltt_kernel_channel
*kchan
;
1139 bool error_occurred
= false;
1142 if (!ksess
|| !ksess
->active
) {
1145 DBG("Stopping kernel tracing");
1147 ret
= kernel_stop_session(ksess
);
1149 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1153 kernel_wait_quiescent();
1155 /* Flush metadata after stopping (if exists) */
1156 if (ksess
->metadata_stream_fd
>= 0) {
1157 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1159 ERR("Kernel metadata flush failed");
1160 error_occurred
= true;
1164 /* Flush all buffers after stopping */
1165 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1166 ret
= kernel_flush_buffer(kchan
);
1168 ERR("Kernel flush buffer error");
1169 error_occurred
= true;
1174 if (error_occurred
) {
1175 ret
= LTTNG_ERR_UNK
;
1184 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1186 int cmd_disable_channel(struct ltt_session
*session
,
1187 enum lttng_domain_type domain
, char *channel_name
)
1190 struct ltt_ust_session
*usess
;
1192 usess
= session
->ust_session
;
1197 case LTTNG_DOMAIN_KERNEL
:
1199 ret
= channel_kernel_disable(session
->kernel_session
,
1201 if (ret
!= LTTNG_OK
) {
1205 kernel_wait_quiescent();
1208 case LTTNG_DOMAIN_UST
:
1210 struct ltt_ust_channel
*uchan
;
1211 struct lttng_ht
*chan_ht
;
1213 chan_ht
= usess
->domain_global
.channels
;
1215 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1216 if (uchan
== NULL
) {
1217 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1221 ret
= channel_ust_disable(usess
, uchan
);
1222 if (ret
!= LTTNG_OK
) {
1228 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1240 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1242 * The wpipe arguments is used as a notifier for the kernel thread.
1244 int cmd_enable_channel(struct command_ctx
*cmd_ctx
, int sock
, int wpipe
)
1248 ssize_t sock_recv_len
;
1249 struct lttng_channel
*channel
= NULL
;
1250 struct lttng_buffer_view view
;
1251 struct lttng_dynamic_buffer channel_buffer
;
1253 lttng_dynamic_buffer_init(&channel_buffer
);
1254 channel_len
= (size_t) cmd_ctx
->lsm
->u
.channel
.length
;
1255 ret
= lttng_dynamic_buffer_set_size(&channel_buffer
, channel_len
);
1257 ret
= LTTNG_ERR_NOMEM
;
1261 sock_recv_len
= lttcomm_recv_unix_sock(sock
, channel_buffer
.data
,
1263 if (sock_recv_len
< 0 || sock_recv_len
!= channel_len
) {
1264 ERR("Failed to receive \"enable channel\" command payload");
1265 ret
= LTTNG_ERR_INVALID
;
1269 view
= lttng_buffer_view_from_dynamic_buffer(&channel_buffer
, 0, channel_len
);
1270 if (!lttng_buffer_view_is_valid(&view
)) {
1271 ret
= LTTNG_ERR_INVALID
;
1275 if (lttng_channel_create_from_buffer(&view
, &channel
) != channel_len
) {
1276 ERR("Invalid channel payload received in \"enable channel\" command");
1277 ret
= LTTNG_ERR_INVALID
;
1281 ret
= cmd_enable_channel_internal(cmd_ctx
->session
,
1282 ALIGNED_CONST_PTR(cmd_ctx
->lsm
->domain
), channel
,
1286 lttng_dynamic_buffer_reset(&channel_buffer
);
1287 lttng_channel_destroy(channel
);
1291 static int cmd_enable_channel_internal(struct ltt_session
*session
,
1292 const struct lttng_domain
*domain
,
1293 const struct lttng_channel
*_attr
,
1297 struct ltt_ust_session
*usess
= session
->ust_session
;
1298 struct lttng_ht
*chan_ht
;
1300 struct lttng_channel
*attr
= NULL
;
1306 attr
= lttng_channel_copy(_attr
);
1308 ret
= -LTTNG_ERR_NOMEM
;
1312 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1314 /* Validate channel name */
1315 if (attr
->name
[0] == '.' ||
1316 memchr(attr
->name
, '/', len
) != NULL
) {
1317 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1321 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1326 * If the session is a live session, remove the switch timer, the
1327 * live timer does the same thing but sends also synchronisation
1328 * beacons for inactive streams.
1330 if (session
->live_timer
> 0) {
1331 attr
->attr
.live_timer_interval
= session
->live_timer
;
1332 attr
->attr
.switch_timer_interval
= 0;
1335 /* Check for feature support */
1336 switch (domain
->type
) {
1337 case LTTNG_DOMAIN_KERNEL
:
1339 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1340 /* Sampling position of buffer is not supported */
1341 WARN("Kernel tracer does not support buffer monitoring. "
1342 "Setting the monitor interval timer to 0 "
1343 "(disabled) for channel '%s' of session '%s'",
1344 attr
->name
, session
->name
);
1345 lttng_channel_set_monitor_timer_interval(attr
, 0);
1349 case LTTNG_DOMAIN_UST
:
1351 case LTTNG_DOMAIN_JUL
:
1352 case LTTNG_DOMAIN_LOG4J
:
1353 case LTTNG_DOMAIN_PYTHON
:
1354 if (!agent_tracing_is_enabled()) {
1355 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1356 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1361 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1365 switch (domain
->type
) {
1366 case LTTNG_DOMAIN_KERNEL
:
1368 struct ltt_kernel_channel
*kchan
;
1370 kchan
= trace_kernel_get_channel_by_name(
1371 attr
->name
, session
->kernel_session
);
1372 if (kchan
== NULL
) {
1374 * Don't try to create a channel if the session has been started at
1375 * some point in time before. The tracer does not allow it.
1377 if (session
->has_been_started
) {
1378 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1382 if (session
->snapshot
.nb_output
> 0 ||
1383 session
->snapshot_mode
) {
1384 /* Enforce mmap output for snapshot sessions. */
1385 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1387 ret
= channel_kernel_create(
1388 session
->kernel_session
, attr
, wpipe
);
1389 if (attr
->name
[0] != '\0') {
1390 session
->kernel_session
->has_non_default_channel
= 1;
1393 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1396 if (ret
!= LTTNG_OK
) {
1400 kernel_wait_quiescent();
1403 case LTTNG_DOMAIN_UST
:
1404 case LTTNG_DOMAIN_JUL
:
1405 case LTTNG_DOMAIN_LOG4J
:
1406 case LTTNG_DOMAIN_PYTHON
:
1408 struct ltt_ust_channel
*uchan
;
1413 * Current agent implementation limitations force us to allow
1414 * only one channel at once in "agent" subdomains. Each
1415 * subdomain has a default channel name which must be strictly
1418 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1419 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1420 LTTNG_SYMBOL_NAME_LEN
)) {
1421 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1424 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1425 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1426 LTTNG_SYMBOL_NAME_LEN
)) {
1427 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1430 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1431 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1432 LTTNG_SYMBOL_NAME_LEN
)) {
1433 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1438 chan_ht
= usess
->domain_global
.channels
;
1440 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1441 if (uchan
== NULL
) {
1443 * Don't try to create a channel if the session has been started at
1444 * some point in time before. The tracer does not allow it.
1446 if (session
->has_been_started
) {
1447 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1451 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1452 if (attr
->name
[0] != '\0') {
1453 usess
->has_non_default_channel
= 1;
1456 ret
= channel_ust_enable(usess
, uchan
);
1461 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1465 if (ret
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1466 session
->has_non_mmap_channel
= true;
1471 lttng_channel_destroy(attr
);
1475 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1476 struct ltt_session
*session
,
1477 enum lttng_domain_type domain
,
1478 enum lttng_process_attr process_attr
,
1479 enum lttng_tracking_policy
*policy
)
1481 enum lttng_error_code ret_code
= LTTNG_OK
;
1482 const struct process_attr_tracker
*tracker
;
1485 case LTTNG_DOMAIN_KERNEL
:
1486 if (!session
->kernel_session
) {
1487 ret_code
= LTTNG_ERR_INVALID
;
1490 tracker
= kernel_get_process_attr_tracker(
1491 session
->kernel_session
, process_attr
);
1493 case LTTNG_DOMAIN_UST
:
1494 if (!session
->ust_session
) {
1495 ret_code
= LTTNG_ERR_INVALID
;
1498 tracker
= trace_ust_get_process_attr_tracker(
1499 session
->ust_session
, process_attr
);
1502 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1506 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1508 ret_code
= LTTNG_ERR_INVALID
;
1514 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1515 struct ltt_session
*session
,
1516 enum lttng_domain_type domain
,
1517 enum lttng_process_attr process_attr
,
1518 enum lttng_tracking_policy policy
)
1520 enum lttng_error_code ret_code
= LTTNG_OK
;
1523 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1524 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1525 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1528 ret_code
= LTTNG_ERR_INVALID
;
1533 case LTTNG_DOMAIN_KERNEL
:
1534 if (!session
->kernel_session
) {
1535 ret_code
= LTTNG_ERR_INVALID
;
1538 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1539 session
->kernel_session
, process_attr
, policy
);
1541 case LTTNG_DOMAIN_UST
:
1542 if (!session
->ust_session
) {
1543 ret_code
= LTTNG_ERR_INVALID
;
1546 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1547 session
->ust_session
, process_attr
, policy
);
1550 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1557 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1558 struct ltt_session
*session
,
1559 enum lttng_domain_type domain
,
1560 enum lttng_process_attr process_attr
,
1561 const struct process_attr_value
*value
)
1563 enum lttng_error_code ret_code
= LTTNG_OK
;
1566 case LTTNG_DOMAIN_KERNEL
:
1567 if (!session
->kernel_session
) {
1568 ret_code
= LTTNG_ERR_INVALID
;
1571 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1572 session
->kernel_session
, process_attr
, value
);
1574 case LTTNG_DOMAIN_UST
:
1575 if (!session
->ust_session
) {
1576 ret_code
= LTTNG_ERR_INVALID
;
1579 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1580 session
->ust_session
, process_attr
, value
);
1583 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1590 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1591 struct ltt_session
*session
,
1592 enum lttng_domain_type domain
,
1593 enum lttng_process_attr process_attr
,
1594 const struct process_attr_value
*value
)
1596 enum lttng_error_code ret_code
= LTTNG_OK
;
1599 case LTTNG_DOMAIN_KERNEL
:
1600 if (!session
->kernel_session
) {
1601 ret_code
= LTTNG_ERR_INVALID
;
1604 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1605 session
->kernel_session
, process_attr
, value
);
1607 case LTTNG_DOMAIN_UST
:
1608 if (!session
->ust_session
) {
1609 ret_code
= LTTNG_ERR_INVALID
;
1612 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1613 session
->ust_session
, process_attr
, value
);
1616 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1623 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1624 struct ltt_session
*session
,
1625 enum lttng_domain_type domain
,
1626 enum lttng_process_attr process_attr
,
1627 struct lttng_process_attr_values
**values
)
1629 enum lttng_error_code ret_code
= LTTNG_OK
;
1630 const struct process_attr_tracker
*tracker
;
1631 enum process_attr_tracker_status status
;
1634 case LTTNG_DOMAIN_KERNEL
:
1635 if (!session
->kernel_session
) {
1636 ret_code
= LTTNG_ERR_INVALID
;
1639 tracker
= kernel_get_process_attr_tracker(
1640 session
->kernel_session
, process_attr
);
1642 case LTTNG_DOMAIN_UST
:
1643 if (!session
->ust_session
) {
1644 ret_code
= LTTNG_ERR_INVALID
;
1647 tracker
= trace_ust_get_process_attr_tracker(
1648 session
->ust_session
, process_attr
);
1651 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1656 ret_code
= LTTNG_ERR_INVALID
;
1660 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1662 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1663 ret_code
= LTTNG_OK
;
1665 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1666 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1668 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1669 ret_code
= LTTNG_ERR_NOMEM
;
1672 ret_code
= LTTNG_ERR_UNK
;
1681 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1683 int cmd_disable_event(struct command_ctx
*cmd_ctx
, int sock
)
1687 const char *event_name
;
1688 ssize_t sock_recv_len
;
1689 struct lttng_event
*event
= NULL
;
1690 struct lttng_buffer_view view
;
1691 struct lttng_dynamic_buffer event_buffer
;
1692 struct lttng_event_exclusion
*exclusion
= NULL
;
1693 struct lttng_filter_bytecode
*bytecode
= NULL
;
1694 char *filter_expression
= NULL
;
1695 unsigned int exclusion_count
;
1696 const struct ltt_session
*session
= cmd_ctx
->session
;
1697 const char *channel_name
= cmd_ctx
->lsm
->u
.disable
.channel_name
;
1698 enum lttng_domain_type domain
= cmd_ctx
->lsm
->domain
.type
;
1700 lttng_dynamic_buffer_init(&event_buffer
);
1701 event_len
= (size_t) cmd_ctx
->lsm
->u
.disable
.length
;
1702 ret
= lttng_dynamic_buffer_set_size(&event_buffer
, event_len
);
1704 ret
= LTTNG_ERR_NOMEM
;
1708 sock_recv_len
= lttcomm_recv_unix_sock(
1709 sock
, event_buffer
.data
, event_len
);
1710 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
1711 ERR("Failed to receive \"disable event\" command payload");
1712 ret
= LTTNG_ERR_INVALID
;
1716 view
= lttng_buffer_view_from_dynamic_buffer(&event_buffer
, 0, -1);
1718 if (lttng_event_create_from_buffer(&view
, &event
,
1719 &exclusion
, &filter_expression
,
1720 &bytecode
, sock
) != event_len
) {
1721 ERR("Invalid event payload received in \"disable event\" command");
1722 ret
= LTTNG_ERR_INVALID
;
1726 DBG("Disable event command for event \'%s\'", event
->name
);
1729 * Filter and exclusions are simply not handled by the
1730 * disable event command at this time.
1734 (void) filter_expression
;
1736 (void) exclusion_count
;
1738 /* Ignore the presence of filter or exclusion for the event */
1740 event
->exclusion
= 0;
1742 event_name
= event
->name
;
1744 /* Error out on unhandled search criteria */
1745 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1746 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1747 ret
= LTTNG_ERR_UNK
;
1754 case LTTNG_DOMAIN_KERNEL
:
1756 struct ltt_kernel_channel
*kchan
;
1757 struct ltt_kernel_session
*ksess
;
1759 ksess
= session
->kernel_session
;
1762 * If a non-default channel has been created in the
1763 * session, explicitely require that -c chan_name needs
1766 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1767 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1771 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1772 if (kchan
== NULL
) {
1773 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1777 switch (event
->type
) {
1778 case LTTNG_EVENT_ALL
:
1779 case LTTNG_EVENT_TRACEPOINT
:
1780 case LTTNG_EVENT_SYSCALL
:
1781 case LTTNG_EVENT_PROBE
:
1782 case LTTNG_EVENT_FUNCTION
:
1783 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1784 if (event_name
[0] == '\0') {
1785 ret
= event_kernel_disable_event(kchan
,
1788 ret
= event_kernel_disable_event(kchan
,
1789 event_name
, event
->type
);
1791 if (ret
!= LTTNG_OK
) {
1796 ret
= LTTNG_ERR_UNK
;
1800 kernel_wait_quiescent();
1803 case LTTNG_DOMAIN_UST
:
1805 struct ltt_ust_channel
*uchan
;
1806 struct ltt_ust_session
*usess
;
1808 usess
= session
->ust_session
;
1810 if (validate_ust_event_name(event_name
)) {
1811 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1816 * If a non-default channel has been created in the
1817 * session, explicitly require that -c chan_name needs
1820 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1821 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1825 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1827 if (uchan
== NULL
) {
1828 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1832 switch (event
->type
) {
1833 case LTTNG_EVENT_ALL
:
1835 * An empty event name means that everything
1836 * should be disabled.
1838 if (event
->name
[0] == '\0') {
1839 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1841 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1844 if (ret
!= LTTNG_OK
) {
1849 ret
= LTTNG_ERR_UNK
;
1853 DBG3("Disable UST event %s in channel %s completed", event_name
,
1857 case LTTNG_DOMAIN_LOG4J
:
1858 case LTTNG_DOMAIN_JUL
:
1859 case LTTNG_DOMAIN_PYTHON
:
1862 struct ltt_ust_session
*usess
= session
->ust_session
;
1866 switch (event
->type
) {
1867 case LTTNG_EVENT_ALL
:
1870 ret
= LTTNG_ERR_UNK
;
1874 agt
= trace_ust_find_agent(usess
, domain
);
1876 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1880 * An empty event name means that everything
1881 * should be disabled.
1883 if (event
->name
[0] == '\0') {
1884 ret
= event_agent_disable_all(usess
, agt
);
1886 ret
= event_agent_disable(usess
, agt
, event_name
);
1888 if (ret
!= LTTNG_OK
) {
1895 ret
= LTTNG_ERR_UND
;
1906 free(filter_expression
);
1907 lttng_event_destroy(event
);
1908 lttng_dynamic_buffer_reset(&event_buffer
);
1914 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1917 int cmd_add_context(struct command_ctx
*cmd_ctx
, int sock
, int kwpipe
)
1919 struct lttng_event_context
*ctx
= NULL
;
1920 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1921 struct lttng_dynamic_buffer buffer
;
1922 struct lttng_buffer_view view
;
1924 ssize_t sock_recv_len
;
1925 enum lttng_domain_type domain
= cmd_ctx
->lsm
->domain
.type
;
1926 struct ltt_session
*session
= cmd_ctx
->session
;
1927 const char *channel_name
= cmd_ctx
->lsm
->u
.context
.channel_name
;
1929 lttng_dynamic_buffer_init(&buffer
);
1931 context_len
= (size_t) cmd_ctx
->lsm
->u
.context
.length
;
1932 ret
= lttng_dynamic_buffer_set_size(&buffer
, context_len
);
1934 ret
= LTTNG_ERR_NOMEM
;
1938 sock_recv_len
= lttcomm_recv_unix_sock(sock
, buffer
.data
, context_len
);
1939 if (sock_recv_len
< 0 || sock_recv_len
!= context_len
) {
1940 ERR("Failed to receive \"add context\" command payload");
1941 ret
= LTTNG_ERR_INVALID
;
1945 view
= lttng_buffer_view_from_dynamic_buffer(&buffer
, 0, -1);
1947 if (lttng_event_context_create_from_buffer(&view
, &ctx
) !=
1949 ERR("Invalid event context payload received in \"add context\" command");
1950 ret
= LTTNG_ERR_INVALID
;
1955 * Don't try to add a context if the session has been started at
1956 * some point in time before. The tracer does not allow it and would
1957 * result in a corrupted trace.
1959 if (cmd_ctx
->session
->has_been_started
) {
1960 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1965 case LTTNG_DOMAIN_KERNEL
:
1966 assert(session
->kernel_session
);
1968 if (session
->kernel_session
->channel_count
== 0) {
1969 /* Create default channel */
1970 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1971 if (ret
!= LTTNG_OK
) {
1974 chan_kern_created
= 1;
1976 /* Add kernel context to kernel tracer */
1977 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1978 if (ret
!= LTTNG_OK
) {
1982 case LTTNG_DOMAIN_JUL
:
1983 case LTTNG_DOMAIN_LOG4J
:
1986 * Validate channel name.
1987 * If no channel name is given and the domain is JUL or LOG4J,
1988 * set it to the appropriate domain-specific channel name. If
1989 * a name is provided but does not match the expexted channel
1990 * name, return an error.
1992 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1993 strcmp(channel_name
,
1994 DEFAULT_JUL_CHANNEL_NAME
)) {
1995 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1997 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1998 strcmp(channel_name
,
1999 DEFAULT_LOG4J_CHANNEL_NAME
)) {
2000 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2003 /* break is _not_ missing here. */
2005 case LTTNG_DOMAIN_UST
:
2007 struct ltt_ust_session
*usess
= session
->ust_session
;
2008 unsigned int chan_count
;
2012 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
2013 if (chan_count
== 0) {
2014 struct lttng_channel
*attr
;
2015 /* Create default channel */
2016 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
2018 ret
= LTTNG_ERR_FATAL
;
2022 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
2023 if (ret
!= LTTNG_OK
) {
2027 channel_attr_destroy(attr
);
2028 chan_ust_created
= 1;
2031 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
2032 if (ret
!= LTTNG_OK
) {
2038 ret
= LTTNG_ERR_UND
;
2046 if (chan_kern_created
) {
2047 struct ltt_kernel_channel
*kchan
=
2048 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2049 session
->kernel_session
);
2050 /* Created previously, this should NOT fail. */
2052 kernel_destroy_channel(kchan
);
2055 if (chan_ust_created
) {
2056 struct ltt_ust_channel
*uchan
=
2057 trace_ust_find_channel_by_name(
2058 session
->ust_session
->domain_global
.channels
,
2059 DEFAULT_CHANNEL_NAME
);
2060 /* Created previously, this should NOT fail. */
2062 /* Remove from the channel list of the session. */
2063 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2065 trace_ust_destroy_channel(uchan
);
2068 lttng_event_context_destroy(ctx
);
2072 static inline bool name_starts_with(const char *name
, const char *prefix
)
2074 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2076 return !strncmp(name
, prefix
, max_cmp_len
);
2079 /* Perform userspace-specific event name validation */
2080 static int validate_ust_event_name(const char *name
)
2090 * Check name against all internal UST event component namespaces used
2093 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2094 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2095 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2104 * Internal version of cmd_enable_event() with a supplemental
2105 * "internal_event" flag which is used to enable internal events which should
2106 * be hidden from clients. Such events are used in the agent implementation to
2107 * enable the events through which all "agent" events are funeled.
2109 static int _cmd_enable_event(struct ltt_session
*session
,
2110 const struct lttng_domain
*domain
,
2111 char *channel_name
, struct lttng_event
*event
,
2112 char *filter_expression
,
2113 struct lttng_filter_bytecode
*filter
,
2114 struct lttng_event_exclusion
*exclusion
,
2115 int wpipe
, bool internal_event
)
2117 int ret
= 0, channel_created
= 0;
2118 struct lttng_channel
*attr
= NULL
;
2122 assert(channel_name
);
2124 /* If we have a filter, we must have its filter expression */
2125 assert(!(!!filter_expression
^ !!filter
));
2127 /* Normalize event name as a globbing pattern */
2128 strutils_normalize_star_glob_pattern(event
->name
);
2130 /* Normalize exclusion names as globbing patterns */
2134 for (i
= 0; i
< exclusion
->count
; i
++) {
2135 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2137 strutils_normalize_star_glob_pattern(name
);
2141 DBG("Enable event command for event \'%s\'", event
->name
);
2145 switch (domain
->type
) {
2146 case LTTNG_DOMAIN_KERNEL
:
2148 struct ltt_kernel_channel
*kchan
;
2151 * If a non-default channel has been created in the
2152 * session, explicitely require that -c chan_name needs
2155 if (session
->kernel_session
->has_non_default_channel
2156 && channel_name
[0] == '\0') {
2157 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2161 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2162 session
->kernel_session
);
2163 if (kchan
== NULL
) {
2164 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2165 LTTNG_BUFFER_GLOBAL
);
2167 ret
= LTTNG_ERR_FATAL
;
2170 if (lttng_strncpy(attr
->name
, channel_name
,
2171 sizeof(attr
->name
))) {
2172 ret
= LTTNG_ERR_INVALID
;
2176 ret
= cmd_enable_channel_internal(
2177 session
, domain
, attr
, wpipe
);
2178 if (ret
!= LTTNG_OK
) {
2181 channel_created
= 1;
2184 /* Get the newly created kernel channel pointer */
2185 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2186 session
->kernel_session
);
2187 if (kchan
== NULL
) {
2188 /* This sould not happen... */
2189 ret
= LTTNG_ERR_FATAL
;
2193 switch (event
->type
) {
2194 case LTTNG_EVENT_ALL
:
2196 char *filter_expression_a
= NULL
;
2197 struct lttng_filter_bytecode
*filter_a
= NULL
;
2200 * We need to duplicate filter_expression and filter,
2201 * because ownership is passed to first enable
2204 if (filter_expression
) {
2205 filter_expression_a
= strdup(filter_expression
);
2206 if (!filter_expression_a
) {
2207 ret
= LTTNG_ERR_FATAL
;
2212 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2214 free(filter_expression_a
);
2215 ret
= LTTNG_ERR_FATAL
;
2218 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2220 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2221 ret
= event_kernel_enable_event(kchan
, event
,
2222 filter_expression
, filter
);
2223 /* We have passed ownership */
2224 filter_expression
= NULL
;
2226 if (ret
!= LTTNG_OK
) {
2227 if (channel_created
) {
2228 /* Let's not leak a useless channel. */
2229 kernel_destroy_channel(kchan
);
2231 free(filter_expression_a
);
2235 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2236 ret
= event_kernel_enable_event(kchan
, event
,
2237 filter_expression_a
, filter_a
);
2238 /* We have passed ownership */
2239 filter_expression_a
= NULL
;
2241 if (ret
!= LTTNG_OK
) {
2246 case LTTNG_EVENT_PROBE
:
2247 case LTTNG_EVENT_USERSPACE_PROBE
:
2248 case LTTNG_EVENT_FUNCTION
:
2249 case LTTNG_EVENT_FUNCTION_ENTRY
:
2250 case LTTNG_EVENT_TRACEPOINT
:
2251 ret
= event_kernel_enable_event(kchan
, event
,
2252 filter_expression
, filter
);
2253 /* We have passed ownership */
2254 filter_expression
= NULL
;
2256 if (ret
!= LTTNG_OK
) {
2257 if (channel_created
) {
2258 /* Let's not leak a useless channel. */
2259 kernel_destroy_channel(kchan
);
2264 case LTTNG_EVENT_SYSCALL
:
2265 ret
= event_kernel_enable_event(kchan
, event
,
2266 filter_expression
, filter
);
2267 /* We have passed ownership */
2268 filter_expression
= NULL
;
2270 if (ret
!= LTTNG_OK
) {
2275 ret
= LTTNG_ERR_UNK
;
2279 kernel_wait_quiescent();
2282 case LTTNG_DOMAIN_UST
:
2284 struct ltt_ust_channel
*uchan
;
2285 struct ltt_ust_session
*usess
= session
->ust_session
;
2290 * If a non-default channel has been created in the
2291 * session, explicitely require that -c chan_name needs
2294 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2295 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2299 /* Get channel from global UST domain */
2300 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2302 if (uchan
== NULL
) {
2303 /* Create default channel */
2304 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2305 usess
->buffer_type
);
2307 ret
= LTTNG_ERR_FATAL
;
2310 if (lttng_strncpy(attr
->name
, channel_name
,
2311 sizeof(attr
->name
))) {
2312 ret
= LTTNG_ERR_INVALID
;
2316 ret
= cmd_enable_channel_internal(
2317 session
, domain
, attr
, wpipe
);
2318 if (ret
!= LTTNG_OK
) {
2322 /* Get the newly created channel reference back */
2323 uchan
= trace_ust_find_channel_by_name(
2324 usess
->domain_global
.channels
, channel_name
);
2328 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2330 * Don't allow users to add UST events to channels which
2331 * are assigned to a userspace subdomain (JUL, Log4J,
2334 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2338 if (!internal_event
) {
2340 * Ensure the event name is not reserved for internal
2343 ret
= validate_ust_event_name(event
->name
);
2345 WARN("Userspace event name %s failed validation.",
2347 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2352 /* At this point, the session and channel exist on the tracer */
2353 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2354 filter_expression
, filter
, exclusion
,
2356 /* We have passed ownership */
2357 filter_expression
= NULL
;
2360 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2361 goto already_enabled
;
2362 } else if (ret
!= LTTNG_OK
) {
2367 case LTTNG_DOMAIN_LOG4J
:
2368 case LTTNG_DOMAIN_JUL
:
2369 case LTTNG_DOMAIN_PYTHON
:
2371 const char *default_event_name
, *default_chan_name
;
2373 struct lttng_event uevent
;
2374 struct lttng_domain tmp_dom
;
2375 struct ltt_ust_session
*usess
= session
->ust_session
;
2379 if (!agent_tracing_is_enabled()) {
2380 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2381 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2385 agt
= trace_ust_find_agent(usess
, domain
->type
);
2387 agt
= agent_create(domain
->type
);
2389 ret
= LTTNG_ERR_NOMEM
;
2392 agent_add(agt
, usess
->agents
);
2395 /* Create the default tracepoint. */
2396 memset(&uevent
, 0, sizeof(uevent
));
2397 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2398 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2399 default_event_name
= event_get_default_agent_ust_name(
2401 if (!default_event_name
) {
2402 ret
= LTTNG_ERR_FATAL
;
2405 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2406 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2409 * The domain type is changed because we are about to enable the
2410 * default channel and event for the JUL domain that are hardcoded.
2411 * This happens in the UST domain.
2413 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2414 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2416 switch (domain
->type
) {
2417 case LTTNG_DOMAIN_LOG4J
:
2418 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2420 case LTTNG_DOMAIN_JUL
:
2421 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2423 case LTTNG_DOMAIN_PYTHON
:
2424 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2427 /* The switch/case we are in makes this impossible */
2432 char *filter_expression_copy
= NULL
;
2433 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2436 const size_t filter_size
= sizeof(
2437 struct lttng_filter_bytecode
)
2440 filter_copy
= zmalloc(filter_size
);
2442 ret
= LTTNG_ERR_NOMEM
;
2445 memcpy(filter_copy
, filter
, filter_size
);
2447 filter_expression_copy
=
2448 strdup(filter_expression
);
2449 if (!filter_expression
) {
2450 ret
= LTTNG_ERR_NOMEM
;
2453 if (!filter_expression_copy
|| !filter_copy
) {
2454 free(filter_expression_copy
);
2460 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2461 (char *) default_chan_name
,
2462 &uevent
, filter_expression_copy
,
2463 filter_copy
, NULL
, wpipe
);
2466 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2467 goto already_enabled
;
2468 } else if (ret
!= LTTNG_OK
) {
2472 /* The wild card * means that everything should be enabled. */
2473 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2474 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2477 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2481 filter_expression
= NULL
;
2482 if (ret
!= LTTNG_OK
) {
2489 ret
= LTTNG_ERR_UND
;
2497 free(filter_expression
);
2500 channel_attr_destroy(attr
);
2506 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2507 * We own filter, exclusion, and filter_expression.
2509 int cmd_enable_event(struct command_ctx
*cmd_ctx
, int sock
, int wpipe
)
2513 ssize_t sock_recv_len
;
2514 struct lttng_event
*event
= NULL
;
2515 struct lttng_buffer_view view
;
2516 struct lttng_dynamic_buffer event_buffer
;
2517 struct lttng_event_exclusion
*exclusion
= NULL
;
2518 struct lttng_filter_bytecode
*bytecode
= NULL
;
2519 char *filter_expression
= NULL
;
2521 lttng_dynamic_buffer_init(&event_buffer
);
2522 event_len
= (size_t) cmd_ctx
->lsm
->u
.enable
.length
;
2523 ret
= lttng_dynamic_buffer_set_size(&event_buffer
, event_len
);
2525 ret
= LTTNG_ERR_NOMEM
;
2529 sock_recv_len
= lttcomm_recv_unix_sock(
2530 sock
, event_buffer
.data
, event_len
);
2531 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
2532 ERR("Failed to receive \"enable event\" command payload");
2533 ret
= LTTNG_ERR_INVALID
;
2537 view
= lttng_buffer_view_from_dynamic_buffer(&event_buffer
, 0, -1);
2539 if (lttng_event_create_from_buffer(&view
, &event
,
2540 &exclusion
, &filter_expression
,
2541 &bytecode
, sock
) != event_len
) {
2542 ERR("Invalid event payload received in \"enable event\" command");
2543 ret
= LTTNG_ERR_INVALID
;
2548 * The ownership of the following parameters is transferred to
2549 * _cmd_enable_event:
2551 * - filter_expression,
2555 ret
= _cmd_enable_event(cmd_ctx
->session
,
2556 ALIGNED_CONST_PTR(cmd_ctx
->lsm
->domain
),
2557 cmd_ctx
->lsm
->u
.enable
.channel_name
, event
,
2558 filter_expression
, bytecode
, exclusion
, wpipe
, false);
2559 filter_expression
= NULL
;
2563 lttng_event_destroy(event
);
2564 lttng_dynamic_buffer_reset(&event_buffer
);
2569 * Enable an event which is internal to LTTng. An internal should
2570 * never be made visible to clients and are immune to checks such as
2573 static int cmd_enable_event_internal(struct ltt_session
*session
,
2574 const struct lttng_domain
*domain
,
2575 char *channel_name
, struct lttng_event
*event
,
2576 char *filter_expression
,
2577 struct lttng_filter_bytecode
*filter
,
2578 struct lttng_event_exclusion
*exclusion
,
2581 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2582 filter_expression
, filter
, exclusion
, wpipe
, true);
2586 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2588 enum lttng_error_code
cmd_list_tracepoints(enum lttng_domain_type domain
,
2589 struct lttng_dynamic_buffer
*buffer
, unsigned int *nb_tracepoints
)
2591 enum lttng_error_code ret_code
;
2593 ssize_t i
, nb_events
= 0;
2594 struct lttng_event
*events
= NULL
;
2597 assert(nb_tracepoints
);
2600 case LTTNG_DOMAIN_KERNEL
:
2601 nb_events
= kernel_list_events(&events
);
2602 if (nb_events
< 0) {
2603 ret_code
= LTTNG_ERR_KERN_LIST_FAIL
;
2607 case LTTNG_DOMAIN_UST
:
2608 nb_events
= ust_app_list_events(&events
);
2609 if (nb_events
< 0) {
2610 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2614 case LTTNG_DOMAIN_LOG4J
:
2615 case LTTNG_DOMAIN_JUL
:
2616 case LTTNG_DOMAIN_PYTHON
:
2617 nb_events
= agent_list_events(&events
, domain
);
2618 if (nb_events
< 0) {
2619 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2624 ret_code
= LTTNG_ERR_UND
;
2629 for (i
= 0; i
< nb_events
; i
++) {
2630 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2633 ret_code
= LTTNG_ERR_NOMEM
;
2638 if (nb_events
> UINT_MAX
) {
2639 ret_code
= LTTNG_ERR_OVERFLOW
;
2643 *nb_tracepoints
= (unsigned int) nb_events
;
2644 ret_code
= LTTNG_OK
;
2651 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2653 enum lttng_error_code
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2654 struct lttng_dynamic_buffer
*buffer
, unsigned int *nb_fields
)
2656 enum lttng_error_code ret_code
;
2659 struct lttng_event_field
*fields
= NULL
;
2662 case LTTNG_DOMAIN_UST
:
2663 ret
= ust_app_list_event_fields(&fields
);
2665 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2669 case LTTNG_DOMAIN_KERNEL
:
2670 default: /* fall-through */
2671 ret_code
= LTTNG_ERR_UND
;
2677 for (i
= 0; i
< *nb_fields
; i
++) {
2678 ret
= lttng_event_field_serialize(&fields
[i
], buffer
);
2680 ret_code
= -LTTNG_ERR_NOMEM
;
2685 ret_code
= LTTNG_OK
;
2692 enum lttng_error_code
cmd_list_syscalls(
2693 struct lttng_dynamic_buffer
*buffer
, unsigned int *nb_syscalls
)
2695 enum lttng_error_code ret_code
;
2696 ssize_t nb_events
, i
;
2698 struct lttng_event
*events
= NULL
;
2701 assert(nb_syscalls
);
2703 nb_events
= syscall_table_list(&events
);
2704 if (nb_events
< 0) {
2705 ret_code
= (enum lttng_error_code
) -nb_events
;
2709 for (i
= 0; i
< nb_events
; i
++) {
2710 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2713 ret_code
= LTTNG_ERR_NOMEM
;
2718 if (nb_events
> UINT_MAX
) {
2719 ret_code
= LTTNG_ERR_OVERFLOW
;
2723 *nb_syscalls
= (uint32_t) nb_events
;
2724 ret_code
= LTTNG_OK
;
2731 * Command LTTNG_START_TRACE processed by the client thread.
2733 * Called with session mutex held.
2735 int cmd_start_trace(struct ltt_session
*session
)
2737 enum lttng_error_code ret
;
2738 unsigned long nb_chan
= 0;
2739 struct ltt_kernel_session
*ksession
;
2740 struct ltt_ust_session
*usess
;
2741 const bool session_rotated_after_last_stop
=
2742 session
->rotated_after_last_stop
;
2743 const bool session_cleared_after_last_stop
=
2744 session
->cleared_after_last_stop
;
2748 /* Ease our life a bit ;) */
2749 ksession
= session
->kernel_session
;
2750 usess
= session
->ust_session
;
2752 /* Is the session already started? */
2753 if (session
->active
) {
2754 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2755 /* Perform nothing */
2759 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2760 !session
->current_trace_chunk
) {
2762 * A rotation was launched while the session was stopped and
2763 * it has not been completed yet. It is not possible to start
2764 * the session since starting the session here would require a
2765 * rotation from "NULL" to a new trace chunk. That rotation
2766 * would overlap with the ongoing rotation, which is not
2769 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2771 ret
= LTTNG_ERR_ROTATION_PENDING
;
2776 * Starting a session without channel is useless since after that it's not
2777 * possible to enable channel thus inform the client.
2779 if (usess
&& usess
->domain_global
.channels
) {
2780 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2783 nb_chan
+= ksession
->channel_count
;
2786 ret
= LTTNG_ERR_NO_CHANNEL
;
2790 session
->active
= 1;
2791 session
->rotated_after_last_stop
= false;
2792 session
->cleared_after_last_stop
= false;
2793 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2794 if (!session
->has_been_started
) {
2795 struct lttng_trace_chunk
*trace_chunk
;
2797 DBG("Creating initial trace chunk of session \"%s\"",
2799 trace_chunk
= session_create_new_trace_chunk(
2800 session
, NULL
, NULL
, NULL
);
2802 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2805 assert(!session
->current_trace_chunk
);
2806 ret
= session_set_trace_chunk(session
, trace_chunk
,
2808 lttng_trace_chunk_put(trace_chunk
);
2810 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2814 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2817 * Rotate existing streams into the new chunk.
2818 * This is a "quiet" rotation has no client has
2819 * explicitly requested this operation.
2821 * There is also no need to wait for the rotation
2822 * to complete as it will happen immediately. No data
2823 * was produced as the session was stopped, so the
2824 * rotation should happen on reception of the command.
2826 ret
= cmd_rotate_session(session
, NULL
, true,
2827 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2828 if (ret
!= LTTNG_OK
) {
2834 /* Kernel tracing */
2835 if (ksession
!= NULL
) {
2836 DBG("Start kernel tracing session %s", session
->name
);
2837 ret
= start_kernel_session(ksession
);
2838 if (ret
!= LTTNG_OK
) {
2843 /* Flag session that trace should start automatically */
2845 int int_ret
= ust_app_start_trace_all(usess
);
2848 ret
= LTTNG_ERR_UST_START_FAIL
;
2854 * Open a packet in every stream of the session to ensure that viewers
2855 * can correctly identify the boundaries of the periods during which
2856 * tracing was active for this session.
2858 ret
= session_open_packets(session
);
2859 if (ret
!= LTTNG_OK
) {
2864 * Clear the flag that indicates that a rotation was done while the
2865 * session was stopped.
2867 session
->rotated_after_last_stop
= false;
2869 if (session
->rotate_timer_period
) {
2870 int int_ret
= timer_session_rotation_schedule_timer_start(
2871 session
, session
->rotate_timer_period
);
2874 ERR("Failed to enable rotate timer");
2875 ret
= LTTNG_ERR_UNK
;
2883 if (ret
== LTTNG_OK
) {
2884 /* Flag this after a successful start. */
2885 session
->has_been_started
|= 1;
2887 session
->active
= 0;
2888 /* Restore initial state on error. */
2889 session
->rotated_after_last_stop
=
2890 session_rotated_after_last_stop
;
2891 session
->cleared_after_last_stop
=
2892 session_cleared_after_last_stop
;
2899 * Command LTTNG_STOP_TRACE processed by the client thread.
2901 int cmd_stop_trace(struct ltt_session
*session
)
2904 struct ltt_kernel_session
*ksession
;
2905 struct ltt_ust_session
*usess
;
2909 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2911 ksession
= session
->kernel_session
;
2912 usess
= session
->ust_session
;
2914 /* Session is not active. Skip everythong and inform the client. */
2915 if (!session
->active
) {
2916 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2920 ret
= stop_kernel_session(ksession
);
2921 if (ret
!= LTTNG_OK
) {
2925 if (usess
&& usess
->active
) {
2926 ret
= ust_app_stop_trace_all(usess
);
2928 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2933 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2935 /* Flag inactive after a successful stop. */
2936 session
->active
= 0;
2944 * Set the base_path of the session only if subdir of a control uris is set.
2945 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2947 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2949 struct lttng_uri
*uris
)
2954 for (i
= 0; i
< nb_uri
; i
++) {
2955 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2956 uris
[i
].subdir
[0] == '\0') {
2957 /* Not interested in these URIs */
2961 if (session
->base_path
!= NULL
) {
2962 free(session
->base_path
);
2963 session
->base_path
= NULL
;
2966 /* Set session base_path */
2967 session
->base_path
= strdup(uris
[i
].subdir
);
2968 if (!session
->base_path
) {
2969 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2970 uris
[i
].subdir
, session
->name
);
2971 ret
= LTTNG_ERR_NOMEM
;
2974 DBG2("Setting base path \"%s\" for session \"%s\"",
2975 session
->base_path
, session
->name
);
2983 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2985 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2986 struct lttng_uri
*uris
)
2989 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2990 struct ltt_ust_session
*usess
= session
->ust_session
;
2996 /* Can't set consumer URI if the session is active. */
2997 if (session
->active
) {
2998 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
3003 * Set the session base path if any. This is done inside
3004 * cmd_set_consumer_uri to preserve backward compatibility of the
3005 * previous session creation api vs the session descriptor api.
3007 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
3008 if (ret
!= LTTNG_OK
) {
3012 /* Set the "global" consumer URIs */
3013 for (i
= 0; i
< nb_uri
; i
++) {
3014 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
3016 if (ret
!= LTTNG_OK
) {
3021 /* Set UST session URIs */
3022 if (session
->ust_session
) {
3023 for (i
= 0; i
< nb_uri
; i
++) {
3024 ret
= add_uri_to_consumer(session
,
3025 session
->ust_session
->consumer
,
3026 &uris
[i
], LTTNG_DOMAIN_UST
);
3027 if (ret
!= LTTNG_OK
) {
3033 /* Set kernel session URIs */
3034 if (session
->kernel_session
) {
3035 for (i
= 0; i
< nb_uri
; i
++) {
3036 ret
= add_uri_to_consumer(session
,
3037 session
->kernel_session
->consumer
,
3038 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
3039 if (ret
!= LTTNG_OK
) {
3046 * Make sure to set the session in output mode after we set URI since a
3047 * session can be created without URL (thus flagged in no output mode).
3049 session
->output_traces
= 1;
3051 ksess
->output_traces
= 1;
3055 usess
->output_traces
= 1;
3066 enum lttng_error_code
set_session_output_from_descriptor(
3067 struct ltt_session
*session
,
3068 const struct lttng_session_descriptor
*descriptor
)
3071 enum lttng_error_code ret_code
= LTTNG_OK
;
3072 enum lttng_session_descriptor_type session_type
=
3073 lttng_session_descriptor_get_type(descriptor
);
3074 enum lttng_session_descriptor_output_type output_type
=
3075 lttng_session_descriptor_get_output_type(descriptor
);
3076 struct lttng_uri uris
[2] = {};
3077 size_t uri_count
= 0;
3079 switch (output_type
) {
3080 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3082 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3083 lttng_session_descriptor_get_local_output_uri(descriptor
,
3087 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3088 lttng_session_descriptor_get_network_output_uris(descriptor
,
3089 &uris
[0], &uris
[1]);
3093 ret_code
= LTTNG_ERR_INVALID
;
3097 switch (session_type
) {
3098 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3100 struct snapshot_output
*new_output
= NULL
;
3102 new_output
= snapshot_output_alloc();
3104 ret_code
= LTTNG_ERR_NOMEM
;
3108 ret
= snapshot_output_init_with_uri(session
,
3109 DEFAULT_SNAPSHOT_MAX_SIZE
,
3110 NULL
, uris
, uri_count
, session
->consumer
,
3111 new_output
, &session
->snapshot
);
3113 ret_code
= (ret
== -ENOMEM
) ?
3114 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3115 snapshot_output_destroy(new_output
);
3118 snapshot_add_output(&session
->snapshot
, new_output
);
3121 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3122 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3124 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3128 ret_code
= LTTNG_ERR_INVALID
;
3136 enum lttng_error_code
cmd_create_session_from_descriptor(
3137 struct lttng_session_descriptor
*descriptor
,
3138 const lttng_sock_cred
*creds
,
3139 const char *home_path
)
3142 enum lttng_error_code ret_code
;
3143 const char *session_name
;
3144 struct ltt_session
*new_session
= NULL
;
3145 enum lttng_session_descriptor_status descriptor_status
;
3147 session_lock_list();
3149 if (*home_path
!= '/') {
3150 ERR("Home path provided by client is not absolute");
3151 ret_code
= LTTNG_ERR_INVALID
;
3156 descriptor_status
= lttng_session_descriptor_get_session_name(
3157 descriptor
, &session_name
);
3158 switch (descriptor_status
) {
3159 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3161 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3162 session_name
= NULL
;
3165 ret_code
= LTTNG_ERR_INVALID
;
3169 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3171 if (ret_code
!= LTTNG_OK
) {
3175 if (!session_name
) {
3176 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3179 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3184 if (!lttng_session_descriptor_is_output_destination_initialized(
3187 * Only include the session's creation time in the output
3188 * destination if the name of the session itself was
3189 * not auto-generated.
3191 ret_code
= lttng_session_descriptor_set_default_output(
3193 session_name
? &new_session
->creation_time
: NULL
,
3195 if (ret_code
!= LTTNG_OK
) {
3199 new_session
->has_user_specified_directory
=
3200 lttng_session_descriptor_has_output_directory(
3204 switch (lttng_session_descriptor_get_type(descriptor
)) {
3205 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3206 new_session
->snapshot_mode
= 1;
3208 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3209 new_session
->live_timer
=
3210 lttng_session_descriptor_live_get_timer_interval(
3217 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3218 if (ret_code
!= LTTNG_OK
) {
3221 new_session
->consumer
->enabled
= 1;
3222 ret_code
= LTTNG_OK
;
3224 /* Release reference provided by the session_create function. */
3225 session_put(new_session
);
3226 if (ret_code
!= LTTNG_OK
&& new_session
) {
3227 /* Release the global reference on error. */
3228 session_destroy(new_session
);
3230 session_unlock_list();
3234 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3235 struct lttng_session_descriptor
**return_descriptor
)
3238 size_t payload_size
;
3239 struct lttng_dynamic_buffer payload
;
3240 struct lttng_buffer_view home_dir_view
;
3241 struct lttng_buffer_view session_descriptor_view
;
3242 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3243 enum lttng_error_code ret_code
;
3245 lttng_dynamic_buffer_init(&payload
);
3246 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3248 ret_code
= LTTNG_ERR_INVALID
;
3251 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3252 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3253 ret_code
= LTTNG_ERR_INVALID
;
3257 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3258 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3259 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3261 ret_code
= LTTNG_ERR_NOMEM
;
3265 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3267 ERR("Reception of session descriptor failed, aborting.");
3268 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3272 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3275 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3276 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3278 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3279 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3281 ret
= lttng_session_descriptor_create_from_buffer(
3282 &session_descriptor_view
, &session_descriptor
);
3284 ERR("Failed to create session descriptor from payload of \"create session\" command");
3285 ret_code
= LTTNG_ERR_INVALID
;
3290 * Sets the descriptor's auto-generated properties (name, output) if
3293 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3295 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3296 if (ret_code
!= LTTNG_OK
) {
3300 ret_code
= LTTNG_OK
;
3301 *return_descriptor
= session_descriptor
;
3302 session_descriptor
= NULL
;
3304 lttng_dynamic_buffer_reset(&payload
);
3305 lttng_session_descriptor_destroy(session_descriptor
);
3310 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3311 void *_reply_context
)
3315 const struct cmd_destroy_session_reply_context
*reply_context
=
3317 struct lttng_dynamic_buffer payload
;
3318 struct lttcomm_session_destroy_command_header cmd_header
;
3319 struct lttng_trace_archive_location
*location
= NULL
;
3320 struct lttcomm_lttng_msg llm
= {
3321 .cmd_type
= LTTNG_DESTROY_SESSION
,
3322 .ret_code
= reply_context
->destruction_status
,
3325 sizeof(struct lttcomm_session_destroy_command_header
),
3328 size_t payload_size_before_location
;
3330 lttng_dynamic_buffer_init(&payload
);
3332 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3334 ERR("Failed to append session destruction message");
3338 cmd_header
.rotation_state
=
3339 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3340 session
->rotation_state
:
3341 LTTNG_ROTATION_STATE_NO_ROTATION
);
3342 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3343 sizeof(cmd_header
));
3345 ERR("Failed to append session destruction command header");
3349 if (!reply_context
->implicit_rotation_on_destroy
) {
3350 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3354 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3355 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3360 location
= session_get_trace_archive_location(session
);
3362 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3367 payload_size_before_location
= payload
.size
;
3368 comm_ret
= lttng_trace_archive_location_serialize(location
,
3370 lttng_trace_archive_location_put(location
);
3372 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3376 /* Update the message to indicate the location's length. */
3377 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3378 payload
.size
- payload_size_before_location
;
3380 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3381 payload
.data
, payload
.size
);
3382 if (comm_ret
!= (ssize_t
) payload
.size
) {
3383 ERR("Failed to send result of the destruction of session \"%s\" to client",
3387 ret
= close(reply_context
->reply_sock_fd
);
3389 PERROR("Failed to close client socket in deferred session destroy reply");
3391 lttng_dynamic_buffer_reset(&payload
);
3392 free(_reply_context
);
3396 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3398 * Called with session lock held.
3400 int cmd_destroy_session(struct ltt_session
*session
,
3401 struct notification_thread_handle
*notification_thread_handle
,
3405 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3406 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3409 reply_context
= zmalloc(sizeof(*reply_context
));
3410 if (!reply_context
) {
3411 ret
= LTTNG_ERR_NOMEM
;
3414 reply_context
->reply_sock_fd
= *sock_fd
;
3420 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3422 if (session
->active
) {
3423 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3425 ret
= cmd_stop_trace(session
);
3426 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3427 /* Carry on with the destruction of the session. */
3428 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3429 session
->name
, lttng_strerror(-ret
));
3430 destruction_last_error
= ret
;
3434 if (session
->rotation_schedule_timer_enabled
) {
3435 if (timer_session_rotation_schedule_timer_stop(
3437 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3439 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3443 if (session
->rotate_size
) {
3444 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3445 session
->rotate_size
= 0;
3448 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3450 * Perform a last rotation on destruction if rotations have
3451 * occurred during the session's lifetime.
3453 ret
= cmd_rotate_session(session
, NULL
, false,
3454 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3455 if (ret
!= LTTNG_OK
) {
3456 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3457 session
->name
, lttng_strerror(-ret
));
3458 destruction_last_error
= -ret
;
3460 if (reply_context
) {
3461 reply_context
->implicit_rotation_on_destroy
= true;
3463 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3465 * The user has not triggered a session rotation. However, to
3466 * ensure all data has been consumed, the session is rotated
3467 * to a 'null' trace chunk before it is destroyed.
3469 * This is a "quiet" rotation meaning that no notification is
3470 * emitted and no renaming of the current trace chunk takes
3473 ret
= cmd_rotate_session(session
, NULL
, true,
3474 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3476 * Rotation operations may not be supported by the kernel
3477 * tracer. Hence, do not consider this implicit rotation as
3478 * a session destruction error. The library has already stopped
3479 * the session and waited for pending data; there is nothing
3480 * left to do but complete the destruction of the session.
3482 if (ret
!= LTTNG_OK
&&
3483 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3484 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3485 session
->name
, lttng_strerror(ret
));
3486 destruction_last_error
= -ret
;
3490 if (session
->shm_path
[0]) {
3492 * When a session is created with an explicit shm_path,
3493 * the consumer daemon will create its shared memory files
3494 * at that location and will *not* unlink them. This is normal
3495 * as the intention of that feature is to make it possible
3496 * to retrieve the content of those files should a crash occur.
3498 * To ensure the content of those files can be used, the
3499 * sessiond daemon will replicate the content of the metadata
3500 * cache in a metadata file.
3502 * On clean-up, it is expected that the consumer daemon will
3503 * unlink the shared memory files and that the session daemon
3504 * will unlink the metadata file. Then, the session's directory
3505 * in the shm path can be removed.
3507 * Unfortunately, a flaw in the design of the sessiond's and
3508 * consumerd's tear down of channels makes it impossible to
3509 * determine when the sessiond _and_ the consumerd have both
3510 * destroyed their representation of a channel. For one, the
3511 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3512 * callbacks in both daemons.
3514 * However, it is also impossible for the sessiond to know when
3515 * the consumer daemon is done destroying its channel(s) since
3516 * it occurs as a reaction to the closing of the channel's file
3517 * descriptor. There is no resulting communication initiated
3518 * from the consumerd to the sessiond to confirm that the
3519 * operation is completed (and was successful).
3521 * Until this is all fixed, the session daemon checks for the
3522 * removal of the session's shm path which makes it possible
3523 * to safely advertise a session as having been destroyed.
3525 * Prior to this fix, it was not possible to reliably save
3526 * a session making use of the --shm-path option, destroy it,
3527 * and load it again. This is because the creation of the
3528 * session would fail upon seeing the session's shm path
3529 * already in existence.
3531 * Note that none of the error paths in the check for the
3532 * directory's existence return an error. This is normal
3533 * as there isn't much that can be done. The session will
3534 * be destroyed properly, except that we can't offer the
3535 * guarantee that the same session can be re-created.
3537 current_completion_handler
= &destroy_completion_handler
.handler
;
3538 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3540 sizeof(destroy_completion_handler
.shm_path
));
3545 * The session is destroyed. However, note that the command context
3546 * still holds a reference to the session, thus delaying its destruction
3547 * _at least_ up to the point when that reference is released.
3549 session_destroy(session
);
3550 if (reply_context
) {
3551 reply_context
->destruction_status
= destruction_last_error
;
3552 ret
= session_add_destroy_notifier(session
,
3553 cmd_destroy_session_reply
,
3554 (void *) reply_context
);
3556 ret
= LTTNG_ERR_FATAL
;
3568 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3570 int cmd_register_consumer(struct ltt_session
*session
,
3571 enum lttng_domain_type domain
, const char *sock_path
,
3572 struct consumer_data
*cdata
)
3575 struct consumer_socket
*socket
= NULL
;
3582 case LTTNG_DOMAIN_KERNEL
:
3584 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3588 /* Can't register a consumer if there is already one */
3589 if (ksess
->consumer_fds_sent
!= 0) {
3590 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3594 sock
= lttcomm_connect_unix_sock(sock_path
);
3596 ret
= LTTNG_ERR_CONNECT_FAIL
;
3599 cdata
->cmd_sock
= sock
;
3601 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3602 if (socket
== NULL
) {
3605 PERROR("close register consumer");
3607 cdata
->cmd_sock
= -1;
3608 ret
= LTTNG_ERR_FATAL
;
3612 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3613 if (socket
->lock
== NULL
) {
3614 PERROR("zmalloc pthread mutex");
3615 ret
= LTTNG_ERR_FATAL
;
3618 pthread_mutex_init(socket
->lock
, NULL
);
3619 socket
->registered
= 1;
3622 consumer_add_socket(socket
, ksess
->consumer
);
3625 pthread_mutex_lock(&cdata
->pid_mutex
);
3627 pthread_mutex_unlock(&cdata
->pid_mutex
);
3632 /* TODO: Userspace tracing */
3633 ret
= LTTNG_ERR_UND
;
3641 consumer_destroy_socket(socket
);
3647 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3649 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3650 struct lttng_domain
**domains
)
3655 struct lttng_ht_iter iter
;
3657 if (session
->kernel_session
!= NULL
) {
3658 DBG3("Listing domains found kernel domain");
3662 if (session
->ust_session
!= NULL
) {
3663 DBG3("Listing domains found UST global domain");
3667 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3669 if (agt
->being_used
) {
3680 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3681 if (*domains
== NULL
) {
3682 ret
= LTTNG_ERR_FATAL
;
3686 if (session
->kernel_session
!= NULL
) {
3687 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3689 /* Kernel session buffer type is always GLOBAL */
3690 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3695 if (session
->ust_session
!= NULL
) {
3696 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3697 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3701 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3703 if (agt
->being_used
) {
3704 (*domains
)[index
].type
= agt
->domain
;
3705 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3715 /* Return negative value to differentiate return code */
3721 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3723 enum lttng_error_code
cmd_list_channels(enum lttng_domain_type domain
,
3724 struct ltt_session
*session
,
3725 struct lttng_dynamic_buffer
*buffer
,
3726 uint32_t *nb_channel
)
3735 DBG("Listing channels for session %s", session
->name
);
3738 case LTTNG_DOMAIN_KERNEL
:
3740 /* Kernel channels */
3741 struct ltt_kernel_channel
*kchan
;
3742 if (session
->kernel_session
!= NULL
) {
3743 cds_list_for_each_entry(kchan
,
3744 &session
->kernel_session
->channel_list
.head
, list
) {
3745 uint64_t discarded_events
, lost_packets
;
3746 struct lttng_channel_extended
*extended
;
3748 extended
= (struct lttng_channel_extended
*)
3749 kchan
->channel
->attr
.extended
.ptr
;
3751 ret
= get_kernel_runtime_stats(session
, kchan
,
3752 &discarded_events
, &lost_packets
);
3758 * Update the discarded_events and lost_packets
3759 * count for the channel
3761 extended
->discarded_events
= discarded_events
;
3762 extended
->lost_packets
= lost_packets
;
3764 ret
= lttng_channel_serialize(
3765 kchan
->channel
, buffer
);
3776 case LTTNG_DOMAIN_UST
:
3778 struct lttng_ht_iter iter
;
3779 struct ltt_ust_channel
*uchan
;
3782 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
3783 &iter
.iter
, uchan
, node
.node
) {
3784 uint64_t discarded_events
= 0, lost_packets
= 0;
3785 struct lttng_channel
*channel
= NULL
;
3786 struct lttng_channel_extended
*extended
;
3788 channel
= trace_ust_channel_to_lttng_channel(uchan
);
3794 extended
= (struct lttng_channel_extended
*)
3795 channel
->attr
.extended
.ptr
;
3797 ret
= get_ust_runtime_stats(session
, uchan
,
3798 &discarded_events
, &lost_packets
);
3800 lttng_channel_destroy(channel
);
3804 extended
->discarded_events
= discarded_events
;
3805 extended
->lost_packets
= lost_packets
;
3807 ret
= lttng_channel_serialize(channel
, buffer
);
3825 return LTTNG_ERR_FATAL
;
3833 * Command LTTNG_LIST_EVENTS processed by the client thread.
3835 enum lttng_error_code
cmd_list_events(enum lttng_domain_type domain
,
3836 struct ltt_session
*session
,
3838 struct lttng_dynamic_buffer
*payload
,
3839 unsigned int *nb_events
)
3841 enum lttng_error_code ret_code
= LTTNG_OK
;
3846 case LTTNG_DOMAIN_KERNEL
:
3847 if (session
->kernel_session
!= NULL
) {
3848 ret_code
= list_lttng_kernel_events(channel_name
,
3849 session
->kernel_session
, payload
, nb_events
);
3852 case LTTNG_DOMAIN_UST
:
3854 if (session
->ust_session
!= NULL
) {
3855 ret_code
= list_lttng_ust_global_events(channel_name
,
3856 &session
->ust_session
->domain_global
,
3857 payload
, nb_events
);
3861 case LTTNG_DOMAIN_LOG4J
:
3862 case LTTNG_DOMAIN_JUL
:
3863 case LTTNG_DOMAIN_PYTHON
:
3864 if (session
->ust_session
) {
3865 struct lttng_ht_iter iter
;
3869 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3870 &iter
.iter
, agt
, node
.node
) {
3871 if (agt
->domain
== domain
) {
3872 ret_code
= list_lttng_agent_events(
3873 agt
, payload
, nb_events
);
3881 ret_code
= LTTNG_ERR_UND
;
3889 * Using the session list, filled a lttng_session array to send back to the
3890 * client for session listing.
3892 * The session list lock MUST be acquired before calling this function. Use
3893 * session_lock_list() and session_unlock_list().
3895 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3896 size_t session_count
, uid_t uid
, gid_t gid
)
3900 struct ltt_session
*session
;
3901 struct ltt_session_list
*list
= session_get_list();
3902 struct lttng_session_extended
*extended
=
3903 (typeof(extended
)) (&sessions
[session_count
]);
3905 DBG("Getting all available session for UID %d GID %d",
3908 * Iterate over session list and append data after the control struct in
3911 cds_list_for_each_entry(session
, &list
->head
, list
) {
3912 if (!session_get(session
)) {
3916 * Only list the sessions the user can control.
3918 if (!session_access_ok(session
, uid
, gid
) ||
3919 session
->destroyed
) {
3920 session_put(session
);
3924 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3925 struct ltt_ust_session
*usess
= session
->ust_session
;
3927 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3928 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3929 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3930 ret
= build_network_session_path(sessions
[i
].path
,
3931 sizeof(sessions
[i
].path
), session
);
3933 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3934 session
->consumer
->dst
.session_root_path
);
3937 PERROR("snprintf session path");
3938 session_put(session
);
3942 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3943 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3944 sessions
[i
].enabled
= session
->active
;
3945 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3946 sessions
[i
].live_timer_interval
= session
->live_timer
;
3947 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3948 extended
[i
].creation_time
.is_set
= 1;
3950 session_put(session
);
3955 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3956 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3958 int cmd_data_pending(struct ltt_session
*session
)
3961 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3962 struct ltt_ust_session
*usess
= session
->ust_session
;
3966 DBG("Data pending for session %s", session
->name
);
3968 /* Session MUST be stopped to ask for data availability. */
3969 if (session
->active
) {
3970 ret
= LTTNG_ERR_SESSION_STARTED
;
3974 * If stopped, just make sure we've started before else the above call
3975 * will always send that there is data pending.
3977 * The consumer assumes that when the data pending command is received,
3978 * the trace has been started before or else no output data is written
3979 * by the streams which is a condition for data pending. So, this is
3980 * *VERY* important that we don't ask the consumer before a start
3983 if (!session
->has_been_started
) {
3989 /* A rotation is still pending, we have to wait. */
3990 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3991 DBG("Rotate still pending for session %s", session
->name
);
3996 if (ksess
&& ksess
->consumer
) {
3997 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3999 /* Data is still being extracted for the kernel. */
4004 if (usess
&& usess
->consumer
) {
4005 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
4007 /* Data is still being extracted for the kernel. */
4012 /* Data is ready to be read by a viewer */
4020 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
4022 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4024 int cmd_snapshot_add_output(struct ltt_session
*session
,
4025 const struct lttng_snapshot_output
*output
, uint32_t *id
)
4028 struct snapshot_output
*new_output
;
4033 DBG("Cmd snapshot add output for session %s", session
->name
);
4036 * Can't create an output if the session is not set in no-output mode.
4038 if (session
->output_traces
) {
4039 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4043 if (session
->has_non_mmap_channel
) {
4044 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
4048 /* Only one output is allowed until we have the "tee" feature. */
4049 if (session
->snapshot
.nb_output
== 1) {
4050 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
4054 new_output
= snapshot_output_alloc();
4056 ret
= LTTNG_ERR_NOMEM
;
4060 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
4061 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
4062 &session
->snapshot
);
4064 if (ret
== -ENOMEM
) {
4065 ret
= LTTNG_ERR_NOMEM
;
4067 ret
= LTTNG_ERR_INVALID
;
4073 snapshot_add_output(&session
->snapshot
, new_output
);
4075 *id
= new_output
->id
;
4082 snapshot_output_destroy(new_output
);
4088 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
4090 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4092 int cmd_snapshot_del_output(struct ltt_session
*session
,
4093 const struct lttng_snapshot_output
*output
)
4096 struct snapshot_output
*sout
= NULL
;
4104 * Permission denied to create an output if the session is not
4105 * set in no output mode.
4107 if (session
->output_traces
) {
4108 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4113 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4115 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4116 } else if (*output
->name
!= '\0') {
4117 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4119 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4122 ret
= LTTNG_ERR_INVALID
;
4126 snapshot_delete_output(&session
->snapshot
, sout
);
4127 snapshot_output_destroy(sout
);
4136 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4138 * If no output is available, outputs is untouched and 0 is returned.
4140 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4142 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4143 struct lttng_snapshot_output
**outputs
)
4146 struct lttng_snapshot_output
*list
= NULL
;
4147 struct lttng_ht_iter iter
;
4148 struct snapshot_output
*output
;
4153 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4156 * Permission denied to create an output if the session is not
4157 * set in no output mode.
4159 if (session
->output_traces
) {
4160 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4164 if (session
->snapshot
.nb_output
== 0) {
4169 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4171 ret
= -LTTNG_ERR_NOMEM
;
4175 /* Copy list from session to the new list object. */
4177 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4178 output
, node
.node
) {
4179 assert(output
->consumer
);
4180 list
[idx
].id
= output
->id
;
4181 list
[idx
].max_size
= output
->max_size
;
4182 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4183 sizeof(list
[idx
].name
))) {
4184 ret
= -LTTNG_ERR_INVALID
;
4187 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4188 if (lttng_strncpy(list
[idx
].ctrl_url
,
4189 output
->consumer
->dst
.session_root_path
,
4190 sizeof(list
[idx
].ctrl_url
))) {
4191 ret
= -LTTNG_ERR_INVALID
;
4196 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4197 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4199 ret
= -LTTNG_ERR_NOMEM
;
4204 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4205 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4207 ret
= -LTTNG_ERR_NOMEM
;
4216 ret
= session
->snapshot
.nb_output
;
4225 * Check if we can regenerate the metadata for this session.
4226 * Only kernel, UST per-uid and non-live sessions are supported.
4228 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4231 int check_regenerate_metadata_support(struct ltt_session
*session
)
4237 if (session
->live_timer
!= 0) {
4238 ret
= LTTNG_ERR_LIVE_SESSION
;
4241 if (!session
->active
) {
4242 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4245 if (session
->ust_session
) {
4246 switch (session
->ust_session
->buffer_type
) {
4247 case LTTNG_BUFFER_PER_UID
:
4249 case LTTNG_BUFFER_PER_PID
:
4250 ret
= LTTNG_ERR_PER_PID_SESSION
;
4254 ret
= LTTNG_ERR_UNK
;
4258 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4259 session
->consumer
->relay_minor_version
< 8) {
4260 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4270 int clear_metadata_file(int fd
)
4275 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4276 if (lseek_ret
< 0) {
4282 ret
= ftruncate(fd
, 0);
4284 PERROR("ftruncate");
4293 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4296 struct buffer_reg_uid
*uid_reg
= NULL
;
4297 struct buffer_reg_session
*session_reg
= NULL
;
4300 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4301 struct ust_registry_session
*registry
;
4302 struct ust_registry_channel
*chan
;
4303 struct lttng_ht_iter iter_chan
;
4305 session_reg
= uid_reg
->registry
;
4306 registry
= session_reg
->reg
.ust
;
4308 pthread_mutex_lock(®istry
->lock
);
4309 registry
->metadata_len_sent
= 0;
4310 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4311 registry
->metadata_len
= 0;
4312 registry
->metadata_version
++;
4313 if (registry
->metadata_fd
> 0) {
4314 /* Clear the metadata file's content. */
4315 ret
= clear_metadata_file(registry
->metadata_fd
);
4317 pthread_mutex_unlock(®istry
->lock
);
4322 ret
= ust_metadata_session_statedump(registry
, NULL
,
4323 registry
->major
, registry
->minor
);
4325 pthread_mutex_unlock(®istry
->lock
);
4326 ERR("Failed to generate session metadata (err = %d)",
4330 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4332 struct ust_registry_event
*event
;
4333 struct lttng_ht_iter iter_event
;
4335 ret
= ust_metadata_channel_statedump(registry
, chan
);
4337 pthread_mutex_unlock(®istry
->lock
);
4338 ERR("Failed to generate channel metadata "
4342 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4344 ret
= ust_metadata_event_statedump(registry
,
4347 pthread_mutex_unlock(®istry
->lock
);
4348 ERR("Failed to generate event metadata "
4354 pthread_mutex_unlock(®istry
->lock
);
4363 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4365 * Ask the consumer to truncate the existing metadata file(s) and
4366 * then regenerate the metadata. Live and per-pid sessions are not
4367 * supported and return an error.
4369 * Return 0 on success or else a LTTNG_ERR code.
4371 int cmd_regenerate_metadata(struct ltt_session
*session
)
4377 ret
= check_regenerate_metadata_support(session
);
4382 if (session
->kernel_session
) {
4383 ret
= kernctl_session_regenerate_metadata(
4384 session
->kernel_session
->fd
);
4386 ERR("Failed to regenerate the kernel metadata");
4391 if (session
->ust_session
) {
4392 ret
= ust_regenerate_metadata(session
->ust_session
);
4394 ERR("Failed to regenerate the UST metadata");
4398 DBG("Cmd metadata regenerate for session %s", session
->name
);
4406 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4408 * Ask the tracer to regenerate a new statedump.
4410 * Return 0 on success or else a LTTNG_ERR code.
4412 int cmd_regenerate_statedump(struct ltt_session
*session
)
4418 if (!session
->active
) {
4419 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4423 if (session
->kernel_session
) {
4424 ret
= kernctl_session_regenerate_statedump(
4425 session
->kernel_session
->fd
);
4427 * Currently, the statedump in kernel can only fail if out
4431 if (ret
== -ENOMEM
) {
4432 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4434 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4436 ERR("Failed to regenerate the kernel statedump");
4441 if (session
->ust_session
) {
4442 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4444 * Currently, the statedump in UST always returns 0.
4447 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4448 ERR("Failed to regenerate the UST statedump");
4452 DBG("Cmd regenerate statedump for session %s", session
->name
);
4459 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4460 struct notification_thread_handle
*notification_thread
)
4464 ssize_t sock_recv_len
;
4465 struct lttng_trigger
*trigger
= NULL
;
4466 struct lttng_buffer_view view
;
4467 struct lttng_dynamic_buffer trigger_buffer
;
4469 lttng_dynamic_buffer_init(&trigger_buffer
);
4470 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4471 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4473 ret
= LTTNG_ERR_NOMEM
;
4477 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4479 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4480 ERR("Failed to receive \"register trigger\" command payload");
4481 /* TODO: should this be a new error enum ? */
4482 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4486 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4487 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4489 ERR("Invalid trigger payload received in \"register trigger\" command");
4490 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4494 ret
= notification_thread_command_register_trigger(notification_thread
,
4496 /* Ownership of trigger was transferred. */
4499 lttng_trigger_destroy(trigger
);
4500 lttng_dynamic_buffer_reset(&trigger_buffer
);
4504 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4505 struct notification_thread_handle
*notification_thread
)
4509 ssize_t sock_recv_len
;
4510 struct lttng_trigger
*trigger
= NULL
;
4511 struct lttng_buffer_view view
;
4512 struct lttng_dynamic_buffer trigger_buffer
;
4514 lttng_dynamic_buffer_init(&trigger_buffer
);
4515 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4516 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4518 ret
= LTTNG_ERR_NOMEM
;
4522 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4524 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4525 ERR("Failed to receive \"unregister trigger\" command payload");
4526 /* TODO: should this be a new error enum ? */
4527 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4531 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4532 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4534 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4535 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4539 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4542 lttng_trigger_destroy(trigger
);
4543 lttng_dynamic_buffer_reset(&trigger_buffer
);
4548 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4549 * snapshot output is *not* set with a remote destination.
4551 * Return LTTNG_OK on success or a LTTNG_ERR code.
4553 static enum lttng_error_code
set_relayd_for_snapshot(
4554 struct consumer_output
*output
,
4555 const struct ltt_session
*session
)
4557 enum lttng_error_code status
= LTTNG_OK
;
4558 struct lttng_ht_iter iter
;
4559 struct consumer_socket
*socket
;
4560 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4561 const char *base_path
;
4566 DBG2("Set relayd object from snapshot output");
4568 if (session
->current_trace_chunk
) {
4569 enum lttng_trace_chunk_status chunk_status
=
4570 lttng_trace_chunk_get_id(
4571 session
->current_trace_chunk
,
4572 ¤t_chunk_id
.value
);
4574 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4575 current_chunk_id
.is_set
= true;
4577 ERR("Failed to get current trace chunk id");
4578 status
= LTTNG_ERR_UNK
;
4583 /* Ignore if snapshot consumer output is not network. */
4584 if (output
->type
!= CONSUMER_DST_NET
) {
4589 * The snapshot record URI base path overrides the session
4592 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4593 base_path
= output
->dst
.net
.control
.subdir
;
4595 base_path
= session
->base_path
;
4599 * For each consumer socket, create and send the relayd object of the
4603 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4604 socket
, node
.node
) {
4605 pthread_mutex_lock(socket
->lock
);
4606 status
= send_consumer_relayd_sockets(0, session
->id
,
4608 session
->name
, session
->hostname
,
4610 session
->live_timer
,
4611 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4612 session
->creation_time
,
4613 session
->name_contains_creation_time
);
4614 pthread_mutex_unlock(socket
->lock
);
4615 if (status
!= LTTNG_OK
) {
4627 * Record a kernel snapshot.
4629 * Return LTTNG_OK on success or a LTTNG_ERR code.
4631 static enum lttng_error_code
record_kernel_snapshot(
4632 struct ltt_kernel_session
*ksess
,
4633 const struct consumer_output
*output
,
4634 const struct ltt_session
*session
,
4635 int wait
, uint64_t nb_packets_per_stream
)
4637 enum lttng_error_code status
;
4643 status
= kernel_snapshot_record(
4644 ksess
, output
, wait
, nb_packets_per_stream
);
4649 * Record a UST snapshot.
4651 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4653 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4654 const struct consumer_output
*output
,
4655 const struct ltt_session
*session
,
4656 int wait
, uint64_t nb_packets_per_stream
)
4658 enum lttng_error_code status
;
4664 status
= ust_app_snapshot_record(
4665 usess
, output
, wait
, nb_packets_per_stream
);
4670 uint64_t get_session_size_one_more_packet_per_stream(
4671 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4673 uint64_t tot_size
= 0;
4675 if (session
->kernel_session
) {
4676 struct ltt_kernel_channel
*chan
;
4677 const struct ltt_kernel_session
*ksess
=
4678 session
->kernel_session
;
4680 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4681 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4683 * Don't take channel into account if we
4684 * already grab all its packets.
4688 tot_size
+= chan
->channel
->attr
.subbuf_size
4689 * chan
->stream_count
;
4693 if (session
->ust_session
) {
4694 const struct ltt_ust_session
*usess
= session
->ust_session
;
4696 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4704 * Calculate the number of packets we can grab from each stream that
4705 * fits within the overall snapshot max size.
4707 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4708 * the number of packets per stream.
4710 * TODO: this approach is not perfect: we consider the worse case
4711 * (packet filling the sub-buffers) as an upper bound, but we could do
4712 * better if we do this calculation while we actually grab the packet
4713 * content: we would know how much padding we don't actually store into
4716 * This algorithm is currently bounded by the number of packets per
4719 * Since we call this algorithm before actually grabbing the data, it's
4720 * an approximation: for instance, applications could appear/disappear
4721 * in between this call and actually grabbing data.
4724 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4728 uint64_t cur_nb_packets
= 0;
4731 return 0; /* Infinite */
4734 size_left
= max_size
;
4736 uint64_t one_more_packet_tot_size
;
4738 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4739 session
, cur_nb_packets
);
4740 if (!one_more_packet_tot_size
) {
4741 /* We are already grabbing all packets. */
4744 size_left
-= one_more_packet_tot_size
;
4745 if (size_left
< 0) {
4750 if (!cur_nb_packets
&& size_left
!= max_size
) {
4751 /* Not enough room to grab one packet of each stream, error. */
4754 return cur_nb_packets
;
4758 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4759 const struct snapshot_output
*snapshot_output
, int wait
)
4761 int64_t nb_packets_per_stream
;
4762 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4764 enum lttng_error_code ret_code
= LTTNG_OK
;
4765 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4766 struct consumer_output
*original_ust_consumer_output
= NULL
;
4767 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4768 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4769 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4771 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4773 snapshot_output
->name
,
4774 snapshot_output
->datetime
,
4775 snapshot_output
->nb_snapshot
);
4776 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4777 ERR("Failed to format snapshot name");
4778 ret_code
= LTTNG_ERR_INVALID
;
4781 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4782 snapshot_output
->name
, session
->name
,
4783 snapshot_chunk_name
);
4784 if (!session
->kernel_session
&& !session
->ust_session
) {
4785 ERR("Failed to record snapshot as no channels exist");
4786 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4790 if (session
->kernel_session
) {
4791 original_kernel_consumer_output
=
4792 session
->kernel_session
->consumer
;
4793 snapshot_kernel_consumer_output
=
4794 consumer_copy_output(snapshot_output
->consumer
);
4795 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4796 snapshot_chunk_name
);
4798 /* Copy the original domain subdir. */
4799 strcpy(snapshot_kernel_consumer_output
->domain_subdir
,
4800 original_kernel_consumer_output
->domain_subdir
);
4802 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4803 original_kernel_consumer_output
);
4805 ERR("Failed to copy consumer sockets from snapshot output configuration");
4806 ret_code
= LTTNG_ERR_NOMEM
;
4809 ret_code
= set_relayd_for_snapshot(
4810 snapshot_kernel_consumer_output
, session
);
4811 if (ret_code
!= LTTNG_OK
) {
4812 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4815 session
->kernel_session
->consumer
=
4816 snapshot_kernel_consumer_output
;
4818 if (session
->ust_session
) {
4819 original_ust_consumer_output
= session
->ust_session
->consumer
;
4820 snapshot_ust_consumer_output
=
4821 consumer_copy_output(snapshot_output
->consumer
);
4822 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4823 snapshot_chunk_name
);
4825 /* Copy the original domain subdir. */
4826 strcpy(snapshot_ust_consumer_output
->domain_subdir
,
4827 original_ust_consumer_output
->domain_subdir
);
4829 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4830 original_ust_consumer_output
);
4832 ERR("Failed to copy consumer sockets from snapshot output configuration");
4833 ret_code
= LTTNG_ERR_NOMEM
;
4836 ret_code
= set_relayd_for_snapshot(
4837 snapshot_ust_consumer_output
, session
);
4838 if (ret_code
!= LTTNG_OK
) {
4839 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4842 session
->ust_session
->consumer
=
4843 snapshot_ust_consumer_output
;
4846 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4847 snapshot_kernel_consumer_output
?:
4848 snapshot_ust_consumer_output
,
4849 consumer_output_get_base_path(
4850 snapshot_output
->consumer
),
4851 snapshot_chunk_name
);
4852 if (!snapshot_trace_chunk
) {
4853 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4855 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4858 assert(!session
->current_trace_chunk
);
4859 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4860 lttng_trace_chunk_put(snapshot_trace_chunk
);
4861 snapshot_trace_chunk
= NULL
;
4863 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4865 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4869 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4870 snapshot_output
->max_size
);
4871 if (nb_packets_per_stream
< 0) {
4872 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4873 goto error_close_trace_chunk
;
4876 if (session
->kernel_session
) {
4877 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4878 snapshot_kernel_consumer_output
, session
,
4879 wait
, nb_packets_per_stream
);
4880 if (ret_code
!= LTTNG_OK
) {
4881 goto error_close_trace_chunk
;
4885 if (session
->ust_session
) {
4886 ret_code
= record_ust_snapshot(session
->ust_session
,
4887 snapshot_ust_consumer_output
, session
,
4888 wait
, nb_packets_per_stream
);
4889 if (ret_code
!= LTTNG_OK
) {
4890 goto error_close_trace_chunk
;
4894 error_close_trace_chunk
:
4895 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4896 ERR("Failed to release the current trace chunk of session \"%s\"",
4898 ret_code
= LTTNG_ERR_UNK
;
4901 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4902 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4904 * Don't goto end; make sure the chunk is closed for the session
4905 * to allow future snapshots.
4907 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4909 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4912 lttng_trace_chunk_put(snapshot_trace_chunk
);
4913 snapshot_trace_chunk
= NULL
;
4915 if (original_ust_consumer_output
) {
4916 session
->ust_session
->consumer
= original_ust_consumer_output
;
4918 if (original_kernel_consumer_output
) {
4919 session
->kernel_session
->consumer
=
4920 original_kernel_consumer_output
;
4922 consumer_output_put(snapshot_ust_consumer_output
);
4923 consumer_output_put(snapshot_kernel_consumer_output
);
4928 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4930 * The wait parameter is ignored so this call always wait for the snapshot to
4931 * complete before returning.
4933 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4935 int cmd_snapshot_record(struct ltt_session
*session
,
4936 const struct lttng_snapshot_output
*output
, int wait
)
4938 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4940 unsigned int snapshot_success
= 0;
4942 struct snapshot_output
*tmp_output
= NULL
;
4947 DBG("Cmd snapshot record for session %s", session
->name
);
4949 /* Get the datetime for the snapshot output directory. */
4950 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4953 cmd_ret
= LTTNG_ERR_INVALID
;
4958 * Permission denied to create an output if the session is not
4959 * set in no output mode.
4961 if (session
->output_traces
) {
4962 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4966 /* The session needs to be started at least once. */
4967 if (!session
->has_been_started
) {
4968 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4972 /* Use temporary output for the session. */
4973 if (*output
->ctrl_url
!= '\0') {
4974 tmp_output
= snapshot_output_alloc();
4976 cmd_ret
= LTTNG_ERR_NOMEM
;
4980 ret
= snapshot_output_init(session
, output
->max_size
,
4982 output
->ctrl_url
, output
->data_url
,
4986 if (ret
== -ENOMEM
) {
4987 cmd_ret
= LTTNG_ERR_NOMEM
;
4989 cmd_ret
= LTTNG_ERR_INVALID
;
4993 /* Use the global session count for the temporary snapshot. */
4994 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4996 /* Use the global datetime */
4997 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4998 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4999 if (cmd_ret
!= LTTNG_OK
) {
5002 snapshot_success
= 1;
5004 struct snapshot_output
*sout
;
5005 struct lttng_ht_iter iter
;
5008 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
5009 &iter
.iter
, sout
, node
.node
) {
5010 struct snapshot_output output_copy
;
5013 * Make a local copy of the output and override output
5014 * parameters with those provided as part of the
5017 memcpy(&output_copy
, sout
, sizeof(output_copy
));
5019 if (output
->max_size
!= (uint64_t) -1ULL) {
5020 output_copy
.max_size
= output
->max_size
;
5023 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
5024 memcpy(output_copy
.datetime
, datetime
,
5027 /* Use temporary name. */
5028 if (*output
->name
!= '\0') {
5029 if (lttng_strncpy(output_copy
.name
,
5031 sizeof(output_copy
.name
))) {
5032 cmd_ret
= LTTNG_ERR_INVALID
;
5038 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
5039 if (cmd_ret
!= LTTNG_OK
) {
5043 snapshot_success
= 1;
5048 if (snapshot_success
) {
5049 session
->snapshot
.nb_snapshot
++;
5051 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
5056 snapshot_output_destroy(tmp_output
);
5062 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
5064 int cmd_set_session_shm_path(struct ltt_session
*session
,
5065 const char *shm_path
)
5071 * Can only set shm path before session is started.
5073 if (session
->has_been_started
) {
5074 return LTTNG_ERR_SESSION_STARTED
;
5077 strncpy(session
->shm_path
, shm_path
,
5078 sizeof(session
->shm_path
));
5079 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
5085 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
5087 * Ask the consumer to rotate the session output directory.
5088 * The session lock must be held.
5090 * Returns LTTNG_OK on success or else a negative LTTng error code.
5092 int cmd_rotate_session(struct ltt_session
*session
,
5093 struct lttng_rotate_session_return
*rotate_return
,
5094 bool quiet_rotation
,
5095 enum lttng_trace_chunk_command_type command
)
5098 uint64_t ongoing_rotation_chunk_id
;
5099 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5100 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
5101 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
5102 enum lttng_trace_chunk_status chunk_status
;
5103 bool failed_to_rotate
= false;
5104 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5108 if (!session
->has_been_started
) {
5109 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5114 * Explicit rotation is not supported for live sessions.
5115 * However, live sessions can perform a quiet rotation on
5117 * Rotation is not supported for snapshot traces (no output).
5119 if ((!quiet_rotation
&& session
->live_timer
) ||
5120 !session
->output_traces
) {
5121 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5125 /* Unsupported feature in lttng-relayd before 2.11. */
5126 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5127 (session
->consumer
->relay_major_version
== 2 &&
5128 session
->consumer
->relay_minor_version
< 11)) {
5129 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5133 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5134 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5135 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5139 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5140 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5142 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5147 * After a stop, we only allow one rotation to occur, the other ones are
5148 * useless until a new start.
5150 if (session
->rotated_after_last_stop
) {
5151 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5153 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5158 * After a stop followed by a clear, disallow following rotations a they would
5159 * generate empty chunks.
5161 if (session
->cleared_after_last_stop
) {
5162 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5164 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5168 if (session
->active
) {
5169 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5171 if (!new_trace_chunk
) {
5172 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5178 * The current trace chunk becomes the chunk being archived.
5180 * After this point, "chunk_being_archived" must absolutely
5181 * be closed on the consumer(s), otherwise it will never be
5182 * cleaned-up, which will result in a leak.
5184 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5185 &chunk_being_archived
);
5187 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5191 if (session
->kernel_session
) {
5192 cmd_ret
= kernel_rotate_session(session
);
5193 if (cmd_ret
!= LTTNG_OK
) {
5194 failed_to_rotate
= true;
5195 rotation_fail_code
= cmd_ret
;
5198 if (session
->ust_session
) {
5199 cmd_ret
= ust_app_rotate_session(session
);
5200 if (cmd_ret
!= LTTNG_OK
) {
5201 failed_to_rotate
= true;
5202 rotation_fail_code
= cmd_ret
;
5206 if (!session
->active
) {
5207 session
->rotated_after_last_stop
= true;
5210 if (!chunk_being_archived
) {
5211 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5213 if (failed_to_rotate
) {
5214 cmd_ret
= rotation_fail_code
;
5221 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5222 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5223 &ongoing_rotation_chunk_id
);
5224 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5226 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5227 command
, session
->last_chunk_path
);
5229 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5233 if (failed_to_rotate
) {
5234 cmd_ret
= rotation_fail_code
;
5238 session
->quiet_rotation
= quiet_rotation
;
5239 ret
= timer_session_rotation_pending_check_start(session
,
5240 DEFAULT_ROTATE_PENDING_TIMER
);
5242 cmd_ret
= LTTNG_ERR_UNK
;
5246 if (rotate_return
) {
5247 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5250 session
->chunk_being_archived
= chunk_being_archived
;
5251 chunk_being_archived
= NULL
;
5252 if (!quiet_rotation
) {
5253 ret
= notification_thread_command_session_rotation_ongoing(
5254 notification_thread_handle
,
5255 session
->name
, session
->uid
, session
->gid
,
5256 ongoing_rotation_chunk_id
);
5257 if (ret
!= LTTNG_OK
) {
5258 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5264 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5265 session
->name
, ongoing_rotation_chunk_id
);
5267 lttng_trace_chunk_put(new_trace_chunk
);
5268 lttng_trace_chunk_put(chunk_being_archived
);
5269 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5272 if (session_reset_rotation_state(session
,
5273 LTTNG_ROTATION_STATE_ERROR
)) {
5274 ERR("Failed to reset rotation state of session \"%s\"",
5281 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5283 * Check if the session has finished its rotation.
5285 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5287 int cmd_rotate_get_info(struct ltt_session
*session
,
5288 struct lttng_rotation_get_info_return
*info_return
,
5289 uint64_t rotation_id
)
5291 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5292 enum lttng_rotation_state rotation_state
;
5294 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5295 session
->most_recent_chunk_id
.value
);
5297 if (session
->chunk_being_archived
) {
5298 enum lttng_trace_chunk_status chunk_status
;
5301 chunk_status
= lttng_trace_chunk_get_id(
5302 session
->chunk_being_archived
,
5304 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5306 rotation_state
= rotation_id
== chunk_id
?
5307 LTTNG_ROTATION_STATE_ONGOING
:
5308 LTTNG_ROTATION_STATE_EXPIRED
;
5310 if (session
->last_archived_chunk_id
.is_set
&&
5311 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5312 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5314 rotation_state
= session
->rotation_state
;
5318 switch (rotation_state
) {
5319 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5320 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5323 case LTTNG_ROTATION_STATE_EXPIRED
:
5324 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5325 rotation_id
, session
->name
);
5327 case LTTNG_ROTATION_STATE_ONGOING
:
5328 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5329 rotation_id
, session
->name
);
5331 case LTTNG_ROTATION_STATE_COMPLETED
:
5335 char *current_tracing_path_reply
;
5336 size_t current_tracing_path_reply_len
;
5338 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5339 rotation_id
, session
->name
);
5341 switch (session_get_consumer_destination_type(session
)) {
5342 case CONSUMER_DST_LOCAL
:
5343 current_tracing_path_reply
=
5344 info_return
->location
.local
.absolute_path
;
5345 current_tracing_path_reply_len
=
5346 sizeof(info_return
->location
.local
.absolute_path
);
5347 info_return
->location_type
=
5348 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5349 fmt_ret
= asprintf(&chunk_path
,
5350 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5351 session_get_base_path(session
),
5352 session
->last_archived_chunk_name
);
5353 if (fmt_ret
== -1) {
5354 PERROR("Failed to format the path of the last archived trace chunk");
5355 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5356 cmd_ret
= LTTNG_ERR_UNK
;
5360 case CONSUMER_DST_NET
:
5362 uint16_t ctrl_port
, data_port
;
5364 current_tracing_path_reply
=
5365 info_return
->location
.relay
.relative_path
;
5366 current_tracing_path_reply_len
=
5367 sizeof(info_return
->location
.relay
.relative_path
);
5368 /* Currently the only supported relay protocol. */
5369 info_return
->location
.relay
.protocol
=
5370 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5372 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5373 session_get_net_consumer_hostname(session
),
5374 sizeof(info_return
->location
.relay
.host
));
5376 ERR("Failed to copy host name to rotate_get_info reply");
5377 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5378 cmd_ret
= LTTNG_ERR_SET_URL
;
5382 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5383 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5384 info_return
->location
.relay
.ports
.data
= data_port
;
5385 info_return
->location_type
=
5386 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5387 chunk_path
= strdup(session
->last_chunk_path
);
5389 ERR("Failed to allocate the path of the last archived trace chunk");
5390 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5391 cmd_ret
= LTTNG_ERR_UNK
;
5400 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5401 chunk_path
, current_tracing_path_reply_len
);
5404 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5405 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5406 cmd_ret
= LTTNG_ERR_UNK
;
5412 case LTTNG_ROTATION_STATE_ERROR
:
5413 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5414 rotation_id
, session
->name
);
5422 info_return
->status
= (int32_t) rotation_state
;
5427 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5429 * Configure the automatic rotation parameters.
5430 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5431 * 'activate' to false means deactivate the rotation schedule and validate that
5432 * 'new_value' has the same value as the currently active value.
5434 * Return 0 on success or else a positive LTTNG_ERR code.
5436 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5437 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5439 struct notification_thread_handle
*notification_thread_handle
)
5442 uint64_t *parameter_value
;
5446 DBG("Cmd rotate set schedule session %s", session
->name
);
5448 if (session
->live_timer
|| !session
->output_traces
) {
5449 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5450 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5454 switch (schedule_type
) {
5455 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5456 parameter_value
= &session
->rotate_size
;
5458 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5459 parameter_value
= &session
->rotate_timer_period
;
5460 if (new_value
>= UINT_MAX
) {
5461 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5462 new_value
, UINT_MAX
);
5463 ret
= LTTNG_ERR_INVALID
;
5468 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5469 ret
= LTTNG_ERR_INVALID
;
5473 /* Improper use of the API. */
5474 if (new_value
== -1ULL) {
5475 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5476 ret
= LTTNG_ERR_INVALID
;
5481 * As indicated in struct ltt_session's comments, a value of == 0 means
5482 * this schedule rotation type is not in use.
5484 * Reject the command if we were asked to activate a schedule that was
5487 if (activate
&& *parameter_value
!= 0) {
5488 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5489 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5494 * Reject the command if we were asked to deactivate a schedule that was
5497 if (!activate
&& *parameter_value
== 0) {
5498 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5499 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5504 * Reject the command if we were asked to deactivate a schedule that
5507 if (!activate
&& *parameter_value
!= new_value
) {
5508 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5509 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5513 *parameter_value
= activate
? new_value
: 0;
5515 switch (schedule_type
) {
5516 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5517 if (activate
&& session
->active
) {
5519 * Only start the timer if the session is active,
5520 * otherwise it will be started when the session starts.
5522 ret
= timer_session_rotation_schedule_timer_start(
5523 session
, new_value
);
5525 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5526 ret
= LTTNG_ERR_UNK
;
5530 ret
= timer_session_rotation_schedule_timer_stop(
5533 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5534 ret
= LTTNG_ERR_UNK
;
5539 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5541 ret
= subscribe_session_consumed_size_rotation(session
,
5542 new_value
, notification_thread_handle
);
5544 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5545 ret
= LTTNG_ERR_UNK
;
5549 ret
= unsubscribe_session_consumed_size_rotation(session
,
5550 notification_thread_handle
);
5552 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5553 ret
= LTTNG_ERR_UNK
;
5560 /* Would have been caught before. */
5572 /* Wait for a given path to be removed before continuing. */
5573 static enum lttng_error_code
wait_on_path(void *path_data
)
5575 const char *shm_path
= path_data
;
5577 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5583 ret
= stat(shm_path
, &st
);
5585 if (errno
!= ENOENT
) {
5586 PERROR("stat() returned an error while checking for the existence of the shm path");
5588 DBG("shm path no longer exists, completing the destruction of session");
5592 if (!S_ISDIR(st
.st_mode
)) {
5593 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5598 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5604 * Returns a pointer to a handler to run on completion of a command.
5605 * Returns NULL if no handler has to be run for the last command executed.
5607 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5609 struct cmd_completion_handler
*handler
= current_completion_handler
;
5611 current_completion_handler
= NULL
;
5616 * Init command subsystem.
5621 * Set network sequence index to 1 for streams to match a relayd
5622 * socket on the consumer side.
5624 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5625 relayd_net_seq_idx
= 1;
5626 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5628 DBG("Command subsystem initialized");