2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
27 #include <common/defaults.h>
28 #include <common/common.h>
29 #include <common/sessiond-comm/sessiond-comm.h>
30 #include <common/relayd/relayd.h>
31 #include <common/utils.h>
32 #include <common/compat/string.h>
33 #include <common/kernel-ctl/kernel-ctl.h>
34 #include <common/dynamic-buffer.h>
35 #include <common/buffer-view.h>
36 #include <common/trace-chunk.h>
37 #include <lttng/location-internal.h>
38 #include <lttng/trigger/trigger-internal.h>
39 #include <lttng/condition/condition.h>
40 #include <lttng/action/action.h>
41 #include <lttng/channel.h>
42 #include <lttng/channel-internal.h>
43 #include <lttng/rotate-internal.h>
44 #include <lttng/location-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/userspace-probe-internal.h>
47 #include <lttng/session-descriptor-internal.h>
48 #include <common/string-utils/string-utils.h>
53 #include "health-sessiond.h"
55 #include "kernel-consumer.h"
56 #include "lttng-sessiond.h"
58 #include "lttng-syscall.h"
60 #include "buffer-registry.h"
61 #include "notification-thread.h"
62 #include "notification-thread-commands.h"
64 #include "rotation-thread.h"
66 #include "agent-thread.h"
70 /* Sleep for 100ms between each check for the shm path's deletion. */
71 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
73 struct cmd_destroy_session_reply_context
{
75 bool implicit_rotation_on_destroy
;
77 * Indicates whether or not an error occurred while launching the
78 * destruction of a session.
80 enum lttng_error_code destruction_status
;
83 static enum lttng_error_code
wait_on_path(void *path
);
86 * Command completion handler that is used by the destroy command
87 * when a session that has a non-default shm_path is being destroyed.
89 * See comment in cmd_destroy_session() for the rationale.
91 static struct destroy_completion_handler
{
92 struct cmd_completion_handler handler
;
93 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
94 } destroy_completion_handler
= {
97 .data
= destroy_completion_handler
.shm_path
102 static struct cmd_completion_handler
*current_completion_handler
;
105 * Used to keep a unique index for each relayd socket created where this value
106 * is associated with streams on the consumer so it can match the right relayd
107 * to send to. It must be accessed with the relayd_net_seq_idx_lock
110 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
111 static uint64_t relayd_net_seq_idx
;
113 static int validate_ust_event_name(const char *);
114 static int cmd_enable_event_internal(struct ltt_session
*session
,
115 const struct lttng_domain
*domain
,
116 char *channel_name
, struct lttng_event
*event
,
117 char *filter_expression
,
118 struct lttng_filter_bytecode
*filter
,
119 struct lttng_event_exclusion
*exclusion
,
123 * Create a session path used by list_lttng_sessions for the case that the
124 * session consumer is on the network.
126 static int build_network_session_path(char *dst
, size_t size
,
127 struct ltt_session
*session
)
129 int ret
, kdata_port
, udata_port
;
130 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
131 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
136 memset(tmp_urls
, 0, sizeof(tmp_urls
));
137 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
139 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
141 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
142 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
143 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
146 if (session
->ust_session
&& session
->ust_session
->consumer
) {
147 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
148 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
151 if (uuri
== NULL
&& kuri
== NULL
) {
152 uri
= &session
->consumer
->dst
.net
.control
;
153 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
154 } else if (kuri
&& uuri
) {
155 ret
= uri_compare(kuri
, uuri
);
159 /* Build uuri URL string */
160 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
167 } else if (kuri
&& uuri
== NULL
) {
169 } else if (uuri
&& kuri
== NULL
) {
173 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
179 * Do we have a UST url set. If yes, this means we have both kernel and UST
182 if (*tmp_uurl
!= '\0') {
183 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
184 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
187 if (kuri
|| (!kuri
&& !uuri
)) {
190 /* No kernel URI, use the UST port. */
193 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
201 * Get run-time attributes if the session has been started (discarded events,
204 static int get_kernel_runtime_stats(struct ltt_session
*session
,
205 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
206 uint64_t *lost_packets
)
210 if (!session
->has_been_started
) {
212 *discarded_events
= 0;
217 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
218 session
->kernel_session
->consumer
,
224 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
225 session
->kernel_session
->consumer
,
236 * Get run-time attributes if the session has been started (discarded events,
239 static int get_ust_runtime_stats(struct ltt_session
*session
,
240 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
241 uint64_t *lost_packets
)
244 struct ltt_ust_session
*usess
;
246 if (!discarded_events
|| !lost_packets
) {
251 usess
= session
->ust_session
;
252 assert(discarded_events
);
253 assert(lost_packets
);
255 if (!usess
|| !session
->has_been_started
) {
256 *discarded_events
= 0;
262 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
263 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
264 &usess
->buffer_reg_uid_list
,
265 usess
->consumer
, uchan
->id
,
266 uchan
->attr
.overwrite
,
269 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
270 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
271 uchan
, usess
->consumer
,
272 uchan
->attr
.overwrite
,
278 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
279 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
281 ERR("Unsupported buffer type");
292 * Fill lttng_channel array of all channels.
294 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
295 struct ltt_session
*session
, struct lttng_channel
*channels
,
296 struct lttng_channel_extended
*chan_exts
)
299 struct ltt_kernel_channel
*kchan
;
301 DBG("Listing channels for session %s", session
->name
);
304 case LTTNG_DOMAIN_KERNEL
:
305 /* Kernel channels */
306 if (session
->kernel_session
!= NULL
) {
307 cds_list_for_each_entry(kchan
,
308 &session
->kernel_session
->channel_list
.head
, list
) {
309 uint64_t discarded_events
, lost_packets
;
310 struct lttng_channel_extended
*extended
;
312 extended
= (struct lttng_channel_extended
*)
313 kchan
->channel
->attr
.extended
.ptr
;
315 ret
= get_kernel_runtime_stats(session
, kchan
,
316 &discarded_events
, &lost_packets
);
320 /* Copy lttng_channel struct to array */
321 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
322 channels
[i
].enabled
= kchan
->enabled
;
323 chan_exts
[i
].discarded_events
=
325 chan_exts
[i
].lost_packets
= lost_packets
;
326 chan_exts
[i
].monitor_timer_interval
=
327 extended
->monitor_timer_interval
;
328 chan_exts
[i
].blocking_timeout
= 0;
333 case LTTNG_DOMAIN_UST
:
335 struct lttng_ht_iter iter
;
336 struct ltt_ust_channel
*uchan
;
339 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
340 &iter
.iter
, uchan
, node
.node
) {
341 uint64_t discarded_events
= 0, lost_packets
= 0;
343 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
344 LTTNG_SYMBOL_NAME_LEN
)) {
347 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
348 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
349 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
350 channels
[i
].attr
.switch_timer_interval
=
351 uchan
->attr
.switch_timer_interval
;
352 channels
[i
].attr
.read_timer_interval
=
353 uchan
->attr
.read_timer_interval
;
354 channels
[i
].enabled
= uchan
->enabled
;
355 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
356 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
359 * Map enum lttng_ust_output to enum lttng_event_output.
361 switch (uchan
->attr
.output
) {
363 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
367 * LTTNG_UST_MMAP is the only supported UST
374 chan_exts
[i
].monitor_timer_interval
=
375 uchan
->monitor_timer_interval
;
376 chan_exts
[i
].blocking_timeout
=
377 uchan
->attr
.u
.s
.blocking_timeout
;
379 ret
= get_ust_runtime_stats(session
, uchan
,
380 &discarded_events
, &lost_packets
);
384 chan_exts
[i
].discarded_events
= discarded_events
;
385 chan_exts
[i
].lost_packets
= lost_packets
;
397 return -LTTNG_ERR_FATAL
;
403 static int increment_extended_len(const char *filter_expression
,
404 struct lttng_event_exclusion
*exclusion
,
405 const struct lttng_userspace_probe_location
*probe_location
,
406 size_t *extended_len
)
410 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
412 if (filter_expression
) {
413 *extended_len
+= strlen(filter_expression
) + 1;
417 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
420 if (probe_location
) {
421 ret
= lttng_userspace_probe_location_serialize(probe_location
,
426 *extended_len
+= ret
;
433 static int append_extended_info(const char *filter_expression
,
434 struct lttng_event_exclusion
*exclusion
,
435 struct lttng_userspace_probe_location
*probe_location
,
439 size_t filter_len
= 0;
440 size_t nb_exclusions
= 0;
441 size_t userspace_probe_location_len
= 0;
442 struct lttng_dynamic_buffer location_buffer
;
443 struct lttcomm_event_extended_header extended_header
;
445 if (filter_expression
) {
446 filter_len
= strlen(filter_expression
) + 1;
450 nb_exclusions
= exclusion
->count
;
453 if (probe_location
) {
454 lttng_dynamic_buffer_init(&location_buffer
);
455 ret
= lttng_userspace_probe_location_serialize(probe_location
,
456 &location_buffer
, NULL
);
461 userspace_probe_location_len
= location_buffer
.size
;
464 /* Set header fields */
465 extended_header
.filter_len
= filter_len
;
466 extended_header
.nb_exclusions
= nb_exclusions
;
467 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
470 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
471 *extended_at
+= sizeof(extended_header
);
473 /* Copy filter string */
474 if (filter_expression
) {
475 memcpy(*extended_at
, filter_expression
, filter_len
);
476 *extended_at
+= filter_len
;
479 /* Copy exclusion names */
481 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
483 memcpy(*extended_at
, &exclusion
->names
, len
);
487 if (probe_location
) {
488 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
489 *extended_at
+= location_buffer
.size
;
490 lttng_dynamic_buffer_reset(&location_buffer
);
498 * Create a list of agent domain events.
500 * Return number of events in list on success or else a negative value.
502 static int list_lttng_agent_events(struct agent
*agt
,
503 struct lttng_event
**events
, size_t *total_size
)
506 unsigned int nb_event
= 0;
507 struct agent_event
*event
;
508 struct lttng_event
*tmp_events
= NULL
;
509 struct lttng_ht_iter iter
;
510 size_t extended_len
= 0;
516 DBG3("Listing agent events");
519 nb_event
= lttng_ht_get_count(agt
->events
);
527 /* Compute required extended infos size */
528 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
531 * This is only valid because the commands which add events are
532 * processed in the same thread as the listing.
535 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
536 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
539 DBG("Error computing the length of extended info message");
540 ret
= -LTTNG_ERR_FATAL
;
546 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
547 tmp_events
= zmalloc(*total_size
);
549 PERROR("zmalloc agent events session");
550 ret
= -LTTNG_ERR_FATAL
;
554 extended_at
= ((uint8_t *) tmp_events
) +
555 nb_event
* sizeof(struct lttng_event
);
558 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
559 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
560 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
561 tmp_events
[i
].enabled
= event
->enabled
;
562 tmp_events
[i
].loglevel
= event
->loglevel_value
;
563 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
566 /* Append extended info */
567 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
570 DBG("Error appending extended info message");
571 ret
= -LTTNG_ERR_FATAL
;
576 *events
= tmp_events
;
578 assert(nb_event
== i
);
589 * Create a list of ust global domain events.
591 static int list_lttng_ust_global_events(char *channel_name
,
592 struct ltt_ust_domain_global
*ust_global
,
593 struct lttng_event
**events
, size_t *total_size
)
596 unsigned int nb_event
= 0;
597 struct lttng_ht_iter iter
;
598 struct lttng_ht_node_str
*node
;
599 struct ltt_ust_channel
*uchan
;
600 struct ltt_ust_event
*uevent
;
601 struct lttng_event
*tmp
;
602 size_t extended_len
= 0;
605 DBG("Listing UST global events for channel %s", channel_name
);
609 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
610 node
= lttng_ht_iter_get_node_str(&iter
);
612 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
616 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
618 nb_event
= lttng_ht_get_count(uchan
->events
);
625 DBG3("Listing UST global %d events", nb_event
);
627 /* Compute required extended infos size */
628 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
629 if (uevent
->internal
) {
634 ret
= increment_extended_len(uevent
->filter_expression
,
635 uevent
->exclusion
, NULL
, &extended_len
);
637 DBG("Error computing the length of extended info message");
638 ret
= -LTTNG_ERR_FATAL
;
643 /* All events are internal, skip. */
649 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
650 tmp
= zmalloc(*total_size
);
652 ret
= -LTTNG_ERR_FATAL
;
656 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
658 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
659 if (uevent
->internal
) {
660 /* This event should remain hidden from clients */
663 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
664 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
665 tmp
[i
].enabled
= uevent
->enabled
;
667 switch (uevent
->attr
.instrumentation
) {
668 case LTTNG_UST_TRACEPOINT
:
669 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
671 case LTTNG_UST_PROBE
:
672 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
674 case LTTNG_UST_FUNCTION
:
675 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
679 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
680 switch (uevent
->attr
.loglevel_type
) {
681 case LTTNG_UST_LOGLEVEL_ALL
:
682 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
684 case LTTNG_UST_LOGLEVEL_RANGE
:
685 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
687 case LTTNG_UST_LOGLEVEL_SINGLE
:
688 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
691 if (uevent
->filter
) {
694 if (uevent
->exclusion
) {
695 tmp
[i
].exclusion
= 1;
699 /* Append extended info */
700 ret
= append_extended_info(uevent
->filter_expression
,
701 uevent
->exclusion
, NULL
, &extended_at
);
703 DBG("Error appending extended info message");
704 ret
= -LTTNG_ERR_FATAL
;
717 * Fill lttng_event array of all kernel events in the channel.
719 static int list_lttng_kernel_events(char *channel_name
,
720 struct ltt_kernel_session
*kernel_session
,
721 struct lttng_event
**events
, size_t *total_size
)
724 unsigned int nb_event
;
725 struct ltt_kernel_event
*event
;
726 struct ltt_kernel_channel
*kchan
;
727 size_t extended_len
= 0;
730 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
732 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
736 nb_event
= kchan
->event_count
;
738 DBG("Listing events for channel %s", kchan
->channel
->name
);
746 /* Compute required extended infos size */
747 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
748 ret
= increment_extended_len(event
->filter_expression
, NULL
,
749 event
->userspace_probe_location
,
752 DBG("Error computing the length of extended info message");
753 ret
= -LTTNG_ERR_FATAL
;
758 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
759 *events
= zmalloc(*total_size
);
760 if (*events
== NULL
) {
761 ret
= -LTTNG_ERR_FATAL
;
765 extended_at
= ((void *) *events
) +
766 nb_event
* sizeof(struct lttng_event
);
768 /* Kernel channels */
769 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
770 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
771 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
772 (*events
)[i
].enabled
= event
->enabled
;
773 (*events
)[i
].filter
=
774 (unsigned char) !!event
->filter_expression
;
776 switch (event
->event
->instrumentation
) {
777 case LTTNG_KERNEL_TRACEPOINT
:
778 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
780 case LTTNG_KERNEL_KRETPROBE
:
781 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
782 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
783 sizeof(struct lttng_kernel_kprobe
));
785 case LTTNG_KERNEL_KPROBE
:
786 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
787 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
788 sizeof(struct lttng_kernel_kprobe
));
790 case LTTNG_KERNEL_UPROBE
:
791 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
793 case LTTNG_KERNEL_FUNCTION
:
794 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
795 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
796 sizeof(struct lttng_kernel_function
));
798 case LTTNG_KERNEL_NOOP
:
799 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
801 case LTTNG_KERNEL_SYSCALL
:
802 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
804 case LTTNG_KERNEL_ALL
:
812 /* Append extended info */
813 ret
= append_extended_info(event
->filter_expression
, NULL
,
814 event
->userspace_probe_location
, &extended_at
);
816 DBG("Error appending extended info message");
817 ret
= -LTTNG_ERR_FATAL
;
826 /* Negate the error code to differentiate the size from an error */
831 * Add URI so the consumer output object. Set the correct path depending on the
832 * domain adding the default trace directory.
834 static enum lttng_error_code
add_uri_to_consumer(
835 const struct ltt_session
*session
,
836 struct consumer_output
*consumer
,
837 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
840 enum lttng_error_code ret_code
= LTTNG_OK
;
844 if (consumer
== NULL
) {
845 DBG("No consumer detected. Don't add URI. Stopping.");
846 ret_code
= LTTNG_ERR_NO_CONSUMER
;
851 case LTTNG_DOMAIN_KERNEL
:
852 ret
= lttng_strncpy(consumer
->domain_subdir
,
853 DEFAULT_KERNEL_TRACE_DIR
,
854 sizeof(consumer
->domain_subdir
));
856 case LTTNG_DOMAIN_UST
:
857 ret
= lttng_strncpy(consumer
->domain_subdir
,
858 DEFAULT_UST_TRACE_DIR
,
859 sizeof(consumer
->domain_subdir
));
863 * This case is possible is we try to add the URI to the global
864 * tracing session consumer object which in this case there is
867 memset(consumer
->domain_subdir
, 0,
868 sizeof(consumer
->domain_subdir
));
872 ERR("Failed to initialize consumer output domain subdirectory");
873 ret_code
= LTTNG_ERR_FATAL
;
877 switch (uri
->dtype
) {
880 DBG2("Setting network URI to consumer");
882 if (consumer
->type
== CONSUMER_DST_NET
) {
883 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
884 consumer
->dst
.net
.control_isset
) ||
885 (uri
->stype
== LTTNG_STREAM_DATA
&&
886 consumer
->dst
.net
.data_isset
)) {
887 ret_code
= LTTNG_ERR_URL_EXIST
;
891 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
894 /* Set URI into consumer output object */
895 ret
= consumer_set_network_uri(session
, consumer
, uri
);
899 } else if (ret
== 1) {
901 * URI was the same in the consumer so we do not append the subdir
902 * again so to not duplicate output dir.
909 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
910 ret_code
= LTTNG_ERR_INVALID
;
913 DBG2("Setting trace directory path from URI to %s",
915 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
917 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
919 sizeof(consumer
->dst
.session_root_path
));
921 ret_code
= LTTNG_ERR_FATAL
;
924 consumer
->type
= CONSUMER_DST_LOCAL
;
934 * Init tracing by creating trace directory and sending fds kernel consumer.
936 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
939 struct lttng_ht_iter iter
;
940 struct consumer_socket
*socket
;
946 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
947 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
949 pthread_mutex_lock(socket
->lock
);
950 ret
= kernel_consumer_send_session(socket
, session
);
951 pthread_mutex_unlock(socket
->lock
);
953 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
965 * Create a socket to the relayd using the URI.
967 * On success, the relayd_sock pointer is set to the created socket.
968 * Else, it remains untouched and an LTTng error code is returned.
970 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
971 struct lttcomm_relayd_sock
**relayd_sock
,
972 struct consumer_output
*consumer
)
975 enum lttng_error_code status
= LTTNG_OK
;
976 struct lttcomm_relayd_sock
*rsock
;
978 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
979 RELAYD_VERSION_COMM_MINOR
);
981 status
= LTTNG_ERR_FATAL
;
986 * Connect to relayd so we can proceed with a session creation. This call
987 * can possibly block for an arbitrary amount of time to set the health
988 * state to be in poll execution.
991 ret
= relayd_connect(rsock
);
994 ERR("Unable to reach lttng-relayd");
995 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
999 /* Create socket for control stream. */
1000 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
1001 DBG3("Creating relayd stream socket from URI");
1003 /* Check relayd version */
1004 ret
= relayd_version_check(rsock
);
1005 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1006 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1008 } else if (ret
< 0) {
1009 ERR("Unable to reach lttng-relayd");
1010 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1013 consumer
->relay_major_version
= rsock
->major
;
1014 consumer
->relay_minor_version
= rsock
->minor
;
1015 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1016 DBG3("Creating relayd data socket from URI");
1018 /* Command is not valid */
1019 ERR("Relayd invalid stream type: %d", uri
->stype
);
1020 status
= LTTNG_ERR_INVALID
;
1024 *relayd_sock
= rsock
;
1029 /* The returned value is not useful since we are on an error path. */
1030 (void) relayd_close(rsock
);
1038 * Connect to the relayd using URI and send the socket to the right consumer.
1040 * The consumer socket lock must be held by the caller.
1042 * Returns LTTNG_OK on success or an LTTng error code on failure.
1044 static enum lttng_error_code
send_consumer_relayd_socket(
1045 unsigned int session_id
,
1046 struct lttng_uri
*relayd_uri
,
1047 struct consumer_output
*consumer
,
1048 struct consumer_socket
*consumer_sock
,
1049 const char *session_name
, const char *hostname
,
1050 const char *base_path
, int session_live_timer
,
1051 const uint64_t *current_chunk_id
,
1052 time_t session_creation_time
,
1053 bool session_name_contains_creation_time
)
1056 struct lttcomm_relayd_sock
*rsock
= NULL
;
1057 enum lttng_error_code status
;
1059 /* Connect to relayd and make version check if uri is the control. */
1060 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1061 if (status
!= LTTNG_OK
) {
1062 goto relayd_comm_error
;
1066 /* Set the network sequence index if not set. */
1067 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1068 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1070 * Increment net_seq_idx because we are about to transfer the
1071 * new relayd socket to the consumer.
1072 * Assign unique key so the consumer can match streams.
1074 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1075 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1078 /* Send relayd socket to consumer. */
1079 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1080 relayd_uri
->stype
, session_id
,
1081 session_name
, hostname
, base_path
,
1082 session_live_timer
, current_chunk_id
,
1083 session_creation_time
, session_name_contains_creation_time
);
1085 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1089 /* Flag that the corresponding socket was sent. */
1090 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1091 consumer_sock
->control_sock_sent
= 1;
1092 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1093 consumer_sock
->data_sock_sent
= 1;
1097 * Close socket which was dup on the consumer side. The session daemon does
1098 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1102 if (status
!= LTTNG_OK
) {
1104 * The consumer output for this session should not be used anymore
1105 * since the relayd connection failed thus making any tracing or/and
1106 * streaming not usable.
1108 consumer
->enabled
= 0;
1110 (void) relayd_close(rsock
);
1118 * Send both relayd sockets to a specific consumer and domain. This is a
1119 * helper function to facilitate sending the information to the consumer for a
1122 * The consumer socket lock must be held by the caller.
1124 * Returns LTTNG_OK, or an LTTng error code on failure.
1126 static enum lttng_error_code
send_consumer_relayd_sockets(
1127 enum lttng_domain_type domain
,
1128 unsigned int session_id
, struct consumer_output
*consumer
,
1129 struct consumer_socket
*sock
, const char *session_name
,
1130 const char *hostname
, const char *base_path
, int session_live_timer
,
1131 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1132 bool session_name_contains_creation_time
)
1134 enum lttng_error_code status
= LTTNG_OK
;
1139 /* Sending control relayd socket. */
1140 if (!sock
->control_sock_sent
) {
1141 status
= send_consumer_relayd_socket(session_id
,
1142 &consumer
->dst
.net
.control
, consumer
, sock
,
1143 session_name
, hostname
, base_path
, session_live_timer
,
1144 current_chunk_id
, session_creation_time
,
1145 session_name_contains_creation_time
);
1146 if (status
!= LTTNG_OK
) {
1151 /* Sending data relayd socket. */
1152 if (!sock
->data_sock_sent
) {
1153 status
= send_consumer_relayd_socket(session_id
,
1154 &consumer
->dst
.net
.data
, consumer
, sock
,
1155 session_name
, hostname
, base_path
, session_live_timer
,
1156 current_chunk_id
, session_creation_time
,
1157 session_name_contains_creation_time
);
1158 if (status
!= LTTNG_OK
) {
1168 * Setup relayd connections for a tracing session. First creates the socket to
1169 * the relayd and send them to the right domain consumer. Consumer type MUST be
1172 int cmd_setup_relayd(struct ltt_session
*session
)
1175 struct ltt_ust_session
*usess
;
1176 struct ltt_kernel_session
*ksess
;
1177 struct consumer_socket
*socket
;
1178 struct lttng_ht_iter iter
;
1179 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1183 usess
= session
->ust_session
;
1184 ksess
= session
->kernel_session
;
1186 DBG("Setting relayd for session %s", session
->name
);
1188 if (session
->current_trace_chunk
) {
1189 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1190 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1192 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1193 current_chunk_id
.is_set
= true;
1195 ERR("Failed to get current trace chunk id");
1196 ret
= LTTNG_ERR_UNK
;
1203 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1204 && usess
->consumer
->enabled
) {
1205 /* For each consumer socket, send relayd sockets */
1206 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1207 socket
, node
.node
) {
1208 pthread_mutex_lock(socket
->lock
);
1209 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1210 usess
->consumer
, socket
,
1211 session
->name
, session
->hostname
,
1213 session
->live_timer
,
1214 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1215 session
->creation_time
,
1216 session
->name_contains_creation_time
);
1217 pthread_mutex_unlock(socket
->lock
);
1218 if (ret
!= LTTNG_OK
) {
1221 /* Session is now ready for network streaming. */
1222 session
->net_handle
= 1;
1224 session
->consumer
->relay_major_version
=
1225 usess
->consumer
->relay_major_version
;
1226 session
->consumer
->relay_minor_version
=
1227 usess
->consumer
->relay_minor_version
;
1230 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1231 && ksess
->consumer
->enabled
) {
1232 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1233 socket
, node
.node
) {
1234 pthread_mutex_lock(socket
->lock
);
1235 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1236 ksess
->consumer
, socket
,
1237 session
->name
, session
->hostname
,
1239 session
->live_timer
,
1240 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1241 session
->creation_time
,
1242 session
->name_contains_creation_time
);
1243 pthread_mutex_unlock(socket
->lock
);
1244 if (ret
!= LTTNG_OK
) {
1247 /* Session is now ready for network streaming. */
1248 session
->net_handle
= 1;
1250 session
->consumer
->relay_major_version
=
1251 ksess
->consumer
->relay_major_version
;
1252 session
->consumer
->relay_minor_version
=
1253 ksess
->consumer
->relay_minor_version
;
1262 * Start a kernel session by opening all necessary streams.
1264 static int start_kernel_session(struct ltt_kernel_session
*ksess
)
1267 struct ltt_kernel_channel
*kchan
;
1269 /* Open kernel metadata */
1270 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1271 ret
= kernel_open_metadata(ksess
);
1273 ret
= LTTNG_ERR_KERN_META_FAIL
;
1278 /* Open kernel metadata stream */
1279 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1280 ret
= kernel_open_metadata_stream(ksess
);
1282 ERR("Kernel create metadata stream failed");
1283 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1288 /* For each channel */
1289 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1290 if (kchan
->stream_count
== 0) {
1291 ret
= kernel_open_channel_stream(kchan
);
1293 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1296 /* Update the stream global counter */
1297 ksess
->stream_count_global
+= ret
;
1301 /* Setup kernel consumer socket and send fds to it */
1302 ret
= init_kernel_tracing(ksess
);
1304 ret
= LTTNG_ERR_KERN_START_FAIL
;
1308 /* This start the kernel tracing */
1309 ret
= kernel_start_session(ksess
);
1311 ret
= LTTNG_ERR_KERN_START_FAIL
;
1315 /* Quiescent wait after starting trace */
1316 kernel_wait_quiescent();
1327 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1329 int cmd_disable_channel(struct ltt_session
*session
,
1330 enum lttng_domain_type domain
, char *channel_name
)
1333 struct ltt_ust_session
*usess
;
1335 usess
= session
->ust_session
;
1340 case LTTNG_DOMAIN_KERNEL
:
1342 ret
= channel_kernel_disable(session
->kernel_session
,
1344 if (ret
!= LTTNG_OK
) {
1348 kernel_wait_quiescent();
1351 case LTTNG_DOMAIN_UST
:
1353 struct ltt_ust_channel
*uchan
;
1354 struct lttng_ht
*chan_ht
;
1356 chan_ht
= usess
->domain_global
.channels
;
1358 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1359 if (uchan
== NULL
) {
1360 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1364 ret
= channel_ust_disable(usess
, uchan
);
1365 if (ret
!= LTTNG_OK
) {
1371 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1383 * Command LTTNG_TRACK_PID processed by the client thread.
1385 * Called with session lock held.
1387 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1395 case LTTNG_DOMAIN_KERNEL
:
1397 struct ltt_kernel_session
*ksess
;
1399 ksess
= session
->kernel_session
;
1401 ret
= kernel_track_pid(ksess
, pid
);
1402 if (ret
!= LTTNG_OK
) {
1406 kernel_wait_quiescent();
1409 case LTTNG_DOMAIN_UST
:
1411 struct ltt_ust_session
*usess
;
1413 usess
= session
->ust_session
;
1415 ret
= trace_ust_track_pid(usess
, pid
);
1416 if (ret
!= LTTNG_OK
) {
1422 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1434 * Command LTTNG_UNTRACK_PID processed by the client thread.
1436 * Called with session lock held.
1438 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1446 case LTTNG_DOMAIN_KERNEL
:
1448 struct ltt_kernel_session
*ksess
;
1450 ksess
= session
->kernel_session
;
1452 ret
= kernel_untrack_pid(ksess
, pid
);
1453 if (ret
!= LTTNG_OK
) {
1457 kernel_wait_quiescent();
1460 case LTTNG_DOMAIN_UST
:
1462 struct ltt_ust_session
*usess
;
1464 usess
= session
->ust_session
;
1466 ret
= trace_ust_untrack_pid(usess
, pid
);
1467 if (ret
!= LTTNG_OK
) {
1473 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1485 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1487 * The wpipe arguments is used as a notifier for the kernel thread.
1489 int cmd_enable_channel(struct ltt_session
*session
,
1490 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1493 struct ltt_ust_session
*usess
= session
->ust_session
;
1494 struct lttng_ht
*chan_ht
;
1496 struct lttng_channel attr
;
1503 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1505 /* Validate channel name */
1506 if (attr
.name
[0] == '.' ||
1507 memchr(attr
.name
, '/', len
) != NULL
) {
1508 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1512 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1517 * Don't try to enable a channel if the session has been started at
1518 * some point in time before. The tracer does not allow it.
1520 if (session
->has_been_started
) {
1521 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1526 * If the session is a live session, remove the switch timer, the
1527 * live timer does the same thing but sends also synchronisation
1528 * beacons for inactive streams.
1530 if (session
->live_timer
> 0) {
1531 attr
.attr
.live_timer_interval
= session
->live_timer
;
1532 attr
.attr
.switch_timer_interval
= 0;
1535 /* Check for feature support */
1536 switch (domain
->type
) {
1537 case LTTNG_DOMAIN_KERNEL
:
1539 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1540 /* Sampling position of buffer is not supported */
1541 WARN("Kernel tracer does not support buffer monitoring. "
1542 "Setting the monitor interval timer to 0 "
1543 "(disabled) for channel '%s' of session '%s'",
1544 attr
.name
, session
->name
);
1545 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1549 case LTTNG_DOMAIN_UST
:
1551 case LTTNG_DOMAIN_JUL
:
1552 case LTTNG_DOMAIN_LOG4J
:
1553 case LTTNG_DOMAIN_PYTHON
:
1554 if (!agent_tracing_is_enabled()) {
1555 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1556 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1561 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1565 switch (domain
->type
) {
1566 case LTTNG_DOMAIN_KERNEL
:
1568 struct ltt_kernel_channel
*kchan
;
1570 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1571 session
->kernel_session
);
1572 if (kchan
== NULL
) {
1573 if (session
->snapshot
.nb_output
> 0 ||
1574 session
->snapshot_mode
) {
1575 /* Enforce mmap output for snapshot sessions. */
1576 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1578 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1579 if (attr
.name
[0] != '\0') {
1580 session
->kernel_session
->has_non_default_channel
= 1;
1583 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1586 if (ret
!= LTTNG_OK
) {
1590 kernel_wait_quiescent();
1593 case LTTNG_DOMAIN_UST
:
1594 case LTTNG_DOMAIN_JUL
:
1595 case LTTNG_DOMAIN_LOG4J
:
1596 case LTTNG_DOMAIN_PYTHON
:
1598 struct ltt_ust_channel
*uchan
;
1603 * Current agent implementation limitations force us to allow
1604 * only one channel at once in "agent" subdomains. Each
1605 * subdomain has a default channel name which must be strictly
1608 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1609 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1610 LTTNG_SYMBOL_NAME_LEN
)) {
1611 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1614 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1615 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1616 LTTNG_SYMBOL_NAME_LEN
)) {
1617 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1620 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1621 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1622 LTTNG_SYMBOL_NAME_LEN
)) {
1623 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1628 chan_ht
= usess
->domain_global
.channels
;
1630 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1631 if (uchan
== NULL
) {
1632 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1633 if (attr
.name
[0] != '\0') {
1634 usess
->has_non_default_channel
= 1;
1637 ret
= channel_ust_enable(usess
, uchan
);
1642 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1646 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1647 session
->has_non_mmap_channel
= true;
1656 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1658 int cmd_disable_event(struct ltt_session
*session
,
1659 enum lttng_domain_type domain
, const char *channel_name
,
1660 const struct lttng_event
*event
)
1663 const char *event_name
;
1665 DBG("Disable event command for event \'%s\'", event
->name
);
1667 event_name
= event
->name
;
1669 /* Error out on unhandled search criteria */
1670 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1671 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1672 ret
= LTTNG_ERR_UNK
;
1679 case LTTNG_DOMAIN_KERNEL
:
1681 struct ltt_kernel_channel
*kchan
;
1682 struct ltt_kernel_session
*ksess
;
1684 ksess
= session
->kernel_session
;
1687 * If a non-default channel has been created in the
1688 * session, explicitely require that -c chan_name needs
1691 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1692 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1696 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1697 if (kchan
== NULL
) {
1698 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1702 switch (event
->type
) {
1703 case LTTNG_EVENT_ALL
:
1704 case LTTNG_EVENT_TRACEPOINT
:
1705 case LTTNG_EVENT_SYSCALL
:
1706 case LTTNG_EVENT_PROBE
:
1707 case LTTNG_EVENT_FUNCTION
:
1708 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1709 if (event_name
[0] == '\0') {
1710 ret
= event_kernel_disable_event(kchan
,
1713 ret
= event_kernel_disable_event(kchan
,
1714 event_name
, event
->type
);
1716 if (ret
!= LTTNG_OK
) {
1721 ret
= LTTNG_ERR_UNK
;
1725 kernel_wait_quiescent();
1728 case LTTNG_DOMAIN_UST
:
1730 struct ltt_ust_channel
*uchan
;
1731 struct ltt_ust_session
*usess
;
1733 usess
= session
->ust_session
;
1735 if (validate_ust_event_name(event_name
)) {
1736 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1741 * If a non-default channel has been created in the
1742 * session, explicitly require that -c chan_name needs
1745 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1746 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1750 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1752 if (uchan
== NULL
) {
1753 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1757 switch (event
->type
) {
1758 case LTTNG_EVENT_ALL
:
1760 * An empty event name means that everything
1761 * should be disabled.
1763 if (event
->name
[0] == '\0') {
1764 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1766 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1769 if (ret
!= LTTNG_OK
) {
1774 ret
= LTTNG_ERR_UNK
;
1778 DBG3("Disable UST event %s in channel %s completed", event_name
,
1782 case LTTNG_DOMAIN_LOG4J
:
1783 case LTTNG_DOMAIN_JUL
:
1784 case LTTNG_DOMAIN_PYTHON
:
1787 struct ltt_ust_session
*usess
= session
->ust_session
;
1791 switch (event
->type
) {
1792 case LTTNG_EVENT_ALL
:
1795 ret
= LTTNG_ERR_UNK
;
1799 agt
= trace_ust_find_agent(usess
, domain
);
1801 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1805 * An empty event name means that everything
1806 * should be disabled.
1808 if (event
->name
[0] == '\0') {
1809 ret
= event_agent_disable_all(usess
, agt
);
1811 ret
= event_agent_disable(usess
, agt
, event_name
);
1813 if (ret
!= LTTNG_OK
) {
1820 ret
= LTTNG_ERR_UND
;
1833 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1835 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1836 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1838 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1839 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1842 * Don't try to add a context if the session has been started at
1843 * some point in time before. The tracer does not allow it and would
1844 * result in a corrupted trace.
1846 if (session
->has_been_started
) {
1847 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1851 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1852 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1853 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1857 case LTTNG_DOMAIN_KERNEL
:
1858 assert(session
->kernel_session
);
1860 if (session
->kernel_session
->channel_count
== 0) {
1861 /* Create default channel */
1862 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1863 if (ret
!= LTTNG_OK
) {
1866 chan_kern_created
= 1;
1868 /* Add kernel context to kernel tracer */
1869 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1870 if (ret
!= LTTNG_OK
) {
1874 case LTTNG_DOMAIN_JUL
:
1875 case LTTNG_DOMAIN_LOG4J
:
1878 * Validate channel name.
1879 * If no channel name is given and the domain is JUL or LOG4J,
1880 * set it to the appropriate domain-specific channel name. If
1881 * a name is provided but does not match the expexted channel
1882 * name, return an error.
1884 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1885 strcmp(channel_name
,
1886 DEFAULT_JUL_CHANNEL_NAME
)) {
1887 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1889 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1890 strcmp(channel_name
,
1891 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1892 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1895 /* break is _not_ missing here. */
1897 case LTTNG_DOMAIN_UST
:
1899 struct ltt_ust_session
*usess
= session
->ust_session
;
1900 unsigned int chan_count
;
1904 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1905 if (chan_count
== 0) {
1906 struct lttng_channel
*attr
;
1907 /* Create default channel */
1908 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1910 ret
= LTTNG_ERR_FATAL
;
1914 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1915 if (ret
!= LTTNG_OK
) {
1919 channel_attr_destroy(attr
);
1920 chan_ust_created
= 1;
1923 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1924 free(app_ctx_provider_name
);
1926 app_ctx_name
= NULL
;
1927 app_ctx_provider_name
= NULL
;
1928 if (ret
!= LTTNG_OK
) {
1934 ret
= LTTNG_ERR_UND
;
1942 if (chan_kern_created
) {
1943 struct ltt_kernel_channel
*kchan
=
1944 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1945 session
->kernel_session
);
1946 /* Created previously, this should NOT fail. */
1948 kernel_destroy_channel(kchan
);
1951 if (chan_ust_created
) {
1952 struct ltt_ust_channel
*uchan
=
1953 trace_ust_find_channel_by_name(
1954 session
->ust_session
->domain_global
.channels
,
1955 DEFAULT_CHANNEL_NAME
);
1956 /* Created previously, this should NOT fail. */
1958 /* Remove from the channel list of the session. */
1959 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1961 trace_ust_destroy_channel(uchan
);
1964 free(app_ctx_provider_name
);
1969 static inline bool name_starts_with(const char *name
, const char *prefix
)
1971 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1973 return !strncmp(name
, prefix
, max_cmp_len
);
1976 /* Perform userspace-specific event name validation */
1977 static int validate_ust_event_name(const char *name
)
1987 * Check name against all internal UST event component namespaces used
1990 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1991 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1992 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2001 * Internal version of cmd_enable_event() with a supplemental
2002 * "internal_event" flag which is used to enable internal events which should
2003 * be hidden from clients. Such events are used in the agent implementation to
2004 * enable the events through which all "agent" events are funeled.
2006 static int _cmd_enable_event(struct ltt_session
*session
,
2007 const struct lttng_domain
*domain
,
2008 char *channel_name
, struct lttng_event
*event
,
2009 char *filter_expression
,
2010 struct lttng_filter_bytecode
*filter
,
2011 struct lttng_event_exclusion
*exclusion
,
2012 int wpipe
, bool internal_event
)
2014 int ret
= 0, channel_created
= 0;
2015 struct lttng_channel
*attr
= NULL
;
2019 assert(channel_name
);
2021 /* If we have a filter, we must have its filter expression */
2022 assert(!(!!filter_expression
^ !!filter
));
2024 /* Normalize event name as a globbing pattern */
2025 strutils_normalize_star_glob_pattern(event
->name
);
2027 /* Normalize exclusion names as globbing patterns */
2031 for (i
= 0; i
< exclusion
->count
; i
++) {
2032 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2034 strutils_normalize_star_glob_pattern(name
);
2038 DBG("Enable event command for event \'%s\'", event
->name
);
2042 switch (domain
->type
) {
2043 case LTTNG_DOMAIN_KERNEL
:
2045 struct ltt_kernel_channel
*kchan
;
2048 * If a non-default channel has been created in the
2049 * session, explicitely require that -c chan_name needs
2052 if (session
->kernel_session
->has_non_default_channel
2053 && channel_name
[0] == '\0') {
2054 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2058 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2059 session
->kernel_session
);
2060 if (kchan
== NULL
) {
2061 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2062 LTTNG_BUFFER_GLOBAL
);
2064 ret
= LTTNG_ERR_FATAL
;
2067 if (lttng_strncpy(attr
->name
, channel_name
,
2068 sizeof(attr
->name
))) {
2069 ret
= LTTNG_ERR_INVALID
;
2073 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2074 if (ret
!= LTTNG_OK
) {
2077 channel_created
= 1;
2080 /* Get the newly created kernel channel pointer */
2081 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2082 session
->kernel_session
);
2083 if (kchan
== NULL
) {
2084 /* This sould not happen... */
2085 ret
= LTTNG_ERR_FATAL
;
2089 switch (event
->type
) {
2090 case LTTNG_EVENT_ALL
:
2092 char *filter_expression_a
= NULL
;
2093 struct lttng_filter_bytecode
*filter_a
= NULL
;
2096 * We need to duplicate filter_expression and filter,
2097 * because ownership is passed to first enable
2100 if (filter_expression
) {
2101 filter_expression_a
= strdup(filter_expression
);
2102 if (!filter_expression_a
) {
2103 ret
= LTTNG_ERR_FATAL
;
2108 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2110 free(filter_expression_a
);
2111 ret
= LTTNG_ERR_FATAL
;
2114 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2116 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2117 ret
= event_kernel_enable_event(kchan
, event
,
2118 filter_expression
, filter
);
2119 /* We have passed ownership */
2120 filter_expression
= NULL
;
2122 if (ret
!= LTTNG_OK
) {
2123 if (channel_created
) {
2124 /* Let's not leak a useless channel. */
2125 kernel_destroy_channel(kchan
);
2127 free(filter_expression_a
);
2131 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2132 ret
= event_kernel_enable_event(kchan
, event
,
2133 filter_expression_a
, filter_a
);
2134 /* We have passed ownership */
2135 filter_expression_a
= NULL
;
2137 if (ret
!= LTTNG_OK
) {
2142 case LTTNG_EVENT_PROBE
:
2143 case LTTNG_EVENT_USERSPACE_PROBE
:
2144 case LTTNG_EVENT_FUNCTION
:
2145 case LTTNG_EVENT_FUNCTION_ENTRY
:
2146 case LTTNG_EVENT_TRACEPOINT
:
2147 ret
= event_kernel_enable_event(kchan
, event
,
2148 filter_expression
, filter
);
2149 /* We have passed ownership */
2150 filter_expression
= NULL
;
2152 if (ret
!= LTTNG_OK
) {
2153 if (channel_created
) {
2154 /* Let's not leak a useless channel. */
2155 kernel_destroy_channel(kchan
);
2160 case LTTNG_EVENT_SYSCALL
:
2161 ret
= event_kernel_enable_event(kchan
, event
,
2162 filter_expression
, filter
);
2163 /* We have passed ownership */
2164 filter_expression
= NULL
;
2166 if (ret
!= LTTNG_OK
) {
2171 ret
= LTTNG_ERR_UNK
;
2175 kernel_wait_quiescent();
2178 case LTTNG_DOMAIN_UST
:
2180 struct ltt_ust_channel
*uchan
;
2181 struct ltt_ust_session
*usess
= session
->ust_session
;
2186 * If a non-default channel has been created in the
2187 * session, explicitely require that -c chan_name needs
2190 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2191 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2195 /* Get channel from global UST domain */
2196 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2198 if (uchan
== NULL
) {
2199 /* Create default channel */
2200 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2201 usess
->buffer_type
);
2203 ret
= LTTNG_ERR_FATAL
;
2206 if (lttng_strncpy(attr
->name
, channel_name
,
2207 sizeof(attr
->name
))) {
2208 ret
= LTTNG_ERR_INVALID
;
2212 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2213 if (ret
!= LTTNG_OK
) {
2217 /* Get the newly created channel reference back */
2218 uchan
= trace_ust_find_channel_by_name(
2219 usess
->domain_global
.channels
, channel_name
);
2223 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2225 * Don't allow users to add UST events to channels which
2226 * are assigned to a userspace subdomain (JUL, Log4J,
2229 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2233 if (!internal_event
) {
2235 * Ensure the event name is not reserved for internal
2238 ret
= validate_ust_event_name(event
->name
);
2240 WARN("Userspace event name %s failed validation.",
2242 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2247 /* At this point, the session and channel exist on the tracer */
2248 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2249 filter_expression
, filter
, exclusion
,
2251 /* We have passed ownership */
2252 filter_expression
= NULL
;
2255 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2256 goto already_enabled
;
2257 } else if (ret
!= LTTNG_OK
) {
2262 case LTTNG_DOMAIN_LOG4J
:
2263 case LTTNG_DOMAIN_JUL
:
2264 case LTTNG_DOMAIN_PYTHON
:
2266 const char *default_event_name
, *default_chan_name
;
2268 struct lttng_event uevent
;
2269 struct lttng_domain tmp_dom
;
2270 struct ltt_ust_session
*usess
= session
->ust_session
;
2274 if (!agent_tracing_is_enabled()) {
2275 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2276 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2280 agt
= trace_ust_find_agent(usess
, domain
->type
);
2282 agt
= agent_create(domain
->type
);
2284 ret
= LTTNG_ERR_NOMEM
;
2287 agent_add(agt
, usess
->agents
);
2290 /* Create the default tracepoint. */
2291 memset(&uevent
, 0, sizeof(uevent
));
2292 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2293 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2294 default_event_name
= event_get_default_agent_ust_name(
2296 if (!default_event_name
) {
2297 ret
= LTTNG_ERR_FATAL
;
2300 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2301 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2304 * The domain type is changed because we are about to enable the
2305 * default channel and event for the JUL domain that are hardcoded.
2306 * This happens in the UST domain.
2308 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2309 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2311 switch (domain
->type
) {
2312 case LTTNG_DOMAIN_LOG4J
:
2313 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2315 case LTTNG_DOMAIN_JUL
:
2316 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2318 case LTTNG_DOMAIN_PYTHON
:
2319 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2322 /* The switch/case we are in makes this impossible */
2327 char *filter_expression_copy
= NULL
;
2328 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2331 const size_t filter_size
= sizeof(
2332 struct lttng_filter_bytecode
)
2335 filter_copy
= zmalloc(filter_size
);
2337 ret
= LTTNG_ERR_NOMEM
;
2340 memcpy(filter_copy
, filter
, filter_size
);
2342 filter_expression_copy
=
2343 strdup(filter_expression
);
2344 if (!filter_expression
) {
2345 ret
= LTTNG_ERR_NOMEM
;
2348 if (!filter_expression_copy
|| !filter_copy
) {
2349 free(filter_expression_copy
);
2355 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2356 (char *) default_chan_name
,
2357 &uevent
, filter_expression_copy
,
2358 filter_copy
, NULL
, wpipe
);
2361 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2362 goto already_enabled
;
2363 } else if (ret
!= LTTNG_OK
) {
2367 /* The wild card * means that everything should be enabled. */
2368 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2369 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2372 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2376 filter_expression
= NULL
;
2377 if (ret
!= LTTNG_OK
) {
2384 ret
= LTTNG_ERR_UND
;
2392 free(filter_expression
);
2395 channel_attr_destroy(attr
);
2401 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2402 * We own filter, exclusion, and filter_expression.
2404 int cmd_enable_event(struct ltt_session
*session
,
2405 const struct lttng_domain
*domain
,
2406 char *channel_name
, struct lttng_event
*event
,
2407 char *filter_expression
,
2408 struct lttng_filter_bytecode
*filter
,
2409 struct lttng_event_exclusion
*exclusion
,
2412 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2413 filter_expression
, filter
, exclusion
, wpipe
, false);
2417 * Enable an event which is internal to LTTng. An internal should
2418 * never be made visible to clients and are immune to checks such as
2421 static int cmd_enable_event_internal(struct ltt_session
*session
,
2422 const struct lttng_domain
*domain
,
2423 char *channel_name
, struct lttng_event
*event
,
2424 char *filter_expression
,
2425 struct lttng_filter_bytecode
*filter
,
2426 struct lttng_event_exclusion
*exclusion
,
2429 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2430 filter_expression
, filter
, exclusion
, wpipe
, true);
2434 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2436 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2437 struct lttng_event
**events
)
2440 ssize_t nb_events
= 0;
2443 case LTTNG_DOMAIN_KERNEL
:
2444 nb_events
= kernel_list_events(events
);
2445 if (nb_events
< 0) {
2446 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2450 case LTTNG_DOMAIN_UST
:
2451 nb_events
= ust_app_list_events(events
);
2452 if (nb_events
< 0) {
2453 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2457 case LTTNG_DOMAIN_LOG4J
:
2458 case LTTNG_DOMAIN_JUL
:
2459 case LTTNG_DOMAIN_PYTHON
:
2460 nb_events
= agent_list_events(events
, domain
);
2461 if (nb_events
< 0) {
2462 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2467 ret
= LTTNG_ERR_UND
;
2474 /* Return negative value to differentiate return code */
2479 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2481 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2482 struct lttng_event_field
**fields
)
2485 ssize_t nb_fields
= 0;
2488 case LTTNG_DOMAIN_UST
:
2489 nb_fields
= ust_app_list_event_fields(fields
);
2490 if (nb_fields
< 0) {
2491 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2495 case LTTNG_DOMAIN_KERNEL
:
2496 default: /* fall-through */
2497 ret
= LTTNG_ERR_UND
;
2504 /* Return negative value to differentiate return code */
2508 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2510 return syscall_table_list(events
);
2514 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2516 * Called with session lock held.
2518 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2519 enum lttng_domain_type domain
, int32_t **pids
)
2522 ssize_t nr_pids
= 0;
2525 case LTTNG_DOMAIN_KERNEL
:
2527 struct ltt_kernel_session
*ksess
;
2529 ksess
= session
->kernel_session
;
2530 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2532 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2537 case LTTNG_DOMAIN_UST
:
2539 struct ltt_ust_session
*usess
;
2541 usess
= session
->ust_session
;
2542 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2544 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2549 case LTTNG_DOMAIN_LOG4J
:
2550 case LTTNG_DOMAIN_JUL
:
2551 case LTTNG_DOMAIN_PYTHON
:
2553 ret
= LTTNG_ERR_UND
;
2560 /* Return negative value to differentiate return code */
2565 * Command LTTNG_START_TRACE processed by the client thread.
2567 * Called with session mutex held.
2569 int cmd_start_trace(struct ltt_session
*session
)
2571 enum lttng_error_code ret
;
2572 unsigned long nb_chan
= 0;
2573 struct ltt_kernel_session
*ksession
;
2574 struct ltt_ust_session
*usess
;
2575 const bool session_rotated_after_last_stop
=
2576 session
->rotated_after_last_stop
;
2580 /* Ease our life a bit ;) */
2581 ksession
= session
->kernel_session
;
2582 usess
= session
->ust_session
;
2584 /* Is the session already started? */
2585 if (session
->active
) {
2586 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2590 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2591 !session
->current_trace_chunk
) {
2593 * A rotation was launched while the session was stopped and
2594 * it has not been completed yet. It is not possible to start
2595 * the session since starting the session here would require a
2596 * rotation from "NULL" to a new trace chunk. That rotation
2597 * would overlap with the ongoing rotation, which is not
2600 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2602 ret
= LTTNG_ERR_ROTATION_PENDING
;
2607 * Starting a session without channel is useless since after that it's not
2608 * possible to enable channel thus inform the client.
2610 if (usess
&& usess
->domain_global
.channels
) {
2611 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2614 nb_chan
+= ksession
->channel_count
;
2617 ret
= LTTNG_ERR_NO_CHANNEL
;
2621 session
->active
= 1;
2622 session
->rotated_after_last_stop
= false;
2623 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2624 if (!session
->has_been_started
) {
2625 struct lttng_trace_chunk
*trace_chunk
;
2627 DBG("Creating initial trace chunk of session \"%s\"",
2629 trace_chunk
= session_create_new_trace_chunk(
2630 session
, NULL
, NULL
, NULL
);
2632 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2635 assert(!session
->current_trace_chunk
);
2636 ret
= session_set_trace_chunk(session
, trace_chunk
,
2638 lttng_trace_chunk_put(trace_chunk
);
2640 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2644 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2647 * Rotate existing streams into the new chunk.
2648 * This is a "quiet" rotation has no client has
2649 * explicitly requested this operation.
2651 * There is also no need to wait for the rotation
2652 * to complete as it will happen immediately. No data
2653 * was produced as the session was stopped, so the
2654 * rotation should happen on reception of the command.
2656 ret
= cmd_rotate_session(session
, NULL
, true);
2657 if (ret
!= LTTNG_OK
) {
2663 /* Kernel tracing */
2664 if (ksession
!= NULL
) {
2665 DBG("Start kernel tracing session %s", session
->name
);
2666 ret
= start_kernel_session(ksession
);
2667 if (ret
!= LTTNG_OK
) {
2672 /* Flag session that trace should start automatically */
2674 int int_ret
= ust_app_start_trace_all(usess
);
2677 ret
= LTTNG_ERR_UST_START_FAIL
;
2683 * Clear the flag that indicates that a rotation was done while the
2684 * session was stopped.
2686 session
->rotated_after_last_stop
= false;
2688 if (session
->rotate_timer_period
) {
2689 int int_ret
= timer_session_rotation_schedule_timer_start(
2690 session
, session
->rotate_timer_period
);
2693 ERR("Failed to enable rotate timer");
2694 ret
= LTTNG_ERR_UNK
;
2702 if (ret
== LTTNG_OK
) {
2703 /* Flag this after a successful start. */
2704 session
->has_been_started
|= 1;
2706 session
->active
= 0;
2707 /* Restore initial state on error. */
2708 session
->rotated_after_last_stop
=
2709 session_rotated_after_last_stop
;
2715 * Command LTTNG_STOP_TRACE processed by the client thread.
2717 int cmd_stop_trace(struct ltt_session
*session
)
2720 struct ltt_kernel_channel
*kchan
;
2721 struct ltt_kernel_session
*ksession
;
2722 struct ltt_ust_session
*usess
;
2723 bool error_occurred
= false;
2727 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2729 ksession
= session
->kernel_session
;
2730 usess
= session
->ust_session
;
2732 /* Session is not active. Skip everythong and inform the client. */
2733 if (!session
->active
) {
2734 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2739 if (ksession
&& ksession
->active
) {
2740 DBG("Stop kernel tracing");
2742 ret
= kernel_stop_session(ksession
);
2744 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2748 kernel_wait_quiescent();
2750 /* Flush metadata after stopping (if exists) */
2751 if (ksession
->metadata_stream_fd
>= 0) {
2752 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2754 ERR("Kernel metadata flush failed");
2755 error_occurred
= true;
2759 /* Flush all buffers after stopping */
2760 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2761 ret
= kernel_flush_buffer(kchan
);
2763 ERR("Kernel flush buffer error");
2764 error_occurred
= true;
2768 ksession
->active
= 0;
2769 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2773 if (usess
&& usess
->active
) {
2774 ret
= ust_app_stop_trace_all(usess
);
2776 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2781 /* Flag inactive after a successful stop. */
2782 session
->active
= 0;
2783 ret
= !error_occurred
? LTTNG_OK
: LTTNG_ERR_UNK
;
2790 * Set the base_path of the session only if subdir of a control uris is set.
2791 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2793 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2795 struct lttng_uri
*uris
)
2800 for (i
= 0; i
< nb_uri
; i
++) {
2801 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2802 uris
[i
].subdir
[0] == '\0') {
2803 /* Not interested in these URIs */
2807 if (session
->base_path
!= NULL
) {
2808 free(session
->base_path
);
2809 session
->base_path
= NULL
;
2812 /* Set session base_path */
2813 session
->base_path
= strdup(uris
[i
].subdir
);
2814 if (!session
->base_path
) {
2815 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2816 uris
[i
].subdir
, session
->name
);
2817 ret
= LTTNG_ERR_NOMEM
;
2820 DBG2("Setting base path \"%s\" for session \"%s\"",
2821 session
->base_path
, session
->name
);
2829 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2831 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2832 struct lttng_uri
*uris
)
2835 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2836 struct ltt_ust_session
*usess
= session
->ust_session
;
2842 /* Can't set consumer URI if the session is active. */
2843 if (session
->active
) {
2844 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2849 * Set the session base path if any. This is done inside
2850 * cmd_set_consumer_uri to preserve backward compatibility of the
2851 * previous session creation api vs the session descriptor api.
2853 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2854 if (ret
!= LTTNG_OK
) {
2858 /* Set the "global" consumer URIs */
2859 for (i
= 0; i
< nb_uri
; i
++) {
2860 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2862 if (ret
!= LTTNG_OK
) {
2867 /* Set UST session URIs */
2868 if (session
->ust_session
) {
2869 for (i
= 0; i
< nb_uri
; i
++) {
2870 ret
= add_uri_to_consumer(session
,
2871 session
->ust_session
->consumer
,
2872 &uris
[i
], LTTNG_DOMAIN_UST
);
2873 if (ret
!= LTTNG_OK
) {
2879 /* Set kernel session URIs */
2880 if (session
->kernel_session
) {
2881 for (i
= 0; i
< nb_uri
; i
++) {
2882 ret
= add_uri_to_consumer(session
,
2883 session
->kernel_session
->consumer
,
2884 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2885 if (ret
!= LTTNG_OK
) {
2892 * Make sure to set the session in output mode after we set URI since a
2893 * session can be created without URL (thus flagged in no output mode).
2895 session
->output_traces
= 1;
2897 ksess
->output_traces
= 1;
2901 usess
->output_traces
= 1;
2912 enum lttng_error_code
set_session_output_from_descriptor(
2913 struct ltt_session
*session
,
2914 const struct lttng_session_descriptor
*descriptor
)
2917 enum lttng_error_code ret_code
= LTTNG_OK
;
2918 enum lttng_session_descriptor_type session_type
=
2919 lttng_session_descriptor_get_type(descriptor
);
2920 enum lttng_session_descriptor_output_type output_type
=
2921 lttng_session_descriptor_get_output_type(descriptor
);
2922 struct lttng_uri uris
[2] = {};
2923 size_t uri_count
= 0;
2925 switch (output_type
) {
2926 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2928 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2929 lttng_session_descriptor_get_local_output_uri(descriptor
,
2933 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2934 lttng_session_descriptor_get_network_output_uris(descriptor
,
2935 &uris
[0], &uris
[1]);
2939 ret_code
= LTTNG_ERR_INVALID
;
2943 switch (session_type
) {
2944 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2946 struct snapshot_output
*new_output
= NULL
;
2948 new_output
= snapshot_output_alloc();
2950 ret_code
= LTTNG_ERR_NOMEM
;
2954 ret
= snapshot_output_init_with_uri(session
,
2955 DEFAULT_SNAPSHOT_MAX_SIZE
,
2956 NULL
, uris
, uri_count
, session
->consumer
,
2957 new_output
, &session
->snapshot
);
2959 ret_code
= (ret
== -ENOMEM
) ?
2960 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2961 snapshot_output_destroy(new_output
);
2964 snapshot_add_output(&session
->snapshot
, new_output
);
2967 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2968 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2970 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2974 ret_code
= LTTNG_ERR_INVALID
;
2982 enum lttng_error_code
cmd_create_session_from_descriptor(
2983 struct lttng_session_descriptor
*descriptor
,
2984 const lttng_sock_cred
*creds
,
2985 const char *home_path
)
2988 enum lttng_error_code ret_code
;
2989 const char *session_name
;
2990 struct ltt_session
*new_session
= NULL
;
2991 enum lttng_session_descriptor_status descriptor_status
;
2993 session_lock_list();
2995 if (*home_path
!= '/') {
2996 ERR("Home path provided by client is not absolute");
2997 ret_code
= LTTNG_ERR_INVALID
;
3002 descriptor_status
= lttng_session_descriptor_get_session_name(
3003 descriptor
, &session_name
);
3004 switch (descriptor_status
) {
3005 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3007 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3008 session_name
= NULL
;
3011 ret_code
= LTTNG_ERR_INVALID
;
3015 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3017 if (ret_code
!= LTTNG_OK
) {
3021 if (!session_name
) {
3022 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3025 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3030 if (!lttng_session_descriptor_is_output_destination_initialized(
3033 * Only include the session's creation time in the output
3034 * destination if the name of the session itself was
3035 * not auto-generated.
3037 ret_code
= lttng_session_descriptor_set_default_output(
3039 session_name
? &new_session
->creation_time
: NULL
,
3041 if (ret_code
!= LTTNG_OK
) {
3045 new_session
->has_user_specified_directory
=
3046 lttng_session_descriptor_has_output_directory(
3050 switch (lttng_session_descriptor_get_type(descriptor
)) {
3051 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3052 new_session
->snapshot_mode
= 1;
3054 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3055 new_session
->live_timer
=
3056 lttng_session_descriptor_live_get_timer_interval(
3063 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3064 if (ret_code
!= LTTNG_OK
) {
3067 new_session
->consumer
->enabled
= 1;
3068 ret_code
= LTTNG_OK
;
3070 /* Release reference provided by the session_create function. */
3071 session_put(new_session
);
3072 if (ret_code
!= LTTNG_OK
&& new_session
) {
3073 /* Release the global reference on error. */
3074 session_destroy(new_session
);
3076 session_unlock_list();
3080 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3081 struct lttng_session_descriptor
**return_descriptor
)
3084 size_t payload_size
;
3085 struct lttng_dynamic_buffer payload
;
3086 struct lttng_buffer_view home_dir_view
;
3087 struct lttng_buffer_view session_descriptor_view
;
3088 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3089 enum lttng_error_code ret_code
;
3091 lttng_dynamic_buffer_init(&payload
);
3092 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3094 ret_code
= LTTNG_ERR_INVALID
;
3097 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3098 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3099 ret_code
= LTTNG_ERR_INVALID
;
3103 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3104 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3105 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3107 ret_code
= LTTNG_ERR_NOMEM
;
3111 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3113 ERR("Reception of session descriptor failed, aborting.");
3114 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3118 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3121 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3122 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3124 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3125 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3127 ret
= lttng_session_descriptor_create_from_buffer(
3128 &session_descriptor_view
, &session_descriptor
);
3130 ERR("Failed to create session descriptor from payload of \"create session\" command");
3131 ret_code
= LTTNG_ERR_INVALID
;
3136 * Sets the descriptor's auto-generated properties (name, output) if
3139 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3141 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3142 if (ret_code
!= LTTNG_OK
) {
3146 ret_code
= LTTNG_OK
;
3147 *return_descriptor
= session_descriptor
;
3148 session_descriptor
= NULL
;
3150 lttng_dynamic_buffer_reset(&payload
);
3151 lttng_session_descriptor_destroy(session_descriptor
);
3156 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3157 void *_reply_context
)
3161 const struct cmd_destroy_session_reply_context
*reply_context
=
3163 struct lttng_dynamic_buffer payload
;
3164 struct lttcomm_session_destroy_command_header cmd_header
;
3165 struct lttng_trace_archive_location
*location
= NULL
;
3166 struct lttcomm_lttng_msg llm
= {
3167 .cmd_type
= LTTNG_DESTROY_SESSION
,
3168 .ret_code
= reply_context
->destruction_status
,
3171 sizeof(struct lttcomm_session_destroy_command_header
),
3174 size_t payload_size_before_location
;
3176 lttng_dynamic_buffer_init(&payload
);
3178 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3180 ERR("Failed to append session destruction message");
3184 cmd_header
.rotation_state
=
3185 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3186 session
->rotation_state
:
3187 LTTNG_ROTATION_STATE_NO_ROTATION
);
3188 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3189 sizeof(cmd_header
));
3191 ERR("Failed to append session destruction command header");
3195 if (!reply_context
->implicit_rotation_on_destroy
) {
3196 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3200 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3201 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3206 location
= session_get_trace_archive_location(session
);
3208 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3213 payload_size_before_location
= payload
.size
;
3214 comm_ret
= lttng_trace_archive_location_serialize(location
,
3217 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3221 /* Update the message to indicate the location's length. */
3222 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3223 payload
.size
- payload_size_before_location
;
3225 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3226 payload
.data
, payload
.size
);
3227 if (comm_ret
!= (ssize_t
) payload
.size
) {
3228 ERR("Failed to send result of the destruction of session \"%s\" to client",
3232 ret
= close(reply_context
->reply_sock_fd
);
3234 PERROR("Failed to close client socket in deferred session destroy reply");
3236 lttng_dynamic_buffer_reset(&payload
);
3237 free(_reply_context
);
3241 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3243 * Called with session lock held.
3245 int cmd_destroy_session(struct ltt_session
*session
,
3246 struct notification_thread_handle
*notification_thread_handle
,
3250 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3251 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3254 reply_context
= zmalloc(sizeof(*reply_context
));
3255 if (!reply_context
) {
3256 ret
= LTTNG_ERR_NOMEM
;
3259 reply_context
->reply_sock_fd
= *sock_fd
;
3265 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3267 if (session
->active
) {
3268 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3270 ret
= cmd_stop_trace(session
);
3271 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3272 /* Carry on with the destruction of the session. */
3273 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3274 session
->name
, lttng_strerror(-ret
));
3275 destruction_last_error
= ret
;
3279 if (session
->rotation_schedule_timer_enabled
) {
3280 if (timer_session_rotation_schedule_timer_stop(
3282 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3284 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3288 if (session
->rotate_size
) {
3289 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3290 session
->rotate_size
= 0;
3293 if (session
->most_recent_chunk_id
.is_set
&&
3294 session
->most_recent_chunk_id
.value
!= 0 &&
3295 session
->current_trace_chunk
&& session
->output_traces
) {
3297 * Perform a last rotation on destruction if rotations have
3298 * occurred during the session's lifetime.
3300 ret
= cmd_rotate_session(session
, NULL
, false);
3301 if (ret
!= LTTNG_OK
) {
3302 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3303 session
->name
, lttng_strerror(-ret
));
3304 destruction_last_error
= -ret
;
3306 if (reply_context
) {
3307 reply_context
->implicit_rotation_on_destroy
= true;
3309 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3311 * The user has not triggered a session rotation. However, to
3312 * ensure all data has been consumed, the session is rotated
3313 * to a 'null' trace chunk before it is destroyed.
3315 * This is a "quiet" rotation meaning that no notification is
3316 * emitted and no renaming of the current trace chunk takes
3319 ret
= cmd_rotate_session(session
, NULL
, true);
3320 if (ret
!= LTTNG_OK
) {
3321 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3322 session
->name
, lttng_strerror(-ret
));
3323 destruction_last_error
= -ret
;
3327 if (session
->shm_path
[0]) {
3329 * When a session is created with an explicit shm_path,
3330 * the consumer daemon will create its shared memory files
3331 * at that location and will *not* unlink them. This is normal
3332 * as the intention of that feature is to make it possible
3333 * to retrieve the content of those files should a crash occur.
3335 * To ensure the content of those files can be used, the
3336 * sessiond daemon will replicate the content of the metadata
3337 * cache in a metadata file.
3339 * On clean-up, it is expected that the consumer daemon will
3340 * unlink the shared memory files and that the session daemon
3341 * will unlink the metadata file. Then, the session's directory
3342 * in the shm path can be removed.
3344 * Unfortunately, a flaw in the design of the sessiond's and
3345 * consumerd's tear down of channels makes it impossible to
3346 * determine when the sessiond _and_ the consumerd have both
3347 * destroyed their representation of a channel. For one, the
3348 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3349 * callbacks in both daemons.
3351 * However, it is also impossible for the sessiond to know when
3352 * the consumer daemon is done destroying its channel(s) since
3353 * it occurs as a reaction to the closing of the channel's file
3354 * descriptor. There is no resulting communication initiated
3355 * from the consumerd to the sessiond to confirm that the
3356 * operation is completed (and was successful).
3358 * Until this is all fixed, the session daemon checks for the
3359 * removal of the session's shm path which makes it possible
3360 * to safely advertise a session as having been destroyed.
3362 * Prior to this fix, it was not possible to reliably save
3363 * a session making use of the --shm-path option, destroy it,
3364 * and load it again. This is because the creation of the
3365 * session would fail upon seeing the session's shm path
3366 * already in existence.
3368 * Note that none of the error paths in the check for the
3369 * directory's existence return an error. This is normal
3370 * as there isn't much that can be done. The session will
3371 * be destroyed properly, except that we can't offer the
3372 * guarantee that the same session can be re-created.
3374 current_completion_handler
= &destroy_completion_handler
.handler
;
3375 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3377 sizeof(destroy_completion_handler
.shm_path
));
3382 * The session is destroyed. However, note that the command context
3383 * still holds a reference to the session, thus delaying its destruction
3384 * _at least_ up to the point when that reference is released.
3386 session_destroy(session
);
3387 if (reply_context
) {
3388 reply_context
->destruction_status
= destruction_last_error
;
3389 ret
= session_add_destroy_notifier(session
,
3390 cmd_destroy_session_reply
,
3391 (void *) reply_context
);
3393 ret
= LTTNG_ERR_FATAL
;
3405 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3407 int cmd_register_consumer(struct ltt_session
*session
,
3408 enum lttng_domain_type domain
, const char *sock_path
,
3409 struct consumer_data
*cdata
)
3412 struct consumer_socket
*socket
= NULL
;
3419 case LTTNG_DOMAIN_KERNEL
:
3421 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3425 /* Can't register a consumer if there is already one */
3426 if (ksess
->consumer_fds_sent
!= 0) {
3427 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3431 sock
= lttcomm_connect_unix_sock(sock_path
);
3433 ret
= LTTNG_ERR_CONNECT_FAIL
;
3436 cdata
->cmd_sock
= sock
;
3438 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3439 if (socket
== NULL
) {
3442 PERROR("close register consumer");
3444 cdata
->cmd_sock
= -1;
3445 ret
= LTTNG_ERR_FATAL
;
3449 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3450 if (socket
->lock
== NULL
) {
3451 PERROR("zmalloc pthread mutex");
3452 ret
= LTTNG_ERR_FATAL
;
3455 pthread_mutex_init(socket
->lock
, NULL
);
3456 socket
->registered
= 1;
3459 consumer_add_socket(socket
, ksess
->consumer
);
3462 pthread_mutex_lock(&cdata
->pid_mutex
);
3464 pthread_mutex_unlock(&cdata
->pid_mutex
);
3469 /* TODO: Userspace tracing */
3470 ret
= LTTNG_ERR_UND
;
3478 consumer_destroy_socket(socket
);
3484 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3486 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3487 struct lttng_domain
**domains
)
3492 struct lttng_ht_iter iter
;
3494 if (session
->kernel_session
!= NULL
) {
3495 DBG3("Listing domains found kernel domain");
3499 if (session
->ust_session
!= NULL
) {
3500 DBG3("Listing domains found UST global domain");
3504 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3506 if (agt
->being_used
) {
3517 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3518 if (*domains
== NULL
) {
3519 ret
= LTTNG_ERR_FATAL
;
3523 if (session
->kernel_session
!= NULL
) {
3524 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3526 /* Kernel session buffer type is always GLOBAL */
3527 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3532 if (session
->ust_session
!= NULL
) {
3533 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3534 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3538 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3540 if (agt
->being_used
) {
3541 (*domains
)[index
].type
= agt
->domain
;
3542 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3552 /* Return negative value to differentiate return code */
3558 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3560 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3561 struct ltt_session
*session
, struct lttng_channel
**channels
)
3563 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3566 case LTTNG_DOMAIN_KERNEL
:
3567 if (session
->kernel_session
!= NULL
) {
3568 nb_chan
= session
->kernel_session
->channel_count
;
3570 DBG3("Number of kernel channels %zd", nb_chan
);
3572 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3576 case LTTNG_DOMAIN_UST
:
3577 if (session
->ust_session
!= NULL
) {
3579 nb_chan
= lttng_ht_get_count(
3580 session
->ust_session
->domain_global
.channels
);
3583 DBG3("Number of UST global channels %zd", nb_chan
);
3585 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3590 ret
= -LTTNG_ERR_UND
;
3595 const size_t channel_size
= sizeof(struct lttng_channel
) +
3596 sizeof(struct lttng_channel_extended
);
3597 struct lttng_channel_extended
*channel_exts
;
3599 payload_size
= nb_chan
* channel_size
;
3600 *channels
= zmalloc(payload_size
);
3601 if (*channels
== NULL
) {
3602 ret
= -LTTNG_ERR_FATAL
;
3606 channel_exts
= ((void *) *channels
) +
3607 (nb_chan
* sizeof(struct lttng_channel
));
3608 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3609 if (ret
!= LTTNG_OK
) {
3624 * Command LTTNG_LIST_EVENTS processed by the client thread.
3626 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3627 struct ltt_session
*session
, char *channel_name
,
3628 struct lttng_event
**events
, size_t *total_size
)
3631 ssize_t nb_event
= 0;
3634 case LTTNG_DOMAIN_KERNEL
:
3635 if (session
->kernel_session
!= NULL
) {
3636 nb_event
= list_lttng_kernel_events(channel_name
,
3637 session
->kernel_session
, events
,
3641 case LTTNG_DOMAIN_UST
:
3643 if (session
->ust_session
!= NULL
) {
3644 nb_event
= list_lttng_ust_global_events(channel_name
,
3645 &session
->ust_session
->domain_global
, events
,
3650 case LTTNG_DOMAIN_LOG4J
:
3651 case LTTNG_DOMAIN_JUL
:
3652 case LTTNG_DOMAIN_PYTHON
:
3653 if (session
->ust_session
) {
3654 struct lttng_ht_iter iter
;
3658 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3659 &iter
.iter
, agt
, node
.node
) {
3660 if (agt
->domain
== domain
) {
3661 nb_event
= list_lttng_agent_events(
3671 ret
= LTTNG_ERR_UND
;
3678 /* Return negative value to differentiate return code */
3683 * Using the session list, filled a lttng_session array to send back to the
3684 * client for session listing.
3686 * The session list lock MUST be acquired before calling this function. Use
3687 * session_lock_list() and session_unlock_list().
3689 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3690 size_t session_count
, uid_t uid
, gid_t gid
)
3694 struct ltt_session
*session
;
3695 struct ltt_session_list
*list
= session_get_list();
3696 struct lttng_session_extended
*extended
=
3697 (typeof(extended
)) (&sessions
[session_count
]);
3699 DBG("Getting all available session for UID %d GID %d",
3702 * Iterate over session list and append data after the control struct in
3705 cds_list_for_each_entry(session
, &list
->head
, list
) {
3706 if (!session_get(session
)) {
3710 * Only list the sessions the user can control.
3712 if (!session_access_ok(session
, uid
, gid
) ||
3713 session
->destroyed
) {
3714 session_put(session
);
3718 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3719 struct ltt_ust_session
*usess
= session
->ust_session
;
3721 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3722 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3723 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3724 ret
= build_network_session_path(sessions
[i
].path
,
3725 sizeof(sessions
[i
].path
), session
);
3727 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3728 session
->consumer
->dst
.session_root_path
);
3731 PERROR("snprintf session path");
3732 session_put(session
);
3736 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3737 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3738 sessions
[i
].enabled
= session
->active
;
3739 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3740 sessions
[i
].live_timer_interval
= session
->live_timer
;
3741 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3742 extended
[i
].creation_time
.is_set
= 1;
3744 session_put(session
);
3749 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3750 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3752 int cmd_data_pending(struct ltt_session
*session
)
3755 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3756 struct ltt_ust_session
*usess
= session
->ust_session
;
3760 DBG("Data pending for session %s", session
->name
);
3762 /* Session MUST be stopped to ask for data availability. */
3763 if (session
->active
) {
3764 ret
= LTTNG_ERR_SESSION_STARTED
;
3768 * If stopped, just make sure we've started before else the above call
3769 * will always send that there is data pending.
3771 * The consumer assumes that when the data pending command is received,
3772 * the trace has been started before or else no output data is written
3773 * by the streams which is a condition for data pending. So, this is
3774 * *VERY* important that we don't ask the consumer before a start
3777 if (!session
->has_been_started
) {
3783 /* A rotation is still pending, we have to wait. */
3784 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3785 DBG("Rotate still pending for session %s", session
->name
);
3790 if (ksess
&& ksess
->consumer
) {
3791 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3793 /* Data is still being extracted for the kernel. */
3798 if (usess
&& usess
->consumer
) {
3799 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3801 /* Data is still being extracted for the kernel. */
3806 /* Data is ready to be read by a viewer */
3814 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3816 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3818 int cmd_snapshot_add_output(struct ltt_session
*session
,
3819 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3822 struct snapshot_output
*new_output
;
3827 DBG("Cmd snapshot add output for session %s", session
->name
);
3830 * Can't create an output if the session is not set in no-output mode.
3832 if (session
->output_traces
) {
3833 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3837 if (session
->has_non_mmap_channel
) {
3838 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3842 /* Only one output is allowed until we have the "tee" feature. */
3843 if (session
->snapshot
.nb_output
== 1) {
3844 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3848 new_output
= snapshot_output_alloc();
3850 ret
= LTTNG_ERR_NOMEM
;
3854 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3855 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3856 &session
->snapshot
);
3858 if (ret
== -ENOMEM
) {
3859 ret
= LTTNG_ERR_NOMEM
;
3861 ret
= LTTNG_ERR_INVALID
;
3867 snapshot_add_output(&session
->snapshot
, new_output
);
3869 *id
= new_output
->id
;
3876 snapshot_output_destroy(new_output
);
3882 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3884 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3886 int cmd_snapshot_del_output(struct ltt_session
*session
,
3887 const struct lttng_snapshot_output
*output
)
3890 struct snapshot_output
*sout
= NULL
;
3898 * Permission denied to create an output if the session is not
3899 * set in no output mode.
3901 if (session
->output_traces
) {
3902 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3907 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3909 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3910 } else if (*output
->name
!= '\0') {
3911 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3913 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3916 ret
= LTTNG_ERR_INVALID
;
3920 snapshot_delete_output(&session
->snapshot
, sout
);
3921 snapshot_output_destroy(sout
);
3930 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3932 * If no output is available, outputs is untouched and 0 is returned.
3934 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3936 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3937 struct lttng_snapshot_output
**outputs
)
3940 struct lttng_snapshot_output
*list
= NULL
;
3941 struct lttng_ht_iter iter
;
3942 struct snapshot_output
*output
;
3947 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3950 * Permission denied to create an output if the session is not
3951 * set in no output mode.
3953 if (session
->output_traces
) {
3954 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3958 if (session
->snapshot
.nb_output
== 0) {
3963 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3965 ret
= -LTTNG_ERR_NOMEM
;
3969 /* Copy list from session to the new list object. */
3971 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3972 output
, node
.node
) {
3973 assert(output
->consumer
);
3974 list
[idx
].id
= output
->id
;
3975 list
[idx
].max_size
= output
->max_size
;
3976 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3977 sizeof(list
[idx
].name
))) {
3978 ret
= -LTTNG_ERR_INVALID
;
3981 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3982 if (lttng_strncpy(list
[idx
].ctrl_url
,
3983 output
->consumer
->dst
.session_root_path
,
3984 sizeof(list
[idx
].ctrl_url
))) {
3985 ret
= -LTTNG_ERR_INVALID
;
3990 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3991 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3993 ret
= -LTTNG_ERR_NOMEM
;
3998 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3999 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4001 ret
= -LTTNG_ERR_NOMEM
;
4010 ret
= session
->snapshot
.nb_output
;
4019 * Check if we can regenerate the metadata for this session.
4020 * Only kernel, UST per-uid and non-live sessions are supported.
4022 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4025 int check_regenerate_metadata_support(struct ltt_session
*session
)
4031 if (session
->live_timer
!= 0) {
4032 ret
= LTTNG_ERR_LIVE_SESSION
;
4035 if (!session
->active
) {
4036 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4039 if (session
->ust_session
) {
4040 switch (session
->ust_session
->buffer_type
) {
4041 case LTTNG_BUFFER_PER_UID
:
4043 case LTTNG_BUFFER_PER_PID
:
4044 ret
= LTTNG_ERR_PER_PID_SESSION
;
4048 ret
= LTTNG_ERR_UNK
;
4052 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4053 session
->consumer
->relay_minor_version
< 8) {
4054 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4064 int clear_metadata_file(int fd
)
4069 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4070 if (lseek_ret
< 0) {
4076 ret
= ftruncate(fd
, 0);
4078 PERROR("ftruncate");
4087 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4090 struct buffer_reg_uid
*uid_reg
= NULL
;
4091 struct buffer_reg_session
*session_reg
= NULL
;
4094 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4095 struct ust_registry_session
*registry
;
4096 struct ust_registry_channel
*chan
;
4097 struct lttng_ht_iter iter_chan
;
4099 session_reg
= uid_reg
->registry
;
4100 registry
= session_reg
->reg
.ust
;
4102 pthread_mutex_lock(®istry
->lock
);
4103 registry
->metadata_len_sent
= 0;
4104 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4105 registry
->metadata_len
= 0;
4106 registry
->metadata_version
++;
4107 if (registry
->metadata_fd
> 0) {
4108 /* Clear the metadata file's content. */
4109 ret
= clear_metadata_file(registry
->metadata_fd
);
4111 pthread_mutex_unlock(®istry
->lock
);
4116 ret
= ust_metadata_session_statedump(registry
, NULL
,
4117 registry
->major
, registry
->minor
);
4119 pthread_mutex_unlock(®istry
->lock
);
4120 ERR("Failed to generate session metadata (err = %d)",
4124 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4126 struct ust_registry_event
*event
;
4127 struct lttng_ht_iter iter_event
;
4129 ret
= ust_metadata_channel_statedump(registry
, chan
);
4131 pthread_mutex_unlock(®istry
->lock
);
4132 ERR("Failed to generate channel metadata "
4136 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4138 ret
= ust_metadata_event_statedump(registry
,
4141 pthread_mutex_unlock(®istry
->lock
);
4142 ERR("Failed to generate event metadata "
4148 pthread_mutex_unlock(®istry
->lock
);
4157 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4159 * Ask the consumer to truncate the existing metadata file(s) and
4160 * then regenerate the metadata. Live and per-pid sessions are not
4161 * supported and return an error.
4163 * Return 0 on success or else a LTTNG_ERR code.
4165 int cmd_regenerate_metadata(struct ltt_session
*session
)
4171 ret
= check_regenerate_metadata_support(session
);
4176 if (session
->kernel_session
) {
4177 ret
= kernctl_session_regenerate_metadata(
4178 session
->kernel_session
->fd
);
4180 ERR("Failed to regenerate the kernel metadata");
4185 if (session
->ust_session
) {
4186 ret
= ust_regenerate_metadata(session
->ust_session
);
4188 ERR("Failed to regenerate the UST metadata");
4192 DBG("Cmd metadata regenerate for session %s", session
->name
);
4200 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4202 * Ask the tracer to regenerate a new statedump.
4204 * Return 0 on success or else a LTTNG_ERR code.
4206 int cmd_regenerate_statedump(struct ltt_session
*session
)
4212 if (!session
->active
) {
4213 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4217 if (session
->kernel_session
) {
4218 ret
= kernctl_session_regenerate_statedump(
4219 session
->kernel_session
->fd
);
4221 * Currently, the statedump in kernel can only fail if out
4225 if (ret
== -ENOMEM
) {
4226 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4228 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4230 ERR("Failed to regenerate the kernel statedump");
4235 if (session
->ust_session
) {
4236 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4238 * Currently, the statedump in UST always returns 0.
4241 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4242 ERR("Failed to regenerate the UST statedump");
4246 DBG("Cmd regenerate statedump for session %s", session
->name
);
4253 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4254 struct notification_thread_handle
*notification_thread
)
4258 ssize_t sock_recv_len
;
4259 struct lttng_trigger
*trigger
= NULL
;
4260 struct lttng_buffer_view view
;
4261 struct lttng_dynamic_buffer trigger_buffer
;
4263 lttng_dynamic_buffer_init(&trigger_buffer
);
4264 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4265 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4267 ret
= LTTNG_ERR_NOMEM
;
4271 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4273 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4274 ERR("Failed to receive \"register trigger\" command payload");
4275 /* TODO: should this be a new error enum ? */
4276 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4280 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4281 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4283 ERR("Invalid trigger payload received in \"register trigger\" command");
4284 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4288 ret
= notification_thread_command_register_trigger(notification_thread
,
4290 /* Ownership of trigger was transferred. */
4293 lttng_trigger_destroy(trigger
);
4294 lttng_dynamic_buffer_reset(&trigger_buffer
);
4298 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4299 struct notification_thread_handle
*notification_thread
)
4303 ssize_t sock_recv_len
;
4304 struct lttng_trigger
*trigger
= NULL
;
4305 struct lttng_buffer_view view
;
4306 struct lttng_dynamic_buffer trigger_buffer
;
4308 lttng_dynamic_buffer_init(&trigger_buffer
);
4309 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4310 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4312 ret
= LTTNG_ERR_NOMEM
;
4316 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4318 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4319 ERR("Failed to receive \"unregister trigger\" command payload");
4320 /* TODO: should this be a new error enum ? */
4321 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4325 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4326 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4328 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4329 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4333 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4336 lttng_trigger_destroy(trigger
);
4337 lttng_dynamic_buffer_reset(&trigger_buffer
);
4342 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4343 * snapshot output is *not* set with a remote destination.
4345 * Return LTTNG_OK on success or a LTTNG_ERR code.
4347 static enum lttng_error_code
set_relayd_for_snapshot(
4348 struct consumer_output
*output
,
4349 const struct ltt_session
*session
)
4351 enum lttng_error_code status
= LTTNG_OK
;
4352 struct lttng_ht_iter iter
;
4353 struct consumer_socket
*socket
;
4354 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4355 const char *base_path
;
4360 DBG2("Set relayd object from snapshot output");
4362 if (session
->current_trace_chunk
) {
4363 enum lttng_trace_chunk_status chunk_status
=
4364 lttng_trace_chunk_get_id(
4365 session
->current_trace_chunk
,
4366 ¤t_chunk_id
.value
);
4368 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4369 current_chunk_id
.is_set
= true;
4371 ERR("Failed to get current trace chunk id");
4372 status
= LTTNG_ERR_UNK
;
4377 /* Ignore if snapshot consumer output is not network. */
4378 if (output
->type
!= CONSUMER_DST_NET
) {
4383 * The snapshot record URI base path overrides the session
4386 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4387 base_path
= output
->dst
.net
.control
.subdir
;
4389 base_path
= session
->base_path
;
4393 * For each consumer socket, create and send the relayd object of the
4397 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4398 socket
, node
.node
) {
4399 pthread_mutex_lock(socket
->lock
);
4400 status
= send_consumer_relayd_sockets(0, session
->id
,
4402 session
->name
, session
->hostname
,
4404 session
->live_timer
,
4405 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4406 session
->creation_time
,
4407 session
->name_contains_creation_time
);
4408 pthread_mutex_unlock(socket
->lock
);
4409 if (status
!= LTTNG_OK
) {
4421 * Record a kernel snapshot.
4423 * Return LTTNG_OK on success or a LTTNG_ERR code.
4425 static enum lttng_error_code
record_kernel_snapshot(
4426 struct ltt_kernel_session
*ksess
,
4427 const struct consumer_output
*output
,
4428 const struct ltt_session
*session
,
4429 int wait
, uint64_t nb_packets_per_stream
)
4431 enum lttng_error_code status
;
4437 status
= kernel_snapshot_record(
4438 ksess
, output
, wait
, nb_packets_per_stream
);
4443 * Record a UST snapshot.
4445 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4447 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4448 const struct consumer_output
*output
,
4449 const struct ltt_session
*session
,
4450 int wait
, uint64_t nb_packets_per_stream
)
4452 enum lttng_error_code status
;
4458 status
= ust_app_snapshot_record(
4459 usess
, output
, wait
, nb_packets_per_stream
);
4464 uint64_t get_session_size_one_more_packet_per_stream(
4465 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4467 uint64_t tot_size
= 0;
4469 if (session
->kernel_session
) {
4470 struct ltt_kernel_channel
*chan
;
4471 const struct ltt_kernel_session
*ksess
=
4472 session
->kernel_session
;
4474 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4475 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4477 * Don't take channel into account if we
4478 * already grab all its packets.
4482 tot_size
+= chan
->channel
->attr
.subbuf_size
4483 * chan
->stream_count
;
4487 if (session
->ust_session
) {
4488 const struct ltt_ust_session
*usess
= session
->ust_session
;
4490 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4498 * Calculate the number of packets we can grab from each stream that
4499 * fits within the overall snapshot max size.
4501 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4502 * the number of packets per stream.
4504 * TODO: this approach is not perfect: we consider the worse case
4505 * (packet filling the sub-buffers) as an upper bound, but we could do
4506 * better if we do this calculation while we actually grab the packet
4507 * content: we would know how much padding we don't actually store into
4510 * This algorithm is currently bounded by the number of packets per
4513 * Since we call this algorithm before actually grabbing the data, it's
4514 * an approximation: for instance, applications could appear/disappear
4515 * in between this call and actually grabbing data.
4518 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4522 uint64_t cur_nb_packets
= 0;
4525 return 0; /* Infinite */
4528 size_left
= max_size
;
4530 uint64_t one_more_packet_tot_size
;
4532 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4533 session
, cur_nb_packets
);
4534 if (!one_more_packet_tot_size
) {
4535 /* We are already grabbing all packets. */
4538 size_left
-= one_more_packet_tot_size
;
4539 if (size_left
< 0) {
4544 if (!cur_nb_packets
) {
4545 /* Not enough room to grab one packet of each stream, error. */
4548 return cur_nb_packets
;
4552 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4553 const struct snapshot_output
*snapshot_output
, int wait
)
4555 int64_t nb_packets_per_stream
;
4556 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4558 enum lttng_error_code ret_code
= LTTNG_OK
;
4559 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4560 struct consumer_output
*original_ust_consumer_output
= NULL
;
4561 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4562 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4563 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4565 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4567 snapshot_output
->name
,
4568 snapshot_output
->datetime
,
4569 snapshot_output
->nb_snapshot
);
4570 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4571 ERR("Failed to format snapshot name");
4572 ret_code
= LTTNG_ERR_INVALID
;
4575 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4576 snapshot_output
->name
, session
->name
,
4577 snapshot_chunk_name
);
4578 if (!session
->kernel_session
&& !session
->ust_session
) {
4579 ERR("Failed to record snapshot as no channels exist");
4580 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4584 if (session
->kernel_session
) {
4585 original_kernel_consumer_output
=
4586 session
->kernel_session
->consumer
;
4587 snapshot_kernel_consumer_output
=
4588 consumer_copy_output(snapshot_output
->consumer
);
4589 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4590 snapshot_chunk_name
);
4591 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4592 original_kernel_consumer_output
);
4594 ERR("Failed to copy consumer sockets from snapshot output configuration");
4595 ret_code
= LTTNG_ERR_NOMEM
;
4598 ret_code
= set_relayd_for_snapshot(
4599 snapshot_kernel_consumer_output
, session
);
4600 if (ret_code
!= LTTNG_OK
) {
4601 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4604 session
->kernel_session
->consumer
=
4605 snapshot_kernel_consumer_output
;
4607 if (session
->ust_session
) {
4608 original_ust_consumer_output
= session
->ust_session
->consumer
;
4609 snapshot_ust_consumer_output
=
4610 consumer_copy_output(snapshot_output
->consumer
);
4611 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4612 snapshot_chunk_name
);
4613 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4614 original_ust_consumer_output
);
4616 ERR("Failed to copy consumer sockets from snapshot output configuration");
4617 ret_code
= LTTNG_ERR_NOMEM
;
4620 ret_code
= set_relayd_for_snapshot(
4621 snapshot_ust_consumer_output
, session
);
4622 if (ret_code
!= LTTNG_OK
) {
4623 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4626 session
->ust_session
->consumer
=
4627 snapshot_ust_consumer_output
;
4630 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4631 snapshot_kernel_consumer_output
?:
4632 snapshot_ust_consumer_output
,
4633 consumer_output_get_base_path(
4634 snapshot_output
->consumer
),
4635 snapshot_chunk_name
);
4636 if (!snapshot_trace_chunk
) {
4637 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4639 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4642 assert(!session
->current_trace_chunk
);
4643 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4644 lttng_trace_chunk_put(snapshot_trace_chunk
);
4645 snapshot_trace_chunk
= NULL
;
4647 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4649 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4653 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4654 snapshot_output
->max_size
);
4655 if (nb_packets_per_stream
< 0) {
4656 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4660 if (session
->kernel_session
) {
4661 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4662 snapshot_kernel_consumer_output
, session
,
4663 wait
, nb_packets_per_stream
);
4664 if (ret_code
!= LTTNG_OK
) {
4669 if (session
->ust_session
) {
4670 ret_code
= record_ust_snapshot(session
->ust_session
,
4671 snapshot_ust_consumer_output
, session
,
4672 wait
, nb_packets_per_stream
);
4673 if (ret_code
!= LTTNG_OK
) {
4678 if (session_close_trace_chunk(
4679 session
, session
->current_trace_chunk
, NULL
, NULL
)) {
4681 * Don't goto end; make sure the chunk is closed for the session
4682 * to allow future snapshots.
4684 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4686 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4688 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4689 ERR("Failed to release the current trace chunk of session \"%s\"",
4691 ret_code
= LTTNG_ERR_UNK
;
4694 if (original_ust_consumer_output
) {
4695 session
->ust_session
->consumer
= original_ust_consumer_output
;
4697 if (original_kernel_consumer_output
) {
4698 session
->kernel_session
->consumer
=
4699 original_kernel_consumer_output
;
4701 consumer_output_put(snapshot_ust_consumer_output
);
4702 consumer_output_put(snapshot_kernel_consumer_output
);
4707 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4709 * The wait parameter is ignored so this call always wait for the snapshot to
4710 * complete before returning.
4712 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4714 int cmd_snapshot_record(struct ltt_session
*session
,
4715 const struct lttng_snapshot_output
*output
, int wait
)
4717 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4719 unsigned int snapshot_success
= 0;
4721 struct snapshot_output
*tmp_output
= NULL
;
4726 DBG("Cmd snapshot record for session %s", session
->name
);
4728 /* Get the datetime for the snapshot output directory. */
4729 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4732 cmd_ret
= LTTNG_ERR_INVALID
;
4737 * Permission denied to create an output if the session is not
4738 * set in no output mode.
4740 if (session
->output_traces
) {
4741 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4745 /* The session needs to be started at least once. */
4746 if (!session
->has_been_started
) {
4747 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4751 /* Use temporary output for the session. */
4752 if (*output
->ctrl_url
!= '\0') {
4753 tmp_output
= snapshot_output_alloc();
4755 cmd_ret
= LTTNG_ERR_NOMEM
;
4759 ret
= snapshot_output_init(session
, output
->max_size
,
4761 output
->ctrl_url
, output
->data_url
,
4765 if (ret
== -ENOMEM
) {
4766 cmd_ret
= LTTNG_ERR_NOMEM
;
4768 cmd_ret
= LTTNG_ERR_INVALID
;
4772 /* Use the global session count for the temporary snapshot. */
4773 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4775 /* Use the global datetime */
4776 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4777 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4778 if (cmd_ret
!= LTTNG_OK
) {
4781 snapshot_success
= 1;
4783 struct snapshot_output
*sout
;
4784 struct lttng_ht_iter iter
;
4787 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4788 &iter
.iter
, sout
, node
.node
) {
4789 struct snapshot_output output_copy
;
4792 * Make a local copy of the output and override output
4793 * parameters with those provided as part of the
4796 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4798 if (output
->max_size
!= (uint64_t) -1ULL) {
4799 output_copy
.max_size
= output
->max_size
;
4802 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4803 memcpy(output_copy
.datetime
, datetime
,
4806 /* Use temporary name. */
4807 if (*output
->name
!= '\0') {
4808 if (lttng_strncpy(output_copy
.name
,
4810 sizeof(output_copy
.name
))) {
4811 cmd_ret
= LTTNG_ERR_INVALID
;
4817 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4818 if (cmd_ret
!= LTTNG_OK
) {
4822 snapshot_success
= 1;
4827 if (snapshot_success
) {
4828 session
->snapshot
.nb_snapshot
++;
4830 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4835 snapshot_output_destroy(tmp_output
);
4841 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4843 int cmd_set_session_shm_path(struct ltt_session
*session
,
4844 const char *shm_path
)
4850 * Can only set shm path before session is started.
4852 if (session
->has_been_started
) {
4853 return LTTNG_ERR_SESSION_STARTED
;
4856 strncpy(session
->shm_path
, shm_path
,
4857 sizeof(session
->shm_path
));
4858 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4864 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4866 * Ask the consumer to rotate the session output directory.
4867 * The session lock must be held.
4869 * Returns LTTNG_OK on success or else a negative LTTng error code.
4871 int cmd_rotate_session(struct ltt_session
*session
,
4872 struct lttng_rotate_session_return
*rotate_return
,
4873 bool quiet_rotation
)
4876 uint64_t ongoing_rotation_chunk_id
;
4877 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4878 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4879 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4880 enum lttng_trace_chunk_status chunk_status
;
4881 bool failed_to_rotate
= false;
4882 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4886 if (!session
->has_been_started
) {
4887 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4892 * Explicit rotation is not supported for live sessions.
4893 * However, live sessions can perform a quiet rotation on
4895 * Rotation is not supported for snapshot traces (no output).
4897 if ((!quiet_rotation
&& session
->live_timer
) ||
4898 !session
->output_traces
) {
4899 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4903 /* Unsupported feature in lttng-relayd before 2.11. */
4904 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4905 (session
->consumer
->relay_major_version
== 2 &&
4906 session
->consumer
->relay_minor_version
< 11)) {
4907 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4911 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4912 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4914 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4919 * After a stop, we only allow one rotation to occur, the other ones are
4920 * useless until a new start.
4922 if (session
->rotated_after_last_stop
) {
4923 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4925 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4928 if (session
->active
) {
4929 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4931 if (!new_trace_chunk
) {
4932 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4938 * The current trace chunk becomes the chunk being archived.
4940 * After this point, "chunk_being_archived" must absolutely
4941 * be closed on the consumer(s), otherwise it will never be
4942 * cleaned-up, which will result in a leak.
4944 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4945 &chunk_being_archived
);
4947 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4951 if (session
->kernel_session
) {
4952 cmd_ret
= kernel_rotate_session(session
);
4953 if (cmd_ret
!= LTTNG_OK
) {
4954 failed_to_rotate
= true;
4955 rotation_fail_code
= cmd_ret
;
4958 if (session
->ust_session
) {
4959 cmd_ret
= ust_app_rotate_session(session
);
4960 if (cmd_ret
!= LTTNG_OK
) {
4961 failed_to_rotate
= true;
4962 rotation_fail_code
= cmd_ret
;
4966 if (!session
->active
) {
4967 session
->rotated_after_last_stop
= true;
4970 if (!chunk_being_archived
) {
4971 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
4973 if (failed_to_rotate
) {
4974 cmd_ret
= rotation_fail_code
;
4981 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4982 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
4983 &ongoing_rotation_chunk_id
);
4984 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4986 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
4989 &((enum lttng_trace_chunk_command_type
){
4990 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
}),
4991 session
->last_chunk_path
);
4993 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4997 if (failed_to_rotate
) {
4998 cmd_ret
= rotation_fail_code
;
5002 session
->quiet_rotation
= quiet_rotation
;
5003 ret
= timer_session_rotation_pending_check_start(session
,
5004 DEFAULT_ROTATE_PENDING_TIMER
);
5006 cmd_ret
= LTTNG_ERR_UNK
;
5010 if (rotate_return
) {
5011 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5014 session
->chunk_being_archived
= chunk_being_archived
;
5015 chunk_being_archived
= NULL
;
5016 if (!quiet_rotation
) {
5017 ret
= notification_thread_command_session_rotation_ongoing(
5018 notification_thread_handle
,
5019 session
->name
, session
->uid
, session
->gid
,
5020 ongoing_rotation_chunk_id
);
5021 if (ret
!= LTTNG_OK
) {
5022 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5028 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5029 session
->name
, ongoing_rotation_chunk_id
);
5031 lttng_trace_chunk_put(new_trace_chunk
);
5032 lttng_trace_chunk_put(chunk_being_archived
);
5033 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5036 if (session_reset_rotation_state(session
,
5037 LTTNG_ROTATION_STATE_ERROR
)) {
5038 ERR("Failed to reset rotation state of session \"%s\"",
5045 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5047 * Check if the session has finished its rotation.
5049 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5051 int cmd_rotate_get_info(struct ltt_session
*session
,
5052 struct lttng_rotation_get_info_return
*info_return
,
5053 uint64_t rotation_id
)
5055 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5056 enum lttng_rotation_state rotation_state
;
5058 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5059 session
->most_recent_chunk_id
.value
);
5061 if (session
->chunk_being_archived
) {
5062 enum lttng_trace_chunk_status chunk_status
;
5065 chunk_status
= lttng_trace_chunk_get_id(
5066 session
->chunk_being_archived
,
5068 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5070 rotation_state
= rotation_id
== chunk_id
?
5071 LTTNG_ROTATION_STATE_ONGOING
:
5072 LTTNG_ROTATION_STATE_EXPIRED
;
5074 if (session
->last_archived_chunk_id
.is_set
&&
5075 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5076 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5078 rotation_state
= session
->rotation_state
;
5082 switch (rotation_state
) {
5083 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5084 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5087 case LTTNG_ROTATION_STATE_EXPIRED
:
5088 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5089 rotation_id
, session
->name
);
5091 case LTTNG_ROTATION_STATE_ONGOING
:
5092 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5093 rotation_id
, session
->name
);
5095 case LTTNG_ROTATION_STATE_COMPLETED
:
5099 char *current_tracing_path_reply
;
5100 size_t current_tracing_path_reply_len
;
5102 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5103 rotation_id
, session
->name
);
5105 switch (session_get_consumer_destination_type(session
)) {
5106 case CONSUMER_DST_LOCAL
:
5107 current_tracing_path_reply
=
5108 info_return
->location
.local
.absolute_path
;
5109 current_tracing_path_reply_len
=
5110 sizeof(info_return
->location
.local
.absolute_path
);
5111 info_return
->location_type
=
5112 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5113 fmt_ret
= asprintf(&chunk_path
,
5114 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5115 session_get_base_path(session
),
5116 session
->last_archived_chunk_name
);
5117 if (fmt_ret
== -1) {
5118 PERROR("Failed to format the path of the last archived trace chunk");
5119 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5120 cmd_ret
= LTTNG_ERR_UNK
;
5124 case CONSUMER_DST_NET
:
5126 uint16_t ctrl_port
, data_port
;
5128 current_tracing_path_reply
=
5129 info_return
->location
.relay
.relative_path
;
5130 current_tracing_path_reply_len
=
5131 sizeof(info_return
->location
.relay
.relative_path
);
5132 /* Currently the only supported relay protocol. */
5133 info_return
->location
.relay
.protocol
=
5134 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5136 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5137 session_get_net_consumer_hostname(session
),
5138 sizeof(info_return
->location
.relay
.host
));
5140 ERR("Failed to copy host name to rotate_get_info reply");
5141 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5142 cmd_ret
= LTTNG_ERR_SET_URL
;
5146 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5147 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5148 info_return
->location
.relay
.ports
.data
= data_port
;
5149 info_return
->location_type
=
5150 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5151 chunk_path
= strdup(session
->last_chunk_path
);
5153 ERR("Failed to allocate the path of the last archived trace chunk");
5154 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5155 cmd_ret
= LTTNG_ERR_UNK
;
5164 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5165 chunk_path
, current_tracing_path_reply_len
);
5168 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5169 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5170 cmd_ret
= LTTNG_ERR_UNK
;
5176 case LTTNG_ROTATION_STATE_ERROR
:
5177 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5178 rotation_id
, session
->name
);
5186 info_return
->status
= (int32_t) rotation_state
;
5191 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5193 * Configure the automatic rotation parameters.
5194 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5195 * 'activate' to false means deactivate the rotation schedule and validate that
5196 * 'new_value' has the same value as the currently active value.
5198 * Return 0 on success or else a positive LTTNG_ERR code.
5200 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5201 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5203 struct notification_thread_handle
*notification_thread_handle
)
5206 uint64_t *parameter_value
;
5210 DBG("Cmd rotate set schedule session %s", session
->name
);
5212 if (session
->live_timer
|| !session
->output_traces
) {
5213 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5214 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5218 switch (schedule_type
) {
5219 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5220 parameter_value
= &session
->rotate_size
;
5222 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5223 parameter_value
= &session
->rotate_timer_period
;
5224 if (new_value
>= UINT_MAX
) {
5225 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5226 new_value
, UINT_MAX
);
5227 ret
= LTTNG_ERR_INVALID
;
5232 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5233 ret
= LTTNG_ERR_INVALID
;
5237 /* Improper use of the API. */
5238 if (new_value
== -1ULL) {
5239 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5240 ret
= LTTNG_ERR_INVALID
;
5245 * As indicated in struct ltt_session's comments, a value of == 0 means
5246 * this schedule rotation type is not in use.
5248 * Reject the command if we were asked to activate a schedule that was
5251 if (activate
&& *parameter_value
!= 0) {
5252 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5253 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5258 * Reject the command if we were asked to deactivate a schedule that was
5261 if (!activate
&& *parameter_value
== 0) {
5262 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5263 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5268 * Reject the command if we were asked to deactivate a schedule that
5271 if (!activate
&& *parameter_value
!= new_value
) {
5272 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5273 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5277 *parameter_value
= activate
? new_value
: 0;
5279 switch (schedule_type
) {
5280 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5281 if (activate
&& session
->active
) {
5283 * Only start the timer if the session is active,
5284 * otherwise it will be started when the session starts.
5286 ret
= timer_session_rotation_schedule_timer_start(
5287 session
, new_value
);
5289 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5290 ret
= LTTNG_ERR_UNK
;
5294 ret
= timer_session_rotation_schedule_timer_stop(
5297 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5298 ret
= LTTNG_ERR_UNK
;
5303 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5305 ret
= subscribe_session_consumed_size_rotation(session
,
5306 new_value
, notification_thread_handle
);
5308 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5309 ret
= LTTNG_ERR_UNK
;
5313 ret
= unsubscribe_session_consumed_size_rotation(session
,
5314 notification_thread_handle
);
5316 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5317 ret
= LTTNG_ERR_UNK
;
5324 /* Would have been caught before. */
5336 /* Wait for a given path to be removed before continuing. */
5337 static enum lttng_error_code
wait_on_path(void *path_data
)
5339 const char *shm_path
= path_data
;
5341 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5347 ret
= stat(shm_path
, &st
);
5349 if (errno
!= ENOENT
) {
5350 PERROR("stat() returned an error while checking for the existence of the shm path");
5352 DBG("shm path no longer exists, completing the destruction of session");
5356 if (!S_ISDIR(st
.st_mode
)) {
5357 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5362 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5368 * Returns a pointer to a handler to run on completion of a command.
5369 * Returns NULL if no handler has to be run for the last command executed.
5371 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5373 struct cmd_completion_handler
*handler
= current_completion_handler
;
5375 current_completion_handler
= NULL
;
5380 * Init command subsystem.
5385 * Set network sequence index to 1 for streams to match a relayd
5386 * socket on the consumer side.
5388 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5389 relayd_net_seq_idx
= 1;
5390 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5392 DBG("Command subsystem initialized");