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
15 #include <urcu/list.h>
16 #include <urcu/uatomic.h>
18 #include <common/buffer-view.h>
19 #include <common/common.h>
20 #include <common/compat/string.h>
21 #include <common/defaults.h>
22 #include <common/dynamic-buffer.h>
23 #include <common/kernel-ctl/kernel-ctl.h>
24 #include <common/relayd/relayd.h>
25 #include <common/sessiond-comm/sessiond-comm.h>
26 #include <common/string-utils/string-utils.h>
27 #include <common/trace-chunk.h>
28 #include <common/utils.h>
30 #include <lttng/action/action.h>
31 #include <lttng/action/action-internal.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/channel.h>
34 #include <lttng/condition/condition.h>
35 #include <lttng/error-query-internal.h>
36 #include <lttng/event-internal.h>
37 #include <lttng/location-internal.h>
38 #include <lttng/rotate-internal.h>
39 #include <lttng/session-descriptor-internal.h>
40 #include <lttng/session-internal.h>
41 #include <lttng/trigger/trigger-internal.h>
42 #include <lttng/userspace-probe-internal.h>
44 #include "agent-thread.h"
46 #include "buffer-registry.h"
50 #include "event-notifier-error-accounting.h"
52 #include "health-sessiond.h"
53 #include "kernel-consumer.h"
55 #include "lttng-sessiond.h"
56 #include "lttng-syscall.h"
57 #include "notification-thread-commands.h"
58 #include "notification-thread.h"
60 #include "rotation-thread.h"
66 /* Sleep for 100ms between each check for the shm path's deletion. */
67 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
69 struct cmd_destroy_session_reply_context
{
71 bool implicit_rotation_on_destroy
;
73 * Indicates whether or not an error occurred while launching the
74 * destruction of a session.
76 enum lttng_error_code destruction_status
;
79 static enum lttng_error_code
wait_on_path(void *path
);
82 * Command completion handler that is used by the destroy command
83 * when a session that has a non-default shm_path is being destroyed.
85 * See comment in cmd_destroy_session() for the rationale.
87 static struct destroy_completion_handler
{
88 struct cmd_completion_handler handler
;
89 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
90 } destroy_completion_handler
= {
93 .data
= destroy_completion_handler
.shm_path
98 static struct cmd_completion_handler
*current_completion_handler
;
101 * Used to keep a unique index for each relayd socket created where this value
102 * is associated with streams on the consumer so it can match the right relayd
103 * to send to. It must be accessed with the relayd_net_seq_idx_lock
106 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
107 static uint64_t relayd_net_seq_idx
;
109 static int validate_ust_event_name(const char *);
110 static int cmd_enable_event_internal(struct ltt_session
*session
,
111 const struct lttng_domain
*domain
,
112 char *channel_name
, struct lttng_event
*event
,
113 char *filter_expression
,
114 struct lttng_bytecode
*filter
,
115 struct lttng_event_exclusion
*exclusion
,
117 static int cmd_enable_channel_internal(struct ltt_session
*session
,
118 const struct lttng_domain
*domain
,
119 const struct lttng_channel
*_attr
,
123 * Create a session path used by list_lttng_sessions for the case that the
124 * session consumer is on the network.
126 static int build_network_session_path(char *dst
, size_t size
,
127 struct ltt_session
*session
)
129 int ret
, kdata_port
, udata_port
;
130 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
131 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
133 LTTNG_ASSERT(session
);
136 memset(tmp_urls
, 0, sizeof(tmp_urls
));
137 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
139 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
141 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
142 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
143 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
146 if (session
->ust_session
&& session
->ust_session
->consumer
) {
147 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
148 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
151 if (uuri
== NULL
&& kuri
== NULL
) {
152 uri
= &session
->consumer
->dst
.net
.control
;
153 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
154 } else if (kuri
&& uuri
) {
155 ret
= uri_compare(kuri
, uuri
);
159 /* Build uuri URL string */
160 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
167 } else if (kuri
&& uuri
== NULL
) {
169 } else if (uuri
&& kuri
== NULL
) {
173 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
179 * Do we have a UST url set. If yes, this means we have both kernel and UST
182 if (*tmp_uurl
!= '\0') {
183 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
184 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
187 if (kuri
|| (!kuri
&& !uuri
)) {
190 /* No kernel URI, use the UST port. */
193 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
201 * Get run-time attributes if the session has been started (discarded events,
204 static int get_kernel_runtime_stats(struct ltt_session
*session
,
205 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
206 uint64_t *lost_packets
)
210 if (!session
->has_been_started
) {
212 *discarded_events
= 0;
217 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
218 session
->kernel_session
->consumer
,
224 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
225 session
->kernel_session
->consumer
,
236 * Get run-time attributes if the session has been started (discarded events,
239 static int get_ust_runtime_stats(struct ltt_session
*session
,
240 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
241 uint64_t *lost_packets
)
244 struct ltt_ust_session
*usess
;
246 if (!discarded_events
|| !lost_packets
) {
251 usess
= session
->ust_session
;
252 LTTNG_ASSERT(discarded_events
);
253 LTTNG_ASSERT(lost_packets
);
255 if (!usess
|| !session
->has_been_started
) {
256 *discarded_events
= 0;
262 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
263 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
264 &usess
->buffer_reg_uid_list
,
265 usess
->consumer
, uchan
->id
,
266 uchan
->attr
.overwrite
,
269 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
270 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
271 uchan
, usess
->consumer
,
272 uchan
->attr
.overwrite
,
278 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
279 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
281 ERR("Unsupported buffer type");
292 * Create a list of agent domain events.
294 * Return number of events in list on success or else a negative value.
296 static enum lttng_error_code
list_lttng_agent_events(
297 struct agent
*agt
, struct lttng_payload
*reply_payload
,
298 unsigned int *nb_events
)
300 enum lttng_error_code ret_code
;
302 unsigned int local_nb_events
= 0;
303 struct agent_event
*event
;
304 struct lttng_ht_iter iter
;
305 unsigned long agent_event_count
;
308 assert(reply_payload
);
310 DBG3("Listing agent events");
313 agent_event_count
= lttng_ht_get_count(agt
->events
);
314 if (agent_event_count
== 0) {
319 if (agent_event_count
> UINT_MAX
) {
320 ret_code
= LTTNG_ERR_OVERFLOW
;
324 local_nb_events
= (unsigned int) agent_event_count
;
326 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
327 struct lttng_event
*tmp_event
= lttng_event_create();
330 ret_code
= LTTNG_ERR_NOMEM
;
334 if (lttng_strncpy(tmp_event
->name
, event
->name
, sizeof(tmp_event
->name
))) {
335 lttng_event_destroy(tmp_event
);
336 ret_code
= LTTNG_ERR_FATAL
;
340 tmp_event
->name
[sizeof(tmp_event
->name
) - 1] = '\0';
341 tmp_event
->enabled
= !!event
->enabled_count
;
342 tmp_event
->loglevel
= event
->loglevel_value
;
343 tmp_event
->loglevel_type
= event
->loglevel_type
;
345 ret
= lttng_event_serialize(tmp_event
, 0, NULL
,
346 event
->filter_expression
, 0, NULL
, reply_payload
);
347 lttng_event_destroy(tmp_event
);
349 ret_code
= LTTNG_ERR_FATAL
;
356 *nb_events
= local_nb_events
;
363 * Create a list of ust global domain events.
365 static enum lttng_error_code
list_lttng_ust_global_events(char *channel_name
,
366 struct ltt_ust_domain_global
*ust_global
,
367 struct lttng_payload
*reply_payload
,
368 unsigned int *nb_events
)
370 enum lttng_error_code ret_code
;
372 struct lttng_ht_iter iter
;
373 struct lttng_ht_node_str
*node
;
374 struct ltt_ust_channel
*uchan
;
375 struct ltt_ust_event
*uevent
;
376 unsigned long channel_event_count
;
377 unsigned int local_nb_events
= 0;
379 assert(reply_payload
);
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 channel_event_count
= lttng_ht_get_count(uchan
->events
);
396 if (channel_event_count
== 0) {
402 if (channel_event_count
> UINT_MAX
) {
403 ret_code
= LTTNG_ERR_OVERFLOW
;
407 local_nb_events
= (unsigned int) channel_event_count
;
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_event
= NULL
;
414 if (uevent
->internal
) {
415 /* This event should remain hidden from clients */
420 tmp_event
= lttng_event_create();
422 ret_code
= LTTNG_ERR_NOMEM
;
426 if (lttng_strncpy(tmp_event
->name
, uevent
->attr
.name
,
427 LTTNG_SYMBOL_NAME_LEN
)) {
428 ret_code
= LTTNG_ERR_FATAL
;
429 lttng_event_destroy(tmp_event
);
433 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
434 tmp_event
->enabled
= uevent
->enabled
;
436 switch (uevent
->attr
.instrumentation
) {
437 case LTTNG_UST_ABI_TRACEPOINT
:
438 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
440 case LTTNG_UST_ABI_PROBE
:
441 tmp_event
->type
= LTTNG_EVENT_PROBE
;
443 case LTTNG_UST_ABI_FUNCTION
:
444 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
448 tmp_event
->loglevel
= uevent
->attr
.loglevel
;
449 switch (uevent
->attr
.loglevel_type
) {
450 case LTTNG_UST_ABI_LOGLEVEL_ALL
:
451 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
453 case LTTNG_UST_ABI_LOGLEVEL_RANGE
:
454 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
456 case LTTNG_UST_ABI_LOGLEVEL_SINGLE
:
457 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
460 if (uevent
->filter
) {
461 tmp_event
->filter
= 1;
463 if (uevent
->exclusion
) {
464 tmp_event
->exclusion
= 1;
468 * We do not care about the filter bytecode and the fd from the
469 * userspace_probe_location.
471 ret
= lttng_event_serialize(tmp_event
, uevent
->exclusion
? uevent
->exclusion
->count
: 0,
472 uevent
->exclusion
? (char **) uevent
->exclusion
->names
: NULL
,
473 uevent
->filter_expression
, 0, NULL
, reply_payload
);
474 lttng_event_destroy(tmp_event
);
476 ret_code
= LTTNG_ERR_FATAL
;
482 /* nb_events is already set at this point. */
484 *nb_events
= local_nb_events
;
491 * Fill lttng_event array of all kernel events in the channel.
493 static enum lttng_error_code
list_lttng_kernel_events(char *channel_name
,
494 struct ltt_kernel_session
*kernel_session
,
495 struct lttng_payload
*reply_payload
,
496 unsigned int *nb_events
)
498 enum lttng_error_code ret_code
;
500 struct ltt_kernel_event
*event
;
501 struct ltt_kernel_channel
*kchan
;
503 assert(reply_payload
);
505 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
507 ret_code
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
511 *nb_events
= kchan
->event_count
;
513 DBG("Listing events for channel %s", kchan
->channel
->name
);
515 if (*nb_events
== 0) {
520 /* Kernel channels */
521 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
522 struct lttng_event
*tmp_event
= lttng_event_create();
525 ret_code
= LTTNG_ERR_NOMEM
;
529 if (lttng_strncpy(tmp_event
->name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
)) {
530 lttng_event_destroy(tmp_event
);
531 ret_code
= LTTNG_ERR_FATAL
;
536 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
537 tmp_event
->enabled
= event
->enabled
;
538 tmp_event
->filter
= (unsigned char) !!event
->filter_expression
;
540 switch (event
->event
->instrumentation
) {
541 case LTTNG_KERNEL_ABI_TRACEPOINT
:
542 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
544 case LTTNG_KERNEL_ABI_KRETPROBE
:
545 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
546 memcpy(&tmp_event
->attr
.probe
, &event
->event
->u
.kprobe
,
547 sizeof(struct lttng_kernel_abi_kprobe
));
549 case LTTNG_KERNEL_ABI_KPROBE
:
550 tmp_event
->type
= LTTNG_EVENT_PROBE
;
551 memcpy(&tmp_event
->attr
.probe
, &event
->event
->u
.kprobe
,
552 sizeof(struct lttng_kernel_abi_kprobe
));
554 case LTTNG_KERNEL_ABI_UPROBE
:
555 tmp_event
->type
= LTTNG_EVENT_USERSPACE_PROBE
;
557 case LTTNG_KERNEL_ABI_FUNCTION
:
558 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
559 memcpy(&(tmp_event
->attr
.ftrace
), &event
->event
->u
.ftrace
,
560 sizeof(struct lttng_kernel_abi_function
));
562 case LTTNG_KERNEL_ABI_NOOP
:
563 tmp_event
->type
= LTTNG_EVENT_NOOP
;
565 case LTTNG_KERNEL_ABI_SYSCALL
:
566 tmp_event
->type
= LTTNG_EVENT_SYSCALL
;
568 case LTTNG_KERNEL_ABI_ALL
:
575 if (event
->userspace_probe_location
) {
576 struct lttng_userspace_probe_location
*location_copy
=
577 lttng_userspace_probe_location_copy(
578 event
->userspace_probe_location
);
580 if (!location_copy
) {
581 lttng_event_destroy(tmp_event
);
582 ret_code
= LTTNG_ERR_NOMEM
;
586 ret
= lttng_event_set_userspace_probe_location(
587 tmp_event
, location_copy
);
589 lttng_event_destroy(tmp_event
);
590 lttng_userspace_probe_location_destroy(
592 ret_code
= LTTNG_ERR_INVALID
;
597 ret
= lttng_event_serialize(tmp_event
, 0, NULL
,
598 event
->filter_expression
, 0, NULL
, reply_payload
);
599 lttng_event_destroy(tmp_event
);
601 ret_code
= LTTNG_ERR_FATAL
;
612 * Add URI so the consumer output object. Set the correct path depending on the
613 * domain adding the default trace directory.
615 static enum lttng_error_code
add_uri_to_consumer(
616 const struct ltt_session
*session
,
617 struct consumer_output
*consumer
,
618 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
621 enum lttng_error_code ret_code
= LTTNG_OK
;
625 if (consumer
== NULL
) {
626 DBG("No consumer detected. Don't add URI. Stopping.");
627 ret_code
= LTTNG_ERR_NO_CONSUMER
;
632 case LTTNG_DOMAIN_KERNEL
:
633 ret
= lttng_strncpy(consumer
->domain_subdir
,
634 DEFAULT_KERNEL_TRACE_DIR
,
635 sizeof(consumer
->domain_subdir
));
637 case LTTNG_DOMAIN_UST
:
638 ret
= lttng_strncpy(consumer
->domain_subdir
,
639 DEFAULT_UST_TRACE_DIR
,
640 sizeof(consumer
->domain_subdir
));
644 * This case is possible is we try to add the URI to the global
645 * tracing session consumer object which in this case there is
648 memset(consumer
->domain_subdir
, 0,
649 sizeof(consumer
->domain_subdir
));
653 ERR("Failed to initialize consumer output domain subdirectory");
654 ret_code
= LTTNG_ERR_FATAL
;
658 switch (uri
->dtype
) {
661 DBG2("Setting network URI to consumer");
663 if (consumer
->type
== CONSUMER_DST_NET
) {
664 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
665 consumer
->dst
.net
.control_isset
) ||
666 (uri
->stype
== LTTNG_STREAM_DATA
&&
667 consumer
->dst
.net
.data_isset
)) {
668 ret_code
= LTTNG_ERR_URL_EXIST
;
672 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
675 /* Set URI into consumer output object */
676 ret
= consumer_set_network_uri(session
, consumer
, uri
);
678 ret_code
= (lttng_error_code
) -ret
;
680 } else if (ret
== 1) {
682 * URI was the same in the consumer so we do not append the subdir
683 * again so to not duplicate output dir.
690 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
691 ret_code
= LTTNG_ERR_INVALID
;
694 DBG2("Setting trace directory path from URI to %s",
696 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
698 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
700 sizeof(consumer
->dst
.session_root_path
));
702 ret_code
= LTTNG_ERR_FATAL
;
705 consumer
->type
= CONSUMER_DST_LOCAL
;
715 * Init tracing by creating trace directory and sending fds kernel consumer.
717 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
720 struct lttng_ht_iter iter
;
721 struct consumer_socket
*socket
;
723 LTTNG_ASSERT(session
);
727 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
728 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
730 pthread_mutex_lock(socket
->lock
);
731 ret
= kernel_consumer_send_session(socket
, session
);
732 pthread_mutex_unlock(socket
->lock
);
734 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
746 * Create a socket to the relayd using the URI.
748 * On success, the relayd_sock pointer is set to the created socket.
749 * Else, it remains untouched and an LTTng error code is returned.
751 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
752 struct lttcomm_relayd_sock
**relayd_sock
,
753 struct consumer_output
*consumer
)
756 enum lttng_error_code status
= LTTNG_OK
;
757 struct lttcomm_relayd_sock
*rsock
;
759 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
760 RELAYD_VERSION_COMM_MINOR
);
762 status
= LTTNG_ERR_FATAL
;
767 * Connect to relayd so we can proceed with a session creation. This call
768 * can possibly block for an arbitrary amount of time to set the health
769 * state to be in poll execution.
772 ret
= relayd_connect(rsock
);
775 ERR("Unable to reach lttng-relayd");
776 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
780 /* Create socket for control stream. */
781 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
782 uint64_t result_flags
;
784 DBG3("Creating relayd stream socket from URI");
786 /* Check relayd version */
787 ret
= relayd_version_check(rsock
);
788 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
789 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
791 } else if (ret
< 0) {
792 ERR("Unable to reach lttng-relayd");
793 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
796 consumer
->relay_major_version
= rsock
->major
;
797 consumer
->relay_minor_version
= rsock
->minor
;
798 ret
= relayd_get_configuration(rsock
, 0,
801 ERR("Unable to get relayd configuration");
802 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
805 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
806 consumer
->relay_allows_clear
= true;
808 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
809 DBG3("Creating relayd data socket from URI");
811 /* Command is not valid */
812 ERR("Relayd invalid stream type: %d", uri
->stype
);
813 status
= LTTNG_ERR_INVALID
;
817 *relayd_sock
= rsock
;
822 /* The returned value is not useful since we are on an error path. */
823 (void) relayd_close(rsock
);
831 * Connect to the relayd using URI and send the socket to the right consumer.
833 * The consumer socket lock must be held by the caller.
835 * Returns LTTNG_OK on success or an LTTng error code on failure.
837 static enum lttng_error_code
send_consumer_relayd_socket(
838 unsigned int session_id
,
839 struct lttng_uri
*relayd_uri
,
840 struct consumer_output
*consumer
,
841 struct consumer_socket
*consumer_sock
,
842 const char *session_name
, const char *hostname
,
843 const char *base_path
, int session_live_timer
,
844 const uint64_t *current_chunk_id
,
845 time_t session_creation_time
,
846 bool session_name_contains_creation_time
)
849 struct lttcomm_relayd_sock
*rsock
= NULL
;
850 enum lttng_error_code status
;
852 /* Connect to relayd and make version check if uri is the control. */
853 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
854 if (status
!= LTTNG_OK
) {
855 goto relayd_comm_error
;
859 /* Set the network sequence index if not set. */
860 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
861 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
863 * Increment net_seq_idx because we are about to transfer the
864 * new relayd socket to the consumer.
865 * Assign unique key so the consumer can match streams.
867 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
868 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
871 /* Send relayd socket to consumer. */
872 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
873 relayd_uri
->stype
, session_id
,
874 session_name
, hostname
, base_path
,
875 session_live_timer
, current_chunk_id
,
876 session_creation_time
, session_name_contains_creation_time
);
878 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
882 /* Flag that the corresponding socket was sent. */
883 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
884 consumer_sock
->control_sock_sent
= 1;
885 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
886 consumer_sock
->data_sock_sent
= 1;
890 * Close socket which was dup on the consumer side. The session daemon does
891 * NOT keep track of the relayd socket(s) once transfer to the consumer.
895 if (status
!= LTTNG_OK
) {
897 * The consumer output for this session should not be used anymore
898 * since the relayd connection failed thus making any tracing or/and
899 * streaming not usable.
901 consumer
->enabled
= 0;
903 (void) relayd_close(rsock
);
911 * Send both relayd sockets to a specific consumer and domain. This is a
912 * helper function to facilitate sending the information to the consumer for a
915 * The consumer socket lock must be held by the caller.
917 * Returns LTTNG_OK, or an LTTng error code on failure.
919 static enum lttng_error_code
send_consumer_relayd_sockets(
920 enum lttng_domain_type domain
,
921 unsigned int session_id
, struct consumer_output
*consumer
,
922 struct consumer_socket
*sock
, const char *session_name
,
923 const char *hostname
, const char *base_path
, int session_live_timer
,
924 const uint64_t *current_chunk_id
, time_t session_creation_time
,
925 bool session_name_contains_creation_time
)
927 enum lttng_error_code status
= LTTNG_OK
;
929 LTTNG_ASSERT(consumer
);
932 /* Sending control relayd socket. */
933 if (!sock
->control_sock_sent
) {
934 status
= send_consumer_relayd_socket(session_id
,
935 &consumer
->dst
.net
.control
, consumer
, sock
,
936 session_name
, hostname
, base_path
, session_live_timer
,
937 current_chunk_id
, session_creation_time
,
938 session_name_contains_creation_time
);
939 if (status
!= LTTNG_OK
) {
944 /* Sending data relayd socket. */
945 if (!sock
->data_sock_sent
) {
946 status
= send_consumer_relayd_socket(session_id
,
947 &consumer
->dst
.net
.data
, consumer
, sock
,
948 session_name
, hostname
, base_path
, session_live_timer
,
949 current_chunk_id
, session_creation_time
,
950 session_name_contains_creation_time
);
951 if (status
!= LTTNG_OK
) {
961 * Setup relayd connections for a tracing session. First creates the socket to
962 * the relayd and send them to the right domain consumer. Consumer type MUST be
965 int cmd_setup_relayd(struct ltt_session
*session
)
968 struct ltt_ust_session
*usess
;
969 struct ltt_kernel_session
*ksess
;
970 struct consumer_socket
*socket
;
971 struct lttng_ht_iter iter
;
972 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
974 LTTNG_ASSERT(session
);
976 usess
= session
->ust_session
;
977 ksess
= session
->kernel_session
;
979 DBG("Setting relayd for session %s", session
->name
);
982 if (session
->current_trace_chunk
) {
983 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
984 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
986 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
987 current_chunk_id
.is_set
= true;
989 ERR("Failed to get current trace chunk id");
995 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
996 && usess
->consumer
->enabled
) {
997 /* For each consumer socket, send relayd sockets */
998 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1000 pthread_mutex_lock(socket
->lock
);
1001 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1002 usess
->consumer
, socket
,
1003 session
->name
, session
->hostname
,
1005 session
->live_timer
,
1006 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1007 session
->creation_time
,
1008 session
->name_contains_creation_time
);
1009 pthread_mutex_unlock(socket
->lock
);
1010 if (ret
!= LTTNG_OK
) {
1013 /* Session is now ready for network streaming. */
1014 session
->net_handle
= 1;
1016 session
->consumer
->relay_major_version
=
1017 usess
->consumer
->relay_major_version
;
1018 session
->consumer
->relay_minor_version
=
1019 usess
->consumer
->relay_minor_version
;
1020 session
->consumer
->relay_allows_clear
=
1021 usess
->consumer
->relay_allows_clear
;
1024 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1025 && ksess
->consumer
->enabled
) {
1026 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1027 socket
, node
.node
) {
1028 pthread_mutex_lock(socket
->lock
);
1029 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1030 ksess
->consumer
, socket
,
1031 session
->name
, session
->hostname
,
1033 session
->live_timer
,
1034 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1035 session
->creation_time
,
1036 session
->name_contains_creation_time
);
1037 pthread_mutex_unlock(socket
->lock
);
1038 if (ret
!= LTTNG_OK
) {
1041 /* Session is now ready for network streaming. */
1042 session
->net_handle
= 1;
1044 session
->consumer
->relay_major_version
=
1045 ksess
->consumer
->relay_major_version
;
1046 session
->consumer
->relay_minor_version
=
1047 ksess
->consumer
->relay_minor_version
;
1048 session
->consumer
->relay_allows_clear
=
1049 ksess
->consumer
->relay_allows_clear
;
1058 * Start a kernel session by opening all necessary streams.
1060 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1063 struct ltt_kernel_channel
*kchan
;
1065 /* Open kernel metadata */
1066 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1067 ret
= kernel_open_metadata(ksess
);
1069 ret
= LTTNG_ERR_KERN_META_FAIL
;
1074 /* Open kernel metadata stream */
1075 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1076 ret
= kernel_open_metadata_stream(ksess
);
1078 ERR("Kernel create metadata stream failed");
1079 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1084 /* For each channel */
1085 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1086 if (kchan
->stream_count
== 0) {
1087 ret
= kernel_open_channel_stream(kchan
);
1089 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1092 /* Update the stream global counter */
1093 ksess
->stream_count_global
+= ret
;
1097 /* Setup kernel consumer socket and send fds to it */
1098 ret
= init_kernel_tracing(ksess
);
1100 ret
= LTTNG_ERR_KERN_START_FAIL
;
1104 /* This start the kernel tracing */
1105 ret
= kernel_start_session(ksess
);
1107 ret
= LTTNG_ERR_KERN_START_FAIL
;
1111 /* Quiescent wait after starting trace */
1112 kernel_wait_quiescent();
1122 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1124 struct ltt_kernel_channel
*kchan
;
1125 bool error_occurred
= false;
1128 if (!ksess
|| !ksess
->active
) {
1131 DBG("Stopping kernel tracing");
1133 ret
= kernel_stop_session(ksess
);
1135 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1139 kernel_wait_quiescent();
1141 /* Flush metadata after stopping (if exists) */
1142 if (ksess
->metadata_stream_fd
>= 0) {
1143 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1145 ERR("Kernel metadata flush failed");
1146 error_occurred
= true;
1150 /* Flush all buffers after stopping */
1151 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1152 ret
= kernel_flush_buffer(kchan
);
1154 ERR("Kernel flush buffer error");
1155 error_occurred
= true;
1160 if (error_occurred
) {
1161 ret
= LTTNG_ERR_UNK
;
1170 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1172 int cmd_disable_channel(struct ltt_session
*session
,
1173 enum lttng_domain_type domain
, char *channel_name
)
1176 struct ltt_ust_session
*usess
;
1178 usess
= session
->ust_session
;
1183 case LTTNG_DOMAIN_KERNEL
:
1185 ret
= channel_kernel_disable(session
->kernel_session
,
1187 if (ret
!= LTTNG_OK
) {
1191 kernel_wait_quiescent();
1194 case LTTNG_DOMAIN_UST
:
1196 struct ltt_ust_channel
*uchan
;
1197 struct lttng_ht
*chan_ht
;
1199 chan_ht
= usess
->domain_global
.channels
;
1201 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1202 if (uchan
== NULL
) {
1203 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1207 ret
= channel_ust_disable(usess
, uchan
);
1208 if (ret
!= LTTNG_OK
) {
1214 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1226 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1228 * The wpipe arguments is used as a notifier for the kernel thread.
1230 int cmd_enable_channel(struct command_ctx
*cmd_ctx
, int sock
, int wpipe
)
1234 ssize_t sock_recv_len
;
1235 struct lttng_channel
*channel
= NULL
;
1236 struct lttng_buffer_view view
;
1237 struct lttng_dynamic_buffer channel_buffer
;
1238 const struct lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
1240 lttng_dynamic_buffer_init(&channel_buffer
);
1241 channel_len
= (size_t) cmd_ctx
->lsm
.u
.channel
.length
;
1242 ret
= lttng_dynamic_buffer_set_size(&channel_buffer
, channel_len
);
1244 ret
= LTTNG_ERR_NOMEM
;
1248 sock_recv_len
= lttcomm_recv_unix_sock(sock
, channel_buffer
.data
,
1250 if (sock_recv_len
< 0 || sock_recv_len
!= channel_len
) {
1251 ERR("Failed to receive \"enable channel\" command payload");
1252 ret
= LTTNG_ERR_INVALID
;
1256 view
= lttng_buffer_view_from_dynamic_buffer(&channel_buffer
, 0, channel_len
);
1257 if (!lttng_buffer_view_is_valid(&view
)) {
1258 ret
= LTTNG_ERR_INVALID
;
1262 if (lttng_channel_create_from_buffer(&view
, &channel
) != channel_len
) {
1263 ERR("Invalid channel payload received in \"enable channel\" command");
1264 ret
= LTTNG_ERR_INVALID
;
1268 ret
= cmd_enable_channel_internal(
1269 cmd_ctx
->session
, &command_domain
, channel
, wpipe
);
1272 lttng_dynamic_buffer_reset(&channel_buffer
);
1273 lttng_channel_destroy(channel
);
1277 static int cmd_enable_channel_internal(struct ltt_session
*session
,
1278 const struct lttng_domain
*domain
,
1279 const struct lttng_channel
*_attr
,
1283 struct ltt_ust_session
*usess
= session
->ust_session
;
1284 struct lttng_ht
*chan_ht
;
1286 struct lttng_channel
*attr
= NULL
;
1288 LTTNG_ASSERT(session
);
1289 LTTNG_ASSERT(_attr
);
1290 LTTNG_ASSERT(domain
);
1292 attr
= lttng_channel_copy(_attr
);
1294 ret
= -LTTNG_ERR_NOMEM
;
1298 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1300 /* Validate channel name */
1301 if (attr
->name
[0] == '.' ||
1302 memchr(attr
->name
, '/', len
) != NULL
) {
1303 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1307 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1312 * If the session is a live session, remove the switch timer, the
1313 * live timer does the same thing but sends also synchronisation
1314 * beacons for inactive streams.
1316 if (session
->live_timer
> 0) {
1317 attr
->attr
.live_timer_interval
= session
->live_timer
;
1318 attr
->attr
.switch_timer_interval
= 0;
1321 /* Check for feature support */
1322 switch (domain
->type
) {
1323 case LTTNG_DOMAIN_KERNEL
:
1325 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1326 /* Sampling position of buffer is not supported */
1327 WARN("Kernel tracer does not support buffer monitoring. "
1328 "Setting the monitor interval timer to 0 "
1329 "(disabled) for channel '%s' of session '%s'",
1330 attr
->name
, session
->name
);
1331 lttng_channel_set_monitor_timer_interval(attr
, 0);
1335 case LTTNG_DOMAIN_UST
:
1337 case LTTNG_DOMAIN_JUL
:
1338 case LTTNG_DOMAIN_LOG4J
:
1339 case LTTNG_DOMAIN_PYTHON
:
1340 if (!agent_tracing_is_enabled()) {
1341 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1342 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1347 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1351 switch (domain
->type
) {
1352 case LTTNG_DOMAIN_KERNEL
:
1354 struct ltt_kernel_channel
*kchan
;
1356 kchan
= trace_kernel_get_channel_by_name(
1357 attr
->name
, session
->kernel_session
);
1358 if (kchan
== NULL
) {
1360 * Don't try to create a channel if the session has been started at
1361 * some point in time before. The tracer does not allow it.
1363 if (session
->has_been_started
) {
1364 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1368 if (session
->snapshot
.nb_output
> 0 ||
1369 session
->snapshot_mode
) {
1370 /* Enforce mmap output for snapshot sessions. */
1371 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1373 ret
= channel_kernel_create(
1374 session
->kernel_session
, attr
, wpipe
);
1375 if (attr
->name
[0] != '\0') {
1376 session
->kernel_session
->has_non_default_channel
= 1;
1379 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1382 if (ret
!= LTTNG_OK
) {
1386 kernel_wait_quiescent();
1389 case LTTNG_DOMAIN_UST
:
1390 case LTTNG_DOMAIN_JUL
:
1391 case LTTNG_DOMAIN_LOG4J
:
1392 case LTTNG_DOMAIN_PYTHON
:
1394 struct ltt_ust_channel
*uchan
;
1399 * Current agent implementation limitations force us to allow
1400 * only one channel at once in "agent" subdomains. Each
1401 * subdomain has a default channel name which must be strictly
1404 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1405 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1406 LTTNG_SYMBOL_NAME_LEN
)) {
1407 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1410 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1411 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1412 LTTNG_SYMBOL_NAME_LEN
)) {
1413 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1416 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1417 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1418 LTTNG_SYMBOL_NAME_LEN
)) {
1419 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1424 chan_ht
= usess
->domain_global
.channels
;
1426 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1427 if (uchan
== NULL
) {
1429 * Don't try to create a channel if the session has been started at
1430 * some point in time before. The tracer does not allow it.
1432 if (session
->has_been_started
) {
1433 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1437 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1438 if (attr
->name
[0] != '\0') {
1439 usess
->has_non_default_channel
= 1;
1442 ret
= channel_ust_enable(usess
, uchan
);
1447 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1451 if (ret
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1452 session
->has_non_mmap_channel
= true;
1457 lttng_channel_destroy(attr
);
1461 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1462 struct ltt_session
*session
,
1463 enum lttng_domain_type domain
,
1464 enum lttng_process_attr process_attr
,
1465 enum lttng_tracking_policy
*policy
)
1467 enum lttng_error_code ret_code
= LTTNG_OK
;
1468 const struct process_attr_tracker
*tracker
;
1471 case LTTNG_DOMAIN_KERNEL
:
1472 if (!session
->kernel_session
) {
1473 ret_code
= LTTNG_ERR_INVALID
;
1476 tracker
= kernel_get_process_attr_tracker(
1477 session
->kernel_session
, process_attr
);
1479 case LTTNG_DOMAIN_UST
:
1480 if (!session
->ust_session
) {
1481 ret_code
= LTTNG_ERR_INVALID
;
1484 tracker
= trace_ust_get_process_attr_tracker(
1485 session
->ust_session
, process_attr
);
1488 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1492 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1494 ret_code
= LTTNG_ERR_INVALID
;
1500 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1501 struct ltt_session
*session
,
1502 enum lttng_domain_type domain
,
1503 enum lttng_process_attr process_attr
,
1504 enum lttng_tracking_policy policy
)
1506 enum lttng_error_code ret_code
= LTTNG_OK
;
1509 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1510 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1511 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1514 ret_code
= LTTNG_ERR_INVALID
;
1519 case LTTNG_DOMAIN_KERNEL
:
1520 if (!session
->kernel_session
) {
1521 ret_code
= LTTNG_ERR_INVALID
;
1524 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1525 session
->kernel_session
, process_attr
, policy
);
1527 case LTTNG_DOMAIN_UST
:
1528 if (!session
->ust_session
) {
1529 ret_code
= LTTNG_ERR_INVALID
;
1532 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1533 session
->ust_session
, process_attr
, policy
);
1536 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1543 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1544 struct ltt_session
*session
,
1545 enum lttng_domain_type domain
,
1546 enum lttng_process_attr process_attr
,
1547 const struct process_attr_value
*value
)
1549 enum lttng_error_code ret_code
= LTTNG_OK
;
1552 case LTTNG_DOMAIN_KERNEL
:
1553 if (!session
->kernel_session
) {
1554 ret_code
= LTTNG_ERR_INVALID
;
1557 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1558 session
->kernel_session
, process_attr
, value
);
1560 case LTTNG_DOMAIN_UST
:
1561 if (!session
->ust_session
) {
1562 ret_code
= LTTNG_ERR_INVALID
;
1565 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1566 session
->ust_session
, process_attr
, value
);
1569 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1576 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1577 struct ltt_session
*session
,
1578 enum lttng_domain_type domain
,
1579 enum lttng_process_attr process_attr
,
1580 const struct process_attr_value
*value
)
1582 enum lttng_error_code ret_code
= LTTNG_OK
;
1585 case LTTNG_DOMAIN_KERNEL
:
1586 if (!session
->kernel_session
) {
1587 ret_code
= LTTNG_ERR_INVALID
;
1590 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1591 session
->kernel_session
, process_attr
, value
);
1593 case LTTNG_DOMAIN_UST
:
1594 if (!session
->ust_session
) {
1595 ret_code
= LTTNG_ERR_INVALID
;
1598 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1599 session
->ust_session
, process_attr
, value
);
1602 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1609 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1610 struct ltt_session
*session
,
1611 enum lttng_domain_type domain
,
1612 enum lttng_process_attr process_attr
,
1613 struct lttng_process_attr_values
**values
)
1615 enum lttng_error_code ret_code
= LTTNG_OK
;
1616 const struct process_attr_tracker
*tracker
;
1617 enum process_attr_tracker_status status
;
1620 case LTTNG_DOMAIN_KERNEL
:
1621 if (!session
->kernel_session
) {
1622 ret_code
= LTTNG_ERR_INVALID
;
1625 tracker
= kernel_get_process_attr_tracker(
1626 session
->kernel_session
, process_attr
);
1628 case LTTNG_DOMAIN_UST
:
1629 if (!session
->ust_session
) {
1630 ret_code
= LTTNG_ERR_INVALID
;
1633 tracker
= trace_ust_get_process_attr_tracker(
1634 session
->ust_session
, process_attr
);
1637 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1642 ret_code
= LTTNG_ERR_INVALID
;
1646 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1648 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1649 ret_code
= LTTNG_OK
;
1651 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1652 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1654 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1655 ret_code
= LTTNG_ERR_NOMEM
;
1658 ret_code
= LTTNG_ERR_UNK
;
1667 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1669 int cmd_disable_event(struct command_ctx
*cmd_ctx
,
1670 struct lttng_event
*event
,
1671 char *filter_expression
,
1672 struct lttng_bytecode
*bytecode
,
1673 struct lttng_event_exclusion
*exclusion
)
1676 const char *event_name
;
1677 const struct ltt_session
*session
= cmd_ctx
->session
;
1678 const char *channel_name
= cmd_ctx
->lsm
.u
.disable
.channel_name
;
1679 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1681 DBG("Disable event command for event \'%s\'", event
->name
);
1684 * Filter and exclusions are simply not handled by the
1685 * disable event command at this time.
1689 (void) filter_expression
;
1692 /* Ignore the presence of filter or exclusion for the event */
1694 event
->exclusion
= 0;
1696 event_name
= event
->name
;
1698 /* Error out on unhandled search criteria */
1699 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1700 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1701 ret
= LTTNG_ERR_UNK
;
1708 case LTTNG_DOMAIN_KERNEL
:
1710 struct ltt_kernel_channel
*kchan
;
1711 struct ltt_kernel_session
*ksess
;
1713 ksess
= session
->kernel_session
;
1716 * If a non-default channel has been created in the
1717 * session, explicitely require that -c chan_name needs
1720 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1721 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1725 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1726 if (kchan
== NULL
) {
1727 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1731 switch (event
->type
) {
1732 case LTTNG_EVENT_ALL
:
1733 case LTTNG_EVENT_TRACEPOINT
:
1734 case LTTNG_EVENT_SYSCALL
:
1735 case LTTNG_EVENT_PROBE
:
1736 case LTTNG_EVENT_FUNCTION
:
1737 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1738 if (event_name
[0] == '\0') {
1739 ret
= event_kernel_disable_event(kchan
,
1742 ret
= event_kernel_disable_event(kchan
,
1743 event_name
, event
->type
);
1745 if (ret
!= LTTNG_OK
) {
1750 ret
= LTTNG_ERR_UNK
;
1754 kernel_wait_quiescent();
1757 case LTTNG_DOMAIN_UST
:
1759 struct ltt_ust_channel
*uchan
;
1760 struct ltt_ust_session
*usess
;
1762 usess
= session
->ust_session
;
1764 if (validate_ust_event_name(event_name
)) {
1765 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1770 * If a non-default channel has been created in the
1771 * session, explicitly require that -c chan_name needs
1774 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1775 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1779 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1781 if (uchan
== NULL
) {
1782 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1786 switch (event
->type
) {
1787 case LTTNG_EVENT_ALL
:
1789 * An empty event name means that everything
1790 * should be disabled.
1792 if (event
->name
[0] == '\0') {
1793 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1795 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1798 if (ret
!= LTTNG_OK
) {
1803 ret
= LTTNG_ERR_UNK
;
1807 DBG3("Disable UST event %s in channel %s completed", event_name
,
1811 case LTTNG_DOMAIN_LOG4J
:
1812 case LTTNG_DOMAIN_JUL
:
1813 case LTTNG_DOMAIN_PYTHON
:
1816 struct ltt_ust_session
*usess
= session
->ust_session
;
1818 LTTNG_ASSERT(usess
);
1820 switch (event
->type
) {
1821 case LTTNG_EVENT_ALL
:
1824 ret
= LTTNG_ERR_UNK
;
1828 agt
= trace_ust_find_agent(usess
, domain
);
1830 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1834 * An empty event name means that everything
1835 * should be disabled.
1837 if (event
->name
[0] == '\0') {
1838 ret
= event_agent_disable_all(usess
, agt
);
1840 ret
= event_agent_disable(usess
, agt
, event_name
);
1842 if (ret
!= LTTNG_OK
) {
1849 ret
= LTTNG_ERR_UND
;
1860 free(filter_expression
);
1865 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1867 int cmd_add_context(struct command_ctx
*cmd_ctx
,
1868 const struct lttng_event_context
*event_context
, int kwpipe
)
1870 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1871 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1872 const struct ltt_session
*session
= cmd_ctx
->session
;
1873 const char *channel_name
= cmd_ctx
->lsm
.u
.context
.channel_name
;
1876 * Don't try to add a context if the session has been started at
1877 * some point in time before. The tracer does not allow it and would
1878 * result in a corrupted trace.
1880 if (cmd_ctx
->session
->has_been_started
) {
1881 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1886 case LTTNG_DOMAIN_KERNEL
:
1887 LTTNG_ASSERT(session
->kernel_session
);
1889 if (session
->kernel_session
->channel_count
== 0) {
1890 /* Create default channel */
1891 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1892 if (ret
!= LTTNG_OK
) {
1895 chan_kern_created
= 1;
1897 /* Add kernel context to kernel tracer */
1898 ret
= context_kernel_add(session
->kernel_session
,
1899 event_context
, channel_name
);
1900 if (ret
!= LTTNG_OK
) {
1904 case LTTNG_DOMAIN_JUL
:
1905 case LTTNG_DOMAIN_LOG4J
:
1908 * Validate channel name.
1909 * If no channel name is given and the domain is JUL or LOG4J,
1910 * set it to the appropriate domain-specific channel name. If
1911 * a name is provided but does not match the expexted channel
1912 * name, return an error.
1914 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1915 strcmp(channel_name
,
1916 DEFAULT_JUL_CHANNEL_NAME
)) {
1917 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1919 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1920 strcmp(channel_name
,
1921 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1922 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1925 /* break is _not_ missing here. */
1927 case LTTNG_DOMAIN_UST
:
1929 struct ltt_ust_session
*usess
= session
->ust_session
;
1930 unsigned int chan_count
;
1932 LTTNG_ASSERT(usess
);
1934 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1935 if (chan_count
== 0) {
1936 struct lttng_channel
*attr
;
1937 /* Create default channel */
1938 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1940 ret
= LTTNG_ERR_FATAL
;
1944 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1945 if (ret
!= LTTNG_OK
) {
1949 channel_attr_destroy(attr
);
1950 chan_ust_created
= 1;
1953 ret
= context_ust_add(usess
, domain
, event_context
,
1955 if (ret
!= LTTNG_OK
) {
1961 ret
= LTTNG_ERR_UND
;
1969 if (chan_kern_created
) {
1970 struct ltt_kernel_channel
*kchan
=
1971 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1972 session
->kernel_session
);
1973 /* Created previously, this should NOT fail. */
1974 LTTNG_ASSERT(kchan
);
1975 kernel_destroy_channel(kchan
);
1978 if (chan_ust_created
) {
1979 struct ltt_ust_channel
*uchan
=
1980 trace_ust_find_channel_by_name(
1981 session
->ust_session
->domain_global
.channels
,
1982 DEFAULT_CHANNEL_NAME
);
1983 /* Created previously, this should NOT fail. */
1984 LTTNG_ASSERT(uchan
);
1985 /* Remove from the channel list of the session. */
1986 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1988 trace_ust_destroy_channel(uchan
);
1994 static inline bool name_starts_with(const char *name
, const char *prefix
)
1996 const size_t max_cmp_len
= std::min(strlen(prefix
), (size_t) LTTNG_SYMBOL_NAME_LEN
);
1998 return !strncmp(name
, prefix
, max_cmp_len
);
2001 /* Perform userspace-specific event name validation */
2002 static int validate_ust_event_name(const char *name
)
2012 * Check name against all internal UST event component namespaces used
2015 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2016 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2017 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2026 * Internal version of cmd_enable_event() with a supplemental
2027 * "internal_event" flag which is used to enable internal events which should
2028 * be hidden from clients. Such events are used in the agent implementation to
2029 * enable the events through which all "agent" events are funeled.
2031 static int _cmd_enable_event(struct ltt_session
*session
,
2032 const struct lttng_domain
*domain
,
2033 char *channel_name
, struct lttng_event
*event
,
2034 char *filter_expression
,
2035 struct lttng_bytecode
*filter
,
2036 struct lttng_event_exclusion
*exclusion
,
2037 int wpipe
, bool internal_event
)
2039 int ret
= 0, channel_created
= 0;
2040 struct lttng_channel
*attr
= NULL
;
2042 LTTNG_ASSERT(session
);
2043 LTTNG_ASSERT(event
);
2044 LTTNG_ASSERT(channel_name
);
2046 /* If we have a filter, we must have its filter expression */
2047 LTTNG_ASSERT(!(!!filter_expression
^ !!filter
));
2049 /* Normalize event name as a globbing pattern */
2050 strutils_normalize_star_glob_pattern(event
->name
);
2052 /* Normalize exclusion names as globbing patterns */
2056 for (i
= 0; i
< exclusion
->count
; i
++) {
2057 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2059 strutils_normalize_star_glob_pattern(name
);
2063 DBG("Enable event command for event \'%s\'", event
->name
);
2067 switch (domain
->type
) {
2068 case LTTNG_DOMAIN_KERNEL
:
2070 struct ltt_kernel_channel
*kchan
;
2073 * If a non-default channel has been created in the
2074 * session, explicitely require that -c chan_name needs
2077 if (session
->kernel_session
->has_non_default_channel
2078 && channel_name
[0] == '\0') {
2079 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2083 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2084 session
->kernel_session
);
2085 if (kchan
== NULL
) {
2086 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2087 LTTNG_BUFFER_GLOBAL
);
2089 ret
= LTTNG_ERR_FATAL
;
2092 if (lttng_strncpy(attr
->name
, channel_name
,
2093 sizeof(attr
->name
))) {
2094 ret
= LTTNG_ERR_INVALID
;
2098 ret
= cmd_enable_channel_internal(
2099 session
, domain
, attr
, wpipe
);
2100 if (ret
!= LTTNG_OK
) {
2103 channel_created
= 1;
2106 /* Get the newly created kernel channel pointer */
2107 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2108 session
->kernel_session
);
2109 if (kchan
== NULL
) {
2110 /* This sould not happen... */
2111 ret
= LTTNG_ERR_FATAL
;
2115 switch (event
->type
) {
2116 case LTTNG_EVENT_ALL
:
2118 char *filter_expression_a
= NULL
;
2119 struct lttng_bytecode
*filter_a
= NULL
;
2122 * We need to duplicate filter_expression and filter,
2123 * because ownership is passed to first enable
2126 if (filter_expression
) {
2127 filter_expression_a
= strdup(filter_expression
);
2128 if (!filter_expression_a
) {
2129 ret
= LTTNG_ERR_FATAL
;
2134 filter_a
= (lttng_bytecode
*) zmalloc(sizeof(*filter_a
) + filter
->len
);
2136 free(filter_expression_a
);
2137 ret
= LTTNG_ERR_FATAL
;
2140 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2142 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2143 ret
= event_kernel_enable_event(kchan
, event
,
2144 filter_expression
, filter
);
2145 /* We have passed ownership */
2146 filter_expression
= NULL
;
2148 if (ret
!= LTTNG_OK
) {
2149 if (channel_created
) {
2150 /* Let's not leak a useless channel. */
2151 kernel_destroy_channel(kchan
);
2153 free(filter_expression_a
);
2157 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2158 ret
= event_kernel_enable_event(kchan
, event
,
2159 filter_expression_a
, filter_a
);
2160 /* We have passed ownership */
2161 filter_expression_a
= NULL
;
2163 if (ret
!= LTTNG_OK
) {
2168 case LTTNG_EVENT_PROBE
:
2169 case LTTNG_EVENT_USERSPACE_PROBE
:
2170 case LTTNG_EVENT_FUNCTION
:
2171 case LTTNG_EVENT_FUNCTION_ENTRY
:
2172 case LTTNG_EVENT_TRACEPOINT
:
2173 ret
= event_kernel_enable_event(kchan
, event
,
2174 filter_expression
, filter
);
2175 /* We have passed ownership */
2176 filter_expression
= NULL
;
2178 if (ret
!= LTTNG_OK
) {
2179 if (channel_created
) {
2180 /* Let's not leak a useless channel. */
2181 kernel_destroy_channel(kchan
);
2186 case LTTNG_EVENT_SYSCALL
:
2187 ret
= event_kernel_enable_event(kchan
, event
,
2188 filter_expression
, filter
);
2189 /* We have passed ownership */
2190 filter_expression
= NULL
;
2192 if (ret
!= LTTNG_OK
) {
2197 ret
= LTTNG_ERR_UNK
;
2201 kernel_wait_quiescent();
2204 case LTTNG_DOMAIN_UST
:
2206 struct ltt_ust_channel
*uchan
;
2207 struct ltt_ust_session
*usess
= session
->ust_session
;
2209 LTTNG_ASSERT(usess
);
2212 * If a non-default channel has been created in the
2213 * session, explicitely require that -c chan_name needs
2216 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2217 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2221 /* Get channel from global UST domain */
2222 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2224 if (uchan
== NULL
) {
2225 /* Create default channel */
2226 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2227 usess
->buffer_type
);
2229 ret
= LTTNG_ERR_FATAL
;
2232 if (lttng_strncpy(attr
->name
, channel_name
,
2233 sizeof(attr
->name
))) {
2234 ret
= LTTNG_ERR_INVALID
;
2238 ret
= cmd_enable_channel_internal(
2239 session
, domain
, attr
, wpipe
);
2240 if (ret
!= LTTNG_OK
) {
2244 /* Get the newly created channel reference back */
2245 uchan
= trace_ust_find_channel_by_name(
2246 usess
->domain_global
.channels
, channel_name
);
2247 LTTNG_ASSERT(uchan
);
2250 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2252 * Don't allow users to add UST events to channels which
2253 * are assigned to a userspace subdomain (JUL, Log4J,
2256 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2260 if (!internal_event
) {
2262 * Ensure the event name is not reserved for internal
2265 ret
= validate_ust_event_name(event
->name
);
2267 WARN("Userspace event name %s failed validation.",
2269 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2274 /* At this point, the session and channel exist on the tracer */
2275 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2276 filter_expression
, filter
, exclusion
,
2278 /* We have passed ownership */
2279 filter_expression
= NULL
;
2282 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2283 goto already_enabled
;
2284 } else if (ret
!= LTTNG_OK
) {
2289 case LTTNG_DOMAIN_LOG4J
:
2290 case LTTNG_DOMAIN_JUL
:
2291 case LTTNG_DOMAIN_PYTHON
:
2293 const char *default_event_name
, *default_chan_name
;
2295 struct lttng_event uevent
;
2296 struct lttng_domain tmp_dom
;
2297 struct ltt_ust_session
*usess
= session
->ust_session
;
2299 LTTNG_ASSERT(usess
);
2301 if (!agent_tracing_is_enabled()) {
2302 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2303 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2307 agt
= trace_ust_find_agent(usess
, domain
->type
);
2309 agt
= agent_create(domain
->type
);
2311 ret
= LTTNG_ERR_NOMEM
;
2314 agent_add(agt
, usess
->agents
);
2317 /* Create the default tracepoint. */
2318 memset(&uevent
, 0, sizeof(uevent
));
2319 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2320 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2321 default_event_name
= event_get_default_agent_ust_name(
2323 if (!default_event_name
) {
2324 ret
= LTTNG_ERR_FATAL
;
2327 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2328 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2331 * The domain type is changed because we are about to enable the
2332 * default channel and event for the JUL domain that are hardcoded.
2333 * This happens in the UST domain.
2335 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2336 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2338 switch (domain
->type
) {
2339 case LTTNG_DOMAIN_LOG4J
:
2340 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2342 case LTTNG_DOMAIN_JUL
:
2343 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2345 case LTTNG_DOMAIN_PYTHON
:
2346 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2349 /* The switch/case we are in makes this impossible */
2354 char *filter_expression_copy
= NULL
;
2355 struct lttng_bytecode
*filter_copy
= NULL
;
2358 const size_t filter_size
= sizeof(
2359 struct lttng_bytecode
)
2362 filter_copy
= (lttng_bytecode
*) zmalloc(filter_size
);
2364 ret
= LTTNG_ERR_NOMEM
;
2367 memcpy(filter_copy
, filter
, filter_size
);
2369 filter_expression_copy
=
2370 strdup(filter_expression
);
2371 if (!filter_expression
) {
2372 ret
= LTTNG_ERR_NOMEM
;
2375 if (!filter_expression_copy
|| !filter_copy
) {
2376 free(filter_expression_copy
);
2382 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2383 (char *) default_chan_name
,
2384 &uevent
, filter_expression_copy
,
2385 filter_copy
, NULL
, wpipe
);
2388 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2389 goto already_enabled
;
2390 } else if (ret
!= LTTNG_OK
) {
2394 /* The wild card * means that everything should be enabled. */
2395 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2396 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2399 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2403 filter_expression
= NULL
;
2404 if (ret
!= LTTNG_OK
) {
2411 ret
= LTTNG_ERR_UND
;
2419 free(filter_expression
);
2422 channel_attr_destroy(attr
);
2428 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2429 * We own filter, exclusion, and filter_expression.
2431 int cmd_enable_event(struct command_ctx
*cmd_ctx
,
2432 struct lttng_event
*event
,
2433 char *filter_expression
,
2434 struct lttng_event_exclusion
*exclusion
,
2435 struct lttng_bytecode
*bytecode
,
2440 * Copied to ensure proper alignment since 'lsm' is a packed structure.
2442 const lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
2445 * The ownership of the following parameters is transferred to
2446 * _cmd_enable_event:
2448 * - filter_expression,
2452 ret
= _cmd_enable_event(cmd_ctx
->session
,
2454 cmd_ctx
->lsm
.u
.enable
.channel_name
, event
,
2455 filter_expression
, bytecode
, exclusion
, wpipe
, false);
2456 filter_expression
= NULL
;
2463 * Enable an event which is internal to LTTng. An internal should
2464 * never be made visible to clients and are immune to checks such as
2467 static int cmd_enable_event_internal(struct ltt_session
*session
,
2468 const struct lttng_domain
*domain
,
2469 char *channel_name
, struct lttng_event
*event
,
2470 char *filter_expression
,
2471 struct lttng_bytecode
*filter
,
2472 struct lttng_event_exclusion
*exclusion
,
2475 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2476 filter_expression
, filter
, exclusion
, wpipe
, true);
2480 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2482 enum lttng_error_code
cmd_list_tracepoints(enum lttng_domain_type domain
,
2483 struct lttng_payload
*reply_payload
)
2485 enum lttng_error_code ret_code
;
2487 ssize_t i
, nb_events
= 0;
2488 struct lttng_event
*events
= NULL
;
2489 struct lttcomm_list_command_header reply_command_header
= {};
2490 size_t reply_command_header_offset
;
2492 assert(reply_payload
);
2494 /* Reserve space for command reply header. */
2495 reply_command_header_offset
= reply_payload
->buffer
.size
;
2496 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2497 reply_command_header_offset
+
2498 sizeof(struct lttcomm_list_command_header
));
2500 ret_code
= LTTNG_ERR_NOMEM
;
2505 case LTTNG_DOMAIN_KERNEL
:
2506 nb_events
= kernel_list_events(&events
);
2507 if (nb_events
< 0) {
2508 ret_code
= LTTNG_ERR_KERN_LIST_FAIL
;
2512 case LTTNG_DOMAIN_UST
:
2513 nb_events
= ust_app_list_events(&events
);
2514 if (nb_events
< 0) {
2515 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2519 case LTTNG_DOMAIN_LOG4J
:
2520 case LTTNG_DOMAIN_JUL
:
2521 case LTTNG_DOMAIN_PYTHON
:
2522 nb_events
= agent_list_events(&events
, domain
);
2523 if (nb_events
< 0) {
2524 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2529 ret_code
= LTTNG_ERR_UND
;
2533 for (i
= 0; i
< nb_events
; i
++) {
2534 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2537 ret_code
= LTTNG_ERR_NOMEM
;
2542 if (nb_events
> UINT32_MAX
) {
2543 ERR("Tracepoint count would overflow the tracepoint listing command's reply");
2544 ret_code
= LTTNG_ERR_OVERFLOW
;
2548 /* Update command reply header. */
2549 reply_command_header
.count
= (uint32_t) nb_events
;
2550 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
2551 sizeof(reply_command_header
));
2553 ret_code
= LTTNG_OK
;
2560 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2562 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2563 struct lttng_event_field
**fields
)
2566 ssize_t nb_fields
= 0;
2569 case LTTNG_DOMAIN_UST
:
2570 nb_fields
= ust_app_list_event_fields(fields
);
2571 if (nb_fields
< 0) {
2572 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2576 case LTTNG_DOMAIN_KERNEL
:
2577 default: /* fall-through */
2578 ret
= LTTNG_ERR_UND
;
2585 /* Return negative value to differentiate return code */
2589 enum lttng_error_code
cmd_list_syscalls(
2590 struct lttng_payload
*reply_payload
)
2592 enum lttng_error_code ret_code
;
2593 ssize_t nb_events
, i
;
2595 struct lttng_event
*events
= NULL
;
2596 struct lttcomm_list_command_header reply_command_header
= {};
2597 size_t reply_command_header_offset
;
2599 assert(reply_payload
);
2601 /* Reserve space for command reply header. */
2602 reply_command_header_offset
= reply_payload
->buffer
.size
;
2603 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2604 reply_command_header_offset
+
2605 sizeof(struct lttcomm_list_command_header
));
2607 ret_code
= LTTNG_ERR_NOMEM
;
2611 nb_events
= syscall_table_list(&events
);
2612 if (nb_events
< 0) {
2613 ret_code
= (enum lttng_error_code
) -nb_events
;
2617 for (i
= 0; i
< nb_events
; i
++) {
2618 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2621 ret_code
= LTTNG_ERR_NOMEM
;
2626 if (nb_events
> UINT32_MAX
) {
2627 ERR("Syscall count would overflow the syscall listing command's reply");
2628 ret_code
= LTTNG_ERR_OVERFLOW
;
2632 /* Update command reply header. */
2633 reply_command_header
.count
= (uint32_t) nb_events
;
2634 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
2635 sizeof(reply_command_header
));
2637 ret_code
= LTTNG_OK
;
2644 * Command LTTNG_START_TRACE processed by the client thread.
2646 * Called with session mutex held.
2648 int cmd_start_trace(struct ltt_session
*session
)
2650 enum lttng_error_code ret
;
2651 unsigned long nb_chan
= 0;
2652 struct ltt_kernel_session
*ksession
;
2653 struct ltt_ust_session
*usess
;
2654 const bool session_rotated_after_last_stop
=
2655 session
->rotated_after_last_stop
;
2656 const bool session_cleared_after_last_stop
=
2657 session
->cleared_after_last_stop
;
2659 LTTNG_ASSERT(session
);
2661 /* Ease our life a bit ;) */
2662 ksession
= session
->kernel_session
;
2663 usess
= session
->ust_session
;
2665 /* Is the session already started? */
2666 if (session
->active
) {
2667 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2668 /* Perform nothing */
2672 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2673 !session
->current_trace_chunk
) {
2675 * A rotation was launched while the session was stopped and
2676 * it has not been completed yet. It is not possible to start
2677 * the session since starting the session here would require a
2678 * rotation from "NULL" to a new trace chunk. That rotation
2679 * would overlap with the ongoing rotation, which is not
2682 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2684 ret
= LTTNG_ERR_ROTATION_PENDING
;
2689 * Starting a session without channel is useless since after that it's not
2690 * possible to enable channel thus inform the client.
2692 if (usess
&& usess
->domain_global
.channels
) {
2693 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2696 nb_chan
+= ksession
->channel_count
;
2699 ret
= LTTNG_ERR_NO_CHANNEL
;
2703 session
->active
= 1;
2704 session
->rotated_after_last_stop
= false;
2705 session
->cleared_after_last_stop
= false;
2706 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2707 if (!session
->has_been_started
) {
2708 struct lttng_trace_chunk
*trace_chunk
;
2710 DBG("Creating initial trace chunk of session \"%s\"",
2712 trace_chunk
= session_create_new_trace_chunk(
2713 session
, NULL
, NULL
, NULL
);
2715 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2718 LTTNG_ASSERT(!session
->current_trace_chunk
);
2719 ret
= (lttng_error_code
) session_set_trace_chunk(session
, trace_chunk
,
2721 lttng_trace_chunk_put(trace_chunk
);
2723 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2727 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2730 * Rotate existing streams into the new chunk.
2731 * This is a "quiet" rotation has no client has
2732 * explicitly requested this operation.
2734 * There is also no need to wait for the rotation
2735 * to complete as it will happen immediately. No data
2736 * was produced as the session was stopped, so the
2737 * rotation should happen on reception of the command.
2739 ret
= (lttng_error_code
) cmd_rotate_session(session
, NULL
, true,
2740 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2741 if (ret
!= LTTNG_OK
) {
2747 /* Kernel tracing */
2748 if (ksession
!= NULL
) {
2749 DBG("Start kernel tracing session %s", session
->name
);
2750 ret
= (lttng_error_code
) start_kernel_session(ksession
);
2751 if (ret
!= LTTNG_OK
) {
2756 /* Flag session that trace should start automatically */
2758 int int_ret
= ust_app_start_trace_all(usess
);
2761 ret
= LTTNG_ERR_UST_START_FAIL
;
2767 * Open a packet in every stream of the session to ensure that viewers
2768 * can correctly identify the boundaries of the periods during which
2769 * tracing was active for this session.
2771 ret
= session_open_packets(session
);
2772 if (ret
!= LTTNG_OK
) {
2777 * Clear the flag that indicates that a rotation was done while the
2778 * session was stopped.
2780 session
->rotated_after_last_stop
= false;
2782 if (session
->rotate_timer_period
) {
2783 int int_ret
= timer_session_rotation_schedule_timer_start(
2784 session
, session
->rotate_timer_period
);
2787 ERR("Failed to enable rotate timer");
2788 ret
= LTTNG_ERR_UNK
;
2796 if (ret
== LTTNG_OK
) {
2797 /* Flag this after a successful start. */
2798 session
->has_been_started
|= 1;
2800 session
->active
= 0;
2801 /* Restore initial state on error. */
2802 session
->rotated_after_last_stop
=
2803 session_rotated_after_last_stop
;
2804 session
->cleared_after_last_stop
=
2805 session_cleared_after_last_stop
;
2812 * Command LTTNG_STOP_TRACE processed by the client thread.
2814 int cmd_stop_trace(struct ltt_session
*session
)
2817 struct ltt_kernel_session
*ksession
;
2818 struct ltt_ust_session
*usess
;
2820 LTTNG_ASSERT(session
);
2822 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2824 ksession
= session
->kernel_session
;
2825 usess
= session
->ust_session
;
2827 /* Session is not active. Skip everything and inform the client. */
2828 if (!session
->active
) {
2829 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2833 ret
= stop_kernel_session(ksession
);
2834 if (ret
!= LTTNG_OK
) {
2838 if (usess
&& usess
->active
) {
2839 ret
= ust_app_stop_trace_all(usess
);
2841 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2846 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2848 /* Flag inactive after a successful stop. */
2849 session
->active
= 0;
2857 * Set the base_path of the session only if subdir of a control uris is set.
2858 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2860 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2862 struct lttng_uri
*uris
)
2867 for (i
= 0; i
< nb_uri
; i
++) {
2868 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2869 uris
[i
].subdir
[0] == '\0') {
2870 /* Not interested in these URIs */
2874 if (session
->base_path
!= NULL
) {
2875 free(session
->base_path
);
2876 session
->base_path
= NULL
;
2879 /* Set session base_path */
2880 session
->base_path
= strdup(uris
[i
].subdir
);
2881 if (!session
->base_path
) {
2882 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2883 uris
[i
].subdir
, session
->name
);
2884 ret
= LTTNG_ERR_NOMEM
;
2887 DBG2("Setting base path \"%s\" for session \"%s\"",
2888 session
->base_path
, session
->name
);
2896 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2898 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2899 struct lttng_uri
*uris
)
2902 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2903 struct ltt_ust_session
*usess
= session
->ust_session
;
2905 LTTNG_ASSERT(session
);
2907 LTTNG_ASSERT(nb_uri
> 0);
2909 /* Can't set consumer URI if the session is active. */
2910 if (session
->active
) {
2911 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2916 * Set the session base path if any. This is done inside
2917 * cmd_set_consumer_uri to preserve backward compatibility of the
2918 * previous session creation api vs the session descriptor api.
2920 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2921 if (ret
!= LTTNG_OK
) {
2925 /* Set the "global" consumer URIs */
2926 for (i
= 0; i
< nb_uri
; i
++) {
2927 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2929 if (ret
!= LTTNG_OK
) {
2934 /* Set UST session URIs */
2935 if (session
->ust_session
) {
2936 for (i
= 0; i
< nb_uri
; i
++) {
2937 ret
= add_uri_to_consumer(session
,
2938 session
->ust_session
->consumer
,
2939 &uris
[i
], LTTNG_DOMAIN_UST
);
2940 if (ret
!= LTTNG_OK
) {
2946 /* Set kernel session URIs */
2947 if (session
->kernel_session
) {
2948 for (i
= 0; i
< nb_uri
; i
++) {
2949 ret
= add_uri_to_consumer(session
,
2950 session
->kernel_session
->consumer
,
2951 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2952 if (ret
!= LTTNG_OK
) {
2959 * Make sure to set the session in output mode after we set URI since a
2960 * session can be created without URL (thus flagged in no output mode).
2962 session
->output_traces
= 1;
2964 ksess
->output_traces
= 1;
2968 usess
->output_traces
= 1;
2979 enum lttng_error_code
set_session_output_from_descriptor(
2980 struct ltt_session
*session
,
2981 const struct lttng_session_descriptor
*descriptor
)
2984 enum lttng_error_code ret_code
= LTTNG_OK
;
2985 enum lttng_session_descriptor_type session_type
=
2986 lttng_session_descriptor_get_type(descriptor
);
2987 enum lttng_session_descriptor_output_type output_type
=
2988 lttng_session_descriptor_get_output_type(descriptor
);
2989 struct lttng_uri uris
[2] = {};
2990 size_t uri_count
= 0;
2992 switch (output_type
) {
2993 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2995 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2996 lttng_session_descriptor_get_local_output_uri(descriptor
,
3000 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3001 lttng_session_descriptor_get_network_output_uris(descriptor
,
3002 &uris
[0], &uris
[1]);
3006 ret_code
= LTTNG_ERR_INVALID
;
3010 switch (session_type
) {
3011 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3013 struct snapshot_output
*new_output
= NULL
;
3015 new_output
= snapshot_output_alloc();
3017 ret_code
= LTTNG_ERR_NOMEM
;
3021 ret
= snapshot_output_init_with_uri(session
,
3022 DEFAULT_SNAPSHOT_MAX_SIZE
,
3023 NULL
, uris
, uri_count
, session
->consumer
,
3024 new_output
, &session
->snapshot
);
3026 ret_code
= (ret
== -ENOMEM
) ?
3027 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3028 snapshot_output_destroy(new_output
);
3031 snapshot_add_output(&session
->snapshot
, new_output
);
3034 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3035 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3037 ret_code
= (lttng_error_code
) cmd_set_consumer_uri(session
, uri_count
, uris
);
3041 ret_code
= LTTNG_ERR_INVALID
;
3049 enum lttng_error_code
cmd_create_session_from_descriptor(
3050 struct lttng_session_descriptor
*descriptor
,
3051 const lttng_sock_cred
*creds
,
3052 const char *home_path
)
3055 enum lttng_error_code ret_code
;
3056 const char *session_name
;
3057 struct ltt_session
*new_session
= NULL
;
3058 enum lttng_session_descriptor_status descriptor_status
;
3060 session_lock_list();
3062 if (*home_path
!= '/') {
3063 ERR("Home path provided by client is not absolute");
3064 ret_code
= LTTNG_ERR_INVALID
;
3069 descriptor_status
= lttng_session_descriptor_get_session_name(
3070 descriptor
, &session_name
);
3071 switch (descriptor_status
) {
3072 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3074 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3075 session_name
= NULL
;
3078 ret_code
= LTTNG_ERR_INVALID
;
3082 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3084 if (ret_code
!= LTTNG_OK
) {
3088 if (!session_name
) {
3089 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3092 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3097 if (!lttng_session_descriptor_is_output_destination_initialized(
3100 * Only include the session's creation time in the output
3101 * destination if the name of the session itself was
3102 * not auto-generated.
3104 ret_code
= lttng_session_descriptor_set_default_output(
3106 session_name
? &new_session
->creation_time
: NULL
,
3108 if (ret_code
!= LTTNG_OK
) {
3112 new_session
->has_user_specified_directory
=
3113 lttng_session_descriptor_has_output_directory(
3117 switch (lttng_session_descriptor_get_type(descriptor
)) {
3118 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3119 new_session
->snapshot_mode
= 1;
3121 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3122 new_session
->live_timer
=
3123 lttng_session_descriptor_live_get_timer_interval(
3130 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3131 if (ret_code
!= LTTNG_OK
) {
3134 new_session
->consumer
->enabled
= 1;
3135 ret_code
= LTTNG_OK
;
3137 /* Release reference provided by the session_create function. */
3138 session_put(new_session
);
3139 if (ret_code
!= LTTNG_OK
&& new_session
) {
3140 /* Release the global reference on error. */
3141 session_destroy(new_session
);
3143 session_unlock_list();
3147 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3148 struct lttng_session_descriptor
**return_descriptor
)
3151 size_t payload_size
;
3152 struct lttng_dynamic_buffer payload
;
3153 struct lttng_buffer_view home_dir_view
;
3154 struct lttng_buffer_view session_descriptor_view
;
3155 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3156 enum lttng_error_code ret_code
;
3158 lttng_dynamic_buffer_init(&payload
);
3159 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
>=
3161 ret_code
= LTTNG_ERR_INVALID
;
3164 if (cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
>
3165 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3166 ret_code
= LTTNG_ERR_INVALID
;
3170 payload_size
= cmd_ctx
->lsm
.u
.create_session
.home_dir_size
+
3171 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
;
3172 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3174 ret_code
= LTTNG_ERR_NOMEM
;
3178 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3180 ERR("Reception of session descriptor failed, aborting.");
3181 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3185 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3188 cmd_ctx
->lsm
.u
.create_session
.home_dir_size
);
3189 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
> 0 &&
3190 !lttng_buffer_view_is_valid(&home_dir_view
)) {
3191 ERR("Invalid payload in \"create session\" command: buffer too short to contain home directory");
3192 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3196 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3198 cmd_ctx
->lsm
.u
.create_session
.home_dir_size
,
3199 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
);
3200 if (!lttng_buffer_view_is_valid(&session_descriptor_view
)) {
3201 ERR("Invalid payload in \"create session\" command: buffer too short to contain session descriptor");
3202 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3206 ret
= lttng_session_descriptor_create_from_buffer(
3207 &session_descriptor_view
, &session_descriptor
);
3209 ERR("Failed to create session descriptor from payload of \"create session\" command");
3210 ret_code
= LTTNG_ERR_INVALID
;
3215 * Sets the descriptor's auto-generated properties (name, output) if
3218 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3220 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3221 if (ret_code
!= LTTNG_OK
) {
3225 ret_code
= LTTNG_OK
;
3226 *return_descriptor
= session_descriptor
;
3227 session_descriptor
= NULL
;
3229 lttng_dynamic_buffer_reset(&payload
);
3230 lttng_session_descriptor_destroy(session_descriptor
);
3235 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3236 void *_reply_context
)
3240 const struct cmd_destroy_session_reply_context
*reply_context
=
3241 (cmd_destroy_session_reply_context
*) _reply_context
;
3242 struct lttng_dynamic_buffer payload
;
3243 struct lttcomm_session_destroy_command_header cmd_header
;
3244 struct lttng_trace_archive_location
*location
= NULL
;
3245 struct lttcomm_lttng_msg llm
= {
3246 .cmd_type
= LTTNG_DESTROY_SESSION
,
3247 .ret_code
= reply_context
->destruction_status
,
3250 sizeof(struct lttcomm_session_destroy_command_header
),
3253 size_t payload_size_before_location
;
3255 lttng_dynamic_buffer_init(&payload
);
3257 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3259 ERR("Failed to append session destruction message");
3263 cmd_header
.rotation_state
=
3264 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3265 session
->rotation_state
:
3266 LTTNG_ROTATION_STATE_NO_ROTATION
);
3267 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3268 sizeof(cmd_header
));
3270 ERR("Failed to append session destruction command header");
3274 if (!reply_context
->implicit_rotation_on_destroy
) {
3275 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3279 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3280 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3285 location
= session_get_trace_archive_location(session
);
3287 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3292 payload_size_before_location
= payload
.size
;
3293 comm_ret
= lttng_trace_archive_location_serialize(location
,
3295 lttng_trace_archive_location_put(location
);
3297 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3301 /* Update the message to indicate the location's length. */
3302 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3303 payload
.size
- payload_size_before_location
;
3305 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3306 payload
.data
, payload
.size
);
3307 if (comm_ret
!= (ssize_t
) payload
.size
) {
3308 ERR("Failed to send result of the destruction of session \"%s\" to client",
3312 ret
= close(reply_context
->reply_sock_fd
);
3314 PERROR("Failed to close client socket in deferred session destroy reply");
3316 lttng_dynamic_buffer_reset(&payload
);
3317 free(_reply_context
);
3321 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3323 * Called with session lock held.
3325 int cmd_destroy_session(struct ltt_session
*session
,
3326 struct notification_thread_handle
*notification_thread_handle
,
3330 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3331 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3334 reply_context
= (cmd_destroy_session_reply_context
*) zmalloc(sizeof(*reply_context
));
3335 if (!reply_context
) {
3336 ret
= LTTNG_ERR_NOMEM
;
3339 reply_context
->reply_sock_fd
= *sock_fd
;
3343 LTTNG_ASSERT(session
);
3345 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3347 if (session
->active
) {
3348 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3350 ret
= cmd_stop_trace(session
);
3351 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3352 /* Carry on with the destruction of the session. */
3353 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3354 session
->name
, lttng_strerror(-ret
));
3355 destruction_last_error
= (lttng_error_code
) ret
;
3359 if (session
->rotation_schedule_timer_enabled
) {
3360 if (timer_session_rotation_schedule_timer_stop(
3362 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3364 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3368 if (session
->rotate_size
) {
3369 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3370 session
->rotate_size
= 0;
3373 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3375 * Perform a last rotation on destruction if rotations have
3376 * occurred during the session's lifetime.
3378 ret
= cmd_rotate_session(session
, NULL
, false,
3379 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3380 if (ret
!= LTTNG_OK
) {
3381 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3382 session
->name
, lttng_strerror(-ret
));
3383 destruction_last_error
= (lttng_error_code
) -ret
;
3385 if (reply_context
) {
3386 reply_context
->implicit_rotation_on_destroy
= true;
3388 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3390 * The user has not triggered a session rotation. However, to
3391 * ensure all data has been consumed, the session is rotated
3392 * to a 'null' trace chunk before it is destroyed.
3394 * This is a "quiet" rotation meaning that no notification is
3395 * emitted and no renaming of the current trace chunk takes
3398 ret
= cmd_rotate_session(session
, NULL
, true,
3399 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3401 * Rotation operations may not be supported by the kernel
3402 * tracer. Hence, do not consider this implicit rotation as
3403 * a session destruction error. The library has already stopped
3404 * the session and waited for pending data; there is nothing
3405 * left to do but complete the destruction of the session.
3407 if (ret
!= LTTNG_OK
&&
3408 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3409 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3410 session
->name
, lttng_strerror(ret
));
3411 destruction_last_error
= (lttng_error_code
) -ret
;
3415 if (session
->shm_path
[0]) {
3417 * When a session is created with an explicit shm_path,
3418 * the consumer daemon will create its shared memory files
3419 * at that location and will *not* unlink them. This is normal
3420 * as the intention of that feature is to make it possible
3421 * to retrieve the content of those files should a crash occur.
3423 * To ensure the content of those files can be used, the
3424 * sessiond daemon will replicate the content of the metadata
3425 * cache in a metadata file.
3427 * On clean-up, it is expected that the consumer daemon will
3428 * unlink the shared memory files and that the session daemon
3429 * will unlink the metadata file. Then, the session's directory
3430 * in the shm path can be removed.
3432 * Unfortunately, a flaw in the design of the sessiond's and
3433 * consumerd's tear down of channels makes it impossible to
3434 * determine when the sessiond _and_ the consumerd have both
3435 * destroyed their representation of a channel. For one, the
3436 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3437 * callbacks in both daemons.
3439 * However, it is also impossible for the sessiond to know when
3440 * the consumer daemon is done destroying its channel(s) since
3441 * it occurs as a reaction to the closing of the channel's file
3442 * descriptor. There is no resulting communication initiated
3443 * from the consumerd to the sessiond to confirm that the
3444 * operation is completed (and was successful).
3446 * Until this is all fixed, the session daemon checks for the
3447 * removal of the session's shm path which makes it possible
3448 * to safely advertise a session as having been destroyed.
3450 * Prior to this fix, it was not possible to reliably save
3451 * a session making use of the --shm-path option, destroy it,
3452 * and load it again. This is because the creation of the
3453 * session would fail upon seeing the session's shm path
3454 * already in existence.
3456 * Note that none of the error paths in the check for the
3457 * directory's existence return an error. This is normal
3458 * as there isn't much that can be done. The session will
3459 * be destroyed properly, except that we can't offer the
3460 * guarantee that the same session can be re-created.
3462 current_completion_handler
= &destroy_completion_handler
.handler
;
3463 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3465 sizeof(destroy_completion_handler
.shm_path
));
3470 * The session is destroyed. However, note that the command context
3471 * still holds a reference to the session, thus delaying its destruction
3472 * _at least_ up to the point when that reference is released.
3474 session_destroy(session
);
3475 if (reply_context
) {
3476 reply_context
->destruction_status
= destruction_last_error
;
3477 ret
= session_add_destroy_notifier(session
,
3478 cmd_destroy_session_reply
,
3479 (void *) reply_context
);
3481 ret
= LTTNG_ERR_FATAL
;
3493 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3495 int cmd_register_consumer(struct ltt_session
*session
,
3496 enum lttng_domain_type domain
, const char *sock_path
,
3497 struct consumer_data
*cdata
)
3500 struct consumer_socket
*socket
= NULL
;
3502 LTTNG_ASSERT(session
);
3503 LTTNG_ASSERT(cdata
);
3504 LTTNG_ASSERT(sock_path
);
3507 case LTTNG_DOMAIN_KERNEL
:
3509 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3511 LTTNG_ASSERT(ksess
);
3513 /* Can't register a consumer if there is already one */
3514 if (ksess
->consumer_fds_sent
!= 0) {
3515 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3519 sock
= lttcomm_connect_unix_sock(sock_path
);
3521 ret
= LTTNG_ERR_CONNECT_FAIL
;
3524 cdata
->cmd_sock
= sock
;
3526 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3527 if (socket
== NULL
) {
3530 PERROR("close register consumer");
3532 cdata
->cmd_sock
= -1;
3533 ret
= LTTNG_ERR_FATAL
;
3537 socket
->lock
= (pthread_mutex_t
*) zmalloc(sizeof(pthread_mutex_t
));
3538 if (socket
->lock
== NULL
) {
3539 PERROR("zmalloc pthread mutex");
3540 ret
= LTTNG_ERR_FATAL
;
3543 pthread_mutex_init(socket
->lock
, NULL
);
3544 socket
->registered
= 1;
3547 consumer_add_socket(socket
, ksess
->consumer
);
3550 pthread_mutex_lock(&cdata
->pid_mutex
);
3552 pthread_mutex_unlock(&cdata
->pid_mutex
);
3557 /* TODO: Userspace tracing */
3558 ret
= LTTNG_ERR_UND
;
3566 consumer_destroy_socket(socket
);
3572 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3574 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3575 struct lttng_domain
**domains
)
3580 struct lttng_ht_iter iter
;
3582 if (session
->kernel_session
!= NULL
) {
3583 DBG3("Listing domains found kernel domain");
3587 if (session
->ust_session
!= NULL
) {
3588 DBG3("Listing domains found UST global domain");
3592 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3594 if (agt
->being_used
) {
3605 *domains
= (lttng_domain
*) zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3606 if (*domains
== NULL
) {
3607 ret
= LTTNG_ERR_FATAL
;
3611 if (session
->kernel_session
!= NULL
) {
3612 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3614 /* Kernel session buffer type is always GLOBAL */
3615 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3620 if (session
->ust_session
!= NULL
) {
3621 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3622 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3626 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3628 if (agt
->being_used
) {
3629 (*domains
)[index
].type
= agt
->domain
;
3630 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3640 /* Return negative value to differentiate return code */
3646 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3648 enum lttng_error_code
cmd_list_channels(enum lttng_domain_type domain
,
3649 struct ltt_session
*session
,
3650 struct lttng_payload
*payload
)
3654 struct lttcomm_list_command_header cmd_header
= {};
3655 size_t cmd_header_offset
;
3656 enum lttng_error_code ret_code
;
3661 DBG("Listing channels for session %s", session
->name
);
3663 cmd_header_offset
= payload
->buffer
.size
;
3665 /* Reserve space for command reply header. */
3666 ret
= lttng_dynamic_buffer_set_size(&payload
->buffer
,
3667 cmd_header_offset
+ sizeof(cmd_header
));
3669 ret_code
= LTTNG_ERR_NOMEM
;
3674 case LTTNG_DOMAIN_KERNEL
:
3676 /* Kernel channels */
3677 struct ltt_kernel_channel
*kchan
;
3678 if (session
->kernel_session
!= NULL
) {
3679 cds_list_for_each_entry(kchan
,
3680 &session
->kernel_session
->channel_list
.head
, list
) {
3681 uint64_t discarded_events
, lost_packets
;
3682 struct lttng_channel_extended
*extended
;
3684 extended
= (struct lttng_channel_extended
*)
3685 kchan
->channel
->attr
.extended
.ptr
;
3687 ret
= get_kernel_runtime_stats(session
, kchan
,
3688 &discarded_events
, &lost_packets
);
3690 ret_code
= LTTNG_ERR_UNK
;
3695 * Update the discarded_events and lost_packets
3696 * count for the channel
3698 extended
->discarded_events
= discarded_events
;
3699 extended
->lost_packets
= lost_packets
;
3701 ret
= lttng_channel_serialize(
3702 kchan
->channel
, &payload
->buffer
);
3704 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3705 kchan
->channel
->name
);
3706 ret_code
= LTTNG_ERR_UNK
;
3715 case LTTNG_DOMAIN_UST
:
3717 struct lttng_ht_iter iter
;
3718 struct ltt_ust_channel
*uchan
;
3721 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
3722 &iter
.iter
, uchan
, node
.node
) {
3723 uint64_t discarded_events
= 0, lost_packets
= 0;
3724 struct lttng_channel
*channel
= NULL
;
3725 struct lttng_channel_extended
*extended
;
3727 channel
= trace_ust_channel_to_lttng_channel(uchan
);
3729 ret
= LTTNG_ERR_NOMEM
;
3733 extended
= (struct lttng_channel_extended
*)
3734 channel
->attr
.extended
.ptr
;
3736 ret
= get_ust_runtime_stats(session
, uchan
,
3737 &discarded_events
, &lost_packets
);
3739 lttng_channel_destroy(channel
);
3740 ret_code
= LTTNG_ERR_UNK
;
3744 extended
->discarded_events
= discarded_events
;
3745 extended
->lost_packets
= lost_packets
;
3747 ret
= lttng_channel_serialize(
3748 channel
, &payload
->buffer
);
3750 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3752 ret_code
= LTTNG_ERR_UNK
;
3766 if (i
> UINT32_MAX
) {
3767 ERR("Channel count would overflow the channel listing command's reply");
3768 ret_code
= LTTNG_ERR_OVERFLOW
;
3772 /* Update command reply header. */
3773 cmd_header
.count
= (uint32_t) i
;
3774 memcpy(payload
->buffer
.data
+ cmd_header_offset
, &cmd_header
,
3775 sizeof(cmd_header
));
3776 ret_code
= LTTNG_OK
;
3783 * Command LTTNG_LIST_EVENTS processed by the client thread.
3785 enum lttng_error_code
cmd_list_events(enum lttng_domain_type domain
,
3786 struct ltt_session
*session
,
3788 struct lttng_payload
*reply_payload
)
3790 int buffer_resize_ret
;
3791 enum lttng_error_code ret_code
= LTTNG_OK
;
3792 struct lttcomm_list_command_header reply_command_header
= {};
3793 size_t reply_command_header_offset
;
3794 unsigned int nb_events
;
3796 assert(reply_payload
);
3798 /* Reserve space for command reply header. */
3799 reply_command_header_offset
= reply_payload
->buffer
.size
;
3800 buffer_resize_ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
3801 reply_command_header_offset
+
3802 sizeof(struct lttcomm_list_command_header
));
3803 if (buffer_resize_ret
) {
3804 ret_code
= LTTNG_ERR_NOMEM
;
3809 case LTTNG_DOMAIN_KERNEL
:
3810 if (session
->kernel_session
!= NULL
) {
3811 ret_code
= list_lttng_kernel_events(channel_name
,
3812 session
->kernel_session
, reply_payload
, &nb_events
);
3816 case LTTNG_DOMAIN_UST
:
3818 if (session
->ust_session
!= NULL
) {
3819 ret_code
= list_lttng_ust_global_events(channel_name
,
3820 &session
->ust_session
->domain_global
,
3821 reply_payload
, &nb_events
);
3826 case LTTNG_DOMAIN_LOG4J
:
3827 case LTTNG_DOMAIN_JUL
:
3828 case LTTNG_DOMAIN_PYTHON
:
3829 if (session
->ust_session
) {
3830 struct lttng_ht_iter iter
;
3834 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3835 &iter
.iter
, agt
, node
.node
) {
3836 if (agt
->domain
== domain
) {
3837 ret_code
= list_lttng_agent_events(
3838 agt
, reply_payload
, &nb_events
);
3847 ret_code
= LTTNG_ERR_UND
;
3851 if (nb_events
> UINT32_MAX
) {
3852 ret_code
= LTTNG_ERR_OVERFLOW
;
3856 /* Update command reply header. */
3857 reply_command_header
.count
= (uint32_t) nb_events
;
3858 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
3859 sizeof(reply_command_header
));
3866 * Using the session list, filled a lttng_session array to send back to the
3867 * client for session listing.
3869 * The session list lock MUST be acquired before calling this function. Use
3870 * session_lock_list() and session_unlock_list().
3872 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3873 size_t session_count
, uid_t uid
, gid_t gid
)
3877 struct ltt_session
*session
;
3878 struct ltt_session_list
*list
= session_get_list();
3879 struct lttng_session_extended
*extended
=
3880 (typeof(extended
)) (&sessions
[session_count
]);
3882 DBG("Getting all available session for UID %d GID %d",
3885 * Iterate over session list and append data after the control struct in
3888 cds_list_for_each_entry(session
, &list
->head
, list
) {
3889 if (!session_get(session
)) {
3893 * Only list the sessions the user can control.
3895 if (!session_access_ok(session
, uid
) ||
3896 session
->destroyed
) {
3897 session_put(session
);
3901 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3902 struct ltt_ust_session
*usess
= session
->ust_session
;
3904 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3905 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3906 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3907 ret
= build_network_session_path(sessions
[i
].path
,
3908 sizeof(sessions
[i
].path
), session
);
3910 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3911 session
->consumer
->dst
.session_root_path
);
3914 PERROR("snprintf session path");
3915 session_put(session
);
3919 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3920 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3921 sessions
[i
].enabled
= session
->active
;
3922 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3923 sessions
[i
].live_timer_interval
= session
->live_timer
;
3924 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3925 extended
[i
].creation_time
.is_set
= 1;
3927 session_put(session
);
3932 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3933 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3935 int cmd_data_pending(struct ltt_session
*session
)
3938 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3939 struct ltt_ust_session
*usess
= session
->ust_session
;
3941 LTTNG_ASSERT(session
);
3943 DBG("Data pending for session %s", session
->name
);
3945 /* Session MUST be stopped to ask for data availability. */
3946 if (session
->active
) {
3947 ret
= LTTNG_ERR_SESSION_STARTED
;
3951 * If stopped, just make sure we've started before else the above call
3952 * will always send that there is data pending.
3954 * The consumer assumes that when the data pending command is received,
3955 * the trace has been started before or else no output data is written
3956 * by the streams which is a condition for data pending. So, this is
3957 * *VERY* important that we don't ask the consumer before a start
3960 if (!session
->has_been_started
) {
3966 /* A rotation is still pending, we have to wait. */
3967 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3968 DBG("Rotate still pending for session %s", session
->name
);
3973 if (ksess
&& ksess
->consumer
) {
3974 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3976 /* Data is still being extracted for the kernel. */
3981 if (usess
&& usess
->consumer
) {
3982 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3984 /* Data is still being extracted for the kernel. */
3989 /* Data is ready to be read by a viewer */
3997 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3999 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4001 int cmd_snapshot_add_output(struct ltt_session
*session
,
4002 const struct lttng_snapshot_output
*output
, uint32_t *id
)
4005 struct snapshot_output
*new_output
;
4007 LTTNG_ASSERT(session
);
4008 LTTNG_ASSERT(output
);
4010 DBG("Cmd snapshot add output for session %s", session
->name
);
4013 * Can't create an output if the session is not set in no-output mode.
4015 if (session
->output_traces
) {
4016 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4020 if (session
->has_non_mmap_channel
) {
4021 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
4025 /* Only one output is allowed until we have the "tee" feature. */
4026 if (session
->snapshot
.nb_output
== 1) {
4027 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
4031 new_output
= snapshot_output_alloc();
4033 ret
= LTTNG_ERR_NOMEM
;
4037 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
4038 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
4039 &session
->snapshot
);
4041 if (ret
== -ENOMEM
) {
4042 ret
= LTTNG_ERR_NOMEM
;
4044 ret
= LTTNG_ERR_INVALID
;
4050 snapshot_add_output(&session
->snapshot
, new_output
);
4052 *id
= new_output
->id
;
4059 snapshot_output_destroy(new_output
);
4065 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
4067 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4069 int cmd_snapshot_del_output(struct ltt_session
*session
,
4070 const struct lttng_snapshot_output
*output
)
4073 struct snapshot_output
*sout
= NULL
;
4075 LTTNG_ASSERT(session
);
4076 LTTNG_ASSERT(output
);
4081 * Permission denied to create an output if the session is not
4082 * set in no output mode.
4084 if (session
->output_traces
) {
4085 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4090 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4092 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4093 } else if (*output
->name
!= '\0') {
4094 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4096 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4099 ret
= LTTNG_ERR_INVALID
;
4103 snapshot_delete_output(&session
->snapshot
, sout
);
4104 snapshot_output_destroy(sout
);
4113 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4115 * If no output is available, outputs is untouched and 0 is returned.
4117 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4119 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4120 struct lttng_snapshot_output
**outputs
)
4123 struct lttng_snapshot_output
*list
= NULL
;
4124 struct lttng_ht_iter iter
;
4125 struct snapshot_output
*output
;
4127 LTTNG_ASSERT(session
);
4128 LTTNG_ASSERT(outputs
);
4130 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4133 * Permission denied to create an output if the session is not
4134 * set in no output mode.
4136 if (session
->output_traces
) {
4137 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4141 if (session
->snapshot
.nb_output
== 0) {
4146 list
= (lttng_snapshot_output
*) zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4148 ret
= -LTTNG_ERR_NOMEM
;
4152 /* Copy list from session to the new list object. */
4154 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4155 output
, node
.node
) {
4156 LTTNG_ASSERT(output
->consumer
);
4157 list
[idx
].id
= output
->id
;
4158 list
[idx
].max_size
= output
->max_size
;
4159 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4160 sizeof(list
[idx
].name
))) {
4161 ret
= -LTTNG_ERR_INVALID
;
4164 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4165 if (lttng_strncpy(list
[idx
].ctrl_url
,
4166 output
->consumer
->dst
.session_root_path
,
4167 sizeof(list
[idx
].ctrl_url
))) {
4168 ret
= -LTTNG_ERR_INVALID
;
4173 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4174 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4176 ret
= -LTTNG_ERR_NOMEM
;
4181 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4182 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4184 ret
= -LTTNG_ERR_NOMEM
;
4193 ret
= session
->snapshot
.nb_output
;
4202 * Check if we can regenerate the metadata for this session.
4203 * Only kernel, UST per-uid and non-live sessions are supported.
4205 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4208 int check_regenerate_metadata_support(struct ltt_session
*session
)
4212 LTTNG_ASSERT(session
);
4214 if (session
->live_timer
!= 0) {
4215 ret
= LTTNG_ERR_LIVE_SESSION
;
4218 if (!session
->active
) {
4219 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4222 if (session
->ust_session
) {
4223 switch (session
->ust_session
->buffer_type
) {
4224 case LTTNG_BUFFER_PER_UID
:
4226 case LTTNG_BUFFER_PER_PID
:
4227 ret
= LTTNG_ERR_PER_PID_SESSION
;
4231 ret
= LTTNG_ERR_UNK
;
4235 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4236 session
->consumer
->relay_minor_version
< 8) {
4237 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4247 int clear_metadata_file(int fd
)
4252 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4253 if (lseek_ret
< 0) {
4259 ret
= ftruncate(fd
, 0);
4261 PERROR("ftruncate");
4270 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4273 struct buffer_reg_uid
*uid_reg
= NULL
;
4274 struct buffer_reg_session
*session_reg
= NULL
;
4277 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4278 struct ust_registry_session
*registry
;
4279 struct ust_registry_channel
*chan
;
4280 struct lttng_ht_iter iter_chan
;
4282 session_reg
= uid_reg
->registry
;
4283 registry
= session_reg
->reg
.ust
;
4285 pthread_mutex_lock(®istry
->lock
);
4286 registry
->metadata_len_sent
= 0;
4287 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4288 registry
->metadata_len
= 0;
4289 registry
->metadata_version
++;
4290 if (registry
->metadata_fd
> 0) {
4291 /* Clear the metadata file's content. */
4292 ret
= clear_metadata_file(registry
->metadata_fd
);
4294 pthread_mutex_unlock(®istry
->lock
);
4299 ret
= ust_metadata_session_statedump(registry
, NULL
,
4300 registry
->major
, registry
->minor
);
4302 pthread_mutex_unlock(®istry
->lock
);
4303 ERR("Failed to generate session metadata (err = %d)",
4307 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4309 struct ust_registry_event
*event
;
4310 struct lttng_ht_iter iter_event
;
4312 ret
= ust_metadata_channel_statedump(registry
, chan
);
4314 pthread_mutex_unlock(®istry
->lock
);
4315 ERR("Failed to generate channel metadata "
4319 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4321 ret
= ust_metadata_event_statedump(registry
,
4324 pthread_mutex_unlock(®istry
->lock
);
4325 ERR("Failed to generate event metadata "
4331 pthread_mutex_unlock(®istry
->lock
);
4340 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4342 * Ask the consumer to truncate the existing metadata file(s) and
4343 * then regenerate the metadata. Live and per-pid sessions are not
4344 * supported and return an error.
4346 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4348 int cmd_regenerate_metadata(struct ltt_session
*session
)
4352 LTTNG_ASSERT(session
);
4354 ret
= check_regenerate_metadata_support(session
);
4359 if (session
->kernel_session
) {
4360 ret
= kernctl_session_regenerate_metadata(
4361 session
->kernel_session
->fd
);
4363 ERR("Failed to regenerate the kernel metadata");
4368 if (session
->ust_session
) {
4369 ret
= ust_regenerate_metadata(session
->ust_session
);
4371 ERR("Failed to regenerate the UST metadata");
4375 DBG("Cmd metadata regenerate for session %s", session
->name
);
4383 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4385 * Ask the tracer to regenerate a new statedump.
4387 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4389 int cmd_regenerate_statedump(struct ltt_session
*session
)
4393 LTTNG_ASSERT(session
);
4395 if (!session
->active
) {
4396 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4400 if (session
->kernel_session
) {
4401 ret
= kernctl_session_regenerate_statedump(
4402 session
->kernel_session
->fd
);
4404 * Currently, the statedump in kernel can only fail if out
4408 if (ret
== -ENOMEM
) {
4409 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4411 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4413 ERR("Failed to regenerate the kernel statedump");
4418 if (session
->ust_session
) {
4419 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4421 * Currently, the statedump in UST always returns 0.
4424 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4425 ERR("Failed to regenerate the UST statedump");
4429 DBG("Cmd regenerate statedump for session %s", session
->name
);
4437 enum lttng_error_code
synchronize_tracer_notifier_register(
4438 struct notification_thread_handle
*notification_thread
,
4439 struct lttng_trigger
*trigger
, const struct lttng_credentials
*cmd_creds
)
4441 enum lttng_error_code ret_code
;
4442 const struct lttng_condition
*condition
=
4443 lttng_trigger_get_const_condition(trigger
);
4444 const char *trigger_name
;
4445 uid_t trigger_owner
;
4446 enum lttng_trigger_status trigger_status
;
4447 const enum lttng_domain_type trigger_domain
=
4448 lttng_trigger_get_underlying_domain_type_restriction(
4451 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4452 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4454 LTTNG_ASSERT(condition
);
4455 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4456 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4458 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4459 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4460 trigger_name
: "(anonymous)";
4462 session_lock_list();
4463 switch (trigger_domain
) {
4464 case LTTNG_DOMAIN_KERNEL
:
4466 ret_code
= kernel_register_event_notifier(trigger
, cmd_creds
);
4467 if (ret_code
!= LTTNG_OK
) {
4468 enum lttng_error_code notif_thread_unregister_ret
;
4470 notif_thread_unregister_ret
=
4471 notification_thread_command_unregister_trigger(
4472 notification_thread
, trigger
);
4474 if (notif_thread_unregister_ret
!= LTTNG_OK
) {
4475 /* Return the original error code. */
4476 ERR("Failed to unregister trigger from notification thread during error recovery: trigger name = '%s', trigger owner uid = %d, error code = %d",
4478 (int) trigger_owner
,
4484 case LTTNG_DOMAIN_UST
:
4485 ust_app_global_update_all_event_notifier_rules();
4487 case LTTNG_DOMAIN_JUL
:
4488 case LTTNG_DOMAIN_LOG4J
:
4489 case LTTNG_DOMAIN_PYTHON
:
4491 /* Agent domains. */
4492 struct agent
*agt
= agent_find_by_event_notifier_domain(
4496 agt
= agent_create(trigger_domain
);
4498 ret_code
= LTTNG_ERR_NOMEM
;
4499 goto end_unlock_session_list
;
4502 agent_add(agt
, the_trigger_agents_ht_by_domain
);
4505 ret_code
= (lttng_error_code
) trigger_agent_enable(trigger
, agt
);
4506 if (ret_code
!= LTTNG_OK
) {
4507 goto end_unlock_session_list
;
4512 case LTTNG_DOMAIN_NONE
:
4517 ret_code
= LTTNG_OK
;
4518 end_unlock_session_list
:
4519 session_unlock_list();
4523 enum lttng_error_code
cmd_register_trigger(const struct lttng_credentials
*cmd_creds
,
4524 struct lttng_trigger
*trigger
,
4525 bool is_trigger_anonymous
,
4526 struct notification_thread_handle
*notification_thread
,
4527 struct lttng_trigger
**return_trigger
)
4529 enum lttng_error_code ret_code
;
4530 const char *trigger_name
;
4531 uid_t trigger_owner
;
4532 enum lttng_trigger_status trigger_status
;
4534 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4535 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4536 trigger_name
: "(anonymous)";
4538 trigger_status
= lttng_trigger_get_owner_uid(
4539 trigger
, &trigger_owner
);
4540 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4542 DBG("Running register trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4543 trigger_name
, (int) trigger_owner
,
4544 (int) lttng_credentials_get_uid(cmd_creds
));
4547 * Validate the trigger credentials against the command credentials.
4548 * Only the root user can register a trigger with non-matching
4551 if (!lttng_credentials_is_equal_uid(
4552 lttng_trigger_get_credentials(trigger
),
4554 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4555 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4556 trigger_name
, (int) trigger_owner
,
4557 (int) lttng_credentials_get_uid(cmd_creds
));
4558 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4564 * The bytecode generation also serves as a validation step for the
4565 * bytecode expressions.
4567 ret_code
= lttng_trigger_generate_bytecode(trigger
, cmd_creds
);
4568 if (ret_code
!= LTTNG_OK
) {
4569 ERR("Failed to generate bytecode of trigger: trigger name = '%s', trigger owner uid = %d, error code = %d",
4570 trigger_name
, (int) trigger_owner
, ret_code
);
4575 * A reference to the trigger is acquired by the notification thread.
4576 * It is safe to return the same trigger to the caller since it the
4577 * other user holds a reference.
4579 * The trigger is modified during the execution of the
4580 * "register trigger" command. However, by the time the command returns,
4581 * it is safe to use without any locking as its properties are
4584 ret_code
= notification_thread_command_register_trigger(
4585 notification_thread
, trigger
, is_trigger_anonymous
);
4586 if (ret_code
!= LTTNG_OK
) {
4587 DBG("Failed to register trigger to notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4588 trigger_name
, (int) trigger_owner
, ret_code
);
4592 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4593 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4594 trigger_name
: "(anonymous)";
4597 * Synchronize tracers if the trigger adds an event notifier.
4599 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4600 ret_code
= synchronize_tracer_notifier_register(notification_thread
,
4601 trigger
, cmd_creds
);
4602 if (ret_code
!= LTTNG_OK
) {
4603 ERR("Error registering tracer notifier: %s",
4604 lttng_strerror(-ret_code
));
4610 * Return an updated trigger to the client.
4612 * Since a modified version of the same trigger is returned, acquire a
4613 * reference to the trigger so the caller doesn't have to care if those
4614 * are distinct instances or not.
4616 if (ret_code
== LTTNG_OK
) {
4617 lttng_trigger_get(trigger
);
4618 *return_trigger
= trigger
;
4619 /* Ownership of trigger was transferred to caller. */
4627 enum lttng_error_code
synchronize_tracer_notifier_unregister(
4628 const struct lttng_trigger
*trigger
)
4630 enum lttng_error_code ret_code
;
4631 const struct lttng_condition
*condition
=
4632 lttng_trigger_get_const_condition(trigger
);
4633 const enum lttng_domain_type trigger_domain
=
4634 lttng_trigger_get_underlying_domain_type_restriction(
4637 LTTNG_ASSERT(condition
);
4638 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4639 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4641 session_lock_list();
4642 switch (trigger_domain
) {
4643 case LTTNG_DOMAIN_KERNEL
:
4644 ret_code
= kernel_unregister_event_notifier(trigger
);
4645 if (ret_code
!= LTTNG_OK
) {
4646 goto end_unlock_session_list
;
4650 case LTTNG_DOMAIN_UST
:
4651 ust_app_global_update_all_event_notifier_rules();
4653 case LTTNG_DOMAIN_JUL
:
4654 case LTTNG_DOMAIN_LOG4J
:
4655 case LTTNG_DOMAIN_PYTHON
:
4657 /* Agent domains. */
4658 struct agent
*agt
= agent_find_by_event_notifier_domain(
4662 * This trigger was never registered in the first place. Calling
4663 * this function under those circumstances is an internal error.
4666 ret_code
= (lttng_error_code
) trigger_agent_disable(trigger
, agt
);
4667 if (ret_code
!= LTTNG_OK
) {
4668 goto end_unlock_session_list
;
4673 case LTTNG_DOMAIN_NONE
:
4678 ret_code
= LTTNG_OK
;
4680 end_unlock_session_list
:
4681 session_unlock_list();
4685 enum lttng_error_code
cmd_unregister_trigger(const struct lttng_credentials
*cmd_creds
,
4686 const struct lttng_trigger
*trigger
,
4687 struct notification_thread_handle
*notification_thread
)
4689 enum lttng_error_code ret_code
;
4690 const char *trigger_name
;
4691 uid_t trigger_owner
;
4692 enum lttng_trigger_status trigger_status
;
4693 struct lttng_trigger
*sessiond_trigger
= NULL
;
4695 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4696 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4697 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4698 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4700 DBG("Running unregister trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4701 trigger_name
, (int) trigger_owner
,
4702 (int) lttng_credentials_get_uid(cmd_creds
));
4705 * Validate the trigger credentials against the command credentials.
4706 * Only the root user can unregister a trigger with non-matching
4709 if (!lttng_credentials_is_equal_uid(
4710 lttng_trigger_get_credentials(trigger
),
4712 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4713 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4714 trigger_name
, (int) trigger_owner
,
4715 (int) lttng_credentials_get_uid(cmd_creds
));
4716 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4721 /* Fetch the sessiond side trigger object. */
4722 ret_code
= notification_thread_command_get_trigger(
4723 notification_thread
, trigger
, &sessiond_trigger
);
4724 if (ret_code
!= LTTNG_OK
) {
4725 DBG("Failed to get trigger from notification thread during unregister: trigger name = '%s', trigger owner uid = %d, error code = %d",
4726 trigger_name
, (int) trigger_owner
, ret_code
);
4730 LTTNG_ASSERT(sessiond_trigger
);
4733 * From this point on, no matter what, consider the trigger
4736 * We set the unregistered state of the sessiond side trigger object in
4737 * the client thread since we want to minimize the possibility of the
4738 * notification thread being stalled due to a long execution of an
4739 * action that required the trigger lock.
4741 lttng_trigger_set_as_unregistered(sessiond_trigger
);
4743 ret_code
= notification_thread_command_unregister_trigger(notification_thread
,
4745 if (ret_code
!= LTTNG_OK
) {
4746 DBG("Failed to unregister trigger from notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4747 trigger_name
, (int) trigger_owner
, ret_code
);
4752 * Synchronize tracers if the trigger removes an event notifier.
4753 * Do this even if the trigger unregistration failed to at least stop
4754 * the tracers from producing notifications associated with this
4757 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4758 ret_code
= synchronize_tracer_notifier_unregister(trigger
);
4759 if (ret_code
!= LTTNG_OK
) {
4760 ERR("Error unregistering trigger to tracer.");
4767 lttng_trigger_put(sessiond_trigger
);
4771 enum lttng_error_code
cmd_list_triggers(struct command_ctx
*cmd_ctx
,
4772 struct notification_thread_handle
*notification_thread
,
4773 struct lttng_triggers
**return_triggers
)
4776 enum lttng_error_code ret_code
;
4777 struct lttng_triggers
*triggers
= NULL
;
4779 /* Get the set of triggers from the notification thread. */
4780 ret_code
= notification_thread_command_list_triggers(
4781 notification_thread
, cmd_ctx
->creds
.uid
, &triggers
);
4782 if (ret_code
!= LTTNG_OK
) {
4786 ret
= lttng_triggers_remove_hidden_triggers(triggers
);
4788 ret_code
= LTTNG_ERR_UNK
;
4792 *return_triggers
= triggers
;
4794 ret_code
= LTTNG_OK
;
4796 lttng_triggers_destroy(triggers
);
4800 enum lttng_error_code
cmd_execute_error_query(const struct lttng_credentials
*cmd_creds
,
4801 const struct lttng_error_query
*query
,
4802 struct lttng_error_query_results
**_results
,
4803 struct notification_thread_handle
*notification_thread
)
4805 enum lttng_error_code ret_code
;
4806 const struct lttng_trigger
*query_target_trigger
;
4807 const struct lttng_action
*query_target_action
= NULL
;
4808 struct lttng_trigger
*matching_trigger
= NULL
;
4809 const char *trigger_name
;
4810 uid_t trigger_owner
;
4811 enum lttng_trigger_status trigger_status
;
4812 struct lttng_error_query_results
*results
= NULL
;
4814 switch (lttng_error_query_get_target_type(query
)) {
4815 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4816 query_target_trigger
= lttng_error_query_trigger_borrow_target(query
);
4818 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4819 query_target_trigger
=
4820 lttng_error_query_condition_borrow_target(query
);
4822 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4823 query_target_trigger
= lttng_error_query_action_borrow_trigger_target(
4830 LTTNG_ASSERT(query_target_trigger
);
4832 ret_code
= notification_thread_command_get_trigger(notification_thread
,
4833 query_target_trigger
, &matching_trigger
);
4834 if (ret_code
!= LTTNG_OK
) {
4838 /* No longer needed. */
4839 query_target_trigger
= NULL
;
4841 if (lttng_error_query_get_target_type(query
) ==
4842 LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
) {
4843 /* Get the sessiond-side version of the target action. */
4844 query_target_action
=
4845 lttng_error_query_action_borrow_action_target(
4846 query
, matching_trigger
);
4849 trigger_status
= lttng_trigger_get_name(matching_trigger
, &trigger_name
);
4850 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4851 trigger_name
: "(anonymous)";
4852 trigger_status
= lttng_trigger_get_owner_uid(matching_trigger
,
4854 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4856 results
= lttng_error_query_results_create();
4858 ret_code
= LTTNG_ERR_NOMEM
;
4862 DBG("Running \"execute error query\" command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4863 trigger_name
, (int) trigger_owner
,
4864 (int) lttng_credentials_get_uid(cmd_creds
));
4867 * Validate the trigger credentials against the command credentials.
4868 * Only the root user can target a trigger with non-matching
4871 if (!lttng_credentials_is_equal_uid(
4872 lttng_trigger_get_credentials(matching_trigger
),
4874 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4875 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4876 trigger_name
, (int) trigger_owner
,
4877 (int) lttng_credentials_get_uid(cmd_creds
));
4878 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4883 switch (lttng_error_query_get_target_type(query
)) {
4884 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4885 trigger_status
= lttng_trigger_add_error_results(
4886 matching_trigger
, results
);
4888 switch (trigger_status
) {
4889 case LTTNG_TRIGGER_STATUS_OK
:
4892 ret_code
= LTTNG_ERR_UNK
;
4897 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4899 trigger_status
= lttng_trigger_condition_add_error_results(
4900 matching_trigger
, results
);
4902 switch (trigger_status
) {
4903 case LTTNG_TRIGGER_STATUS_OK
:
4906 ret_code
= LTTNG_ERR_UNK
;
4912 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4914 const enum lttng_action_status action_status
=
4915 lttng_action_add_error_query_results(
4916 query_target_action
, results
);
4918 switch (action_status
) {
4919 case LTTNG_ACTION_STATUS_OK
:
4922 ret_code
= LTTNG_ERR_UNK
;
4933 *_results
= results
;
4935 ret_code
= LTTNG_OK
;
4937 lttng_trigger_put(matching_trigger
);
4938 lttng_error_query_results_destroy(results
);
4943 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4944 * snapshot output is *not* set with a remote destination.
4946 * Return LTTNG_OK on success or a LTTNG_ERR code.
4948 static enum lttng_error_code
set_relayd_for_snapshot(
4949 struct consumer_output
*output
,
4950 const struct ltt_session
*session
)
4952 enum lttng_error_code status
= LTTNG_OK
;
4953 struct lttng_ht_iter iter
;
4954 struct consumer_socket
*socket
;
4955 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4956 const char *base_path
;
4958 LTTNG_ASSERT(output
);
4959 LTTNG_ASSERT(session
);
4961 DBG2("Set relayd object from snapshot output");
4963 if (session
->current_trace_chunk
) {
4964 enum lttng_trace_chunk_status chunk_status
=
4965 lttng_trace_chunk_get_id(
4966 session
->current_trace_chunk
,
4967 ¤t_chunk_id
.value
);
4969 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4970 current_chunk_id
.is_set
= true;
4972 ERR("Failed to get current trace chunk id");
4973 status
= LTTNG_ERR_UNK
;
4978 /* Ignore if snapshot consumer output is not network. */
4979 if (output
->type
!= CONSUMER_DST_NET
) {
4984 * The snapshot record URI base path overrides the session
4987 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4988 base_path
= output
->dst
.net
.control
.subdir
;
4990 base_path
= session
->base_path
;
4994 * For each consumer socket, create and send the relayd object of the
4998 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4999 socket
, node
.node
) {
5000 pthread_mutex_lock(socket
->lock
);
5001 status
= send_consumer_relayd_sockets(LTTNG_DOMAIN_NONE
, session
->id
,
5003 session
->name
, session
->hostname
,
5005 session
->live_timer
,
5006 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
5007 session
->creation_time
,
5008 session
->name_contains_creation_time
);
5009 pthread_mutex_unlock(socket
->lock
);
5010 if (status
!= LTTNG_OK
) {
5022 * Record a kernel snapshot.
5024 * Return LTTNG_OK on success or a LTTNG_ERR code.
5026 static enum lttng_error_code
record_kernel_snapshot(
5027 struct ltt_kernel_session
*ksess
,
5028 const struct consumer_output
*output
,
5029 const struct ltt_session
*session
,
5030 int wait
, uint64_t nb_packets_per_stream
)
5032 enum lttng_error_code status
;
5034 LTTNG_ASSERT(ksess
);
5035 LTTNG_ASSERT(output
);
5036 LTTNG_ASSERT(session
);
5038 status
= kernel_snapshot_record(
5039 ksess
, output
, wait
, nb_packets_per_stream
);
5044 * Record a UST snapshot.
5046 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5048 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
5049 const struct consumer_output
*output
,
5050 const struct ltt_session
*session
,
5051 int wait
, uint64_t nb_packets_per_stream
)
5053 enum lttng_error_code status
;
5055 LTTNG_ASSERT(usess
);
5056 LTTNG_ASSERT(output
);
5057 LTTNG_ASSERT(session
);
5059 status
= ust_app_snapshot_record(
5060 usess
, output
, wait
, nb_packets_per_stream
);
5065 uint64_t get_session_size_one_more_packet_per_stream(
5066 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
5068 uint64_t tot_size
= 0;
5070 if (session
->kernel_session
) {
5071 struct ltt_kernel_channel
*chan
;
5072 const struct ltt_kernel_session
*ksess
=
5073 session
->kernel_session
;
5075 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
5076 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
5078 * Don't take channel into account if we
5079 * already grab all its packets.
5083 tot_size
+= chan
->channel
->attr
.subbuf_size
5084 * chan
->stream_count
;
5088 if (session
->ust_session
) {
5089 const struct ltt_ust_session
*usess
= session
->ust_session
;
5091 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
5099 * Calculate the number of packets we can grab from each stream that
5100 * fits within the overall snapshot max size.
5102 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
5103 * the number of packets per stream.
5105 * TODO: this approach is not perfect: we consider the worse case
5106 * (packet filling the sub-buffers) as an upper bound, but we could do
5107 * better if we do this calculation while we actually grab the packet
5108 * content: we would know how much padding we don't actually store into
5111 * This algorithm is currently bounded by the number of packets per
5114 * Since we call this algorithm before actually grabbing the data, it's
5115 * an approximation: for instance, applications could appear/disappear
5116 * in between this call and actually grabbing data.
5119 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
5123 uint64_t cur_nb_packets
= 0;
5126 return 0; /* Infinite */
5129 size_left
= max_size
;
5131 uint64_t one_more_packet_tot_size
;
5133 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
5134 session
, cur_nb_packets
);
5135 if (!one_more_packet_tot_size
) {
5136 /* We are already grabbing all packets. */
5139 size_left
-= one_more_packet_tot_size
;
5140 if (size_left
< 0) {
5145 if (!cur_nb_packets
&& size_left
!= max_size
) {
5146 /* Not enough room to grab one packet of each stream, error. */
5149 return cur_nb_packets
;
5153 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
5154 const struct snapshot_output
*snapshot_output
, int wait
)
5156 int64_t nb_packets_per_stream
;
5157 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
5159 enum lttng_error_code ret_code
= LTTNG_OK
;
5160 struct lttng_trace_chunk
*snapshot_trace_chunk
;
5161 struct consumer_output
*original_ust_consumer_output
= NULL
;
5162 struct consumer_output
*original_kernel_consumer_output
= NULL
;
5163 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
5164 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
5166 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
5168 snapshot_output
->name
,
5169 snapshot_output
->datetime
,
5170 snapshot_output
->nb_snapshot
);
5171 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
5172 ERR("Failed to format snapshot name");
5173 ret_code
= LTTNG_ERR_INVALID
;
5176 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
5177 snapshot_output
->name
, session
->name
,
5178 snapshot_chunk_name
);
5179 if (!session
->kernel_session
&& !session
->ust_session
) {
5180 ERR("Failed to record snapshot as no channels exist");
5181 ret_code
= LTTNG_ERR_NO_CHANNEL
;
5185 if (session
->kernel_session
) {
5186 original_kernel_consumer_output
=
5187 session
->kernel_session
->consumer
;
5188 snapshot_kernel_consumer_output
=
5189 consumer_copy_output(snapshot_output
->consumer
);
5190 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
5191 snapshot_chunk_name
);
5193 /* Copy the original domain subdir. */
5194 strcpy(snapshot_kernel_consumer_output
->domain_subdir
,
5195 original_kernel_consumer_output
->domain_subdir
);
5197 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
5198 original_kernel_consumer_output
);
5200 ERR("Failed to copy consumer sockets from snapshot output configuration");
5201 ret_code
= LTTNG_ERR_NOMEM
;
5204 ret_code
= set_relayd_for_snapshot(
5205 snapshot_kernel_consumer_output
, session
);
5206 if (ret_code
!= LTTNG_OK
) {
5207 ERR("Failed to setup relay daemon for kernel tracer snapshot");
5210 session
->kernel_session
->consumer
=
5211 snapshot_kernel_consumer_output
;
5213 if (session
->ust_session
) {
5214 original_ust_consumer_output
= session
->ust_session
->consumer
;
5215 snapshot_ust_consumer_output
=
5216 consumer_copy_output(snapshot_output
->consumer
);
5217 strcpy(snapshot_ust_consumer_output
->chunk_path
,
5218 snapshot_chunk_name
);
5220 /* Copy the original domain subdir. */
5221 strcpy(snapshot_ust_consumer_output
->domain_subdir
,
5222 original_ust_consumer_output
->domain_subdir
);
5224 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
5225 original_ust_consumer_output
);
5227 ERR("Failed to copy consumer sockets from snapshot output configuration");
5228 ret_code
= LTTNG_ERR_NOMEM
;
5231 ret_code
= set_relayd_for_snapshot(
5232 snapshot_ust_consumer_output
, session
);
5233 if (ret_code
!= LTTNG_OK
) {
5234 ERR("Failed to setup relay daemon for userspace tracer snapshot");
5237 session
->ust_session
->consumer
=
5238 snapshot_ust_consumer_output
;
5241 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
5242 snapshot_kernel_consumer_output
?:
5243 snapshot_ust_consumer_output
,
5244 consumer_output_get_base_path(
5245 snapshot_output
->consumer
),
5246 snapshot_chunk_name
);
5247 if (!snapshot_trace_chunk
) {
5248 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
5250 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
5253 LTTNG_ASSERT(!session
->current_trace_chunk
);
5254 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
5255 lttng_trace_chunk_put(snapshot_trace_chunk
);
5256 snapshot_trace_chunk
= NULL
;
5258 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
5260 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5264 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
5265 snapshot_output
->max_size
);
5266 if (nb_packets_per_stream
< 0) {
5267 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
5268 goto error_close_trace_chunk
;
5271 if (session
->kernel_session
) {
5272 ret_code
= record_kernel_snapshot(session
->kernel_session
,
5273 snapshot_kernel_consumer_output
, session
,
5274 wait
, nb_packets_per_stream
);
5275 if (ret_code
!= LTTNG_OK
) {
5276 goto error_close_trace_chunk
;
5280 if (session
->ust_session
) {
5281 ret_code
= record_ust_snapshot(session
->ust_session
,
5282 snapshot_ust_consumer_output
, session
,
5283 wait
, nb_packets_per_stream
);
5284 if (ret_code
!= LTTNG_OK
) {
5285 goto error_close_trace_chunk
;
5289 error_close_trace_chunk
:
5290 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
5291 ERR("Failed to release the current trace chunk of session \"%s\"",
5293 ret_code
= LTTNG_ERR_UNK
;
5296 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
5297 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
5299 * Don't goto end; make sure the chunk is closed for the session
5300 * to allow future snapshots.
5302 ERR("Failed to close snapshot trace chunk of session \"%s\"",
5304 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5307 lttng_trace_chunk_put(snapshot_trace_chunk
);
5308 snapshot_trace_chunk
= NULL
;
5310 if (original_ust_consumer_output
) {
5311 session
->ust_session
->consumer
= original_ust_consumer_output
;
5313 if (original_kernel_consumer_output
) {
5314 session
->kernel_session
->consumer
=
5315 original_kernel_consumer_output
;
5317 consumer_output_put(snapshot_ust_consumer_output
);
5318 consumer_output_put(snapshot_kernel_consumer_output
);
5323 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
5325 * The wait parameter is ignored so this call always wait for the snapshot to
5326 * complete before returning.
5328 * Return LTTNG_OK on success or else a LTTNG_ERR code.
5330 int cmd_snapshot_record(struct ltt_session
*session
,
5331 const struct lttng_snapshot_output
*output
, int wait
)
5333 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5335 unsigned int snapshot_success
= 0;
5337 struct snapshot_output
*tmp_output
= NULL
;
5339 LTTNG_ASSERT(session
);
5340 LTTNG_ASSERT(output
);
5342 DBG("Cmd snapshot record for session %s", session
->name
);
5344 /* Get the datetime for the snapshot output directory. */
5345 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
5348 cmd_ret
= LTTNG_ERR_INVALID
;
5353 * Permission denied to create an output if the session is not
5354 * set in no output mode.
5356 if (session
->output_traces
) {
5357 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
5361 /* The session needs to be started at least once. */
5362 if (!session
->has_been_started
) {
5363 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5367 /* Use temporary output for the session. */
5368 if (*output
->ctrl_url
!= '\0') {
5369 tmp_output
= snapshot_output_alloc();
5371 cmd_ret
= LTTNG_ERR_NOMEM
;
5375 ret
= snapshot_output_init(session
, output
->max_size
,
5377 output
->ctrl_url
, output
->data_url
,
5381 if (ret
== -ENOMEM
) {
5382 cmd_ret
= LTTNG_ERR_NOMEM
;
5384 cmd_ret
= LTTNG_ERR_INVALID
;
5388 /* Use the global session count for the temporary snapshot. */
5389 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
5391 /* Use the global datetime */
5392 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
5393 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
5394 if (cmd_ret
!= LTTNG_OK
) {
5397 snapshot_success
= 1;
5399 struct snapshot_output
*sout
;
5400 struct lttng_ht_iter iter
;
5403 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
5404 &iter
.iter
, sout
, node
.node
) {
5405 struct snapshot_output output_copy
;
5408 * Make a local copy of the output and override output
5409 * parameters with those provided as part of the
5412 memcpy(&output_copy
, sout
, sizeof(output_copy
));
5414 if (output
->max_size
!= (uint64_t) -1ULL) {
5415 output_copy
.max_size
= output
->max_size
;
5418 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
5419 memcpy(output_copy
.datetime
, datetime
,
5422 /* Use temporary name. */
5423 if (*output
->name
!= '\0') {
5424 if (lttng_strncpy(output_copy
.name
,
5426 sizeof(output_copy
.name
))) {
5427 cmd_ret
= LTTNG_ERR_INVALID
;
5433 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
5434 if (cmd_ret
!= LTTNG_OK
) {
5438 snapshot_success
= 1;
5443 if (snapshot_success
) {
5444 session
->snapshot
.nb_snapshot
++;
5446 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
5451 snapshot_output_destroy(tmp_output
);
5457 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
5459 int cmd_set_session_shm_path(struct ltt_session
*session
,
5460 const char *shm_path
)
5463 LTTNG_ASSERT(session
);
5466 * Can only set shm path before session is started.
5468 if (session
->has_been_started
) {
5469 return LTTNG_ERR_SESSION_STARTED
;
5472 strncpy(session
->shm_path
, shm_path
,
5473 sizeof(session
->shm_path
));
5474 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
5480 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
5482 * Ask the consumer to rotate the session output directory.
5483 * The session lock must be held.
5485 * Returns LTTNG_OK on success or else a negative LTTng error code.
5487 int cmd_rotate_session(struct ltt_session
*session
,
5488 struct lttng_rotate_session_return
*rotate_return
,
5489 bool quiet_rotation
,
5490 enum lttng_trace_chunk_command_type command
)
5493 uint64_t ongoing_rotation_chunk_id
;
5494 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5495 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
5496 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
5497 enum lttng_trace_chunk_status chunk_status
;
5498 bool failed_to_rotate
= false;
5499 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5501 LTTNG_ASSERT(session
);
5503 if (!session
->has_been_started
) {
5504 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5509 * Explicit rotation is not supported for live sessions.
5510 * However, live sessions can perform a quiet rotation on
5512 * Rotation is not supported for snapshot traces (no output).
5514 if ((!quiet_rotation
&& session
->live_timer
) ||
5515 !session
->output_traces
) {
5516 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5520 /* Unsupported feature in lttng-relayd before 2.11. */
5521 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5522 (session
->consumer
->relay_major_version
== 2 &&
5523 session
->consumer
->relay_minor_version
< 11)) {
5524 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5528 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5529 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5530 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5534 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5535 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5537 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5542 * After a stop, we only allow one rotation to occur, the other ones are
5543 * useless until a new start.
5545 if (session
->rotated_after_last_stop
) {
5546 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5548 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5553 * After a stop followed by a clear, disallow following rotations a they would
5554 * generate empty chunks.
5556 if (session
->cleared_after_last_stop
) {
5557 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5559 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5563 if (session
->active
) {
5564 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5566 if (!new_trace_chunk
) {
5567 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5573 * The current trace chunk becomes the chunk being archived.
5575 * After this point, "chunk_being_archived" must absolutely
5576 * be closed on the consumer(s), otherwise it will never be
5577 * cleaned-up, which will result in a leak.
5579 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5580 &chunk_being_archived
);
5582 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5586 if (session
->kernel_session
) {
5587 cmd_ret
= kernel_rotate_session(session
);
5588 if (cmd_ret
!= LTTNG_OK
) {
5589 failed_to_rotate
= true;
5590 rotation_fail_code
= cmd_ret
;
5593 if (session
->ust_session
) {
5594 cmd_ret
= ust_app_rotate_session(session
);
5595 if (cmd_ret
!= LTTNG_OK
) {
5596 failed_to_rotate
= true;
5597 rotation_fail_code
= cmd_ret
;
5601 if (!session
->active
) {
5602 session
->rotated_after_last_stop
= true;
5605 if (!chunk_being_archived
) {
5606 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5608 if (failed_to_rotate
) {
5609 cmd_ret
= rotation_fail_code
;
5616 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5617 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5618 &ongoing_rotation_chunk_id
);
5619 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5621 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5622 command
, session
->last_chunk_path
);
5624 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5628 if (failed_to_rotate
) {
5629 cmd_ret
= rotation_fail_code
;
5633 session
->quiet_rotation
= quiet_rotation
;
5634 ret
= timer_session_rotation_pending_check_start(session
,
5635 DEFAULT_ROTATE_PENDING_TIMER
);
5637 cmd_ret
= LTTNG_ERR_UNK
;
5641 if (rotate_return
) {
5642 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5645 session
->chunk_being_archived
= chunk_being_archived
;
5646 chunk_being_archived
= NULL
;
5647 if (!quiet_rotation
) {
5648 ret
= notification_thread_command_session_rotation_ongoing(
5649 the_notification_thread_handle
, session
->name
,
5650 session
->uid
, session
->gid
,
5651 ongoing_rotation_chunk_id
);
5652 if (ret
!= LTTNG_OK
) {
5653 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5655 cmd_ret
= (lttng_error_code
) ret
;
5659 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5660 session
->name
, ongoing_rotation_chunk_id
);
5662 lttng_trace_chunk_put(new_trace_chunk
);
5663 lttng_trace_chunk_put(chunk_being_archived
);
5664 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5667 if (session_reset_rotation_state(session
,
5668 LTTNG_ROTATION_STATE_ERROR
)) {
5669 ERR("Failed to reset rotation state of session \"%s\"",
5676 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5678 * Check if the session has finished its rotation.
5680 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5682 int cmd_rotate_get_info(struct ltt_session
*session
,
5683 struct lttng_rotation_get_info_return
*info_return
,
5684 uint64_t rotation_id
)
5686 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5687 enum lttng_rotation_state rotation_state
;
5689 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5690 session
->most_recent_chunk_id
.value
);
5692 if (session
->chunk_being_archived
) {
5693 enum lttng_trace_chunk_status chunk_status
;
5696 chunk_status
= lttng_trace_chunk_get_id(
5697 session
->chunk_being_archived
,
5699 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5701 rotation_state
= rotation_id
== chunk_id
?
5702 LTTNG_ROTATION_STATE_ONGOING
:
5703 LTTNG_ROTATION_STATE_EXPIRED
;
5705 if (session
->last_archived_chunk_id
.is_set
&&
5706 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5707 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5709 rotation_state
= session
->rotation_state
;
5713 switch (rotation_state
) {
5714 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5715 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5718 case LTTNG_ROTATION_STATE_EXPIRED
:
5719 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5720 rotation_id
, session
->name
);
5722 case LTTNG_ROTATION_STATE_ONGOING
:
5723 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5724 rotation_id
, session
->name
);
5726 case LTTNG_ROTATION_STATE_COMPLETED
:
5730 char *current_tracing_path_reply
;
5731 size_t current_tracing_path_reply_len
;
5733 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5734 rotation_id
, session
->name
);
5736 switch (session_get_consumer_destination_type(session
)) {
5737 case CONSUMER_DST_LOCAL
:
5738 current_tracing_path_reply
=
5739 info_return
->location
.local
.absolute_path
;
5740 current_tracing_path_reply_len
=
5741 sizeof(info_return
->location
.local
.absolute_path
);
5742 info_return
->location_type
=
5743 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5744 fmt_ret
= asprintf(&chunk_path
,
5745 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5746 session_get_base_path(session
),
5747 session
->last_archived_chunk_name
);
5748 if (fmt_ret
== -1) {
5749 PERROR("Failed to format the path of the last archived trace chunk");
5750 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5751 cmd_ret
= LTTNG_ERR_UNK
;
5755 case CONSUMER_DST_NET
:
5757 uint16_t ctrl_port
, data_port
;
5759 current_tracing_path_reply
=
5760 info_return
->location
.relay
.relative_path
;
5761 current_tracing_path_reply_len
=
5762 sizeof(info_return
->location
.relay
.relative_path
);
5763 /* Currently the only supported relay protocol. */
5764 info_return
->location
.relay
.protocol
=
5765 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5767 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5768 session_get_net_consumer_hostname(session
),
5769 sizeof(info_return
->location
.relay
.host
));
5771 ERR("Failed to copy host name to rotate_get_info reply");
5772 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5773 cmd_ret
= LTTNG_ERR_SET_URL
;
5777 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5778 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5779 info_return
->location
.relay
.ports
.data
= data_port
;
5780 info_return
->location_type
=
5781 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5782 chunk_path
= strdup(session
->last_chunk_path
);
5784 ERR("Failed to allocate the path of the last archived trace chunk");
5785 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5786 cmd_ret
= LTTNG_ERR_UNK
;
5795 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5796 chunk_path
, current_tracing_path_reply_len
);
5799 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5800 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5801 cmd_ret
= LTTNG_ERR_UNK
;
5807 case LTTNG_ROTATION_STATE_ERROR
:
5808 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5809 rotation_id
, session
->name
);
5817 info_return
->status
= (int32_t) rotation_state
;
5822 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5824 * Configure the automatic rotation parameters.
5825 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5826 * 'activate' to false means deactivate the rotation schedule and validate that
5827 * 'new_value' has the same value as the currently active value.
5829 * Return LTTNG_OK on success or else a positive LTTNG_ERR code.
5831 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5832 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5834 struct notification_thread_handle
*notification_thread_handle
)
5837 uint64_t *parameter_value
;
5839 LTTNG_ASSERT(session
);
5841 DBG("Cmd rotate set schedule session %s", session
->name
);
5843 if (session
->live_timer
|| !session
->output_traces
) {
5844 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5845 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5849 switch (schedule_type
) {
5850 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5851 parameter_value
= &session
->rotate_size
;
5853 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5854 parameter_value
= &session
->rotate_timer_period
;
5855 if (new_value
>= UINT_MAX
) {
5856 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5857 new_value
, UINT_MAX
);
5858 ret
= LTTNG_ERR_INVALID
;
5863 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5864 ret
= LTTNG_ERR_INVALID
;
5868 /* Improper use of the API. */
5869 if (new_value
== -1ULL) {
5870 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5871 ret
= LTTNG_ERR_INVALID
;
5876 * As indicated in struct ltt_session's comments, a value of == 0 means
5877 * this schedule rotation type is not in use.
5879 * Reject the command if we were asked to activate a schedule that was
5882 if (activate
&& *parameter_value
!= 0) {
5883 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5884 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5889 * Reject the command if we were asked to deactivate a schedule that was
5892 if (!activate
&& *parameter_value
== 0) {
5893 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5894 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5899 * Reject the command if we were asked to deactivate a schedule that
5902 if (!activate
&& *parameter_value
!= new_value
) {
5903 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5904 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5908 *parameter_value
= activate
? new_value
: 0;
5910 switch (schedule_type
) {
5911 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5912 if (activate
&& session
->active
) {
5914 * Only start the timer if the session is active,
5915 * otherwise it will be started when the session starts.
5917 ret
= timer_session_rotation_schedule_timer_start(
5918 session
, new_value
);
5920 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5921 ret
= LTTNG_ERR_UNK
;
5925 ret
= timer_session_rotation_schedule_timer_stop(
5928 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5929 ret
= LTTNG_ERR_UNK
;
5934 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5936 ret
= subscribe_session_consumed_size_rotation(session
,
5937 new_value
, notification_thread_handle
);
5939 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5940 ret
= LTTNG_ERR_UNK
;
5944 ret
= unsubscribe_session_consumed_size_rotation(session
,
5945 notification_thread_handle
);
5947 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5948 ret
= LTTNG_ERR_UNK
;
5955 /* Would have been caught before. */
5967 /* Wait for a given path to be removed before continuing. */
5968 static enum lttng_error_code
wait_on_path(void *path_data
)
5970 const char *shm_path
= (const char *) path_data
;
5972 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5978 ret
= stat(shm_path
, &st
);
5980 if (errno
!= ENOENT
) {
5981 PERROR("stat() returned an error while checking for the existence of the shm path");
5983 DBG("shm path no longer exists, completing the destruction of session");
5987 if (!S_ISDIR(st
.st_mode
)) {
5988 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5993 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5999 * Returns a pointer to a handler to run on completion of a command.
6000 * Returns NULL if no handler has to be run for the last command executed.
6002 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
6004 struct cmd_completion_handler
*handler
= current_completion_handler
;
6006 current_completion_handler
= NULL
;
6011 * Init command subsystem.
6016 * Set network sequence index to 1 for streams to match a relayd
6017 * socket on the consumer side.
6019 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
6020 relayd_net_seq_idx
= 1;
6021 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
6023 DBG("Command subsystem initialized");