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
);
1189 if (session
->current_trace_chunk
) {
1190 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1191 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1193 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1194 current_chunk_id
.is_set
= true;
1196 ERR("Failed to get current trace chunk id");
1197 ret
= LTTNG_ERR_UNK
;
1202 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1203 && usess
->consumer
->enabled
) {
1204 /* For each consumer socket, send relayd sockets */
1205 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1206 socket
, node
.node
) {
1207 pthread_mutex_lock(socket
->lock
);
1208 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1209 usess
->consumer
, socket
,
1210 session
->name
, session
->hostname
,
1212 session
->live_timer
,
1213 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1214 session
->creation_time
,
1215 session
->name_contains_creation_time
);
1216 pthread_mutex_unlock(socket
->lock
);
1217 if (ret
!= LTTNG_OK
) {
1220 /* Session is now ready for network streaming. */
1221 session
->net_handle
= 1;
1223 session
->consumer
->relay_major_version
=
1224 usess
->consumer
->relay_major_version
;
1225 session
->consumer
->relay_minor_version
=
1226 usess
->consumer
->relay_minor_version
;
1229 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1230 && ksess
->consumer
->enabled
) {
1231 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1232 socket
, node
.node
) {
1233 pthread_mutex_lock(socket
->lock
);
1234 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1235 ksess
->consumer
, socket
,
1236 session
->name
, session
->hostname
,
1238 session
->live_timer
,
1239 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1240 session
->creation_time
,
1241 session
->name_contains_creation_time
);
1242 pthread_mutex_unlock(socket
->lock
);
1243 if (ret
!= LTTNG_OK
) {
1246 /* Session is now ready for network streaming. */
1247 session
->net_handle
= 1;
1249 session
->consumer
->relay_major_version
=
1250 ksess
->consumer
->relay_major_version
;
1251 session
->consumer
->relay_minor_version
=
1252 ksess
->consumer
->relay_minor_version
;
1261 * Start a kernel session by opening all necessary streams.
1263 static int start_kernel_session(struct ltt_kernel_session
*ksess
)
1266 struct ltt_kernel_channel
*kchan
;
1268 /* Open kernel metadata */
1269 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1270 ret
= kernel_open_metadata(ksess
);
1272 ret
= LTTNG_ERR_KERN_META_FAIL
;
1277 /* Open kernel metadata stream */
1278 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1279 ret
= kernel_open_metadata_stream(ksess
);
1281 ERR("Kernel create metadata stream failed");
1282 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1287 /* For each channel */
1288 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1289 if (kchan
->stream_count
== 0) {
1290 ret
= kernel_open_channel_stream(kchan
);
1292 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1295 /* Update the stream global counter */
1296 ksess
->stream_count_global
+= ret
;
1300 /* Setup kernel consumer socket and send fds to it */
1301 ret
= init_kernel_tracing(ksess
);
1303 ret
= LTTNG_ERR_KERN_START_FAIL
;
1307 /* This start the kernel tracing */
1308 ret
= kernel_start_session(ksess
);
1310 ret
= LTTNG_ERR_KERN_START_FAIL
;
1314 /* Quiescent wait after starting trace */
1315 kernel_wait_quiescent();
1326 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1328 int cmd_disable_channel(struct ltt_session
*session
,
1329 enum lttng_domain_type domain
, char *channel_name
)
1332 struct ltt_ust_session
*usess
;
1334 usess
= session
->ust_session
;
1339 case LTTNG_DOMAIN_KERNEL
:
1341 ret
= channel_kernel_disable(session
->kernel_session
,
1343 if (ret
!= LTTNG_OK
) {
1347 kernel_wait_quiescent();
1350 case LTTNG_DOMAIN_UST
:
1352 struct ltt_ust_channel
*uchan
;
1353 struct lttng_ht
*chan_ht
;
1355 chan_ht
= usess
->domain_global
.channels
;
1357 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1358 if (uchan
== NULL
) {
1359 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1363 ret
= channel_ust_disable(usess
, uchan
);
1364 if (ret
!= LTTNG_OK
) {
1370 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1382 * Command LTTNG_TRACK_PID processed by the client thread.
1384 * Called with session lock held.
1386 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1394 case LTTNG_DOMAIN_KERNEL
:
1396 struct ltt_kernel_session
*ksess
;
1398 ksess
= session
->kernel_session
;
1400 ret
= kernel_track_pid(ksess
, pid
);
1401 if (ret
!= LTTNG_OK
) {
1405 kernel_wait_quiescent();
1408 case LTTNG_DOMAIN_UST
:
1410 struct ltt_ust_session
*usess
;
1412 usess
= session
->ust_session
;
1414 ret
= trace_ust_track_pid(usess
, pid
);
1415 if (ret
!= LTTNG_OK
) {
1421 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1433 * Command LTTNG_UNTRACK_PID processed by the client thread.
1435 * Called with session lock held.
1437 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1445 case LTTNG_DOMAIN_KERNEL
:
1447 struct ltt_kernel_session
*ksess
;
1449 ksess
= session
->kernel_session
;
1451 ret
= kernel_untrack_pid(ksess
, pid
);
1452 if (ret
!= LTTNG_OK
) {
1456 kernel_wait_quiescent();
1459 case LTTNG_DOMAIN_UST
:
1461 struct ltt_ust_session
*usess
;
1463 usess
= session
->ust_session
;
1465 ret
= trace_ust_untrack_pid(usess
, pid
);
1466 if (ret
!= LTTNG_OK
) {
1472 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1484 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1486 * The wpipe arguments is used as a notifier for the kernel thread.
1488 int cmd_enable_channel(struct ltt_session
*session
,
1489 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1492 struct ltt_ust_session
*usess
= session
->ust_session
;
1493 struct lttng_ht
*chan_ht
;
1495 struct lttng_channel attr
;
1502 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1504 /* Validate channel name */
1505 if (attr
.name
[0] == '.' ||
1506 memchr(attr
.name
, '/', len
) != NULL
) {
1507 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1511 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1516 * Don't try to enable a channel if the session has been started at
1517 * some point in time before. The tracer does not allow it.
1519 if (session
->has_been_started
) {
1520 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1525 * If the session is a live session, remove the switch timer, the
1526 * live timer does the same thing but sends also synchronisation
1527 * beacons for inactive streams.
1529 if (session
->live_timer
> 0) {
1530 attr
.attr
.live_timer_interval
= session
->live_timer
;
1531 attr
.attr
.switch_timer_interval
= 0;
1534 /* Check for feature support */
1535 switch (domain
->type
) {
1536 case LTTNG_DOMAIN_KERNEL
:
1538 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1539 /* Sampling position of buffer is not supported */
1540 WARN("Kernel tracer does not support buffer monitoring. "
1541 "Setting the monitor interval timer to 0 "
1542 "(disabled) for channel '%s' of session '%s'",
1543 attr
.name
, session
->name
);
1544 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1548 case LTTNG_DOMAIN_UST
:
1550 case LTTNG_DOMAIN_JUL
:
1551 case LTTNG_DOMAIN_LOG4J
:
1552 case LTTNG_DOMAIN_PYTHON
:
1553 if (!agent_tracing_is_enabled()) {
1554 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1555 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1560 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1564 switch (domain
->type
) {
1565 case LTTNG_DOMAIN_KERNEL
:
1567 struct ltt_kernel_channel
*kchan
;
1569 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1570 session
->kernel_session
);
1571 if (kchan
== NULL
) {
1572 if (session
->snapshot
.nb_output
> 0 ||
1573 session
->snapshot_mode
) {
1574 /* Enforce mmap output for snapshot sessions. */
1575 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1577 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1578 if (attr
.name
[0] != '\0') {
1579 session
->kernel_session
->has_non_default_channel
= 1;
1582 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1585 if (ret
!= LTTNG_OK
) {
1589 kernel_wait_quiescent();
1592 case LTTNG_DOMAIN_UST
:
1593 case LTTNG_DOMAIN_JUL
:
1594 case LTTNG_DOMAIN_LOG4J
:
1595 case LTTNG_DOMAIN_PYTHON
:
1597 struct ltt_ust_channel
*uchan
;
1602 * Current agent implementation limitations force us to allow
1603 * only one channel at once in "agent" subdomains. Each
1604 * subdomain has a default channel name which must be strictly
1607 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1608 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1609 LTTNG_SYMBOL_NAME_LEN
)) {
1610 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1613 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1614 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1615 LTTNG_SYMBOL_NAME_LEN
)) {
1616 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1619 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1620 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1621 LTTNG_SYMBOL_NAME_LEN
)) {
1622 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1627 chan_ht
= usess
->domain_global
.channels
;
1629 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1630 if (uchan
== NULL
) {
1631 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1632 if (attr
.name
[0] != '\0') {
1633 usess
->has_non_default_channel
= 1;
1636 ret
= channel_ust_enable(usess
, uchan
);
1641 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1645 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1646 session
->has_non_mmap_channel
= true;
1655 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1657 int cmd_disable_event(struct ltt_session
*session
,
1658 enum lttng_domain_type domain
, const char *channel_name
,
1659 const struct lttng_event
*event
)
1662 const char *event_name
;
1664 DBG("Disable event command for event \'%s\'", event
->name
);
1666 event_name
= event
->name
;
1668 /* Error out on unhandled search criteria */
1669 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1670 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1671 ret
= LTTNG_ERR_UNK
;
1678 case LTTNG_DOMAIN_KERNEL
:
1680 struct ltt_kernel_channel
*kchan
;
1681 struct ltt_kernel_session
*ksess
;
1683 ksess
= session
->kernel_session
;
1686 * If a non-default channel has been created in the
1687 * session, explicitely require that -c chan_name needs
1690 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1691 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1695 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1696 if (kchan
== NULL
) {
1697 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1701 switch (event
->type
) {
1702 case LTTNG_EVENT_ALL
:
1703 case LTTNG_EVENT_TRACEPOINT
:
1704 case LTTNG_EVENT_SYSCALL
:
1705 case LTTNG_EVENT_PROBE
:
1706 case LTTNG_EVENT_FUNCTION
:
1707 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1708 if (event_name
[0] == '\0') {
1709 ret
= event_kernel_disable_event(kchan
,
1712 ret
= event_kernel_disable_event(kchan
,
1713 event_name
, event
->type
);
1715 if (ret
!= LTTNG_OK
) {
1720 ret
= LTTNG_ERR_UNK
;
1724 kernel_wait_quiescent();
1727 case LTTNG_DOMAIN_UST
:
1729 struct ltt_ust_channel
*uchan
;
1730 struct ltt_ust_session
*usess
;
1732 usess
= session
->ust_session
;
1734 if (validate_ust_event_name(event_name
)) {
1735 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1740 * If a non-default channel has been created in the
1741 * session, explicitly require that -c chan_name needs
1744 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1745 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1749 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1751 if (uchan
== NULL
) {
1752 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1756 switch (event
->type
) {
1757 case LTTNG_EVENT_ALL
:
1759 * An empty event name means that everything
1760 * should be disabled.
1762 if (event
->name
[0] == '\0') {
1763 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1765 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1768 if (ret
!= LTTNG_OK
) {
1773 ret
= LTTNG_ERR_UNK
;
1777 DBG3("Disable UST event %s in channel %s completed", event_name
,
1781 case LTTNG_DOMAIN_LOG4J
:
1782 case LTTNG_DOMAIN_JUL
:
1783 case LTTNG_DOMAIN_PYTHON
:
1786 struct ltt_ust_session
*usess
= session
->ust_session
;
1790 switch (event
->type
) {
1791 case LTTNG_EVENT_ALL
:
1794 ret
= LTTNG_ERR_UNK
;
1798 agt
= trace_ust_find_agent(usess
, domain
);
1800 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1804 * An empty event name means that everything
1805 * should be disabled.
1807 if (event
->name
[0] == '\0') {
1808 ret
= event_agent_disable_all(usess
, agt
);
1810 ret
= event_agent_disable(usess
, agt
, event_name
);
1812 if (ret
!= LTTNG_OK
) {
1819 ret
= LTTNG_ERR_UND
;
1832 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1834 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1835 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1837 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1838 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1841 * Don't try to add a context if the session has been started at
1842 * some point in time before. The tracer does not allow it and would
1843 * result in a corrupted trace.
1845 if (session
->has_been_started
) {
1846 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1850 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1851 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1852 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1856 case LTTNG_DOMAIN_KERNEL
:
1857 assert(session
->kernel_session
);
1859 if (session
->kernel_session
->channel_count
== 0) {
1860 /* Create default channel */
1861 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1862 if (ret
!= LTTNG_OK
) {
1865 chan_kern_created
= 1;
1867 /* Add kernel context to kernel tracer */
1868 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1869 if (ret
!= LTTNG_OK
) {
1873 case LTTNG_DOMAIN_JUL
:
1874 case LTTNG_DOMAIN_LOG4J
:
1877 * Validate channel name.
1878 * If no channel name is given and the domain is JUL or LOG4J,
1879 * set it to the appropriate domain-specific channel name. If
1880 * a name is provided but does not match the expexted channel
1881 * name, return an error.
1883 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1884 strcmp(channel_name
,
1885 DEFAULT_JUL_CHANNEL_NAME
)) {
1886 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1888 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1889 strcmp(channel_name
,
1890 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1891 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1894 /* break is _not_ missing here. */
1896 case LTTNG_DOMAIN_UST
:
1898 struct ltt_ust_session
*usess
= session
->ust_session
;
1899 unsigned int chan_count
;
1903 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1904 if (chan_count
== 0) {
1905 struct lttng_channel
*attr
;
1906 /* Create default channel */
1907 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1909 ret
= LTTNG_ERR_FATAL
;
1913 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1914 if (ret
!= LTTNG_OK
) {
1918 channel_attr_destroy(attr
);
1919 chan_ust_created
= 1;
1922 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1923 free(app_ctx_provider_name
);
1925 app_ctx_name
= NULL
;
1926 app_ctx_provider_name
= NULL
;
1927 if (ret
!= LTTNG_OK
) {
1933 ret
= LTTNG_ERR_UND
;
1941 if (chan_kern_created
) {
1942 struct ltt_kernel_channel
*kchan
=
1943 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1944 session
->kernel_session
);
1945 /* Created previously, this should NOT fail. */
1947 kernel_destroy_channel(kchan
);
1950 if (chan_ust_created
) {
1951 struct ltt_ust_channel
*uchan
=
1952 trace_ust_find_channel_by_name(
1953 session
->ust_session
->domain_global
.channels
,
1954 DEFAULT_CHANNEL_NAME
);
1955 /* Created previously, this should NOT fail. */
1957 /* Remove from the channel list of the session. */
1958 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1960 trace_ust_destroy_channel(uchan
);
1963 free(app_ctx_provider_name
);
1968 static inline bool name_starts_with(const char *name
, const char *prefix
)
1970 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1972 return !strncmp(name
, prefix
, max_cmp_len
);
1975 /* Perform userspace-specific event name validation */
1976 static int validate_ust_event_name(const char *name
)
1986 * Check name against all internal UST event component namespaces used
1989 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1990 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1991 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2000 * Internal version of cmd_enable_event() with a supplemental
2001 * "internal_event" flag which is used to enable internal events which should
2002 * be hidden from clients. Such events are used in the agent implementation to
2003 * enable the events through which all "agent" events are funeled.
2005 static int _cmd_enable_event(struct ltt_session
*session
,
2006 const struct lttng_domain
*domain
,
2007 char *channel_name
, struct lttng_event
*event
,
2008 char *filter_expression
,
2009 struct lttng_filter_bytecode
*filter
,
2010 struct lttng_event_exclusion
*exclusion
,
2011 int wpipe
, bool internal_event
)
2013 int ret
= 0, channel_created
= 0;
2014 struct lttng_channel
*attr
= NULL
;
2018 assert(channel_name
);
2020 /* If we have a filter, we must have its filter expression */
2021 assert(!(!!filter_expression
^ !!filter
));
2023 /* Normalize event name as a globbing pattern */
2024 strutils_normalize_star_glob_pattern(event
->name
);
2026 /* Normalize exclusion names as globbing patterns */
2030 for (i
= 0; i
< exclusion
->count
; i
++) {
2031 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2033 strutils_normalize_star_glob_pattern(name
);
2037 DBG("Enable event command for event \'%s\'", event
->name
);
2041 switch (domain
->type
) {
2042 case LTTNG_DOMAIN_KERNEL
:
2044 struct ltt_kernel_channel
*kchan
;
2047 * If a non-default channel has been created in the
2048 * session, explicitely require that -c chan_name needs
2051 if (session
->kernel_session
->has_non_default_channel
2052 && channel_name
[0] == '\0') {
2053 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2057 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2058 session
->kernel_session
);
2059 if (kchan
== NULL
) {
2060 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2061 LTTNG_BUFFER_GLOBAL
);
2063 ret
= LTTNG_ERR_FATAL
;
2066 if (lttng_strncpy(attr
->name
, channel_name
,
2067 sizeof(attr
->name
))) {
2068 ret
= LTTNG_ERR_INVALID
;
2072 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2073 if (ret
!= LTTNG_OK
) {
2076 channel_created
= 1;
2079 /* Get the newly created kernel channel pointer */
2080 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2081 session
->kernel_session
);
2082 if (kchan
== NULL
) {
2083 /* This sould not happen... */
2084 ret
= LTTNG_ERR_FATAL
;
2088 switch (event
->type
) {
2089 case LTTNG_EVENT_ALL
:
2091 char *filter_expression_a
= NULL
;
2092 struct lttng_filter_bytecode
*filter_a
= NULL
;
2095 * We need to duplicate filter_expression and filter,
2096 * because ownership is passed to first enable
2099 if (filter_expression
) {
2100 filter_expression_a
= strdup(filter_expression
);
2101 if (!filter_expression_a
) {
2102 ret
= LTTNG_ERR_FATAL
;
2107 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2109 free(filter_expression_a
);
2110 ret
= LTTNG_ERR_FATAL
;
2113 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2115 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2116 ret
= event_kernel_enable_event(kchan
, event
,
2117 filter_expression
, filter
);
2118 /* We have passed ownership */
2119 filter_expression
= NULL
;
2121 if (ret
!= LTTNG_OK
) {
2122 if (channel_created
) {
2123 /* Let's not leak a useless channel. */
2124 kernel_destroy_channel(kchan
);
2126 free(filter_expression_a
);
2130 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2131 ret
= event_kernel_enable_event(kchan
, event
,
2132 filter_expression_a
, filter_a
);
2133 /* We have passed ownership */
2134 filter_expression_a
= NULL
;
2136 if (ret
!= LTTNG_OK
) {
2141 case LTTNG_EVENT_PROBE
:
2142 case LTTNG_EVENT_USERSPACE_PROBE
:
2143 case LTTNG_EVENT_FUNCTION
:
2144 case LTTNG_EVENT_FUNCTION_ENTRY
:
2145 case LTTNG_EVENT_TRACEPOINT
:
2146 ret
= event_kernel_enable_event(kchan
, event
,
2147 filter_expression
, filter
);
2148 /* We have passed ownership */
2149 filter_expression
= NULL
;
2151 if (ret
!= LTTNG_OK
) {
2152 if (channel_created
) {
2153 /* Let's not leak a useless channel. */
2154 kernel_destroy_channel(kchan
);
2159 case LTTNG_EVENT_SYSCALL
:
2160 ret
= event_kernel_enable_event(kchan
, event
,
2161 filter_expression
, filter
);
2162 /* We have passed ownership */
2163 filter_expression
= NULL
;
2165 if (ret
!= LTTNG_OK
) {
2170 ret
= LTTNG_ERR_UNK
;
2174 kernel_wait_quiescent();
2177 case LTTNG_DOMAIN_UST
:
2179 struct ltt_ust_channel
*uchan
;
2180 struct ltt_ust_session
*usess
= session
->ust_session
;
2185 * If a non-default channel has been created in the
2186 * session, explicitely require that -c chan_name needs
2189 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2190 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2194 /* Get channel from global UST domain */
2195 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2197 if (uchan
== NULL
) {
2198 /* Create default channel */
2199 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2200 usess
->buffer_type
);
2202 ret
= LTTNG_ERR_FATAL
;
2205 if (lttng_strncpy(attr
->name
, channel_name
,
2206 sizeof(attr
->name
))) {
2207 ret
= LTTNG_ERR_INVALID
;
2211 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2212 if (ret
!= LTTNG_OK
) {
2216 /* Get the newly created channel reference back */
2217 uchan
= trace_ust_find_channel_by_name(
2218 usess
->domain_global
.channels
, channel_name
);
2222 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2224 * Don't allow users to add UST events to channels which
2225 * are assigned to a userspace subdomain (JUL, Log4J,
2228 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2232 if (!internal_event
) {
2234 * Ensure the event name is not reserved for internal
2237 ret
= validate_ust_event_name(event
->name
);
2239 WARN("Userspace event name %s failed validation.",
2241 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2246 /* At this point, the session and channel exist on the tracer */
2247 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2248 filter_expression
, filter
, exclusion
,
2250 /* We have passed ownership */
2251 filter_expression
= NULL
;
2254 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2255 goto already_enabled
;
2256 } else if (ret
!= LTTNG_OK
) {
2261 case LTTNG_DOMAIN_LOG4J
:
2262 case LTTNG_DOMAIN_JUL
:
2263 case LTTNG_DOMAIN_PYTHON
:
2265 const char *default_event_name
, *default_chan_name
;
2267 struct lttng_event uevent
;
2268 struct lttng_domain tmp_dom
;
2269 struct ltt_ust_session
*usess
= session
->ust_session
;
2273 if (!agent_tracing_is_enabled()) {
2274 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2275 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2279 agt
= trace_ust_find_agent(usess
, domain
->type
);
2281 agt
= agent_create(domain
->type
);
2283 ret
= LTTNG_ERR_NOMEM
;
2286 agent_add(agt
, usess
->agents
);
2289 /* Create the default tracepoint. */
2290 memset(&uevent
, 0, sizeof(uevent
));
2291 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2292 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2293 default_event_name
= event_get_default_agent_ust_name(
2295 if (!default_event_name
) {
2296 ret
= LTTNG_ERR_FATAL
;
2299 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2300 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2303 * The domain type is changed because we are about to enable the
2304 * default channel and event for the JUL domain that are hardcoded.
2305 * This happens in the UST domain.
2307 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2308 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2310 switch (domain
->type
) {
2311 case LTTNG_DOMAIN_LOG4J
:
2312 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2314 case LTTNG_DOMAIN_JUL
:
2315 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2317 case LTTNG_DOMAIN_PYTHON
:
2318 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2321 /* The switch/case we are in makes this impossible */
2326 char *filter_expression_copy
= NULL
;
2327 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2330 const size_t filter_size
= sizeof(
2331 struct lttng_filter_bytecode
)
2334 filter_copy
= zmalloc(filter_size
);
2336 ret
= LTTNG_ERR_NOMEM
;
2339 memcpy(filter_copy
, filter
, filter_size
);
2341 filter_expression_copy
=
2342 strdup(filter_expression
);
2343 if (!filter_expression
) {
2344 ret
= LTTNG_ERR_NOMEM
;
2347 if (!filter_expression_copy
|| !filter_copy
) {
2348 free(filter_expression_copy
);
2354 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2355 (char *) default_chan_name
,
2356 &uevent
, filter_expression_copy
,
2357 filter_copy
, NULL
, wpipe
);
2360 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2361 goto already_enabled
;
2362 } else if (ret
!= LTTNG_OK
) {
2366 /* The wild card * means that everything should be enabled. */
2367 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2368 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2371 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2375 filter_expression
= NULL
;
2376 if (ret
!= LTTNG_OK
) {
2383 ret
= LTTNG_ERR_UND
;
2391 free(filter_expression
);
2394 channel_attr_destroy(attr
);
2400 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2401 * We own filter, exclusion, and filter_expression.
2403 int cmd_enable_event(struct ltt_session
*session
,
2404 const struct lttng_domain
*domain
,
2405 char *channel_name
, struct lttng_event
*event
,
2406 char *filter_expression
,
2407 struct lttng_filter_bytecode
*filter
,
2408 struct lttng_event_exclusion
*exclusion
,
2411 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2412 filter_expression
, filter
, exclusion
, wpipe
, false);
2416 * Enable an event which is internal to LTTng. An internal should
2417 * never be made visible to clients and are immune to checks such as
2420 static int cmd_enable_event_internal(struct ltt_session
*session
,
2421 const struct lttng_domain
*domain
,
2422 char *channel_name
, struct lttng_event
*event
,
2423 char *filter_expression
,
2424 struct lttng_filter_bytecode
*filter
,
2425 struct lttng_event_exclusion
*exclusion
,
2428 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2429 filter_expression
, filter
, exclusion
, wpipe
, true);
2433 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2435 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2436 struct lttng_event
**events
)
2439 ssize_t nb_events
= 0;
2442 case LTTNG_DOMAIN_KERNEL
:
2443 nb_events
= kernel_list_events(events
);
2444 if (nb_events
< 0) {
2445 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2449 case LTTNG_DOMAIN_UST
:
2450 nb_events
= ust_app_list_events(events
);
2451 if (nb_events
< 0) {
2452 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2456 case LTTNG_DOMAIN_LOG4J
:
2457 case LTTNG_DOMAIN_JUL
:
2458 case LTTNG_DOMAIN_PYTHON
:
2459 nb_events
= agent_list_events(events
, domain
);
2460 if (nb_events
< 0) {
2461 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2466 ret
= LTTNG_ERR_UND
;
2473 /* Return negative value to differentiate return code */
2478 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2480 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2481 struct lttng_event_field
**fields
)
2484 ssize_t nb_fields
= 0;
2487 case LTTNG_DOMAIN_UST
:
2488 nb_fields
= ust_app_list_event_fields(fields
);
2489 if (nb_fields
< 0) {
2490 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2494 case LTTNG_DOMAIN_KERNEL
:
2495 default: /* fall-through */
2496 ret
= LTTNG_ERR_UND
;
2503 /* Return negative value to differentiate return code */
2507 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2509 return syscall_table_list(events
);
2513 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2515 * Called with session lock held.
2517 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2518 enum lttng_domain_type domain
, int32_t **pids
)
2521 ssize_t nr_pids
= 0;
2524 case LTTNG_DOMAIN_KERNEL
:
2526 struct ltt_kernel_session
*ksess
;
2528 ksess
= session
->kernel_session
;
2529 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2531 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2536 case LTTNG_DOMAIN_UST
:
2538 struct ltt_ust_session
*usess
;
2540 usess
= session
->ust_session
;
2541 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2543 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2548 case LTTNG_DOMAIN_LOG4J
:
2549 case LTTNG_DOMAIN_JUL
:
2550 case LTTNG_DOMAIN_PYTHON
:
2552 ret
= LTTNG_ERR_UND
;
2559 /* Return negative value to differentiate return code */
2564 * Command LTTNG_START_TRACE processed by the client thread.
2566 * Called with session mutex held.
2568 int cmd_start_trace(struct ltt_session
*session
)
2570 enum lttng_error_code ret
;
2571 unsigned long nb_chan
= 0;
2572 struct ltt_kernel_session
*ksession
;
2573 struct ltt_ust_session
*usess
;
2574 const bool session_rotated_after_last_stop
=
2575 session
->rotated_after_last_stop
;
2579 /* Ease our life a bit ;) */
2580 ksession
= session
->kernel_session
;
2581 usess
= session
->ust_session
;
2583 /* Is the session already started? */
2584 if (session
->active
) {
2585 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2589 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2590 !session
->current_trace_chunk
) {
2592 * A rotation was launched while the session was stopped and
2593 * it has not been completed yet. It is not possible to start
2594 * the session since starting the session here would require a
2595 * rotation from "NULL" to a new trace chunk. That rotation
2596 * would overlap with the ongoing rotation, which is not
2599 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2601 ret
= LTTNG_ERR_ROTATION_PENDING
;
2606 * Starting a session without channel is useless since after that it's not
2607 * possible to enable channel thus inform the client.
2609 if (usess
&& usess
->domain_global
.channels
) {
2610 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2613 nb_chan
+= ksession
->channel_count
;
2616 ret
= LTTNG_ERR_NO_CHANNEL
;
2620 session
->active
= 1;
2621 session
->rotated_after_last_stop
= false;
2622 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2623 if (!session
->has_been_started
) {
2624 struct lttng_trace_chunk
*trace_chunk
;
2626 DBG("Creating initial trace chunk of session \"%s\"",
2628 trace_chunk
= session_create_new_trace_chunk(
2629 session
, NULL
, NULL
, NULL
);
2631 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2634 assert(!session
->current_trace_chunk
);
2635 ret
= session_set_trace_chunk(session
, trace_chunk
,
2637 lttng_trace_chunk_put(trace_chunk
);
2639 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2643 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2646 * Rotate existing streams into the new chunk.
2647 * This is a "quiet" rotation has no client has
2648 * explicitly requested this operation.
2650 * There is also no need to wait for the rotation
2651 * to complete as it will happen immediately. No data
2652 * was produced as the session was stopped, so the
2653 * rotation should happen on reception of the command.
2655 ret
= cmd_rotate_session(session
, NULL
, true);
2656 if (ret
!= LTTNG_OK
) {
2662 /* Kernel tracing */
2663 if (ksession
!= NULL
) {
2664 DBG("Start kernel tracing session %s", session
->name
);
2665 ret
= start_kernel_session(ksession
);
2666 if (ret
!= LTTNG_OK
) {
2671 /* Flag session that trace should start automatically */
2673 int int_ret
= ust_app_start_trace_all(usess
);
2676 ret
= LTTNG_ERR_UST_START_FAIL
;
2682 * Clear the flag that indicates that a rotation was done while the
2683 * session was stopped.
2685 session
->rotated_after_last_stop
= false;
2687 if (session
->rotate_timer_period
) {
2688 int int_ret
= timer_session_rotation_schedule_timer_start(
2689 session
, session
->rotate_timer_period
);
2692 ERR("Failed to enable rotate timer");
2693 ret
= LTTNG_ERR_UNK
;
2701 if (ret
== LTTNG_OK
) {
2702 /* Flag this after a successful start. */
2703 session
->has_been_started
|= 1;
2705 session
->active
= 0;
2706 /* Restore initial state on error. */
2707 session
->rotated_after_last_stop
=
2708 session_rotated_after_last_stop
;
2714 * Command LTTNG_STOP_TRACE processed by the client thread.
2716 int cmd_stop_trace(struct ltt_session
*session
)
2719 struct ltt_kernel_channel
*kchan
;
2720 struct ltt_kernel_session
*ksession
;
2721 struct ltt_ust_session
*usess
;
2722 bool error_occurred
= false;
2726 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2728 ksession
= session
->kernel_session
;
2729 usess
= session
->ust_session
;
2731 /* Session is not active. Skip everythong and inform the client. */
2732 if (!session
->active
) {
2733 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2738 if (ksession
&& ksession
->active
) {
2739 DBG("Stop kernel tracing");
2741 ret
= kernel_stop_session(ksession
);
2743 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2747 kernel_wait_quiescent();
2749 /* Flush metadata after stopping (if exists) */
2750 if (ksession
->metadata_stream_fd
>= 0) {
2751 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2753 ERR("Kernel metadata flush failed");
2754 error_occurred
= true;
2758 /* Flush all buffers after stopping */
2759 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2760 ret
= kernel_flush_buffer(kchan
);
2762 ERR("Kernel flush buffer error");
2763 error_occurred
= true;
2767 ksession
->active
= 0;
2768 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2772 if (usess
&& usess
->active
) {
2773 ret
= ust_app_stop_trace_all(usess
);
2775 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2780 /* Flag inactive after a successful stop. */
2781 session
->active
= 0;
2782 ret
= !error_occurred
? LTTNG_OK
: LTTNG_ERR_UNK
;
2789 * Set the base_path of the session only if subdir of a control uris is set.
2790 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2792 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2794 struct lttng_uri
*uris
)
2799 for (i
= 0; i
< nb_uri
; i
++) {
2800 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2801 uris
[i
].subdir
[0] == '\0') {
2802 /* Not interested in these URIs */
2806 if (session
->base_path
!= NULL
) {
2807 free(session
->base_path
);
2808 session
->base_path
= NULL
;
2811 /* Set session base_path */
2812 session
->base_path
= strdup(uris
[i
].subdir
);
2813 if (!session
->base_path
) {
2814 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2815 uris
[i
].subdir
, session
->name
);
2816 ret
= LTTNG_ERR_NOMEM
;
2819 DBG2("Setting base path \"%s\" for session \"%s\"",
2820 session
->base_path
, session
->name
);
2828 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2830 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2831 struct lttng_uri
*uris
)
2834 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2835 struct ltt_ust_session
*usess
= session
->ust_session
;
2841 /* Can't set consumer URI if the session is active. */
2842 if (session
->active
) {
2843 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2848 * Set the session base path if any. This is done inside
2849 * cmd_set_consumer_uri to preserve backward compatibility of the
2850 * previous session creation api vs the session descriptor api.
2852 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2853 if (ret
!= LTTNG_OK
) {
2857 /* Set the "global" consumer URIs */
2858 for (i
= 0; i
< nb_uri
; i
++) {
2859 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2861 if (ret
!= LTTNG_OK
) {
2866 /* Set UST session URIs */
2867 if (session
->ust_session
) {
2868 for (i
= 0; i
< nb_uri
; i
++) {
2869 ret
= add_uri_to_consumer(session
,
2870 session
->ust_session
->consumer
,
2871 &uris
[i
], LTTNG_DOMAIN_UST
);
2872 if (ret
!= LTTNG_OK
) {
2878 /* Set kernel session URIs */
2879 if (session
->kernel_session
) {
2880 for (i
= 0; i
< nb_uri
; i
++) {
2881 ret
= add_uri_to_consumer(session
,
2882 session
->kernel_session
->consumer
,
2883 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2884 if (ret
!= LTTNG_OK
) {
2891 * Make sure to set the session in output mode after we set URI since a
2892 * session can be created without URL (thus flagged in no output mode).
2894 session
->output_traces
= 1;
2896 ksess
->output_traces
= 1;
2900 usess
->output_traces
= 1;
2911 enum lttng_error_code
set_session_output_from_descriptor(
2912 struct ltt_session
*session
,
2913 const struct lttng_session_descriptor
*descriptor
)
2916 enum lttng_error_code ret_code
= LTTNG_OK
;
2917 enum lttng_session_descriptor_type session_type
=
2918 lttng_session_descriptor_get_type(descriptor
);
2919 enum lttng_session_descriptor_output_type output_type
=
2920 lttng_session_descriptor_get_output_type(descriptor
);
2921 struct lttng_uri uris
[2] = {};
2922 size_t uri_count
= 0;
2924 switch (output_type
) {
2925 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2927 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2928 lttng_session_descriptor_get_local_output_uri(descriptor
,
2932 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2933 lttng_session_descriptor_get_network_output_uris(descriptor
,
2934 &uris
[0], &uris
[1]);
2938 ret_code
= LTTNG_ERR_INVALID
;
2942 switch (session_type
) {
2943 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2945 struct snapshot_output
*new_output
= NULL
;
2947 new_output
= snapshot_output_alloc();
2949 ret_code
= LTTNG_ERR_NOMEM
;
2953 ret
= snapshot_output_init_with_uri(session
,
2954 DEFAULT_SNAPSHOT_MAX_SIZE
,
2955 NULL
, uris
, uri_count
, session
->consumer
,
2956 new_output
, &session
->snapshot
);
2958 ret_code
= (ret
== -ENOMEM
) ?
2959 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2960 snapshot_output_destroy(new_output
);
2963 snapshot_add_output(&session
->snapshot
, new_output
);
2966 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2967 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2969 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2973 ret_code
= LTTNG_ERR_INVALID
;
2981 enum lttng_error_code
cmd_create_session_from_descriptor(
2982 struct lttng_session_descriptor
*descriptor
,
2983 const lttng_sock_cred
*creds
,
2984 const char *home_path
)
2987 enum lttng_error_code ret_code
;
2988 const char *session_name
;
2989 struct ltt_session
*new_session
= NULL
;
2990 enum lttng_session_descriptor_status descriptor_status
;
2992 session_lock_list();
2994 if (*home_path
!= '/') {
2995 ERR("Home path provided by client is not absolute");
2996 ret_code
= LTTNG_ERR_INVALID
;
3001 descriptor_status
= lttng_session_descriptor_get_session_name(
3002 descriptor
, &session_name
);
3003 switch (descriptor_status
) {
3004 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3006 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3007 session_name
= NULL
;
3010 ret_code
= LTTNG_ERR_INVALID
;
3014 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3016 if (ret_code
!= LTTNG_OK
) {
3020 if (!session_name
) {
3021 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3024 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3029 if (!lttng_session_descriptor_is_output_destination_initialized(
3032 * Only include the session's creation time in the output
3033 * destination if the name of the session itself was
3034 * not auto-generated.
3036 ret_code
= lttng_session_descriptor_set_default_output(
3038 session_name
? &new_session
->creation_time
: NULL
,
3040 if (ret_code
!= LTTNG_OK
) {
3044 new_session
->has_user_specified_directory
=
3045 lttng_session_descriptor_has_output_directory(
3049 switch (lttng_session_descriptor_get_type(descriptor
)) {
3050 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3051 new_session
->snapshot_mode
= 1;
3053 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3054 new_session
->live_timer
=
3055 lttng_session_descriptor_live_get_timer_interval(
3062 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3063 if (ret_code
!= LTTNG_OK
) {
3066 new_session
->consumer
->enabled
= 1;
3067 ret_code
= LTTNG_OK
;
3069 /* Release reference provided by the session_create function. */
3070 session_put(new_session
);
3071 if (ret_code
!= LTTNG_OK
&& new_session
) {
3072 /* Release the global reference on error. */
3073 session_destroy(new_session
);
3075 session_unlock_list();
3079 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3080 struct lttng_session_descriptor
**return_descriptor
)
3083 size_t payload_size
;
3084 struct lttng_dynamic_buffer payload
;
3085 struct lttng_buffer_view home_dir_view
;
3086 struct lttng_buffer_view session_descriptor_view
;
3087 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3088 enum lttng_error_code ret_code
;
3090 lttng_dynamic_buffer_init(&payload
);
3091 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3093 ret_code
= LTTNG_ERR_INVALID
;
3096 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3097 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3098 ret_code
= LTTNG_ERR_INVALID
;
3102 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3103 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3104 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3106 ret_code
= LTTNG_ERR_NOMEM
;
3110 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3112 ERR("Reception of session descriptor failed, aborting.");
3113 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3117 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3120 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3121 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3123 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3124 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3126 ret
= lttng_session_descriptor_create_from_buffer(
3127 &session_descriptor_view
, &session_descriptor
);
3129 ERR("Failed to create session descriptor from payload of \"create session\" command");
3130 ret_code
= LTTNG_ERR_INVALID
;
3135 * Sets the descriptor's auto-generated properties (name, output) if
3138 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3140 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3141 if (ret_code
!= LTTNG_OK
) {
3145 ret_code
= LTTNG_OK
;
3146 *return_descriptor
= session_descriptor
;
3147 session_descriptor
= NULL
;
3149 lttng_dynamic_buffer_reset(&payload
);
3150 lttng_session_descriptor_destroy(session_descriptor
);
3155 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3156 void *_reply_context
)
3160 const struct cmd_destroy_session_reply_context
*reply_context
=
3162 struct lttng_dynamic_buffer payload
;
3163 struct lttcomm_session_destroy_command_header cmd_header
;
3164 struct lttng_trace_archive_location
*location
= NULL
;
3165 struct lttcomm_lttng_msg llm
= {
3166 .cmd_type
= LTTNG_DESTROY_SESSION
,
3167 .ret_code
= reply_context
->destruction_status
,
3170 sizeof(struct lttcomm_session_destroy_command_header
),
3173 size_t payload_size_before_location
;
3175 lttng_dynamic_buffer_init(&payload
);
3177 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3179 ERR("Failed to append session destruction message");
3183 cmd_header
.rotation_state
=
3184 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3185 session
->rotation_state
:
3186 LTTNG_ROTATION_STATE_NO_ROTATION
);
3187 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3188 sizeof(cmd_header
));
3190 ERR("Failed to append session destruction command header");
3194 if (!reply_context
->implicit_rotation_on_destroy
) {
3195 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3199 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3200 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3205 location
= session_get_trace_archive_location(session
);
3207 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3212 payload_size_before_location
= payload
.size
;
3213 comm_ret
= lttng_trace_archive_location_serialize(location
,
3216 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3220 /* Update the message to indicate the location's length. */
3221 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3222 payload
.size
- payload_size_before_location
;
3224 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3225 payload
.data
, payload
.size
);
3226 if (comm_ret
!= (ssize_t
) payload
.size
) {
3227 ERR("Failed to send result of the destruction of session \"%s\" to client",
3231 ret
= close(reply_context
->reply_sock_fd
);
3233 PERROR("Failed to close client socket in deferred session destroy reply");
3235 lttng_dynamic_buffer_reset(&payload
);
3236 free(_reply_context
);
3240 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3242 * Called with session lock held.
3244 int cmd_destroy_session(struct ltt_session
*session
,
3245 struct notification_thread_handle
*notification_thread_handle
,
3249 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3250 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3253 reply_context
= zmalloc(sizeof(*reply_context
));
3254 if (!reply_context
) {
3255 ret
= LTTNG_ERR_NOMEM
;
3258 reply_context
->reply_sock_fd
= *sock_fd
;
3264 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3266 if (session
->active
) {
3267 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3269 ret
= cmd_stop_trace(session
);
3270 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3271 /* Carry on with the destruction of the session. */
3272 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3273 session
->name
, lttng_strerror(-ret
));
3274 destruction_last_error
= ret
;
3278 if (session
->rotation_schedule_timer_enabled
) {
3279 if (timer_session_rotation_schedule_timer_stop(
3281 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3283 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3287 if (session
->rotate_size
) {
3288 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3289 session
->rotate_size
= 0;
3292 if (session
->most_recent_chunk_id
.is_set
&&
3293 session
->most_recent_chunk_id
.value
!= 0 &&
3294 session
->current_trace_chunk
&& session
->output_traces
) {
3296 * Perform a last rotation on destruction if rotations have
3297 * occurred during the session's lifetime.
3299 ret
= cmd_rotate_session(session
, NULL
, false);
3300 if (ret
!= LTTNG_OK
) {
3301 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3302 session
->name
, lttng_strerror(-ret
));
3303 destruction_last_error
= -ret
;
3305 if (reply_context
) {
3306 reply_context
->implicit_rotation_on_destroy
= true;
3308 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3310 * The user has not triggered a session rotation. However, to
3311 * ensure all data has been consumed, the session is rotated
3312 * to a 'null' trace chunk before it is destroyed.
3314 * This is a "quiet" rotation meaning that no notification is
3315 * emitted and no renaming of the current trace chunk takes
3318 ret
= cmd_rotate_session(session
, NULL
, true);
3319 if (ret
!= LTTNG_OK
) {
3320 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3321 session
->name
, lttng_strerror(-ret
));
3322 destruction_last_error
= -ret
;
3326 if (session
->shm_path
[0]) {
3328 * When a session is created with an explicit shm_path,
3329 * the consumer daemon will create its shared memory files
3330 * at that location and will *not* unlink them. This is normal
3331 * as the intention of that feature is to make it possible
3332 * to retrieve the content of those files should a crash occur.
3334 * To ensure the content of those files can be used, the
3335 * sessiond daemon will replicate the content of the metadata
3336 * cache in a metadata file.
3338 * On clean-up, it is expected that the consumer daemon will
3339 * unlink the shared memory files and that the session daemon
3340 * will unlink the metadata file. Then, the session's directory
3341 * in the shm path can be removed.
3343 * Unfortunately, a flaw in the design of the sessiond's and
3344 * consumerd's tear down of channels makes it impossible to
3345 * determine when the sessiond _and_ the consumerd have both
3346 * destroyed their representation of a channel. For one, the
3347 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3348 * callbacks in both daemons.
3350 * However, it is also impossible for the sessiond to know when
3351 * the consumer daemon is done destroying its channel(s) since
3352 * it occurs as a reaction to the closing of the channel's file
3353 * descriptor. There is no resulting communication initiated
3354 * from the consumerd to the sessiond to confirm that the
3355 * operation is completed (and was successful).
3357 * Until this is all fixed, the session daemon checks for the
3358 * removal of the session's shm path which makes it possible
3359 * to safely advertise a session as having been destroyed.
3361 * Prior to this fix, it was not possible to reliably save
3362 * a session making use of the --shm-path option, destroy it,
3363 * and load it again. This is because the creation of the
3364 * session would fail upon seeing the session's shm path
3365 * already in existence.
3367 * Note that none of the error paths in the check for the
3368 * directory's existence return an error. This is normal
3369 * as there isn't much that can be done. The session will
3370 * be destroyed properly, except that we can't offer the
3371 * guarantee that the same session can be re-created.
3373 current_completion_handler
= &destroy_completion_handler
.handler
;
3374 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3376 sizeof(destroy_completion_handler
.shm_path
));
3381 * The session is destroyed. However, note that the command context
3382 * still holds a reference to the session, thus delaying its destruction
3383 * _at least_ up to the point when that reference is released.
3385 session_destroy(session
);
3386 if (reply_context
) {
3387 reply_context
->destruction_status
= destruction_last_error
;
3388 ret
= session_add_destroy_notifier(session
,
3389 cmd_destroy_session_reply
,
3390 (void *) reply_context
);
3392 ret
= LTTNG_ERR_FATAL
;
3404 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3406 int cmd_register_consumer(struct ltt_session
*session
,
3407 enum lttng_domain_type domain
, const char *sock_path
,
3408 struct consumer_data
*cdata
)
3411 struct consumer_socket
*socket
= NULL
;
3418 case LTTNG_DOMAIN_KERNEL
:
3420 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3424 /* Can't register a consumer if there is already one */
3425 if (ksess
->consumer_fds_sent
!= 0) {
3426 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3430 sock
= lttcomm_connect_unix_sock(sock_path
);
3432 ret
= LTTNG_ERR_CONNECT_FAIL
;
3435 cdata
->cmd_sock
= sock
;
3437 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3438 if (socket
== NULL
) {
3441 PERROR("close register consumer");
3443 cdata
->cmd_sock
= -1;
3444 ret
= LTTNG_ERR_FATAL
;
3448 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3449 if (socket
->lock
== NULL
) {
3450 PERROR("zmalloc pthread mutex");
3451 ret
= LTTNG_ERR_FATAL
;
3454 pthread_mutex_init(socket
->lock
, NULL
);
3455 socket
->registered
= 1;
3458 consumer_add_socket(socket
, ksess
->consumer
);
3461 pthread_mutex_lock(&cdata
->pid_mutex
);
3463 pthread_mutex_unlock(&cdata
->pid_mutex
);
3468 /* TODO: Userspace tracing */
3469 ret
= LTTNG_ERR_UND
;
3477 consumer_destroy_socket(socket
);
3483 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3485 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3486 struct lttng_domain
**domains
)
3491 struct lttng_ht_iter iter
;
3493 if (session
->kernel_session
!= NULL
) {
3494 DBG3("Listing domains found kernel domain");
3498 if (session
->ust_session
!= NULL
) {
3499 DBG3("Listing domains found UST global domain");
3503 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3505 if (agt
->being_used
) {
3516 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3517 if (*domains
== NULL
) {
3518 ret
= LTTNG_ERR_FATAL
;
3522 if (session
->kernel_session
!= NULL
) {
3523 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3525 /* Kernel session buffer type is always GLOBAL */
3526 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3531 if (session
->ust_session
!= NULL
) {
3532 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3533 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3537 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3539 if (agt
->being_used
) {
3540 (*domains
)[index
].type
= agt
->domain
;
3541 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3551 /* Return negative value to differentiate return code */
3557 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3559 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3560 struct ltt_session
*session
, struct lttng_channel
**channels
)
3562 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3565 case LTTNG_DOMAIN_KERNEL
:
3566 if (session
->kernel_session
!= NULL
) {
3567 nb_chan
= session
->kernel_session
->channel_count
;
3569 DBG3("Number of kernel channels %zd", nb_chan
);
3571 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3575 case LTTNG_DOMAIN_UST
:
3576 if (session
->ust_session
!= NULL
) {
3578 nb_chan
= lttng_ht_get_count(
3579 session
->ust_session
->domain_global
.channels
);
3582 DBG3("Number of UST global channels %zd", nb_chan
);
3584 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3589 ret
= -LTTNG_ERR_UND
;
3594 const size_t channel_size
= sizeof(struct lttng_channel
) +
3595 sizeof(struct lttng_channel_extended
);
3596 struct lttng_channel_extended
*channel_exts
;
3598 payload_size
= nb_chan
* channel_size
;
3599 *channels
= zmalloc(payload_size
);
3600 if (*channels
== NULL
) {
3601 ret
= -LTTNG_ERR_FATAL
;
3605 channel_exts
= ((void *) *channels
) +
3606 (nb_chan
* sizeof(struct lttng_channel
));
3607 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3608 if (ret
!= LTTNG_OK
) {
3623 * Command LTTNG_LIST_EVENTS processed by the client thread.
3625 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3626 struct ltt_session
*session
, char *channel_name
,
3627 struct lttng_event
**events
, size_t *total_size
)
3630 ssize_t nb_event
= 0;
3633 case LTTNG_DOMAIN_KERNEL
:
3634 if (session
->kernel_session
!= NULL
) {
3635 nb_event
= list_lttng_kernel_events(channel_name
,
3636 session
->kernel_session
, events
,
3640 case LTTNG_DOMAIN_UST
:
3642 if (session
->ust_session
!= NULL
) {
3643 nb_event
= list_lttng_ust_global_events(channel_name
,
3644 &session
->ust_session
->domain_global
, events
,
3649 case LTTNG_DOMAIN_LOG4J
:
3650 case LTTNG_DOMAIN_JUL
:
3651 case LTTNG_DOMAIN_PYTHON
:
3652 if (session
->ust_session
) {
3653 struct lttng_ht_iter iter
;
3657 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3658 &iter
.iter
, agt
, node
.node
) {
3659 if (agt
->domain
== domain
) {
3660 nb_event
= list_lttng_agent_events(
3670 ret
= LTTNG_ERR_UND
;
3677 /* Return negative value to differentiate return code */
3682 * Using the session list, filled a lttng_session array to send back to the
3683 * client for session listing.
3685 * The session list lock MUST be acquired before calling this function. Use
3686 * session_lock_list() and session_unlock_list().
3688 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3689 size_t session_count
, uid_t uid
, gid_t gid
)
3693 struct ltt_session
*session
;
3694 struct ltt_session_list
*list
= session_get_list();
3695 struct lttng_session_extended
*extended
=
3696 (typeof(extended
)) (&sessions
[session_count
]);
3698 DBG("Getting all available session for UID %d GID %d",
3701 * Iterate over session list and append data after the control struct in
3704 cds_list_for_each_entry(session
, &list
->head
, list
) {
3705 if (!session_get(session
)) {
3709 * Only list the sessions the user can control.
3711 if (!session_access_ok(session
, uid
, gid
) ||
3712 session
->destroyed
) {
3713 session_put(session
);
3717 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3718 struct ltt_ust_session
*usess
= session
->ust_session
;
3720 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3721 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3722 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3723 ret
= build_network_session_path(sessions
[i
].path
,
3724 sizeof(sessions
[i
].path
), session
);
3726 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3727 session
->consumer
->dst
.session_root_path
);
3730 PERROR("snprintf session path");
3731 session_put(session
);
3735 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3736 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3737 sessions
[i
].enabled
= session
->active
;
3738 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3739 sessions
[i
].live_timer_interval
= session
->live_timer
;
3740 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3741 extended
[i
].creation_time
.is_set
= 1;
3743 session_put(session
);
3748 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3749 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3751 int cmd_data_pending(struct ltt_session
*session
)
3754 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3755 struct ltt_ust_session
*usess
= session
->ust_session
;
3759 DBG("Data pending for session %s", session
->name
);
3761 /* Session MUST be stopped to ask for data availability. */
3762 if (session
->active
) {
3763 ret
= LTTNG_ERR_SESSION_STARTED
;
3767 * If stopped, just make sure we've started before else the above call
3768 * will always send that there is data pending.
3770 * The consumer assumes that when the data pending command is received,
3771 * the trace has been started before or else no output data is written
3772 * by the streams which is a condition for data pending. So, this is
3773 * *VERY* important that we don't ask the consumer before a start
3776 if (!session
->has_been_started
) {
3782 /* A rotation is still pending, we have to wait. */
3783 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3784 DBG("Rotate still pending for session %s", session
->name
);
3789 if (ksess
&& ksess
->consumer
) {
3790 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3792 /* Data is still being extracted for the kernel. */
3797 if (usess
&& usess
->consumer
) {
3798 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3800 /* Data is still being extracted for the kernel. */
3805 /* Data is ready to be read by a viewer */
3813 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3815 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3817 int cmd_snapshot_add_output(struct ltt_session
*session
,
3818 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3821 struct snapshot_output
*new_output
;
3826 DBG("Cmd snapshot add output for session %s", session
->name
);
3829 * Can't create an output if the session is not set in no-output mode.
3831 if (session
->output_traces
) {
3832 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3836 if (session
->has_non_mmap_channel
) {
3837 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3841 /* Only one output is allowed until we have the "tee" feature. */
3842 if (session
->snapshot
.nb_output
== 1) {
3843 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3847 new_output
= snapshot_output_alloc();
3849 ret
= LTTNG_ERR_NOMEM
;
3853 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3854 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3855 &session
->snapshot
);
3857 if (ret
== -ENOMEM
) {
3858 ret
= LTTNG_ERR_NOMEM
;
3860 ret
= LTTNG_ERR_INVALID
;
3866 snapshot_add_output(&session
->snapshot
, new_output
);
3868 *id
= new_output
->id
;
3875 snapshot_output_destroy(new_output
);
3881 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3883 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3885 int cmd_snapshot_del_output(struct ltt_session
*session
,
3886 const struct lttng_snapshot_output
*output
)
3889 struct snapshot_output
*sout
= NULL
;
3897 * Permission denied to create an output if the session is not
3898 * set in no output mode.
3900 if (session
->output_traces
) {
3901 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3906 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3908 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3909 } else if (*output
->name
!= '\0') {
3910 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3912 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3915 ret
= LTTNG_ERR_INVALID
;
3919 snapshot_delete_output(&session
->snapshot
, sout
);
3920 snapshot_output_destroy(sout
);
3929 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3931 * If no output is available, outputs is untouched and 0 is returned.
3933 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3935 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3936 struct lttng_snapshot_output
**outputs
)
3939 struct lttng_snapshot_output
*list
= NULL
;
3940 struct lttng_ht_iter iter
;
3941 struct snapshot_output
*output
;
3946 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3949 * Permission denied to create an output if the session is not
3950 * set in no output mode.
3952 if (session
->output_traces
) {
3953 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3957 if (session
->snapshot
.nb_output
== 0) {
3962 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3964 ret
= -LTTNG_ERR_NOMEM
;
3968 /* Copy list from session to the new list object. */
3970 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3971 output
, node
.node
) {
3972 assert(output
->consumer
);
3973 list
[idx
].id
= output
->id
;
3974 list
[idx
].max_size
= output
->max_size
;
3975 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3976 sizeof(list
[idx
].name
))) {
3977 ret
= -LTTNG_ERR_INVALID
;
3980 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3981 if (lttng_strncpy(list
[idx
].ctrl_url
,
3982 output
->consumer
->dst
.session_root_path
,
3983 sizeof(list
[idx
].ctrl_url
))) {
3984 ret
= -LTTNG_ERR_INVALID
;
3989 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3990 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3992 ret
= -LTTNG_ERR_NOMEM
;
3997 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3998 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4000 ret
= -LTTNG_ERR_NOMEM
;
4009 ret
= session
->snapshot
.nb_output
;
4018 * Check if we can regenerate the metadata for this session.
4019 * Only kernel, UST per-uid and non-live sessions are supported.
4021 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4024 int check_regenerate_metadata_support(struct ltt_session
*session
)
4030 if (session
->live_timer
!= 0) {
4031 ret
= LTTNG_ERR_LIVE_SESSION
;
4034 if (!session
->active
) {
4035 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4038 if (session
->ust_session
) {
4039 switch (session
->ust_session
->buffer_type
) {
4040 case LTTNG_BUFFER_PER_UID
:
4042 case LTTNG_BUFFER_PER_PID
:
4043 ret
= LTTNG_ERR_PER_PID_SESSION
;
4047 ret
= LTTNG_ERR_UNK
;
4051 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4052 session
->consumer
->relay_minor_version
< 8) {
4053 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4063 int clear_metadata_file(int fd
)
4068 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4069 if (lseek_ret
< 0) {
4075 ret
= ftruncate(fd
, 0);
4077 PERROR("ftruncate");
4086 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4089 struct buffer_reg_uid
*uid_reg
= NULL
;
4090 struct buffer_reg_session
*session_reg
= NULL
;
4093 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4094 struct ust_registry_session
*registry
;
4095 struct ust_registry_channel
*chan
;
4096 struct lttng_ht_iter iter_chan
;
4098 session_reg
= uid_reg
->registry
;
4099 registry
= session_reg
->reg
.ust
;
4101 pthread_mutex_lock(®istry
->lock
);
4102 registry
->metadata_len_sent
= 0;
4103 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4104 registry
->metadata_len
= 0;
4105 registry
->metadata_version
++;
4106 if (registry
->metadata_fd
> 0) {
4107 /* Clear the metadata file's content. */
4108 ret
= clear_metadata_file(registry
->metadata_fd
);
4110 pthread_mutex_unlock(®istry
->lock
);
4115 ret
= ust_metadata_session_statedump(registry
, NULL
,
4116 registry
->major
, registry
->minor
);
4118 pthread_mutex_unlock(®istry
->lock
);
4119 ERR("Failed to generate session metadata (err = %d)",
4123 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4125 struct ust_registry_event
*event
;
4126 struct lttng_ht_iter iter_event
;
4128 ret
= ust_metadata_channel_statedump(registry
, chan
);
4130 pthread_mutex_unlock(®istry
->lock
);
4131 ERR("Failed to generate channel metadata "
4135 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4137 ret
= ust_metadata_event_statedump(registry
,
4140 pthread_mutex_unlock(®istry
->lock
);
4141 ERR("Failed to generate event metadata "
4147 pthread_mutex_unlock(®istry
->lock
);
4156 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4158 * Ask the consumer to truncate the existing metadata file(s) and
4159 * then regenerate the metadata. Live and per-pid sessions are not
4160 * supported and return an error.
4162 * Return 0 on success or else a LTTNG_ERR code.
4164 int cmd_regenerate_metadata(struct ltt_session
*session
)
4170 ret
= check_regenerate_metadata_support(session
);
4175 if (session
->kernel_session
) {
4176 ret
= kernctl_session_regenerate_metadata(
4177 session
->kernel_session
->fd
);
4179 ERR("Failed to regenerate the kernel metadata");
4184 if (session
->ust_session
) {
4185 ret
= ust_regenerate_metadata(session
->ust_session
);
4187 ERR("Failed to regenerate the UST metadata");
4191 DBG("Cmd metadata regenerate for session %s", session
->name
);
4199 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4201 * Ask the tracer to regenerate a new statedump.
4203 * Return 0 on success or else a LTTNG_ERR code.
4205 int cmd_regenerate_statedump(struct ltt_session
*session
)
4211 if (!session
->active
) {
4212 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4216 if (session
->kernel_session
) {
4217 ret
= kernctl_session_regenerate_statedump(
4218 session
->kernel_session
->fd
);
4220 * Currently, the statedump in kernel can only fail if out
4224 if (ret
== -ENOMEM
) {
4225 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4227 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4229 ERR("Failed to regenerate the kernel statedump");
4234 if (session
->ust_session
) {
4235 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4237 * Currently, the statedump in UST always returns 0.
4240 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4241 ERR("Failed to regenerate the UST statedump");
4245 DBG("Cmd regenerate statedump for session %s", session
->name
);
4252 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4253 struct notification_thread_handle
*notification_thread
)
4257 ssize_t sock_recv_len
;
4258 struct lttng_trigger
*trigger
= NULL
;
4259 struct lttng_buffer_view view
;
4260 struct lttng_dynamic_buffer trigger_buffer
;
4262 lttng_dynamic_buffer_init(&trigger_buffer
);
4263 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4264 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4266 ret
= LTTNG_ERR_NOMEM
;
4270 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4272 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4273 ERR("Failed to receive \"register trigger\" command payload");
4274 /* TODO: should this be a new error enum ? */
4275 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4279 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4280 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4282 ERR("Invalid trigger payload received in \"register trigger\" command");
4283 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4287 ret
= notification_thread_command_register_trigger(notification_thread
,
4289 /* Ownership of trigger was transferred. */
4292 lttng_trigger_destroy(trigger
);
4293 lttng_dynamic_buffer_reset(&trigger_buffer
);
4297 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4298 struct notification_thread_handle
*notification_thread
)
4302 ssize_t sock_recv_len
;
4303 struct lttng_trigger
*trigger
= NULL
;
4304 struct lttng_buffer_view view
;
4305 struct lttng_dynamic_buffer trigger_buffer
;
4307 lttng_dynamic_buffer_init(&trigger_buffer
);
4308 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4309 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4311 ret
= LTTNG_ERR_NOMEM
;
4315 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4317 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4318 ERR("Failed to receive \"unregister trigger\" command payload");
4319 /* TODO: should this be a new error enum ? */
4320 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4324 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4325 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4327 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4328 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4332 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4335 lttng_trigger_destroy(trigger
);
4336 lttng_dynamic_buffer_reset(&trigger_buffer
);
4341 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4342 * snapshot output is *not* set with a remote destination.
4344 * Return LTTNG_OK on success or a LTTNG_ERR code.
4346 static enum lttng_error_code
set_relayd_for_snapshot(
4347 struct consumer_output
*output
,
4348 const struct ltt_session
*session
)
4350 enum lttng_error_code status
= LTTNG_OK
;
4351 struct lttng_ht_iter iter
;
4352 struct consumer_socket
*socket
;
4353 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4354 const char *base_path
;
4359 DBG2("Set relayd object from snapshot output");
4361 if (session
->current_trace_chunk
) {
4362 enum lttng_trace_chunk_status chunk_status
=
4363 lttng_trace_chunk_get_id(
4364 session
->current_trace_chunk
,
4365 ¤t_chunk_id
.value
);
4367 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4368 current_chunk_id
.is_set
= true;
4370 ERR("Failed to get current trace chunk id");
4371 status
= LTTNG_ERR_UNK
;
4376 /* Ignore if snapshot consumer output is not network. */
4377 if (output
->type
!= CONSUMER_DST_NET
) {
4382 * The snapshot record URI base path overrides the session
4385 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4386 base_path
= output
->dst
.net
.control
.subdir
;
4388 base_path
= session
->base_path
;
4392 * For each consumer socket, create and send the relayd object of the
4396 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4397 socket
, node
.node
) {
4398 pthread_mutex_lock(socket
->lock
);
4399 status
= send_consumer_relayd_sockets(0, session
->id
,
4401 session
->name
, session
->hostname
,
4403 session
->live_timer
,
4404 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4405 session
->creation_time
,
4406 session
->name_contains_creation_time
);
4407 pthread_mutex_unlock(socket
->lock
);
4408 if (status
!= LTTNG_OK
) {
4420 * Record a kernel snapshot.
4422 * Return LTTNG_OK on success or a LTTNG_ERR code.
4424 static enum lttng_error_code
record_kernel_snapshot(
4425 struct ltt_kernel_session
*ksess
,
4426 const struct consumer_output
*output
,
4427 const struct ltt_session
*session
,
4428 int wait
, uint64_t nb_packets_per_stream
)
4430 enum lttng_error_code status
;
4436 status
= kernel_snapshot_record(
4437 ksess
, output
, wait
, nb_packets_per_stream
);
4442 * Record a UST snapshot.
4444 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4446 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4447 const struct consumer_output
*output
,
4448 const struct ltt_session
*session
,
4449 int wait
, uint64_t nb_packets_per_stream
)
4451 enum lttng_error_code status
;
4457 status
= ust_app_snapshot_record(
4458 usess
, output
, wait
, nb_packets_per_stream
);
4463 uint64_t get_session_size_one_more_packet_per_stream(
4464 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4466 uint64_t tot_size
= 0;
4468 if (session
->kernel_session
) {
4469 struct ltt_kernel_channel
*chan
;
4470 const struct ltt_kernel_session
*ksess
=
4471 session
->kernel_session
;
4473 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4474 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4476 * Don't take channel into account if we
4477 * already grab all its packets.
4481 tot_size
+= chan
->channel
->attr
.subbuf_size
4482 * chan
->stream_count
;
4486 if (session
->ust_session
) {
4487 const struct ltt_ust_session
*usess
= session
->ust_session
;
4489 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4497 * Calculate the number of packets we can grab from each stream that
4498 * fits within the overall snapshot max size.
4500 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4501 * the number of packets per stream.
4503 * TODO: this approach is not perfect: we consider the worse case
4504 * (packet filling the sub-buffers) as an upper bound, but we could do
4505 * better if we do this calculation while we actually grab the packet
4506 * content: we would know how much padding we don't actually store into
4509 * This algorithm is currently bounded by the number of packets per
4512 * Since we call this algorithm before actually grabbing the data, it's
4513 * an approximation: for instance, applications could appear/disappear
4514 * in between this call and actually grabbing data.
4517 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4521 uint64_t cur_nb_packets
= 0;
4524 return 0; /* Infinite */
4527 size_left
= max_size
;
4529 uint64_t one_more_packet_tot_size
;
4531 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4532 session
, cur_nb_packets
);
4533 if (!one_more_packet_tot_size
) {
4534 /* We are already grabbing all packets. */
4537 size_left
-= one_more_packet_tot_size
;
4538 if (size_left
< 0) {
4543 if (!cur_nb_packets
) {
4544 /* Not enough room to grab one packet of each stream, error. */
4547 return cur_nb_packets
;
4551 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4552 const struct snapshot_output
*snapshot_output
, int wait
)
4554 int64_t nb_packets_per_stream
;
4555 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4557 enum lttng_error_code ret_code
= LTTNG_OK
;
4558 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4559 struct consumer_output
*original_ust_consumer_output
= NULL
;
4560 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4561 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4562 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4564 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4566 snapshot_output
->name
,
4567 snapshot_output
->datetime
,
4568 snapshot_output
->nb_snapshot
);
4569 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4570 ERR("Failed to format snapshot name");
4571 ret_code
= LTTNG_ERR_INVALID
;
4574 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4575 snapshot_output
->name
, session
->name
,
4576 snapshot_chunk_name
);
4577 if (!session
->kernel_session
&& !session
->ust_session
) {
4578 ERR("Failed to record snapshot as no channels exist");
4579 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4583 if (session
->kernel_session
) {
4584 original_kernel_consumer_output
=
4585 session
->kernel_session
->consumer
;
4586 snapshot_kernel_consumer_output
=
4587 consumer_copy_output(snapshot_output
->consumer
);
4588 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4589 snapshot_chunk_name
);
4590 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4591 original_kernel_consumer_output
);
4593 ERR("Failed to copy consumer sockets from snapshot output configuration");
4594 ret_code
= LTTNG_ERR_NOMEM
;
4597 ret_code
= set_relayd_for_snapshot(
4598 snapshot_kernel_consumer_output
, session
);
4599 if (ret_code
!= LTTNG_OK
) {
4600 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4603 session
->kernel_session
->consumer
=
4604 snapshot_kernel_consumer_output
;
4606 if (session
->ust_session
) {
4607 original_ust_consumer_output
= session
->ust_session
->consumer
;
4608 snapshot_ust_consumer_output
=
4609 consumer_copy_output(snapshot_output
->consumer
);
4610 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4611 snapshot_chunk_name
);
4612 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4613 original_ust_consumer_output
);
4615 ERR("Failed to copy consumer sockets from snapshot output configuration");
4616 ret_code
= LTTNG_ERR_NOMEM
;
4619 ret_code
= set_relayd_for_snapshot(
4620 snapshot_ust_consumer_output
, session
);
4621 if (ret_code
!= LTTNG_OK
) {
4622 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4625 session
->ust_session
->consumer
=
4626 snapshot_ust_consumer_output
;
4629 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4630 snapshot_kernel_consumer_output
?:
4631 snapshot_ust_consumer_output
,
4632 consumer_output_get_base_path(
4633 snapshot_output
->consumer
),
4634 snapshot_chunk_name
);
4635 if (!snapshot_trace_chunk
) {
4636 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4638 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4641 assert(!session
->current_trace_chunk
);
4642 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4643 lttng_trace_chunk_put(snapshot_trace_chunk
);
4644 snapshot_trace_chunk
= NULL
;
4646 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4648 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4652 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4653 snapshot_output
->max_size
);
4654 if (nb_packets_per_stream
< 0) {
4655 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4659 if (session
->kernel_session
) {
4660 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4661 snapshot_kernel_consumer_output
, session
,
4662 wait
, nb_packets_per_stream
);
4663 if (ret_code
!= LTTNG_OK
) {
4668 if (session
->ust_session
) {
4669 ret_code
= record_ust_snapshot(session
->ust_session
,
4670 snapshot_ust_consumer_output
, session
,
4671 wait
, nb_packets_per_stream
);
4672 if (ret_code
!= LTTNG_OK
) {
4677 if (session_close_trace_chunk(
4678 session
, session
->current_trace_chunk
, NULL
, NULL
)) {
4680 * Don't goto end; make sure the chunk is closed for the session
4681 * to allow future snapshots.
4683 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4685 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4687 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4688 ERR("Failed to release the current trace chunk of session \"%s\"",
4690 ret_code
= LTTNG_ERR_UNK
;
4693 if (original_ust_consumer_output
) {
4694 session
->ust_session
->consumer
= original_ust_consumer_output
;
4696 if (original_kernel_consumer_output
) {
4697 session
->kernel_session
->consumer
=
4698 original_kernel_consumer_output
;
4700 consumer_output_put(snapshot_ust_consumer_output
);
4701 consumer_output_put(snapshot_kernel_consumer_output
);
4706 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4708 * The wait parameter is ignored so this call always wait for the snapshot to
4709 * complete before returning.
4711 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4713 int cmd_snapshot_record(struct ltt_session
*session
,
4714 const struct lttng_snapshot_output
*output
, int wait
)
4716 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4718 unsigned int snapshot_success
= 0;
4720 struct snapshot_output
*tmp_output
= NULL
;
4725 DBG("Cmd snapshot record for session %s", session
->name
);
4727 /* Get the datetime for the snapshot output directory. */
4728 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4731 cmd_ret
= LTTNG_ERR_INVALID
;
4736 * Permission denied to create an output if the session is not
4737 * set in no output mode.
4739 if (session
->output_traces
) {
4740 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4744 /* The session needs to be started at least once. */
4745 if (!session
->has_been_started
) {
4746 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4750 /* Use temporary output for the session. */
4751 if (*output
->ctrl_url
!= '\0') {
4752 tmp_output
= snapshot_output_alloc();
4754 cmd_ret
= LTTNG_ERR_NOMEM
;
4758 ret
= snapshot_output_init(session
, output
->max_size
,
4760 output
->ctrl_url
, output
->data_url
,
4764 if (ret
== -ENOMEM
) {
4765 cmd_ret
= LTTNG_ERR_NOMEM
;
4767 cmd_ret
= LTTNG_ERR_INVALID
;
4771 /* Use the global session count for the temporary snapshot. */
4772 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4774 /* Use the global datetime */
4775 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4776 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4777 if (cmd_ret
!= LTTNG_OK
) {
4780 snapshot_success
= 1;
4782 struct snapshot_output
*sout
;
4783 struct lttng_ht_iter iter
;
4786 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4787 &iter
.iter
, sout
, node
.node
) {
4788 struct snapshot_output output_copy
;
4791 * Make a local copy of the output and override output
4792 * parameters with those provided as part of the
4795 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4797 if (output
->max_size
!= (uint64_t) -1ULL) {
4798 output_copy
.max_size
= output
->max_size
;
4801 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4802 memcpy(output_copy
.datetime
, datetime
,
4805 /* Use temporary name. */
4806 if (*output
->name
!= '\0') {
4807 if (lttng_strncpy(output_copy
.name
,
4809 sizeof(output_copy
.name
))) {
4810 cmd_ret
= LTTNG_ERR_INVALID
;
4816 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4817 if (cmd_ret
!= LTTNG_OK
) {
4821 snapshot_success
= 1;
4826 if (snapshot_success
) {
4827 session
->snapshot
.nb_snapshot
++;
4829 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4834 snapshot_output_destroy(tmp_output
);
4840 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4842 int cmd_set_session_shm_path(struct ltt_session
*session
,
4843 const char *shm_path
)
4849 * Can only set shm path before session is started.
4851 if (session
->has_been_started
) {
4852 return LTTNG_ERR_SESSION_STARTED
;
4855 strncpy(session
->shm_path
, shm_path
,
4856 sizeof(session
->shm_path
));
4857 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4863 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4865 * Ask the consumer to rotate the session output directory.
4866 * The session lock must be held.
4868 * Returns LTTNG_OK on success or else a negative LTTng error code.
4870 int cmd_rotate_session(struct ltt_session
*session
,
4871 struct lttng_rotate_session_return
*rotate_return
,
4872 bool quiet_rotation
)
4875 uint64_t ongoing_rotation_chunk_id
;
4876 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4877 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4878 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4879 enum lttng_trace_chunk_status chunk_status
;
4880 bool failed_to_rotate
= false;
4881 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4885 if (!session
->has_been_started
) {
4886 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4891 * Explicit rotation is not supported for live sessions.
4892 * However, live sessions can perform a quiet rotation on
4894 * Rotation is not supported for snapshot traces (no output).
4896 if ((!quiet_rotation
&& session
->live_timer
) ||
4897 !session
->output_traces
) {
4898 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4902 /* Unsupported feature in lttng-relayd before 2.11. */
4903 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4904 (session
->consumer
->relay_major_version
== 2 &&
4905 session
->consumer
->relay_minor_version
< 11)) {
4906 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4910 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4911 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4912 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4916 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4917 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4919 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4924 * After a stop, we only allow one rotation to occur, the other ones are
4925 * useless until a new start.
4927 if (session
->rotated_after_last_stop
) {
4928 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4930 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4933 if (session
->active
) {
4934 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4936 if (!new_trace_chunk
) {
4937 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4943 * The current trace chunk becomes the chunk being archived.
4945 * After this point, "chunk_being_archived" must absolutely
4946 * be closed on the consumer(s), otherwise it will never be
4947 * cleaned-up, which will result in a leak.
4949 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4950 &chunk_being_archived
);
4952 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4956 if (session
->kernel_session
) {
4957 cmd_ret
= kernel_rotate_session(session
);
4958 if (cmd_ret
!= LTTNG_OK
) {
4959 failed_to_rotate
= true;
4960 rotation_fail_code
= cmd_ret
;
4963 if (session
->ust_session
) {
4964 cmd_ret
= ust_app_rotate_session(session
);
4965 if (cmd_ret
!= LTTNG_OK
) {
4966 failed_to_rotate
= true;
4967 rotation_fail_code
= cmd_ret
;
4971 if (!session
->active
) {
4972 session
->rotated_after_last_stop
= true;
4975 if (!chunk_being_archived
) {
4976 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
4978 if (failed_to_rotate
) {
4979 cmd_ret
= rotation_fail_code
;
4986 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4987 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
4988 &ongoing_rotation_chunk_id
);
4989 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4991 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
4994 &((enum lttng_trace_chunk_command_type
){
4995 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
}),
4996 session
->last_chunk_path
);
4998 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5002 if (failed_to_rotate
) {
5003 cmd_ret
= rotation_fail_code
;
5007 session
->quiet_rotation
= quiet_rotation
;
5008 ret
= timer_session_rotation_pending_check_start(session
,
5009 DEFAULT_ROTATE_PENDING_TIMER
);
5011 cmd_ret
= LTTNG_ERR_UNK
;
5015 if (rotate_return
) {
5016 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5019 session
->chunk_being_archived
= chunk_being_archived
;
5020 chunk_being_archived
= NULL
;
5021 if (!quiet_rotation
) {
5022 ret
= notification_thread_command_session_rotation_ongoing(
5023 notification_thread_handle
,
5024 session
->name
, session
->uid
, session
->gid
,
5025 ongoing_rotation_chunk_id
);
5026 if (ret
!= LTTNG_OK
) {
5027 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5033 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5034 session
->name
, ongoing_rotation_chunk_id
);
5036 lttng_trace_chunk_put(new_trace_chunk
);
5037 lttng_trace_chunk_put(chunk_being_archived
);
5038 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5041 if (session_reset_rotation_state(session
,
5042 LTTNG_ROTATION_STATE_ERROR
)) {
5043 ERR("Failed to reset rotation state of session \"%s\"",
5050 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5052 * Check if the session has finished its rotation.
5054 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5056 int cmd_rotate_get_info(struct ltt_session
*session
,
5057 struct lttng_rotation_get_info_return
*info_return
,
5058 uint64_t rotation_id
)
5060 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5061 enum lttng_rotation_state rotation_state
;
5063 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5064 session
->most_recent_chunk_id
.value
);
5066 if (session
->chunk_being_archived
) {
5067 enum lttng_trace_chunk_status chunk_status
;
5070 chunk_status
= lttng_trace_chunk_get_id(
5071 session
->chunk_being_archived
,
5073 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5075 rotation_state
= rotation_id
== chunk_id
?
5076 LTTNG_ROTATION_STATE_ONGOING
:
5077 LTTNG_ROTATION_STATE_EXPIRED
;
5079 if (session
->last_archived_chunk_id
.is_set
&&
5080 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5081 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5083 rotation_state
= session
->rotation_state
;
5087 switch (rotation_state
) {
5088 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5089 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5092 case LTTNG_ROTATION_STATE_EXPIRED
:
5093 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5094 rotation_id
, session
->name
);
5096 case LTTNG_ROTATION_STATE_ONGOING
:
5097 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5098 rotation_id
, session
->name
);
5100 case LTTNG_ROTATION_STATE_COMPLETED
:
5104 char *current_tracing_path_reply
;
5105 size_t current_tracing_path_reply_len
;
5107 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5108 rotation_id
, session
->name
);
5110 switch (session_get_consumer_destination_type(session
)) {
5111 case CONSUMER_DST_LOCAL
:
5112 current_tracing_path_reply
=
5113 info_return
->location
.local
.absolute_path
;
5114 current_tracing_path_reply_len
=
5115 sizeof(info_return
->location
.local
.absolute_path
);
5116 info_return
->location_type
=
5117 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5118 fmt_ret
= asprintf(&chunk_path
,
5119 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5120 session_get_base_path(session
),
5121 session
->last_archived_chunk_name
);
5122 if (fmt_ret
== -1) {
5123 PERROR("Failed to format the path of the last archived trace chunk");
5124 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5125 cmd_ret
= LTTNG_ERR_UNK
;
5129 case CONSUMER_DST_NET
:
5131 uint16_t ctrl_port
, data_port
;
5133 current_tracing_path_reply
=
5134 info_return
->location
.relay
.relative_path
;
5135 current_tracing_path_reply_len
=
5136 sizeof(info_return
->location
.relay
.relative_path
);
5137 /* Currently the only supported relay protocol. */
5138 info_return
->location
.relay
.protocol
=
5139 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5141 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5142 session_get_net_consumer_hostname(session
),
5143 sizeof(info_return
->location
.relay
.host
));
5145 ERR("Failed to copy host name to rotate_get_info reply");
5146 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5147 cmd_ret
= LTTNG_ERR_SET_URL
;
5151 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5152 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5153 info_return
->location
.relay
.ports
.data
= data_port
;
5154 info_return
->location_type
=
5155 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5156 chunk_path
= strdup(session
->last_chunk_path
);
5158 ERR("Failed to allocate the path of the last archived trace chunk");
5159 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5160 cmd_ret
= LTTNG_ERR_UNK
;
5169 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5170 chunk_path
, current_tracing_path_reply_len
);
5173 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5174 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5175 cmd_ret
= LTTNG_ERR_UNK
;
5181 case LTTNG_ROTATION_STATE_ERROR
:
5182 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5183 rotation_id
, session
->name
);
5191 info_return
->status
= (int32_t) rotation_state
;
5196 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5198 * Configure the automatic rotation parameters.
5199 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5200 * 'activate' to false means deactivate the rotation schedule and validate that
5201 * 'new_value' has the same value as the currently active value.
5203 * Return 0 on success or else a positive LTTNG_ERR code.
5205 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5206 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5208 struct notification_thread_handle
*notification_thread_handle
)
5211 uint64_t *parameter_value
;
5215 DBG("Cmd rotate set schedule session %s", session
->name
);
5217 if (session
->live_timer
|| !session
->output_traces
) {
5218 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5219 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5223 switch (schedule_type
) {
5224 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5225 parameter_value
= &session
->rotate_size
;
5227 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5228 parameter_value
= &session
->rotate_timer_period
;
5229 if (new_value
>= UINT_MAX
) {
5230 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5231 new_value
, UINT_MAX
);
5232 ret
= LTTNG_ERR_INVALID
;
5237 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5238 ret
= LTTNG_ERR_INVALID
;
5242 /* Improper use of the API. */
5243 if (new_value
== -1ULL) {
5244 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5245 ret
= LTTNG_ERR_INVALID
;
5250 * As indicated in struct ltt_session's comments, a value of == 0 means
5251 * this schedule rotation type is not in use.
5253 * Reject the command if we were asked to activate a schedule that was
5256 if (activate
&& *parameter_value
!= 0) {
5257 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5258 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5263 * Reject the command if we were asked to deactivate a schedule that was
5266 if (!activate
&& *parameter_value
== 0) {
5267 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5268 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5273 * Reject the command if we were asked to deactivate a schedule that
5276 if (!activate
&& *parameter_value
!= new_value
) {
5277 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5278 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5282 *parameter_value
= activate
? new_value
: 0;
5284 switch (schedule_type
) {
5285 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5286 if (activate
&& session
->active
) {
5288 * Only start the timer if the session is active,
5289 * otherwise it will be started when the session starts.
5291 ret
= timer_session_rotation_schedule_timer_start(
5292 session
, new_value
);
5294 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5295 ret
= LTTNG_ERR_UNK
;
5299 ret
= timer_session_rotation_schedule_timer_stop(
5302 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5303 ret
= LTTNG_ERR_UNK
;
5308 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5310 ret
= subscribe_session_consumed_size_rotation(session
,
5311 new_value
, notification_thread_handle
);
5313 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5314 ret
= LTTNG_ERR_UNK
;
5318 ret
= unsubscribe_session_consumed_size_rotation(session
,
5319 notification_thread_handle
);
5321 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5322 ret
= LTTNG_ERR_UNK
;
5329 /* Would have been caught before. */
5341 /* Wait for a given path to be removed before continuing. */
5342 static enum lttng_error_code
wait_on_path(void *path_data
)
5344 const char *shm_path
= path_data
;
5346 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5352 ret
= stat(shm_path
, &st
);
5354 if (errno
!= ENOENT
) {
5355 PERROR("stat() returned an error while checking for the existence of the shm path");
5357 DBG("shm path no longer exists, completing the destruction of session");
5361 if (!S_ISDIR(st
.st_mode
)) {
5362 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5367 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5373 * Returns a pointer to a handler to run on completion of a command.
5374 * Returns NULL if no handler has to be run for the last command executed.
5376 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5378 struct cmd_completion_handler
*handler
= current_completion_handler
;
5380 current_completion_handler
= NULL
;
5385 * Init command subsystem.
5390 * Set network sequence index to 1 for streams to match a relayd
5391 * socket on the consumer side.
5393 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5394 relayd_net_seq_idx
= 1;
5395 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5397 DBG("Command subsystem initialized");