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
;
830 * Add URI so the consumer output object. Set the correct path depending on the
831 * domain adding the default trace directory.
833 static enum lttng_error_code
add_uri_to_consumer(
834 const struct ltt_session
*session
,
835 struct consumer_output
*consumer
,
836 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
839 enum lttng_error_code ret_code
= LTTNG_OK
;
843 if (consumer
== NULL
) {
844 DBG("No consumer detected. Don't add URI. Stopping.");
845 ret_code
= LTTNG_ERR_NO_CONSUMER
;
850 case LTTNG_DOMAIN_KERNEL
:
851 ret
= lttng_strncpy(consumer
->domain_subdir
,
852 DEFAULT_KERNEL_TRACE_DIR
,
853 sizeof(consumer
->domain_subdir
));
855 case LTTNG_DOMAIN_UST
:
856 ret
= lttng_strncpy(consumer
->domain_subdir
,
857 DEFAULT_UST_TRACE_DIR
,
858 sizeof(consumer
->domain_subdir
));
862 * This case is possible is we try to add the URI to the global
863 * tracing session consumer object which in this case there is
866 memset(consumer
->domain_subdir
, 0,
867 sizeof(consumer
->domain_subdir
));
871 ERR("Failed to initialize consumer output domain subdirectory");
872 ret_code
= LTTNG_ERR_FATAL
;
876 switch (uri
->dtype
) {
879 DBG2("Setting network URI to consumer");
881 if (consumer
->type
== CONSUMER_DST_NET
) {
882 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
883 consumer
->dst
.net
.control_isset
) ||
884 (uri
->stype
== LTTNG_STREAM_DATA
&&
885 consumer
->dst
.net
.data_isset
)) {
886 ret_code
= LTTNG_ERR_URL_EXIST
;
890 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
893 /* Set URI into consumer output object */
894 ret
= consumer_set_network_uri(session
, consumer
, uri
);
898 } else if (ret
== 1) {
900 * URI was the same in the consumer so we do not append the subdir
901 * again so to not duplicate output dir.
908 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
909 ret_code
= LTTNG_ERR_INVALID
;
912 DBG2("Setting trace directory path from URI to %s",
914 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
916 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
918 sizeof(consumer
->dst
.session_root_path
));
920 ret_code
= LTTNG_ERR_FATAL
;
923 consumer
->type
= CONSUMER_DST_LOCAL
;
933 * Init tracing by creating trace directory and sending fds kernel consumer.
935 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
938 struct lttng_ht_iter iter
;
939 struct consumer_socket
*socket
;
945 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
946 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
948 pthread_mutex_lock(socket
->lock
);
949 ret
= kernel_consumer_send_session(socket
, session
);
950 pthread_mutex_unlock(socket
->lock
);
952 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
964 * Create a socket to the relayd using the URI.
966 * On success, the relayd_sock pointer is set to the created socket.
967 * Else, it remains untouched and an LTTng error code is returned.
969 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
970 struct lttcomm_relayd_sock
**relayd_sock
,
971 struct consumer_output
*consumer
)
974 enum lttng_error_code status
= LTTNG_OK
;
975 struct lttcomm_relayd_sock
*rsock
;
977 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
978 RELAYD_VERSION_COMM_MINOR
);
980 status
= LTTNG_ERR_FATAL
;
985 * Connect to relayd so we can proceed with a session creation. This call
986 * can possibly block for an arbitrary amount of time to set the health
987 * state to be in poll execution.
990 ret
= relayd_connect(rsock
);
993 ERR("Unable to reach lttng-relayd");
994 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
998 /* Create socket for control stream. */
999 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
1000 DBG3("Creating relayd stream socket from URI");
1002 /* Check relayd version */
1003 ret
= relayd_version_check(rsock
);
1004 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1005 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1007 } else if (ret
< 0) {
1008 ERR("Unable to reach lttng-relayd");
1009 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1012 consumer
->relay_major_version
= rsock
->major
;
1013 consumer
->relay_minor_version
= rsock
->minor
;
1014 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1015 DBG3("Creating relayd data socket from URI");
1017 /* Command is not valid */
1018 ERR("Relayd invalid stream type: %d", uri
->stype
);
1019 status
= LTTNG_ERR_INVALID
;
1023 *relayd_sock
= rsock
;
1028 /* The returned value is not useful since we are on an error path. */
1029 (void) relayd_close(rsock
);
1037 * Connect to the relayd using URI and send the socket to the right consumer.
1039 * The consumer socket lock must be held by the caller.
1041 * Returns LTTNG_OK on success or an LTTng error code on failure.
1043 static enum lttng_error_code
send_consumer_relayd_socket(
1044 unsigned int session_id
,
1045 struct lttng_uri
*relayd_uri
,
1046 struct consumer_output
*consumer
,
1047 struct consumer_socket
*consumer_sock
,
1048 const char *session_name
, const char *hostname
,
1049 const char *base_path
, int session_live_timer
,
1050 const uint64_t *current_chunk_id
,
1051 time_t session_creation_time
,
1052 bool session_name_contains_creation_time
)
1055 struct lttcomm_relayd_sock
*rsock
= NULL
;
1056 enum lttng_error_code status
;
1058 /* Connect to relayd and make version check if uri is the control. */
1059 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1060 if (status
!= LTTNG_OK
) {
1061 goto relayd_comm_error
;
1065 /* Set the network sequence index if not set. */
1066 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1067 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1069 * Increment net_seq_idx because we are about to transfer the
1070 * new relayd socket to the consumer.
1071 * Assign unique key so the consumer can match streams.
1073 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1074 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1077 /* Send relayd socket to consumer. */
1078 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1079 relayd_uri
->stype
, session_id
,
1080 session_name
, hostname
, base_path
,
1081 session_live_timer
, current_chunk_id
,
1082 session_creation_time
, session_name_contains_creation_time
);
1084 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1088 /* Flag that the corresponding socket was sent. */
1089 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1090 consumer_sock
->control_sock_sent
= 1;
1091 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1092 consumer_sock
->data_sock_sent
= 1;
1096 * Close socket which was dup on the consumer side. The session daemon does
1097 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1101 if (status
!= LTTNG_OK
) {
1103 * The consumer output for this session should not be used anymore
1104 * since the relayd connection failed thus making any tracing or/and
1105 * streaming not usable.
1107 consumer
->enabled
= 0;
1109 (void) relayd_close(rsock
);
1117 * Send both relayd sockets to a specific consumer and domain. This is a
1118 * helper function to facilitate sending the information to the consumer for a
1121 * The consumer socket lock must be held by the caller.
1123 * Returns LTTNG_OK, or an LTTng error code on failure.
1125 static enum lttng_error_code
send_consumer_relayd_sockets(
1126 enum lttng_domain_type domain
,
1127 unsigned int session_id
, struct consumer_output
*consumer
,
1128 struct consumer_socket
*sock
, const char *session_name
,
1129 const char *hostname
, const char *base_path
, int session_live_timer
,
1130 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1131 bool session_name_contains_creation_time
)
1133 enum lttng_error_code status
= LTTNG_OK
;
1138 /* Sending control relayd socket. */
1139 if (!sock
->control_sock_sent
) {
1140 status
= send_consumer_relayd_socket(session_id
,
1141 &consumer
->dst
.net
.control
, consumer
, sock
,
1142 session_name
, hostname
, base_path
, session_live_timer
,
1143 current_chunk_id
, session_creation_time
,
1144 session_name_contains_creation_time
);
1145 if (status
!= LTTNG_OK
) {
1150 /* Sending data relayd socket. */
1151 if (!sock
->data_sock_sent
) {
1152 status
= send_consumer_relayd_socket(session_id
,
1153 &consumer
->dst
.net
.data
, consumer
, sock
,
1154 session_name
, hostname
, base_path
, session_live_timer
,
1155 current_chunk_id
, session_creation_time
,
1156 session_name_contains_creation_time
);
1157 if (status
!= LTTNG_OK
) {
1167 * Setup relayd connections for a tracing session. First creates the socket to
1168 * the relayd and send them to the right domain consumer. Consumer type MUST be
1171 int cmd_setup_relayd(struct ltt_session
*session
)
1174 struct ltt_ust_session
*usess
;
1175 struct ltt_kernel_session
*ksess
;
1176 struct consumer_socket
*socket
;
1177 struct lttng_ht_iter iter
;
1178 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1182 usess
= session
->ust_session
;
1183 ksess
= session
->kernel_session
;
1185 DBG("Setting relayd for session %s", session
->name
);
1188 if (session
->current_trace_chunk
) {
1189 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1190 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1192 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1193 current_chunk_id
.is_set
= true;
1195 ERR("Failed to get current trace chunk id");
1196 ret
= LTTNG_ERR_UNK
;
1201 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1202 && usess
->consumer
->enabled
) {
1203 /* For each consumer socket, send relayd sockets */
1204 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1205 socket
, node
.node
) {
1206 pthread_mutex_lock(socket
->lock
);
1207 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1208 usess
->consumer
, socket
,
1209 session
->name
, session
->hostname
,
1211 session
->live_timer
,
1212 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1213 session
->creation_time
,
1214 session
->name_contains_creation_time
);
1215 pthread_mutex_unlock(socket
->lock
);
1216 if (ret
!= LTTNG_OK
) {
1219 /* Session is now ready for network streaming. */
1220 session
->net_handle
= 1;
1222 session
->consumer
->relay_major_version
=
1223 usess
->consumer
->relay_major_version
;
1224 session
->consumer
->relay_minor_version
=
1225 usess
->consumer
->relay_minor_version
;
1228 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1229 && ksess
->consumer
->enabled
) {
1230 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1231 socket
, node
.node
) {
1232 pthread_mutex_lock(socket
->lock
);
1233 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1234 ksess
->consumer
, socket
,
1235 session
->name
, session
->hostname
,
1237 session
->live_timer
,
1238 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1239 session
->creation_time
,
1240 session
->name_contains_creation_time
);
1241 pthread_mutex_unlock(socket
->lock
);
1242 if (ret
!= LTTNG_OK
) {
1245 /* Session is now ready for network streaming. */
1246 session
->net_handle
= 1;
1248 session
->consumer
->relay_major_version
=
1249 ksess
->consumer
->relay_major_version
;
1250 session
->consumer
->relay_minor_version
=
1251 ksess
->consumer
->relay_minor_version
;
1260 * Start a kernel session by opening all necessary streams.
1262 static int start_kernel_session(struct ltt_kernel_session
*ksess
)
1265 struct ltt_kernel_channel
*kchan
;
1267 /* Open kernel metadata */
1268 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1269 ret
= kernel_open_metadata(ksess
);
1271 ret
= LTTNG_ERR_KERN_META_FAIL
;
1276 /* Open kernel metadata stream */
1277 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1278 ret
= kernel_open_metadata_stream(ksess
);
1280 ERR("Kernel create metadata stream failed");
1281 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1286 /* For each channel */
1287 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1288 if (kchan
->stream_count
== 0) {
1289 ret
= kernel_open_channel_stream(kchan
);
1291 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1294 /* Update the stream global counter */
1295 ksess
->stream_count_global
+= ret
;
1299 /* Setup kernel consumer socket and send fds to it */
1300 ret
= init_kernel_tracing(ksess
);
1302 ret
= LTTNG_ERR_KERN_START_FAIL
;
1306 /* This start the kernel tracing */
1307 ret
= kernel_start_session(ksess
);
1309 ret
= LTTNG_ERR_KERN_START_FAIL
;
1313 /* Quiescent wait after starting trace */
1314 kernel_wait_quiescent();
1325 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1327 int cmd_disable_channel(struct ltt_session
*session
,
1328 enum lttng_domain_type domain
, char *channel_name
)
1331 struct ltt_ust_session
*usess
;
1333 usess
= session
->ust_session
;
1338 case LTTNG_DOMAIN_KERNEL
:
1340 ret
= channel_kernel_disable(session
->kernel_session
,
1342 if (ret
!= LTTNG_OK
) {
1346 kernel_wait_quiescent();
1349 case LTTNG_DOMAIN_UST
:
1351 struct ltt_ust_channel
*uchan
;
1352 struct lttng_ht
*chan_ht
;
1354 chan_ht
= usess
->domain_global
.channels
;
1356 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1357 if (uchan
== NULL
) {
1358 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1362 ret
= channel_ust_disable(usess
, uchan
);
1363 if (ret
!= LTTNG_OK
) {
1369 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1381 * Command LTTNG_TRACK_PID processed by the client thread.
1383 * Called with session lock held.
1385 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1393 case LTTNG_DOMAIN_KERNEL
:
1395 struct ltt_kernel_session
*ksess
;
1397 ksess
= session
->kernel_session
;
1399 ret
= kernel_track_pid(ksess
, pid
);
1400 if (ret
!= LTTNG_OK
) {
1404 kernel_wait_quiescent();
1407 case LTTNG_DOMAIN_UST
:
1409 struct ltt_ust_session
*usess
;
1411 usess
= session
->ust_session
;
1413 ret
= trace_ust_track_pid(usess
, pid
);
1414 if (ret
!= LTTNG_OK
) {
1420 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1432 * Command LTTNG_UNTRACK_PID processed by the client thread.
1434 * Called with session lock held.
1436 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1444 case LTTNG_DOMAIN_KERNEL
:
1446 struct ltt_kernel_session
*ksess
;
1448 ksess
= session
->kernel_session
;
1450 ret
= kernel_untrack_pid(ksess
, pid
);
1451 if (ret
!= LTTNG_OK
) {
1455 kernel_wait_quiescent();
1458 case LTTNG_DOMAIN_UST
:
1460 struct ltt_ust_session
*usess
;
1462 usess
= session
->ust_session
;
1464 ret
= trace_ust_untrack_pid(usess
, pid
);
1465 if (ret
!= LTTNG_OK
) {
1471 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1483 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1485 * The wpipe arguments is used as a notifier for the kernel thread.
1487 int cmd_enable_channel(struct ltt_session
*session
,
1488 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1491 struct ltt_ust_session
*usess
= session
->ust_session
;
1492 struct lttng_ht
*chan_ht
;
1494 struct lttng_channel attr
;
1501 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1503 /* Validate channel name */
1504 if (attr
.name
[0] == '.' ||
1505 memchr(attr
.name
, '/', len
) != NULL
) {
1506 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1510 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1515 * Don't try to enable a channel if the session has been started at
1516 * some point in time before. The tracer does not allow it.
1518 if (session
->has_been_started
) {
1519 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1524 * If the session is a live session, remove the switch timer, the
1525 * live timer does the same thing but sends also synchronisation
1526 * beacons for inactive streams.
1528 if (session
->live_timer
> 0) {
1529 attr
.attr
.live_timer_interval
= session
->live_timer
;
1530 attr
.attr
.switch_timer_interval
= 0;
1533 /* Check for feature support */
1534 switch (domain
->type
) {
1535 case LTTNG_DOMAIN_KERNEL
:
1537 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1538 /* Sampling position of buffer is not supported */
1539 WARN("Kernel tracer does not support buffer monitoring. "
1540 "Setting the monitor interval timer to 0 "
1541 "(disabled) for channel '%s' of session '%s'",
1542 attr
.name
, session
->name
);
1543 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1547 case LTTNG_DOMAIN_UST
:
1549 case LTTNG_DOMAIN_JUL
:
1550 case LTTNG_DOMAIN_LOG4J
:
1551 case LTTNG_DOMAIN_PYTHON
:
1552 if (!agent_tracing_is_enabled()) {
1553 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1554 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1559 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1563 switch (domain
->type
) {
1564 case LTTNG_DOMAIN_KERNEL
:
1566 struct ltt_kernel_channel
*kchan
;
1568 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1569 session
->kernel_session
);
1570 if (kchan
== NULL
) {
1571 if (session
->snapshot
.nb_output
> 0 ||
1572 session
->snapshot_mode
) {
1573 /* Enforce mmap output for snapshot sessions. */
1574 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1576 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1577 if (attr
.name
[0] != '\0') {
1578 session
->kernel_session
->has_non_default_channel
= 1;
1581 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1584 if (ret
!= LTTNG_OK
) {
1588 kernel_wait_quiescent();
1591 case LTTNG_DOMAIN_UST
:
1592 case LTTNG_DOMAIN_JUL
:
1593 case LTTNG_DOMAIN_LOG4J
:
1594 case LTTNG_DOMAIN_PYTHON
:
1596 struct ltt_ust_channel
*uchan
;
1601 * Current agent implementation limitations force us to allow
1602 * only one channel at once in "agent" subdomains. Each
1603 * subdomain has a default channel name which must be strictly
1606 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1607 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1608 LTTNG_SYMBOL_NAME_LEN
)) {
1609 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1612 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1613 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1614 LTTNG_SYMBOL_NAME_LEN
)) {
1615 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1618 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1619 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1620 LTTNG_SYMBOL_NAME_LEN
)) {
1621 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1626 chan_ht
= usess
->domain_global
.channels
;
1628 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1629 if (uchan
== NULL
) {
1630 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1631 if (attr
.name
[0] != '\0') {
1632 usess
->has_non_default_channel
= 1;
1635 ret
= channel_ust_enable(usess
, uchan
);
1640 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1644 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1645 session
->has_non_mmap_channel
= true;
1654 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1656 int cmd_disable_event(struct ltt_session
*session
,
1657 enum lttng_domain_type domain
, const char *channel_name
,
1658 const struct lttng_event
*event
)
1661 const char *event_name
;
1663 DBG("Disable event command for event \'%s\'", event
->name
);
1665 event_name
= event
->name
;
1667 /* Error out on unhandled search criteria */
1668 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1669 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1670 ret
= LTTNG_ERR_UNK
;
1677 case LTTNG_DOMAIN_KERNEL
:
1679 struct ltt_kernel_channel
*kchan
;
1680 struct ltt_kernel_session
*ksess
;
1682 ksess
= session
->kernel_session
;
1685 * If a non-default channel has been created in the
1686 * session, explicitely require that -c chan_name needs
1689 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1690 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1694 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1695 if (kchan
== NULL
) {
1696 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1700 switch (event
->type
) {
1701 case LTTNG_EVENT_ALL
:
1702 case LTTNG_EVENT_TRACEPOINT
:
1703 case LTTNG_EVENT_SYSCALL
:
1704 case LTTNG_EVENT_PROBE
:
1705 case LTTNG_EVENT_FUNCTION
:
1706 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1707 if (event_name
[0] == '\0') {
1708 ret
= event_kernel_disable_event(kchan
,
1711 ret
= event_kernel_disable_event(kchan
,
1712 event_name
, event
->type
);
1714 if (ret
!= LTTNG_OK
) {
1719 ret
= LTTNG_ERR_UNK
;
1723 kernel_wait_quiescent();
1726 case LTTNG_DOMAIN_UST
:
1728 struct ltt_ust_channel
*uchan
;
1729 struct ltt_ust_session
*usess
;
1731 usess
= session
->ust_session
;
1733 if (validate_ust_event_name(event_name
)) {
1734 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1739 * If a non-default channel has been created in the
1740 * session, explicitly require that -c chan_name needs
1743 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1744 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1748 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1750 if (uchan
== NULL
) {
1751 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1755 switch (event
->type
) {
1756 case LTTNG_EVENT_ALL
:
1758 * An empty event name means that everything
1759 * should be disabled.
1761 if (event
->name
[0] == '\0') {
1762 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1764 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1767 if (ret
!= LTTNG_OK
) {
1772 ret
= LTTNG_ERR_UNK
;
1776 DBG3("Disable UST event %s in channel %s completed", event_name
,
1780 case LTTNG_DOMAIN_LOG4J
:
1781 case LTTNG_DOMAIN_JUL
:
1782 case LTTNG_DOMAIN_PYTHON
:
1785 struct ltt_ust_session
*usess
= session
->ust_session
;
1789 switch (event
->type
) {
1790 case LTTNG_EVENT_ALL
:
1793 ret
= LTTNG_ERR_UNK
;
1797 agt
= trace_ust_find_agent(usess
, domain
);
1799 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1803 * An empty event name means that everything
1804 * should be disabled.
1806 if (event
->name
[0] == '\0') {
1807 ret
= event_agent_disable_all(usess
, agt
);
1809 ret
= event_agent_disable(usess
, agt
, event_name
);
1811 if (ret
!= LTTNG_OK
) {
1818 ret
= LTTNG_ERR_UND
;
1831 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1833 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1834 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1836 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1837 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1840 * Don't try to add a context if the session has been started at
1841 * some point in time before. The tracer does not allow it and would
1842 * result in a corrupted trace.
1844 if (session
->has_been_started
) {
1845 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1849 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1850 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1851 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1855 case LTTNG_DOMAIN_KERNEL
:
1856 assert(session
->kernel_session
);
1858 if (session
->kernel_session
->channel_count
== 0) {
1859 /* Create default channel */
1860 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1861 if (ret
!= LTTNG_OK
) {
1864 chan_kern_created
= 1;
1866 /* Add kernel context to kernel tracer */
1867 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1868 if (ret
!= LTTNG_OK
) {
1872 case LTTNG_DOMAIN_JUL
:
1873 case LTTNG_DOMAIN_LOG4J
:
1876 * Validate channel name.
1877 * If no channel name is given and the domain is JUL or LOG4J,
1878 * set it to the appropriate domain-specific channel name. If
1879 * a name is provided but does not match the expexted channel
1880 * name, return an error.
1882 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1883 strcmp(channel_name
,
1884 DEFAULT_JUL_CHANNEL_NAME
)) {
1885 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1887 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1888 strcmp(channel_name
,
1889 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1890 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1893 /* break is _not_ missing here. */
1895 case LTTNG_DOMAIN_UST
:
1897 struct ltt_ust_session
*usess
= session
->ust_session
;
1898 unsigned int chan_count
;
1902 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1903 if (chan_count
== 0) {
1904 struct lttng_channel
*attr
;
1905 /* Create default channel */
1906 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1908 ret
= LTTNG_ERR_FATAL
;
1912 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1913 if (ret
!= LTTNG_OK
) {
1917 channel_attr_destroy(attr
);
1918 chan_ust_created
= 1;
1921 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1922 free(app_ctx_provider_name
);
1924 app_ctx_name
= NULL
;
1925 app_ctx_provider_name
= NULL
;
1926 if (ret
!= LTTNG_OK
) {
1932 ret
= LTTNG_ERR_UND
;
1940 if (chan_kern_created
) {
1941 struct ltt_kernel_channel
*kchan
=
1942 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1943 session
->kernel_session
);
1944 /* Created previously, this should NOT fail. */
1946 kernel_destroy_channel(kchan
);
1949 if (chan_ust_created
) {
1950 struct ltt_ust_channel
*uchan
=
1951 trace_ust_find_channel_by_name(
1952 session
->ust_session
->domain_global
.channels
,
1953 DEFAULT_CHANNEL_NAME
);
1954 /* Created previously, this should NOT fail. */
1956 /* Remove from the channel list of the session. */
1957 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1959 trace_ust_destroy_channel(uchan
);
1962 free(app_ctx_provider_name
);
1967 static inline bool name_starts_with(const char *name
, const char *prefix
)
1969 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1971 return !strncmp(name
, prefix
, max_cmp_len
);
1974 /* Perform userspace-specific event name validation */
1975 static int validate_ust_event_name(const char *name
)
1985 * Check name against all internal UST event component namespaces used
1988 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1989 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1990 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1999 * Internal version of cmd_enable_event() with a supplemental
2000 * "internal_event" flag which is used to enable internal events which should
2001 * be hidden from clients. Such events are used in the agent implementation to
2002 * enable the events through which all "agent" events are funeled.
2004 static int _cmd_enable_event(struct ltt_session
*session
,
2005 const struct lttng_domain
*domain
,
2006 char *channel_name
, struct lttng_event
*event
,
2007 char *filter_expression
,
2008 struct lttng_filter_bytecode
*filter
,
2009 struct lttng_event_exclusion
*exclusion
,
2010 int wpipe
, bool internal_event
)
2012 int ret
= 0, channel_created
= 0;
2013 struct lttng_channel
*attr
= NULL
;
2017 assert(channel_name
);
2019 /* If we have a filter, we must have its filter expression */
2020 assert(!(!!filter_expression
^ !!filter
));
2022 /* Normalize event name as a globbing pattern */
2023 strutils_normalize_star_glob_pattern(event
->name
);
2025 /* Normalize exclusion names as globbing patterns */
2029 for (i
= 0; i
< exclusion
->count
; i
++) {
2030 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2032 strutils_normalize_star_glob_pattern(name
);
2036 DBG("Enable event command for event \'%s\'", event
->name
);
2040 switch (domain
->type
) {
2041 case LTTNG_DOMAIN_KERNEL
:
2043 struct ltt_kernel_channel
*kchan
;
2046 * If a non-default channel has been created in the
2047 * session, explicitely require that -c chan_name needs
2050 if (session
->kernel_session
->has_non_default_channel
2051 && channel_name
[0] == '\0') {
2052 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2056 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2057 session
->kernel_session
);
2058 if (kchan
== NULL
) {
2059 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2060 LTTNG_BUFFER_GLOBAL
);
2062 ret
= LTTNG_ERR_FATAL
;
2065 if (lttng_strncpy(attr
->name
, channel_name
,
2066 sizeof(attr
->name
))) {
2067 ret
= LTTNG_ERR_INVALID
;
2071 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2072 if (ret
!= LTTNG_OK
) {
2075 channel_created
= 1;
2078 /* Get the newly created kernel channel pointer */
2079 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2080 session
->kernel_session
);
2081 if (kchan
== NULL
) {
2082 /* This sould not happen... */
2083 ret
= LTTNG_ERR_FATAL
;
2087 switch (event
->type
) {
2088 case LTTNG_EVENT_ALL
:
2090 char *filter_expression_a
= NULL
;
2091 struct lttng_filter_bytecode
*filter_a
= NULL
;
2094 * We need to duplicate filter_expression and filter,
2095 * because ownership is passed to first enable
2098 if (filter_expression
) {
2099 filter_expression_a
= strdup(filter_expression
);
2100 if (!filter_expression_a
) {
2101 ret
= LTTNG_ERR_FATAL
;
2106 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2108 free(filter_expression_a
);
2109 ret
= LTTNG_ERR_FATAL
;
2112 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2114 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2115 ret
= event_kernel_enable_event(kchan
, event
,
2116 filter_expression
, filter
);
2117 /* We have passed ownership */
2118 filter_expression
= NULL
;
2120 if (ret
!= LTTNG_OK
) {
2121 if (channel_created
) {
2122 /* Let's not leak a useless channel. */
2123 kernel_destroy_channel(kchan
);
2125 free(filter_expression_a
);
2129 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2130 ret
= event_kernel_enable_event(kchan
, event
,
2131 filter_expression_a
, filter_a
);
2132 /* We have passed ownership */
2133 filter_expression_a
= NULL
;
2135 if (ret
!= LTTNG_OK
) {
2140 case LTTNG_EVENT_PROBE
:
2141 case LTTNG_EVENT_USERSPACE_PROBE
:
2142 case LTTNG_EVENT_FUNCTION
:
2143 case LTTNG_EVENT_FUNCTION_ENTRY
:
2144 case LTTNG_EVENT_TRACEPOINT
:
2145 ret
= event_kernel_enable_event(kchan
, event
,
2146 filter_expression
, filter
);
2147 /* We have passed ownership */
2148 filter_expression
= NULL
;
2150 if (ret
!= LTTNG_OK
) {
2151 if (channel_created
) {
2152 /* Let's not leak a useless channel. */
2153 kernel_destroy_channel(kchan
);
2158 case LTTNG_EVENT_SYSCALL
:
2159 ret
= event_kernel_enable_event(kchan
, event
,
2160 filter_expression
, filter
);
2161 /* We have passed ownership */
2162 filter_expression
= NULL
;
2164 if (ret
!= LTTNG_OK
) {
2169 ret
= LTTNG_ERR_UNK
;
2173 kernel_wait_quiescent();
2176 case LTTNG_DOMAIN_UST
:
2178 struct ltt_ust_channel
*uchan
;
2179 struct ltt_ust_session
*usess
= session
->ust_session
;
2184 * If a non-default channel has been created in the
2185 * session, explicitely require that -c chan_name needs
2188 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2189 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2193 /* Get channel from global UST domain */
2194 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2196 if (uchan
== NULL
) {
2197 /* Create default channel */
2198 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2199 usess
->buffer_type
);
2201 ret
= LTTNG_ERR_FATAL
;
2204 if (lttng_strncpy(attr
->name
, channel_name
,
2205 sizeof(attr
->name
))) {
2206 ret
= LTTNG_ERR_INVALID
;
2210 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2211 if (ret
!= LTTNG_OK
) {
2215 /* Get the newly created channel reference back */
2216 uchan
= trace_ust_find_channel_by_name(
2217 usess
->domain_global
.channels
, channel_name
);
2221 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2223 * Don't allow users to add UST events to channels which
2224 * are assigned to a userspace subdomain (JUL, Log4J,
2227 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2231 if (!internal_event
) {
2233 * Ensure the event name is not reserved for internal
2236 ret
= validate_ust_event_name(event
->name
);
2238 WARN("Userspace event name %s failed validation.",
2240 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2245 /* At this point, the session and channel exist on the tracer */
2246 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2247 filter_expression
, filter
, exclusion
,
2249 /* We have passed ownership */
2250 filter_expression
= NULL
;
2253 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2254 goto already_enabled
;
2255 } else if (ret
!= LTTNG_OK
) {
2260 case LTTNG_DOMAIN_LOG4J
:
2261 case LTTNG_DOMAIN_JUL
:
2262 case LTTNG_DOMAIN_PYTHON
:
2264 const char *default_event_name
, *default_chan_name
;
2266 struct lttng_event uevent
;
2267 struct lttng_domain tmp_dom
;
2268 struct ltt_ust_session
*usess
= session
->ust_session
;
2272 if (!agent_tracing_is_enabled()) {
2273 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2274 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2278 agt
= trace_ust_find_agent(usess
, domain
->type
);
2280 agt
= agent_create(domain
->type
);
2282 ret
= LTTNG_ERR_NOMEM
;
2285 agent_add(agt
, usess
->agents
);
2288 /* Create the default tracepoint. */
2289 memset(&uevent
, 0, sizeof(uevent
));
2290 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2291 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2292 default_event_name
= event_get_default_agent_ust_name(
2294 if (!default_event_name
) {
2295 ret
= LTTNG_ERR_FATAL
;
2298 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2299 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2302 * The domain type is changed because we are about to enable the
2303 * default channel and event for the JUL domain that are hardcoded.
2304 * This happens in the UST domain.
2306 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2307 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2309 switch (domain
->type
) {
2310 case LTTNG_DOMAIN_LOG4J
:
2311 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2313 case LTTNG_DOMAIN_JUL
:
2314 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2316 case LTTNG_DOMAIN_PYTHON
:
2317 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2320 /* The switch/case we are in makes this impossible */
2325 char *filter_expression_copy
= NULL
;
2326 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2329 const size_t filter_size
= sizeof(
2330 struct lttng_filter_bytecode
)
2333 filter_copy
= zmalloc(filter_size
);
2335 ret
= LTTNG_ERR_NOMEM
;
2338 memcpy(filter_copy
, filter
, filter_size
);
2340 filter_expression_copy
=
2341 strdup(filter_expression
);
2342 if (!filter_expression
) {
2343 ret
= LTTNG_ERR_NOMEM
;
2346 if (!filter_expression_copy
|| !filter_copy
) {
2347 free(filter_expression_copy
);
2353 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2354 (char *) default_chan_name
,
2355 &uevent
, filter_expression_copy
,
2356 filter_copy
, NULL
, wpipe
);
2359 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2360 goto already_enabled
;
2361 } else if (ret
!= LTTNG_OK
) {
2365 /* The wild card * means that everything should be enabled. */
2366 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2367 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2370 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2374 filter_expression
= NULL
;
2375 if (ret
!= LTTNG_OK
) {
2382 ret
= LTTNG_ERR_UND
;
2390 free(filter_expression
);
2393 channel_attr_destroy(attr
);
2399 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2400 * We own filter, exclusion, and filter_expression.
2402 int cmd_enable_event(struct ltt_session
*session
,
2403 const struct lttng_domain
*domain
,
2404 char *channel_name
, struct lttng_event
*event
,
2405 char *filter_expression
,
2406 struct lttng_filter_bytecode
*filter
,
2407 struct lttng_event_exclusion
*exclusion
,
2410 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2411 filter_expression
, filter
, exclusion
, wpipe
, false);
2415 * Enable an event which is internal to LTTng. An internal should
2416 * never be made visible to clients and are immune to checks such as
2419 static int cmd_enable_event_internal(struct ltt_session
*session
,
2420 const struct lttng_domain
*domain
,
2421 char *channel_name
, struct lttng_event
*event
,
2422 char *filter_expression
,
2423 struct lttng_filter_bytecode
*filter
,
2424 struct lttng_event_exclusion
*exclusion
,
2427 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2428 filter_expression
, filter
, exclusion
, wpipe
, true);
2432 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2434 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2435 struct lttng_event
**events
)
2438 ssize_t nb_events
= 0;
2441 case LTTNG_DOMAIN_KERNEL
:
2442 nb_events
= kernel_list_events(events
);
2443 if (nb_events
< 0) {
2444 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2448 case LTTNG_DOMAIN_UST
:
2449 nb_events
= ust_app_list_events(events
);
2450 if (nb_events
< 0) {
2451 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2455 case LTTNG_DOMAIN_LOG4J
:
2456 case LTTNG_DOMAIN_JUL
:
2457 case LTTNG_DOMAIN_PYTHON
:
2458 nb_events
= agent_list_events(events
, domain
);
2459 if (nb_events
< 0) {
2460 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2465 ret
= LTTNG_ERR_UND
;
2472 /* Return negative value to differentiate return code */
2477 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2479 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2480 struct lttng_event_field
**fields
)
2483 ssize_t nb_fields
= 0;
2486 case LTTNG_DOMAIN_UST
:
2487 nb_fields
= ust_app_list_event_fields(fields
);
2488 if (nb_fields
< 0) {
2489 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2493 case LTTNG_DOMAIN_KERNEL
:
2494 default: /* fall-through */
2495 ret
= LTTNG_ERR_UND
;
2502 /* Return negative value to differentiate return code */
2506 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2508 return syscall_table_list(events
);
2512 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2514 * Called with session lock held.
2516 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2517 enum lttng_domain_type domain
, int32_t **pids
)
2520 ssize_t nr_pids
= 0;
2523 case LTTNG_DOMAIN_KERNEL
:
2525 struct ltt_kernel_session
*ksess
;
2527 ksess
= session
->kernel_session
;
2528 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2530 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2535 case LTTNG_DOMAIN_UST
:
2537 struct ltt_ust_session
*usess
;
2539 usess
= session
->ust_session
;
2540 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2542 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2547 case LTTNG_DOMAIN_LOG4J
:
2548 case LTTNG_DOMAIN_JUL
:
2549 case LTTNG_DOMAIN_PYTHON
:
2551 ret
= LTTNG_ERR_UND
;
2558 /* Return negative value to differentiate return code */
2563 * Command LTTNG_START_TRACE processed by the client thread.
2565 * Called with session mutex held.
2567 int cmd_start_trace(struct ltt_session
*session
)
2569 enum lttng_error_code ret
;
2570 unsigned long nb_chan
= 0;
2571 struct ltt_kernel_session
*ksession
;
2572 struct ltt_ust_session
*usess
;
2573 const bool session_rotated_after_last_stop
=
2574 session
->rotated_after_last_stop
;
2578 /* Ease our life a bit ;) */
2579 ksession
= session
->kernel_session
;
2580 usess
= session
->ust_session
;
2582 /* Is the session already started? */
2583 if (session
->active
) {
2584 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2588 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2589 !session
->current_trace_chunk
) {
2591 * A rotation was launched while the session was stopped and
2592 * it has not been completed yet. It is not possible to start
2593 * the session since starting the session here would require a
2594 * rotation from "NULL" to a new trace chunk. That rotation
2595 * would overlap with the ongoing rotation, which is not
2598 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2600 ret
= LTTNG_ERR_ROTATION_PENDING
;
2605 * Starting a session without channel is useless since after that it's not
2606 * possible to enable channel thus inform the client.
2608 if (usess
&& usess
->domain_global
.channels
) {
2609 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2612 nb_chan
+= ksession
->channel_count
;
2615 ret
= LTTNG_ERR_NO_CHANNEL
;
2619 session
->active
= 1;
2620 session
->rotated_after_last_stop
= false;
2621 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2622 if (!session
->has_been_started
) {
2623 struct lttng_trace_chunk
*trace_chunk
;
2625 DBG("Creating initial trace chunk of session \"%s\"",
2627 trace_chunk
= session_create_new_trace_chunk(
2628 session
, NULL
, NULL
, NULL
);
2630 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2633 assert(!session
->current_trace_chunk
);
2634 ret
= session_set_trace_chunk(session
, trace_chunk
,
2636 lttng_trace_chunk_put(trace_chunk
);
2638 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2642 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2645 * Rotate existing streams into the new chunk.
2646 * This is a "quiet" rotation has no client has
2647 * explicitly requested this operation.
2649 * There is also no need to wait for the rotation
2650 * to complete as it will happen immediately. No data
2651 * was produced as the session was stopped, so the
2652 * rotation should happen on reception of the command.
2654 ret
= cmd_rotate_session(session
, NULL
, true);
2655 if (ret
!= LTTNG_OK
) {
2661 /* Kernel tracing */
2662 if (ksession
!= NULL
) {
2663 DBG("Start kernel tracing session %s", session
->name
);
2664 ret
= start_kernel_session(ksession
);
2665 if (ret
!= LTTNG_OK
) {
2670 /* Flag session that trace should start automatically */
2672 int int_ret
= ust_app_start_trace_all(usess
);
2675 ret
= LTTNG_ERR_UST_START_FAIL
;
2681 * Clear the flag that indicates that a rotation was done while the
2682 * session was stopped.
2684 session
->rotated_after_last_stop
= false;
2686 if (session
->rotate_timer_period
) {
2687 int int_ret
= timer_session_rotation_schedule_timer_start(
2688 session
, session
->rotate_timer_period
);
2691 ERR("Failed to enable rotate timer");
2692 ret
= LTTNG_ERR_UNK
;
2700 if (ret
== LTTNG_OK
) {
2701 /* Flag this after a successful start. */
2702 session
->has_been_started
|= 1;
2704 session
->active
= 0;
2705 /* Restore initial state on error. */
2706 session
->rotated_after_last_stop
=
2707 session_rotated_after_last_stop
;
2713 * Command LTTNG_STOP_TRACE processed by the client thread.
2715 int cmd_stop_trace(struct ltt_session
*session
)
2718 struct ltt_kernel_channel
*kchan
;
2719 struct ltt_kernel_session
*ksession
;
2720 struct ltt_ust_session
*usess
;
2721 bool error_occurred
= false;
2725 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2727 ksession
= session
->kernel_session
;
2728 usess
= session
->ust_session
;
2730 /* Session is not active. Skip everythong and inform the client. */
2731 if (!session
->active
) {
2732 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2737 if (ksession
&& ksession
->active
) {
2738 DBG("Stop kernel tracing");
2740 ret
= kernel_stop_session(ksession
);
2742 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2746 kernel_wait_quiescent();
2748 /* Flush metadata after stopping (if exists) */
2749 if (ksession
->metadata_stream_fd
>= 0) {
2750 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2752 ERR("Kernel metadata flush failed");
2753 error_occurred
= true;
2757 /* Flush all buffers after stopping */
2758 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2759 ret
= kernel_flush_buffer(kchan
);
2761 ERR("Kernel flush buffer error");
2762 error_occurred
= true;
2766 ksession
->active
= 0;
2767 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2771 if (usess
&& usess
->active
) {
2772 ret
= ust_app_stop_trace_all(usess
);
2774 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2779 /* Flag inactive after a successful stop. */
2780 session
->active
= 0;
2781 ret
= !error_occurred
? LTTNG_OK
: LTTNG_ERR_UNK
;
2788 * Set the base_path of the session only if subdir of a control uris is set.
2789 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2791 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2793 struct lttng_uri
*uris
)
2798 for (i
= 0; i
< nb_uri
; i
++) {
2799 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2800 uris
[i
].subdir
[0] == '\0') {
2801 /* Not interested in these URIs */
2805 if (session
->base_path
!= NULL
) {
2806 free(session
->base_path
);
2807 session
->base_path
= NULL
;
2810 /* Set session base_path */
2811 session
->base_path
= strdup(uris
[i
].subdir
);
2812 if (!session
->base_path
) {
2813 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2814 uris
[i
].subdir
, session
->name
);
2815 ret
= LTTNG_ERR_NOMEM
;
2818 DBG2("Setting base path \"%s\" for session \"%s\"",
2819 session
->base_path
, session
->name
);
2827 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2829 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2830 struct lttng_uri
*uris
)
2833 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2834 struct ltt_ust_session
*usess
= session
->ust_session
;
2840 /* Can't set consumer URI if the session is active. */
2841 if (session
->active
) {
2842 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2847 * Set the session base path if any. This is done inside
2848 * cmd_set_consumer_uri to preserve backward compatibility of the
2849 * previous session creation api vs the session descriptor api.
2851 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2852 if (ret
!= LTTNG_OK
) {
2856 /* Set the "global" consumer URIs */
2857 for (i
= 0; i
< nb_uri
; i
++) {
2858 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2860 if (ret
!= LTTNG_OK
) {
2865 /* Set UST session URIs */
2866 if (session
->ust_session
) {
2867 for (i
= 0; i
< nb_uri
; i
++) {
2868 ret
= add_uri_to_consumer(session
,
2869 session
->ust_session
->consumer
,
2870 &uris
[i
], LTTNG_DOMAIN_UST
);
2871 if (ret
!= LTTNG_OK
) {
2877 /* Set kernel session URIs */
2878 if (session
->kernel_session
) {
2879 for (i
= 0; i
< nb_uri
; i
++) {
2880 ret
= add_uri_to_consumer(session
,
2881 session
->kernel_session
->consumer
,
2882 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2883 if (ret
!= LTTNG_OK
) {
2890 * Make sure to set the session in output mode after we set URI since a
2891 * session can be created without URL (thus flagged in no output mode).
2893 session
->output_traces
= 1;
2895 ksess
->output_traces
= 1;
2899 usess
->output_traces
= 1;
2910 enum lttng_error_code
set_session_output_from_descriptor(
2911 struct ltt_session
*session
,
2912 const struct lttng_session_descriptor
*descriptor
)
2915 enum lttng_error_code ret_code
= LTTNG_OK
;
2916 enum lttng_session_descriptor_type session_type
=
2917 lttng_session_descriptor_get_type(descriptor
);
2918 enum lttng_session_descriptor_output_type output_type
=
2919 lttng_session_descriptor_get_output_type(descriptor
);
2920 struct lttng_uri uris
[2] = {};
2921 size_t uri_count
= 0;
2923 switch (output_type
) {
2924 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2926 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2927 lttng_session_descriptor_get_local_output_uri(descriptor
,
2931 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2932 lttng_session_descriptor_get_network_output_uris(descriptor
,
2933 &uris
[0], &uris
[1]);
2937 ret_code
= LTTNG_ERR_INVALID
;
2941 switch (session_type
) {
2942 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2944 struct snapshot_output
*new_output
= NULL
;
2946 new_output
= snapshot_output_alloc();
2948 ret_code
= LTTNG_ERR_NOMEM
;
2952 ret
= snapshot_output_init_with_uri(session
,
2953 DEFAULT_SNAPSHOT_MAX_SIZE
,
2954 NULL
, uris
, uri_count
, session
->consumer
,
2955 new_output
, &session
->snapshot
);
2957 ret_code
= (ret
== -ENOMEM
) ?
2958 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2959 snapshot_output_destroy(new_output
);
2962 snapshot_add_output(&session
->snapshot
, new_output
);
2965 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2966 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2968 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2972 ret_code
= LTTNG_ERR_INVALID
;
2980 enum lttng_error_code
cmd_create_session_from_descriptor(
2981 struct lttng_session_descriptor
*descriptor
,
2982 const lttng_sock_cred
*creds
,
2983 const char *home_path
)
2986 enum lttng_error_code ret_code
;
2987 const char *session_name
;
2988 struct ltt_session
*new_session
= NULL
;
2989 enum lttng_session_descriptor_status descriptor_status
;
2991 session_lock_list();
2993 if (*home_path
!= '/') {
2994 ERR("Home path provided by client is not absolute");
2995 ret_code
= LTTNG_ERR_INVALID
;
3000 descriptor_status
= lttng_session_descriptor_get_session_name(
3001 descriptor
, &session_name
);
3002 switch (descriptor_status
) {
3003 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3005 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3006 session_name
= NULL
;
3009 ret_code
= LTTNG_ERR_INVALID
;
3013 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3015 if (ret_code
!= LTTNG_OK
) {
3019 if (!session_name
) {
3020 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3023 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3028 if (!lttng_session_descriptor_is_output_destination_initialized(
3031 * Only include the session's creation time in the output
3032 * destination if the name of the session itself was
3033 * not auto-generated.
3035 ret_code
= lttng_session_descriptor_set_default_output(
3037 session_name
? &new_session
->creation_time
: NULL
,
3039 if (ret_code
!= LTTNG_OK
) {
3043 new_session
->has_user_specified_directory
=
3044 lttng_session_descriptor_has_output_directory(
3048 switch (lttng_session_descriptor_get_type(descriptor
)) {
3049 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3050 new_session
->snapshot_mode
= 1;
3052 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3053 new_session
->live_timer
=
3054 lttng_session_descriptor_live_get_timer_interval(
3061 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3062 if (ret_code
!= LTTNG_OK
) {
3065 new_session
->consumer
->enabled
= 1;
3066 ret_code
= LTTNG_OK
;
3068 /* Release reference provided by the session_create function. */
3069 session_put(new_session
);
3070 if (ret_code
!= LTTNG_OK
&& new_session
) {
3071 /* Release the global reference on error. */
3072 session_destroy(new_session
);
3074 session_unlock_list();
3078 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3079 struct lttng_session_descriptor
**return_descriptor
)
3082 size_t payload_size
;
3083 struct lttng_dynamic_buffer payload
;
3084 struct lttng_buffer_view home_dir_view
;
3085 struct lttng_buffer_view session_descriptor_view
;
3086 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3087 enum lttng_error_code ret_code
;
3089 lttng_dynamic_buffer_init(&payload
);
3090 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3092 ret_code
= LTTNG_ERR_INVALID
;
3095 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3096 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3097 ret_code
= LTTNG_ERR_INVALID
;
3101 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3102 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3103 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3105 ret_code
= LTTNG_ERR_NOMEM
;
3109 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3111 ERR("Reception of session descriptor failed, aborting.");
3112 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3116 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3119 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3120 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3122 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3123 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3125 ret
= lttng_session_descriptor_create_from_buffer(
3126 &session_descriptor_view
, &session_descriptor
);
3128 ERR("Failed to create session descriptor from payload of \"create session\" command");
3129 ret_code
= LTTNG_ERR_INVALID
;
3134 * Sets the descriptor's auto-generated properties (name, output) if
3137 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3139 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3140 if (ret_code
!= LTTNG_OK
) {
3144 ret_code
= LTTNG_OK
;
3145 *return_descriptor
= session_descriptor
;
3146 session_descriptor
= NULL
;
3148 lttng_dynamic_buffer_reset(&payload
);
3149 lttng_session_descriptor_destroy(session_descriptor
);
3154 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3155 void *_reply_context
)
3159 const struct cmd_destroy_session_reply_context
*reply_context
=
3161 struct lttng_dynamic_buffer payload
;
3162 struct lttcomm_session_destroy_command_header cmd_header
;
3163 struct lttng_trace_archive_location
*location
= NULL
;
3164 struct lttcomm_lttng_msg llm
= {
3165 .cmd_type
= LTTNG_DESTROY_SESSION
,
3166 .ret_code
= reply_context
->destruction_status
,
3169 sizeof(struct lttcomm_session_destroy_command_header
),
3172 size_t payload_size_before_location
;
3174 lttng_dynamic_buffer_init(&payload
);
3176 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3178 ERR("Failed to append session destruction message");
3182 cmd_header
.rotation_state
=
3183 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3184 session
->rotation_state
:
3185 LTTNG_ROTATION_STATE_NO_ROTATION
);
3186 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3187 sizeof(cmd_header
));
3189 ERR("Failed to append session destruction command header");
3193 if (!reply_context
->implicit_rotation_on_destroy
) {
3194 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3198 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3199 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3204 location
= session_get_trace_archive_location(session
);
3206 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3211 payload_size_before_location
= payload
.size
;
3212 comm_ret
= lttng_trace_archive_location_serialize(location
,
3215 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3219 /* Update the message to indicate the location's length. */
3220 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3221 payload
.size
- payload_size_before_location
;
3223 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3224 payload
.data
, payload
.size
);
3225 if (comm_ret
!= (ssize_t
) payload
.size
) {
3226 ERR("Failed to send result of the destruction of session \"%s\" to client",
3230 ret
= close(reply_context
->reply_sock_fd
);
3232 PERROR("Failed to close client socket in deferred session destroy reply");
3234 lttng_dynamic_buffer_reset(&payload
);
3235 free(_reply_context
);
3239 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3241 * Called with session lock held.
3243 int cmd_destroy_session(struct ltt_session
*session
,
3244 struct notification_thread_handle
*notification_thread_handle
,
3248 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3249 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3252 reply_context
= zmalloc(sizeof(*reply_context
));
3253 if (!reply_context
) {
3254 ret
= LTTNG_ERR_NOMEM
;
3257 reply_context
->reply_sock_fd
= *sock_fd
;
3263 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3265 if (session
->active
) {
3266 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3268 ret
= cmd_stop_trace(session
);
3269 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3270 /* Carry on with the destruction of the session. */
3271 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3272 session
->name
, lttng_strerror(-ret
));
3273 destruction_last_error
= ret
;
3277 if (session
->rotation_schedule_timer_enabled
) {
3278 if (timer_session_rotation_schedule_timer_stop(
3280 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3282 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3286 if (session
->rotate_size
) {
3287 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3288 session
->rotate_size
= 0;
3291 if (session
->most_recent_chunk_id
.is_set
&&
3292 session
->most_recent_chunk_id
.value
!= 0 &&
3293 session
->current_trace_chunk
&& session
->output_traces
) {
3295 * Perform a last rotation on destruction if rotations have
3296 * occurred during the session's lifetime.
3298 ret
= cmd_rotate_session(session
, NULL
, false);
3299 if (ret
!= LTTNG_OK
) {
3300 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3301 session
->name
, lttng_strerror(-ret
));
3302 destruction_last_error
= -ret
;
3304 if (reply_context
) {
3305 reply_context
->implicit_rotation_on_destroy
= true;
3307 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3309 * The user has not triggered a session rotation. However, to
3310 * ensure all data has been consumed, the session is rotated
3311 * to a 'null' trace chunk before it is destroyed.
3313 * This is a "quiet" rotation meaning that no notification is
3314 * emitted and no renaming of the current trace chunk takes
3317 ret
= cmd_rotate_session(session
, NULL
, true);
3318 if (ret
!= LTTNG_OK
) {
3319 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3320 session
->name
, lttng_strerror(-ret
));
3321 destruction_last_error
= -ret
;
3325 if (session
->shm_path
[0]) {
3327 * When a session is created with an explicit shm_path,
3328 * the consumer daemon will create its shared memory files
3329 * at that location and will *not* unlink them. This is normal
3330 * as the intention of that feature is to make it possible
3331 * to retrieve the content of those files should a crash occur.
3333 * To ensure the content of those files can be used, the
3334 * sessiond daemon will replicate the content of the metadata
3335 * cache in a metadata file.
3337 * On clean-up, it is expected that the consumer daemon will
3338 * unlink the shared memory files and that the session daemon
3339 * will unlink the metadata file. Then, the session's directory
3340 * in the shm path can be removed.
3342 * Unfortunately, a flaw in the design of the sessiond's and
3343 * consumerd's tear down of channels makes it impossible to
3344 * determine when the sessiond _and_ the consumerd have both
3345 * destroyed their representation of a channel. For one, the
3346 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3347 * callbacks in both daemons.
3349 * However, it is also impossible for the sessiond to know when
3350 * the consumer daemon is done destroying its channel(s) since
3351 * it occurs as a reaction to the closing of the channel's file
3352 * descriptor. There is no resulting communication initiated
3353 * from the consumerd to the sessiond to confirm that the
3354 * operation is completed (and was successful).
3356 * Until this is all fixed, the session daemon checks for the
3357 * removal of the session's shm path which makes it possible
3358 * to safely advertise a session as having been destroyed.
3360 * Prior to this fix, it was not possible to reliably save
3361 * a session making use of the --shm-path option, destroy it,
3362 * and load it again. This is because the creation of the
3363 * session would fail upon seeing the session's shm path
3364 * already in existence.
3366 * Note that none of the error paths in the check for the
3367 * directory's existence return an error. This is normal
3368 * as there isn't much that can be done. The session will
3369 * be destroyed properly, except that we can't offer the
3370 * guarantee that the same session can be re-created.
3372 current_completion_handler
= &destroy_completion_handler
.handler
;
3373 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3375 sizeof(destroy_completion_handler
.shm_path
));
3380 * The session is destroyed. However, note that the command context
3381 * still holds a reference to the session, thus delaying its destruction
3382 * _at least_ up to the point when that reference is released.
3384 session_destroy(session
);
3385 if (reply_context
) {
3386 reply_context
->destruction_status
= destruction_last_error
;
3387 ret
= session_add_destroy_notifier(session
,
3388 cmd_destroy_session_reply
,
3389 (void *) reply_context
);
3391 ret
= LTTNG_ERR_FATAL
;
3403 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3405 int cmd_register_consumer(struct ltt_session
*session
,
3406 enum lttng_domain_type domain
, const char *sock_path
,
3407 struct consumer_data
*cdata
)
3410 struct consumer_socket
*socket
= NULL
;
3417 case LTTNG_DOMAIN_KERNEL
:
3419 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3423 /* Can't register a consumer if there is already one */
3424 if (ksess
->consumer_fds_sent
!= 0) {
3425 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3429 sock
= lttcomm_connect_unix_sock(sock_path
);
3431 ret
= LTTNG_ERR_CONNECT_FAIL
;
3434 cdata
->cmd_sock
= sock
;
3436 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3437 if (socket
== NULL
) {
3440 PERROR("close register consumer");
3442 cdata
->cmd_sock
= -1;
3443 ret
= LTTNG_ERR_FATAL
;
3447 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3448 if (socket
->lock
== NULL
) {
3449 PERROR("zmalloc pthread mutex");
3450 ret
= LTTNG_ERR_FATAL
;
3453 pthread_mutex_init(socket
->lock
, NULL
);
3454 socket
->registered
= 1;
3457 consumer_add_socket(socket
, ksess
->consumer
);
3460 pthread_mutex_lock(&cdata
->pid_mutex
);
3462 pthread_mutex_unlock(&cdata
->pid_mutex
);
3467 /* TODO: Userspace tracing */
3468 ret
= LTTNG_ERR_UND
;
3476 consumer_destroy_socket(socket
);
3482 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3484 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3485 struct lttng_domain
**domains
)
3490 struct lttng_ht_iter iter
;
3492 if (session
->kernel_session
!= NULL
) {
3493 DBG3("Listing domains found kernel domain");
3497 if (session
->ust_session
!= NULL
) {
3498 DBG3("Listing domains found UST global domain");
3502 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3504 if (agt
->being_used
) {
3515 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3516 if (*domains
== NULL
) {
3517 ret
= LTTNG_ERR_FATAL
;
3521 if (session
->kernel_session
!= NULL
) {
3522 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3524 /* Kernel session buffer type is always GLOBAL */
3525 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3530 if (session
->ust_session
!= NULL
) {
3531 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3532 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3536 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3538 if (agt
->being_used
) {
3539 (*domains
)[index
].type
= agt
->domain
;
3540 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3550 /* Return negative value to differentiate return code */
3556 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3558 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3559 struct ltt_session
*session
, struct lttng_channel
**channels
)
3561 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3564 case LTTNG_DOMAIN_KERNEL
:
3565 if (session
->kernel_session
!= NULL
) {
3566 nb_chan
= session
->kernel_session
->channel_count
;
3568 DBG3("Number of kernel channels %zd", nb_chan
);
3570 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3574 case LTTNG_DOMAIN_UST
:
3575 if (session
->ust_session
!= NULL
) {
3577 nb_chan
= lttng_ht_get_count(
3578 session
->ust_session
->domain_global
.channels
);
3581 DBG3("Number of UST global channels %zd", nb_chan
);
3583 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3588 ret
= -LTTNG_ERR_UND
;
3593 const size_t channel_size
= sizeof(struct lttng_channel
) +
3594 sizeof(struct lttng_channel_extended
);
3595 struct lttng_channel_extended
*channel_exts
;
3597 payload_size
= nb_chan
* channel_size
;
3598 *channels
= zmalloc(payload_size
);
3599 if (*channels
== NULL
) {
3600 ret
= -LTTNG_ERR_FATAL
;
3604 channel_exts
= ((void *) *channels
) +
3605 (nb_chan
* sizeof(struct lttng_channel
));
3606 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3607 if (ret
!= LTTNG_OK
) {
3622 * Command LTTNG_LIST_EVENTS processed by the client thread.
3624 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3625 struct ltt_session
*session
, char *channel_name
,
3626 struct lttng_event
**events
, size_t *total_size
)
3629 ssize_t nb_event
= 0;
3632 case LTTNG_DOMAIN_KERNEL
:
3633 if (session
->kernel_session
!= NULL
) {
3634 nb_event
= list_lttng_kernel_events(channel_name
,
3635 session
->kernel_session
, events
,
3639 case LTTNG_DOMAIN_UST
:
3641 if (session
->ust_session
!= NULL
) {
3642 nb_event
= list_lttng_ust_global_events(channel_name
,
3643 &session
->ust_session
->domain_global
, events
,
3648 case LTTNG_DOMAIN_LOG4J
:
3649 case LTTNG_DOMAIN_JUL
:
3650 case LTTNG_DOMAIN_PYTHON
:
3651 if (session
->ust_session
) {
3652 struct lttng_ht_iter iter
;
3656 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3657 &iter
.iter
, agt
, node
.node
) {
3658 if (agt
->domain
== domain
) {
3659 nb_event
= list_lttng_agent_events(
3669 ret
= LTTNG_ERR_UND
;
3676 /* Return negative value to differentiate return code */
3681 * Using the session list, filled a lttng_session array to send back to the
3682 * client for session listing.
3684 * The session list lock MUST be acquired before calling this function. Use
3685 * session_lock_list() and session_unlock_list().
3687 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3688 size_t session_count
, uid_t uid
, gid_t gid
)
3692 struct ltt_session
*session
;
3693 struct ltt_session_list
*list
= session_get_list();
3694 struct lttng_session_extended
*extended
=
3695 (typeof(extended
)) (&sessions
[session_count
]);
3697 DBG("Getting all available session for UID %d GID %d",
3700 * Iterate over session list and append data after the control struct in
3703 cds_list_for_each_entry(session
, &list
->head
, list
) {
3704 if (!session_get(session
)) {
3708 * Only list the sessions the user can control.
3710 if (!session_access_ok(session
, uid
, gid
) ||
3711 session
->destroyed
) {
3712 session_put(session
);
3716 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3717 struct ltt_ust_session
*usess
= session
->ust_session
;
3719 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3720 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3721 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3722 ret
= build_network_session_path(sessions
[i
].path
,
3723 sizeof(sessions
[i
].path
), session
);
3725 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3726 session
->consumer
->dst
.session_root_path
);
3729 PERROR("snprintf session path");
3730 session_put(session
);
3734 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3735 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3736 sessions
[i
].enabled
= session
->active
;
3737 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3738 sessions
[i
].live_timer_interval
= session
->live_timer
;
3739 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3740 extended
[i
].creation_time
.is_set
= 1;
3742 session_put(session
);
3747 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3748 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3750 int cmd_data_pending(struct ltt_session
*session
)
3753 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3754 struct ltt_ust_session
*usess
= session
->ust_session
;
3758 DBG("Data pending for session %s", session
->name
);
3760 /* Session MUST be stopped to ask for data availability. */
3761 if (session
->active
) {
3762 ret
= LTTNG_ERR_SESSION_STARTED
;
3766 * If stopped, just make sure we've started before else the above call
3767 * will always send that there is data pending.
3769 * The consumer assumes that when the data pending command is received,
3770 * the trace has been started before or else no output data is written
3771 * by the streams which is a condition for data pending. So, this is
3772 * *VERY* important that we don't ask the consumer before a start
3775 if (!session
->has_been_started
) {
3781 /* A rotation is still pending, we have to wait. */
3782 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3783 DBG("Rotate still pending for session %s", session
->name
);
3788 if (ksess
&& ksess
->consumer
) {
3789 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3791 /* Data is still being extracted for the kernel. */
3796 if (usess
&& usess
->consumer
) {
3797 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3799 /* Data is still being extracted for the kernel. */
3804 /* Data is ready to be read by a viewer */
3812 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3814 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3816 int cmd_snapshot_add_output(struct ltt_session
*session
,
3817 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3820 struct snapshot_output
*new_output
;
3825 DBG("Cmd snapshot add output for session %s", session
->name
);
3828 * Can't create an output if the session is not set in no-output mode.
3830 if (session
->output_traces
) {
3831 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3835 if (session
->has_non_mmap_channel
) {
3836 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3840 /* Only one output is allowed until we have the "tee" feature. */
3841 if (session
->snapshot
.nb_output
== 1) {
3842 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3846 new_output
= snapshot_output_alloc();
3848 ret
= LTTNG_ERR_NOMEM
;
3852 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3853 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3854 &session
->snapshot
);
3856 if (ret
== -ENOMEM
) {
3857 ret
= LTTNG_ERR_NOMEM
;
3859 ret
= LTTNG_ERR_INVALID
;
3865 snapshot_add_output(&session
->snapshot
, new_output
);
3867 *id
= new_output
->id
;
3874 snapshot_output_destroy(new_output
);
3880 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3882 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3884 int cmd_snapshot_del_output(struct ltt_session
*session
,
3885 const struct lttng_snapshot_output
*output
)
3888 struct snapshot_output
*sout
= NULL
;
3896 * Permission denied to create an output if the session is not
3897 * set in no output mode.
3899 if (session
->output_traces
) {
3900 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3905 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3907 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3908 } else if (*output
->name
!= '\0') {
3909 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3911 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3914 ret
= LTTNG_ERR_INVALID
;
3918 snapshot_delete_output(&session
->snapshot
, sout
);
3919 snapshot_output_destroy(sout
);
3928 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3930 * If no output is available, outputs is untouched and 0 is returned.
3932 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3934 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3935 struct lttng_snapshot_output
**outputs
)
3938 struct lttng_snapshot_output
*list
= NULL
;
3939 struct lttng_ht_iter iter
;
3940 struct snapshot_output
*output
;
3945 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3948 * Permission denied to create an output if the session is not
3949 * set in no output mode.
3951 if (session
->output_traces
) {
3952 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3956 if (session
->snapshot
.nb_output
== 0) {
3961 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3963 ret
= -LTTNG_ERR_NOMEM
;
3967 /* Copy list from session to the new list object. */
3969 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3970 output
, node
.node
) {
3971 assert(output
->consumer
);
3972 list
[idx
].id
= output
->id
;
3973 list
[idx
].max_size
= output
->max_size
;
3974 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3975 sizeof(list
[idx
].name
))) {
3976 ret
= -LTTNG_ERR_INVALID
;
3979 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3980 if (lttng_strncpy(list
[idx
].ctrl_url
,
3981 output
->consumer
->dst
.session_root_path
,
3982 sizeof(list
[idx
].ctrl_url
))) {
3983 ret
= -LTTNG_ERR_INVALID
;
3988 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3989 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3991 ret
= -LTTNG_ERR_NOMEM
;
3996 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3997 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3999 ret
= -LTTNG_ERR_NOMEM
;
4008 ret
= session
->snapshot
.nb_output
;
4017 * Check if we can regenerate the metadata for this session.
4018 * Only kernel, UST per-uid and non-live sessions are supported.
4020 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4023 int check_regenerate_metadata_support(struct ltt_session
*session
)
4029 if (session
->live_timer
!= 0) {
4030 ret
= LTTNG_ERR_LIVE_SESSION
;
4033 if (!session
->active
) {
4034 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4037 if (session
->ust_session
) {
4038 switch (session
->ust_session
->buffer_type
) {
4039 case LTTNG_BUFFER_PER_UID
:
4041 case LTTNG_BUFFER_PER_PID
:
4042 ret
= LTTNG_ERR_PER_PID_SESSION
;
4046 ret
= LTTNG_ERR_UNK
;
4050 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4051 session
->consumer
->relay_minor_version
< 8) {
4052 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4062 int clear_metadata_file(int fd
)
4067 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4068 if (lseek_ret
< 0) {
4074 ret
= ftruncate(fd
, 0);
4076 PERROR("ftruncate");
4085 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4088 struct buffer_reg_uid
*uid_reg
= NULL
;
4089 struct buffer_reg_session
*session_reg
= NULL
;
4092 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4093 struct ust_registry_session
*registry
;
4094 struct ust_registry_channel
*chan
;
4095 struct lttng_ht_iter iter_chan
;
4097 session_reg
= uid_reg
->registry
;
4098 registry
= session_reg
->reg
.ust
;
4100 pthread_mutex_lock(®istry
->lock
);
4101 registry
->metadata_len_sent
= 0;
4102 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4103 registry
->metadata_len
= 0;
4104 registry
->metadata_version
++;
4105 if (registry
->metadata_fd
> 0) {
4106 /* Clear the metadata file's content. */
4107 ret
= clear_metadata_file(registry
->metadata_fd
);
4109 pthread_mutex_unlock(®istry
->lock
);
4114 ret
= ust_metadata_session_statedump(registry
, NULL
,
4115 registry
->major
, registry
->minor
);
4117 pthread_mutex_unlock(®istry
->lock
);
4118 ERR("Failed to generate session metadata (err = %d)",
4122 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4124 struct ust_registry_event
*event
;
4125 struct lttng_ht_iter iter_event
;
4127 ret
= ust_metadata_channel_statedump(registry
, chan
);
4129 pthread_mutex_unlock(®istry
->lock
);
4130 ERR("Failed to generate channel metadata "
4134 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4136 ret
= ust_metadata_event_statedump(registry
,
4139 pthread_mutex_unlock(®istry
->lock
);
4140 ERR("Failed to generate event metadata "
4146 pthread_mutex_unlock(®istry
->lock
);
4155 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4157 * Ask the consumer to truncate the existing metadata file(s) and
4158 * then regenerate the metadata. Live and per-pid sessions are not
4159 * supported and return an error.
4161 * Return 0 on success or else a LTTNG_ERR code.
4163 int cmd_regenerate_metadata(struct ltt_session
*session
)
4169 ret
= check_regenerate_metadata_support(session
);
4174 if (session
->kernel_session
) {
4175 ret
= kernctl_session_regenerate_metadata(
4176 session
->kernel_session
->fd
);
4178 ERR("Failed to regenerate the kernel metadata");
4183 if (session
->ust_session
) {
4184 ret
= ust_regenerate_metadata(session
->ust_session
);
4186 ERR("Failed to regenerate the UST metadata");
4190 DBG("Cmd metadata regenerate for session %s", session
->name
);
4198 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4200 * Ask the tracer to regenerate a new statedump.
4202 * Return 0 on success or else a LTTNG_ERR code.
4204 int cmd_regenerate_statedump(struct ltt_session
*session
)
4210 if (!session
->active
) {
4211 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4215 if (session
->kernel_session
) {
4216 ret
= kernctl_session_regenerate_statedump(
4217 session
->kernel_session
->fd
);
4219 * Currently, the statedump in kernel can only fail if out
4223 if (ret
== -ENOMEM
) {
4224 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4226 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4228 ERR("Failed to regenerate the kernel statedump");
4233 if (session
->ust_session
) {
4234 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4236 * Currently, the statedump in UST always returns 0.
4239 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4240 ERR("Failed to regenerate the UST statedump");
4244 DBG("Cmd regenerate statedump for session %s", session
->name
);
4251 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4252 struct notification_thread_handle
*notification_thread
)
4256 ssize_t sock_recv_len
;
4257 struct lttng_trigger
*trigger
= NULL
;
4258 struct lttng_buffer_view view
;
4259 struct lttng_dynamic_buffer trigger_buffer
;
4261 lttng_dynamic_buffer_init(&trigger_buffer
);
4262 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4263 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4265 ret
= LTTNG_ERR_NOMEM
;
4269 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4271 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4272 ERR("Failed to receive \"register trigger\" command payload");
4273 /* TODO: should this be a new error enum ? */
4274 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4278 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4279 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4281 ERR("Invalid trigger payload received in \"register trigger\" command");
4282 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4286 ret
= notification_thread_command_register_trigger(notification_thread
,
4288 /* Ownership of trigger was transferred. */
4291 lttng_trigger_destroy(trigger
);
4292 lttng_dynamic_buffer_reset(&trigger_buffer
);
4296 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4297 struct notification_thread_handle
*notification_thread
)
4301 ssize_t sock_recv_len
;
4302 struct lttng_trigger
*trigger
= NULL
;
4303 struct lttng_buffer_view view
;
4304 struct lttng_dynamic_buffer trigger_buffer
;
4306 lttng_dynamic_buffer_init(&trigger_buffer
);
4307 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4308 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4310 ret
= LTTNG_ERR_NOMEM
;
4314 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4316 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4317 ERR("Failed to receive \"unregister trigger\" command payload");
4318 /* TODO: should this be a new error enum ? */
4319 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4323 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4324 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4326 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4327 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4331 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4334 lttng_trigger_destroy(trigger
);
4335 lttng_dynamic_buffer_reset(&trigger_buffer
);
4340 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4341 * snapshot output is *not* set with a remote destination.
4343 * Return LTTNG_OK on success or a LTTNG_ERR code.
4345 static enum lttng_error_code
set_relayd_for_snapshot(
4346 struct consumer_output
*output
,
4347 const struct ltt_session
*session
)
4349 enum lttng_error_code status
= LTTNG_OK
;
4350 struct lttng_ht_iter iter
;
4351 struct consumer_socket
*socket
;
4352 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4353 const char *base_path
;
4358 DBG2("Set relayd object from snapshot output");
4360 if (session
->current_trace_chunk
) {
4361 enum lttng_trace_chunk_status chunk_status
=
4362 lttng_trace_chunk_get_id(
4363 session
->current_trace_chunk
,
4364 ¤t_chunk_id
.value
);
4366 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4367 current_chunk_id
.is_set
= true;
4369 ERR("Failed to get current trace chunk id");
4370 status
= LTTNG_ERR_UNK
;
4375 /* Ignore if snapshot consumer output is not network. */
4376 if (output
->type
!= CONSUMER_DST_NET
) {
4381 * The snapshot record URI base path overrides the session
4384 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4385 base_path
= output
->dst
.net
.control
.subdir
;
4387 base_path
= session
->base_path
;
4391 * For each consumer socket, create and send the relayd object of the
4395 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4396 socket
, node
.node
) {
4397 pthread_mutex_lock(socket
->lock
);
4398 status
= send_consumer_relayd_sockets(0, session
->id
,
4400 session
->name
, session
->hostname
,
4402 session
->live_timer
,
4403 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4404 session
->creation_time
,
4405 session
->name_contains_creation_time
);
4406 pthread_mutex_unlock(socket
->lock
);
4407 if (status
!= LTTNG_OK
) {
4419 * Record a kernel snapshot.
4421 * Return LTTNG_OK on success or a LTTNG_ERR code.
4423 static enum lttng_error_code
record_kernel_snapshot(
4424 struct ltt_kernel_session
*ksess
,
4425 const struct consumer_output
*output
,
4426 const struct ltt_session
*session
,
4427 int wait
, uint64_t nb_packets_per_stream
)
4429 enum lttng_error_code status
;
4435 status
= kernel_snapshot_record(
4436 ksess
, output
, wait
, nb_packets_per_stream
);
4441 * Record a UST snapshot.
4443 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4445 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4446 const struct consumer_output
*output
,
4447 const struct ltt_session
*session
,
4448 int wait
, uint64_t nb_packets_per_stream
)
4450 enum lttng_error_code status
;
4456 status
= ust_app_snapshot_record(
4457 usess
, output
, wait
, nb_packets_per_stream
);
4462 uint64_t get_session_size_one_more_packet_per_stream(
4463 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4465 uint64_t tot_size
= 0;
4467 if (session
->kernel_session
) {
4468 struct ltt_kernel_channel
*chan
;
4469 const struct ltt_kernel_session
*ksess
=
4470 session
->kernel_session
;
4472 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4473 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4475 * Don't take channel into account if we
4476 * already grab all its packets.
4480 tot_size
+= chan
->channel
->attr
.subbuf_size
4481 * chan
->stream_count
;
4485 if (session
->ust_session
) {
4486 const struct ltt_ust_session
*usess
= session
->ust_session
;
4488 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4496 * Calculate the number of packets we can grab from each stream that
4497 * fits within the overall snapshot max size.
4499 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4500 * the number of packets per stream.
4502 * TODO: this approach is not perfect: we consider the worse case
4503 * (packet filling the sub-buffers) as an upper bound, but we could do
4504 * better if we do this calculation while we actually grab the packet
4505 * content: we would know how much padding we don't actually store into
4508 * This algorithm is currently bounded by the number of packets per
4511 * Since we call this algorithm before actually grabbing the data, it's
4512 * an approximation: for instance, applications could appear/disappear
4513 * in between this call and actually grabbing data.
4516 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4520 uint64_t cur_nb_packets
= 0;
4523 return 0; /* Infinite */
4526 size_left
= max_size
;
4528 uint64_t one_more_packet_tot_size
;
4530 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4531 session
, cur_nb_packets
);
4532 if (!one_more_packet_tot_size
) {
4533 /* We are already grabbing all packets. */
4536 size_left
-= one_more_packet_tot_size
;
4537 if (size_left
< 0) {
4542 if (!cur_nb_packets
&& size_left
!= max_size
) {
4543 /* Not enough room to grab one packet of each stream, error. */
4546 return cur_nb_packets
;
4550 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4551 const struct snapshot_output
*snapshot_output
, int wait
)
4553 int64_t nb_packets_per_stream
;
4554 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4556 enum lttng_error_code ret_code
= LTTNG_OK
;
4557 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4558 struct consumer_output
*original_ust_consumer_output
= NULL
;
4559 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4560 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4561 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4563 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4565 snapshot_output
->name
,
4566 snapshot_output
->datetime
,
4567 snapshot_output
->nb_snapshot
);
4568 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4569 ERR("Failed to format snapshot name");
4570 ret_code
= LTTNG_ERR_INVALID
;
4573 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4574 snapshot_output
->name
, session
->name
,
4575 snapshot_chunk_name
);
4576 if (!session
->kernel_session
&& !session
->ust_session
) {
4577 ERR("Failed to record snapshot as no channels exist");
4578 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4582 if (session
->kernel_session
) {
4583 original_kernel_consumer_output
=
4584 session
->kernel_session
->consumer
;
4585 snapshot_kernel_consumer_output
=
4586 consumer_copy_output(snapshot_output
->consumer
);
4587 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4588 snapshot_chunk_name
);
4589 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4590 original_kernel_consumer_output
);
4592 ERR("Failed to copy consumer sockets from snapshot output configuration");
4593 ret_code
= LTTNG_ERR_NOMEM
;
4596 ret_code
= set_relayd_for_snapshot(
4597 snapshot_kernel_consumer_output
, session
);
4598 if (ret_code
!= LTTNG_OK
) {
4599 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4602 session
->kernel_session
->consumer
=
4603 snapshot_kernel_consumer_output
;
4605 if (session
->ust_session
) {
4606 original_ust_consumer_output
= session
->ust_session
->consumer
;
4607 snapshot_ust_consumer_output
=
4608 consumer_copy_output(snapshot_output
->consumer
);
4609 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4610 snapshot_chunk_name
);
4611 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4612 original_ust_consumer_output
);
4614 ERR("Failed to copy consumer sockets from snapshot output configuration");
4615 ret_code
= LTTNG_ERR_NOMEM
;
4618 ret_code
= set_relayd_for_snapshot(
4619 snapshot_ust_consumer_output
, session
);
4620 if (ret_code
!= LTTNG_OK
) {
4621 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4624 session
->ust_session
->consumer
=
4625 snapshot_ust_consumer_output
;
4628 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4629 snapshot_kernel_consumer_output
?:
4630 snapshot_ust_consumer_output
,
4631 consumer_output_get_base_path(
4632 snapshot_output
->consumer
),
4633 snapshot_chunk_name
);
4634 if (!snapshot_trace_chunk
) {
4635 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4637 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4640 assert(!session
->current_trace_chunk
);
4641 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4642 lttng_trace_chunk_put(snapshot_trace_chunk
);
4643 snapshot_trace_chunk
= NULL
;
4645 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4647 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4651 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4652 snapshot_output
->max_size
);
4653 if (nb_packets_per_stream
< 0) {
4654 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4655 goto error_close_trace_chunk
;
4658 if (session
->kernel_session
) {
4659 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4660 snapshot_kernel_consumer_output
, session
,
4661 wait
, nb_packets_per_stream
);
4662 if (ret_code
!= LTTNG_OK
) {
4663 goto error_close_trace_chunk
;
4667 if (session
->ust_session
) {
4668 ret_code
= record_ust_snapshot(session
->ust_session
,
4669 snapshot_ust_consumer_output
, session
,
4670 wait
, nb_packets_per_stream
);
4671 if (ret_code
!= LTTNG_OK
) {
4672 goto error_close_trace_chunk
;
4675 error_close_trace_chunk
:
4676 if (session_close_trace_chunk(
4677 session
, session
->current_trace_chunk
, NULL
, NULL
)) {
4679 * Don't goto end; make sure the chunk is closed for the session
4680 * to allow future snapshots.
4682 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4684 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4686 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4687 ERR("Failed to release the current trace chunk of session \"%s\"",
4689 ret_code
= LTTNG_ERR_UNK
;
4692 if (original_ust_consumer_output
) {
4693 session
->ust_session
->consumer
= original_ust_consumer_output
;
4695 if (original_kernel_consumer_output
) {
4696 session
->kernel_session
->consumer
=
4697 original_kernel_consumer_output
;
4699 consumer_output_put(snapshot_ust_consumer_output
);
4700 consumer_output_put(snapshot_kernel_consumer_output
);
4705 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4707 * The wait parameter is ignored so this call always wait for the snapshot to
4708 * complete before returning.
4710 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4712 int cmd_snapshot_record(struct ltt_session
*session
,
4713 const struct lttng_snapshot_output
*output
, int wait
)
4715 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4717 unsigned int snapshot_success
= 0;
4719 struct snapshot_output
*tmp_output
= NULL
;
4724 DBG("Cmd snapshot record for session %s", session
->name
);
4726 /* Get the datetime for the snapshot output directory. */
4727 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4730 cmd_ret
= LTTNG_ERR_INVALID
;
4735 * Permission denied to create an output if the session is not
4736 * set in no output mode.
4738 if (session
->output_traces
) {
4739 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4743 /* The session needs to be started at least once. */
4744 if (!session
->has_been_started
) {
4745 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4749 /* Use temporary output for the session. */
4750 if (*output
->ctrl_url
!= '\0') {
4751 tmp_output
= snapshot_output_alloc();
4753 cmd_ret
= LTTNG_ERR_NOMEM
;
4757 ret
= snapshot_output_init(session
, output
->max_size
,
4759 output
->ctrl_url
, output
->data_url
,
4763 if (ret
== -ENOMEM
) {
4764 cmd_ret
= LTTNG_ERR_NOMEM
;
4766 cmd_ret
= LTTNG_ERR_INVALID
;
4770 /* Use the global session count for the temporary snapshot. */
4771 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4773 /* Use the global datetime */
4774 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4775 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4776 if (cmd_ret
!= LTTNG_OK
) {
4779 snapshot_success
= 1;
4781 struct snapshot_output
*sout
;
4782 struct lttng_ht_iter iter
;
4785 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4786 &iter
.iter
, sout
, node
.node
) {
4787 struct snapshot_output output_copy
;
4790 * Make a local copy of the output and override output
4791 * parameters with those provided as part of the
4794 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4796 if (output
->max_size
!= (uint64_t) -1ULL) {
4797 output_copy
.max_size
= output
->max_size
;
4800 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4801 memcpy(output_copy
.datetime
, datetime
,
4804 /* Use temporary name. */
4805 if (*output
->name
!= '\0') {
4806 if (lttng_strncpy(output_copy
.name
,
4808 sizeof(output_copy
.name
))) {
4809 cmd_ret
= LTTNG_ERR_INVALID
;
4815 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4816 if (cmd_ret
!= LTTNG_OK
) {
4820 snapshot_success
= 1;
4825 if (snapshot_success
) {
4826 session
->snapshot
.nb_snapshot
++;
4828 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4833 snapshot_output_destroy(tmp_output
);
4839 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4841 int cmd_set_session_shm_path(struct ltt_session
*session
,
4842 const char *shm_path
)
4848 * Can only set shm path before session is started.
4850 if (session
->has_been_started
) {
4851 return LTTNG_ERR_SESSION_STARTED
;
4854 strncpy(session
->shm_path
, shm_path
,
4855 sizeof(session
->shm_path
));
4856 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4862 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4864 * Ask the consumer to rotate the session output directory.
4865 * The session lock must be held.
4867 * Returns LTTNG_OK on success or else a negative LTTng error code.
4869 int cmd_rotate_session(struct ltt_session
*session
,
4870 struct lttng_rotate_session_return
*rotate_return
,
4871 bool quiet_rotation
)
4874 uint64_t ongoing_rotation_chunk_id
;
4875 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4876 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4877 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4878 enum lttng_trace_chunk_status chunk_status
;
4879 bool failed_to_rotate
= false;
4880 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4884 if (!session
->has_been_started
) {
4885 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4890 * Explicit rotation is not supported for live sessions.
4891 * However, live sessions can perform a quiet rotation on
4893 * Rotation is not supported for snapshot traces (no output).
4895 if ((!quiet_rotation
&& session
->live_timer
) ||
4896 !session
->output_traces
) {
4897 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4901 /* Unsupported feature in lttng-relayd before 2.11. */
4902 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4903 (session
->consumer
->relay_major_version
== 2 &&
4904 session
->consumer
->relay_minor_version
< 11)) {
4905 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4909 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4910 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4911 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4915 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4916 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4918 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4923 * After a stop, we only allow one rotation to occur, the other ones are
4924 * useless until a new start.
4926 if (session
->rotated_after_last_stop
) {
4927 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4929 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4932 if (session
->active
) {
4933 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4935 if (!new_trace_chunk
) {
4936 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4942 * The current trace chunk becomes the chunk being archived.
4944 * After this point, "chunk_being_archived" must absolutely
4945 * be closed on the consumer(s), otherwise it will never be
4946 * cleaned-up, which will result in a leak.
4948 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4949 &chunk_being_archived
);
4951 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4955 if (session
->kernel_session
) {
4956 cmd_ret
= kernel_rotate_session(session
);
4957 if (cmd_ret
!= LTTNG_OK
) {
4958 failed_to_rotate
= true;
4959 rotation_fail_code
= cmd_ret
;
4962 if (session
->ust_session
) {
4963 cmd_ret
= ust_app_rotate_session(session
);
4964 if (cmd_ret
!= LTTNG_OK
) {
4965 failed_to_rotate
= true;
4966 rotation_fail_code
= cmd_ret
;
4970 if (!session
->active
) {
4971 session
->rotated_after_last_stop
= true;
4974 if (!chunk_being_archived
) {
4975 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
4977 if (failed_to_rotate
) {
4978 cmd_ret
= rotation_fail_code
;
4985 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4986 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
4987 &ongoing_rotation_chunk_id
);
4988 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4990 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
4993 &((enum lttng_trace_chunk_command_type
){
4994 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
}),
4995 session
->last_chunk_path
);
4997 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5001 if (failed_to_rotate
) {
5002 cmd_ret
= rotation_fail_code
;
5006 session
->quiet_rotation
= quiet_rotation
;
5007 ret
= timer_session_rotation_pending_check_start(session
,
5008 DEFAULT_ROTATE_PENDING_TIMER
);
5010 cmd_ret
= LTTNG_ERR_UNK
;
5014 if (rotate_return
) {
5015 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5018 session
->chunk_being_archived
= chunk_being_archived
;
5019 chunk_being_archived
= NULL
;
5020 if (!quiet_rotation
) {
5021 ret
= notification_thread_command_session_rotation_ongoing(
5022 notification_thread_handle
,
5023 session
->name
, session
->uid
, session
->gid
,
5024 ongoing_rotation_chunk_id
);
5025 if (ret
!= LTTNG_OK
) {
5026 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5032 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5033 session
->name
, ongoing_rotation_chunk_id
);
5035 lttng_trace_chunk_put(new_trace_chunk
);
5036 lttng_trace_chunk_put(chunk_being_archived
);
5037 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5040 if (session_reset_rotation_state(session
,
5041 LTTNG_ROTATION_STATE_ERROR
)) {
5042 ERR("Failed to reset rotation state of session \"%s\"",
5049 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5051 * Check if the session has finished its rotation.
5053 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5055 int cmd_rotate_get_info(struct ltt_session
*session
,
5056 struct lttng_rotation_get_info_return
*info_return
,
5057 uint64_t rotation_id
)
5059 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5060 enum lttng_rotation_state rotation_state
;
5062 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5063 session
->most_recent_chunk_id
.value
);
5065 if (session
->chunk_being_archived
) {
5066 enum lttng_trace_chunk_status chunk_status
;
5069 chunk_status
= lttng_trace_chunk_get_id(
5070 session
->chunk_being_archived
,
5072 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5074 rotation_state
= rotation_id
== chunk_id
?
5075 LTTNG_ROTATION_STATE_ONGOING
:
5076 LTTNG_ROTATION_STATE_EXPIRED
;
5078 if (session
->last_archived_chunk_id
.is_set
&&
5079 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5080 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5082 rotation_state
= session
->rotation_state
;
5086 switch (rotation_state
) {
5087 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5088 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5091 case LTTNG_ROTATION_STATE_EXPIRED
:
5092 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5093 rotation_id
, session
->name
);
5095 case LTTNG_ROTATION_STATE_ONGOING
:
5096 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5097 rotation_id
, session
->name
);
5099 case LTTNG_ROTATION_STATE_COMPLETED
:
5103 char *current_tracing_path_reply
;
5104 size_t current_tracing_path_reply_len
;
5106 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5107 rotation_id
, session
->name
);
5109 switch (session_get_consumer_destination_type(session
)) {
5110 case CONSUMER_DST_LOCAL
:
5111 current_tracing_path_reply
=
5112 info_return
->location
.local
.absolute_path
;
5113 current_tracing_path_reply_len
=
5114 sizeof(info_return
->location
.local
.absolute_path
);
5115 info_return
->location_type
=
5116 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5117 fmt_ret
= asprintf(&chunk_path
,
5118 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5119 session_get_base_path(session
),
5120 session
->last_archived_chunk_name
);
5121 if (fmt_ret
== -1) {
5122 PERROR("Failed to format the path of the last archived trace chunk");
5123 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5124 cmd_ret
= LTTNG_ERR_UNK
;
5128 case CONSUMER_DST_NET
:
5130 uint16_t ctrl_port
, data_port
;
5132 current_tracing_path_reply
=
5133 info_return
->location
.relay
.relative_path
;
5134 current_tracing_path_reply_len
=
5135 sizeof(info_return
->location
.relay
.relative_path
);
5136 /* Currently the only supported relay protocol. */
5137 info_return
->location
.relay
.protocol
=
5138 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5140 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5141 session_get_net_consumer_hostname(session
),
5142 sizeof(info_return
->location
.relay
.host
));
5144 ERR("Failed to copy host name to rotate_get_info reply");
5145 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5146 cmd_ret
= LTTNG_ERR_SET_URL
;
5150 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5151 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5152 info_return
->location
.relay
.ports
.data
= data_port
;
5153 info_return
->location_type
=
5154 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5155 chunk_path
= strdup(session
->last_chunk_path
);
5157 ERR("Failed to allocate the path of the last archived trace chunk");
5158 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5159 cmd_ret
= LTTNG_ERR_UNK
;
5168 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5169 chunk_path
, current_tracing_path_reply_len
);
5172 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5173 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5174 cmd_ret
= LTTNG_ERR_UNK
;
5180 case LTTNG_ROTATION_STATE_ERROR
:
5181 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5182 rotation_id
, session
->name
);
5190 info_return
->status
= (int32_t) rotation_state
;
5195 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5197 * Configure the automatic rotation parameters.
5198 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5199 * 'activate' to false means deactivate the rotation schedule and validate that
5200 * 'new_value' has the same value as the currently active value.
5202 * Return 0 on success or else a positive LTTNG_ERR code.
5204 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5205 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5207 struct notification_thread_handle
*notification_thread_handle
)
5210 uint64_t *parameter_value
;
5214 DBG("Cmd rotate set schedule session %s", session
->name
);
5216 if (session
->live_timer
|| !session
->output_traces
) {
5217 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5218 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5222 switch (schedule_type
) {
5223 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5224 parameter_value
= &session
->rotate_size
;
5226 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5227 parameter_value
= &session
->rotate_timer_period
;
5228 if (new_value
>= UINT_MAX
) {
5229 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5230 new_value
, UINT_MAX
);
5231 ret
= LTTNG_ERR_INVALID
;
5236 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5237 ret
= LTTNG_ERR_INVALID
;
5241 /* Improper use of the API. */
5242 if (new_value
== -1ULL) {
5243 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5244 ret
= LTTNG_ERR_INVALID
;
5249 * As indicated in struct ltt_session's comments, a value of == 0 means
5250 * this schedule rotation type is not in use.
5252 * Reject the command if we were asked to activate a schedule that was
5255 if (activate
&& *parameter_value
!= 0) {
5256 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5257 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5262 * Reject the command if we were asked to deactivate a schedule that was
5265 if (!activate
&& *parameter_value
== 0) {
5266 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5267 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5272 * Reject the command if we were asked to deactivate a schedule that
5275 if (!activate
&& *parameter_value
!= new_value
) {
5276 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5277 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5281 *parameter_value
= activate
? new_value
: 0;
5283 switch (schedule_type
) {
5284 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5285 if (activate
&& session
->active
) {
5287 * Only start the timer if the session is active,
5288 * otherwise it will be started when the session starts.
5290 ret
= timer_session_rotation_schedule_timer_start(
5291 session
, new_value
);
5293 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5294 ret
= LTTNG_ERR_UNK
;
5298 ret
= timer_session_rotation_schedule_timer_stop(
5301 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5302 ret
= LTTNG_ERR_UNK
;
5307 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5309 ret
= subscribe_session_consumed_size_rotation(session
,
5310 new_value
, notification_thread_handle
);
5312 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5313 ret
= LTTNG_ERR_UNK
;
5317 ret
= unsubscribe_session_consumed_size_rotation(session
,
5318 notification_thread_handle
);
5320 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5321 ret
= LTTNG_ERR_UNK
;
5328 /* Would have been caught before. */
5340 /* Wait for a given path to be removed before continuing. */
5341 static enum lttng_error_code
wait_on_path(void *path_data
)
5343 const char *shm_path
= path_data
;
5345 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5351 ret
= stat(shm_path
, &st
);
5353 if (errno
!= ENOENT
) {
5354 PERROR("stat() returned an error while checking for the existence of the shm path");
5356 DBG("shm path no longer exists, completing the destruction of session");
5360 if (!S_ISDIR(st
.st_mode
)) {
5361 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5366 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5372 * Returns a pointer to a handler to run on completion of a command.
5373 * Returns NULL if no handler has to be run for the last command executed.
5375 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5377 struct cmd_completion_handler
*handler
= current_completion_handler
;
5379 current_completion_handler
= NULL
;
5384 * Init command subsystem.
5389 * Set network sequence index to 1 for streams to match a relayd
5390 * socket on the consumer side.
5392 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5393 relayd_net_seq_idx
= 1;
5394 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5396 DBG("Command subsystem initialized");