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
12 #include <urcu/list.h>
13 #include <urcu/uatomic.h>
17 #include <common/defaults.h>
18 #include <common/common.h>
19 #include <common/sessiond-comm/sessiond-comm.h>
20 #include <common/relayd/relayd.h>
21 #include <common/utils.h>
22 #include <common/compat/string.h>
23 #include <common/kernel-ctl/kernel-ctl.h>
24 #include <common/dynamic-buffer.h>
25 #include <common/buffer-view.h>
26 #include <common/trace-chunk.h>
27 #include <lttng/location-internal.h>
28 #include <lttng/trigger/trigger-internal.h>
29 #include <lttng/condition/condition.h>
30 #include <lttng/action/action.h>
31 #include <lttng/channel.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/rotate-internal.h>
34 #include <lttng/location-internal.h>
35 #include <lttng/session-internal.h>
36 #include <lttng/userspace-probe-internal.h>
37 #include <lttng/session-descriptor-internal.h>
38 #include <common/string-utils/string-utils.h>
43 #include "health-sessiond.h"
45 #include "kernel-consumer.h"
46 #include "lttng-sessiond.h"
48 #include "lttng-syscall.h"
50 #include "buffer-registry.h"
51 #include "notification-thread.h"
52 #include "notification-thread-commands.h"
54 #include "rotation-thread.h"
56 #include "agent-thread.h"
60 /* Sleep for 100ms between each check for the shm path's deletion. */
61 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
63 struct cmd_destroy_session_reply_context
{
65 bool implicit_rotation_on_destroy
;
67 * Indicates whether or not an error occurred while launching the
68 * destruction of a session.
70 enum lttng_error_code destruction_status
;
73 static enum lttng_error_code
wait_on_path(void *path
);
76 * Command completion handler that is used by the destroy command
77 * when a session that has a non-default shm_path is being destroyed.
79 * See comment in cmd_destroy_session() for the rationale.
81 static struct destroy_completion_handler
{
82 struct cmd_completion_handler handler
;
83 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
84 } destroy_completion_handler
= {
87 .data
= destroy_completion_handler
.shm_path
92 static struct cmd_completion_handler
*current_completion_handler
;
95 * Used to keep a unique index for each relayd socket created where this value
96 * is associated with streams on the consumer so it can match the right relayd
97 * to send to. It must be accessed with the relayd_net_seq_idx_lock
100 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
101 static uint64_t relayd_net_seq_idx
;
103 static int validate_ust_event_name(const char *);
104 static int cmd_enable_event_internal(struct ltt_session
*session
,
105 const struct lttng_domain
*domain
,
106 char *channel_name
, struct lttng_event
*event
,
107 char *filter_expression
,
108 struct lttng_filter_bytecode
*filter
,
109 struct lttng_event_exclusion
*exclusion
,
113 * Create a session path used by list_lttng_sessions for the case that the
114 * session consumer is on the network.
116 static int build_network_session_path(char *dst
, size_t size
,
117 struct ltt_session
*session
)
119 int ret
, kdata_port
, udata_port
;
120 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
121 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
126 memset(tmp_urls
, 0, sizeof(tmp_urls
));
127 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
129 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
131 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
132 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
133 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
136 if (session
->ust_session
&& session
->ust_session
->consumer
) {
137 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
138 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
141 if (uuri
== NULL
&& kuri
== NULL
) {
142 uri
= &session
->consumer
->dst
.net
.control
;
143 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
144 } else if (kuri
&& uuri
) {
145 ret
= uri_compare(kuri
, uuri
);
149 /* Build uuri URL string */
150 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
157 } else if (kuri
&& uuri
== NULL
) {
159 } else if (uuri
&& kuri
== NULL
) {
163 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
169 * Do we have a UST url set. If yes, this means we have both kernel and UST
172 if (*tmp_uurl
!= '\0') {
173 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
174 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
177 if (kuri
|| (!kuri
&& !uuri
)) {
180 /* No kernel URI, use the UST port. */
183 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
191 * Get run-time attributes if the session has been started (discarded events,
194 static int get_kernel_runtime_stats(struct ltt_session
*session
,
195 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
196 uint64_t *lost_packets
)
200 if (!session
->has_been_started
) {
202 *discarded_events
= 0;
207 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
208 session
->kernel_session
->consumer
,
214 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
215 session
->kernel_session
->consumer
,
226 * Get run-time attributes if the session has been started (discarded events,
229 static int get_ust_runtime_stats(struct ltt_session
*session
,
230 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
231 uint64_t *lost_packets
)
234 struct ltt_ust_session
*usess
;
236 if (!discarded_events
|| !lost_packets
) {
241 usess
= session
->ust_session
;
242 assert(discarded_events
);
243 assert(lost_packets
);
245 if (!usess
|| !session
->has_been_started
) {
246 *discarded_events
= 0;
252 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
253 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
254 &usess
->buffer_reg_uid_list
,
255 usess
->consumer
, uchan
->id
,
256 uchan
->attr
.overwrite
,
259 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
260 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
261 uchan
, usess
->consumer
,
262 uchan
->attr
.overwrite
,
268 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
269 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
271 ERR("Unsupported buffer type");
282 * Fill lttng_channel array of all channels.
284 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
285 struct ltt_session
*session
, struct lttng_channel
*channels
,
286 struct lttng_channel_extended
*chan_exts
)
289 struct ltt_kernel_channel
*kchan
;
291 DBG("Listing channels for session %s", session
->name
);
294 case LTTNG_DOMAIN_KERNEL
:
295 /* Kernel channels */
296 if (session
->kernel_session
!= NULL
) {
297 cds_list_for_each_entry(kchan
,
298 &session
->kernel_session
->channel_list
.head
, list
) {
299 uint64_t discarded_events
, lost_packets
;
300 struct lttng_channel_extended
*extended
;
302 extended
= (struct lttng_channel_extended
*)
303 kchan
->channel
->attr
.extended
.ptr
;
305 ret
= get_kernel_runtime_stats(session
, kchan
,
306 &discarded_events
, &lost_packets
);
310 /* Copy lttng_channel struct to array */
311 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
312 channels
[i
].enabled
= kchan
->enabled
;
313 chan_exts
[i
].discarded_events
=
315 chan_exts
[i
].lost_packets
= lost_packets
;
316 chan_exts
[i
].monitor_timer_interval
=
317 extended
->monitor_timer_interval
;
318 chan_exts
[i
].blocking_timeout
= 0;
323 case LTTNG_DOMAIN_UST
:
325 struct lttng_ht_iter iter
;
326 struct ltt_ust_channel
*uchan
;
329 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
330 &iter
.iter
, uchan
, node
.node
) {
331 uint64_t discarded_events
= 0, lost_packets
= 0;
333 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
334 LTTNG_SYMBOL_NAME_LEN
)) {
337 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
338 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
339 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
340 channels
[i
].attr
.switch_timer_interval
=
341 uchan
->attr
.switch_timer_interval
;
342 channels
[i
].attr
.read_timer_interval
=
343 uchan
->attr
.read_timer_interval
;
344 channels
[i
].enabled
= uchan
->enabled
;
345 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
346 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
349 * Map enum lttng_ust_output to enum lttng_event_output.
351 switch (uchan
->attr
.output
) {
353 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
357 * LTTNG_UST_MMAP is the only supported UST
364 chan_exts
[i
].monitor_timer_interval
=
365 uchan
->monitor_timer_interval
;
366 chan_exts
[i
].blocking_timeout
=
367 uchan
->attr
.u
.s
.blocking_timeout
;
369 ret
= get_ust_runtime_stats(session
, uchan
,
370 &discarded_events
, &lost_packets
);
374 chan_exts
[i
].discarded_events
= discarded_events
;
375 chan_exts
[i
].lost_packets
= lost_packets
;
387 return -LTTNG_ERR_FATAL
;
393 static int increment_extended_len(const char *filter_expression
,
394 struct lttng_event_exclusion
*exclusion
,
395 const struct lttng_userspace_probe_location
*probe_location
,
396 size_t *extended_len
)
400 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
402 if (filter_expression
) {
403 *extended_len
+= strlen(filter_expression
) + 1;
407 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
410 if (probe_location
) {
411 ret
= lttng_userspace_probe_location_serialize(probe_location
,
416 *extended_len
+= ret
;
423 static int append_extended_info(const char *filter_expression
,
424 struct lttng_event_exclusion
*exclusion
,
425 struct lttng_userspace_probe_location
*probe_location
,
429 size_t filter_len
= 0;
430 size_t nb_exclusions
= 0;
431 size_t userspace_probe_location_len
= 0;
432 struct lttng_dynamic_buffer location_buffer
;
433 struct lttcomm_event_extended_header extended_header
;
435 if (filter_expression
) {
436 filter_len
= strlen(filter_expression
) + 1;
440 nb_exclusions
= exclusion
->count
;
443 if (probe_location
) {
444 lttng_dynamic_buffer_init(&location_buffer
);
445 ret
= lttng_userspace_probe_location_serialize(probe_location
,
446 &location_buffer
, NULL
);
451 userspace_probe_location_len
= location_buffer
.size
;
454 /* Set header fields */
455 extended_header
.filter_len
= filter_len
;
456 extended_header
.nb_exclusions
= nb_exclusions
;
457 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
460 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
461 *extended_at
+= sizeof(extended_header
);
463 /* Copy filter string */
464 if (filter_expression
) {
465 memcpy(*extended_at
, filter_expression
, filter_len
);
466 *extended_at
+= filter_len
;
469 /* Copy exclusion names */
471 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
473 memcpy(*extended_at
, &exclusion
->names
, len
);
477 if (probe_location
) {
478 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
479 *extended_at
+= location_buffer
.size
;
480 lttng_dynamic_buffer_reset(&location_buffer
);
488 * Create a list of agent domain events.
490 * Return number of events in list on success or else a negative value.
492 static int list_lttng_agent_events(struct agent
*agt
,
493 struct lttng_event
**events
, size_t *total_size
)
496 unsigned int nb_event
= 0;
497 struct agent_event
*event
;
498 struct lttng_event
*tmp_events
= NULL
;
499 struct lttng_ht_iter iter
;
500 size_t extended_len
= 0;
506 DBG3("Listing agent events");
509 nb_event
= lttng_ht_get_count(agt
->events
);
517 /* Compute required extended infos size */
518 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
521 * This is only valid because the commands which add events are
522 * processed in the same thread as the listing.
525 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
526 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
529 DBG("Error computing the length of extended info message");
530 ret
= -LTTNG_ERR_FATAL
;
536 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
537 tmp_events
= zmalloc(*total_size
);
539 PERROR("zmalloc agent events session");
540 ret
= -LTTNG_ERR_FATAL
;
544 extended_at
= ((uint8_t *) tmp_events
) +
545 nb_event
* sizeof(struct lttng_event
);
548 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
549 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
550 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
551 tmp_events
[i
].enabled
= event
->enabled
;
552 tmp_events
[i
].loglevel
= event
->loglevel_value
;
553 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
556 /* Append extended info */
557 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
560 DBG("Error appending extended info message");
561 ret
= -LTTNG_ERR_FATAL
;
566 *events
= tmp_events
;
568 assert(nb_event
== i
);
579 * Create a list of ust global domain events.
581 static int list_lttng_ust_global_events(char *channel_name
,
582 struct ltt_ust_domain_global
*ust_global
,
583 struct lttng_event
**events
, size_t *total_size
)
586 unsigned int nb_event
= 0;
587 struct lttng_ht_iter iter
;
588 struct lttng_ht_node_str
*node
;
589 struct ltt_ust_channel
*uchan
;
590 struct ltt_ust_event
*uevent
;
591 struct lttng_event
*tmp
;
592 size_t extended_len
= 0;
595 DBG("Listing UST global events for channel %s", channel_name
);
599 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
600 node
= lttng_ht_iter_get_node_str(&iter
);
602 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
606 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
608 nb_event
= lttng_ht_get_count(uchan
->events
);
615 DBG3("Listing UST global %d events", nb_event
);
617 /* Compute required extended infos size */
618 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
619 if (uevent
->internal
) {
624 ret
= increment_extended_len(uevent
->filter_expression
,
625 uevent
->exclusion
, NULL
, &extended_len
);
627 DBG("Error computing the length of extended info message");
628 ret
= -LTTNG_ERR_FATAL
;
633 /* All events are internal, skip. */
639 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
640 tmp
= zmalloc(*total_size
);
642 ret
= -LTTNG_ERR_FATAL
;
646 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
648 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
649 if (uevent
->internal
) {
650 /* This event should remain hidden from clients */
653 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
654 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
655 tmp
[i
].enabled
= uevent
->enabled
;
657 switch (uevent
->attr
.instrumentation
) {
658 case LTTNG_UST_TRACEPOINT
:
659 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
661 case LTTNG_UST_PROBE
:
662 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
664 case LTTNG_UST_FUNCTION
:
665 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
669 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
670 switch (uevent
->attr
.loglevel_type
) {
671 case LTTNG_UST_LOGLEVEL_ALL
:
672 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
674 case LTTNG_UST_LOGLEVEL_RANGE
:
675 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
677 case LTTNG_UST_LOGLEVEL_SINGLE
:
678 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
681 if (uevent
->filter
) {
684 if (uevent
->exclusion
) {
685 tmp
[i
].exclusion
= 1;
689 /* Append extended info */
690 ret
= append_extended_info(uevent
->filter_expression
,
691 uevent
->exclusion
, NULL
, &extended_at
);
693 DBG("Error appending extended info message");
694 ret
= -LTTNG_ERR_FATAL
;
707 * Fill lttng_event array of all kernel events in the channel.
709 static int list_lttng_kernel_events(char *channel_name
,
710 struct ltt_kernel_session
*kernel_session
,
711 struct lttng_event
**events
, size_t *total_size
)
714 unsigned int nb_event
;
715 struct ltt_kernel_event
*event
;
716 struct ltt_kernel_channel
*kchan
;
717 size_t extended_len
= 0;
720 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
722 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
726 nb_event
= kchan
->event_count
;
728 DBG("Listing events for channel %s", kchan
->channel
->name
);
736 /* Compute required extended infos size */
737 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
738 ret
= increment_extended_len(event
->filter_expression
, NULL
,
739 event
->userspace_probe_location
,
742 DBG("Error computing the length of extended info message");
743 ret
= -LTTNG_ERR_FATAL
;
748 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
749 *events
= zmalloc(*total_size
);
750 if (*events
== NULL
) {
751 ret
= -LTTNG_ERR_FATAL
;
755 extended_at
= ((void *) *events
) +
756 nb_event
* sizeof(struct lttng_event
);
758 /* Kernel channels */
759 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
760 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
761 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
762 (*events
)[i
].enabled
= event
->enabled
;
763 (*events
)[i
].filter
=
764 (unsigned char) !!event
->filter_expression
;
766 switch (event
->event
->instrumentation
) {
767 case LTTNG_KERNEL_TRACEPOINT
:
768 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
770 case LTTNG_KERNEL_KRETPROBE
:
771 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
772 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
773 sizeof(struct lttng_kernel_kprobe
));
775 case LTTNG_KERNEL_KPROBE
:
776 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
777 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
778 sizeof(struct lttng_kernel_kprobe
));
780 case LTTNG_KERNEL_UPROBE
:
781 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
783 case LTTNG_KERNEL_FUNCTION
:
784 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
785 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
786 sizeof(struct lttng_kernel_function
));
788 case LTTNG_KERNEL_NOOP
:
789 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
791 case LTTNG_KERNEL_SYSCALL
:
792 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
794 case LTTNG_KERNEL_ALL
:
802 /* Append extended info */
803 ret
= append_extended_info(event
->filter_expression
, NULL
,
804 event
->userspace_probe_location
, &extended_at
);
806 DBG("Error appending extended info message");
807 ret
= -LTTNG_ERR_FATAL
;
816 /* Negate the error code to differentiate the size from an error */
821 * Add URI so the consumer output object. Set the correct path depending on the
822 * domain adding the default trace directory.
824 static enum lttng_error_code
add_uri_to_consumer(
825 const struct ltt_session
*session
,
826 struct consumer_output
*consumer
,
827 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
830 enum lttng_error_code ret_code
= LTTNG_OK
;
834 if (consumer
== NULL
) {
835 DBG("No consumer detected. Don't add URI. Stopping.");
836 ret_code
= LTTNG_ERR_NO_CONSUMER
;
841 case LTTNG_DOMAIN_KERNEL
:
842 ret
= lttng_strncpy(consumer
->domain_subdir
,
843 DEFAULT_KERNEL_TRACE_DIR
,
844 sizeof(consumer
->domain_subdir
));
846 case LTTNG_DOMAIN_UST
:
847 ret
= lttng_strncpy(consumer
->domain_subdir
,
848 DEFAULT_UST_TRACE_DIR
,
849 sizeof(consumer
->domain_subdir
));
853 * This case is possible is we try to add the URI to the global
854 * tracing session consumer object which in this case there is
857 memset(consumer
->domain_subdir
, 0,
858 sizeof(consumer
->domain_subdir
));
862 ERR("Failed to initialize consumer output domain subdirectory");
863 ret_code
= LTTNG_ERR_FATAL
;
867 switch (uri
->dtype
) {
870 DBG2("Setting network URI to consumer");
872 if (consumer
->type
== CONSUMER_DST_NET
) {
873 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
874 consumer
->dst
.net
.control_isset
) ||
875 (uri
->stype
== LTTNG_STREAM_DATA
&&
876 consumer
->dst
.net
.data_isset
)) {
877 ret_code
= LTTNG_ERR_URL_EXIST
;
881 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
884 /* Set URI into consumer output object */
885 ret
= consumer_set_network_uri(session
, consumer
, uri
);
889 } else if (ret
== 1) {
891 * URI was the same in the consumer so we do not append the subdir
892 * again so to not duplicate output dir.
899 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
900 ret_code
= LTTNG_ERR_INVALID
;
903 DBG2("Setting trace directory path from URI to %s",
905 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
907 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
909 sizeof(consumer
->dst
.session_root_path
));
911 ret_code
= LTTNG_ERR_FATAL
;
914 consumer
->type
= CONSUMER_DST_LOCAL
;
924 * Init tracing by creating trace directory and sending fds kernel consumer.
926 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
929 struct lttng_ht_iter iter
;
930 struct consumer_socket
*socket
;
936 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
937 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
939 pthread_mutex_lock(socket
->lock
);
940 ret
= kernel_consumer_send_session(socket
, session
);
941 pthread_mutex_unlock(socket
->lock
);
943 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
955 * Create a socket to the relayd using the URI.
957 * On success, the relayd_sock pointer is set to the created socket.
958 * Else, it remains untouched and an LTTng error code is returned.
960 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
961 struct lttcomm_relayd_sock
**relayd_sock
,
962 struct consumer_output
*consumer
)
965 enum lttng_error_code status
= LTTNG_OK
;
966 struct lttcomm_relayd_sock
*rsock
;
968 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
969 RELAYD_VERSION_COMM_MINOR
);
971 status
= LTTNG_ERR_FATAL
;
976 * Connect to relayd so we can proceed with a session creation. This call
977 * can possibly block for an arbitrary amount of time to set the health
978 * state to be in poll execution.
981 ret
= relayd_connect(rsock
);
984 ERR("Unable to reach lttng-relayd");
985 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
989 /* Create socket for control stream. */
990 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
991 uint64_t result_flags
;
993 DBG3("Creating relayd stream socket from URI");
995 /* Check relayd version */
996 ret
= relayd_version_check(rsock
);
997 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
998 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1000 } else if (ret
< 0) {
1001 ERR("Unable to reach lttng-relayd");
1002 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1005 consumer
->relay_major_version
= rsock
->major
;
1006 consumer
->relay_minor_version
= rsock
->minor
;
1007 ret
= relayd_get_configuration(rsock
, 0,
1010 ERR("Unable to get relayd configuration");
1011 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1014 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1015 consumer
->relay_allows_clear
= true;
1017 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1018 DBG3("Creating relayd data socket from URI");
1020 /* Command is not valid */
1021 ERR("Relayd invalid stream type: %d", uri
->stype
);
1022 status
= LTTNG_ERR_INVALID
;
1026 *relayd_sock
= rsock
;
1031 /* The returned value is not useful since we are on an error path. */
1032 (void) relayd_close(rsock
);
1040 * Connect to the relayd using URI and send the socket to the right consumer.
1042 * The consumer socket lock must be held by the caller.
1044 * Returns LTTNG_OK on success or an LTTng error code on failure.
1046 static enum lttng_error_code
send_consumer_relayd_socket(
1047 unsigned int session_id
,
1048 struct lttng_uri
*relayd_uri
,
1049 struct consumer_output
*consumer
,
1050 struct consumer_socket
*consumer_sock
,
1051 const char *session_name
, const char *hostname
,
1052 const char *base_path
, int session_live_timer
,
1053 const uint64_t *current_chunk_id
,
1054 time_t session_creation_time
,
1055 bool session_name_contains_creation_time
)
1058 struct lttcomm_relayd_sock
*rsock
= NULL
;
1059 enum lttng_error_code status
;
1061 /* Connect to relayd and make version check if uri is the control. */
1062 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1063 if (status
!= LTTNG_OK
) {
1064 goto relayd_comm_error
;
1068 /* Set the network sequence index if not set. */
1069 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1070 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1072 * Increment net_seq_idx because we are about to transfer the
1073 * new relayd socket to the consumer.
1074 * Assign unique key so the consumer can match streams.
1076 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1077 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1080 /* Send relayd socket to consumer. */
1081 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1082 relayd_uri
->stype
, session_id
,
1083 session_name
, hostname
, base_path
,
1084 session_live_timer
, current_chunk_id
,
1085 session_creation_time
, session_name_contains_creation_time
);
1087 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1091 /* Flag that the corresponding socket was sent. */
1092 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1093 consumer_sock
->control_sock_sent
= 1;
1094 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1095 consumer_sock
->data_sock_sent
= 1;
1099 * Close socket which was dup on the consumer side. The session daemon does
1100 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1104 if (status
!= LTTNG_OK
) {
1106 * The consumer output for this session should not be used anymore
1107 * since the relayd connection failed thus making any tracing or/and
1108 * streaming not usable.
1110 consumer
->enabled
= 0;
1112 (void) relayd_close(rsock
);
1120 * Send both relayd sockets to a specific consumer and domain. This is a
1121 * helper function to facilitate sending the information to the consumer for a
1124 * The consumer socket lock must be held by the caller.
1126 * Returns LTTNG_OK, or an LTTng error code on failure.
1128 static enum lttng_error_code
send_consumer_relayd_sockets(
1129 enum lttng_domain_type domain
,
1130 unsigned int session_id
, struct consumer_output
*consumer
,
1131 struct consumer_socket
*sock
, const char *session_name
,
1132 const char *hostname
, const char *base_path
, int session_live_timer
,
1133 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1134 bool session_name_contains_creation_time
)
1136 enum lttng_error_code status
= LTTNG_OK
;
1141 /* Sending control relayd socket. */
1142 if (!sock
->control_sock_sent
) {
1143 status
= send_consumer_relayd_socket(session_id
,
1144 &consumer
->dst
.net
.control
, consumer
, sock
,
1145 session_name
, hostname
, base_path
, session_live_timer
,
1146 current_chunk_id
, session_creation_time
,
1147 session_name_contains_creation_time
);
1148 if (status
!= LTTNG_OK
) {
1153 /* Sending data relayd socket. */
1154 if (!sock
->data_sock_sent
) {
1155 status
= send_consumer_relayd_socket(session_id
,
1156 &consumer
->dst
.net
.data
, consumer
, sock
,
1157 session_name
, hostname
, base_path
, session_live_timer
,
1158 current_chunk_id
, session_creation_time
,
1159 session_name_contains_creation_time
);
1160 if (status
!= LTTNG_OK
) {
1170 * Setup relayd connections for a tracing session. First creates the socket to
1171 * the relayd and send them to the right domain consumer. Consumer type MUST be
1174 int cmd_setup_relayd(struct ltt_session
*session
)
1177 struct ltt_ust_session
*usess
;
1178 struct ltt_kernel_session
*ksess
;
1179 struct consumer_socket
*socket
;
1180 struct lttng_ht_iter iter
;
1181 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1185 usess
= session
->ust_session
;
1186 ksess
= session
->kernel_session
;
1188 DBG("Setting relayd for session %s", session
->name
);
1191 if (session
->current_trace_chunk
) {
1192 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1193 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1195 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1196 current_chunk_id
.is_set
= true;
1198 ERR("Failed to get current trace chunk id");
1199 ret
= LTTNG_ERR_UNK
;
1204 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1205 && usess
->consumer
->enabled
) {
1206 /* For each consumer socket, send relayd sockets */
1207 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1208 socket
, node
.node
) {
1209 pthread_mutex_lock(socket
->lock
);
1210 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1211 usess
->consumer
, socket
,
1212 session
->name
, session
->hostname
,
1214 session
->live_timer
,
1215 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1216 session
->creation_time
,
1217 session
->name_contains_creation_time
);
1218 pthread_mutex_unlock(socket
->lock
);
1219 if (ret
!= LTTNG_OK
) {
1222 /* Session is now ready for network streaming. */
1223 session
->net_handle
= 1;
1225 session
->consumer
->relay_major_version
=
1226 usess
->consumer
->relay_major_version
;
1227 session
->consumer
->relay_minor_version
=
1228 usess
->consumer
->relay_minor_version
;
1229 session
->consumer
->relay_allows_clear
=
1230 usess
->consumer
->relay_allows_clear
;
1233 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1234 && ksess
->consumer
->enabled
) {
1235 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1236 socket
, node
.node
) {
1237 pthread_mutex_lock(socket
->lock
);
1238 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1239 ksess
->consumer
, socket
,
1240 session
->name
, session
->hostname
,
1242 session
->live_timer
,
1243 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1244 session
->creation_time
,
1245 session
->name_contains_creation_time
);
1246 pthread_mutex_unlock(socket
->lock
);
1247 if (ret
!= LTTNG_OK
) {
1250 /* Session is now ready for network streaming. */
1251 session
->net_handle
= 1;
1253 session
->consumer
->relay_major_version
=
1254 ksess
->consumer
->relay_major_version
;
1255 session
->consumer
->relay_minor_version
=
1256 ksess
->consumer
->relay_minor_version
;
1257 session
->consumer
->relay_allows_clear
=
1258 ksess
->consumer
->relay_allows_clear
;
1267 * Start a kernel session by opening all necessary streams.
1269 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1272 struct ltt_kernel_channel
*kchan
;
1274 /* Open kernel metadata */
1275 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1276 ret
= kernel_open_metadata(ksess
);
1278 ret
= LTTNG_ERR_KERN_META_FAIL
;
1283 /* Open kernel metadata stream */
1284 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1285 ret
= kernel_open_metadata_stream(ksess
);
1287 ERR("Kernel create metadata stream failed");
1288 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1293 /* For each channel */
1294 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1295 if (kchan
->stream_count
== 0) {
1296 ret
= kernel_open_channel_stream(kchan
);
1298 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1301 /* Update the stream global counter */
1302 ksess
->stream_count_global
+= ret
;
1306 /* Setup kernel consumer socket and send fds to it */
1307 ret
= init_kernel_tracing(ksess
);
1309 ret
= LTTNG_ERR_KERN_START_FAIL
;
1313 /* This start the kernel tracing */
1314 ret
= kernel_start_session(ksess
);
1316 ret
= LTTNG_ERR_KERN_START_FAIL
;
1320 /* Quiescent wait after starting trace */
1321 kernel_wait_quiescent();
1331 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1333 struct ltt_kernel_channel
*kchan
;
1334 bool error_occurred
= false;
1337 if (!ksess
|| !ksess
->active
) {
1340 DBG("Stopping kernel tracing");
1342 ret
= kernel_stop_session(ksess
);
1344 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1348 kernel_wait_quiescent();
1350 /* Flush metadata after stopping (if exists) */
1351 if (ksess
->metadata_stream_fd
>= 0) {
1352 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1354 ERR("Kernel metadata flush failed");
1355 error_occurred
= true;
1359 /* Flush all buffers after stopping */
1360 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1361 ret
= kernel_flush_buffer(kchan
);
1363 ERR("Kernel flush buffer error");
1364 error_occurred
= true;
1369 if (error_occurred
) {
1370 ret
= LTTNG_ERR_UNK
;
1379 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1381 int cmd_disable_channel(struct ltt_session
*session
,
1382 enum lttng_domain_type domain
, char *channel_name
)
1385 struct ltt_ust_session
*usess
;
1387 usess
= session
->ust_session
;
1392 case LTTNG_DOMAIN_KERNEL
:
1394 ret
= channel_kernel_disable(session
->kernel_session
,
1396 if (ret
!= LTTNG_OK
) {
1400 kernel_wait_quiescent();
1403 case LTTNG_DOMAIN_UST
:
1405 struct ltt_ust_channel
*uchan
;
1406 struct lttng_ht
*chan_ht
;
1408 chan_ht
= usess
->domain_global
.channels
;
1410 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1411 if (uchan
== NULL
) {
1412 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1416 ret
= channel_ust_disable(usess
, uchan
);
1417 if (ret
!= LTTNG_OK
) {
1423 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1435 * Command LTTNG_TRACK_ID processed by the client thread.
1437 * Called with session lock held.
1439 int cmd_track_id(struct ltt_session
*session
,
1440 enum lttng_tracker_type tracker_type
,
1441 enum lttng_domain_type domain
,
1442 const struct lttng_tracker_id
*id
)
1449 case LTTNG_DOMAIN_KERNEL
:
1451 struct ltt_kernel_session
*ksess
;
1453 ksess
= session
->kernel_session
;
1455 ret
= kernel_track_id(tracker_type
, ksess
, id
);
1456 if (ret
!= LTTNG_OK
) {
1460 kernel_wait_quiescent();
1463 case LTTNG_DOMAIN_UST
:
1465 struct ltt_ust_session
*usess
;
1467 usess
= session
->ust_session
;
1469 ret
= trace_ust_track_id(tracker_type
, usess
, id
);
1470 if (ret
!= LTTNG_OK
) {
1476 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1488 * Command LTTNG_UNTRACK_ID processed by the client thread.
1490 * Called with session lock held.
1492 int cmd_untrack_id(struct ltt_session
*session
,
1493 enum lttng_tracker_type tracker_type
,
1494 enum lttng_domain_type domain
,
1495 const struct lttng_tracker_id
*id
)
1502 case LTTNG_DOMAIN_KERNEL
:
1504 struct ltt_kernel_session
*ksess
;
1506 ksess
= session
->kernel_session
;
1508 ret
= kernel_untrack_id(tracker_type
, ksess
, id
);
1509 if (ret
!= LTTNG_OK
) {
1513 kernel_wait_quiescent();
1516 case LTTNG_DOMAIN_UST
:
1518 struct ltt_ust_session
*usess
;
1520 usess
= session
->ust_session
;
1522 ret
= trace_ust_untrack_id(tracker_type
, usess
, id
);
1523 if (ret
!= LTTNG_OK
) {
1529 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1541 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1543 * The wpipe arguments is used as a notifier for the kernel thread.
1545 int cmd_enable_channel(struct ltt_session
*session
,
1546 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1549 struct ltt_ust_session
*usess
= session
->ust_session
;
1550 struct lttng_ht
*chan_ht
;
1552 struct lttng_channel attr
;
1559 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1561 /* Validate channel name */
1562 if (attr
.name
[0] == '.' ||
1563 memchr(attr
.name
, '/', len
) != NULL
) {
1564 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1568 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1573 * Don't try to enable a channel if the session has been started at
1574 * some point in time before. The tracer does not allow it.
1576 if (session
->has_been_started
) {
1577 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1582 * If the session is a live session, remove the switch timer, the
1583 * live timer does the same thing but sends also synchronisation
1584 * beacons for inactive streams.
1586 if (session
->live_timer
> 0) {
1587 attr
.attr
.live_timer_interval
= session
->live_timer
;
1588 attr
.attr
.switch_timer_interval
= 0;
1591 /* Check for feature support */
1592 switch (domain
->type
) {
1593 case LTTNG_DOMAIN_KERNEL
:
1595 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1596 /* Sampling position of buffer is not supported */
1597 WARN("Kernel tracer does not support buffer monitoring. "
1598 "Setting the monitor interval timer to 0 "
1599 "(disabled) for channel '%s' of session '%s'",
1600 attr
.name
, session
->name
);
1601 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1605 case LTTNG_DOMAIN_UST
:
1607 case LTTNG_DOMAIN_JUL
:
1608 case LTTNG_DOMAIN_LOG4J
:
1609 case LTTNG_DOMAIN_PYTHON
:
1610 if (!agent_tracing_is_enabled()) {
1611 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1612 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1617 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1621 switch (domain
->type
) {
1622 case LTTNG_DOMAIN_KERNEL
:
1624 struct ltt_kernel_channel
*kchan
;
1626 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1627 session
->kernel_session
);
1628 if (kchan
== NULL
) {
1629 if (session
->snapshot
.nb_output
> 0 ||
1630 session
->snapshot_mode
) {
1631 /* Enforce mmap output for snapshot sessions. */
1632 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1634 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1635 if (attr
.name
[0] != '\0') {
1636 session
->kernel_session
->has_non_default_channel
= 1;
1639 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1642 if (ret
!= LTTNG_OK
) {
1646 kernel_wait_quiescent();
1649 case LTTNG_DOMAIN_UST
:
1650 case LTTNG_DOMAIN_JUL
:
1651 case LTTNG_DOMAIN_LOG4J
:
1652 case LTTNG_DOMAIN_PYTHON
:
1654 struct ltt_ust_channel
*uchan
;
1659 * Current agent implementation limitations force us to allow
1660 * only one channel at once in "agent" subdomains. Each
1661 * subdomain has a default channel name which must be strictly
1664 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1665 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1666 LTTNG_SYMBOL_NAME_LEN
)) {
1667 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1670 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1671 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1672 LTTNG_SYMBOL_NAME_LEN
)) {
1673 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1676 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1677 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1678 LTTNG_SYMBOL_NAME_LEN
)) {
1679 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1684 chan_ht
= usess
->domain_global
.channels
;
1686 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1687 if (uchan
== NULL
) {
1688 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1689 if (attr
.name
[0] != '\0') {
1690 usess
->has_non_default_channel
= 1;
1693 ret
= channel_ust_enable(usess
, uchan
);
1698 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1702 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1703 session
->has_non_mmap_channel
= true;
1712 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1714 int cmd_disable_event(struct ltt_session
*session
,
1715 enum lttng_domain_type domain
, const char *channel_name
,
1716 const struct lttng_event
*event
)
1719 const char *event_name
;
1721 DBG("Disable event command for event \'%s\'", event
->name
);
1723 event_name
= event
->name
;
1725 /* Error out on unhandled search criteria */
1726 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1727 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1728 ret
= LTTNG_ERR_UNK
;
1735 case LTTNG_DOMAIN_KERNEL
:
1737 struct ltt_kernel_channel
*kchan
;
1738 struct ltt_kernel_session
*ksess
;
1740 ksess
= session
->kernel_session
;
1743 * If a non-default channel has been created in the
1744 * session, explicitely require that -c chan_name needs
1747 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1748 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1752 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1753 if (kchan
== NULL
) {
1754 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1758 switch (event
->type
) {
1759 case LTTNG_EVENT_ALL
:
1760 case LTTNG_EVENT_TRACEPOINT
:
1761 case LTTNG_EVENT_SYSCALL
:
1762 case LTTNG_EVENT_PROBE
:
1763 case LTTNG_EVENT_FUNCTION
:
1764 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1765 if (event_name
[0] == '\0') {
1766 ret
= event_kernel_disable_event(kchan
,
1769 ret
= event_kernel_disable_event(kchan
,
1770 event_name
, event
->type
);
1772 if (ret
!= LTTNG_OK
) {
1777 ret
= LTTNG_ERR_UNK
;
1781 kernel_wait_quiescent();
1784 case LTTNG_DOMAIN_UST
:
1786 struct ltt_ust_channel
*uchan
;
1787 struct ltt_ust_session
*usess
;
1789 usess
= session
->ust_session
;
1791 if (validate_ust_event_name(event_name
)) {
1792 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1797 * If a non-default channel has been created in the
1798 * session, explicitly require that -c chan_name needs
1801 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1802 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1806 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1808 if (uchan
== NULL
) {
1809 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1813 switch (event
->type
) {
1814 case LTTNG_EVENT_ALL
:
1816 * An empty event name means that everything
1817 * should be disabled.
1819 if (event
->name
[0] == '\0') {
1820 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1822 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1825 if (ret
!= LTTNG_OK
) {
1830 ret
= LTTNG_ERR_UNK
;
1834 DBG3("Disable UST event %s in channel %s completed", event_name
,
1838 case LTTNG_DOMAIN_LOG4J
:
1839 case LTTNG_DOMAIN_JUL
:
1840 case LTTNG_DOMAIN_PYTHON
:
1843 struct ltt_ust_session
*usess
= session
->ust_session
;
1847 switch (event
->type
) {
1848 case LTTNG_EVENT_ALL
:
1851 ret
= LTTNG_ERR_UNK
;
1855 agt
= trace_ust_find_agent(usess
, domain
);
1857 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1861 * An empty event name means that everything
1862 * should be disabled.
1864 if (event
->name
[0] == '\0') {
1865 ret
= event_agent_disable_all(usess
, agt
);
1867 ret
= event_agent_disable(usess
, agt
, event_name
);
1869 if (ret
!= LTTNG_OK
) {
1876 ret
= LTTNG_ERR_UND
;
1889 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1891 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1892 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1894 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1895 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1898 * Don't try to add a context if the session has been started at
1899 * some point in time before. The tracer does not allow it and would
1900 * result in a corrupted trace.
1902 if (session
->has_been_started
) {
1903 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1907 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1908 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1909 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1913 case LTTNG_DOMAIN_KERNEL
:
1914 assert(session
->kernel_session
);
1916 if (session
->kernel_session
->channel_count
== 0) {
1917 /* Create default channel */
1918 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1919 if (ret
!= LTTNG_OK
) {
1922 chan_kern_created
= 1;
1924 /* Add kernel context to kernel tracer */
1925 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1926 if (ret
!= LTTNG_OK
) {
1930 case LTTNG_DOMAIN_JUL
:
1931 case LTTNG_DOMAIN_LOG4J
:
1934 * Validate channel name.
1935 * If no channel name is given and the domain is JUL or LOG4J,
1936 * set it to the appropriate domain-specific channel name. If
1937 * a name is provided but does not match the expexted channel
1938 * name, return an error.
1940 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1941 strcmp(channel_name
,
1942 DEFAULT_JUL_CHANNEL_NAME
)) {
1943 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1945 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1946 strcmp(channel_name
,
1947 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1948 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1951 /* break is _not_ missing here. */
1953 case LTTNG_DOMAIN_UST
:
1955 struct ltt_ust_session
*usess
= session
->ust_session
;
1956 unsigned int chan_count
;
1960 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1961 if (chan_count
== 0) {
1962 struct lttng_channel
*attr
;
1963 /* Create default channel */
1964 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1966 ret
= LTTNG_ERR_FATAL
;
1970 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1971 if (ret
!= LTTNG_OK
) {
1975 channel_attr_destroy(attr
);
1976 chan_ust_created
= 1;
1979 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1980 free(app_ctx_provider_name
);
1982 app_ctx_name
= NULL
;
1983 app_ctx_provider_name
= NULL
;
1984 if (ret
!= LTTNG_OK
) {
1990 ret
= LTTNG_ERR_UND
;
1998 if (chan_kern_created
) {
1999 struct ltt_kernel_channel
*kchan
=
2000 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2001 session
->kernel_session
);
2002 /* Created previously, this should NOT fail. */
2004 kernel_destroy_channel(kchan
);
2007 if (chan_ust_created
) {
2008 struct ltt_ust_channel
*uchan
=
2009 trace_ust_find_channel_by_name(
2010 session
->ust_session
->domain_global
.channels
,
2011 DEFAULT_CHANNEL_NAME
);
2012 /* Created previously, this should NOT fail. */
2014 /* Remove from the channel list of the session. */
2015 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2017 trace_ust_destroy_channel(uchan
);
2020 free(app_ctx_provider_name
);
2025 static inline bool name_starts_with(const char *name
, const char *prefix
)
2027 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2029 return !strncmp(name
, prefix
, max_cmp_len
);
2032 /* Perform userspace-specific event name validation */
2033 static int validate_ust_event_name(const char *name
)
2043 * Check name against all internal UST event component namespaces used
2046 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2047 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2048 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2057 * Internal version of cmd_enable_event() with a supplemental
2058 * "internal_event" flag which is used to enable internal events which should
2059 * be hidden from clients. Such events are used in the agent implementation to
2060 * enable the events through which all "agent" events are funeled.
2062 static int _cmd_enable_event(struct ltt_session
*session
,
2063 const struct lttng_domain
*domain
,
2064 char *channel_name
, struct lttng_event
*event
,
2065 char *filter_expression
,
2066 struct lttng_filter_bytecode
*filter
,
2067 struct lttng_event_exclusion
*exclusion
,
2068 int wpipe
, bool internal_event
)
2070 int ret
= 0, channel_created
= 0;
2071 struct lttng_channel
*attr
= NULL
;
2075 assert(channel_name
);
2077 /* If we have a filter, we must have its filter expression */
2078 assert(!(!!filter_expression
^ !!filter
));
2080 /* Normalize event name as a globbing pattern */
2081 strutils_normalize_star_glob_pattern(event
->name
);
2083 /* Normalize exclusion names as globbing patterns */
2087 for (i
= 0; i
< exclusion
->count
; i
++) {
2088 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2090 strutils_normalize_star_glob_pattern(name
);
2094 DBG("Enable event command for event \'%s\'", event
->name
);
2098 switch (domain
->type
) {
2099 case LTTNG_DOMAIN_KERNEL
:
2101 struct ltt_kernel_channel
*kchan
;
2104 * If a non-default channel has been created in the
2105 * session, explicitely require that -c chan_name needs
2108 if (session
->kernel_session
->has_non_default_channel
2109 && channel_name
[0] == '\0') {
2110 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2114 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2115 session
->kernel_session
);
2116 if (kchan
== NULL
) {
2117 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2118 LTTNG_BUFFER_GLOBAL
);
2120 ret
= LTTNG_ERR_FATAL
;
2123 if (lttng_strncpy(attr
->name
, channel_name
,
2124 sizeof(attr
->name
))) {
2125 ret
= LTTNG_ERR_INVALID
;
2129 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2130 if (ret
!= LTTNG_OK
) {
2133 channel_created
= 1;
2136 /* Get the newly created kernel channel pointer */
2137 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2138 session
->kernel_session
);
2139 if (kchan
== NULL
) {
2140 /* This sould not happen... */
2141 ret
= LTTNG_ERR_FATAL
;
2145 switch (event
->type
) {
2146 case LTTNG_EVENT_ALL
:
2148 char *filter_expression_a
= NULL
;
2149 struct lttng_filter_bytecode
*filter_a
= NULL
;
2152 * We need to duplicate filter_expression and filter,
2153 * because ownership is passed to first enable
2156 if (filter_expression
) {
2157 filter_expression_a
= strdup(filter_expression
);
2158 if (!filter_expression_a
) {
2159 ret
= LTTNG_ERR_FATAL
;
2164 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2166 free(filter_expression_a
);
2167 ret
= LTTNG_ERR_FATAL
;
2170 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2172 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
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
);
2183 free(filter_expression_a
);
2187 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2188 ret
= event_kernel_enable_event(kchan
, event
,
2189 filter_expression_a
, filter_a
);
2190 /* We have passed ownership */
2191 filter_expression_a
= NULL
;
2193 if (ret
!= LTTNG_OK
) {
2198 case LTTNG_EVENT_PROBE
:
2199 case LTTNG_EVENT_USERSPACE_PROBE
:
2200 case LTTNG_EVENT_FUNCTION
:
2201 case LTTNG_EVENT_FUNCTION_ENTRY
:
2202 case LTTNG_EVENT_TRACEPOINT
:
2203 ret
= event_kernel_enable_event(kchan
, event
,
2204 filter_expression
, filter
);
2205 /* We have passed ownership */
2206 filter_expression
= NULL
;
2208 if (ret
!= LTTNG_OK
) {
2209 if (channel_created
) {
2210 /* Let's not leak a useless channel. */
2211 kernel_destroy_channel(kchan
);
2216 case LTTNG_EVENT_SYSCALL
:
2217 ret
= event_kernel_enable_event(kchan
, event
,
2218 filter_expression
, filter
);
2219 /* We have passed ownership */
2220 filter_expression
= NULL
;
2222 if (ret
!= LTTNG_OK
) {
2227 ret
= LTTNG_ERR_UNK
;
2231 kernel_wait_quiescent();
2234 case LTTNG_DOMAIN_UST
:
2236 struct ltt_ust_channel
*uchan
;
2237 struct ltt_ust_session
*usess
= session
->ust_session
;
2242 * If a non-default channel has been created in the
2243 * session, explicitely require that -c chan_name needs
2246 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2247 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2251 /* Get channel from global UST domain */
2252 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2254 if (uchan
== NULL
) {
2255 /* Create default channel */
2256 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2257 usess
->buffer_type
);
2259 ret
= LTTNG_ERR_FATAL
;
2262 if (lttng_strncpy(attr
->name
, channel_name
,
2263 sizeof(attr
->name
))) {
2264 ret
= LTTNG_ERR_INVALID
;
2268 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2269 if (ret
!= LTTNG_OK
) {
2273 /* Get the newly created channel reference back */
2274 uchan
= trace_ust_find_channel_by_name(
2275 usess
->domain_global
.channels
, channel_name
);
2279 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2281 * Don't allow users to add UST events to channels which
2282 * are assigned to a userspace subdomain (JUL, Log4J,
2285 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2289 if (!internal_event
) {
2291 * Ensure the event name is not reserved for internal
2294 ret
= validate_ust_event_name(event
->name
);
2296 WARN("Userspace event name %s failed validation.",
2298 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2303 /* At this point, the session and channel exist on the tracer */
2304 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2305 filter_expression
, filter
, exclusion
,
2307 /* We have passed ownership */
2308 filter_expression
= NULL
;
2311 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2312 goto already_enabled
;
2313 } else if (ret
!= LTTNG_OK
) {
2318 case LTTNG_DOMAIN_LOG4J
:
2319 case LTTNG_DOMAIN_JUL
:
2320 case LTTNG_DOMAIN_PYTHON
:
2322 const char *default_event_name
, *default_chan_name
;
2324 struct lttng_event uevent
;
2325 struct lttng_domain tmp_dom
;
2326 struct ltt_ust_session
*usess
= session
->ust_session
;
2330 if (!agent_tracing_is_enabled()) {
2331 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2332 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2336 agt
= trace_ust_find_agent(usess
, domain
->type
);
2338 agt
= agent_create(domain
->type
);
2340 ret
= LTTNG_ERR_NOMEM
;
2343 agent_add(agt
, usess
->agents
);
2346 /* Create the default tracepoint. */
2347 memset(&uevent
, 0, sizeof(uevent
));
2348 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2349 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2350 default_event_name
= event_get_default_agent_ust_name(
2352 if (!default_event_name
) {
2353 ret
= LTTNG_ERR_FATAL
;
2356 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2357 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2360 * The domain type is changed because we are about to enable the
2361 * default channel and event for the JUL domain that are hardcoded.
2362 * This happens in the UST domain.
2364 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2365 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2367 switch (domain
->type
) {
2368 case LTTNG_DOMAIN_LOG4J
:
2369 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2371 case LTTNG_DOMAIN_JUL
:
2372 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2374 case LTTNG_DOMAIN_PYTHON
:
2375 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2378 /* The switch/case we are in makes this impossible */
2383 char *filter_expression_copy
= NULL
;
2384 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2387 const size_t filter_size
= sizeof(
2388 struct lttng_filter_bytecode
)
2391 filter_copy
= zmalloc(filter_size
);
2393 ret
= LTTNG_ERR_NOMEM
;
2396 memcpy(filter_copy
, filter
, filter_size
);
2398 filter_expression_copy
=
2399 strdup(filter_expression
);
2400 if (!filter_expression
) {
2401 ret
= LTTNG_ERR_NOMEM
;
2404 if (!filter_expression_copy
|| !filter_copy
) {
2405 free(filter_expression_copy
);
2411 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2412 (char *) default_chan_name
,
2413 &uevent
, filter_expression_copy
,
2414 filter_copy
, NULL
, wpipe
);
2417 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2418 goto already_enabled
;
2419 } else if (ret
!= LTTNG_OK
) {
2423 /* The wild card * means that everything should be enabled. */
2424 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2425 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2428 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2432 filter_expression
= NULL
;
2433 if (ret
!= LTTNG_OK
) {
2440 ret
= LTTNG_ERR_UND
;
2448 free(filter_expression
);
2451 channel_attr_destroy(attr
);
2457 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2458 * We own filter, exclusion, and filter_expression.
2460 int cmd_enable_event(struct ltt_session
*session
,
2461 const struct lttng_domain
*domain
,
2462 char *channel_name
, struct lttng_event
*event
,
2463 char *filter_expression
,
2464 struct lttng_filter_bytecode
*filter
,
2465 struct lttng_event_exclusion
*exclusion
,
2468 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2469 filter_expression
, filter
, exclusion
, wpipe
, false);
2473 * Enable an event which is internal to LTTng. An internal should
2474 * never be made visible to clients and are immune to checks such as
2477 static int cmd_enable_event_internal(struct ltt_session
*session
,
2478 const struct lttng_domain
*domain
,
2479 char *channel_name
, struct lttng_event
*event
,
2480 char *filter_expression
,
2481 struct lttng_filter_bytecode
*filter
,
2482 struct lttng_event_exclusion
*exclusion
,
2485 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2486 filter_expression
, filter
, exclusion
, wpipe
, true);
2490 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2492 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2493 struct lttng_event
**events
)
2496 ssize_t nb_events
= 0;
2499 case LTTNG_DOMAIN_KERNEL
:
2500 nb_events
= kernel_list_events(events
);
2501 if (nb_events
< 0) {
2502 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2506 case LTTNG_DOMAIN_UST
:
2507 nb_events
= ust_app_list_events(events
);
2508 if (nb_events
< 0) {
2509 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2513 case LTTNG_DOMAIN_LOG4J
:
2514 case LTTNG_DOMAIN_JUL
:
2515 case LTTNG_DOMAIN_PYTHON
:
2516 nb_events
= agent_list_events(events
, domain
);
2517 if (nb_events
< 0) {
2518 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2523 ret
= LTTNG_ERR_UND
;
2530 /* Return negative value to differentiate return code */
2535 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2537 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2538 struct lttng_event_field
**fields
)
2541 ssize_t nb_fields
= 0;
2544 case LTTNG_DOMAIN_UST
:
2545 nb_fields
= ust_app_list_event_fields(fields
);
2546 if (nb_fields
< 0) {
2547 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2551 case LTTNG_DOMAIN_KERNEL
:
2552 default: /* fall-through */
2553 ret
= LTTNG_ERR_UND
;
2560 /* Return negative value to differentiate return code */
2564 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2566 return syscall_table_list(events
);
2570 * Command LTTNG_LIST_TRACKER_IDS processed by the client thread.
2572 * Called with session lock held.
2574 int cmd_list_tracker_ids(enum lttng_tracker_type tracker_type
,
2575 struct ltt_session
*session
,
2576 enum lttng_domain_type domain
,
2577 struct lttng_tracker_ids
**ids
)
2582 case LTTNG_DOMAIN_KERNEL
:
2584 struct ltt_kernel_session
*ksess
;
2586 ksess
= session
->kernel_session
;
2587 ret
= kernel_list_tracker_ids(tracker_type
, ksess
, ids
);
2588 if (ret
!= LTTNG_OK
) {
2589 ret
= -LTTNG_ERR_KERN_LIST_FAIL
;
2594 case LTTNG_DOMAIN_UST
:
2596 struct ltt_ust_session
*usess
;
2598 usess
= session
->ust_session
;
2599 ret
= trace_ust_list_tracker_ids(tracker_type
, usess
, ids
);
2600 if (ret
!= LTTNG_OK
) {
2601 ret
= -LTTNG_ERR_UST_LIST_FAIL
;
2606 case LTTNG_DOMAIN_LOG4J
:
2607 case LTTNG_DOMAIN_JUL
:
2608 case LTTNG_DOMAIN_PYTHON
:
2610 ret
= -LTTNG_ERR_UND
;
2615 /* Return negative value to differentiate return code */
2620 * Command LTTNG_START_TRACE processed by the client thread.
2622 * Called with session mutex held.
2624 int cmd_start_trace(struct ltt_session
*session
)
2626 enum lttng_error_code ret
;
2627 unsigned long nb_chan
= 0;
2628 struct ltt_kernel_session
*ksession
;
2629 struct ltt_ust_session
*usess
;
2630 const bool session_rotated_after_last_stop
=
2631 session
->rotated_after_last_stop
;
2632 const bool session_cleared_after_last_stop
=
2633 session
->cleared_after_last_stop
;
2637 /* Ease our life a bit ;) */
2638 ksession
= session
->kernel_session
;
2639 usess
= session
->ust_session
;
2641 /* Is the session already started? */
2642 if (session
->active
) {
2643 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2644 /* Perform nothing */
2648 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2649 !session
->current_trace_chunk
) {
2651 * A rotation was launched while the session was stopped and
2652 * it has not been completed yet. It is not possible to start
2653 * the session since starting the session here would require a
2654 * rotation from "NULL" to a new trace chunk. That rotation
2655 * would overlap with the ongoing rotation, which is not
2658 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2660 ret
= LTTNG_ERR_ROTATION_PENDING
;
2665 * Starting a session without channel is useless since after that it's not
2666 * possible to enable channel thus inform the client.
2668 if (usess
&& usess
->domain_global
.channels
) {
2669 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2672 nb_chan
+= ksession
->channel_count
;
2675 ret
= LTTNG_ERR_NO_CHANNEL
;
2679 session
->active
= 1;
2680 session
->rotated_after_last_stop
= false;
2681 session
->cleared_after_last_stop
= false;
2682 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2683 if (!session
->has_been_started
) {
2684 struct lttng_trace_chunk
*trace_chunk
;
2686 DBG("Creating initial trace chunk of session \"%s\"",
2688 trace_chunk
= session_create_new_trace_chunk(
2689 session
, NULL
, NULL
, NULL
);
2691 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2694 assert(!session
->current_trace_chunk
);
2695 ret
= session_set_trace_chunk(session
, trace_chunk
,
2697 lttng_trace_chunk_put(trace_chunk
);
2699 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2703 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2706 * Rotate existing streams into the new chunk.
2707 * This is a "quiet" rotation has no client has
2708 * explicitly requested this operation.
2710 * There is also no need to wait for the rotation
2711 * to complete as it will happen immediately. No data
2712 * was produced as the session was stopped, so the
2713 * rotation should happen on reception of the command.
2715 ret
= cmd_rotate_session(session
, NULL
, true,
2716 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2717 if (ret
!= LTTNG_OK
) {
2723 /* Kernel tracing */
2724 if (ksession
!= NULL
) {
2725 DBG("Start kernel tracing session %s", session
->name
);
2726 ret
= start_kernel_session(ksession
);
2727 if (ret
!= LTTNG_OK
) {
2732 /* Flag session that trace should start automatically */
2734 int int_ret
= ust_app_start_trace_all(usess
);
2737 ret
= LTTNG_ERR_UST_START_FAIL
;
2743 * Clear the flag that indicates that a rotation was done while the
2744 * session was stopped.
2746 session
->rotated_after_last_stop
= false;
2748 if (session
->rotate_timer_period
) {
2749 int int_ret
= timer_session_rotation_schedule_timer_start(
2750 session
, session
->rotate_timer_period
);
2753 ERR("Failed to enable rotate timer");
2754 ret
= LTTNG_ERR_UNK
;
2762 if (ret
== LTTNG_OK
) {
2763 /* Flag this after a successful start. */
2764 session
->has_been_started
|= 1;
2766 session
->active
= 0;
2767 /* Restore initial state on error. */
2768 session
->rotated_after_last_stop
=
2769 session_rotated_after_last_stop
;
2770 session
->cleared_after_last_stop
=
2771 session_cleared_after_last_stop
;
2778 * Command LTTNG_STOP_TRACE processed by the client thread.
2780 int cmd_stop_trace(struct ltt_session
*session
)
2783 struct ltt_kernel_session
*ksession
;
2784 struct ltt_ust_session
*usess
;
2788 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2790 ksession
= session
->kernel_session
;
2791 usess
= session
->ust_session
;
2793 /* Session is not active. Skip everythong and inform the client. */
2794 if (!session
->active
) {
2795 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2799 ret
= stop_kernel_session(ksession
);
2800 if (ret
!= LTTNG_OK
) {
2804 if (usess
&& usess
->active
) {
2805 ret
= ust_app_stop_trace_all(usess
);
2807 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2812 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2814 /* Flag inactive after a successful stop. */
2815 session
->active
= 0;
2823 * Set the base_path of the session only if subdir of a control uris is set.
2824 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2826 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2828 struct lttng_uri
*uris
)
2833 for (i
= 0; i
< nb_uri
; i
++) {
2834 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2835 uris
[i
].subdir
[0] == '\0') {
2836 /* Not interested in these URIs */
2840 if (session
->base_path
!= NULL
) {
2841 free(session
->base_path
);
2842 session
->base_path
= NULL
;
2845 /* Set session base_path */
2846 session
->base_path
= strdup(uris
[i
].subdir
);
2847 if (!session
->base_path
) {
2848 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2849 uris
[i
].subdir
, session
->name
);
2850 ret
= LTTNG_ERR_NOMEM
;
2853 DBG2("Setting base path \"%s\" for session \"%s\"",
2854 session
->base_path
, session
->name
);
2862 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2864 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2865 struct lttng_uri
*uris
)
2868 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2869 struct ltt_ust_session
*usess
= session
->ust_session
;
2875 /* Can't set consumer URI if the session is active. */
2876 if (session
->active
) {
2877 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2882 * Set the session base path if any. This is done inside
2883 * cmd_set_consumer_uri to preserve backward compatibility of the
2884 * previous session creation api vs the session descriptor api.
2886 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2887 if (ret
!= LTTNG_OK
) {
2891 /* Set the "global" consumer URIs */
2892 for (i
= 0; i
< nb_uri
; i
++) {
2893 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2895 if (ret
!= LTTNG_OK
) {
2900 /* Set UST session URIs */
2901 if (session
->ust_session
) {
2902 for (i
= 0; i
< nb_uri
; i
++) {
2903 ret
= add_uri_to_consumer(session
,
2904 session
->ust_session
->consumer
,
2905 &uris
[i
], LTTNG_DOMAIN_UST
);
2906 if (ret
!= LTTNG_OK
) {
2912 /* Set kernel session URIs */
2913 if (session
->kernel_session
) {
2914 for (i
= 0; i
< nb_uri
; i
++) {
2915 ret
= add_uri_to_consumer(session
,
2916 session
->kernel_session
->consumer
,
2917 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2918 if (ret
!= LTTNG_OK
) {
2925 * Make sure to set the session in output mode after we set URI since a
2926 * session can be created without URL (thus flagged in no output mode).
2928 session
->output_traces
= 1;
2930 ksess
->output_traces
= 1;
2934 usess
->output_traces
= 1;
2945 enum lttng_error_code
set_session_output_from_descriptor(
2946 struct ltt_session
*session
,
2947 const struct lttng_session_descriptor
*descriptor
)
2950 enum lttng_error_code ret_code
= LTTNG_OK
;
2951 enum lttng_session_descriptor_type session_type
=
2952 lttng_session_descriptor_get_type(descriptor
);
2953 enum lttng_session_descriptor_output_type output_type
=
2954 lttng_session_descriptor_get_output_type(descriptor
);
2955 struct lttng_uri uris
[2] = {};
2956 size_t uri_count
= 0;
2958 switch (output_type
) {
2959 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2961 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2962 lttng_session_descriptor_get_local_output_uri(descriptor
,
2966 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2967 lttng_session_descriptor_get_network_output_uris(descriptor
,
2968 &uris
[0], &uris
[1]);
2972 ret_code
= LTTNG_ERR_INVALID
;
2976 switch (session_type
) {
2977 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2979 struct snapshot_output
*new_output
= NULL
;
2981 new_output
= snapshot_output_alloc();
2983 ret_code
= LTTNG_ERR_NOMEM
;
2987 ret
= snapshot_output_init_with_uri(session
,
2988 DEFAULT_SNAPSHOT_MAX_SIZE
,
2989 NULL
, uris
, uri_count
, session
->consumer
,
2990 new_output
, &session
->snapshot
);
2992 ret_code
= (ret
== -ENOMEM
) ?
2993 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2994 snapshot_output_destroy(new_output
);
2997 snapshot_add_output(&session
->snapshot
, new_output
);
3000 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3001 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3003 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3007 ret_code
= LTTNG_ERR_INVALID
;
3015 enum lttng_error_code
cmd_create_session_from_descriptor(
3016 struct lttng_session_descriptor
*descriptor
,
3017 const lttng_sock_cred
*creds
,
3018 const char *home_path
)
3021 enum lttng_error_code ret_code
;
3022 const char *session_name
;
3023 struct ltt_session
*new_session
= NULL
;
3024 enum lttng_session_descriptor_status descriptor_status
;
3026 session_lock_list();
3028 if (*home_path
!= '/') {
3029 ERR("Home path provided by client is not absolute");
3030 ret_code
= LTTNG_ERR_INVALID
;
3035 descriptor_status
= lttng_session_descriptor_get_session_name(
3036 descriptor
, &session_name
);
3037 switch (descriptor_status
) {
3038 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3040 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3041 session_name
= NULL
;
3044 ret_code
= LTTNG_ERR_INVALID
;
3048 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3050 if (ret_code
!= LTTNG_OK
) {
3054 if (!session_name
) {
3055 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3058 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3063 if (!lttng_session_descriptor_is_output_destination_initialized(
3066 * Only include the session's creation time in the output
3067 * destination if the name of the session itself was
3068 * not auto-generated.
3070 ret_code
= lttng_session_descriptor_set_default_output(
3072 session_name
? &new_session
->creation_time
: NULL
,
3074 if (ret_code
!= LTTNG_OK
) {
3078 new_session
->has_user_specified_directory
=
3079 lttng_session_descriptor_has_output_directory(
3083 switch (lttng_session_descriptor_get_type(descriptor
)) {
3084 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3085 new_session
->snapshot_mode
= 1;
3087 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3088 new_session
->live_timer
=
3089 lttng_session_descriptor_live_get_timer_interval(
3096 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3097 if (ret_code
!= LTTNG_OK
) {
3100 new_session
->consumer
->enabled
= 1;
3101 ret_code
= LTTNG_OK
;
3103 /* Release reference provided by the session_create function. */
3104 session_put(new_session
);
3105 if (ret_code
!= LTTNG_OK
&& new_session
) {
3106 /* Release the global reference on error. */
3107 session_destroy(new_session
);
3109 session_unlock_list();
3113 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3114 struct lttng_session_descriptor
**return_descriptor
)
3117 size_t payload_size
;
3118 struct lttng_dynamic_buffer payload
;
3119 struct lttng_buffer_view home_dir_view
;
3120 struct lttng_buffer_view session_descriptor_view
;
3121 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3122 enum lttng_error_code ret_code
;
3124 lttng_dynamic_buffer_init(&payload
);
3125 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3127 ret_code
= LTTNG_ERR_INVALID
;
3130 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3131 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3132 ret_code
= LTTNG_ERR_INVALID
;
3136 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3137 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3138 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3140 ret_code
= LTTNG_ERR_NOMEM
;
3144 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3146 ERR("Reception of session descriptor failed, aborting.");
3147 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3151 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3154 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3155 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3157 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3158 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3160 ret
= lttng_session_descriptor_create_from_buffer(
3161 &session_descriptor_view
, &session_descriptor
);
3163 ERR("Failed to create session descriptor from payload of \"create session\" command");
3164 ret_code
= LTTNG_ERR_INVALID
;
3169 * Sets the descriptor's auto-generated properties (name, output) if
3172 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3174 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3175 if (ret_code
!= LTTNG_OK
) {
3179 ret_code
= LTTNG_OK
;
3180 *return_descriptor
= session_descriptor
;
3181 session_descriptor
= NULL
;
3183 lttng_dynamic_buffer_reset(&payload
);
3184 lttng_session_descriptor_destroy(session_descriptor
);
3189 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3190 void *_reply_context
)
3194 const struct cmd_destroy_session_reply_context
*reply_context
=
3196 struct lttng_dynamic_buffer payload
;
3197 struct lttcomm_session_destroy_command_header cmd_header
;
3198 struct lttng_trace_archive_location
*location
= NULL
;
3199 struct lttcomm_lttng_msg llm
= {
3200 .cmd_type
= LTTNG_DESTROY_SESSION
,
3201 .ret_code
= reply_context
->destruction_status
,
3204 sizeof(struct lttcomm_session_destroy_command_header
),
3207 size_t payload_size_before_location
;
3209 lttng_dynamic_buffer_init(&payload
);
3211 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3213 ERR("Failed to append session destruction message");
3217 cmd_header
.rotation_state
=
3218 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3219 session
->rotation_state
:
3220 LTTNG_ROTATION_STATE_NO_ROTATION
);
3221 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3222 sizeof(cmd_header
));
3224 ERR("Failed to append session destruction command header");
3228 if (!reply_context
->implicit_rotation_on_destroy
) {
3229 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3233 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3234 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3239 location
= session_get_trace_archive_location(session
);
3241 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3246 payload_size_before_location
= payload
.size
;
3247 comm_ret
= lttng_trace_archive_location_serialize(location
,
3250 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3254 /* Update the message to indicate the location's length. */
3255 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3256 payload
.size
- payload_size_before_location
;
3258 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3259 payload
.data
, payload
.size
);
3260 if (comm_ret
!= (ssize_t
) payload
.size
) {
3261 ERR("Failed to send result of the destruction of session \"%s\" to client",
3265 ret
= close(reply_context
->reply_sock_fd
);
3267 PERROR("Failed to close client socket in deferred session destroy reply");
3269 lttng_dynamic_buffer_reset(&payload
);
3270 free(_reply_context
);
3274 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3276 * Called with session lock held.
3278 int cmd_destroy_session(struct ltt_session
*session
,
3279 struct notification_thread_handle
*notification_thread_handle
,
3283 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3284 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3287 reply_context
= zmalloc(sizeof(*reply_context
));
3288 if (!reply_context
) {
3289 ret
= LTTNG_ERR_NOMEM
;
3292 reply_context
->reply_sock_fd
= *sock_fd
;
3298 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3300 if (session
->active
) {
3301 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3303 ret
= cmd_stop_trace(session
);
3304 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3305 /* Carry on with the destruction of the session. */
3306 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3307 session
->name
, lttng_strerror(-ret
));
3308 destruction_last_error
= ret
;
3312 if (session
->rotation_schedule_timer_enabled
) {
3313 if (timer_session_rotation_schedule_timer_stop(
3315 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3317 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3321 if (session
->rotate_size
) {
3322 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3323 session
->rotate_size
= 0;
3326 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3328 * Perform a last rotation on destruction if rotations have
3329 * occurred during the session's lifetime.
3331 ret
= cmd_rotate_session(session
, NULL
, false,
3332 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3333 if (ret
!= LTTNG_OK
) {
3334 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3335 session
->name
, lttng_strerror(-ret
));
3336 destruction_last_error
= -ret
;
3338 if (reply_context
) {
3339 reply_context
->implicit_rotation_on_destroy
= true;
3341 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3343 * The user has not triggered a session rotation. However, to
3344 * ensure all data has been consumed, the session is rotated
3345 * to a 'null' trace chunk before it is destroyed.
3347 * This is a "quiet" rotation meaning that no notification is
3348 * emitted and no renaming of the current trace chunk takes
3351 ret
= cmd_rotate_session(session
, NULL
, true,
3352 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3353 if (ret
!= LTTNG_OK
) {
3354 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3355 session
->name
, lttng_strerror(-ret
));
3356 destruction_last_error
= -ret
;
3360 if (session
->shm_path
[0]) {
3362 * When a session is created with an explicit shm_path,
3363 * the consumer daemon will create its shared memory files
3364 * at that location and will *not* unlink them. This is normal
3365 * as the intention of that feature is to make it possible
3366 * to retrieve the content of those files should a crash occur.
3368 * To ensure the content of those files can be used, the
3369 * sessiond daemon will replicate the content of the metadata
3370 * cache in a metadata file.
3372 * On clean-up, it is expected that the consumer daemon will
3373 * unlink the shared memory files and that the session daemon
3374 * will unlink the metadata file. Then, the session's directory
3375 * in the shm path can be removed.
3377 * Unfortunately, a flaw in the design of the sessiond's and
3378 * consumerd's tear down of channels makes it impossible to
3379 * determine when the sessiond _and_ the consumerd have both
3380 * destroyed their representation of a channel. For one, the
3381 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3382 * callbacks in both daemons.
3384 * However, it is also impossible for the sessiond to know when
3385 * the consumer daemon is done destroying its channel(s) since
3386 * it occurs as a reaction to the closing of the channel's file
3387 * descriptor. There is no resulting communication initiated
3388 * from the consumerd to the sessiond to confirm that the
3389 * operation is completed (and was successful).
3391 * Until this is all fixed, the session daemon checks for the
3392 * removal of the session's shm path which makes it possible
3393 * to safely advertise a session as having been destroyed.
3395 * Prior to this fix, it was not possible to reliably save
3396 * a session making use of the --shm-path option, destroy it,
3397 * and load it again. This is because the creation of the
3398 * session would fail upon seeing the session's shm path
3399 * already in existence.
3401 * Note that none of the error paths in the check for the
3402 * directory's existence return an error. This is normal
3403 * as there isn't much that can be done. The session will
3404 * be destroyed properly, except that we can't offer the
3405 * guarantee that the same session can be re-created.
3407 current_completion_handler
= &destroy_completion_handler
.handler
;
3408 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3410 sizeof(destroy_completion_handler
.shm_path
));
3415 * The session is destroyed. However, note that the command context
3416 * still holds a reference to the session, thus delaying its destruction
3417 * _at least_ up to the point when that reference is released.
3419 session_destroy(session
);
3420 if (reply_context
) {
3421 reply_context
->destruction_status
= destruction_last_error
;
3422 ret
= session_add_destroy_notifier(session
,
3423 cmd_destroy_session_reply
,
3424 (void *) reply_context
);
3426 ret
= LTTNG_ERR_FATAL
;
3438 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3440 int cmd_register_consumer(struct ltt_session
*session
,
3441 enum lttng_domain_type domain
, const char *sock_path
,
3442 struct consumer_data
*cdata
)
3445 struct consumer_socket
*socket
= NULL
;
3452 case LTTNG_DOMAIN_KERNEL
:
3454 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3458 /* Can't register a consumer if there is already one */
3459 if (ksess
->consumer_fds_sent
!= 0) {
3460 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3464 sock
= lttcomm_connect_unix_sock(sock_path
);
3466 ret
= LTTNG_ERR_CONNECT_FAIL
;
3469 cdata
->cmd_sock
= sock
;
3471 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3472 if (socket
== NULL
) {
3475 PERROR("close register consumer");
3477 cdata
->cmd_sock
= -1;
3478 ret
= LTTNG_ERR_FATAL
;
3482 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3483 if (socket
->lock
== NULL
) {
3484 PERROR("zmalloc pthread mutex");
3485 ret
= LTTNG_ERR_FATAL
;
3488 pthread_mutex_init(socket
->lock
, NULL
);
3489 socket
->registered
= 1;
3492 consumer_add_socket(socket
, ksess
->consumer
);
3495 pthread_mutex_lock(&cdata
->pid_mutex
);
3497 pthread_mutex_unlock(&cdata
->pid_mutex
);
3502 /* TODO: Userspace tracing */
3503 ret
= LTTNG_ERR_UND
;
3511 consumer_destroy_socket(socket
);
3517 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3519 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3520 struct lttng_domain
**domains
)
3525 struct lttng_ht_iter iter
;
3527 if (session
->kernel_session
!= NULL
) {
3528 DBG3("Listing domains found kernel domain");
3532 if (session
->ust_session
!= NULL
) {
3533 DBG3("Listing domains found UST global domain");
3537 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3539 if (agt
->being_used
) {
3550 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3551 if (*domains
== NULL
) {
3552 ret
= LTTNG_ERR_FATAL
;
3556 if (session
->kernel_session
!= NULL
) {
3557 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3559 /* Kernel session buffer type is always GLOBAL */
3560 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3565 if (session
->ust_session
!= NULL
) {
3566 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3567 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3571 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3573 if (agt
->being_used
) {
3574 (*domains
)[index
].type
= agt
->domain
;
3575 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3585 /* Return negative value to differentiate return code */
3591 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3593 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3594 struct ltt_session
*session
, struct lttng_channel
**channels
)
3596 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3599 case LTTNG_DOMAIN_KERNEL
:
3600 if (session
->kernel_session
!= NULL
) {
3601 nb_chan
= session
->kernel_session
->channel_count
;
3603 DBG3("Number of kernel channels %zd", nb_chan
);
3605 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3609 case LTTNG_DOMAIN_UST
:
3610 if (session
->ust_session
!= NULL
) {
3612 nb_chan
= lttng_ht_get_count(
3613 session
->ust_session
->domain_global
.channels
);
3616 DBG3("Number of UST global channels %zd", nb_chan
);
3618 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3623 ret
= -LTTNG_ERR_UND
;
3628 const size_t channel_size
= sizeof(struct lttng_channel
) +
3629 sizeof(struct lttng_channel_extended
);
3630 struct lttng_channel_extended
*channel_exts
;
3632 payload_size
= nb_chan
* channel_size
;
3633 *channels
= zmalloc(payload_size
);
3634 if (*channels
== NULL
) {
3635 ret
= -LTTNG_ERR_FATAL
;
3639 channel_exts
= ((void *) *channels
) +
3640 (nb_chan
* sizeof(struct lttng_channel
));
3641 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3642 if (ret
!= LTTNG_OK
) {
3657 * Command LTTNG_LIST_EVENTS processed by the client thread.
3659 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3660 struct ltt_session
*session
, char *channel_name
,
3661 struct lttng_event
**events
, size_t *total_size
)
3664 ssize_t nb_event
= 0;
3667 case LTTNG_DOMAIN_KERNEL
:
3668 if (session
->kernel_session
!= NULL
) {
3669 nb_event
= list_lttng_kernel_events(channel_name
,
3670 session
->kernel_session
, events
,
3674 case LTTNG_DOMAIN_UST
:
3676 if (session
->ust_session
!= NULL
) {
3677 nb_event
= list_lttng_ust_global_events(channel_name
,
3678 &session
->ust_session
->domain_global
, events
,
3683 case LTTNG_DOMAIN_LOG4J
:
3684 case LTTNG_DOMAIN_JUL
:
3685 case LTTNG_DOMAIN_PYTHON
:
3686 if (session
->ust_session
) {
3687 struct lttng_ht_iter iter
;
3691 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3692 &iter
.iter
, agt
, node
.node
) {
3693 if (agt
->domain
== domain
) {
3694 nb_event
= list_lttng_agent_events(
3704 ret
= LTTNG_ERR_UND
;
3711 /* Return negative value to differentiate return code */
3716 * Using the session list, filled a lttng_session array to send back to the
3717 * client for session listing.
3719 * The session list lock MUST be acquired before calling this function. Use
3720 * session_lock_list() and session_unlock_list().
3722 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3723 size_t session_count
, uid_t uid
, gid_t gid
)
3727 struct ltt_session
*session
;
3728 struct ltt_session_list
*list
= session_get_list();
3729 struct lttng_session_extended
*extended
=
3730 (typeof(extended
)) (&sessions
[session_count
]);
3732 DBG("Getting all available session for UID %d GID %d",
3735 * Iterate over session list and append data after the control struct in
3738 cds_list_for_each_entry(session
, &list
->head
, list
) {
3739 if (!session_get(session
)) {
3743 * Only list the sessions the user can control.
3745 if (!session_access_ok(session
, uid
, gid
) ||
3746 session
->destroyed
) {
3747 session_put(session
);
3751 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3752 struct ltt_ust_session
*usess
= session
->ust_session
;
3754 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3755 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3756 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3757 ret
= build_network_session_path(sessions
[i
].path
,
3758 sizeof(sessions
[i
].path
), session
);
3760 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3761 session
->consumer
->dst
.session_root_path
);
3764 PERROR("snprintf session path");
3765 session_put(session
);
3769 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3770 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3771 sessions
[i
].enabled
= session
->active
;
3772 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3773 sessions
[i
].live_timer_interval
= session
->live_timer
;
3774 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3775 extended
[i
].creation_time
.is_set
= 1;
3777 session_put(session
);
3782 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3783 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3785 int cmd_data_pending(struct ltt_session
*session
)
3788 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3789 struct ltt_ust_session
*usess
= session
->ust_session
;
3793 DBG("Data pending for session %s", session
->name
);
3795 /* Session MUST be stopped to ask for data availability. */
3796 if (session
->active
) {
3797 ret
= LTTNG_ERR_SESSION_STARTED
;
3801 * If stopped, just make sure we've started before else the above call
3802 * will always send that there is data pending.
3804 * The consumer assumes that when the data pending command is received,
3805 * the trace has been started before or else no output data is written
3806 * by the streams which is a condition for data pending. So, this is
3807 * *VERY* important that we don't ask the consumer before a start
3810 if (!session
->has_been_started
) {
3816 /* A rotation is still pending, we have to wait. */
3817 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3818 DBG("Rotate still pending for session %s", session
->name
);
3823 if (ksess
&& ksess
->consumer
) {
3824 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3826 /* Data is still being extracted for the kernel. */
3831 if (usess
&& usess
->consumer
) {
3832 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3834 /* Data is still being extracted for the kernel. */
3839 /* Data is ready to be read by a viewer */
3847 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3849 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3851 int cmd_snapshot_add_output(struct ltt_session
*session
,
3852 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3855 struct snapshot_output
*new_output
;
3860 DBG("Cmd snapshot add output for session %s", session
->name
);
3863 * Can't create an output if the session is not set in no-output mode.
3865 if (session
->output_traces
) {
3866 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3870 if (session
->has_non_mmap_channel
) {
3871 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3875 /* Only one output is allowed until we have the "tee" feature. */
3876 if (session
->snapshot
.nb_output
== 1) {
3877 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3881 new_output
= snapshot_output_alloc();
3883 ret
= LTTNG_ERR_NOMEM
;
3887 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3888 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3889 &session
->snapshot
);
3891 if (ret
== -ENOMEM
) {
3892 ret
= LTTNG_ERR_NOMEM
;
3894 ret
= LTTNG_ERR_INVALID
;
3900 snapshot_add_output(&session
->snapshot
, new_output
);
3902 *id
= new_output
->id
;
3909 snapshot_output_destroy(new_output
);
3915 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3917 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3919 int cmd_snapshot_del_output(struct ltt_session
*session
,
3920 const struct lttng_snapshot_output
*output
)
3923 struct snapshot_output
*sout
= NULL
;
3931 * Permission denied to create an output if the session is not
3932 * set in no output mode.
3934 if (session
->output_traces
) {
3935 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3940 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3942 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3943 } else if (*output
->name
!= '\0') {
3944 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3946 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3949 ret
= LTTNG_ERR_INVALID
;
3953 snapshot_delete_output(&session
->snapshot
, sout
);
3954 snapshot_output_destroy(sout
);
3963 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3965 * If no output is available, outputs is untouched and 0 is returned.
3967 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3969 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3970 struct lttng_snapshot_output
**outputs
)
3973 struct lttng_snapshot_output
*list
= NULL
;
3974 struct lttng_ht_iter iter
;
3975 struct snapshot_output
*output
;
3980 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3983 * Permission denied to create an output if the session is not
3984 * set in no output mode.
3986 if (session
->output_traces
) {
3987 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3991 if (session
->snapshot
.nb_output
== 0) {
3996 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3998 ret
= -LTTNG_ERR_NOMEM
;
4002 /* Copy list from session to the new list object. */
4004 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4005 output
, node
.node
) {
4006 assert(output
->consumer
);
4007 list
[idx
].id
= output
->id
;
4008 list
[idx
].max_size
= output
->max_size
;
4009 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4010 sizeof(list
[idx
].name
))) {
4011 ret
= -LTTNG_ERR_INVALID
;
4014 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4015 if (lttng_strncpy(list
[idx
].ctrl_url
,
4016 output
->consumer
->dst
.session_root_path
,
4017 sizeof(list
[idx
].ctrl_url
))) {
4018 ret
= -LTTNG_ERR_INVALID
;
4023 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4024 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4026 ret
= -LTTNG_ERR_NOMEM
;
4031 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4032 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4034 ret
= -LTTNG_ERR_NOMEM
;
4043 ret
= session
->snapshot
.nb_output
;
4052 * Check if we can regenerate the metadata for this session.
4053 * Only kernel, UST per-uid and non-live sessions are supported.
4055 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4058 int check_regenerate_metadata_support(struct ltt_session
*session
)
4064 if (session
->live_timer
!= 0) {
4065 ret
= LTTNG_ERR_LIVE_SESSION
;
4068 if (!session
->active
) {
4069 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4072 if (session
->ust_session
) {
4073 switch (session
->ust_session
->buffer_type
) {
4074 case LTTNG_BUFFER_PER_UID
:
4076 case LTTNG_BUFFER_PER_PID
:
4077 ret
= LTTNG_ERR_PER_PID_SESSION
;
4081 ret
= LTTNG_ERR_UNK
;
4085 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4086 session
->consumer
->relay_minor_version
< 8) {
4087 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4097 int clear_metadata_file(int fd
)
4102 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4103 if (lseek_ret
< 0) {
4109 ret
= ftruncate(fd
, 0);
4111 PERROR("ftruncate");
4120 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4123 struct buffer_reg_uid
*uid_reg
= NULL
;
4124 struct buffer_reg_session
*session_reg
= NULL
;
4127 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4128 struct ust_registry_session
*registry
;
4129 struct ust_registry_channel
*chan
;
4130 struct lttng_ht_iter iter_chan
;
4132 session_reg
= uid_reg
->registry
;
4133 registry
= session_reg
->reg
.ust
;
4135 pthread_mutex_lock(®istry
->lock
);
4136 registry
->metadata_len_sent
= 0;
4137 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4138 registry
->metadata_len
= 0;
4139 registry
->metadata_version
++;
4140 if (registry
->metadata_fd
> 0) {
4141 /* Clear the metadata file's content. */
4142 ret
= clear_metadata_file(registry
->metadata_fd
);
4144 pthread_mutex_unlock(®istry
->lock
);
4149 ret
= ust_metadata_session_statedump(registry
, NULL
,
4150 registry
->major
, registry
->minor
);
4152 pthread_mutex_unlock(®istry
->lock
);
4153 ERR("Failed to generate session metadata (err = %d)",
4157 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4159 struct ust_registry_event
*event
;
4160 struct lttng_ht_iter iter_event
;
4162 ret
= ust_metadata_channel_statedump(registry
, chan
);
4164 pthread_mutex_unlock(®istry
->lock
);
4165 ERR("Failed to generate channel metadata "
4169 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4171 ret
= ust_metadata_event_statedump(registry
,
4174 pthread_mutex_unlock(®istry
->lock
);
4175 ERR("Failed to generate event metadata "
4181 pthread_mutex_unlock(®istry
->lock
);
4190 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4192 * Ask the consumer to truncate the existing metadata file(s) and
4193 * then regenerate the metadata. Live and per-pid sessions are not
4194 * supported and return an error.
4196 * Return 0 on success or else a LTTNG_ERR code.
4198 int cmd_regenerate_metadata(struct ltt_session
*session
)
4204 ret
= check_regenerate_metadata_support(session
);
4209 if (session
->kernel_session
) {
4210 ret
= kernctl_session_regenerate_metadata(
4211 session
->kernel_session
->fd
);
4213 ERR("Failed to regenerate the kernel metadata");
4218 if (session
->ust_session
) {
4219 ret
= ust_regenerate_metadata(session
->ust_session
);
4221 ERR("Failed to regenerate the UST metadata");
4225 DBG("Cmd metadata regenerate for session %s", session
->name
);
4233 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4235 * Ask the tracer to regenerate a new statedump.
4237 * Return 0 on success or else a LTTNG_ERR code.
4239 int cmd_regenerate_statedump(struct ltt_session
*session
)
4245 if (!session
->active
) {
4246 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4250 if (session
->kernel_session
) {
4251 ret
= kernctl_session_regenerate_statedump(
4252 session
->kernel_session
->fd
);
4254 * Currently, the statedump in kernel can only fail if out
4258 if (ret
== -ENOMEM
) {
4259 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4261 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4263 ERR("Failed to regenerate the kernel statedump");
4268 if (session
->ust_session
) {
4269 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4271 * Currently, the statedump in UST always returns 0.
4274 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4275 ERR("Failed to regenerate the UST statedump");
4279 DBG("Cmd regenerate statedump for session %s", session
->name
);
4286 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4287 struct notification_thread_handle
*notification_thread
)
4291 ssize_t sock_recv_len
;
4292 struct lttng_trigger
*trigger
= NULL
;
4293 struct lttng_buffer_view view
;
4294 struct lttng_dynamic_buffer trigger_buffer
;
4296 lttng_dynamic_buffer_init(&trigger_buffer
);
4297 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4298 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4300 ret
= LTTNG_ERR_NOMEM
;
4304 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4306 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4307 ERR("Failed to receive \"register trigger\" command payload");
4308 /* TODO: should this be a new error enum ? */
4309 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4313 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4314 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4316 ERR("Invalid trigger payload received in \"register trigger\" command");
4317 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4321 ret
= notification_thread_command_register_trigger(notification_thread
,
4323 /* Ownership of trigger was transferred. */
4326 lttng_trigger_destroy(trigger
);
4327 lttng_dynamic_buffer_reset(&trigger_buffer
);
4331 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4332 struct notification_thread_handle
*notification_thread
)
4336 ssize_t sock_recv_len
;
4337 struct lttng_trigger
*trigger
= NULL
;
4338 struct lttng_buffer_view view
;
4339 struct lttng_dynamic_buffer trigger_buffer
;
4341 lttng_dynamic_buffer_init(&trigger_buffer
);
4342 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4343 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4345 ret
= LTTNG_ERR_NOMEM
;
4349 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4351 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4352 ERR("Failed to receive \"unregister trigger\" command payload");
4353 /* TODO: should this be a new error enum ? */
4354 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4358 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4359 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4361 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4362 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4366 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4369 lttng_trigger_destroy(trigger
);
4370 lttng_dynamic_buffer_reset(&trigger_buffer
);
4375 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4376 * snapshot output is *not* set with a remote destination.
4378 * Return LTTNG_OK on success or a LTTNG_ERR code.
4380 static enum lttng_error_code
set_relayd_for_snapshot(
4381 struct consumer_output
*output
,
4382 const struct ltt_session
*session
)
4384 enum lttng_error_code status
= LTTNG_OK
;
4385 struct lttng_ht_iter iter
;
4386 struct consumer_socket
*socket
;
4387 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4388 const char *base_path
;
4393 DBG2("Set relayd object from snapshot output");
4395 if (session
->current_trace_chunk
) {
4396 enum lttng_trace_chunk_status chunk_status
=
4397 lttng_trace_chunk_get_id(
4398 session
->current_trace_chunk
,
4399 ¤t_chunk_id
.value
);
4401 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4402 current_chunk_id
.is_set
= true;
4404 ERR("Failed to get current trace chunk id");
4405 status
= LTTNG_ERR_UNK
;
4410 /* Ignore if snapshot consumer output is not network. */
4411 if (output
->type
!= CONSUMER_DST_NET
) {
4416 * The snapshot record URI base path overrides the session
4419 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4420 base_path
= output
->dst
.net
.control
.subdir
;
4422 base_path
= session
->base_path
;
4426 * For each consumer socket, create and send the relayd object of the
4430 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4431 socket
, node
.node
) {
4432 pthread_mutex_lock(socket
->lock
);
4433 status
= send_consumer_relayd_sockets(0, session
->id
,
4435 session
->name
, session
->hostname
,
4437 session
->live_timer
,
4438 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4439 session
->creation_time
,
4440 session
->name_contains_creation_time
);
4441 pthread_mutex_unlock(socket
->lock
);
4442 if (status
!= LTTNG_OK
) {
4454 * Record a kernel snapshot.
4456 * Return LTTNG_OK on success or a LTTNG_ERR code.
4458 static enum lttng_error_code
record_kernel_snapshot(
4459 struct ltt_kernel_session
*ksess
,
4460 const struct consumer_output
*output
,
4461 const struct ltt_session
*session
,
4462 int wait
, uint64_t nb_packets_per_stream
)
4464 enum lttng_error_code status
;
4470 status
= kernel_snapshot_record(
4471 ksess
, output
, wait
, nb_packets_per_stream
);
4476 * Record a UST snapshot.
4478 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4480 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4481 const struct consumer_output
*output
,
4482 const struct ltt_session
*session
,
4483 int wait
, uint64_t nb_packets_per_stream
)
4485 enum lttng_error_code status
;
4491 status
= ust_app_snapshot_record(
4492 usess
, output
, wait
, nb_packets_per_stream
);
4497 uint64_t get_session_size_one_more_packet_per_stream(
4498 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4500 uint64_t tot_size
= 0;
4502 if (session
->kernel_session
) {
4503 struct ltt_kernel_channel
*chan
;
4504 const struct ltt_kernel_session
*ksess
=
4505 session
->kernel_session
;
4507 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4508 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4510 * Don't take channel into account if we
4511 * already grab all its packets.
4515 tot_size
+= chan
->channel
->attr
.subbuf_size
4516 * chan
->stream_count
;
4520 if (session
->ust_session
) {
4521 const struct ltt_ust_session
*usess
= session
->ust_session
;
4523 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4531 * Calculate the number of packets we can grab from each stream that
4532 * fits within the overall snapshot max size.
4534 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4535 * the number of packets per stream.
4537 * TODO: this approach is not perfect: we consider the worse case
4538 * (packet filling the sub-buffers) as an upper bound, but we could do
4539 * better if we do this calculation while we actually grab the packet
4540 * content: we would know how much padding we don't actually store into
4543 * This algorithm is currently bounded by the number of packets per
4546 * Since we call this algorithm before actually grabbing the data, it's
4547 * an approximation: for instance, applications could appear/disappear
4548 * in between this call and actually grabbing data.
4551 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4555 uint64_t cur_nb_packets
= 0;
4558 return 0; /* Infinite */
4561 size_left
= max_size
;
4563 uint64_t one_more_packet_tot_size
;
4565 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4566 session
, cur_nb_packets
);
4567 if (!one_more_packet_tot_size
) {
4568 /* We are already grabbing all packets. */
4571 size_left
-= one_more_packet_tot_size
;
4572 if (size_left
< 0) {
4577 if (!cur_nb_packets
&& size_left
!= max_size
) {
4578 /* Not enough room to grab one packet of each stream, error. */
4581 return cur_nb_packets
;
4585 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4586 const struct snapshot_output
*snapshot_output
, int wait
)
4588 int64_t nb_packets_per_stream
;
4589 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4591 enum lttng_error_code ret_code
= LTTNG_OK
;
4592 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4593 struct consumer_output
*original_ust_consumer_output
= NULL
;
4594 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4595 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4596 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4598 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4600 snapshot_output
->name
,
4601 snapshot_output
->datetime
,
4602 snapshot_output
->nb_snapshot
);
4603 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4604 ERR("Failed to format snapshot name");
4605 ret_code
= LTTNG_ERR_INVALID
;
4608 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4609 snapshot_output
->name
, session
->name
,
4610 snapshot_chunk_name
);
4611 if (!session
->kernel_session
&& !session
->ust_session
) {
4612 ERR("Failed to record snapshot as no channels exist");
4613 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4617 if (session
->kernel_session
) {
4618 original_kernel_consumer_output
=
4619 session
->kernel_session
->consumer
;
4620 snapshot_kernel_consumer_output
=
4621 consumer_copy_output(snapshot_output
->consumer
);
4622 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4623 snapshot_chunk_name
);
4624 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4625 original_kernel_consumer_output
);
4627 ERR("Failed to copy consumer sockets from snapshot output configuration");
4628 ret_code
= LTTNG_ERR_NOMEM
;
4631 ret_code
= set_relayd_for_snapshot(
4632 snapshot_kernel_consumer_output
, session
);
4633 if (ret_code
!= LTTNG_OK
) {
4634 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4637 session
->kernel_session
->consumer
=
4638 snapshot_kernel_consumer_output
;
4640 if (session
->ust_session
) {
4641 original_ust_consumer_output
= session
->ust_session
->consumer
;
4642 snapshot_ust_consumer_output
=
4643 consumer_copy_output(snapshot_output
->consumer
);
4644 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4645 snapshot_chunk_name
);
4646 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4647 original_ust_consumer_output
);
4649 ERR("Failed to copy consumer sockets from snapshot output configuration");
4650 ret_code
= LTTNG_ERR_NOMEM
;
4653 ret_code
= set_relayd_for_snapshot(
4654 snapshot_ust_consumer_output
, session
);
4655 if (ret_code
!= LTTNG_OK
) {
4656 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4659 session
->ust_session
->consumer
=
4660 snapshot_ust_consumer_output
;
4663 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4664 snapshot_kernel_consumer_output
?:
4665 snapshot_ust_consumer_output
,
4666 consumer_output_get_base_path(
4667 snapshot_output
->consumer
),
4668 snapshot_chunk_name
);
4669 if (!snapshot_trace_chunk
) {
4670 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4672 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4675 assert(!session
->current_trace_chunk
);
4676 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4677 lttng_trace_chunk_put(snapshot_trace_chunk
);
4678 snapshot_trace_chunk
= NULL
;
4680 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4682 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4686 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4687 snapshot_output
->max_size
);
4688 if (nb_packets_per_stream
< 0) {
4689 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4690 goto error_close_trace_chunk
;
4693 if (session
->kernel_session
) {
4694 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4695 snapshot_kernel_consumer_output
, session
,
4696 wait
, nb_packets_per_stream
);
4697 if (ret_code
!= LTTNG_OK
) {
4698 goto error_close_trace_chunk
;
4702 if (session
->ust_session
) {
4703 ret_code
= record_ust_snapshot(session
->ust_session
,
4704 snapshot_ust_consumer_output
, session
,
4705 wait
, nb_packets_per_stream
);
4706 if (ret_code
!= LTTNG_OK
) {
4707 goto error_close_trace_chunk
;
4711 error_close_trace_chunk
:
4712 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4713 ERR("Failed to release the current trace chunk of session \"%s\"",
4715 ret_code
= LTTNG_ERR_UNK
;
4718 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4719 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4721 * Don't goto end; make sure the chunk is closed for the session
4722 * to allow future snapshots.
4724 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4726 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4729 if (original_ust_consumer_output
) {
4730 session
->ust_session
->consumer
= original_ust_consumer_output
;
4732 if (original_kernel_consumer_output
) {
4733 session
->kernel_session
->consumer
=
4734 original_kernel_consumer_output
;
4736 consumer_output_put(snapshot_ust_consumer_output
);
4737 consumer_output_put(snapshot_kernel_consumer_output
);
4742 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4744 * The wait parameter is ignored so this call always wait for the snapshot to
4745 * complete before returning.
4747 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4749 int cmd_snapshot_record(struct ltt_session
*session
,
4750 const struct lttng_snapshot_output
*output
, int wait
)
4752 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4754 unsigned int snapshot_success
= 0;
4756 struct snapshot_output
*tmp_output
= NULL
;
4761 DBG("Cmd snapshot record for session %s", session
->name
);
4763 /* Get the datetime for the snapshot output directory. */
4764 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4767 cmd_ret
= LTTNG_ERR_INVALID
;
4772 * Permission denied to create an output if the session is not
4773 * set in no output mode.
4775 if (session
->output_traces
) {
4776 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4780 /* The session needs to be started at least once. */
4781 if (!session
->has_been_started
) {
4782 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4786 /* Use temporary output for the session. */
4787 if (*output
->ctrl_url
!= '\0') {
4788 tmp_output
= snapshot_output_alloc();
4790 cmd_ret
= LTTNG_ERR_NOMEM
;
4794 ret
= snapshot_output_init(session
, output
->max_size
,
4796 output
->ctrl_url
, output
->data_url
,
4800 if (ret
== -ENOMEM
) {
4801 cmd_ret
= LTTNG_ERR_NOMEM
;
4803 cmd_ret
= LTTNG_ERR_INVALID
;
4807 /* Use the global session count for the temporary snapshot. */
4808 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4810 /* Use the global datetime */
4811 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4812 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4813 if (cmd_ret
!= LTTNG_OK
) {
4816 snapshot_success
= 1;
4818 struct snapshot_output
*sout
;
4819 struct lttng_ht_iter iter
;
4822 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4823 &iter
.iter
, sout
, node
.node
) {
4824 struct snapshot_output output_copy
;
4827 * Make a local copy of the output and override output
4828 * parameters with those provided as part of the
4831 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4833 if (output
->max_size
!= (uint64_t) -1ULL) {
4834 output_copy
.max_size
= output
->max_size
;
4837 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4838 memcpy(output_copy
.datetime
, datetime
,
4841 /* Use temporary name. */
4842 if (*output
->name
!= '\0') {
4843 if (lttng_strncpy(output_copy
.name
,
4845 sizeof(output_copy
.name
))) {
4846 cmd_ret
= LTTNG_ERR_INVALID
;
4852 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4853 if (cmd_ret
!= LTTNG_OK
) {
4857 snapshot_success
= 1;
4862 if (snapshot_success
) {
4863 session
->snapshot
.nb_snapshot
++;
4865 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4870 snapshot_output_destroy(tmp_output
);
4876 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4878 int cmd_set_session_shm_path(struct ltt_session
*session
,
4879 const char *shm_path
)
4885 * Can only set shm path before session is started.
4887 if (session
->has_been_started
) {
4888 return LTTNG_ERR_SESSION_STARTED
;
4891 strncpy(session
->shm_path
, shm_path
,
4892 sizeof(session
->shm_path
));
4893 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4899 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4901 * Ask the consumer to rotate the session output directory.
4902 * The session lock must be held.
4904 * Returns LTTNG_OK on success or else a negative LTTng error code.
4906 int cmd_rotate_session(struct ltt_session
*session
,
4907 struct lttng_rotate_session_return
*rotate_return
,
4908 bool quiet_rotation
,
4909 enum lttng_trace_chunk_command_type command
)
4912 uint64_t ongoing_rotation_chunk_id
;
4913 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4914 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4915 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4916 enum lttng_trace_chunk_status chunk_status
;
4917 bool failed_to_rotate
= false;
4918 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4922 if (!session
->has_been_started
) {
4923 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4928 * Explicit rotation is not supported for live sessions.
4929 * However, live sessions can perform a quiet rotation on
4931 * Rotation is not supported for snapshot traces (no output).
4933 if ((!quiet_rotation
&& session
->live_timer
) ||
4934 !session
->output_traces
) {
4935 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4939 /* Unsupported feature in lttng-relayd before 2.11. */
4940 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4941 (session
->consumer
->relay_major_version
== 2 &&
4942 session
->consumer
->relay_minor_version
< 11)) {
4943 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4947 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4948 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4949 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4953 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4954 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4956 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4961 * After a stop, we only allow one rotation to occur, the other ones are
4962 * useless until a new start.
4964 if (session
->rotated_after_last_stop
) {
4965 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4967 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4972 * After a stop followed by a clear, disallow following rotations a they would
4973 * generate empty chunks.
4975 if (session
->cleared_after_last_stop
) {
4976 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
4978 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
4982 if (session
->active
) {
4983 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4985 if (!new_trace_chunk
) {
4986 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4992 * The current trace chunk becomes the chunk being archived.
4994 * After this point, "chunk_being_archived" must absolutely
4995 * be closed on the consumer(s), otherwise it will never be
4996 * cleaned-up, which will result in a leak.
4998 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4999 &chunk_being_archived
);
5001 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5005 if (session
->kernel_session
) {
5006 cmd_ret
= kernel_rotate_session(session
);
5007 if (cmd_ret
!= LTTNG_OK
) {
5008 failed_to_rotate
= true;
5009 rotation_fail_code
= cmd_ret
;
5012 if (session
->ust_session
) {
5013 cmd_ret
= ust_app_rotate_session(session
);
5014 if (cmd_ret
!= LTTNG_OK
) {
5015 failed_to_rotate
= true;
5016 rotation_fail_code
= cmd_ret
;
5020 if (!session
->active
) {
5021 session
->rotated_after_last_stop
= true;
5024 if (!chunk_being_archived
) {
5025 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5027 if (failed_to_rotate
) {
5028 cmd_ret
= rotation_fail_code
;
5035 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5036 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5037 &ongoing_rotation_chunk_id
);
5038 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5040 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5041 command
, session
->last_chunk_path
);
5043 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5047 if (failed_to_rotate
) {
5048 cmd_ret
= rotation_fail_code
;
5052 session
->quiet_rotation
= quiet_rotation
;
5053 ret
= timer_session_rotation_pending_check_start(session
,
5054 DEFAULT_ROTATE_PENDING_TIMER
);
5056 cmd_ret
= LTTNG_ERR_UNK
;
5060 if (rotate_return
) {
5061 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5064 session
->chunk_being_archived
= chunk_being_archived
;
5065 chunk_being_archived
= NULL
;
5066 if (!quiet_rotation
) {
5067 ret
= notification_thread_command_session_rotation_ongoing(
5068 notification_thread_handle
,
5069 session
->name
, session
->uid
, session
->gid
,
5070 ongoing_rotation_chunk_id
);
5071 if (ret
!= LTTNG_OK
) {
5072 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5078 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5079 session
->name
, ongoing_rotation_chunk_id
);
5081 lttng_trace_chunk_put(new_trace_chunk
);
5082 lttng_trace_chunk_put(chunk_being_archived
);
5083 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5086 if (session_reset_rotation_state(session
,
5087 LTTNG_ROTATION_STATE_ERROR
)) {
5088 ERR("Failed to reset rotation state of session \"%s\"",
5095 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5097 * Check if the session has finished its rotation.
5099 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5101 int cmd_rotate_get_info(struct ltt_session
*session
,
5102 struct lttng_rotation_get_info_return
*info_return
,
5103 uint64_t rotation_id
)
5105 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5106 enum lttng_rotation_state rotation_state
;
5108 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5109 session
->most_recent_chunk_id
.value
);
5111 if (session
->chunk_being_archived
) {
5112 enum lttng_trace_chunk_status chunk_status
;
5115 chunk_status
= lttng_trace_chunk_get_id(
5116 session
->chunk_being_archived
,
5118 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5120 rotation_state
= rotation_id
== chunk_id
?
5121 LTTNG_ROTATION_STATE_ONGOING
:
5122 LTTNG_ROTATION_STATE_EXPIRED
;
5124 if (session
->last_archived_chunk_id
.is_set
&&
5125 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5126 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5128 rotation_state
= session
->rotation_state
;
5132 switch (rotation_state
) {
5133 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5134 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5137 case LTTNG_ROTATION_STATE_EXPIRED
:
5138 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5139 rotation_id
, session
->name
);
5141 case LTTNG_ROTATION_STATE_ONGOING
:
5142 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5143 rotation_id
, session
->name
);
5145 case LTTNG_ROTATION_STATE_COMPLETED
:
5149 char *current_tracing_path_reply
;
5150 size_t current_tracing_path_reply_len
;
5152 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5153 rotation_id
, session
->name
);
5155 switch (session_get_consumer_destination_type(session
)) {
5156 case CONSUMER_DST_LOCAL
:
5157 current_tracing_path_reply
=
5158 info_return
->location
.local
.absolute_path
;
5159 current_tracing_path_reply_len
=
5160 sizeof(info_return
->location
.local
.absolute_path
);
5161 info_return
->location_type
=
5162 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5163 fmt_ret
= asprintf(&chunk_path
,
5164 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5165 session_get_base_path(session
),
5166 session
->last_archived_chunk_name
);
5167 if (fmt_ret
== -1) {
5168 PERROR("Failed to format the path of the last archived trace chunk");
5169 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5170 cmd_ret
= LTTNG_ERR_UNK
;
5174 case CONSUMER_DST_NET
:
5176 uint16_t ctrl_port
, data_port
;
5178 current_tracing_path_reply
=
5179 info_return
->location
.relay
.relative_path
;
5180 current_tracing_path_reply_len
=
5181 sizeof(info_return
->location
.relay
.relative_path
);
5182 /* Currently the only supported relay protocol. */
5183 info_return
->location
.relay
.protocol
=
5184 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5186 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5187 session_get_net_consumer_hostname(session
),
5188 sizeof(info_return
->location
.relay
.host
));
5190 ERR("Failed to copy host name to rotate_get_info reply");
5191 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5192 cmd_ret
= LTTNG_ERR_SET_URL
;
5196 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5197 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5198 info_return
->location
.relay
.ports
.data
= data_port
;
5199 info_return
->location_type
=
5200 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5201 chunk_path
= strdup(session
->last_chunk_path
);
5203 ERR("Failed to allocate the path of the last archived trace chunk");
5204 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5205 cmd_ret
= LTTNG_ERR_UNK
;
5214 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5215 chunk_path
, current_tracing_path_reply_len
);
5218 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5219 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5220 cmd_ret
= LTTNG_ERR_UNK
;
5226 case LTTNG_ROTATION_STATE_ERROR
:
5227 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5228 rotation_id
, session
->name
);
5236 info_return
->status
= (int32_t) rotation_state
;
5241 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5243 * Configure the automatic rotation parameters.
5244 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5245 * 'activate' to false means deactivate the rotation schedule and validate that
5246 * 'new_value' has the same value as the currently active value.
5248 * Return 0 on success or else a positive LTTNG_ERR code.
5250 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5251 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5253 struct notification_thread_handle
*notification_thread_handle
)
5256 uint64_t *parameter_value
;
5260 DBG("Cmd rotate set schedule session %s", session
->name
);
5262 if (session
->live_timer
|| !session
->output_traces
) {
5263 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5264 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5268 switch (schedule_type
) {
5269 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5270 parameter_value
= &session
->rotate_size
;
5272 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5273 parameter_value
= &session
->rotate_timer_period
;
5274 if (new_value
>= UINT_MAX
) {
5275 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5276 new_value
, UINT_MAX
);
5277 ret
= LTTNG_ERR_INVALID
;
5282 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5283 ret
= LTTNG_ERR_INVALID
;
5287 /* Improper use of the API. */
5288 if (new_value
== -1ULL) {
5289 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5290 ret
= LTTNG_ERR_INVALID
;
5295 * As indicated in struct ltt_session's comments, a value of == 0 means
5296 * this schedule rotation type is not in use.
5298 * Reject the command if we were asked to activate a schedule that was
5301 if (activate
&& *parameter_value
!= 0) {
5302 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5303 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5308 * Reject the command if we were asked to deactivate a schedule that was
5311 if (!activate
&& *parameter_value
== 0) {
5312 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5313 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5318 * Reject the command if we were asked to deactivate a schedule that
5321 if (!activate
&& *parameter_value
!= new_value
) {
5322 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5323 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5327 *parameter_value
= activate
? new_value
: 0;
5329 switch (schedule_type
) {
5330 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5331 if (activate
&& session
->active
) {
5333 * Only start the timer if the session is active,
5334 * otherwise it will be started when the session starts.
5336 ret
= timer_session_rotation_schedule_timer_start(
5337 session
, new_value
);
5339 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5340 ret
= LTTNG_ERR_UNK
;
5344 ret
= timer_session_rotation_schedule_timer_stop(
5347 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5348 ret
= LTTNG_ERR_UNK
;
5353 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5355 ret
= subscribe_session_consumed_size_rotation(session
,
5356 new_value
, notification_thread_handle
);
5358 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5359 ret
= LTTNG_ERR_UNK
;
5363 ret
= unsubscribe_session_consumed_size_rotation(session
,
5364 notification_thread_handle
);
5366 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5367 ret
= LTTNG_ERR_UNK
;
5374 /* Would have been caught before. */
5386 /* Wait for a given path to be removed before continuing. */
5387 static enum lttng_error_code
wait_on_path(void *path_data
)
5389 const char *shm_path
= path_data
;
5391 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5397 ret
= stat(shm_path
, &st
);
5399 if (errno
!= ENOENT
) {
5400 PERROR("stat() returned an error while checking for the existence of the shm path");
5402 DBG("shm path no longer exists, completing the destruction of session");
5406 if (!S_ISDIR(st
.st_mode
)) {
5407 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5412 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5418 * Returns a pointer to a handler to run on completion of a command.
5419 * Returns NULL if no handler has to be run for the last command executed.
5421 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5423 struct cmd_completion_handler
*handler
= current_completion_handler
;
5425 current_completion_handler
= NULL
;
5430 * Init command subsystem.
5435 * Set network sequence index to 1 for streams to match a relayd
5436 * socket on the consumer side.
5438 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5439 relayd_net_seq_idx
= 1;
5440 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5442 DBG("Command subsystem initialized");