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 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();
1325 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1327 struct ltt_kernel_channel
*kchan
;
1328 bool error_occurred
= false;
1331 if (!ksess
|| !ksess
->active
) {
1334 DBG("Stopping kernel tracing");
1336 ret
= kernel_stop_session(ksess
);
1338 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1342 kernel_wait_quiescent();
1344 /* Flush metadata after stopping (if exists) */
1345 if (ksess
->metadata_stream_fd
>= 0) {
1346 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1348 ERR("Kernel metadata flush failed");
1349 error_occurred
= true;
1353 /* Flush all buffers after stopping */
1354 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1355 ret
= kernel_flush_buffer(kchan
);
1357 ERR("Kernel flush buffer error");
1358 error_occurred
= true;
1363 if (error_occurred
) {
1364 ret
= LTTNG_ERR_UNK
;
1373 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1375 int cmd_disable_channel(struct ltt_session
*session
,
1376 enum lttng_domain_type domain
, char *channel_name
)
1379 struct ltt_ust_session
*usess
;
1381 usess
= session
->ust_session
;
1386 case LTTNG_DOMAIN_KERNEL
:
1388 ret
= channel_kernel_disable(session
->kernel_session
,
1390 if (ret
!= LTTNG_OK
) {
1394 kernel_wait_quiescent();
1397 case LTTNG_DOMAIN_UST
:
1399 struct ltt_ust_channel
*uchan
;
1400 struct lttng_ht
*chan_ht
;
1402 chan_ht
= usess
->domain_global
.channels
;
1404 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1405 if (uchan
== NULL
) {
1406 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1410 ret
= channel_ust_disable(usess
, uchan
);
1411 if (ret
!= LTTNG_OK
) {
1417 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1429 * Command LTTNG_TRACK_PID processed by the client thread.
1431 * Called with session lock held.
1433 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1441 case LTTNG_DOMAIN_KERNEL
:
1443 struct ltt_kernel_session
*ksess
;
1445 ksess
= session
->kernel_session
;
1447 ret
= kernel_track_pid(ksess
, pid
);
1448 if (ret
!= LTTNG_OK
) {
1452 kernel_wait_quiescent();
1455 case LTTNG_DOMAIN_UST
:
1457 struct ltt_ust_session
*usess
;
1459 usess
= session
->ust_session
;
1461 ret
= trace_ust_track_pid(usess
, pid
);
1462 if (ret
!= LTTNG_OK
) {
1468 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1480 * Command LTTNG_UNTRACK_PID processed by the client thread.
1482 * Called with session lock held.
1484 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1492 case LTTNG_DOMAIN_KERNEL
:
1494 struct ltt_kernel_session
*ksess
;
1496 ksess
= session
->kernel_session
;
1498 ret
= kernel_untrack_pid(ksess
, pid
);
1499 if (ret
!= LTTNG_OK
) {
1503 kernel_wait_quiescent();
1506 case LTTNG_DOMAIN_UST
:
1508 struct ltt_ust_session
*usess
;
1510 usess
= session
->ust_session
;
1512 ret
= trace_ust_untrack_pid(usess
, pid
);
1513 if (ret
!= LTTNG_OK
) {
1519 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1531 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1533 * The wpipe arguments is used as a notifier for the kernel thread.
1535 int cmd_enable_channel(struct ltt_session
*session
,
1536 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1539 struct ltt_ust_session
*usess
= session
->ust_session
;
1540 struct lttng_ht
*chan_ht
;
1542 struct lttng_channel attr
;
1549 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1551 /* Validate channel name */
1552 if (attr
.name
[0] == '.' ||
1553 memchr(attr
.name
, '/', len
) != NULL
) {
1554 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1558 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1563 * Don't try to enable a channel if the session has been started at
1564 * some point in time before. The tracer does not allow it.
1566 if (session
->has_been_started
) {
1567 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1572 * If the session is a live session, remove the switch timer, the
1573 * live timer does the same thing but sends also synchronisation
1574 * beacons for inactive streams.
1576 if (session
->live_timer
> 0) {
1577 attr
.attr
.live_timer_interval
= session
->live_timer
;
1578 attr
.attr
.switch_timer_interval
= 0;
1581 /* Check for feature support */
1582 switch (domain
->type
) {
1583 case LTTNG_DOMAIN_KERNEL
:
1585 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1586 /* Sampling position of buffer is not supported */
1587 WARN("Kernel tracer does not support buffer monitoring. "
1588 "Setting the monitor interval timer to 0 "
1589 "(disabled) for channel '%s' of session '%s'",
1590 attr
.name
, session
->name
);
1591 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1595 case LTTNG_DOMAIN_UST
:
1597 case LTTNG_DOMAIN_JUL
:
1598 case LTTNG_DOMAIN_LOG4J
:
1599 case LTTNG_DOMAIN_PYTHON
:
1600 if (!agent_tracing_is_enabled()) {
1601 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1602 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1607 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1611 switch (domain
->type
) {
1612 case LTTNG_DOMAIN_KERNEL
:
1614 struct ltt_kernel_channel
*kchan
;
1616 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1617 session
->kernel_session
);
1618 if (kchan
== NULL
) {
1619 if (session
->snapshot
.nb_output
> 0 ||
1620 session
->snapshot_mode
) {
1621 /* Enforce mmap output for snapshot sessions. */
1622 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1624 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1625 if (attr
.name
[0] != '\0') {
1626 session
->kernel_session
->has_non_default_channel
= 1;
1629 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1632 if (ret
!= LTTNG_OK
) {
1636 kernel_wait_quiescent();
1639 case LTTNG_DOMAIN_UST
:
1640 case LTTNG_DOMAIN_JUL
:
1641 case LTTNG_DOMAIN_LOG4J
:
1642 case LTTNG_DOMAIN_PYTHON
:
1644 struct ltt_ust_channel
*uchan
;
1649 * Current agent implementation limitations force us to allow
1650 * only one channel at once in "agent" subdomains. Each
1651 * subdomain has a default channel name which must be strictly
1654 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1655 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1656 LTTNG_SYMBOL_NAME_LEN
)) {
1657 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1660 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1661 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1662 LTTNG_SYMBOL_NAME_LEN
)) {
1663 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1666 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1667 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1668 LTTNG_SYMBOL_NAME_LEN
)) {
1669 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1674 chan_ht
= usess
->domain_global
.channels
;
1676 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1677 if (uchan
== NULL
) {
1678 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1679 if (attr
.name
[0] != '\0') {
1680 usess
->has_non_default_channel
= 1;
1683 ret
= channel_ust_enable(usess
, uchan
);
1688 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1692 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1693 session
->has_non_mmap_channel
= true;
1702 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1704 int cmd_disable_event(struct ltt_session
*session
,
1705 enum lttng_domain_type domain
, const char *channel_name
,
1706 const struct lttng_event
*event
)
1709 const char *event_name
;
1711 DBG("Disable event command for event \'%s\'", event
->name
);
1713 event_name
= event
->name
;
1715 /* Error out on unhandled search criteria */
1716 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1717 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1718 ret
= LTTNG_ERR_UNK
;
1725 case LTTNG_DOMAIN_KERNEL
:
1727 struct ltt_kernel_channel
*kchan
;
1728 struct ltt_kernel_session
*ksess
;
1730 ksess
= session
->kernel_session
;
1733 * If a non-default channel has been created in the
1734 * session, explicitely require that -c chan_name needs
1737 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1738 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1742 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1743 if (kchan
== NULL
) {
1744 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1748 switch (event
->type
) {
1749 case LTTNG_EVENT_ALL
:
1750 case LTTNG_EVENT_TRACEPOINT
:
1751 case LTTNG_EVENT_SYSCALL
:
1752 case LTTNG_EVENT_PROBE
:
1753 case LTTNG_EVENT_FUNCTION
:
1754 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1755 if (event_name
[0] == '\0') {
1756 ret
= event_kernel_disable_event(kchan
,
1759 ret
= event_kernel_disable_event(kchan
,
1760 event_name
, event
->type
);
1762 if (ret
!= LTTNG_OK
) {
1767 ret
= LTTNG_ERR_UNK
;
1771 kernel_wait_quiescent();
1774 case LTTNG_DOMAIN_UST
:
1776 struct ltt_ust_channel
*uchan
;
1777 struct ltt_ust_session
*usess
;
1779 usess
= session
->ust_session
;
1781 if (validate_ust_event_name(event_name
)) {
1782 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1787 * If a non-default channel has been created in the
1788 * session, explicitly require that -c chan_name needs
1791 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1792 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1796 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1798 if (uchan
== NULL
) {
1799 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1803 switch (event
->type
) {
1804 case LTTNG_EVENT_ALL
:
1806 * An empty event name means that everything
1807 * should be disabled.
1809 if (event
->name
[0] == '\0') {
1810 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1812 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1815 if (ret
!= LTTNG_OK
) {
1820 ret
= LTTNG_ERR_UNK
;
1824 DBG3("Disable UST event %s in channel %s completed", event_name
,
1828 case LTTNG_DOMAIN_LOG4J
:
1829 case LTTNG_DOMAIN_JUL
:
1830 case LTTNG_DOMAIN_PYTHON
:
1833 struct ltt_ust_session
*usess
= session
->ust_session
;
1837 switch (event
->type
) {
1838 case LTTNG_EVENT_ALL
:
1841 ret
= LTTNG_ERR_UNK
;
1845 agt
= trace_ust_find_agent(usess
, domain
);
1847 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1851 * An empty event name means that everything
1852 * should be disabled.
1854 if (event
->name
[0] == '\0') {
1855 ret
= event_agent_disable_all(usess
, agt
);
1857 ret
= event_agent_disable(usess
, agt
, event_name
);
1859 if (ret
!= LTTNG_OK
) {
1866 ret
= LTTNG_ERR_UND
;
1879 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1881 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1882 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1884 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1885 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1888 * Don't try to add a context if the session has been started at
1889 * some point in time before. The tracer does not allow it and would
1890 * result in a corrupted trace.
1892 if (session
->has_been_started
) {
1893 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1897 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1898 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1899 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1903 case LTTNG_DOMAIN_KERNEL
:
1904 assert(session
->kernel_session
);
1906 if (session
->kernel_session
->channel_count
== 0) {
1907 /* Create default channel */
1908 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1909 if (ret
!= LTTNG_OK
) {
1912 chan_kern_created
= 1;
1914 /* Add kernel context to kernel tracer */
1915 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1916 if (ret
!= LTTNG_OK
) {
1920 case LTTNG_DOMAIN_JUL
:
1921 case LTTNG_DOMAIN_LOG4J
:
1924 * Validate channel name.
1925 * If no channel name is given and the domain is JUL or LOG4J,
1926 * set it to the appropriate domain-specific channel name. If
1927 * a name is provided but does not match the expexted channel
1928 * name, return an error.
1930 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1931 strcmp(channel_name
,
1932 DEFAULT_JUL_CHANNEL_NAME
)) {
1933 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1935 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1936 strcmp(channel_name
,
1937 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1938 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1941 /* break is _not_ missing here. */
1943 case LTTNG_DOMAIN_UST
:
1945 struct ltt_ust_session
*usess
= session
->ust_session
;
1946 unsigned int chan_count
;
1950 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1951 if (chan_count
== 0) {
1952 struct lttng_channel
*attr
;
1953 /* Create default channel */
1954 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1956 ret
= LTTNG_ERR_FATAL
;
1960 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1961 if (ret
!= LTTNG_OK
) {
1965 channel_attr_destroy(attr
);
1966 chan_ust_created
= 1;
1969 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1970 free(app_ctx_provider_name
);
1972 app_ctx_name
= NULL
;
1973 app_ctx_provider_name
= NULL
;
1974 if (ret
!= LTTNG_OK
) {
1980 ret
= LTTNG_ERR_UND
;
1988 if (chan_kern_created
) {
1989 struct ltt_kernel_channel
*kchan
=
1990 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1991 session
->kernel_session
);
1992 /* Created previously, this should NOT fail. */
1994 kernel_destroy_channel(kchan
);
1997 if (chan_ust_created
) {
1998 struct ltt_ust_channel
*uchan
=
1999 trace_ust_find_channel_by_name(
2000 session
->ust_session
->domain_global
.channels
,
2001 DEFAULT_CHANNEL_NAME
);
2002 /* Created previously, this should NOT fail. */
2004 /* Remove from the channel list of the session. */
2005 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2007 trace_ust_destroy_channel(uchan
);
2010 free(app_ctx_provider_name
);
2015 static inline bool name_starts_with(const char *name
, const char *prefix
)
2017 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2019 return !strncmp(name
, prefix
, max_cmp_len
);
2022 /* Perform userspace-specific event name validation */
2023 static int validate_ust_event_name(const char *name
)
2033 * Check name against all internal UST event component namespaces used
2036 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2037 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2038 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2047 * Internal version of cmd_enable_event() with a supplemental
2048 * "internal_event" flag which is used to enable internal events which should
2049 * be hidden from clients. Such events are used in the agent implementation to
2050 * enable the events through which all "agent" events are funeled.
2052 static int _cmd_enable_event(struct ltt_session
*session
,
2053 const struct lttng_domain
*domain
,
2054 char *channel_name
, struct lttng_event
*event
,
2055 char *filter_expression
,
2056 struct lttng_filter_bytecode
*filter
,
2057 struct lttng_event_exclusion
*exclusion
,
2058 int wpipe
, bool internal_event
)
2060 int ret
= 0, channel_created
= 0;
2061 struct lttng_channel
*attr
= NULL
;
2065 assert(channel_name
);
2067 /* If we have a filter, we must have its filter expression */
2068 assert(!(!!filter_expression
^ !!filter
));
2070 /* Normalize event name as a globbing pattern */
2071 strutils_normalize_star_glob_pattern(event
->name
);
2073 /* Normalize exclusion names as globbing patterns */
2077 for (i
= 0; i
< exclusion
->count
; i
++) {
2078 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2080 strutils_normalize_star_glob_pattern(name
);
2084 DBG("Enable event command for event \'%s\'", event
->name
);
2088 switch (domain
->type
) {
2089 case LTTNG_DOMAIN_KERNEL
:
2091 struct ltt_kernel_channel
*kchan
;
2094 * If a non-default channel has been created in the
2095 * session, explicitely require that -c chan_name needs
2098 if (session
->kernel_session
->has_non_default_channel
2099 && channel_name
[0] == '\0') {
2100 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2104 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2105 session
->kernel_session
);
2106 if (kchan
== NULL
) {
2107 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2108 LTTNG_BUFFER_GLOBAL
);
2110 ret
= LTTNG_ERR_FATAL
;
2113 if (lttng_strncpy(attr
->name
, channel_name
,
2114 sizeof(attr
->name
))) {
2115 ret
= LTTNG_ERR_INVALID
;
2119 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2120 if (ret
!= LTTNG_OK
) {
2123 channel_created
= 1;
2126 /* Get the newly created kernel channel pointer */
2127 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2128 session
->kernel_session
);
2129 if (kchan
== NULL
) {
2130 /* This sould not happen... */
2131 ret
= LTTNG_ERR_FATAL
;
2135 switch (event
->type
) {
2136 case LTTNG_EVENT_ALL
:
2138 char *filter_expression_a
= NULL
;
2139 struct lttng_filter_bytecode
*filter_a
= NULL
;
2142 * We need to duplicate filter_expression and filter,
2143 * because ownership is passed to first enable
2146 if (filter_expression
) {
2147 filter_expression_a
= strdup(filter_expression
);
2148 if (!filter_expression_a
) {
2149 ret
= LTTNG_ERR_FATAL
;
2154 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2156 free(filter_expression_a
);
2157 ret
= LTTNG_ERR_FATAL
;
2160 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2162 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2163 ret
= event_kernel_enable_event(kchan
, event
,
2164 filter_expression
, filter
);
2165 /* We have passed ownership */
2166 filter_expression
= NULL
;
2168 if (ret
!= LTTNG_OK
) {
2169 if (channel_created
) {
2170 /* Let's not leak a useless channel. */
2171 kernel_destroy_channel(kchan
);
2173 free(filter_expression_a
);
2177 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2178 ret
= event_kernel_enable_event(kchan
, event
,
2179 filter_expression_a
, filter_a
);
2180 /* We have passed ownership */
2181 filter_expression_a
= NULL
;
2183 if (ret
!= LTTNG_OK
) {
2188 case LTTNG_EVENT_PROBE
:
2189 case LTTNG_EVENT_USERSPACE_PROBE
:
2190 case LTTNG_EVENT_FUNCTION
:
2191 case LTTNG_EVENT_FUNCTION_ENTRY
:
2192 case LTTNG_EVENT_TRACEPOINT
:
2193 ret
= event_kernel_enable_event(kchan
, event
,
2194 filter_expression
, filter
);
2195 /* We have passed ownership */
2196 filter_expression
= NULL
;
2198 if (ret
!= LTTNG_OK
) {
2199 if (channel_created
) {
2200 /* Let's not leak a useless channel. */
2201 kernel_destroy_channel(kchan
);
2206 case LTTNG_EVENT_SYSCALL
:
2207 ret
= event_kernel_enable_event(kchan
, event
,
2208 filter_expression
, filter
);
2209 /* We have passed ownership */
2210 filter_expression
= NULL
;
2212 if (ret
!= LTTNG_OK
) {
2217 ret
= LTTNG_ERR_UNK
;
2221 kernel_wait_quiescent();
2224 case LTTNG_DOMAIN_UST
:
2226 struct ltt_ust_channel
*uchan
;
2227 struct ltt_ust_session
*usess
= session
->ust_session
;
2232 * If a non-default channel has been created in the
2233 * session, explicitely require that -c chan_name needs
2236 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2237 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2241 /* Get channel from global UST domain */
2242 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2244 if (uchan
== NULL
) {
2245 /* Create default channel */
2246 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2247 usess
->buffer_type
);
2249 ret
= LTTNG_ERR_FATAL
;
2252 if (lttng_strncpy(attr
->name
, channel_name
,
2253 sizeof(attr
->name
))) {
2254 ret
= LTTNG_ERR_INVALID
;
2258 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2259 if (ret
!= LTTNG_OK
) {
2263 /* Get the newly created channel reference back */
2264 uchan
= trace_ust_find_channel_by_name(
2265 usess
->domain_global
.channels
, channel_name
);
2269 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2271 * Don't allow users to add UST events to channels which
2272 * are assigned to a userspace subdomain (JUL, Log4J,
2275 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2279 if (!internal_event
) {
2281 * Ensure the event name is not reserved for internal
2284 ret
= validate_ust_event_name(event
->name
);
2286 WARN("Userspace event name %s failed validation.",
2288 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2293 /* At this point, the session and channel exist on the tracer */
2294 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2295 filter_expression
, filter
, exclusion
,
2297 /* We have passed ownership */
2298 filter_expression
= NULL
;
2301 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2302 goto already_enabled
;
2303 } else if (ret
!= LTTNG_OK
) {
2308 case LTTNG_DOMAIN_LOG4J
:
2309 case LTTNG_DOMAIN_JUL
:
2310 case LTTNG_DOMAIN_PYTHON
:
2312 const char *default_event_name
, *default_chan_name
;
2314 struct lttng_event uevent
;
2315 struct lttng_domain tmp_dom
;
2316 struct ltt_ust_session
*usess
= session
->ust_session
;
2320 if (!agent_tracing_is_enabled()) {
2321 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2322 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2326 agt
= trace_ust_find_agent(usess
, domain
->type
);
2328 agt
= agent_create(domain
->type
);
2330 ret
= LTTNG_ERR_NOMEM
;
2333 agent_add(agt
, usess
->agents
);
2336 /* Create the default tracepoint. */
2337 memset(&uevent
, 0, sizeof(uevent
));
2338 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2339 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2340 default_event_name
= event_get_default_agent_ust_name(
2342 if (!default_event_name
) {
2343 ret
= LTTNG_ERR_FATAL
;
2346 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2347 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2350 * The domain type is changed because we are about to enable the
2351 * default channel and event for the JUL domain that are hardcoded.
2352 * This happens in the UST domain.
2354 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2355 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2357 switch (domain
->type
) {
2358 case LTTNG_DOMAIN_LOG4J
:
2359 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2361 case LTTNG_DOMAIN_JUL
:
2362 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2364 case LTTNG_DOMAIN_PYTHON
:
2365 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2368 /* The switch/case we are in makes this impossible */
2373 char *filter_expression_copy
= NULL
;
2374 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2377 const size_t filter_size
= sizeof(
2378 struct lttng_filter_bytecode
)
2381 filter_copy
= zmalloc(filter_size
);
2383 ret
= LTTNG_ERR_NOMEM
;
2386 memcpy(filter_copy
, filter
, filter_size
);
2388 filter_expression_copy
=
2389 strdup(filter_expression
);
2390 if (!filter_expression
) {
2391 ret
= LTTNG_ERR_NOMEM
;
2394 if (!filter_expression_copy
|| !filter_copy
) {
2395 free(filter_expression_copy
);
2401 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2402 (char *) default_chan_name
,
2403 &uevent
, filter_expression_copy
,
2404 filter_copy
, NULL
, wpipe
);
2407 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2408 goto already_enabled
;
2409 } else if (ret
!= LTTNG_OK
) {
2413 /* The wild card * means that everything should be enabled. */
2414 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2415 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2418 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2422 filter_expression
= NULL
;
2423 if (ret
!= LTTNG_OK
) {
2430 ret
= LTTNG_ERR_UND
;
2438 free(filter_expression
);
2441 channel_attr_destroy(attr
);
2447 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2448 * We own filter, exclusion, and filter_expression.
2450 int cmd_enable_event(struct ltt_session
*session
,
2451 const struct lttng_domain
*domain
,
2452 char *channel_name
, struct lttng_event
*event
,
2453 char *filter_expression
,
2454 struct lttng_filter_bytecode
*filter
,
2455 struct lttng_event_exclusion
*exclusion
,
2458 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2459 filter_expression
, filter
, exclusion
, wpipe
, false);
2463 * Enable an event which is internal to LTTng. An internal should
2464 * never be made visible to clients and are immune to checks such as
2467 static int cmd_enable_event_internal(struct ltt_session
*session
,
2468 const struct lttng_domain
*domain
,
2469 char *channel_name
, struct lttng_event
*event
,
2470 char *filter_expression
,
2471 struct lttng_filter_bytecode
*filter
,
2472 struct lttng_event_exclusion
*exclusion
,
2475 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2476 filter_expression
, filter
, exclusion
, wpipe
, true);
2480 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2482 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2483 struct lttng_event
**events
)
2486 ssize_t nb_events
= 0;
2489 case LTTNG_DOMAIN_KERNEL
:
2490 nb_events
= kernel_list_events(events
);
2491 if (nb_events
< 0) {
2492 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2496 case LTTNG_DOMAIN_UST
:
2497 nb_events
= ust_app_list_events(events
);
2498 if (nb_events
< 0) {
2499 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2503 case LTTNG_DOMAIN_LOG4J
:
2504 case LTTNG_DOMAIN_JUL
:
2505 case LTTNG_DOMAIN_PYTHON
:
2506 nb_events
= agent_list_events(events
, domain
);
2507 if (nb_events
< 0) {
2508 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2513 ret
= LTTNG_ERR_UND
;
2520 /* Return negative value to differentiate return code */
2525 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2527 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2528 struct lttng_event_field
**fields
)
2531 ssize_t nb_fields
= 0;
2534 case LTTNG_DOMAIN_UST
:
2535 nb_fields
= ust_app_list_event_fields(fields
);
2536 if (nb_fields
< 0) {
2537 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2541 case LTTNG_DOMAIN_KERNEL
:
2542 default: /* fall-through */
2543 ret
= LTTNG_ERR_UND
;
2550 /* Return negative value to differentiate return code */
2554 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2556 return syscall_table_list(events
);
2560 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2562 * Called with session lock held.
2564 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2565 enum lttng_domain_type domain
, int32_t **pids
)
2568 ssize_t nr_pids
= 0;
2571 case LTTNG_DOMAIN_KERNEL
:
2573 struct ltt_kernel_session
*ksess
;
2575 ksess
= session
->kernel_session
;
2576 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2578 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2583 case LTTNG_DOMAIN_UST
:
2585 struct ltt_ust_session
*usess
;
2587 usess
= session
->ust_session
;
2588 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2590 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2595 case LTTNG_DOMAIN_LOG4J
:
2596 case LTTNG_DOMAIN_JUL
:
2597 case LTTNG_DOMAIN_PYTHON
:
2599 ret
= LTTNG_ERR_UND
;
2606 /* Return negative value to differentiate return code */
2611 * Command LTTNG_START_TRACE processed by the client thread.
2613 * Called with session mutex held.
2615 int cmd_start_trace(struct ltt_session
*session
)
2617 enum lttng_error_code ret
;
2618 unsigned long nb_chan
= 0;
2619 struct ltt_kernel_session
*ksession
;
2620 struct ltt_ust_session
*usess
;
2621 const bool session_rotated_after_last_stop
=
2622 session
->rotated_after_last_stop
;
2626 /* Ease our life a bit ;) */
2627 ksession
= session
->kernel_session
;
2628 usess
= session
->ust_session
;
2630 /* Is the session already started? */
2631 if (session
->active
) {
2632 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2636 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2637 !session
->current_trace_chunk
) {
2639 * A rotation was launched while the session was stopped and
2640 * it has not been completed yet. It is not possible to start
2641 * the session since starting the session here would require a
2642 * rotation from "NULL" to a new trace chunk. That rotation
2643 * would overlap with the ongoing rotation, which is not
2646 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2648 ret
= LTTNG_ERR_ROTATION_PENDING
;
2653 * Starting a session without channel is useless since after that it's not
2654 * possible to enable channel thus inform the client.
2656 if (usess
&& usess
->domain_global
.channels
) {
2657 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2660 nb_chan
+= ksession
->channel_count
;
2663 ret
= LTTNG_ERR_NO_CHANNEL
;
2667 session
->active
= 1;
2668 session
->rotated_after_last_stop
= false;
2669 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2670 if (!session
->has_been_started
) {
2671 struct lttng_trace_chunk
*trace_chunk
;
2673 DBG("Creating initial trace chunk of session \"%s\"",
2675 trace_chunk
= session_create_new_trace_chunk(
2676 session
, NULL
, NULL
, NULL
);
2678 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2681 assert(!session
->current_trace_chunk
);
2682 ret
= session_set_trace_chunk(session
, trace_chunk
,
2684 lttng_trace_chunk_put(trace_chunk
);
2686 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2690 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2693 * Rotate existing streams into the new chunk.
2694 * This is a "quiet" rotation has no client has
2695 * explicitly requested this operation.
2697 * There is also no need to wait for the rotation
2698 * to complete as it will happen immediately. No data
2699 * was produced as the session was stopped, so the
2700 * rotation should happen on reception of the command.
2702 ret
= cmd_rotate_session(session
, NULL
, true);
2703 if (ret
!= LTTNG_OK
) {
2709 /* Kernel tracing */
2710 if (ksession
!= NULL
) {
2711 DBG("Start kernel tracing session %s", session
->name
);
2712 ret
= start_kernel_session(ksession
);
2713 if (ret
!= LTTNG_OK
) {
2718 /* Flag session that trace should start automatically */
2720 int int_ret
= ust_app_start_trace_all(usess
);
2723 ret
= LTTNG_ERR_UST_START_FAIL
;
2729 * Clear the flag that indicates that a rotation was done while the
2730 * session was stopped.
2732 session
->rotated_after_last_stop
= false;
2734 if (session
->rotate_timer_period
) {
2735 int int_ret
= timer_session_rotation_schedule_timer_start(
2736 session
, session
->rotate_timer_period
);
2739 ERR("Failed to enable rotate timer");
2740 ret
= LTTNG_ERR_UNK
;
2748 if (ret
== LTTNG_OK
) {
2749 /* Flag this after a successful start. */
2750 session
->has_been_started
|= 1;
2752 session
->active
= 0;
2753 /* Restore initial state on error. */
2754 session
->rotated_after_last_stop
=
2755 session_rotated_after_last_stop
;
2761 * Command LTTNG_STOP_TRACE processed by the client thread.
2763 int cmd_stop_trace(struct ltt_session
*session
)
2766 struct ltt_kernel_session
*ksession
;
2767 struct ltt_ust_session
*usess
;
2771 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2773 ksession
= session
->kernel_session
;
2774 usess
= session
->ust_session
;
2776 /* Session is not active. Skip everythong and inform the client. */
2777 if (!session
->active
) {
2778 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2782 ret
= stop_kernel_session(ksession
);
2783 if (ret
!= LTTNG_OK
) {
2787 if (usess
&& usess
->active
) {
2788 ret
= ust_app_stop_trace_all(usess
);
2790 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2795 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2797 /* Flag inactive after a successful stop. */
2798 session
->active
= 0;
2806 * Set the base_path of the session only if subdir of a control uris is set.
2807 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2809 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2811 struct lttng_uri
*uris
)
2816 for (i
= 0; i
< nb_uri
; i
++) {
2817 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2818 uris
[i
].subdir
[0] == '\0') {
2819 /* Not interested in these URIs */
2823 if (session
->base_path
!= NULL
) {
2824 free(session
->base_path
);
2825 session
->base_path
= NULL
;
2828 /* Set session base_path */
2829 session
->base_path
= strdup(uris
[i
].subdir
);
2830 if (!session
->base_path
) {
2831 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2832 uris
[i
].subdir
, session
->name
);
2833 ret
= LTTNG_ERR_NOMEM
;
2836 DBG2("Setting base path \"%s\" for session \"%s\"",
2837 session
->base_path
, session
->name
);
2845 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2847 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2848 struct lttng_uri
*uris
)
2851 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2852 struct ltt_ust_session
*usess
= session
->ust_session
;
2858 /* Can't set consumer URI if the session is active. */
2859 if (session
->active
) {
2860 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2865 * Set the session base path if any. This is done inside
2866 * cmd_set_consumer_uri to preserve backward compatibility of the
2867 * previous session creation api vs the session descriptor api.
2869 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2870 if (ret
!= LTTNG_OK
) {
2874 /* Set the "global" consumer URIs */
2875 for (i
= 0; i
< nb_uri
; i
++) {
2876 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2878 if (ret
!= LTTNG_OK
) {
2883 /* Set UST session URIs */
2884 if (session
->ust_session
) {
2885 for (i
= 0; i
< nb_uri
; i
++) {
2886 ret
= add_uri_to_consumer(session
,
2887 session
->ust_session
->consumer
,
2888 &uris
[i
], LTTNG_DOMAIN_UST
);
2889 if (ret
!= LTTNG_OK
) {
2895 /* Set kernel session URIs */
2896 if (session
->kernel_session
) {
2897 for (i
= 0; i
< nb_uri
; i
++) {
2898 ret
= add_uri_to_consumer(session
,
2899 session
->kernel_session
->consumer
,
2900 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2901 if (ret
!= LTTNG_OK
) {
2908 * Make sure to set the session in output mode after we set URI since a
2909 * session can be created without URL (thus flagged in no output mode).
2911 session
->output_traces
= 1;
2913 ksess
->output_traces
= 1;
2917 usess
->output_traces
= 1;
2928 enum lttng_error_code
set_session_output_from_descriptor(
2929 struct ltt_session
*session
,
2930 const struct lttng_session_descriptor
*descriptor
)
2933 enum lttng_error_code ret_code
= LTTNG_OK
;
2934 enum lttng_session_descriptor_type session_type
=
2935 lttng_session_descriptor_get_type(descriptor
);
2936 enum lttng_session_descriptor_output_type output_type
=
2937 lttng_session_descriptor_get_output_type(descriptor
);
2938 struct lttng_uri uris
[2] = {};
2939 size_t uri_count
= 0;
2941 switch (output_type
) {
2942 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2944 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2945 lttng_session_descriptor_get_local_output_uri(descriptor
,
2949 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2950 lttng_session_descriptor_get_network_output_uris(descriptor
,
2951 &uris
[0], &uris
[1]);
2955 ret_code
= LTTNG_ERR_INVALID
;
2959 switch (session_type
) {
2960 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2962 struct snapshot_output
*new_output
= NULL
;
2964 new_output
= snapshot_output_alloc();
2966 ret_code
= LTTNG_ERR_NOMEM
;
2970 ret
= snapshot_output_init_with_uri(session
,
2971 DEFAULT_SNAPSHOT_MAX_SIZE
,
2972 NULL
, uris
, uri_count
, session
->consumer
,
2973 new_output
, &session
->snapshot
);
2975 ret_code
= (ret
== -ENOMEM
) ?
2976 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2977 snapshot_output_destroy(new_output
);
2980 snapshot_add_output(&session
->snapshot
, new_output
);
2983 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2984 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2986 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2990 ret_code
= LTTNG_ERR_INVALID
;
2998 enum lttng_error_code
cmd_create_session_from_descriptor(
2999 struct lttng_session_descriptor
*descriptor
,
3000 const lttng_sock_cred
*creds
,
3001 const char *home_path
)
3004 enum lttng_error_code ret_code
;
3005 const char *session_name
;
3006 struct ltt_session
*new_session
= NULL
;
3007 enum lttng_session_descriptor_status descriptor_status
;
3009 session_lock_list();
3011 if (*home_path
!= '/') {
3012 ERR("Home path provided by client is not absolute");
3013 ret_code
= LTTNG_ERR_INVALID
;
3018 descriptor_status
= lttng_session_descriptor_get_session_name(
3019 descriptor
, &session_name
);
3020 switch (descriptor_status
) {
3021 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3023 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3024 session_name
= NULL
;
3027 ret_code
= LTTNG_ERR_INVALID
;
3031 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3033 if (ret_code
!= LTTNG_OK
) {
3037 if (!session_name
) {
3038 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3041 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3046 if (!lttng_session_descriptor_is_output_destination_initialized(
3049 * Only include the session's creation time in the output
3050 * destination if the name of the session itself was
3051 * not auto-generated.
3053 ret_code
= lttng_session_descriptor_set_default_output(
3055 session_name
? &new_session
->creation_time
: NULL
,
3057 if (ret_code
!= LTTNG_OK
) {
3061 new_session
->has_user_specified_directory
=
3062 lttng_session_descriptor_has_output_directory(
3066 switch (lttng_session_descriptor_get_type(descriptor
)) {
3067 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3068 new_session
->snapshot_mode
= 1;
3070 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3071 new_session
->live_timer
=
3072 lttng_session_descriptor_live_get_timer_interval(
3079 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3080 if (ret_code
!= LTTNG_OK
) {
3083 new_session
->consumer
->enabled
= 1;
3084 ret_code
= LTTNG_OK
;
3086 /* Release reference provided by the session_create function. */
3087 session_put(new_session
);
3088 if (ret_code
!= LTTNG_OK
&& new_session
) {
3089 /* Release the global reference on error. */
3090 session_destroy(new_session
);
3092 session_unlock_list();
3096 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3097 struct lttng_session_descriptor
**return_descriptor
)
3100 size_t payload_size
;
3101 struct lttng_dynamic_buffer payload
;
3102 struct lttng_buffer_view home_dir_view
;
3103 struct lttng_buffer_view session_descriptor_view
;
3104 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3105 enum lttng_error_code ret_code
;
3107 lttng_dynamic_buffer_init(&payload
);
3108 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3110 ret_code
= LTTNG_ERR_INVALID
;
3113 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3114 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3115 ret_code
= LTTNG_ERR_INVALID
;
3119 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3120 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3121 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3123 ret_code
= LTTNG_ERR_NOMEM
;
3127 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3129 ERR("Reception of session descriptor failed, aborting.");
3130 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3134 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3137 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3138 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3140 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3141 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3143 ret
= lttng_session_descriptor_create_from_buffer(
3144 &session_descriptor_view
, &session_descriptor
);
3146 ERR("Failed to create session descriptor from payload of \"create session\" command");
3147 ret_code
= LTTNG_ERR_INVALID
;
3152 * Sets the descriptor's auto-generated properties (name, output) if
3155 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3157 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3158 if (ret_code
!= LTTNG_OK
) {
3162 ret_code
= LTTNG_OK
;
3163 *return_descriptor
= session_descriptor
;
3164 session_descriptor
= NULL
;
3166 lttng_dynamic_buffer_reset(&payload
);
3167 lttng_session_descriptor_destroy(session_descriptor
);
3172 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3173 void *_reply_context
)
3177 const struct cmd_destroy_session_reply_context
*reply_context
=
3179 struct lttng_dynamic_buffer payload
;
3180 struct lttcomm_session_destroy_command_header cmd_header
;
3181 struct lttng_trace_archive_location
*location
= NULL
;
3182 struct lttcomm_lttng_msg llm
= {
3183 .cmd_type
= LTTNG_DESTROY_SESSION
,
3184 .ret_code
= reply_context
->destruction_status
,
3187 sizeof(struct lttcomm_session_destroy_command_header
),
3190 size_t payload_size_before_location
;
3192 lttng_dynamic_buffer_init(&payload
);
3194 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3196 ERR("Failed to append session destruction message");
3200 cmd_header
.rotation_state
=
3201 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3202 session
->rotation_state
:
3203 LTTNG_ROTATION_STATE_NO_ROTATION
);
3204 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3205 sizeof(cmd_header
));
3207 ERR("Failed to append session destruction command header");
3211 if (!reply_context
->implicit_rotation_on_destroy
) {
3212 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3216 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3217 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3222 location
= session_get_trace_archive_location(session
);
3224 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3229 payload_size_before_location
= payload
.size
;
3230 comm_ret
= lttng_trace_archive_location_serialize(location
,
3233 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3237 /* Update the message to indicate the location's length. */
3238 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3239 payload
.size
- payload_size_before_location
;
3241 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3242 payload
.data
, payload
.size
);
3243 if (comm_ret
!= (ssize_t
) payload
.size
) {
3244 ERR("Failed to send result of the destruction of session \"%s\" to client",
3248 ret
= close(reply_context
->reply_sock_fd
);
3250 PERROR("Failed to close client socket in deferred session destroy reply");
3252 lttng_dynamic_buffer_reset(&payload
);
3253 free(_reply_context
);
3257 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3259 * Called with session lock held.
3261 int cmd_destroy_session(struct ltt_session
*session
,
3262 struct notification_thread_handle
*notification_thread_handle
,
3266 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3267 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3270 reply_context
= zmalloc(sizeof(*reply_context
));
3271 if (!reply_context
) {
3272 ret
= LTTNG_ERR_NOMEM
;
3275 reply_context
->reply_sock_fd
= *sock_fd
;
3281 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3283 if (session
->active
) {
3284 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3286 ret
= cmd_stop_trace(session
);
3287 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3288 /* Carry on with the destruction of the session. */
3289 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3290 session
->name
, lttng_strerror(-ret
));
3291 destruction_last_error
= ret
;
3295 if (session
->rotation_schedule_timer_enabled
) {
3296 if (timer_session_rotation_schedule_timer_stop(
3298 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3300 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3304 if (session
->rotate_size
) {
3305 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3306 session
->rotate_size
= 0;
3309 if (session
->most_recent_chunk_id
.is_set
&&
3310 session
->most_recent_chunk_id
.value
!= 0 &&
3311 session
->current_trace_chunk
&& session
->output_traces
) {
3313 * Perform a last rotation on destruction if rotations have
3314 * occurred during the session's lifetime.
3316 ret
= cmd_rotate_session(session
, NULL
, false);
3317 if (ret
!= LTTNG_OK
) {
3318 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3319 session
->name
, lttng_strerror(-ret
));
3320 destruction_last_error
= -ret
;
3322 if (reply_context
) {
3323 reply_context
->implicit_rotation_on_destroy
= true;
3325 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3327 * The user has not triggered a session rotation. However, to
3328 * ensure all data has been consumed, the session is rotated
3329 * to a 'null' trace chunk before it is destroyed.
3331 * This is a "quiet" rotation meaning that no notification is
3332 * emitted and no renaming of the current trace chunk takes
3335 ret
= cmd_rotate_session(session
, NULL
, true);
3336 if (ret
!= LTTNG_OK
) {
3337 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3338 session
->name
, lttng_strerror(-ret
));
3339 destruction_last_error
= -ret
;
3343 if (session
->shm_path
[0]) {
3345 * When a session is created with an explicit shm_path,
3346 * the consumer daemon will create its shared memory files
3347 * at that location and will *not* unlink them. This is normal
3348 * as the intention of that feature is to make it possible
3349 * to retrieve the content of those files should a crash occur.
3351 * To ensure the content of those files can be used, the
3352 * sessiond daemon will replicate the content of the metadata
3353 * cache in a metadata file.
3355 * On clean-up, it is expected that the consumer daemon will
3356 * unlink the shared memory files and that the session daemon
3357 * will unlink the metadata file. Then, the session's directory
3358 * in the shm path can be removed.
3360 * Unfortunately, a flaw in the design of the sessiond's and
3361 * consumerd's tear down of channels makes it impossible to
3362 * determine when the sessiond _and_ the consumerd have both
3363 * destroyed their representation of a channel. For one, the
3364 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3365 * callbacks in both daemons.
3367 * However, it is also impossible for the sessiond to know when
3368 * the consumer daemon is done destroying its channel(s) since
3369 * it occurs as a reaction to the closing of the channel's file
3370 * descriptor. There is no resulting communication initiated
3371 * from the consumerd to the sessiond to confirm that the
3372 * operation is completed (and was successful).
3374 * Until this is all fixed, the session daemon checks for the
3375 * removal of the session's shm path which makes it possible
3376 * to safely advertise a session as having been destroyed.
3378 * Prior to this fix, it was not possible to reliably save
3379 * a session making use of the --shm-path option, destroy it,
3380 * and load it again. This is because the creation of the
3381 * session would fail upon seeing the session's shm path
3382 * already in existence.
3384 * Note that none of the error paths in the check for the
3385 * directory's existence return an error. This is normal
3386 * as there isn't much that can be done. The session will
3387 * be destroyed properly, except that we can't offer the
3388 * guarantee that the same session can be re-created.
3390 current_completion_handler
= &destroy_completion_handler
.handler
;
3391 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3393 sizeof(destroy_completion_handler
.shm_path
));
3398 * The session is destroyed. However, note that the command context
3399 * still holds a reference to the session, thus delaying its destruction
3400 * _at least_ up to the point when that reference is released.
3402 session_destroy(session
);
3403 if (reply_context
) {
3404 reply_context
->destruction_status
= destruction_last_error
;
3405 ret
= session_add_destroy_notifier(session
,
3406 cmd_destroy_session_reply
,
3407 (void *) reply_context
);
3409 ret
= LTTNG_ERR_FATAL
;
3421 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3423 int cmd_register_consumer(struct ltt_session
*session
,
3424 enum lttng_domain_type domain
, const char *sock_path
,
3425 struct consumer_data
*cdata
)
3428 struct consumer_socket
*socket
= NULL
;
3435 case LTTNG_DOMAIN_KERNEL
:
3437 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3441 /* Can't register a consumer if there is already one */
3442 if (ksess
->consumer_fds_sent
!= 0) {
3443 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3447 sock
= lttcomm_connect_unix_sock(sock_path
);
3449 ret
= LTTNG_ERR_CONNECT_FAIL
;
3452 cdata
->cmd_sock
= sock
;
3454 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3455 if (socket
== NULL
) {
3458 PERROR("close register consumer");
3460 cdata
->cmd_sock
= -1;
3461 ret
= LTTNG_ERR_FATAL
;
3465 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3466 if (socket
->lock
== NULL
) {
3467 PERROR("zmalloc pthread mutex");
3468 ret
= LTTNG_ERR_FATAL
;
3471 pthread_mutex_init(socket
->lock
, NULL
);
3472 socket
->registered
= 1;
3475 consumer_add_socket(socket
, ksess
->consumer
);
3478 pthread_mutex_lock(&cdata
->pid_mutex
);
3480 pthread_mutex_unlock(&cdata
->pid_mutex
);
3485 /* TODO: Userspace tracing */
3486 ret
= LTTNG_ERR_UND
;
3494 consumer_destroy_socket(socket
);
3500 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3502 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3503 struct lttng_domain
**domains
)
3508 struct lttng_ht_iter iter
;
3510 if (session
->kernel_session
!= NULL
) {
3511 DBG3("Listing domains found kernel domain");
3515 if (session
->ust_session
!= NULL
) {
3516 DBG3("Listing domains found UST global domain");
3520 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3522 if (agt
->being_used
) {
3533 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3534 if (*domains
== NULL
) {
3535 ret
= LTTNG_ERR_FATAL
;
3539 if (session
->kernel_session
!= NULL
) {
3540 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3542 /* Kernel session buffer type is always GLOBAL */
3543 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3548 if (session
->ust_session
!= NULL
) {
3549 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3550 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3554 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3556 if (agt
->being_used
) {
3557 (*domains
)[index
].type
= agt
->domain
;
3558 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3568 /* Return negative value to differentiate return code */
3574 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3576 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3577 struct ltt_session
*session
, struct lttng_channel
**channels
)
3579 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3582 case LTTNG_DOMAIN_KERNEL
:
3583 if (session
->kernel_session
!= NULL
) {
3584 nb_chan
= session
->kernel_session
->channel_count
;
3586 DBG3("Number of kernel channels %zd", nb_chan
);
3588 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3592 case LTTNG_DOMAIN_UST
:
3593 if (session
->ust_session
!= NULL
) {
3595 nb_chan
= lttng_ht_get_count(
3596 session
->ust_session
->domain_global
.channels
);
3599 DBG3("Number of UST global channels %zd", nb_chan
);
3601 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3606 ret
= -LTTNG_ERR_UND
;
3611 const size_t channel_size
= sizeof(struct lttng_channel
) +
3612 sizeof(struct lttng_channel_extended
);
3613 struct lttng_channel_extended
*channel_exts
;
3615 payload_size
= nb_chan
* channel_size
;
3616 *channels
= zmalloc(payload_size
);
3617 if (*channels
== NULL
) {
3618 ret
= -LTTNG_ERR_FATAL
;
3622 channel_exts
= ((void *) *channels
) +
3623 (nb_chan
* sizeof(struct lttng_channel
));
3624 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3625 if (ret
!= LTTNG_OK
) {
3640 * Command LTTNG_LIST_EVENTS processed by the client thread.
3642 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3643 struct ltt_session
*session
, char *channel_name
,
3644 struct lttng_event
**events
, size_t *total_size
)
3647 ssize_t nb_event
= 0;
3650 case LTTNG_DOMAIN_KERNEL
:
3651 if (session
->kernel_session
!= NULL
) {
3652 nb_event
= list_lttng_kernel_events(channel_name
,
3653 session
->kernel_session
, events
,
3657 case LTTNG_DOMAIN_UST
:
3659 if (session
->ust_session
!= NULL
) {
3660 nb_event
= list_lttng_ust_global_events(channel_name
,
3661 &session
->ust_session
->domain_global
, events
,
3666 case LTTNG_DOMAIN_LOG4J
:
3667 case LTTNG_DOMAIN_JUL
:
3668 case LTTNG_DOMAIN_PYTHON
:
3669 if (session
->ust_session
) {
3670 struct lttng_ht_iter iter
;
3674 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3675 &iter
.iter
, agt
, node
.node
) {
3676 if (agt
->domain
== domain
) {
3677 nb_event
= list_lttng_agent_events(
3687 ret
= LTTNG_ERR_UND
;
3694 /* Return negative value to differentiate return code */
3699 * Using the session list, filled a lttng_session array to send back to the
3700 * client for session listing.
3702 * The session list lock MUST be acquired before calling this function. Use
3703 * session_lock_list() and session_unlock_list().
3705 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3706 size_t session_count
, uid_t uid
, gid_t gid
)
3710 struct ltt_session
*session
;
3711 struct ltt_session_list
*list
= session_get_list();
3712 struct lttng_session_extended
*extended
=
3713 (typeof(extended
)) (&sessions
[session_count
]);
3715 DBG("Getting all available session for UID %d GID %d",
3718 * Iterate over session list and append data after the control struct in
3721 cds_list_for_each_entry(session
, &list
->head
, list
) {
3722 if (!session_get(session
)) {
3726 * Only list the sessions the user can control.
3728 if (!session_access_ok(session
, uid
, gid
) ||
3729 session
->destroyed
) {
3730 session_put(session
);
3734 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3735 struct ltt_ust_session
*usess
= session
->ust_session
;
3737 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3738 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3739 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3740 ret
= build_network_session_path(sessions
[i
].path
,
3741 sizeof(sessions
[i
].path
), session
);
3743 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3744 session
->consumer
->dst
.session_root_path
);
3747 PERROR("snprintf session path");
3748 session_put(session
);
3752 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3753 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3754 sessions
[i
].enabled
= session
->active
;
3755 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3756 sessions
[i
].live_timer_interval
= session
->live_timer
;
3757 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3758 extended
[i
].creation_time
.is_set
= 1;
3760 session_put(session
);
3765 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3766 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3768 int cmd_data_pending(struct ltt_session
*session
)
3771 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3772 struct ltt_ust_session
*usess
= session
->ust_session
;
3776 DBG("Data pending for session %s", session
->name
);
3778 /* Session MUST be stopped to ask for data availability. */
3779 if (session
->active
) {
3780 ret
= LTTNG_ERR_SESSION_STARTED
;
3784 * If stopped, just make sure we've started before else the above call
3785 * will always send that there is data pending.
3787 * The consumer assumes that when the data pending command is received,
3788 * the trace has been started before or else no output data is written
3789 * by the streams which is a condition for data pending. So, this is
3790 * *VERY* important that we don't ask the consumer before a start
3793 if (!session
->has_been_started
) {
3799 /* A rotation is still pending, we have to wait. */
3800 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3801 DBG("Rotate still pending for session %s", session
->name
);
3806 if (ksess
&& ksess
->consumer
) {
3807 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3809 /* Data is still being extracted for the kernel. */
3814 if (usess
&& usess
->consumer
) {
3815 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3817 /* Data is still being extracted for the kernel. */
3822 /* Data is ready to be read by a viewer */
3830 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3832 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3834 int cmd_snapshot_add_output(struct ltt_session
*session
,
3835 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3838 struct snapshot_output
*new_output
;
3843 DBG("Cmd snapshot add output for session %s", session
->name
);
3846 * Can't create an output if the session is not set in no-output mode.
3848 if (session
->output_traces
) {
3849 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3853 if (session
->has_non_mmap_channel
) {
3854 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3858 /* Only one output is allowed until we have the "tee" feature. */
3859 if (session
->snapshot
.nb_output
== 1) {
3860 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3864 new_output
= snapshot_output_alloc();
3866 ret
= LTTNG_ERR_NOMEM
;
3870 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3871 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3872 &session
->snapshot
);
3874 if (ret
== -ENOMEM
) {
3875 ret
= LTTNG_ERR_NOMEM
;
3877 ret
= LTTNG_ERR_INVALID
;
3883 snapshot_add_output(&session
->snapshot
, new_output
);
3885 *id
= new_output
->id
;
3892 snapshot_output_destroy(new_output
);
3898 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3900 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3902 int cmd_snapshot_del_output(struct ltt_session
*session
,
3903 const struct lttng_snapshot_output
*output
)
3906 struct snapshot_output
*sout
= NULL
;
3914 * Permission denied to create an output if the session is not
3915 * set in no output mode.
3917 if (session
->output_traces
) {
3918 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3923 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3925 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3926 } else if (*output
->name
!= '\0') {
3927 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3929 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3932 ret
= LTTNG_ERR_INVALID
;
3936 snapshot_delete_output(&session
->snapshot
, sout
);
3937 snapshot_output_destroy(sout
);
3946 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3948 * If no output is available, outputs is untouched and 0 is returned.
3950 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3952 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3953 struct lttng_snapshot_output
**outputs
)
3956 struct lttng_snapshot_output
*list
= NULL
;
3957 struct lttng_ht_iter iter
;
3958 struct snapshot_output
*output
;
3963 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3966 * Permission denied to create an output if the session is not
3967 * set in no output mode.
3969 if (session
->output_traces
) {
3970 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3974 if (session
->snapshot
.nb_output
== 0) {
3979 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3981 ret
= -LTTNG_ERR_NOMEM
;
3985 /* Copy list from session to the new list object. */
3987 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3988 output
, node
.node
) {
3989 assert(output
->consumer
);
3990 list
[idx
].id
= output
->id
;
3991 list
[idx
].max_size
= output
->max_size
;
3992 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3993 sizeof(list
[idx
].name
))) {
3994 ret
= -LTTNG_ERR_INVALID
;
3997 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3998 if (lttng_strncpy(list
[idx
].ctrl_url
,
3999 output
->consumer
->dst
.session_root_path
,
4000 sizeof(list
[idx
].ctrl_url
))) {
4001 ret
= -LTTNG_ERR_INVALID
;
4006 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4007 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4009 ret
= -LTTNG_ERR_NOMEM
;
4014 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4015 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4017 ret
= -LTTNG_ERR_NOMEM
;
4026 ret
= session
->snapshot
.nb_output
;
4035 * Check if we can regenerate the metadata for this session.
4036 * Only kernel, UST per-uid and non-live sessions are supported.
4038 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4041 int check_regenerate_metadata_support(struct ltt_session
*session
)
4047 if (session
->live_timer
!= 0) {
4048 ret
= LTTNG_ERR_LIVE_SESSION
;
4051 if (!session
->active
) {
4052 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4055 if (session
->ust_session
) {
4056 switch (session
->ust_session
->buffer_type
) {
4057 case LTTNG_BUFFER_PER_UID
:
4059 case LTTNG_BUFFER_PER_PID
:
4060 ret
= LTTNG_ERR_PER_PID_SESSION
;
4064 ret
= LTTNG_ERR_UNK
;
4068 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4069 session
->consumer
->relay_minor_version
< 8) {
4070 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4080 int clear_metadata_file(int fd
)
4085 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4086 if (lseek_ret
< 0) {
4092 ret
= ftruncate(fd
, 0);
4094 PERROR("ftruncate");
4103 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4106 struct buffer_reg_uid
*uid_reg
= NULL
;
4107 struct buffer_reg_session
*session_reg
= NULL
;
4110 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4111 struct ust_registry_session
*registry
;
4112 struct ust_registry_channel
*chan
;
4113 struct lttng_ht_iter iter_chan
;
4115 session_reg
= uid_reg
->registry
;
4116 registry
= session_reg
->reg
.ust
;
4118 pthread_mutex_lock(®istry
->lock
);
4119 registry
->metadata_len_sent
= 0;
4120 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4121 registry
->metadata_len
= 0;
4122 registry
->metadata_version
++;
4123 if (registry
->metadata_fd
> 0) {
4124 /* Clear the metadata file's content. */
4125 ret
= clear_metadata_file(registry
->metadata_fd
);
4127 pthread_mutex_unlock(®istry
->lock
);
4132 ret
= ust_metadata_session_statedump(registry
, NULL
,
4133 registry
->major
, registry
->minor
);
4135 pthread_mutex_unlock(®istry
->lock
);
4136 ERR("Failed to generate session metadata (err = %d)",
4140 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4142 struct ust_registry_event
*event
;
4143 struct lttng_ht_iter iter_event
;
4145 ret
= ust_metadata_channel_statedump(registry
, chan
);
4147 pthread_mutex_unlock(®istry
->lock
);
4148 ERR("Failed to generate channel metadata "
4152 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4154 ret
= ust_metadata_event_statedump(registry
,
4157 pthread_mutex_unlock(®istry
->lock
);
4158 ERR("Failed to generate event metadata "
4164 pthread_mutex_unlock(®istry
->lock
);
4173 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4175 * Ask the consumer to truncate the existing metadata file(s) and
4176 * then regenerate the metadata. Live and per-pid sessions are not
4177 * supported and return an error.
4179 * Return 0 on success or else a LTTNG_ERR code.
4181 int cmd_regenerate_metadata(struct ltt_session
*session
)
4187 ret
= check_regenerate_metadata_support(session
);
4192 if (session
->kernel_session
) {
4193 ret
= kernctl_session_regenerate_metadata(
4194 session
->kernel_session
->fd
);
4196 ERR("Failed to regenerate the kernel metadata");
4201 if (session
->ust_session
) {
4202 ret
= ust_regenerate_metadata(session
->ust_session
);
4204 ERR("Failed to regenerate the UST metadata");
4208 DBG("Cmd metadata regenerate for session %s", session
->name
);
4216 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4218 * Ask the tracer to regenerate a new statedump.
4220 * Return 0 on success or else a LTTNG_ERR code.
4222 int cmd_regenerate_statedump(struct ltt_session
*session
)
4228 if (!session
->active
) {
4229 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4233 if (session
->kernel_session
) {
4234 ret
= kernctl_session_regenerate_statedump(
4235 session
->kernel_session
->fd
);
4237 * Currently, the statedump in kernel can only fail if out
4241 if (ret
== -ENOMEM
) {
4242 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4244 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4246 ERR("Failed to regenerate the kernel statedump");
4251 if (session
->ust_session
) {
4252 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4254 * Currently, the statedump in UST always returns 0.
4257 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4258 ERR("Failed to regenerate the UST statedump");
4262 DBG("Cmd regenerate statedump for session %s", session
->name
);
4269 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4270 struct notification_thread_handle
*notification_thread
)
4274 ssize_t sock_recv_len
;
4275 struct lttng_trigger
*trigger
= NULL
;
4276 struct lttng_buffer_view view
;
4277 struct lttng_dynamic_buffer trigger_buffer
;
4279 lttng_dynamic_buffer_init(&trigger_buffer
);
4280 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4281 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4283 ret
= LTTNG_ERR_NOMEM
;
4287 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4289 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4290 ERR("Failed to receive \"register trigger\" command payload");
4291 /* TODO: should this be a new error enum ? */
4292 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4296 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4297 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4299 ERR("Invalid trigger payload received in \"register trigger\" command");
4300 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4304 ret
= notification_thread_command_register_trigger(notification_thread
,
4306 /* Ownership of trigger was transferred. */
4309 lttng_trigger_destroy(trigger
);
4310 lttng_dynamic_buffer_reset(&trigger_buffer
);
4314 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4315 struct notification_thread_handle
*notification_thread
)
4319 ssize_t sock_recv_len
;
4320 struct lttng_trigger
*trigger
= NULL
;
4321 struct lttng_buffer_view view
;
4322 struct lttng_dynamic_buffer trigger_buffer
;
4324 lttng_dynamic_buffer_init(&trigger_buffer
);
4325 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4326 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4328 ret
= LTTNG_ERR_NOMEM
;
4332 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4334 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4335 ERR("Failed to receive \"unregister trigger\" command payload");
4336 /* TODO: should this be a new error enum ? */
4337 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4341 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4342 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4344 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4345 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4349 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4352 lttng_trigger_destroy(trigger
);
4353 lttng_dynamic_buffer_reset(&trigger_buffer
);
4358 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4359 * snapshot output is *not* set with a remote destination.
4361 * Return LTTNG_OK on success or a LTTNG_ERR code.
4363 static enum lttng_error_code
set_relayd_for_snapshot(
4364 struct consumer_output
*output
,
4365 const struct ltt_session
*session
)
4367 enum lttng_error_code status
= LTTNG_OK
;
4368 struct lttng_ht_iter iter
;
4369 struct consumer_socket
*socket
;
4370 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4371 const char *base_path
;
4376 DBG2("Set relayd object from snapshot output");
4378 if (session
->current_trace_chunk
) {
4379 enum lttng_trace_chunk_status chunk_status
=
4380 lttng_trace_chunk_get_id(
4381 session
->current_trace_chunk
,
4382 ¤t_chunk_id
.value
);
4384 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4385 current_chunk_id
.is_set
= true;
4387 ERR("Failed to get current trace chunk id");
4388 status
= LTTNG_ERR_UNK
;
4393 /* Ignore if snapshot consumer output is not network. */
4394 if (output
->type
!= CONSUMER_DST_NET
) {
4399 * The snapshot record URI base path overrides the session
4402 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4403 base_path
= output
->dst
.net
.control
.subdir
;
4405 base_path
= session
->base_path
;
4409 * For each consumer socket, create and send the relayd object of the
4413 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4414 socket
, node
.node
) {
4415 pthread_mutex_lock(socket
->lock
);
4416 status
= send_consumer_relayd_sockets(0, session
->id
,
4418 session
->name
, session
->hostname
,
4420 session
->live_timer
,
4421 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4422 session
->creation_time
,
4423 session
->name_contains_creation_time
);
4424 pthread_mutex_unlock(socket
->lock
);
4425 if (status
!= LTTNG_OK
) {
4437 * Record a kernel snapshot.
4439 * Return LTTNG_OK on success or a LTTNG_ERR code.
4441 static enum lttng_error_code
record_kernel_snapshot(
4442 struct ltt_kernel_session
*ksess
,
4443 const struct consumer_output
*output
,
4444 const struct ltt_session
*session
,
4445 int wait
, uint64_t nb_packets_per_stream
)
4447 enum lttng_error_code status
;
4453 status
= kernel_snapshot_record(
4454 ksess
, output
, wait
, nb_packets_per_stream
);
4459 * Record a UST snapshot.
4461 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4463 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4464 const struct consumer_output
*output
,
4465 const struct ltt_session
*session
,
4466 int wait
, uint64_t nb_packets_per_stream
)
4468 enum lttng_error_code status
;
4474 status
= ust_app_snapshot_record(
4475 usess
, output
, wait
, nb_packets_per_stream
);
4480 uint64_t get_session_size_one_more_packet_per_stream(
4481 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4483 uint64_t tot_size
= 0;
4485 if (session
->kernel_session
) {
4486 struct ltt_kernel_channel
*chan
;
4487 const struct ltt_kernel_session
*ksess
=
4488 session
->kernel_session
;
4490 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4491 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4493 * Don't take channel into account if we
4494 * already grab all its packets.
4498 tot_size
+= chan
->channel
->attr
.subbuf_size
4499 * chan
->stream_count
;
4503 if (session
->ust_session
) {
4504 const struct ltt_ust_session
*usess
= session
->ust_session
;
4506 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4514 * Calculate the number of packets we can grab from each stream that
4515 * fits within the overall snapshot max size.
4517 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4518 * the number of packets per stream.
4520 * TODO: this approach is not perfect: we consider the worse case
4521 * (packet filling the sub-buffers) as an upper bound, but we could do
4522 * better if we do this calculation while we actually grab the packet
4523 * content: we would know how much padding we don't actually store into
4526 * This algorithm is currently bounded by the number of packets per
4529 * Since we call this algorithm before actually grabbing the data, it's
4530 * an approximation: for instance, applications could appear/disappear
4531 * in between this call and actually grabbing data.
4534 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4538 uint64_t cur_nb_packets
= 0;
4541 return 0; /* Infinite */
4544 size_left
= max_size
;
4546 uint64_t one_more_packet_tot_size
;
4548 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4549 session
, cur_nb_packets
);
4550 if (!one_more_packet_tot_size
) {
4551 /* We are already grabbing all packets. */
4554 size_left
-= one_more_packet_tot_size
;
4555 if (size_left
< 0) {
4560 if (!cur_nb_packets
) {
4561 /* Not enough room to grab one packet of each stream, error. */
4564 return cur_nb_packets
;
4568 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4569 const struct snapshot_output
*snapshot_output
, int wait
)
4571 int64_t nb_packets_per_stream
;
4572 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4574 enum lttng_error_code ret_code
= LTTNG_OK
;
4575 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4576 struct consumer_output
*original_ust_consumer_output
= NULL
;
4577 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4578 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4579 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4581 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4583 snapshot_output
->name
,
4584 snapshot_output
->datetime
,
4585 snapshot_output
->nb_snapshot
);
4586 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4587 ERR("Failed to format snapshot name");
4588 ret_code
= LTTNG_ERR_INVALID
;
4591 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4592 snapshot_output
->name
, session
->name
,
4593 snapshot_chunk_name
);
4594 if (!session
->kernel_session
&& !session
->ust_session
) {
4595 ERR("Failed to record snapshot as no channels exist");
4596 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4600 if (session
->kernel_session
) {
4601 original_kernel_consumer_output
=
4602 session
->kernel_session
->consumer
;
4603 snapshot_kernel_consumer_output
=
4604 consumer_copy_output(snapshot_output
->consumer
);
4605 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4606 snapshot_chunk_name
);
4607 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4608 original_kernel_consumer_output
);
4610 ERR("Failed to copy consumer sockets from snapshot output configuration");
4611 ret_code
= LTTNG_ERR_NOMEM
;
4614 ret_code
= set_relayd_for_snapshot(
4615 snapshot_kernel_consumer_output
, session
);
4616 if (ret_code
!= LTTNG_OK
) {
4617 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4620 session
->kernel_session
->consumer
=
4621 snapshot_kernel_consumer_output
;
4623 if (session
->ust_session
) {
4624 original_ust_consumer_output
= session
->ust_session
->consumer
;
4625 snapshot_ust_consumer_output
=
4626 consumer_copy_output(snapshot_output
->consumer
);
4627 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4628 snapshot_chunk_name
);
4629 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4630 original_ust_consumer_output
);
4632 ERR("Failed to copy consumer sockets from snapshot output configuration");
4633 ret_code
= LTTNG_ERR_NOMEM
;
4636 ret_code
= set_relayd_for_snapshot(
4637 snapshot_ust_consumer_output
, session
);
4638 if (ret_code
!= LTTNG_OK
) {
4639 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4642 session
->ust_session
->consumer
=
4643 snapshot_ust_consumer_output
;
4646 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4647 snapshot_kernel_consumer_output
?:
4648 snapshot_ust_consumer_output
,
4649 consumer_output_get_base_path(
4650 snapshot_output
->consumer
),
4651 snapshot_chunk_name
);
4652 if (!snapshot_trace_chunk
) {
4653 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4655 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4658 assert(!session
->current_trace_chunk
);
4659 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4660 lttng_trace_chunk_put(snapshot_trace_chunk
);
4661 snapshot_trace_chunk
= NULL
;
4663 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4665 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4669 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4670 snapshot_output
->max_size
);
4671 if (nb_packets_per_stream
< 0) {
4672 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4676 if (session
->kernel_session
) {
4677 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4678 snapshot_kernel_consumer_output
, session
,
4679 wait
, nb_packets_per_stream
);
4680 if (ret_code
!= LTTNG_OK
) {
4685 if (session
->ust_session
) {
4686 ret_code
= record_ust_snapshot(session
->ust_session
,
4687 snapshot_ust_consumer_output
, session
,
4688 wait
, nb_packets_per_stream
);
4689 if (ret_code
!= LTTNG_OK
) {
4694 if (session_close_trace_chunk(
4695 session
, session
->current_trace_chunk
, NULL
, NULL
)) {
4697 * Don't goto end; make sure the chunk is closed for the session
4698 * to allow future snapshots.
4700 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4702 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4704 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4705 ERR("Failed to release the current trace chunk of session \"%s\"",
4707 ret_code
= LTTNG_ERR_UNK
;
4710 if (original_ust_consumer_output
) {
4711 session
->ust_session
->consumer
= original_ust_consumer_output
;
4713 if (original_kernel_consumer_output
) {
4714 session
->kernel_session
->consumer
=
4715 original_kernel_consumer_output
;
4717 consumer_output_put(snapshot_ust_consumer_output
);
4718 consumer_output_put(snapshot_kernel_consumer_output
);
4723 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4725 * The wait parameter is ignored so this call always wait for the snapshot to
4726 * complete before returning.
4728 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4730 int cmd_snapshot_record(struct ltt_session
*session
,
4731 const struct lttng_snapshot_output
*output
, int wait
)
4733 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4735 unsigned int snapshot_success
= 0;
4737 struct snapshot_output
*tmp_output
= NULL
;
4742 DBG("Cmd snapshot record for session %s", session
->name
);
4744 /* Get the datetime for the snapshot output directory. */
4745 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4748 cmd_ret
= LTTNG_ERR_INVALID
;
4753 * Permission denied to create an output if the session is not
4754 * set in no output mode.
4756 if (session
->output_traces
) {
4757 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4761 /* The session needs to be started at least once. */
4762 if (!session
->has_been_started
) {
4763 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4767 /* Use temporary output for the session. */
4768 if (*output
->ctrl_url
!= '\0') {
4769 tmp_output
= snapshot_output_alloc();
4771 cmd_ret
= LTTNG_ERR_NOMEM
;
4775 ret
= snapshot_output_init(session
, output
->max_size
,
4777 output
->ctrl_url
, output
->data_url
,
4781 if (ret
== -ENOMEM
) {
4782 cmd_ret
= LTTNG_ERR_NOMEM
;
4784 cmd_ret
= LTTNG_ERR_INVALID
;
4788 /* Use the global session count for the temporary snapshot. */
4789 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4791 /* Use the global datetime */
4792 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4793 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4794 if (cmd_ret
!= LTTNG_OK
) {
4797 snapshot_success
= 1;
4799 struct snapshot_output
*sout
;
4800 struct lttng_ht_iter iter
;
4803 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4804 &iter
.iter
, sout
, node
.node
) {
4805 struct snapshot_output output_copy
;
4808 * Make a local copy of the output and override output
4809 * parameters with those provided as part of the
4812 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4814 if (output
->max_size
!= (uint64_t) -1ULL) {
4815 output_copy
.max_size
= output
->max_size
;
4818 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4819 memcpy(output_copy
.datetime
, datetime
,
4822 /* Use temporary name. */
4823 if (*output
->name
!= '\0') {
4824 if (lttng_strncpy(output_copy
.name
,
4826 sizeof(output_copy
.name
))) {
4827 cmd_ret
= LTTNG_ERR_INVALID
;
4833 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4834 if (cmd_ret
!= LTTNG_OK
) {
4838 snapshot_success
= 1;
4843 if (snapshot_success
) {
4844 session
->snapshot
.nb_snapshot
++;
4846 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4851 snapshot_output_destroy(tmp_output
);
4857 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4859 int cmd_set_session_shm_path(struct ltt_session
*session
,
4860 const char *shm_path
)
4866 * Can only set shm path before session is started.
4868 if (session
->has_been_started
) {
4869 return LTTNG_ERR_SESSION_STARTED
;
4872 strncpy(session
->shm_path
, shm_path
,
4873 sizeof(session
->shm_path
));
4874 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4880 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4882 * Ask the consumer to rotate the session output directory.
4883 * The session lock must be held.
4885 * Returns LTTNG_OK on success or else a negative LTTng error code.
4887 int cmd_rotate_session(struct ltt_session
*session
,
4888 struct lttng_rotate_session_return
*rotate_return
,
4889 bool quiet_rotation
)
4892 uint64_t ongoing_rotation_chunk_id
;
4893 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4894 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4895 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4896 enum lttng_trace_chunk_status chunk_status
;
4897 bool failed_to_rotate
= false;
4898 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4902 if (!session
->has_been_started
) {
4903 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4908 * Explicit rotation is not supported for live sessions.
4909 * However, live sessions can perform a quiet rotation on
4911 * Rotation is not supported for snapshot traces (no output).
4913 if ((!quiet_rotation
&& session
->live_timer
) ||
4914 !session
->output_traces
) {
4915 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4919 /* Unsupported feature in lttng-relayd before 2.11. */
4920 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4921 (session
->consumer
->relay_major_version
== 2 &&
4922 session
->consumer
->relay_minor_version
< 11)) {
4923 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4927 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4928 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4929 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4933 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4934 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4936 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4941 * After a stop, we only allow one rotation to occur, the other ones are
4942 * useless until a new start.
4944 if (session
->rotated_after_last_stop
) {
4945 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4947 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4950 if (session
->active
) {
4951 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4953 if (!new_trace_chunk
) {
4954 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4960 * The current trace chunk becomes the chunk being archived.
4962 * After this point, "chunk_being_archived" must absolutely
4963 * be closed on the consumer(s), otherwise it will never be
4964 * cleaned-up, which will result in a leak.
4966 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4967 &chunk_being_archived
);
4969 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4973 if (session
->kernel_session
) {
4974 cmd_ret
= kernel_rotate_session(session
);
4975 if (cmd_ret
!= LTTNG_OK
) {
4976 failed_to_rotate
= true;
4977 rotation_fail_code
= cmd_ret
;
4980 if (session
->ust_session
) {
4981 cmd_ret
= ust_app_rotate_session(session
);
4982 if (cmd_ret
!= LTTNG_OK
) {
4983 failed_to_rotate
= true;
4984 rotation_fail_code
= cmd_ret
;
4988 if (!session
->active
) {
4989 session
->rotated_after_last_stop
= true;
4992 if (!chunk_being_archived
) {
4993 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
4995 if (failed_to_rotate
) {
4996 cmd_ret
= rotation_fail_code
;
5003 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5004 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5005 &ongoing_rotation_chunk_id
);
5006 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5008 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5011 &((enum lttng_trace_chunk_command_type
){
5012 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
}),
5013 session
->last_chunk_path
);
5015 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5019 if (failed_to_rotate
) {
5020 cmd_ret
= rotation_fail_code
;
5024 session
->quiet_rotation
= quiet_rotation
;
5025 ret
= timer_session_rotation_pending_check_start(session
,
5026 DEFAULT_ROTATE_PENDING_TIMER
);
5028 cmd_ret
= LTTNG_ERR_UNK
;
5032 if (rotate_return
) {
5033 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5036 session
->chunk_being_archived
= chunk_being_archived
;
5037 chunk_being_archived
= NULL
;
5038 if (!quiet_rotation
) {
5039 ret
= notification_thread_command_session_rotation_ongoing(
5040 notification_thread_handle
,
5041 session
->name
, session
->uid
, session
->gid
,
5042 ongoing_rotation_chunk_id
);
5043 if (ret
!= LTTNG_OK
) {
5044 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5050 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5051 session
->name
, ongoing_rotation_chunk_id
);
5053 lttng_trace_chunk_put(new_trace_chunk
);
5054 lttng_trace_chunk_put(chunk_being_archived
);
5055 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5058 if (session_reset_rotation_state(session
,
5059 LTTNG_ROTATION_STATE_ERROR
)) {
5060 ERR("Failed to reset rotation state of session \"%s\"",
5067 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5069 * Check if the session has finished its rotation.
5071 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5073 int cmd_rotate_get_info(struct ltt_session
*session
,
5074 struct lttng_rotation_get_info_return
*info_return
,
5075 uint64_t rotation_id
)
5077 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5078 enum lttng_rotation_state rotation_state
;
5080 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5081 session
->most_recent_chunk_id
.value
);
5083 if (session
->chunk_being_archived
) {
5084 enum lttng_trace_chunk_status chunk_status
;
5087 chunk_status
= lttng_trace_chunk_get_id(
5088 session
->chunk_being_archived
,
5090 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5092 rotation_state
= rotation_id
== chunk_id
?
5093 LTTNG_ROTATION_STATE_ONGOING
:
5094 LTTNG_ROTATION_STATE_EXPIRED
;
5096 if (session
->last_archived_chunk_id
.is_set
&&
5097 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5098 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5100 rotation_state
= session
->rotation_state
;
5104 switch (rotation_state
) {
5105 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5106 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5109 case LTTNG_ROTATION_STATE_EXPIRED
:
5110 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5111 rotation_id
, session
->name
);
5113 case LTTNG_ROTATION_STATE_ONGOING
:
5114 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5115 rotation_id
, session
->name
);
5117 case LTTNG_ROTATION_STATE_COMPLETED
:
5121 char *current_tracing_path_reply
;
5122 size_t current_tracing_path_reply_len
;
5124 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5125 rotation_id
, session
->name
);
5127 switch (session_get_consumer_destination_type(session
)) {
5128 case CONSUMER_DST_LOCAL
:
5129 current_tracing_path_reply
=
5130 info_return
->location
.local
.absolute_path
;
5131 current_tracing_path_reply_len
=
5132 sizeof(info_return
->location
.local
.absolute_path
);
5133 info_return
->location_type
=
5134 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5135 fmt_ret
= asprintf(&chunk_path
,
5136 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5137 session_get_base_path(session
),
5138 session
->last_archived_chunk_name
);
5139 if (fmt_ret
== -1) {
5140 PERROR("Failed to format the path of the last archived trace chunk");
5141 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5142 cmd_ret
= LTTNG_ERR_UNK
;
5146 case CONSUMER_DST_NET
:
5148 uint16_t ctrl_port
, data_port
;
5150 current_tracing_path_reply
=
5151 info_return
->location
.relay
.relative_path
;
5152 current_tracing_path_reply_len
=
5153 sizeof(info_return
->location
.relay
.relative_path
);
5154 /* Currently the only supported relay protocol. */
5155 info_return
->location
.relay
.protocol
=
5156 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5158 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5159 session_get_net_consumer_hostname(session
),
5160 sizeof(info_return
->location
.relay
.host
));
5162 ERR("Failed to copy host name to rotate_get_info reply");
5163 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5164 cmd_ret
= LTTNG_ERR_SET_URL
;
5168 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5169 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5170 info_return
->location
.relay
.ports
.data
= data_port
;
5171 info_return
->location_type
=
5172 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5173 chunk_path
= strdup(session
->last_chunk_path
);
5175 ERR("Failed to allocate the path of the last archived trace chunk");
5176 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5177 cmd_ret
= LTTNG_ERR_UNK
;
5186 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5187 chunk_path
, current_tracing_path_reply_len
);
5190 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5191 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5192 cmd_ret
= LTTNG_ERR_UNK
;
5198 case LTTNG_ROTATION_STATE_ERROR
:
5199 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5200 rotation_id
, session
->name
);
5208 info_return
->status
= (int32_t) rotation_state
;
5213 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5215 * Configure the automatic rotation parameters.
5216 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5217 * 'activate' to false means deactivate the rotation schedule and validate that
5218 * 'new_value' has the same value as the currently active value.
5220 * Return 0 on success or else a positive LTTNG_ERR code.
5222 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5223 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5225 struct notification_thread_handle
*notification_thread_handle
)
5228 uint64_t *parameter_value
;
5232 DBG("Cmd rotate set schedule session %s", session
->name
);
5234 if (session
->live_timer
|| !session
->output_traces
) {
5235 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5236 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5240 switch (schedule_type
) {
5241 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5242 parameter_value
= &session
->rotate_size
;
5244 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5245 parameter_value
= &session
->rotate_timer_period
;
5246 if (new_value
>= UINT_MAX
) {
5247 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5248 new_value
, UINT_MAX
);
5249 ret
= LTTNG_ERR_INVALID
;
5254 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5255 ret
= LTTNG_ERR_INVALID
;
5259 /* Improper use of the API. */
5260 if (new_value
== -1ULL) {
5261 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5262 ret
= LTTNG_ERR_INVALID
;
5267 * As indicated in struct ltt_session's comments, a value of == 0 means
5268 * this schedule rotation type is not in use.
5270 * Reject the command if we were asked to activate a schedule that was
5273 if (activate
&& *parameter_value
!= 0) {
5274 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5275 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5280 * Reject the command if we were asked to deactivate a schedule that was
5283 if (!activate
&& *parameter_value
== 0) {
5284 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5285 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5290 * Reject the command if we were asked to deactivate a schedule that
5293 if (!activate
&& *parameter_value
!= new_value
) {
5294 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5295 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5299 *parameter_value
= activate
? new_value
: 0;
5301 switch (schedule_type
) {
5302 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5303 if (activate
&& session
->active
) {
5305 * Only start the timer if the session is active,
5306 * otherwise it will be started when the session starts.
5308 ret
= timer_session_rotation_schedule_timer_start(
5309 session
, new_value
);
5311 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5312 ret
= LTTNG_ERR_UNK
;
5316 ret
= timer_session_rotation_schedule_timer_stop(
5319 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5320 ret
= LTTNG_ERR_UNK
;
5325 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5327 ret
= subscribe_session_consumed_size_rotation(session
,
5328 new_value
, notification_thread_handle
);
5330 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5331 ret
= LTTNG_ERR_UNK
;
5335 ret
= unsubscribe_session_consumed_size_rotation(session
,
5336 notification_thread_handle
);
5338 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5339 ret
= LTTNG_ERR_UNK
;
5346 /* Would have been caught before. */
5358 /* Wait for a given path to be removed before continuing. */
5359 static enum lttng_error_code
wait_on_path(void *path_data
)
5361 const char *shm_path
= path_data
;
5363 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5369 ret
= stat(shm_path
, &st
);
5371 if (errno
!= ENOENT
) {
5372 PERROR("stat() returned an error while checking for the existence of the shm path");
5374 DBG("shm path no longer exists, completing the destruction of session");
5378 if (!S_ISDIR(st
.st_mode
)) {
5379 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5384 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5390 * Returns a pointer to a handler to run on completion of a command.
5391 * Returns NULL if no handler has to be run for the last command executed.
5393 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5395 struct cmd_completion_handler
*handler
= current_completion_handler
;
5397 current_completion_handler
= NULL
;
5402 * Init command subsystem.
5407 * Set network sequence index to 1 for streams to match a relayd
5408 * socket on the consumer side.
5410 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5411 relayd_net_seq_idx
= 1;
5412 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5414 DBG("Command subsystem initialized");