2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
27 #include <common/defaults.h>
28 #include <common/common.h>
29 #include <common/sessiond-comm/sessiond-comm.h>
30 #include <common/relayd/relayd.h>
31 #include <common/utils.h>
32 #include <common/compat/string.h>
33 #include <common/kernel-ctl/kernel-ctl.h>
34 #include <common/dynamic-buffer.h>
35 #include <common/buffer-view.h>
36 #include <common/trace-chunk.h>
37 #include <lttng/location-internal.h>
38 #include <lttng/trigger/trigger-internal.h>
39 #include <lttng/condition/condition.h>
40 #include <lttng/action/action.h>
41 #include <lttng/channel.h>
42 #include <lttng/channel-internal.h>
43 #include <lttng/rotate-internal.h>
44 #include <lttng/location-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/userspace-probe-internal.h>
47 #include <lttng/session-descriptor-internal.h>
48 #include <common/string-utils/string-utils.h>
53 #include "health-sessiond.h"
55 #include "kernel-consumer.h"
56 #include "lttng-sessiond.h"
58 #include "lttng-syscall.h"
60 #include "buffer-registry.h"
61 #include "notification-thread.h"
62 #include "notification-thread-commands.h"
64 #include "rotation-thread.h"
66 #include "agent-thread.h"
70 /* Sleep for 100ms between each check for the shm path's deletion. */
71 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
73 struct cmd_destroy_session_reply_context
{
75 bool implicit_rotation_on_destroy
;
77 * Indicates whether or not an error occurred while launching the
78 * destruction of a session.
80 enum lttng_error_code destruction_status
;
83 static enum lttng_error_code
wait_on_path(void *path
);
86 * Command completion handler that is used by the destroy command
87 * when a session that has a non-default shm_path is being destroyed.
89 * See comment in cmd_destroy_session() for the rationale.
91 static struct destroy_completion_handler
{
92 struct cmd_completion_handler handler
;
93 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
94 } destroy_completion_handler
= {
97 .data
= destroy_completion_handler
.shm_path
102 static struct cmd_completion_handler
*current_completion_handler
;
105 * Used to keep a unique index for each relayd socket created where this value
106 * is associated with streams on the consumer so it can match the right relayd
107 * to send to. It must be accessed with the relayd_net_seq_idx_lock
110 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
111 static uint64_t relayd_net_seq_idx
;
113 static int validate_ust_event_name(const char *);
114 static int cmd_enable_event_internal(struct ltt_session
*session
,
115 const struct lttng_domain
*domain
,
116 char *channel_name
, struct lttng_event
*event
,
117 char *filter_expression
,
118 struct lttng_filter_bytecode
*filter
,
119 struct lttng_event_exclusion
*exclusion
,
123 * Create a session path used by list_lttng_sessions for the case that the
124 * session consumer is on the network.
126 static int build_network_session_path(char *dst
, size_t size
,
127 struct ltt_session
*session
)
129 int ret
, kdata_port
, udata_port
;
130 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
131 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
136 memset(tmp_urls
, 0, sizeof(tmp_urls
));
137 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
139 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
141 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
142 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
143 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
146 if (session
->ust_session
&& session
->ust_session
->consumer
) {
147 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
148 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
151 if (uuri
== NULL
&& kuri
== NULL
) {
152 uri
= &session
->consumer
->dst
.net
.control
;
153 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
154 } else if (kuri
&& uuri
) {
155 ret
= uri_compare(kuri
, uuri
);
159 /* Build uuri URL string */
160 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
167 } else if (kuri
&& uuri
== NULL
) {
169 } else if (uuri
&& kuri
== NULL
) {
173 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
179 * Do we have a UST url set. If yes, this means we have both kernel and UST
182 if (*tmp_uurl
!= '\0') {
183 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
184 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
187 if (kuri
|| (!kuri
&& !uuri
)) {
190 /* No kernel URI, use the UST port. */
193 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
201 * Get run-time attributes if the session has been started (discarded events,
204 static int get_kernel_runtime_stats(struct ltt_session
*session
,
205 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
206 uint64_t *lost_packets
)
210 if (!session
->has_been_started
) {
212 *discarded_events
= 0;
217 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
218 session
->kernel_session
->consumer
,
224 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
225 session
->kernel_session
->consumer
,
236 * Get run-time attributes if the session has been started (discarded events,
239 static int get_ust_runtime_stats(struct ltt_session
*session
,
240 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
241 uint64_t *lost_packets
)
244 struct ltt_ust_session
*usess
;
246 if (!discarded_events
|| !lost_packets
) {
251 usess
= session
->ust_session
;
252 assert(discarded_events
);
253 assert(lost_packets
);
255 if (!usess
|| !session
->has_been_started
) {
256 *discarded_events
= 0;
262 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
263 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
264 &usess
->buffer_reg_uid_list
,
265 usess
->consumer
, uchan
->id
,
266 uchan
->attr
.overwrite
,
269 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
270 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
271 uchan
, usess
->consumer
,
272 uchan
->attr
.overwrite
,
278 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
279 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
281 ERR("Unsupported buffer type");
292 * Fill lttng_channel array of all channels.
294 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
295 struct ltt_session
*session
, struct lttng_channel
*channels
,
296 struct lttng_channel_extended
*chan_exts
)
299 struct ltt_kernel_channel
*kchan
;
301 DBG("Listing channels for session %s", session
->name
);
304 case LTTNG_DOMAIN_KERNEL
:
305 /* Kernel channels */
306 if (session
->kernel_session
!= NULL
) {
307 cds_list_for_each_entry(kchan
,
308 &session
->kernel_session
->channel_list
.head
, list
) {
309 uint64_t discarded_events
, lost_packets
;
310 struct lttng_channel_extended
*extended
;
312 extended
= (struct lttng_channel_extended
*)
313 kchan
->channel
->attr
.extended
.ptr
;
315 ret
= get_kernel_runtime_stats(session
, kchan
,
316 &discarded_events
, &lost_packets
);
320 /* Copy lttng_channel struct to array */
321 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
322 channels
[i
].enabled
= kchan
->enabled
;
323 chan_exts
[i
].discarded_events
=
325 chan_exts
[i
].lost_packets
= lost_packets
;
326 chan_exts
[i
].monitor_timer_interval
=
327 extended
->monitor_timer_interval
;
328 chan_exts
[i
].blocking_timeout
= 0;
333 case LTTNG_DOMAIN_UST
:
335 struct lttng_ht_iter iter
;
336 struct ltt_ust_channel
*uchan
;
339 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
340 &iter
.iter
, uchan
, node
.node
) {
341 uint64_t discarded_events
= 0, lost_packets
= 0;
343 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
344 LTTNG_SYMBOL_NAME_LEN
)) {
347 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
348 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
349 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
350 channels
[i
].attr
.switch_timer_interval
=
351 uchan
->attr
.switch_timer_interval
;
352 channels
[i
].attr
.read_timer_interval
=
353 uchan
->attr
.read_timer_interval
;
354 channels
[i
].enabled
= uchan
->enabled
;
355 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
356 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
359 * Map enum lttng_ust_output to enum lttng_event_output.
361 switch (uchan
->attr
.output
) {
363 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
367 * LTTNG_UST_MMAP is the only supported UST
374 chan_exts
[i
].monitor_timer_interval
=
375 uchan
->monitor_timer_interval
;
376 chan_exts
[i
].blocking_timeout
=
377 uchan
->attr
.u
.s
.blocking_timeout
;
379 ret
= get_ust_runtime_stats(session
, uchan
,
380 &discarded_events
, &lost_packets
);
384 chan_exts
[i
].discarded_events
= discarded_events
;
385 chan_exts
[i
].lost_packets
= lost_packets
;
397 return -LTTNG_ERR_FATAL
;
403 static int increment_extended_len(const char *filter_expression
,
404 struct lttng_event_exclusion
*exclusion
,
405 const struct lttng_userspace_probe_location
*probe_location
,
406 size_t *extended_len
)
410 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
412 if (filter_expression
) {
413 *extended_len
+= strlen(filter_expression
) + 1;
417 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
420 if (probe_location
) {
421 ret
= lttng_userspace_probe_location_serialize(probe_location
,
426 *extended_len
+= ret
;
433 static int append_extended_info(const char *filter_expression
,
434 struct lttng_event_exclusion
*exclusion
,
435 struct lttng_userspace_probe_location
*probe_location
,
439 size_t filter_len
= 0;
440 size_t nb_exclusions
= 0;
441 size_t userspace_probe_location_len
= 0;
442 struct lttng_dynamic_buffer location_buffer
;
443 struct lttcomm_event_extended_header extended_header
;
445 if (filter_expression
) {
446 filter_len
= strlen(filter_expression
) + 1;
450 nb_exclusions
= exclusion
->count
;
453 if (probe_location
) {
454 lttng_dynamic_buffer_init(&location_buffer
);
455 ret
= lttng_userspace_probe_location_serialize(probe_location
,
456 &location_buffer
, NULL
);
461 userspace_probe_location_len
= location_buffer
.size
;
464 /* Set header fields */
465 extended_header
.filter_len
= filter_len
;
466 extended_header
.nb_exclusions
= nb_exclusions
;
467 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
470 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
471 *extended_at
+= sizeof(extended_header
);
473 /* Copy filter string */
474 if (filter_expression
) {
475 memcpy(*extended_at
, filter_expression
, filter_len
);
476 *extended_at
+= filter_len
;
479 /* Copy exclusion names */
481 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
483 memcpy(*extended_at
, &exclusion
->names
, len
);
487 if (probe_location
) {
488 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
489 *extended_at
+= location_buffer
.size
;
490 lttng_dynamic_buffer_reset(&location_buffer
);
498 * Create a list of agent domain events.
500 * Return number of events in list on success or else a negative value.
502 static int list_lttng_agent_events(struct agent
*agt
,
503 struct lttng_event
**events
, size_t *total_size
)
506 unsigned int nb_event
= 0;
507 struct agent_event
*event
;
508 struct lttng_event
*tmp_events
= NULL
;
509 struct lttng_ht_iter iter
;
510 size_t extended_len
= 0;
516 DBG3("Listing agent events");
519 nb_event
= lttng_ht_get_count(agt
->events
);
527 /* Compute required extended infos size */
528 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
531 * This is only valid because the commands which add events are
532 * processed in the same thread as the listing.
535 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
536 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
539 DBG("Error computing the length of extended info message");
540 ret
= -LTTNG_ERR_FATAL
;
546 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
547 tmp_events
= zmalloc(*total_size
);
549 PERROR("zmalloc agent events session");
550 ret
= -LTTNG_ERR_FATAL
;
554 extended_at
= ((uint8_t *) tmp_events
) +
555 nb_event
* sizeof(struct lttng_event
);
558 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
559 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
560 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
561 tmp_events
[i
].enabled
= event
->enabled
;
562 tmp_events
[i
].loglevel
= event
->loglevel_value
;
563 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
566 /* Append extended info */
567 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
570 DBG("Error appending extended info message");
571 ret
= -LTTNG_ERR_FATAL
;
576 *events
= tmp_events
;
578 assert(nb_event
== i
);
589 * Create a list of ust global domain events.
591 static int list_lttng_ust_global_events(char *channel_name
,
592 struct ltt_ust_domain_global
*ust_global
,
593 struct lttng_event
**events
, size_t *total_size
)
596 unsigned int nb_event
= 0;
597 struct lttng_ht_iter iter
;
598 struct lttng_ht_node_str
*node
;
599 struct ltt_ust_channel
*uchan
;
600 struct ltt_ust_event
*uevent
;
601 struct lttng_event
*tmp
;
602 size_t extended_len
= 0;
605 DBG("Listing UST global events for channel %s", channel_name
);
609 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
610 node
= lttng_ht_iter_get_node_str(&iter
);
612 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
616 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
618 nb_event
= lttng_ht_get_count(uchan
->events
);
625 DBG3("Listing UST global %d events", nb_event
);
627 /* Compute required extended infos size */
628 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
629 if (uevent
->internal
) {
634 ret
= increment_extended_len(uevent
->filter_expression
,
635 uevent
->exclusion
, NULL
, &extended_len
);
637 DBG("Error computing the length of extended info message");
638 ret
= -LTTNG_ERR_FATAL
;
643 /* All events are internal, skip. */
649 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
650 tmp
= zmalloc(*total_size
);
652 ret
= -LTTNG_ERR_FATAL
;
656 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
658 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
659 if (uevent
->internal
) {
660 /* This event should remain hidden from clients */
663 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
664 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
665 tmp
[i
].enabled
= uevent
->enabled
;
667 switch (uevent
->attr
.instrumentation
) {
668 case LTTNG_UST_TRACEPOINT
:
669 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
671 case LTTNG_UST_PROBE
:
672 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
674 case LTTNG_UST_FUNCTION
:
675 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
679 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
680 switch (uevent
->attr
.loglevel_type
) {
681 case LTTNG_UST_LOGLEVEL_ALL
:
682 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
684 case LTTNG_UST_LOGLEVEL_RANGE
:
685 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
687 case LTTNG_UST_LOGLEVEL_SINGLE
:
688 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
691 if (uevent
->filter
) {
694 if (uevent
->exclusion
) {
695 tmp
[i
].exclusion
= 1;
699 /* Append extended info */
700 ret
= append_extended_info(uevent
->filter_expression
,
701 uevent
->exclusion
, NULL
, &extended_at
);
703 DBG("Error appending extended info message");
704 ret
= -LTTNG_ERR_FATAL
;
717 * Fill lttng_event array of all kernel events in the channel.
719 static int list_lttng_kernel_events(char *channel_name
,
720 struct ltt_kernel_session
*kernel_session
,
721 struct lttng_event
**events
, size_t *total_size
)
724 unsigned int nb_event
;
725 struct ltt_kernel_event
*event
;
726 struct ltt_kernel_channel
*kchan
;
727 size_t extended_len
= 0;
730 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
732 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
736 nb_event
= kchan
->event_count
;
738 DBG("Listing events for channel %s", kchan
->channel
->name
);
746 /* Compute required extended infos size */
747 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
748 ret
= increment_extended_len(event
->filter_expression
, NULL
,
749 event
->userspace_probe_location
,
752 DBG("Error computing the length of extended info message");
753 ret
= -LTTNG_ERR_FATAL
;
758 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
759 *events
= zmalloc(*total_size
);
760 if (*events
== NULL
) {
761 ret
= -LTTNG_ERR_FATAL
;
765 extended_at
= ((void *) *events
) +
766 nb_event
* sizeof(struct lttng_event
);
768 /* Kernel channels */
769 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
770 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
771 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
772 (*events
)[i
].enabled
= event
->enabled
;
773 (*events
)[i
].filter
=
774 (unsigned char) !!event
->filter_expression
;
776 switch (event
->event
->instrumentation
) {
777 case LTTNG_KERNEL_TRACEPOINT
:
778 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
780 case LTTNG_KERNEL_KRETPROBE
:
781 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
782 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
783 sizeof(struct lttng_kernel_kprobe
));
785 case LTTNG_KERNEL_KPROBE
:
786 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
787 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
788 sizeof(struct lttng_kernel_kprobe
));
790 case LTTNG_KERNEL_UPROBE
:
791 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
793 case LTTNG_KERNEL_FUNCTION
:
794 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
795 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
796 sizeof(struct lttng_kernel_function
));
798 case LTTNG_KERNEL_NOOP
:
799 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
801 case LTTNG_KERNEL_SYSCALL
:
802 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
804 case LTTNG_KERNEL_ALL
:
812 /* Append extended info */
813 ret
= append_extended_info(event
->filter_expression
, NULL
,
814 event
->userspace_probe_location
, &extended_at
);
816 DBG("Error appending extended info message");
817 ret
= -LTTNG_ERR_FATAL
;
826 /* Negate the error code to differentiate the size from an error */
831 * Add URI so the consumer output object. Set the correct path depending on the
832 * domain adding the default trace directory.
834 static enum lttng_error_code
add_uri_to_consumer(
835 const struct ltt_session
*session
,
836 struct consumer_output
*consumer
,
837 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
840 enum lttng_error_code ret_code
= LTTNG_OK
;
844 if (consumer
== NULL
) {
845 DBG("No consumer detected. Don't add URI. Stopping.");
846 ret_code
= LTTNG_ERR_NO_CONSUMER
;
851 case LTTNG_DOMAIN_KERNEL
:
852 ret
= lttng_strncpy(consumer
->domain_subdir
,
853 DEFAULT_KERNEL_TRACE_DIR
,
854 sizeof(consumer
->domain_subdir
));
856 case LTTNG_DOMAIN_UST
:
857 ret
= lttng_strncpy(consumer
->domain_subdir
,
858 DEFAULT_UST_TRACE_DIR
,
859 sizeof(consumer
->domain_subdir
));
863 * This case is possible is we try to add the URI to the global
864 * tracing session consumer object which in this case there is
867 memset(consumer
->domain_subdir
, 0,
868 sizeof(consumer
->domain_subdir
));
872 ERR("Failed to initialize consumer output domain subdirectory");
873 ret_code
= LTTNG_ERR_FATAL
;
877 switch (uri
->dtype
) {
880 DBG2("Setting network URI to consumer");
882 if (consumer
->type
== CONSUMER_DST_NET
) {
883 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
884 consumer
->dst
.net
.control_isset
) ||
885 (uri
->stype
== LTTNG_STREAM_DATA
&&
886 consumer
->dst
.net
.data_isset
)) {
887 ret_code
= LTTNG_ERR_URL_EXIST
;
891 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
894 /* Set URI into consumer output object */
895 ret
= consumer_set_network_uri(session
, consumer
, uri
);
899 } else if (ret
== 1) {
901 * URI was the same in the consumer so we do not append the subdir
902 * again so to not duplicate output dir.
909 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
910 ret_code
= LTTNG_ERR_INVALID
;
913 DBG2("Setting trace directory path from URI to %s",
915 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
917 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
919 sizeof(consumer
->dst
.session_root_path
));
921 ret_code
= LTTNG_ERR_FATAL
;
924 consumer
->type
= CONSUMER_DST_LOCAL
;
934 * Init tracing by creating trace directory and sending fds kernel consumer.
936 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
939 struct lttng_ht_iter iter
;
940 struct consumer_socket
*socket
;
946 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
947 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
949 pthread_mutex_lock(socket
->lock
);
950 ret
= kernel_consumer_send_session(socket
, session
);
951 pthread_mutex_unlock(socket
->lock
);
953 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
965 * Create a socket to the relayd using the URI.
967 * On success, the relayd_sock pointer is set to the created socket.
968 * Else, it remains untouched and an LTTng error code is returned.
970 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
971 struct lttcomm_relayd_sock
**relayd_sock
,
972 struct consumer_output
*consumer
)
975 enum lttng_error_code status
= LTTNG_OK
;
976 struct lttcomm_relayd_sock
*rsock
;
978 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
979 RELAYD_VERSION_COMM_MINOR
);
981 status
= LTTNG_ERR_FATAL
;
986 * Connect to relayd so we can proceed with a session creation. This call
987 * can possibly block for an arbitrary amount of time to set the health
988 * state to be in poll execution.
991 ret
= relayd_connect(rsock
);
994 ERR("Unable to reach lttng-relayd");
995 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
999 /* Create socket for control stream. */
1000 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
1001 uint64_t result_flags
;
1003 DBG3("Creating relayd stream socket from URI");
1005 /* Check relayd version */
1006 ret
= relayd_version_check(rsock
);
1007 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1008 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1010 } else if (ret
< 0) {
1011 ERR("Unable to reach lttng-relayd");
1012 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1015 consumer
->relay_major_version
= rsock
->major
;
1016 consumer
->relay_minor_version
= rsock
->minor
;
1017 ret
= relayd_get_configuration(rsock
, 0,
1020 ERR("Unable to get relayd configuration");
1021 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1024 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1025 consumer
->relay_allows_clear
= true;
1027 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1028 DBG3("Creating relayd data socket from URI");
1030 /* Command is not valid */
1031 ERR("Relayd invalid stream type: %d", uri
->stype
);
1032 status
= LTTNG_ERR_INVALID
;
1036 *relayd_sock
= rsock
;
1041 /* The returned value is not useful since we are on an error path. */
1042 (void) relayd_close(rsock
);
1050 * Connect to the relayd using URI and send the socket to the right consumer.
1052 * The consumer socket lock must be held by the caller.
1054 * Returns LTTNG_OK on success or an LTTng error code on failure.
1056 static enum lttng_error_code
send_consumer_relayd_socket(
1057 unsigned int session_id
,
1058 struct lttng_uri
*relayd_uri
,
1059 struct consumer_output
*consumer
,
1060 struct consumer_socket
*consumer_sock
,
1061 const char *session_name
, const char *hostname
,
1062 const char *base_path
, int session_live_timer
,
1063 const uint64_t *current_chunk_id
,
1064 time_t session_creation_time
,
1065 bool session_name_contains_creation_time
)
1068 struct lttcomm_relayd_sock
*rsock
= NULL
;
1069 enum lttng_error_code status
;
1071 /* Connect to relayd and make version check if uri is the control. */
1072 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1073 if (status
!= LTTNG_OK
) {
1074 goto relayd_comm_error
;
1078 /* Set the network sequence index if not set. */
1079 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1080 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1082 * Increment net_seq_idx because we are about to transfer the
1083 * new relayd socket to the consumer.
1084 * Assign unique key so the consumer can match streams.
1086 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1087 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1090 /* Send relayd socket to consumer. */
1091 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1092 relayd_uri
->stype
, session_id
,
1093 session_name
, hostname
, base_path
,
1094 session_live_timer
, current_chunk_id
,
1095 session_creation_time
, session_name_contains_creation_time
);
1097 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1101 /* Flag that the corresponding socket was sent. */
1102 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1103 consumer_sock
->control_sock_sent
= 1;
1104 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1105 consumer_sock
->data_sock_sent
= 1;
1109 * Close socket which was dup on the consumer side. The session daemon does
1110 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1114 if (status
!= LTTNG_OK
) {
1116 * The consumer output for this session should not be used anymore
1117 * since the relayd connection failed thus making any tracing or/and
1118 * streaming not usable.
1120 consumer
->enabled
= 0;
1122 (void) relayd_close(rsock
);
1130 * Send both relayd sockets to a specific consumer and domain. This is a
1131 * helper function to facilitate sending the information to the consumer for a
1134 * The consumer socket lock must be held by the caller.
1136 * Returns LTTNG_OK, or an LTTng error code on failure.
1138 static enum lttng_error_code
send_consumer_relayd_sockets(
1139 enum lttng_domain_type domain
,
1140 unsigned int session_id
, struct consumer_output
*consumer
,
1141 struct consumer_socket
*sock
, const char *session_name
,
1142 const char *hostname
, const char *base_path
, int session_live_timer
,
1143 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1144 bool session_name_contains_creation_time
)
1146 enum lttng_error_code status
= LTTNG_OK
;
1151 /* Sending control relayd socket. */
1152 if (!sock
->control_sock_sent
) {
1153 status
= send_consumer_relayd_socket(session_id
,
1154 &consumer
->dst
.net
.control
, consumer
, sock
,
1155 session_name
, hostname
, base_path
, session_live_timer
,
1156 current_chunk_id
, session_creation_time
,
1157 session_name_contains_creation_time
);
1158 if (status
!= LTTNG_OK
) {
1163 /* Sending data relayd socket. */
1164 if (!sock
->data_sock_sent
) {
1165 status
= send_consumer_relayd_socket(session_id
,
1166 &consumer
->dst
.net
.data
, consumer
, sock
,
1167 session_name
, hostname
, base_path
, session_live_timer
,
1168 current_chunk_id
, session_creation_time
,
1169 session_name_contains_creation_time
);
1170 if (status
!= LTTNG_OK
) {
1180 * Setup relayd connections for a tracing session. First creates the socket to
1181 * the relayd and send them to the right domain consumer. Consumer type MUST be
1184 int cmd_setup_relayd(struct ltt_session
*session
)
1187 struct ltt_ust_session
*usess
;
1188 struct ltt_kernel_session
*ksess
;
1189 struct consumer_socket
*socket
;
1190 struct lttng_ht_iter iter
;
1191 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1195 usess
= session
->ust_session
;
1196 ksess
= session
->kernel_session
;
1198 DBG("Setting relayd for session %s", session
->name
);
1201 if (session
->current_trace_chunk
) {
1202 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1203 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1205 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1206 current_chunk_id
.is_set
= true;
1208 ERR("Failed to get current trace chunk id");
1209 ret
= LTTNG_ERR_UNK
;
1214 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1215 && usess
->consumer
->enabled
) {
1216 /* For each consumer socket, send relayd sockets */
1217 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1218 socket
, node
.node
) {
1219 pthread_mutex_lock(socket
->lock
);
1220 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1221 usess
->consumer
, socket
,
1222 session
->name
, session
->hostname
,
1224 session
->live_timer
,
1225 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1226 session
->creation_time
,
1227 session
->name_contains_creation_time
);
1228 pthread_mutex_unlock(socket
->lock
);
1229 if (ret
!= LTTNG_OK
) {
1232 /* Session is now ready for network streaming. */
1233 session
->net_handle
= 1;
1235 session
->consumer
->relay_major_version
=
1236 usess
->consumer
->relay_major_version
;
1237 session
->consumer
->relay_minor_version
=
1238 usess
->consumer
->relay_minor_version
;
1239 session
->consumer
->relay_allows_clear
=
1240 usess
->consumer
->relay_allows_clear
;
1243 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1244 && ksess
->consumer
->enabled
) {
1245 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1246 socket
, node
.node
) {
1247 pthread_mutex_lock(socket
->lock
);
1248 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1249 ksess
->consumer
, socket
,
1250 session
->name
, session
->hostname
,
1252 session
->live_timer
,
1253 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1254 session
->creation_time
,
1255 session
->name_contains_creation_time
);
1256 pthread_mutex_unlock(socket
->lock
);
1257 if (ret
!= LTTNG_OK
) {
1260 /* Session is now ready for network streaming. */
1261 session
->net_handle
= 1;
1263 session
->consumer
->relay_major_version
=
1264 ksess
->consumer
->relay_major_version
;
1265 session
->consumer
->relay_minor_version
=
1266 ksess
->consumer
->relay_minor_version
;
1267 session
->consumer
->relay_allows_clear
=
1268 ksess
->consumer
->relay_allows_clear
;
1277 * Start a kernel session by opening all necessary streams.
1279 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1282 struct ltt_kernel_channel
*kchan
;
1284 /* Open kernel metadata */
1285 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1286 ret
= kernel_open_metadata(ksess
);
1288 ret
= LTTNG_ERR_KERN_META_FAIL
;
1293 /* Open kernel metadata stream */
1294 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1295 ret
= kernel_open_metadata_stream(ksess
);
1297 ERR("Kernel create metadata stream failed");
1298 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1303 /* For each channel */
1304 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1305 if (kchan
->stream_count
== 0) {
1306 ret
= kernel_open_channel_stream(kchan
);
1308 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1311 /* Update the stream global counter */
1312 ksess
->stream_count_global
+= ret
;
1316 /* Setup kernel consumer socket and send fds to it */
1317 ret
= init_kernel_tracing(ksess
);
1319 ret
= LTTNG_ERR_KERN_START_FAIL
;
1323 /* This start the kernel tracing */
1324 ret
= kernel_start_session(ksess
);
1326 ret
= LTTNG_ERR_KERN_START_FAIL
;
1330 /* Quiescent wait after starting trace */
1331 kernel_wait_quiescent();
1341 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1343 struct ltt_kernel_channel
*kchan
;
1344 bool error_occurred
= false;
1347 if (!ksess
|| !ksess
->active
) {
1350 DBG("Stopping kernel tracing");
1352 ret
= kernel_stop_session(ksess
);
1354 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1358 kernel_wait_quiescent();
1360 /* Flush metadata after stopping (if exists) */
1361 if (ksess
->metadata_stream_fd
>= 0) {
1362 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1364 ERR("Kernel metadata flush failed");
1365 error_occurred
= true;
1369 /* Flush all buffers after stopping */
1370 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1371 ret
= kernel_flush_buffer(kchan
);
1373 ERR("Kernel flush buffer error");
1374 error_occurred
= true;
1379 if (error_occurred
) {
1380 ret
= LTTNG_ERR_UNK
;
1389 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1391 int cmd_disable_channel(struct ltt_session
*session
,
1392 enum lttng_domain_type domain
, char *channel_name
)
1395 struct ltt_ust_session
*usess
;
1397 usess
= session
->ust_session
;
1402 case LTTNG_DOMAIN_KERNEL
:
1404 ret
= channel_kernel_disable(session
->kernel_session
,
1406 if (ret
!= LTTNG_OK
) {
1410 kernel_wait_quiescent();
1413 case LTTNG_DOMAIN_UST
:
1415 struct ltt_ust_channel
*uchan
;
1416 struct lttng_ht
*chan_ht
;
1418 chan_ht
= usess
->domain_global
.channels
;
1420 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1421 if (uchan
== NULL
) {
1422 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1426 ret
= channel_ust_disable(usess
, uchan
);
1427 if (ret
!= LTTNG_OK
) {
1433 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1445 * Command LTTNG_TRACK_ID processed by the client thread.
1447 * Called with session lock held.
1449 int cmd_track_id(struct ltt_session
*session
,
1450 enum lttng_tracker_type tracker_type
,
1451 enum lttng_domain_type domain
,
1452 const struct lttng_tracker_id
*id
)
1459 case LTTNG_DOMAIN_KERNEL
:
1461 struct ltt_kernel_session
*ksess
;
1463 ksess
= session
->kernel_session
;
1465 ret
= kernel_track_id(tracker_type
, ksess
, id
);
1466 if (ret
!= LTTNG_OK
) {
1470 kernel_wait_quiescent();
1473 case LTTNG_DOMAIN_UST
:
1475 struct ltt_ust_session
*usess
;
1477 usess
= session
->ust_session
;
1479 ret
= trace_ust_track_id(tracker_type
, usess
, id
);
1480 if (ret
!= LTTNG_OK
) {
1486 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1498 * Command LTTNG_UNTRACK_ID processed by the client thread.
1500 * Called with session lock held.
1502 int cmd_untrack_id(struct ltt_session
*session
,
1503 enum lttng_tracker_type tracker_type
,
1504 enum lttng_domain_type domain
,
1505 const struct lttng_tracker_id
*id
)
1512 case LTTNG_DOMAIN_KERNEL
:
1514 struct ltt_kernel_session
*ksess
;
1516 ksess
= session
->kernel_session
;
1518 ret
= kernel_untrack_id(tracker_type
, ksess
, id
);
1519 if (ret
!= LTTNG_OK
) {
1523 kernel_wait_quiescent();
1526 case LTTNG_DOMAIN_UST
:
1528 struct ltt_ust_session
*usess
;
1530 usess
= session
->ust_session
;
1532 ret
= trace_ust_untrack_id(tracker_type
, usess
, id
);
1533 if (ret
!= LTTNG_OK
) {
1539 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1551 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1553 * The wpipe arguments is used as a notifier for the kernel thread.
1555 int cmd_enable_channel(struct ltt_session
*session
,
1556 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1559 struct ltt_ust_session
*usess
= session
->ust_session
;
1560 struct lttng_ht
*chan_ht
;
1562 struct lttng_channel attr
;
1569 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1571 /* Validate channel name */
1572 if (attr
.name
[0] == '.' ||
1573 memchr(attr
.name
, '/', len
) != NULL
) {
1574 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1578 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1583 * Don't try to enable a channel if the session has been started at
1584 * some point in time before. The tracer does not allow it.
1586 if (session
->has_been_started
) {
1587 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1592 * If the session is a live session, remove the switch timer, the
1593 * live timer does the same thing but sends also synchronisation
1594 * beacons for inactive streams.
1596 if (session
->live_timer
> 0) {
1597 attr
.attr
.live_timer_interval
= session
->live_timer
;
1598 attr
.attr
.switch_timer_interval
= 0;
1601 /* Check for feature support */
1602 switch (domain
->type
) {
1603 case LTTNG_DOMAIN_KERNEL
:
1605 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1606 /* Sampling position of buffer is not supported */
1607 WARN("Kernel tracer does not support buffer monitoring. "
1608 "Setting the monitor interval timer to 0 "
1609 "(disabled) for channel '%s' of session '%s'",
1610 attr
.name
, session
->name
);
1611 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1615 case LTTNG_DOMAIN_UST
:
1617 case LTTNG_DOMAIN_JUL
:
1618 case LTTNG_DOMAIN_LOG4J
:
1619 case LTTNG_DOMAIN_PYTHON
:
1620 if (!agent_tracing_is_enabled()) {
1621 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1622 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1627 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1631 switch (domain
->type
) {
1632 case LTTNG_DOMAIN_KERNEL
:
1634 struct ltt_kernel_channel
*kchan
;
1636 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1637 session
->kernel_session
);
1638 if (kchan
== NULL
) {
1639 if (session
->snapshot
.nb_output
> 0 ||
1640 session
->snapshot_mode
) {
1641 /* Enforce mmap output for snapshot sessions. */
1642 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1644 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1645 if (attr
.name
[0] != '\0') {
1646 session
->kernel_session
->has_non_default_channel
= 1;
1649 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1652 if (ret
!= LTTNG_OK
) {
1656 kernel_wait_quiescent();
1659 case LTTNG_DOMAIN_UST
:
1660 case LTTNG_DOMAIN_JUL
:
1661 case LTTNG_DOMAIN_LOG4J
:
1662 case LTTNG_DOMAIN_PYTHON
:
1664 struct ltt_ust_channel
*uchan
;
1669 * Current agent implementation limitations force us to allow
1670 * only one channel at once in "agent" subdomains. Each
1671 * subdomain has a default channel name which must be strictly
1674 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1675 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1676 LTTNG_SYMBOL_NAME_LEN
)) {
1677 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1680 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1681 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1682 LTTNG_SYMBOL_NAME_LEN
)) {
1683 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1686 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1687 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1688 LTTNG_SYMBOL_NAME_LEN
)) {
1689 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1694 chan_ht
= usess
->domain_global
.channels
;
1696 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1697 if (uchan
== NULL
) {
1698 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1699 if (attr
.name
[0] != '\0') {
1700 usess
->has_non_default_channel
= 1;
1703 ret
= channel_ust_enable(usess
, uchan
);
1708 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1712 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1713 session
->has_non_mmap_channel
= true;
1722 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1724 int cmd_disable_event(struct ltt_session
*session
,
1725 enum lttng_domain_type domain
, const char *channel_name
,
1726 const struct lttng_event
*event
)
1729 const char *event_name
;
1731 DBG("Disable event command for event \'%s\'", event
->name
);
1733 event_name
= event
->name
;
1735 /* Error out on unhandled search criteria */
1736 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1737 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1738 ret
= LTTNG_ERR_UNK
;
1745 case LTTNG_DOMAIN_KERNEL
:
1747 struct ltt_kernel_channel
*kchan
;
1748 struct ltt_kernel_session
*ksess
;
1750 ksess
= session
->kernel_session
;
1753 * If a non-default channel has been created in the
1754 * session, explicitely require that -c chan_name needs
1757 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1758 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1762 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1763 if (kchan
== NULL
) {
1764 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1768 switch (event
->type
) {
1769 case LTTNG_EVENT_ALL
:
1770 case LTTNG_EVENT_TRACEPOINT
:
1771 case LTTNG_EVENT_SYSCALL
:
1772 case LTTNG_EVENT_PROBE
:
1773 case LTTNG_EVENT_FUNCTION
:
1774 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1775 if (event_name
[0] == '\0') {
1776 ret
= event_kernel_disable_event(kchan
,
1779 ret
= event_kernel_disable_event(kchan
,
1780 event_name
, event
->type
);
1782 if (ret
!= LTTNG_OK
) {
1787 ret
= LTTNG_ERR_UNK
;
1791 kernel_wait_quiescent();
1794 case LTTNG_DOMAIN_UST
:
1796 struct ltt_ust_channel
*uchan
;
1797 struct ltt_ust_session
*usess
;
1799 usess
= session
->ust_session
;
1801 if (validate_ust_event_name(event_name
)) {
1802 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1807 * If a non-default channel has been created in the
1808 * session, explicitly require that -c chan_name needs
1811 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1812 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1816 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1818 if (uchan
== NULL
) {
1819 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1823 switch (event
->type
) {
1824 case LTTNG_EVENT_ALL
:
1826 * An empty event name means that everything
1827 * should be disabled.
1829 if (event
->name
[0] == '\0') {
1830 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1832 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1835 if (ret
!= LTTNG_OK
) {
1840 ret
= LTTNG_ERR_UNK
;
1844 DBG3("Disable UST event %s in channel %s completed", event_name
,
1848 case LTTNG_DOMAIN_LOG4J
:
1849 case LTTNG_DOMAIN_JUL
:
1850 case LTTNG_DOMAIN_PYTHON
:
1853 struct ltt_ust_session
*usess
= session
->ust_session
;
1857 switch (event
->type
) {
1858 case LTTNG_EVENT_ALL
:
1861 ret
= LTTNG_ERR_UNK
;
1865 agt
= trace_ust_find_agent(usess
, domain
);
1867 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1871 * An empty event name means that everything
1872 * should be disabled.
1874 if (event
->name
[0] == '\0') {
1875 ret
= event_agent_disable_all(usess
, agt
);
1877 ret
= event_agent_disable(usess
, agt
, event_name
);
1879 if (ret
!= LTTNG_OK
) {
1886 ret
= LTTNG_ERR_UND
;
1899 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1901 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1902 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1904 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1905 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1908 * Don't try to add a context if the session has been started at
1909 * some point in time before. The tracer does not allow it and would
1910 * result in a corrupted trace.
1912 if (session
->has_been_started
) {
1913 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1917 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1918 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1919 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1923 case LTTNG_DOMAIN_KERNEL
:
1924 assert(session
->kernel_session
);
1926 if (session
->kernel_session
->channel_count
== 0) {
1927 /* Create default channel */
1928 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1929 if (ret
!= LTTNG_OK
) {
1932 chan_kern_created
= 1;
1934 /* Add kernel context to kernel tracer */
1935 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1936 if (ret
!= LTTNG_OK
) {
1940 case LTTNG_DOMAIN_JUL
:
1941 case LTTNG_DOMAIN_LOG4J
:
1944 * Validate channel name.
1945 * If no channel name is given and the domain is JUL or LOG4J,
1946 * set it to the appropriate domain-specific channel name. If
1947 * a name is provided but does not match the expexted channel
1948 * name, return an error.
1950 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1951 strcmp(channel_name
,
1952 DEFAULT_JUL_CHANNEL_NAME
)) {
1953 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1955 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1956 strcmp(channel_name
,
1957 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1958 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1961 /* break is _not_ missing here. */
1963 case LTTNG_DOMAIN_UST
:
1965 struct ltt_ust_session
*usess
= session
->ust_session
;
1966 unsigned int chan_count
;
1970 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1971 if (chan_count
== 0) {
1972 struct lttng_channel
*attr
;
1973 /* Create default channel */
1974 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1976 ret
= LTTNG_ERR_FATAL
;
1980 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1981 if (ret
!= LTTNG_OK
) {
1985 channel_attr_destroy(attr
);
1986 chan_ust_created
= 1;
1989 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1990 free(app_ctx_provider_name
);
1992 app_ctx_name
= NULL
;
1993 app_ctx_provider_name
= NULL
;
1994 if (ret
!= LTTNG_OK
) {
2000 ret
= LTTNG_ERR_UND
;
2008 if (chan_kern_created
) {
2009 struct ltt_kernel_channel
*kchan
=
2010 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2011 session
->kernel_session
);
2012 /* Created previously, this should NOT fail. */
2014 kernel_destroy_channel(kchan
);
2017 if (chan_ust_created
) {
2018 struct ltt_ust_channel
*uchan
=
2019 trace_ust_find_channel_by_name(
2020 session
->ust_session
->domain_global
.channels
,
2021 DEFAULT_CHANNEL_NAME
);
2022 /* Created previously, this should NOT fail. */
2024 /* Remove from the channel list of the session. */
2025 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2027 trace_ust_destroy_channel(uchan
);
2030 free(app_ctx_provider_name
);
2035 static inline bool name_starts_with(const char *name
, const char *prefix
)
2037 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2039 return !strncmp(name
, prefix
, max_cmp_len
);
2042 /* Perform userspace-specific event name validation */
2043 static int validate_ust_event_name(const char *name
)
2053 * Check name against all internal UST event component namespaces used
2056 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2057 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2058 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2067 * Internal version of cmd_enable_event() with a supplemental
2068 * "internal_event" flag which is used to enable internal events which should
2069 * be hidden from clients. Such events are used in the agent implementation to
2070 * enable the events through which all "agent" events are funeled.
2072 static int _cmd_enable_event(struct ltt_session
*session
,
2073 const struct lttng_domain
*domain
,
2074 char *channel_name
, struct lttng_event
*event
,
2075 char *filter_expression
,
2076 struct lttng_filter_bytecode
*filter
,
2077 struct lttng_event_exclusion
*exclusion
,
2078 int wpipe
, bool internal_event
)
2080 int ret
= 0, channel_created
= 0;
2081 struct lttng_channel
*attr
= NULL
;
2085 assert(channel_name
);
2087 /* If we have a filter, we must have its filter expression */
2088 assert(!(!!filter_expression
^ !!filter
));
2090 /* Normalize event name as a globbing pattern */
2091 strutils_normalize_star_glob_pattern(event
->name
);
2093 /* Normalize exclusion names as globbing patterns */
2097 for (i
= 0; i
< exclusion
->count
; i
++) {
2098 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2100 strutils_normalize_star_glob_pattern(name
);
2104 DBG("Enable event command for event \'%s\'", event
->name
);
2108 switch (domain
->type
) {
2109 case LTTNG_DOMAIN_KERNEL
:
2111 struct ltt_kernel_channel
*kchan
;
2114 * If a non-default channel has been created in the
2115 * session, explicitely require that -c chan_name needs
2118 if (session
->kernel_session
->has_non_default_channel
2119 && channel_name
[0] == '\0') {
2120 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2124 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2125 session
->kernel_session
);
2126 if (kchan
== NULL
) {
2127 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2128 LTTNG_BUFFER_GLOBAL
);
2130 ret
= LTTNG_ERR_FATAL
;
2133 if (lttng_strncpy(attr
->name
, channel_name
,
2134 sizeof(attr
->name
))) {
2135 ret
= LTTNG_ERR_INVALID
;
2139 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2140 if (ret
!= LTTNG_OK
) {
2143 channel_created
= 1;
2146 /* Get the newly created kernel channel pointer */
2147 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2148 session
->kernel_session
);
2149 if (kchan
== NULL
) {
2150 /* This sould not happen... */
2151 ret
= LTTNG_ERR_FATAL
;
2155 switch (event
->type
) {
2156 case LTTNG_EVENT_ALL
:
2158 char *filter_expression_a
= NULL
;
2159 struct lttng_filter_bytecode
*filter_a
= NULL
;
2162 * We need to duplicate filter_expression and filter,
2163 * because ownership is passed to first enable
2166 if (filter_expression
) {
2167 filter_expression_a
= strdup(filter_expression
);
2168 if (!filter_expression_a
) {
2169 ret
= LTTNG_ERR_FATAL
;
2174 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2176 free(filter_expression_a
);
2177 ret
= LTTNG_ERR_FATAL
;
2180 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2182 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2183 ret
= event_kernel_enable_event(kchan
, event
,
2184 filter_expression
, filter
);
2185 /* We have passed ownership */
2186 filter_expression
= NULL
;
2188 if (ret
!= LTTNG_OK
) {
2189 if (channel_created
) {
2190 /* Let's not leak a useless channel. */
2191 kernel_destroy_channel(kchan
);
2193 free(filter_expression_a
);
2197 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2198 ret
= event_kernel_enable_event(kchan
, event
,
2199 filter_expression_a
, filter_a
);
2200 /* We have passed ownership */
2201 filter_expression_a
= NULL
;
2203 if (ret
!= LTTNG_OK
) {
2208 case LTTNG_EVENT_PROBE
:
2209 case LTTNG_EVENT_USERSPACE_PROBE
:
2210 case LTTNG_EVENT_FUNCTION
:
2211 case LTTNG_EVENT_FUNCTION_ENTRY
:
2212 case LTTNG_EVENT_TRACEPOINT
:
2213 ret
= event_kernel_enable_event(kchan
, event
,
2214 filter_expression
, filter
);
2215 /* We have passed ownership */
2216 filter_expression
= NULL
;
2218 if (ret
!= LTTNG_OK
) {
2219 if (channel_created
) {
2220 /* Let's not leak a useless channel. */
2221 kernel_destroy_channel(kchan
);
2226 case LTTNG_EVENT_SYSCALL
:
2227 ret
= event_kernel_enable_event(kchan
, event
,
2228 filter_expression
, filter
);
2229 /* We have passed ownership */
2230 filter_expression
= NULL
;
2232 if (ret
!= LTTNG_OK
) {
2237 ret
= LTTNG_ERR_UNK
;
2241 kernel_wait_quiescent();
2244 case LTTNG_DOMAIN_UST
:
2246 struct ltt_ust_channel
*uchan
;
2247 struct ltt_ust_session
*usess
= session
->ust_session
;
2252 * If a non-default channel has been created in the
2253 * session, explicitely require that -c chan_name needs
2256 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2257 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2261 /* Get channel from global UST domain */
2262 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2264 if (uchan
== NULL
) {
2265 /* Create default channel */
2266 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2267 usess
->buffer_type
);
2269 ret
= LTTNG_ERR_FATAL
;
2272 if (lttng_strncpy(attr
->name
, channel_name
,
2273 sizeof(attr
->name
))) {
2274 ret
= LTTNG_ERR_INVALID
;
2278 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2279 if (ret
!= LTTNG_OK
) {
2283 /* Get the newly created channel reference back */
2284 uchan
= trace_ust_find_channel_by_name(
2285 usess
->domain_global
.channels
, channel_name
);
2289 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2291 * Don't allow users to add UST events to channels which
2292 * are assigned to a userspace subdomain (JUL, Log4J,
2295 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2299 if (!internal_event
) {
2301 * Ensure the event name is not reserved for internal
2304 ret
= validate_ust_event_name(event
->name
);
2306 WARN("Userspace event name %s failed validation.",
2308 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2313 /* At this point, the session and channel exist on the tracer */
2314 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2315 filter_expression
, filter
, exclusion
,
2317 /* We have passed ownership */
2318 filter_expression
= NULL
;
2321 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2322 goto already_enabled
;
2323 } else if (ret
!= LTTNG_OK
) {
2328 case LTTNG_DOMAIN_LOG4J
:
2329 case LTTNG_DOMAIN_JUL
:
2330 case LTTNG_DOMAIN_PYTHON
:
2332 const char *default_event_name
, *default_chan_name
;
2334 struct lttng_event uevent
;
2335 struct lttng_domain tmp_dom
;
2336 struct ltt_ust_session
*usess
= session
->ust_session
;
2340 if (!agent_tracing_is_enabled()) {
2341 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2342 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2346 agt
= trace_ust_find_agent(usess
, domain
->type
);
2348 agt
= agent_create(domain
->type
);
2350 ret
= LTTNG_ERR_NOMEM
;
2353 agent_add(agt
, usess
->agents
);
2356 /* Create the default tracepoint. */
2357 memset(&uevent
, 0, sizeof(uevent
));
2358 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2359 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2360 default_event_name
= event_get_default_agent_ust_name(
2362 if (!default_event_name
) {
2363 ret
= LTTNG_ERR_FATAL
;
2366 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2367 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2370 * The domain type is changed because we are about to enable the
2371 * default channel and event for the JUL domain that are hardcoded.
2372 * This happens in the UST domain.
2374 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2375 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2377 switch (domain
->type
) {
2378 case LTTNG_DOMAIN_LOG4J
:
2379 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2381 case LTTNG_DOMAIN_JUL
:
2382 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2384 case LTTNG_DOMAIN_PYTHON
:
2385 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2388 /* The switch/case we are in makes this impossible */
2393 char *filter_expression_copy
= NULL
;
2394 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2397 const size_t filter_size
= sizeof(
2398 struct lttng_filter_bytecode
)
2401 filter_copy
= zmalloc(filter_size
);
2403 ret
= LTTNG_ERR_NOMEM
;
2406 memcpy(filter_copy
, filter
, filter_size
);
2408 filter_expression_copy
=
2409 strdup(filter_expression
);
2410 if (!filter_expression
) {
2411 ret
= LTTNG_ERR_NOMEM
;
2414 if (!filter_expression_copy
|| !filter_copy
) {
2415 free(filter_expression_copy
);
2421 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2422 (char *) default_chan_name
,
2423 &uevent
, filter_expression_copy
,
2424 filter_copy
, NULL
, wpipe
);
2427 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2428 goto already_enabled
;
2429 } else if (ret
!= LTTNG_OK
) {
2433 /* The wild card * means that everything should be enabled. */
2434 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2435 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2438 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2442 filter_expression
= NULL
;
2443 if (ret
!= LTTNG_OK
) {
2450 ret
= LTTNG_ERR_UND
;
2458 free(filter_expression
);
2461 channel_attr_destroy(attr
);
2467 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2468 * We own filter, exclusion, and filter_expression.
2470 int cmd_enable_event(struct ltt_session
*session
,
2471 const struct lttng_domain
*domain
,
2472 char *channel_name
, struct lttng_event
*event
,
2473 char *filter_expression
,
2474 struct lttng_filter_bytecode
*filter
,
2475 struct lttng_event_exclusion
*exclusion
,
2478 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2479 filter_expression
, filter
, exclusion
, wpipe
, false);
2483 * Enable an event which is internal to LTTng. An internal should
2484 * never be made visible to clients and are immune to checks such as
2487 static int cmd_enable_event_internal(struct ltt_session
*session
,
2488 const struct lttng_domain
*domain
,
2489 char *channel_name
, struct lttng_event
*event
,
2490 char *filter_expression
,
2491 struct lttng_filter_bytecode
*filter
,
2492 struct lttng_event_exclusion
*exclusion
,
2495 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2496 filter_expression
, filter
, exclusion
, wpipe
, true);
2500 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2502 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2503 struct lttng_event
**events
)
2506 ssize_t nb_events
= 0;
2509 case LTTNG_DOMAIN_KERNEL
:
2510 nb_events
= kernel_list_events(events
);
2511 if (nb_events
< 0) {
2512 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2516 case LTTNG_DOMAIN_UST
:
2517 nb_events
= ust_app_list_events(events
);
2518 if (nb_events
< 0) {
2519 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2523 case LTTNG_DOMAIN_LOG4J
:
2524 case LTTNG_DOMAIN_JUL
:
2525 case LTTNG_DOMAIN_PYTHON
:
2526 nb_events
= agent_list_events(events
, domain
);
2527 if (nb_events
< 0) {
2528 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2533 ret
= LTTNG_ERR_UND
;
2540 /* Return negative value to differentiate return code */
2545 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2547 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2548 struct lttng_event_field
**fields
)
2551 ssize_t nb_fields
= 0;
2554 case LTTNG_DOMAIN_UST
:
2555 nb_fields
= ust_app_list_event_fields(fields
);
2556 if (nb_fields
< 0) {
2557 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2561 case LTTNG_DOMAIN_KERNEL
:
2562 default: /* fall-through */
2563 ret
= LTTNG_ERR_UND
;
2570 /* Return negative value to differentiate return code */
2574 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2576 return syscall_table_list(events
);
2580 * Command LTTNG_LIST_TRACKER_IDS processed by the client thread.
2582 * Called with session lock held.
2584 ssize_t
cmd_list_tracker_ids(enum lttng_tracker_type tracker_type
,
2585 struct ltt_session
*session
,
2586 enum lttng_domain_type domain
,
2587 struct lttng_tracker_id
**ids
)
2590 ssize_t nr_pids
= 0;
2593 case LTTNG_DOMAIN_KERNEL
:
2595 struct ltt_kernel_session
*ksess
;
2597 ksess
= session
->kernel_session
;
2598 nr_pids
= kernel_list_tracker_ids(tracker_type
, ksess
, ids
);
2600 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2605 case LTTNG_DOMAIN_UST
:
2607 struct ltt_ust_session
*usess
;
2609 usess
= session
->ust_session
;
2610 nr_pids
= trace_ust_list_tracker_ids(tracker_type
, usess
, ids
);
2612 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2617 case LTTNG_DOMAIN_LOG4J
:
2618 case LTTNG_DOMAIN_JUL
:
2619 case LTTNG_DOMAIN_PYTHON
:
2621 ret
= LTTNG_ERR_UND
;
2628 /* Return negative value to differentiate return code */
2633 * Command LTTNG_START_TRACE processed by the client thread.
2635 * Called with session mutex held.
2637 int cmd_start_trace(struct ltt_session
*session
)
2639 enum lttng_error_code ret
;
2640 unsigned long nb_chan
= 0;
2641 struct ltt_kernel_session
*ksession
;
2642 struct ltt_ust_session
*usess
;
2643 const bool session_rotated_after_last_stop
=
2644 session
->rotated_after_last_stop
;
2645 const bool session_cleared_after_last_stop
=
2646 session
->cleared_after_last_stop
;
2650 /* Ease our life a bit ;) */
2651 ksession
= session
->kernel_session
;
2652 usess
= session
->ust_session
;
2654 /* Is the session already started? */
2655 if (session
->active
) {
2656 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2660 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2661 !session
->current_trace_chunk
) {
2663 * A rotation was launched while the session was stopped and
2664 * it has not been completed yet. It is not possible to start
2665 * the session since starting the session here would require a
2666 * rotation from "NULL" to a new trace chunk. That rotation
2667 * would overlap with the ongoing rotation, which is not
2670 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2672 ret
= LTTNG_ERR_ROTATION_PENDING
;
2677 * Starting a session without channel is useless since after that it's not
2678 * possible to enable channel thus inform the client.
2680 if (usess
&& usess
->domain_global
.channels
) {
2681 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2684 nb_chan
+= ksession
->channel_count
;
2687 ret
= LTTNG_ERR_NO_CHANNEL
;
2691 session
->active
= 1;
2692 session
->rotated_after_last_stop
= false;
2693 session
->cleared_after_last_stop
= false;
2694 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2695 if (!session
->has_been_started
) {
2696 struct lttng_trace_chunk
*trace_chunk
;
2698 DBG("Creating initial trace chunk of session \"%s\"",
2700 trace_chunk
= session_create_new_trace_chunk(
2701 session
, NULL
, NULL
, NULL
);
2703 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2706 assert(!session
->current_trace_chunk
);
2707 ret
= session_set_trace_chunk(session
, trace_chunk
,
2709 lttng_trace_chunk_put(trace_chunk
);
2711 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2715 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2718 * Rotate existing streams into the new chunk.
2719 * This is a "quiet" rotation has no client has
2720 * explicitly requested this operation.
2722 * There is also no need to wait for the rotation
2723 * to complete as it will happen immediately. No data
2724 * was produced as the session was stopped, so the
2725 * rotation should happen on reception of the command.
2727 ret
= cmd_rotate_session(session
, NULL
, true,
2728 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2729 if (ret
!= LTTNG_OK
) {
2735 /* Kernel tracing */
2736 if (ksession
!= NULL
) {
2737 DBG("Start kernel tracing session %s", session
->name
);
2738 ret
= start_kernel_session(ksession
);
2739 if (ret
!= LTTNG_OK
) {
2744 /* Flag session that trace should start automatically */
2746 int int_ret
= ust_app_start_trace_all(usess
);
2749 ret
= LTTNG_ERR_UST_START_FAIL
;
2755 * Clear the flag that indicates that a rotation was done while the
2756 * session was stopped.
2758 session
->rotated_after_last_stop
= false;
2760 if (session
->rotate_timer_period
) {
2761 int int_ret
= timer_session_rotation_schedule_timer_start(
2762 session
, session
->rotate_timer_period
);
2765 ERR("Failed to enable rotate timer");
2766 ret
= LTTNG_ERR_UNK
;
2774 if (ret
== LTTNG_OK
) {
2775 /* Flag this after a successful start. */
2776 session
->has_been_started
|= 1;
2778 session
->active
= 0;
2779 /* Restore initial state on error. */
2780 session
->rotated_after_last_stop
=
2781 session_rotated_after_last_stop
;
2782 session
->cleared_after_last_stop
=
2783 session_cleared_after_last_stop
;
2789 * Command LTTNG_STOP_TRACE processed by the client thread.
2791 int cmd_stop_trace(struct ltt_session
*session
)
2794 struct ltt_kernel_session
*ksession
;
2795 struct ltt_ust_session
*usess
;
2799 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2801 ksession
= session
->kernel_session
;
2802 usess
= session
->ust_session
;
2804 /* Session is not active. Skip everythong and inform the client. */
2805 if (!session
->active
) {
2806 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2810 ret
= stop_kernel_session(ksession
);
2811 if (ret
!= LTTNG_OK
) {
2815 if (usess
&& usess
->active
) {
2816 ret
= ust_app_stop_trace_all(usess
);
2818 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2823 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2825 /* Flag inactive after a successful stop. */
2826 session
->active
= 0;
2834 * Set the base_path of the session only if subdir of a control uris is set.
2835 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2837 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2839 struct lttng_uri
*uris
)
2844 for (i
= 0; i
< nb_uri
; i
++) {
2845 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2846 uris
[i
].subdir
[0] == '\0') {
2847 /* Not interested in these URIs */
2851 if (session
->base_path
!= NULL
) {
2852 free(session
->base_path
);
2853 session
->base_path
= NULL
;
2856 /* Set session base_path */
2857 session
->base_path
= strdup(uris
[i
].subdir
);
2858 if (!session
->base_path
) {
2859 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2860 uris
[i
].subdir
, session
->name
);
2861 ret
= LTTNG_ERR_NOMEM
;
2864 DBG2("Setting base path \"%s\" for session \"%s\"",
2865 session
->base_path
, session
->name
);
2873 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2875 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2876 struct lttng_uri
*uris
)
2879 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2880 struct ltt_ust_session
*usess
= session
->ust_session
;
2886 /* Can't set consumer URI if the session is active. */
2887 if (session
->active
) {
2888 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2893 * Set the session base path if any. This is done inside
2894 * cmd_set_consumer_uri to preserve backward compatibility of the
2895 * previous session creation api vs the session descriptor api.
2897 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2898 if (ret
!= LTTNG_OK
) {
2902 /* Set the "global" consumer URIs */
2903 for (i
= 0; i
< nb_uri
; i
++) {
2904 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2906 if (ret
!= LTTNG_OK
) {
2911 /* Set UST session URIs */
2912 if (session
->ust_session
) {
2913 for (i
= 0; i
< nb_uri
; i
++) {
2914 ret
= add_uri_to_consumer(session
,
2915 session
->ust_session
->consumer
,
2916 &uris
[i
], LTTNG_DOMAIN_UST
);
2917 if (ret
!= LTTNG_OK
) {
2923 /* Set kernel session URIs */
2924 if (session
->kernel_session
) {
2925 for (i
= 0; i
< nb_uri
; i
++) {
2926 ret
= add_uri_to_consumer(session
,
2927 session
->kernel_session
->consumer
,
2928 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2929 if (ret
!= LTTNG_OK
) {
2936 * Make sure to set the session in output mode after we set URI since a
2937 * session can be created without URL (thus flagged in no output mode).
2939 session
->output_traces
= 1;
2941 ksess
->output_traces
= 1;
2945 usess
->output_traces
= 1;
2956 enum lttng_error_code
set_session_output_from_descriptor(
2957 struct ltt_session
*session
,
2958 const struct lttng_session_descriptor
*descriptor
)
2961 enum lttng_error_code ret_code
= LTTNG_OK
;
2962 enum lttng_session_descriptor_type session_type
=
2963 lttng_session_descriptor_get_type(descriptor
);
2964 enum lttng_session_descriptor_output_type output_type
=
2965 lttng_session_descriptor_get_output_type(descriptor
);
2966 struct lttng_uri uris
[2] = {};
2967 size_t uri_count
= 0;
2969 switch (output_type
) {
2970 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2972 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2973 lttng_session_descriptor_get_local_output_uri(descriptor
,
2977 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2978 lttng_session_descriptor_get_network_output_uris(descriptor
,
2979 &uris
[0], &uris
[1]);
2983 ret_code
= LTTNG_ERR_INVALID
;
2987 switch (session_type
) {
2988 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2990 struct snapshot_output
*new_output
= NULL
;
2992 new_output
= snapshot_output_alloc();
2994 ret_code
= LTTNG_ERR_NOMEM
;
2998 ret
= snapshot_output_init_with_uri(session
,
2999 DEFAULT_SNAPSHOT_MAX_SIZE
,
3000 NULL
, uris
, uri_count
, session
->consumer
,
3001 new_output
, &session
->snapshot
);
3003 ret_code
= (ret
== -ENOMEM
) ?
3004 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3005 snapshot_output_destroy(new_output
);
3008 snapshot_add_output(&session
->snapshot
, new_output
);
3011 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3012 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3014 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3018 ret_code
= LTTNG_ERR_INVALID
;
3026 enum lttng_error_code
cmd_create_session_from_descriptor(
3027 struct lttng_session_descriptor
*descriptor
,
3028 const lttng_sock_cred
*creds
,
3029 const char *home_path
)
3032 enum lttng_error_code ret_code
;
3033 const char *session_name
;
3034 struct ltt_session
*new_session
= NULL
;
3035 enum lttng_session_descriptor_status descriptor_status
;
3037 session_lock_list();
3039 if (*home_path
!= '/') {
3040 ERR("Home path provided by client is not absolute");
3041 ret_code
= LTTNG_ERR_INVALID
;
3046 descriptor_status
= lttng_session_descriptor_get_session_name(
3047 descriptor
, &session_name
);
3048 switch (descriptor_status
) {
3049 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3051 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3052 session_name
= NULL
;
3055 ret_code
= LTTNG_ERR_INVALID
;
3059 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3061 if (ret_code
!= LTTNG_OK
) {
3065 if (!session_name
) {
3066 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3069 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3074 if (!lttng_session_descriptor_is_output_destination_initialized(
3077 * Only include the session's creation time in the output
3078 * destination if the name of the session itself was
3079 * not auto-generated.
3081 ret_code
= lttng_session_descriptor_set_default_output(
3083 session_name
? &new_session
->creation_time
: NULL
,
3085 if (ret_code
!= LTTNG_OK
) {
3089 new_session
->has_user_specified_directory
=
3090 lttng_session_descriptor_has_output_directory(
3094 switch (lttng_session_descriptor_get_type(descriptor
)) {
3095 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3096 new_session
->snapshot_mode
= 1;
3098 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3099 new_session
->live_timer
=
3100 lttng_session_descriptor_live_get_timer_interval(
3107 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3108 if (ret_code
!= LTTNG_OK
) {
3111 new_session
->consumer
->enabled
= 1;
3112 ret_code
= LTTNG_OK
;
3114 /* Release reference provided by the session_create function. */
3115 session_put(new_session
);
3116 if (ret_code
!= LTTNG_OK
&& new_session
) {
3117 /* Release the global reference on error. */
3118 session_destroy(new_session
);
3120 session_unlock_list();
3124 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3125 struct lttng_session_descriptor
**return_descriptor
)
3128 size_t payload_size
;
3129 struct lttng_dynamic_buffer payload
;
3130 struct lttng_buffer_view home_dir_view
;
3131 struct lttng_buffer_view session_descriptor_view
;
3132 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3133 enum lttng_error_code ret_code
;
3135 lttng_dynamic_buffer_init(&payload
);
3136 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3138 ret_code
= LTTNG_ERR_INVALID
;
3141 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3142 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3143 ret_code
= LTTNG_ERR_INVALID
;
3147 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3148 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3149 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3151 ret_code
= LTTNG_ERR_NOMEM
;
3155 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3157 ERR("Reception of session descriptor failed, aborting.");
3158 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3162 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3165 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3166 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3168 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3169 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3171 ret
= lttng_session_descriptor_create_from_buffer(
3172 &session_descriptor_view
, &session_descriptor
);
3174 ERR("Failed to create session descriptor from payload of \"create session\" command");
3175 ret_code
= LTTNG_ERR_INVALID
;
3180 * Sets the descriptor's auto-generated properties (name, output) if
3183 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3185 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3186 if (ret_code
!= LTTNG_OK
) {
3190 ret_code
= LTTNG_OK
;
3191 *return_descriptor
= session_descriptor
;
3192 session_descriptor
= NULL
;
3194 lttng_dynamic_buffer_reset(&payload
);
3195 lttng_session_descriptor_destroy(session_descriptor
);
3200 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3201 void *_reply_context
)
3205 const struct cmd_destroy_session_reply_context
*reply_context
=
3207 struct lttng_dynamic_buffer payload
;
3208 struct lttcomm_session_destroy_command_header cmd_header
;
3209 struct lttng_trace_archive_location
*location
= NULL
;
3210 struct lttcomm_lttng_msg llm
= {
3211 .cmd_type
= LTTNG_DESTROY_SESSION
,
3212 .ret_code
= reply_context
->destruction_status
,
3215 sizeof(struct lttcomm_session_destroy_command_header
),
3218 size_t payload_size_before_location
;
3220 lttng_dynamic_buffer_init(&payload
);
3222 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3224 ERR("Failed to append session destruction message");
3228 cmd_header
.rotation_state
=
3229 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3230 session
->rotation_state
:
3231 LTTNG_ROTATION_STATE_NO_ROTATION
);
3232 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3233 sizeof(cmd_header
));
3235 ERR("Failed to append session destruction command header");
3239 if (!reply_context
->implicit_rotation_on_destroy
) {
3240 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3244 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3245 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3250 location
= session_get_trace_archive_location(session
);
3252 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3257 payload_size_before_location
= payload
.size
;
3258 comm_ret
= lttng_trace_archive_location_serialize(location
,
3261 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3265 /* Update the message to indicate the location's length. */
3266 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3267 payload
.size
- payload_size_before_location
;
3269 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3270 payload
.data
, payload
.size
);
3271 if (comm_ret
!= (ssize_t
) payload
.size
) {
3272 ERR("Failed to send result of the destruction of session \"%s\" to client",
3276 ret
= close(reply_context
->reply_sock_fd
);
3278 PERROR("Failed to close client socket in deferred session destroy reply");
3280 lttng_dynamic_buffer_reset(&payload
);
3281 free(_reply_context
);
3285 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3287 * Called with session lock held.
3289 int cmd_destroy_session(struct ltt_session
*session
,
3290 struct notification_thread_handle
*notification_thread_handle
,
3294 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3295 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3298 reply_context
= zmalloc(sizeof(*reply_context
));
3299 if (!reply_context
) {
3300 ret
= LTTNG_ERR_NOMEM
;
3303 reply_context
->reply_sock_fd
= *sock_fd
;
3309 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3311 if (session
->active
) {
3312 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3314 ret
= cmd_stop_trace(session
);
3315 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3316 /* Carry on with the destruction of the session. */
3317 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3318 session
->name
, lttng_strerror(-ret
));
3319 destruction_last_error
= ret
;
3323 if (session
->rotation_schedule_timer_enabled
) {
3324 if (timer_session_rotation_schedule_timer_stop(
3326 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3328 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3332 if (session
->rotate_size
) {
3333 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3334 session
->rotate_size
= 0;
3337 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3339 * Perform a last rotation on destruction if rotations have
3340 * occurred during the session's lifetime.
3342 ret
= cmd_rotate_session(session
, NULL
, false,
3343 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3344 if (ret
!= LTTNG_OK
) {
3345 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3346 session
->name
, lttng_strerror(-ret
));
3347 destruction_last_error
= -ret
;
3349 if (reply_context
) {
3350 reply_context
->implicit_rotation_on_destroy
= true;
3352 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3354 * The user has not triggered a session rotation. However, to
3355 * ensure all data has been consumed, the session is rotated
3356 * to a 'null' trace chunk before it is destroyed.
3358 * This is a "quiet" rotation meaning that no notification is
3359 * emitted and no renaming of the current trace chunk takes
3362 ret
= cmd_rotate_session(session
, NULL
, true,
3363 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3364 if (ret
!= LTTNG_OK
) {
3365 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3366 session
->name
, lttng_strerror(-ret
));
3367 destruction_last_error
= -ret
;
3371 if (session
->shm_path
[0]) {
3373 * When a session is created with an explicit shm_path,
3374 * the consumer daemon will create its shared memory files
3375 * at that location and will *not* unlink them. This is normal
3376 * as the intention of that feature is to make it possible
3377 * to retrieve the content of those files should a crash occur.
3379 * To ensure the content of those files can be used, the
3380 * sessiond daemon will replicate the content of the metadata
3381 * cache in a metadata file.
3383 * On clean-up, it is expected that the consumer daemon will
3384 * unlink the shared memory files and that the session daemon
3385 * will unlink the metadata file. Then, the session's directory
3386 * in the shm path can be removed.
3388 * Unfortunately, a flaw in the design of the sessiond's and
3389 * consumerd's tear down of channels makes it impossible to
3390 * determine when the sessiond _and_ the consumerd have both
3391 * destroyed their representation of a channel. For one, the
3392 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3393 * callbacks in both daemons.
3395 * However, it is also impossible for the sessiond to know when
3396 * the consumer daemon is done destroying its channel(s) since
3397 * it occurs as a reaction to the closing of the channel's file
3398 * descriptor. There is no resulting communication initiated
3399 * from the consumerd to the sessiond to confirm that the
3400 * operation is completed (and was successful).
3402 * Until this is all fixed, the session daemon checks for the
3403 * removal of the session's shm path which makes it possible
3404 * to safely advertise a session as having been destroyed.
3406 * Prior to this fix, it was not possible to reliably save
3407 * a session making use of the --shm-path option, destroy it,
3408 * and load it again. This is because the creation of the
3409 * session would fail upon seeing the session's shm path
3410 * already in existence.
3412 * Note that none of the error paths in the check for the
3413 * directory's existence return an error. This is normal
3414 * as there isn't much that can be done. The session will
3415 * be destroyed properly, except that we can't offer the
3416 * guarantee that the same session can be re-created.
3418 current_completion_handler
= &destroy_completion_handler
.handler
;
3419 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3421 sizeof(destroy_completion_handler
.shm_path
));
3426 * The session is destroyed. However, note that the command context
3427 * still holds a reference to the session, thus delaying its destruction
3428 * _at least_ up to the point when that reference is released.
3430 session_destroy(session
);
3431 if (reply_context
) {
3432 reply_context
->destruction_status
= destruction_last_error
;
3433 ret
= session_add_destroy_notifier(session
,
3434 cmd_destroy_session_reply
,
3435 (void *) reply_context
);
3437 ret
= LTTNG_ERR_FATAL
;
3449 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3451 int cmd_register_consumer(struct ltt_session
*session
,
3452 enum lttng_domain_type domain
, const char *sock_path
,
3453 struct consumer_data
*cdata
)
3456 struct consumer_socket
*socket
= NULL
;
3463 case LTTNG_DOMAIN_KERNEL
:
3465 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3469 /* Can't register a consumer if there is already one */
3470 if (ksess
->consumer_fds_sent
!= 0) {
3471 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3475 sock
= lttcomm_connect_unix_sock(sock_path
);
3477 ret
= LTTNG_ERR_CONNECT_FAIL
;
3480 cdata
->cmd_sock
= sock
;
3482 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3483 if (socket
== NULL
) {
3486 PERROR("close register consumer");
3488 cdata
->cmd_sock
= -1;
3489 ret
= LTTNG_ERR_FATAL
;
3493 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3494 if (socket
->lock
== NULL
) {
3495 PERROR("zmalloc pthread mutex");
3496 ret
= LTTNG_ERR_FATAL
;
3499 pthread_mutex_init(socket
->lock
, NULL
);
3500 socket
->registered
= 1;
3503 consumer_add_socket(socket
, ksess
->consumer
);
3506 pthread_mutex_lock(&cdata
->pid_mutex
);
3508 pthread_mutex_unlock(&cdata
->pid_mutex
);
3513 /* TODO: Userspace tracing */
3514 ret
= LTTNG_ERR_UND
;
3522 consumer_destroy_socket(socket
);
3528 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3530 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3531 struct lttng_domain
**domains
)
3536 struct lttng_ht_iter iter
;
3538 if (session
->kernel_session
!= NULL
) {
3539 DBG3("Listing domains found kernel domain");
3543 if (session
->ust_session
!= NULL
) {
3544 DBG3("Listing domains found UST global domain");
3548 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3550 if (agt
->being_used
) {
3561 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3562 if (*domains
== NULL
) {
3563 ret
= LTTNG_ERR_FATAL
;
3567 if (session
->kernel_session
!= NULL
) {
3568 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3570 /* Kernel session buffer type is always GLOBAL */
3571 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3576 if (session
->ust_session
!= NULL
) {
3577 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3578 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3582 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3584 if (agt
->being_used
) {
3585 (*domains
)[index
].type
= agt
->domain
;
3586 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3596 /* Return negative value to differentiate return code */
3602 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3604 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3605 struct ltt_session
*session
, struct lttng_channel
**channels
)
3607 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3610 case LTTNG_DOMAIN_KERNEL
:
3611 if (session
->kernel_session
!= NULL
) {
3612 nb_chan
= session
->kernel_session
->channel_count
;
3614 DBG3("Number of kernel channels %zd", nb_chan
);
3616 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3620 case LTTNG_DOMAIN_UST
:
3621 if (session
->ust_session
!= NULL
) {
3623 nb_chan
= lttng_ht_get_count(
3624 session
->ust_session
->domain_global
.channels
);
3627 DBG3("Number of UST global channels %zd", nb_chan
);
3629 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3634 ret
= -LTTNG_ERR_UND
;
3639 const size_t channel_size
= sizeof(struct lttng_channel
) +
3640 sizeof(struct lttng_channel_extended
);
3641 struct lttng_channel_extended
*channel_exts
;
3643 payload_size
= nb_chan
* channel_size
;
3644 *channels
= zmalloc(payload_size
);
3645 if (*channels
== NULL
) {
3646 ret
= -LTTNG_ERR_FATAL
;
3650 channel_exts
= ((void *) *channels
) +
3651 (nb_chan
* sizeof(struct lttng_channel
));
3652 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3653 if (ret
!= LTTNG_OK
) {
3668 * Command LTTNG_LIST_EVENTS processed by the client thread.
3670 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3671 struct ltt_session
*session
, char *channel_name
,
3672 struct lttng_event
**events
, size_t *total_size
)
3675 ssize_t nb_event
= 0;
3678 case LTTNG_DOMAIN_KERNEL
:
3679 if (session
->kernel_session
!= NULL
) {
3680 nb_event
= list_lttng_kernel_events(channel_name
,
3681 session
->kernel_session
, events
,
3685 case LTTNG_DOMAIN_UST
:
3687 if (session
->ust_session
!= NULL
) {
3688 nb_event
= list_lttng_ust_global_events(channel_name
,
3689 &session
->ust_session
->domain_global
, events
,
3694 case LTTNG_DOMAIN_LOG4J
:
3695 case LTTNG_DOMAIN_JUL
:
3696 case LTTNG_DOMAIN_PYTHON
:
3697 if (session
->ust_session
) {
3698 struct lttng_ht_iter iter
;
3702 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3703 &iter
.iter
, agt
, node
.node
) {
3704 if (agt
->domain
== domain
) {
3705 nb_event
= list_lttng_agent_events(
3715 ret
= LTTNG_ERR_UND
;
3722 /* Return negative value to differentiate return code */
3727 * Using the session list, filled a lttng_session array to send back to the
3728 * client for session listing.
3730 * The session list lock MUST be acquired before calling this function. Use
3731 * session_lock_list() and session_unlock_list().
3733 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3734 size_t session_count
, uid_t uid
, gid_t gid
)
3738 struct ltt_session
*session
;
3739 struct ltt_session_list
*list
= session_get_list();
3740 struct lttng_session_extended
*extended
=
3741 (typeof(extended
)) (&sessions
[session_count
]);
3743 DBG("Getting all available session for UID %d GID %d",
3746 * Iterate over session list and append data after the control struct in
3749 cds_list_for_each_entry(session
, &list
->head
, list
) {
3750 if (!session_get(session
)) {
3754 * Only list the sessions the user can control.
3756 if (!session_access_ok(session
, uid
, gid
) ||
3757 session
->destroyed
) {
3758 session_put(session
);
3762 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3763 struct ltt_ust_session
*usess
= session
->ust_session
;
3765 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3766 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3767 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3768 ret
= build_network_session_path(sessions
[i
].path
,
3769 sizeof(sessions
[i
].path
), session
);
3771 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3772 session
->consumer
->dst
.session_root_path
);
3775 PERROR("snprintf session path");
3776 session_put(session
);
3780 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3781 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3782 sessions
[i
].enabled
= session
->active
;
3783 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3784 sessions
[i
].live_timer_interval
= session
->live_timer
;
3785 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3786 extended
[i
].creation_time
.is_set
= 1;
3788 session_put(session
);
3793 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3794 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3796 int cmd_data_pending(struct ltt_session
*session
)
3799 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3800 struct ltt_ust_session
*usess
= session
->ust_session
;
3804 DBG("Data pending for session %s", session
->name
);
3806 /* Session MUST be stopped to ask for data availability. */
3807 if (session
->active
) {
3808 ret
= LTTNG_ERR_SESSION_STARTED
;
3812 * If stopped, just make sure we've started before else the above call
3813 * will always send that there is data pending.
3815 * The consumer assumes that when the data pending command is received,
3816 * the trace has been started before or else no output data is written
3817 * by the streams which is a condition for data pending. So, this is
3818 * *VERY* important that we don't ask the consumer before a start
3821 if (!session
->has_been_started
) {
3827 /* A rotation is still pending, we have to wait. */
3828 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3829 DBG("Rotate still pending for session %s", session
->name
);
3834 if (ksess
&& ksess
->consumer
) {
3835 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3837 /* Data is still being extracted for the kernel. */
3842 if (usess
&& usess
->consumer
) {
3843 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3845 /* Data is still being extracted for the kernel. */
3850 /* Data is ready to be read by a viewer */
3858 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3860 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3862 int cmd_snapshot_add_output(struct ltt_session
*session
,
3863 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3866 struct snapshot_output
*new_output
;
3871 DBG("Cmd snapshot add output for session %s", session
->name
);
3874 * Can't create an output if the session is not set in no-output mode.
3876 if (session
->output_traces
) {
3877 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3881 if (session
->has_non_mmap_channel
) {
3882 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3886 /* Only one output is allowed until we have the "tee" feature. */
3887 if (session
->snapshot
.nb_output
== 1) {
3888 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3892 new_output
= snapshot_output_alloc();
3894 ret
= LTTNG_ERR_NOMEM
;
3898 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3899 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3900 &session
->snapshot
);
3902 if (ret
== -ENOMEM
) {
3903 ret
= LTTNG_ERR_NOMEM
;
3905 ret
= LTTNG_ERR_INVALID
;
3911 snapshot_add_output(&session
->snapshot
, new_output
);
3913 *id
= new_output
->id
;
3920 snapshot_output_destroy(new_output
);
3926 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3928 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3930 int cmd_snapshot_del_output(struct ltt_session
*session
,
3931 const struct lttng_snapshot_output
*output
)
3934 struct snapshot_output
*sout
= NULL
;
3942 * Permission denied to create an output if the session is not
3943 * set in no output mode.
3945 if (session
->output_traces
) {
3946 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3951 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3953 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3954 } else if (*output
->name
!= '\0') {
3955 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3957 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3960 ret
= LTTNG_ERR_INVALID
;
3964 snapshot_delete_output(&session
->snapshot
, sout
);
3965 snapshot_output_destroy(sout
);
3974 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3976 * If no output is available, outputs is untouched and 0 is returned.
3978 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3980 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3981 struct lttng_snapshot_output
**outputs
)
3984 struct lttng_snapshot_output
*list
= NULL
;
3985 struct lttng_ht_iter iter
;
3986 struct snapshot_output
*output
;
3991 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3994 * Permission denied to create an output if the session is not
3995 * set in no output mode.
3997 if (session
->output_traces
) {
3998 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4002 if (session
->snapshot
.nb_output
== 0) {
4007 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4009 ret
= -LTTNG_ERR_NOMEM
;
4013 /* Copy list from session to the new list object. */
4015 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4016 output
, node
.node
) {
4017 assert(output
->consumer
);
4018 list
[idx
].id
= output
->id
;
4019 list
[idx
].max_size
= output
->max_size
;
4020 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4021 sizeof(list
[idx
].name
))) {
4022 ret
= -LTTNG_ERR_INVALID
;
4025 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4026 if (lttng_strncpy(list
[idx
].ctrl_url
,
4027 output
->consumer
->dst
.session_root_path
,
4028 sizeof(list
[idx
].ctrl_url
))) {
4029 ret
= -LTTNG_ERR_INVALID
;
4034 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4035 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4037 ret
= -LTTNG_ERR_NOMEM
;
4042 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4043 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4045 ret
= -LTTNG_ERR_NOMEM
;
4054 ret
= session
->snapshot
.nb_output
;
4063 * Check if we can regenerate the metadata for this session.
4064 * Only kernel, UST per-uid and non-live sessions are supported.
4066 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4069 int check_regenerate_metadata_support(struct ltt_session
*session
)
4075 if (session
->live_timer
!= 0) {
4076 ret
= LTTNG_ERR_LIVE_SESSION
;
4079 if (!session
->active
) {
4080 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4083 if (session
->ust_session
) {
4084 switch (session
->ust_session
->buffer_type
) {
4085 case LTTNG_BUFFER_PER_UID
:
4087 case LTTNG_BUFFER_PER_PID
:
4088 ret
= LTTNG_ERR_PER_PID_SESSION
;
4092 ret
= LTTNG_ERR_UNK
;
4096 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4097 session
->consumer
->relay_minor_version
< 8) {
4098 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4108 int clear_metadata_file(int fd
)
4113 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4114 if (lseek_ret
< 0) {
4120 ret
= ftruncate(fd
, 0);
4122 PERROR("ftruncate");
4131 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4134 struct buffer_reg_uid
*uid_reg
= NULL
;
4135 struct buffer_reg_session
*session_reg
= NULL
;
4138 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4139 struct ust_registry_session
*registry
;
4140 struct ust_registry_channel
*chan
;
4141 struct lttng_ht_iter iter_chan
;
4143 session_reg
= uid_reg
->registry
;
4144 registry
= session_reg
->reg
.ust
;
4146 pthread_mutex_lock(®istry
->lock
);
4147 registry
->metadata_len_sent
= 0;
4148 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4149 registry
->metadata_len
= 0;
4150 registry
->metadata_version
++;
4151 if (registry
->metadata_fd
> 0) {
4152 /* Clear the metadata file's content. */
4153 ret
= clear_metadata_file(registry
->metadata_fd
);
4155 pthread_mutex_unlock(®istry
->lock
);
4160 ret
= ust_metadata_session_statedump(registry
, NULL
,
4161 registry
->major
, registry
->minor
);
4163 pthread_mutex_unlock(®istry
->lock
);
4164 ERR("Failed to generate session metadata (err = %d)",
4168 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4170 struct ust_registry_event
*event
;
4171 struct lttng_ht_iter iter_event
;
4173 ret
= ust_metadata_channel_statedump(registry
, chan
);
4175 pthread_mutex_unlock(®istry
->lock
);
4176 ERR("Failed to generate channel metadata "
4180 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4182 ret
= ust_metadata_event_statedump(registry
,
4185 pthread_mutex_unlock(®istry
->lock
);
4186 ERR("Failed to generate event metadata "
4192 pthread_mutex_unlock(®istry
->lock
);
4201 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4203 * Ask the consumer to truncate the existing metadata file(s) and
4204 * then regenerate the metadata. Live and per-pid sessions are not
4205 * supported and return an error.
4207 * Return 0 on success or else a LTTNG_ERR code.
4209 int cmd_regenerate_metadata(struct ltt_session
*session
)
4215 ret
= check_regenerate_metadata_support(session
);
4220 if (session
->kernel_session
) {
4221 ret
= kernctl_session_regenerate_metadata(
4222 session
->kernel_session
->fd
);
4224 ERR("Failed to regenerate the kernel metadata");
4229 if (session
->ust_session
) {
4230 ret
= ust_regenerate_metadata(session
->ust_session
);
4232 ERR("Failed to regenerate the UST metadata");
4236 DBG("Cmd metadata regenerate for session %s", session
->name
);
4244 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4246 * Ask the tracer to regenerate a new statedump.
4248 * Return 0 on success or else a LTTNG_ERR code.
4250 int cmd_regenerate_statedump(struct ltt_session
*session
)
4256 if (!session
->active
) {
4257 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4261 if (session
->kernel_session
) {
4262 ret
= kernctl_session_regenerate_statedump(
4263 session
->kernel_session
->fd
);
4265 * Currently, the statedump in kernel can only fail if out
4269 if (ret
== -ENOMEM
) {
4270 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4272 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4274 ERR("Failed to regenerate the kernel statedump");
4279 if (session
->ust_session
) {
4280 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4282 * Currently, the statedump in UST always returns 0.
4285 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4286 ERR("Failed to regenerate the UST statedump");
4290 DBG("Cmd regenerate statedump for session %s", session
->name
);
4297 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4298 struct notification_thread_handle
*notification_thread
)
4302 ssize_t sock_recv_len
;
4303 struct lttng_trigger
*trigger
= NULL
;
4304 struct lttng_buffer_view view
;
4305 struct lttng_dynamic_buffer trigger_buffer
;
4307 lttng_dynamic_buffer_init(&trigger_buffer
);
4308 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4309 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4311 ret
= LTTNG_ERR_NOMEM
;
4315 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4317 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4318 ERR("Failed to receive \"register trigger\" command payload");
4319 /* TODO: should this be a new error enum ? */
4320 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4324 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4325 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4327 ERR("Invalid trigger payload received in \"register trigger\" command");
4328 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4332 ret
= notification_thread_command_register_trigger(notification_thread
,
4334 /* Ownership of trigger was transferred. */
4337 lttng_trigger_destroy(trigger
);
4338 lttng_dynamic_buffer_reset(&trigger_buffer
);
4342 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4343 struct notification_thread_handle
*notification_thread
)
4347 ssize_t sock_recv_len
;
4348 struct lttng_trigger
*trigger
= NULL
;
4349 struct lttng_buffer_view view
;
4350 struct lttng_dynamic_buffer trigger_buffer
;
4352 lttng_dynamic_buffer_init(&trigger_buffer
);
4353 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4354 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4356 ret
= LTTNG_ERR_NOMEM
;
4360 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4362 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4363 ERR("Failed to receive \"unregister trigger\" command payload");
4364 /* TODO: should this be a new error enum ? */
4365 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4369 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4370 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4372 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4373 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4377 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4380 lttng_trigger_destroy(trigger
);
4381 lttng_dynamic_buffer_reset(&trigger_buffer
);
4386 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4387 * snapshot output is *not* set with a remote destination.
4389 * Return LTTNG_OK on success or a LTTNG_ERR code.
4391 static enum lttng_error_code
set_relayd_for_snapshot(
4392 struct consumer_output
*output
,
4393 const struct ltt_session
*session
)
4395 enum lttng_error_code status
= LTTNG_OK
;
4396 struct lttng_ht_iter iter
;
4397 struct consumer_socket
*socket
;
4398 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4399 const char *base_path
;
4404 DBG2("Set relayd object from snapshot output");
4406 if (session
->current_trace_chunk
) {
4407 enum lttng_trace_chunk_status chunk_status
=
4408 lttng_trace_chunk_get_id(
4409 session
->current_trace_chunk
,
4410 ¤t_chunk_id
.value
);
4412 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4413 current_chunk_id
.is_set
= true;
4415 ERR("Failed to get current trace chunk id");
4416 status
= LTTNG_ERR_UNK
;
4421 /* Ignore if snapshot consumer output is not network. */
4422 if (output
->type
!= CONSUMER_DST_NET
) {
4427 * The snapshot record URI base path overrides the session
4430 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4431 base_path
= output
->dst
.net
.control
.subdir
;
4433 base_path
= session
->base_path
;
4437 * For each consumer socket, create and send the relayd object of the
4441 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4442 socket
, node
.node
) {
4443 pthread_mutex_lock(socket
->lock
);
4444 status
= send_consumer_relayd_sockets(0, session
->id
,
4446 session
->name
, session
->hostname
,
4448 session
->live_timer
,
4449 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4450 session
->creation_time
,
4451 session
->name_contains_creation_time
);
4452 pthread_mutex_unlock(socket
->lock
);
4453 if (status
!= LTTNG_OK
) {
4465 * Record a kernel snapshot.
4467 * Return LTTNG_OK on success or a LTTNG_ERR code.
4469 static enum lttng_error_code
record_kernel_snapshot(
4470 struct ltt_kernel_session
*ksess
,
4471 const struct consumer_output
*output
,
4472 const struct ltt_session
*session
,
4473 int wait
, uint64_t nb_packets_per_stream
)
4475 enum lttng_error_code status
;
4481 status
= kernel_snapshot_record(
4482 ksess
, output
, wait
, nb_packets_per_stream
);
4487 * Record a UST snapshot.
4489 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4491 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4492 const struct consumer_output
*output
,
4493 const struct ltt_session
*session
,
4494 int wait
, uint64_t nb_packets_per_stream
)
4496 enum lttng_error_code status
;
4502 status
= ust_app_snapshot_record(
4503 usess
, output
, wait
, nb_packets_per_stream
);
4508 uint64_t get_session_size_one_more_packet_per_stream(
4509 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4511 uint64_t tot_size
= 0;
4513 if (session
->kernel_session
) {
4514 struct ltt_kernel_channel
*chan
;
4515 const struct ltt_kernel_session
*ksess
=
4516 session
->kernel_session
;
4518 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4519 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4521 * Don't take channel into account if we
4522 * already grab all its packets.
4526 tot_size
+= chan
->channel
->attr
.subbuf_size
4527 * chan
->stream_count
;
4531 if (session
->ust_session
) {
4532 const struct ltt_ust_session
*usess
= session
->ust_session
;
4534 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4542 * Calculate the number of packets we can grab from each stream that
4543 * fits within the overall snapshot max size.
4545 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4546 * the number of packets per stream.
4548 * TODO: this approach is not perfect: we consider the worse case
4549 * (packet filling the sub-buffers) as an upper bound, but we could do
4550 * better if we do this calculation while we actually grab the packet
4551 * content: we would know how much padding we don't actually store into
4554 * This algorithm is currently bounded by the number of packets per
4557 * Since we call this algorithm before actually grabbing the data, it's
4558 * an approximation: for instance, applications could appear/disappear
4559 * in between this call and actually grabbing data.
4562 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4566 uint64_t cur_nb_packets
= 0;
4569 return 0; /* Infinite */
4572 size_left
= max_size
;
4574 uint64_t one_more_packet_tot_size
;
4576 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4577 session
, cur_nb_packets
);
4578 if (!one_more_packet_tot_size
) {
4579 /* We are already grabbing all packets. */
4582 size_left
-= one_more_packet_tot_size
;
4583 if (size_left
< 0) {
4588 if (!cur_nb_packets
) {
4589 /* Not enough room to grab one packet of each stream, error. */
4592 return cur_nb_packets
;
4596 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4597 const struct snapshot_output
*snapshot_output
, int wait
)
4599 int64_t nb_packets_per_stream
;
4600 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4602 enum lttng_error_code ret_code
= LTTNG_OK
;
4603 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4604 struct consumer_output
*original_ust_consumer_output
= NULL
;
4605 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4606 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4607 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4609 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4611 snapshot_output
->name
,
4612 snapshot_output
->datetime
,
4613 snapshot_output
->nb_snapshot
);
4614 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4615 ERR("Failed to format snapshot name");
4616 ret_code
= LTTNG_ERR_INVALID
;
4619 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4620 snapshot_output
->name
, session
->name
,
4621 snapshot_chunk_name
);
4622 if (!session
->kernel_session
&& !session
->ust_session
) {
4623 ERR("Failed to record snapshot as no channels exist");
4624 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4628 if (session
->kernel_session
) {
4629 original_kernel_consumer_output
=
4630 session
->kernel_session
->consumer
;
4631 snapshot_kernel_consumer_output
=
4632 consumer_copy_output(snapshot_output
->consumer
);
4633 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4634 snapshot_chunk_name
);
4635 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4636 original_kernel_consumer_output
);
4638 ERR("Failed to copy consumer sockets from snapshot output configuration");
4639 ret_code
= LTTNG_ERR_NOMEM
;
4642 ret_code
= set_relayd_for_snapshot(
4643 snapshot_kernel_consumer_output
, session
);
4644 if (ret_code
!= LTTNG_OK
) {
4645 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4648 session
->kernel_session
->consumer
=
4649 snapshot_kernel_consumer_output
;
4651 if (session
->ust_session
) {
4652 original_ust_consumer_output
= session
->ust_session
->consumer
;
4653 snapshot_ust_consumer_output
=
4654 consumer_copy_output(snapshot_output
->consumer
);
4655 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4656 snapshot_chunk_name
);
4657 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4658 original_ust_consumer_output
);
4660 ERR("Failed to copy consumer sockets from snapshot output configuration");
4661 ret_code
= LTTNG_ERR_NOMEM
;
4664 ret_code
= set_relayd_for_snapshot(
4665 snapshot_ust_consumer_output
, session
);
4666 if (ret_code
!= LTTNG_OK
) {
4667 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4670 session
->ust_session
->consumer
=
4671 snapshot_ust_consumer_output
;
4674 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4675 snapshot_kernel_consumer_output
?:
4676 snapshot_ust_consumer_output
,
4677 consumer_output_get_base_path(
4678 snapshot_output
->consumer
),
4679 snapshot_chunk_name
);
4680 if (!snapshot_trace_chunk
) {
4681 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4683 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4686 assert(!session
->current_trace_chunk
);
4687 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4688 lttng_trace_chunk_put(snapshot_trace_chunk
);
4689 snapshot_trace_chunk
= NULL
;
4691 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4693 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4697 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4698 snapshot_output
->max_size
);
4699 if (nb_packets_per_stream
< 0) {
4700 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4704 if (session
->kernel_session
) {
4705 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4706 snapshot_kernel_consumer_output
, session
,
4707 wait
, nb_packets_per_stream
);
4708 if (ret_code
!= LTTNG_OK
) {
4713 if (session
->ust_session
) {
4714 ret_code
= record_ust_snapshot(session
->ust_session
,
4715 snapshot_ust_consumer_output
, session
,
4716 wait
, nb_packets_per_stream
);
4717 if (ret_code
!= LTTNG_OK
) {
4722 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4723 ERR("Failed to release the current trace chunk of session \"%s\"",
4725 ret_code
= LTTNG_ERR_UNK
;
4728 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4729 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4731 * Don't goto end; make sure the chunk is closed for the session
4732 * to allow future snapshots.
4734 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4736 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4739 if (original_ust_consumer_output
) {
4740 session
->ust_session
->consumer
= original_ust_consumer_output
;
4742 if (original_kernel_consumer_output
) {
4743 session
->kernel_session
->consumer
=
4744 original_kernel_consumer_output
;
4746 consumer_output_put(snapshot_ust_consumer_output
);
4747 consumer_output_put(snapshot_kernel_consumer_output
);
4752 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4754 * The wait parameter is ignored so this call always wait for the snapshot to
4755 * complete before returning.
4757 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4759 int cmd_snapshot_record(struct ltt_session
*session
,
4760 const struct lttng_snapshot_output
*output
, int wait
)
4762 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4764 unsigned int snapshot_success
= 0;
4766 struct snapshot_output
*tmp_output
= NULL
;
4771 DBG("Cmd snapshot record for session %s", session
->name
);
4773 /* Get the datetime for the snapshot output directory. */
4774 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4777 cmd_ret
= LTTNG_ERR_INVALID
;
4782 * Permission denied to create an output if the session is not
4783 * set in no output mode.
4785 if (session
->output_traces
) {
4786 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4790 /* The session needs to be started at least once. */
4791 if (!session
->has_been_started
) {
4792 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4796 /* Use temporary output for the session. */
4797 if (*output
->ctrl_url
!= '\0') {
4798 tmp_output
= snapshot_output_alloc();
4800 cmd_ret
= LTTNG_ERR_NOMEM
;
4804 ret
= snapshot_output_init(session
, output
->max_size
,
4806 output
->ctrl_url
, output
->data_url
,
4810 if (ret
== -ENOMEM
) {
4811 cmd_ret
= LTTNG_ERR_NOMEM
;
4813 cmd_ret
= LTTNG_ERR_INVALID
;
4817 /* Use the global session count for the temporary snapshot. */
4818 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4820 /* Use the global datetime */
4821 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4822 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4823 if (cmd_ret
!= LTTNG_OK
) {
4826 snapshot_success
= 1;
4828 struct snapshot_output
*sout
;
4829 struct lttng_ht_iter iter
;
4832 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4833 &iter
.iter
, sout
, node
.node
) {
4834 struct snapshot_output output_copy
;
4837 * Make a local copy of the output and override output
4838 * parameters with those provided as part of the
4841 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4843 if (output
->max_size
!= (uint64_t) -1ULL) {
4844 output_copy
.max_size
= output
->max_size
;
4847 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4848 memcpy(output_copy
.datetime
, datetime
,
4851 /* Use temporary name. */
4852 if (*output
->name
!= '\0') {
4853 if (lttng_strncpy(output_copy
.name
,
4855 sizeof(output_copy
.name
))) {
4856 cmd_ret
= LTTNG_ERR_INVALID
;
4862 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4863 if (cmd_ret
!= LTTNG_OK
) {
4867 snapshot_success
= 1;
4872 if (snapshot_success
) {
4873 session
->snapshot
.nb_snapshot
++;
4875 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4880 snapshot_output_destroy(tmp_output
);
4886 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4888 int cmd_set_session_shm_path(struct ltt_session
*session
,
4889 const char *shm_path
)
4895 * Can only set shm path before session is started.
4897 if (session
->has_been_started
) {
4898 return LTTNG_ERR_SESSION_STARTED
;
4901 strncpy(session
->shm_path
, shm_path
,
4902 sizeof(session
->shm_path
));
4903 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4909 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4911 * Ask the consumer to rotate the session output directory.
4912 * The session lock must be held.
4914 * Returns LTTNG_OK on success or else a negative LTTng error code.
4916 int cmd_rotate_session(struct ltt_session
*session
,
4917 struct lttng_rotate_session_return
*rotate_return
,
4918 bool quiet_rotation
,
4919 enum lttng_trace_chunk_command_type command
)
4922 uint64_t ongoing_rotation_chunk_id
;
4923 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4924 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4925 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4926 enum lttng_trace_chunk_status chunk_status
;
4927 bool failed_to_rotate
= false;
4928 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4932 if (!session
->has_been_started
) {
4933 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4938 * Explicit rotation is not supported for live sessions.
4939 * However, live sessions can perform a quiet rotation on
4941 * Rotation is not supported for snapshot traces (no output).
4943 if ((!quiet_rotation
&& session
->live_timer
) ||
4944 !session
->output_traces
) {
4945 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4949 /* Unsupported feature in lttng-relayd before 2.11. */
4950 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4951 (session
->consumer
->relay_major_version
== 2 &&
4952 session
->consumer
->relay_minor_version
< 11)) {
4953 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4957 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4958 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4959 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4963 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4964 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4966 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4971 * After a stop, we only allow one rotation to occur, the other ones are
4972 * useless until a new start.
4974 if (session
->rotated_after_last_stop
) {
4975 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4977 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4982 * After a stop followed by a clear, disallow following rotations a they would
4983 * generate empty chunks.
4985 if (session
->cleared_after_last_stop
) {
4986 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
4988 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
4992 if (session
->active
) {
4993 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4995 if (!new_trace_chunk
) {
4996 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5002 * The current trace chunk becomes the chunk being archived.
5004 * After this point, "chunk_being_archived" must absolutely
5005 * be closed on the consumer(s), otherwise it will never be
5006 * cleaned-up, which will result in a leak.
5008 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5009 &chunk_being_archived
);
5011 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5015 if (session
->kernel_session
) {
5016 cmd_ret
= kernel_rotate_session(session
);
5017 if (cmd_ret
!= LTTNG_OK
) {
5018 failed_to_rotate
= true;
5019 rotation_fail_code
= cmd_ret
;
5022 if (session
->ust_session
) {
5023 cmd_ret
= ust_app_rotate_session(session
);
5024 if (cmd_ret
!= LTTNG_OK
) {
5025 failed_to_rotate
= true;
5026 rotation_fail_code
= cmd_ret
;
5030 if (!session
->active
) {
5031 session
->rotated_after_last_stop
= true;
5034 if (!chunk_being_archived
) {
5035 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5037 if (failed_to_rotate
) {
5038 cmd_ret
= rotation_fail_code
;
5045 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5046 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5047 &ongoing_rotation_chunk_id
);
5048 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5050 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5051 command
, session
->last_chunk_path
);
5053 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5057 if (failed_to_rotate
) {
5058 cmd_ret
= rotation_fail_code
;
5062 session
->quiet_rotation
= quiet_rotation
;
5063 ret
= timer_session_rotation_pending_check_start(session
,
5064 DEFAULT_ROTATE_PENDING_TIMER
);
5066 cmd_ret
= LTTNG_ERR_UNK
;
5070 if (rotate_return
) {
5071 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5074 session
->chunk_being_archived
= chunk_being_archived
;
5075 chunk_being_archived
= NULL
;
5076 if (!quiet_rotation
) {
5077 ret
= notification_thread_command_session_rotation_ongoing(
5078 notification_thread_handle
,
5079 session
->name
, session
->uid
, session
->gid
,
5080 ongoing_rotation_chunk_id
);
5081 if (ret
!= LTTNG_OK
) {
5082 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5088 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5089 session
->name
, ongoing_rotation_chunk_id
);
5091 lttng_trace_chunk_put(new_trace_chunk
);
5092 lttng_trace_chunk_put(chunk_being_archived
);
5093 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5096 if (session_reset_rotation_state(session
,
5097 LTTNG_ROTATION_STATE_ERROR
)) {
5098 ERR("Failed to reset rotation state of session \"%s\"",
5105 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5107 * Check if the session has finished its rotation.
5109 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5111 int cmd_rotate_get_info(struct ltt_session
*session
,
5112 struct lttng_rotation_get_info_return
*info_return
,
5113 uint64_t rotation_id
)
5115 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5116 enum lttng_rotation_state rotation_state
;
5118 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5119 session
->most_recent_chunk_id
.value
);
5121 if (session
->chunk_being_archived
) {
5122 enum lttng_trace_chunk_status chunk_status
;
5125 chunk_status
= lttng_trace_chunk_get_id(
5126 session
->chunk_being_archived
,
5128 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5130 rotation_state
= rotation_id
== chunk_id
?
5131 LTTNG_ROTATION_STATE_ONGOING
:
5132 LTTNG_ROTATION_STATE_EXPIRED
;
5134 if (session
->last_archived_chunk_id
.is_set
&&
5135 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5136 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5138 rotation_state
= session
->rotation_state
;
5142 switch (rotation_state
) {
5143 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5144 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5147 case LTTNG_ROTATION_STATE_EXPIRED
:
5148 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5149 rotation_id
, session
->name
);
5151 case LTTNG_ROTATION_STATE_ONGOING
:
5152 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5153 rotation_id
, session
->name
);
5155 case LTTNG_ROTATION_STATE_COMPLETED
:
5159 char *current_tracing_path_reply
;
5160 size_t current_tracing_path_reply_len
;
5162 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5163 rotation_id
, session
->name
);
5165 switch (session_get_consumer_destination_type(session
)) {
5166 case CONSUMER_DST_LOCAL
:
5167 current_tracing_path_reply
=
5168 info_return
->location
.local
.absolute_path
;
5169 current_tracing_path_reply_len
=
5170 sizeof(info_return
->location
.local
.absolute_path
);
5171 info_return
->location_type
=
5172 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5173 fmt_ret
= asprintf(&chunk_path
,
5174 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5175 session_get_base_path(session
),
5176 session
->last_archived_chunk_name
);
5177 if (fmt_ret
== -1) {
5178 PERROR("Failed to format the path of the last archived trace chunk");
5179 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5180 cmd_ret
= LTTNG_ERR_UNK
;
5184 case CONSUMER_DST_NET
:
5186 uint16_t ctrl_port
, data_port
;
5188 current_tracing_path_reply
=
5189 info_return
->location
.relay
.relative_path
;
5190 current_tracing_path_reply_len
=
5191 sizeof(info_return
->location
.relay
.relative_path
);
5192 /* Currently the only supported relay protocol. */
5193 info_return
->location
.relay
.protocol
=
5194 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5196 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5197 session_get_net_consumer_hostname(session
),
5198 sizeof(info_return
->location
.relay
.host
));
5200 ERR("Failed to copy host name to rotate_get_info reply");
5201 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5202 cmd_ret
= LTTNG_ERR_SET_URL
;
5206 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5207 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5208 info_return
->location
.relay
.ports
.data
= data_port
;
5209 info_return
->location_type
=
5210 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5211 chunk_path
= strdup(session
->last_chunk_path
);
5213 ERR("Failed to allocate the path of the last archived trace chunk");
5214 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5215 cmd_ret
= LTTNG_ERR_UNK
;
5224 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5225 chunk_path
, current_tracing_path_reply_len
);
5228 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5229 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5230 cmd_ret
= LTTNG_ERR_UNK
;
5236 case LTTNG_ROTATION_STATE_ERROR
:
5237 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5238 rotation_id
, session
->name
);
5246 info_return
->status
= (int32_t) rotation_state
;
5251 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5253 * Configure the automatic rotation parameters.
5254 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5255 * 'activate' to false means deactivate the rotation schedule and validate that
5256 * 'new_value' has the same value as the currently active value.
5258 * Return 0 on success or else a positive LTTNG_ERR code.
5260 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5261 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5263 struct notification_thread_handle
*notification_thread_handle
)
5266 uint64_t *parameter_value
;
5270 DBG("Cmd rotate set schedule session %s", session
->name
);
5272 if (session
->live_timer
|| !session
->output_traces
) {
5273 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5274 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5278 switch (schedule_type
) {
5279 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5280 parameter_value
= &session
->rotate_size
;
5282 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5283 parameter_value
= &session
->rotate_timer_period
;
5284 if (new_value
>= UINT_MAX
) {
5285 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5286 new_value
, UINT_MAX
);
5287 ret
= LTTNG_ERR_INVALID
;
5292 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5293 ret
= LTTNG_ERR_INVALID
;
5297 /* Improper use of the API. */
5298 if (new_value
== -1ULL) {
5299 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5300 ret
= LTTNG_ERR_INVALID
;
5305 * As indicated in struct ltt_session's comments, a value of == 0 means
5306 * this schedule rotation type is not in use.
5308 * Reject the command if we were asked to activate a schedule that was
5311 if (activate
&& *parameter_value
!= 0) {
5312 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5313 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5318 * Reject the command if we were asked to deactivate a schedule that was
5321 if (!activate
&& *parameter_value
== 0) {
5322 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5323 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5328 * Reject the command if we were asked to deactivate a schedule that
5331 if (!activate
&& *parameter_value
!= new_value
) {
5332 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5333 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5337 *parameter_value
= activate
? new_value
: 0;
5339 switch (schedule_type
) {
5340 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5341 if (activate
&& session
->active
) {
5343 * Only start the timer if the session is active,
5344 * otherwise it will be started when the session starts.
5346 ret
= timer_session_rotation_schedule_timer_start(
5347 session
, new_value
);
5349 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5350 ret
= LTTNG_ERR_UNK
;
5354 ret
= timer_session_rotation_schedule_timer_stop(
5357 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5358 ret
= LTTNG_ERR_UNK
;
5363 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5365 ret
= subscribe_session_consumed_size_rotation(session
,
5366 new_value
, notification_thread_handle
);
5368 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5369 ret
= LTTNG_ERR_UNK
;
5373 ret
= unsubscribe_session_consumed_size_rotation(session
,
5374 notification_thread_handle
);
5376 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5377 ret
= LTTNG_ERR_UNK
;
5384 /* Would have been caught before. */
5396 /* Wait for a given path to be removed before continuing. */
5397 static enum lttng_error_code
wait_on_path(void *path_data
)
5399 const char *shm_path
= path_data
;
5401 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5407 ret
= stat(shm_path
, &st
);
5409 if (errno
!= ENOENT
) {
5410 PERROR("stat() returned an error while checking for the existence of the shm path");
5412 DBG("shm path no longer exists, completing the destruction of session");
5416 if (!S_ISDIR(st
.st_mode
)) {
5417 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5422 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5428 * Returns a pointer to a handler to run on completion of a command.
5429 * Returns NULL if no handler has to be run for the last command executed.
5431 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5433 struct cmd_completion_handler
*handler
= current_completion_handler
;
5435 current_completion_handler
= NULL
;
5440 * Init command subsystem.
5445 * Set network sequence index to 1 for streams to match a relayd
5446 * socket on the consumer side.
5448 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5449 relayd_net_seq_idx
= 1;
5450 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5452 DBG("Command subsystem initialized");