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 int 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_ids
**ids
)
2592 case LTTNG_DOMAIN_KERNEL
:
2594 struct ltt_kernel_session
*ksess
;
2596 ksess
= session
->kernel_session
;
2597 ret
= kernel_list_tracker_ids(tracker_type
, ksess
, ids
);
2598 if (ret
!= LTTNG_OK
) {
2599 ret
= -LTTNG_ERR_KERN_LIST_FAIL
;
2604 case LTTNG_DOMAIN_UST
:
2606 struct ltt_ust_session
*usess
;
2608 usess
= session
->ust_session
;
2609 ret
= trace_ust_list_tracker_ids(tracker_type
, usess
, ids
);
2610 if (ret
!= LTTNG_OK
) {
2611 ret
= -LTTNG_ERR_UST_LIST_FAIL
;
2616 case LTTNG_DOMAIN_LOG4J
:
2617 case LTTNG_DOMAIN_JUL
:
2618 case LTTNG_DOMAIN_PYTHON
:
2620 ret
= -LTTNG_ERR_UND
;
2625 /* Return negative value to differentiate return code */
2630 * Command LTTNG_START_TRACE processed by the client thread.
2632 * Called with session mutex held.
2634 int cmd_start_trace(struct ltt_session
*session
)
2636 enum lttng_error_code ret
;
2637 unsigned long nb_chan
= 0;
2638 struct ltt_kernel_session
*ksession
;
2639 struct ltt_ust_session
*usess
;
2640 const bool session_rotated_after_last_stop
=
2641 session
->rotated_after_last_stop
;
2642 const bool session_cleared_after_last_stop
=
2643 session
->cleared_after_last_stop
;
2647 /* Ease our life a bit ;) */
2648 ksession
= session
->kernel_session
;
2649 usess
= session
->ust_session
;
2651 /* Is the session already started? */
2652 if (session
->active
) {
2653 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2657 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2658 !session
->current_trace_chunk
) {
2660 * A rotation was launched while the session was stopped and
2661 * it has not been completed yet. It is not possible to start
2662 * the session since starting the session here would require a
2663 * rotation from "NULL" to a new trace chunk. That rotation
2664 * would overlap with the ongoing rotation, which is not
2667 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2669 ret
= LTTNG_ERR_ROTATION_PENDING
;
2674 * Starting a session without channel is useless since after that it's not
2675 * possible to enable channel thus inform the client.
2677 if (usess
&& usess
->domain_global
.channels
) {
2678 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2681 nb_chan
+= ksession
->channel_count
;
2684 ret
= LTTNG_ERR_NO_CHANNEL
;
2688 session
->active
= 1;
2689 session
->rotated_after_last_stop
= false;
2690 session
->cleared_after_last_stop
= false;
2691 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2692 if (!session
->has_been_started
) {
2693 struct lttng_trace_chunk
*trace_chunk
;
2695 DBG("Creating initial trace chunk of session \"%s\"",
2697 trace_chunk
= session_create_new_trace_chunk(
2698 session
, NULL
, NULL
, NULL
);
2700 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2703 assert(!session
->current_trace_chunk
);
2704 ret
= session_set_trace_chunk(session
, trace_chunk
,
2706 lttng_trace_chunk_put(trace_chunk
);
2708 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2712 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2715 * Rotate existing streams into the new chunk.
2716 * This is a "quiet" rotation has no client has
2717 * explicitly requested this operation.
2719 * There is also no need to wait for the rotation
2720 * to complete as it will happen immediately. No data
2721 * was produced as the session was stopped, so the
2722 * rotation should happen on reception of the command.
2724 ret
= cmd_rotate_session(session
, NULL
, true,
2725 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2726 if (ret
!= LTTNG_OK
) {
2732 /* Kernel tracing */
2733 if (ksession
!= NULL
) {
2734 DBG("Start kernel tracing session %s", session
->name
);
2735 ret
= start_kernel_session(ksession
);
2736 if (ret
!= LTTNG_OK
) {
2741 /* Flag session that trace should start automatically */
2743 int int_ret
= ust_app_start_trace_all(usess
);
2746 ret
= LTTNG_ERR_UST_START_FAIL
;
2752 * Clear the flag that indicates that a rotation was done while the
2753 * session was stopped.
2755 session
->rotated_after_last_stop
= false;
2757 if (session
->rotate_timer_period
) {
2758 int int_ret
= timer_session_rotation_schedule_timer_start(
2759 session
, session
->rotate_timer_period
);
2762 ERR("Failed to enable rotate timer");
2763 ret
= LTTNG_ERR_UNK
;
2771 if (ret
== LTTNG_OK
) {
2772 /* Flag this after a successful start. */
2773 session
->has_been_started
|= 1;
2775 session
->active
= 0;
2776 /* Restore initial state on error. */
2777 session
->rotated_after_last_stop
=
2778 session_rotated_after_last_stop
;
2779 session
->cleared_after_last_stop
=
2780 session_cleared_after_last_stop
;
2786 * Command LTTNG_STOP_TRACE processed by the client thread.
2788 int cmd_stop_trace(struct ltt_session
*session
)
2791 struct ltt_kernel_session
*ksession
;
2792 struct ltt_ust_session
*usess
;
2796 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2798 ksession
= session
->kernel_session
;
2799 usess
= session
->ust_session
;
2801 /* Session is not active. Skip everythong and inform the client. */
2802 if (!session
->active
) {
2803 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2807 ret
= stop_kernel_session(ksession
);
2808 if (ret
!= LTTNG_OK
) {
2812 if (usess
&& usess
->active
) {
2813 ret
= ust_app_stop_trace_all(usess
);
2815 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2820 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2822 /* Flag inactive after a successful stop. */
2823 session
->active
= 0;
2831 * Set the base_path of the session only if subdir of a control uris is set.
2832 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2834 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2836 struct lttng_uri
*uris
)
2841 for (i
= 0; i
< nb_uri
; i
++) {
2842 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2843 uris
[i
].subdir
[0] == '\0') {
2844 /* Not interested in these URIs */
2848 if (session
->base_path
!= NULL
) {
2849 free(session
->base_path
);
2850 session
->base_path
= NULL
;
2853 /* Set session base_path */
2854 session
->base_path
= strdup(uris
[i
].subdir
);
2855 if (!session
->base_path
) {
2856 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2857 uris
[i
].subdir
, session
->name
);
2858 ret
= LTTNG_ERR_NOMEM
;
2861 DBG2("Setting base path \"%s\" for session \"%s\"",
2862 session
->base_path
, session
->name
);
2870 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2872 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2873 struct lttng_uri
*uris
)
2876 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2877 struct ltt_ust_session
*usess
= session
->ust_session
;
2883 /* Can't set consumer URI if the session is active. */
2884 if (session
->active
) {
2885 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2890 * Set the session base path if any. This is done inside
2891 * cmd_set_consumer_uri to preserve backward compatibility of the
2892 * previous session creation api vs the session descriptor api.
2894 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2895 if (ret
!= LTTNG_OK
) {
2899 /* Set the "global" consumer URIs */
2900 for (i
= 0; i
< nb_uri
; i
++) {
2901 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2903 if (ret
!= LTTNG_OK
) {
2908 /* Set UST session URIs */
2909 if (session
->ust_session
) {
2910 for (i
= 0; i
< nb_uri
; i
++) {
2911 ret
= add_uri_to_consumer(session
,
2912 session
->ust_session
->consumer
,
2913 &uris
[i
], LTTNG_DOMAIN_UST
);
2914 if (ret
!= LTTNG_OK
) {
2920 /* Set kernel session URIs */
2921 if (session
->kernel_session
) {
2922 for (i
= 0; i
< nb_uri
; i
++) {
2923 ret
= add_uri_to_consumer(session
,
2924 session
->kernel_session
->consumer
,
2925 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2926 if (ret
!= LTTNG_OK
) {
2933 * Make sure to set the session in output mode after we set URI since a
2934 * session can be created without URL (thus flagged in no output mode).
2936 session
->output_traces
= 1;
2938 ksess
->output_traces
= 1;
2942 usess
->output_traces
= 1;
2953 enum lttng_error_code
set_session_output_from_descriptor(
2954 struct ltt_session
*session
,
2955 const struct lttng_session_descriptor
*descriptor
)
2958 enum lttng_error_code ret_code
= LTTNG_OK
;
2959 enum lttng_session_descriptor_type session_type
=
2960 lttng_session_descriptor_get_type(descriptor
);
2961 enum lttng_session_descriptor_output_type output_type
=
2962 lttng_session_descriptor_get_output_type(descriptor
);
2963 struct lttng_uri uris
[2] = {};
2964 size_t uri_count
= 0;
2966 switch (output_type
) {
2967 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2969 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2970 lttng_session_descriptor_get_local_output_uri(descriptor
,
2974 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2975 lttng_session_descriptor_get_network_output_uris(descriptor
,
2976 &uris
[0], &uris
[1]);
2980 ret_code
= LTTNG_ERR_INVALID
;
2984 switch (session_type
) {
2985 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2987 struct snapshot_output
*new_output
= NULL
;
2989 new_output
= snapshot_output_alloc();
2991 ret_code
= LTTNG_ERR_NOMEM
;
2995 ret
= snapshot_output_init_with_uri(session
,
2996 DEFAULT_SNAPSHOT_MAX_SIZE
,
2997 NULL
, uris
, uri_count
, session
->consumer
,
2998 new_output
, &session
->snapshot
);
3000 ret_code
= (ret
== -ENOMEM
) ?
3001 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3002 snapshot_output_destroy(new_output
);
3005 snapshot_add_output(&session
->snapshot
, new_output
);
3008 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3009 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3011 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3015 ret_code
= LTTNG_ERR_INVALID
;
3023 enum lttng_error_code
cmd_create_session_from_descriptor(
3024 struct lttng_session_descriptor
*descriptor
,
3025 const lttng_sock_cred
*creds
,
3026 const char *home_path
)
3029 enum lttng_error_code ret_code
;
3030 const char *session_name
;
3031 struct ltt_session
*new_session
= NULL
;
3032 enum lttng_session_descriptor_status descriptor_status
;
3034 session_lock_list();
3036 if (*home_path
!= '/') {
3037 ERR("Home path provided by client is not absolute");
3038 ret_code
= LTTNG_ERR_INVALID
;
3043 descriptor_status
= lttng_session_descriptor_get_session_name(
3044 descriptor
, &session_name
);
3045 switch (descriptor_status
) {
3046 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3048 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3049 session_name
= NULL
;
3052 ret_code
= LTTNG_ERR_INVALID
;
3056 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3058 if (ret_code
!= LTTNG_OK
) {
3062 if (!session_name
) {
3063 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3066 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3071 if (!lttng_session_descriptor_is_output_destination_initialized(
3074 * Only include the session's creation time in the output
3075 * destination if the name of the session itself was
3076 * not auto-generated.
3078 ret_code
= lttng_session_descriptor_set_default_output(
3080 session_name
? &new_session
->creation_time
: NULL
,
3082 if (ret_code
!= LTTNG_OK
) {
3086 new_session
->has_user_specified_directory
=
3087 lttng_session_descriptor_has_output_directory(
3091 switch (lttng_session_descriptor_get_type(descriptor
)) {
3092 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3093 new_session
->snapshot_mode
= 1;
3095 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3096 new_session
->live_timer
=
3097 lttng_session_descriptor_live_get_timer_interval(
3104 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3105 if (ret_code
!= LTTNG_OK
) {
3108 new_session
->consumer
->enabled
= 1;
3109 ret_code
= LTTNG_OK
;
3111 /* Release reference provided by the session_create function. */
3112 session_put(new_session
);
3113 if (ret_code
!= LTTNG_OK
&& new_session
) {
3114 /* Release the global reference on error. */
3115 session_destroy(new_session
);
3117 session_unlock_list();
3121 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3122 struct lttng_session_descriptor
**return_descriptor
)
3125 size_t payload_size
;
3126 struct lttng_dynamic_buffer payload
;
3127 struct lttng_buffer_view home_dir_view
;
3128 struct lttng_buffer_view session_descriptor_view
;
3129 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3130 enum lttng_error_code ret_code
;
3132 lttng_dynamic_buffer_init(&payload
);
3133 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3135 ret_code
= LTTNG_ERR_INVALID
;
3138 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3139 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3140 ret_code
= LTTNG_ERR_INVALID
;
3144 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3145 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3146 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3148 ret_code
= LTTNG_ERR_NOMEM
;
3152 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3154 ERR("Reception of session descriptor failed, aborting.");
3155 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3159 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3162 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3163 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3165 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3166 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3168 ret
= lttng_session_descriptor_create_from_buffer(
3169 &session_descriptor_view
, &session_descriptor
);
3171 ERR("Failed to create session descriptor from payload of \"create session\" command");
3172 ret_code
= LTTNG_ERR_INVALID
;
3177 * Sets the descriptor's auto-generated properties (name, output) if
3180 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3182 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3183 if (ret_code
!= LTTNG_OK
) {
3187 ret_code
= LTTNG_OK
;
3188 *return_descriptor
= session_descriptor
;
3189 session_descriptor
= NULL
;
3191 lttng_dynamic_buffer_reset(&payload
);
3192 lttng_session_descriptor_destroy(session_descriptor
);
3197 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3198 void *_reply_context
)
3202 const struct cmd_destroy_session_reply_context
*reply_context
=
3204 struct lttng_dynamic_buffer payload
;
3205 struct lttcomm_session_destroy_command_header cmd_header
;
3206 struct lttng_trace_archive_location
*location
= NULL
;
3207 struct lttcomm_lttng_msg llm
= {
3208 .cmd_type
= LTTNG_DESTROY_SESSION
,
3209 .ret_code
= reply_context
->destruction_status
,
3212 sizeof(struct lttcomm_session_destroy_command_header
),
3215 size_t payload_size_before_location
;
3217 lttng_dynamic_buffer_init(&payload
);
3219 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3221 ERR("Failed to append session destruction message");
3225 cmd_header
.rotation_state
=
3226 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3227 session
->rotation_state
:
3228 LTTNG_ROTATION_STATE_NO_ROTATION
);
3229 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3230 sizeof(cmd_header
));
3232 ERR("Failed to append session destruction command header");
3236 if (!reply_context
->implicit_rotation_on_destroy
) {
3237 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3241 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3242 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3247 location
= session_get_trace_archive_location(session
);
3249 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3254 payload_size_before_location
= payload
.size
;
3255 comm_ret
= lttng_trace_archive_location_serialize(location
,
3258 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3262 /* Update the message to indicate the location's length. */
3263 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3264 payload
.size
- payload_size_before_location
;
3266 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3267 payload
.data
, payload
.size
);
3268 if (comm_ret
!= (ssize_t
) payload
.size
) {
3269 ERR("Failed to send result of the destruction of session \"%s\" to client",
3273 ret
= close(reply_context
->reply_sock_fd
);
3275 PERROR("Failed to close client socket in deferred session destroy reply");
3277 lttng_dynamic_buffer_reset(&payload
);
3278 free(_reply_context
);
3282 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3284 * Called with session lock held.
3286 int cmd_destroy_session(struct ltt_session
*session
,
3287 struct notification_thread_handle
*notification_thread_handle
,
3291 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3292 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3295 reply_context
= zmalloc(sizeof(*reply_context
));
3296 if (!reply_context
) {
3297 ret
= LTTNG_ERR_NOMEM
;
3300 reply_context
->reply_sock_fd
= *sock_fd
;
3306 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3308 if (session
->active
) {
3309 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3311 ret
= cmd_stop_trace(session
);
3312 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3313 /* Carry on with the destruction of the session. */
3314 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3315 session
->name
, lttng_strerror(-ret
));
3316 destruction_last_error
= ret
;
3320 if (session
->rotation_schedule_timer_enabled
) {
3321 if (timer_session_rotation_schedule_timer_stop(
3323 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3325 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3329 if (session
->rotate_size
) {
3330 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3331 session
->rotate_size
= 0;
3334 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3336 * Perform a last rotation on destruction if rotations have
3337 * occurred during the session's lifetime.
3339 ret
= cmd_rotate_session(session
, NULL
, false,
3340 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3341 if (ret
!= LTTNG_OK
) {
3342 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3343 session
->name
, lttng_strerror(-ret
));
3344 destruction_last_error
= -ret
;
3346 if (reply_context
) {
3347 reply_context
->implicit_rotation_on_destroy
= true;
3349 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3351 * The user has not triggered a session rotation. However, to
3352 * ensure all data has been consumed, the session is rotated
3353 * to a 'null' trace chunk before it is destroyed.
3355 * This is a "quiet" rotation meaning that no notification is
3356 * emitted and no renaming of the current trace chunk takes
3359 ret
= cmd_rotate_session(session
, NULL
, true,
3360 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3361 if (ret
!= LTTNG_OK
) {
3362 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3363 session
->name
, lttng_strerror(-ret
));
3364 destruction_last_error
= -ret
;
3368 if (session
->shm_path
[0]) {
3370 * When a session is created with an explicit shm_path,
3371 * the consumer daemon will create its shared memory files
3372 * at that location and will *not* unlink them. This is normal
3373 * as the intention of that feature is to make it possible
3374 * to retrieve the content of those files should a crash occur.
3376 * To ensure the content of those files can be used, the
3377 * sessiond daemon will replicate the content of the metadata
3378 * cache in a metadata file.
3380 * On clean-up, it is expected that the consumer daemon will
3381 * unlink the shared memory files and that the session daemon
3382 * will unlink the metadata file. Then, the session's directory
3383 * in the shm path can be removed.
3385 * Unfortunately, a flaw in the design of the sessiond's and
3386 * consumerd's tear down of channels makes it impossible to
3387 * determine when the sessiond _and_ the consumerd have both
3388 * destroyed their representation of a channel. For one, the
3389 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3390 * callbacks in both daemons.
3392 * However, it is also impossible for the sessiond to know when
3393 * the consumer daemon is done destroying its channel(s) since
3394 * it occurs as a reaction to the closing of the channel's file
3395 * descriptor. There is no resulting communication initiated
3396 * from the consumerd to the sessiond to confirm that the
3397 * operation is completed (and was successful).
3399 * Until this is all fixed, the session daemon checks for the
3400 * removal of the session's shm path which makes it possible
3401 * to safely advertise a session as having been destroyed.
3403 * Prior to this fix, it was not possible to reliably save
3404 * a session making use of the --shm-path option, destroy it,
3405 * and load it again. This is because the creation of the
3406 * session would fail upon seeing the session's shm path
3407 * already in existence.
3409 * Note that none of the error paths in the check for the
3410 * directory's existence return an error. This is normal
3411 * as there isn't much that can be done. The session will
3412 * be destroyed properly, except that we can't offer the
3413 * guarantee that the same session can be re-created.
3415 current_completion_handler
= &destroy_completion_handler
.handler
;
3416 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3418 sizeof(destroy_completion_handler
.shm_path
));
3423 * The session is destroyed. However, note that the command context
3424 * still holds a reference to the session, thus delaying its destruction
3425 * _at least_ up to the point when that reference is released.
3427 session_destroy(session
);
3428 if (reply_context
) {
3429 reply_context
->destruction_status
= destruction_last_error
;
3430 ret
= session_add_destroy_notifier(session
,
3431 cmd_destroy_session_reply
,
3432 (void *) reply_context
);
3434 ret
= LTTNG_ERR_FATAL
;
3446 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3448 int cmd_register_consumer(struct ltt_session
*session
,
3449 enum lttng_domain_type domain
, const char *sock_path
,
3450 struct consumer_data
*cdata
)
3453 struct consumer_socket
*socket
= NULL
;
3460 case LTTNG_DOMAIN_KERNEL
:
3462 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3466 /* Can't register a consumer if there is already one */
3467 if (ksess
->consumer_fds_sent
!= 0) {
3468 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3472 sock
= lttcomm_connect_unix_sock(sock_path
);
3474 ret
= LTTNG_ERR_CONNECT_FAIL
;
3477 cdata
->cmd_sock
= sock
;
3479 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3480 if (socket
== NULL
) {
3483 PERROR("close register consumer");
3485 cdata
->cmd_sock
= -1;
3486 ret
= LTTNG_ERR_FATAL
;
3490 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3491 if (socket
->lock
== NULL
) {
3492 PERROR("zmalloc pthread mutex");
3493 ret
= LTTNG_ERR_FATAL
;
3496 pthread_mutex_init(socket
->lock
, NULL
);
3497 socket
->registered
= 1;
3500 consumer_add_socket(socket
, ksess
->consumer
);
3503 pthread_mutex_lock(&cdata
->pid_mutex
);
3505 pthread_mutex_unlock(&cdata
->pid_mutex
);
3510 /* TODO: Userspace tracing */
3511 ret
= LTTNG_ERR_UND
;
3519 consumer_destroy_socket(socket
);
3525 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3527 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3528 struct lttng_domain
**domains
)
3533 struct lttng_ht_iter iter
;
3535 if (session
->kernel_session
!= NULL
) {
3536 DBG3("Listing domains found kernel domain");
3540 if (session
->ust_session
!= NULL
) {
3541 DBG3("Listing domains found UST global domain");
3545 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3547 if (agt
->being_used
) {
3558 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3559 if (*domains
== NULL
) {
3560 ret
= LTTNG_ERR_FATAL
;
3564 if (session
->kernel_session
!= NULL
) {
3565 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3567 /* Kernel session buffer type is always GLOBAL */
3568 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3573 if (session
->ust_session
!= NULL
) {
3574 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3575 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3579 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3581 if (agt
->being_used
) {
3582 (*domains
)[index
].type
= agt
->domain
;
3583 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3593 /* Return negative value to differentiate return code */
3599 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3601 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3602 struct ltt_session
*session
, struct lttng_channel
**channels
)
3604 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3607 case LTTNG_DOMAIN_KERNEL
:
3608 if (session
->kernel_session
!= NULL
) {
3609 nb_chan
= session
->kernel_session
->channel_count
;
3611 DBG3("Number of kernel channels %zd", nb_chan
);
3613 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3617 case LTTNG_DOMAIN_UST
:
3618 if (session
->ust_session
!= NULL
) {
3620 nb_chan
= lttng_ht_get_count(
3621 session
->ust_session
->domain_global
.channels
);
3624 DBG3("Number of UST global channels %zd", nb_chan
);
3626 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3631 ret
= -LTTNG_ERR_UND
;
3636 const size_t channel_size
= sizeof(struct lttng_channel
) +
3637 sizeof(struct lttng_channel_extended
);
3638 struct lttng_channel_extended
*channel_exts
;
3640 payload_size
= nb_chan
* channel_size
;
3641 *channels
= zmalloc(payload_size
);
3642 if (*channels
== NULL
) {
3643 ret
= -LTTNG_ERR_FATAL
;
3647 channel_exts
= ((void *) *channels
) +
3648 (nb_chan
* sizeof(struct lttng_channel
));
3649 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3650 if (ret
!= LTTNG_OK
) {
3665 * Command LTTNG_LIST_EVENTS processed by the client thread.
3667 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3668 struct ltt_session
*session
, char *channel_name
,
3669 struct lttng_event
**events
, size_t *total_size
)
3672 ssize_t nb_event
= 0;
3675 case LTTNG_DOMAIN_KERNEL
:
3676 if (session
->kernel_session
!= NULL
) {
3677 nb_event
= list_lttng_kernel_events(channel_name
,
3678 session
->kernel_session
, events
,
3682 case LTTNG_DOMAIN_UST
:
3684 if (session
->ust_session
!= NULL
) {
3685 nb_event
= list_lttng_ust_global_events(channel_name
,
3686 &session
->ust_session
->domain_global
, events
,
3691 case LTTNG_DOMAIN_LOG4J
:
3692 case LTTNG_DOMAIN_JUL
:
3693 case LTTNG_DOMAIN_PYTHON
:
3694 if (session
->ust_session
) {
3695 struct lttng_ht_iter iter
;
3699 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3700 &iter
.iter
, agt
, node
.node
) {
3701 if (agt
->domain
== domain
) {
3702 nb_event
= list_lttng_agent_events(
3712 ret
= LTTNG_ERR_UND
;
3719 /* Return negative value to differentiate return code */
3724 * Using the session list, filled a lttng_session array to send back to the
3725 * client for session listing.
3727 * The session list lock MUST be acquired before calling this function. Use
3728 * session_lock_list() and session_unlock_list().
3730 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3731 size_t session_count
, uid_t uid
, gid_t gid
)
3735 struct ltt_session
*session
;
3736 struct ltt_session_list
*list
= session_get_list();
3737 struct lttng_session_extended
*extended
=
3738 (typeof(extended
)) (&sessions
[session_count
]);
3740 DBG("Getting all available session for UID %d GID %d",
3743 * Iterate over session list and append data after the control struct in
3746 cds_list_for_each_entry(session
, &list
->head
, list
) {
3747 if (!session_get(session
)) {
3751 * Only list the sessions the user can control.
3753 if (!session_access_ok(session
, uid
, gid
) ||
3754 session
->destroyed
) {
3755 session_put(session
);
3759 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3760 struct ltt_ust_session
*usess
= session
->ust_session
;
3762 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3763 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3764 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3765 ret
= build_network_session_path(sessions
[i
].path
,
3766 sizeof(sessions
[i
].path
), session
);
3768 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3769 session
->consumer
->dst
.session_root_path
);
3772 PERROR("snprintf session path");
3773 session_put(session
);
3777 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3778 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3779 sessions
[i
].enabled
= session
->active
;
3780 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3781 sessions
[i
].live_timer_interval
= session
->live_timer
;
3782 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3783 extended
[i
].creation_time
.is_set
= 1;
3785 session_put(session
);
3790 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3791 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3793 int cmd_data_pending(struct ltt_session
*session
)
3796 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3797 struct ltt_ust_session
*usess
= session
->ust_session
;
3801 DBG("Data pending for session %s", session
->name
);
3803 /* Session MUST be stopped to ask for data availability. */
3804 if (session
->active
) {
3805 ret
= LTTNG_ERR_SESSION_STARTED
;
3809 * If stopped, just make sure we've started before else the above call
3810 * will always send that there is data pending.
3812 * The consumer assumes that when the data pending command is received,
3813 * the trace has been started before or else no output data is written
3814 * by the streams which is a condition for data pending. So, this is
3815 * *VERY* important that we don't ask the consumer before a start
3818 if (!session
->has_been_started
) {
3824 /* A rotation is still pending, we have to wait. */
3825 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3826 DBG("Rotate still pending for session %s", session
->name
);
3831 if (ksess
&& ksess
->consumer
) {
3832 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3834 /* Data is still being extracted for the kernel. */
3839 if (usess
&& usess
->consumer
) {
3840 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3842 /* Data is still being extracted for the kernel. */
3847 /* Data is ready to be read by a viewer */
3855 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3857 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3859 int cmd_snapshot_add_output(struct ltt_session
*session
,
3860 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3863 struct snapshot_output
*new_output
;
3868 DBG("Cmd snapshot add output for session %s", session
->name
);
3871 * Can't create an output if the session is not set in no-output mode.
3873 if (session
->output_traces
) {
3874 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3878 if (session
->has_non_mmap_channel
) {
3879 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3883 /* Only one output is allowed until we have the "tee" feature. */
3884 if (session
->snapshot
.nb_output
== 1) {
3885 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3889 new_output
= snapshot_output_alloc();
3891 ret
= LTTNG_ERR_NOMEM
;
3895 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3896 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3897 &session
->snapshot
);
3899 if (ret
== -ENOMEM
) {
3900 ret
= LTTNG_ERR_NOMEM
;
3902 ret
= LTTNG_ERR_INVALID
;
3908 snapshot_add_output(&session
->snapshot
, new_output
);
3910 *id
= new_output
->id
;
3917 snapshot_output_destroy(new_output
);
3923 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3925 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3927 int cmd_snapshot_del_output(struct ltt_session
*session
,
3928 const struct lttng_snapshot_output
*output
)
3931 struct snapshot_output
*sout
= NULL
;
3939 * Permission denied to create an output if the session is not
3940 * set in no output mode.
3942 if (session
->output_traces
) {
3943 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3948 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3950 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3951 } else if (*output
->name
!= '\0') {
3952 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3954 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3957 ret
= LTTNG_ERR_INVALID
;
3961 snapshot_delete_output(&session
->snapshot
, sout
);
3962 snapshot_output_destroy(sout
);
3971 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3973 * If no output is available, outputs is untouched and 0 is returned.
3975 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3977 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3978 struct lttng_snapshot_output
**outputs
)
3981 struct lttng_snapshot_output
*list
= NULL
;
3982 struct lttng_ht_iter iter
;
3983 struct snapshot_output
*output
;
3988 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3991 * Permission denied to create an output if the session is not
3992 * set in no output mode.
3994 if (session
->output_traces
) {
3995 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3999 if (session
->snapshot
.nb_output
== 0) {
4004 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4006 ret
= -LTTNG_ERR_NOMEM
;
4010 /* Copy list from session to the new list object. */
4012 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4013 output
, node
.node
) {
4014 assert(output
->consumer
);
4015 list
[idx
].id
= output
->id
;
4016 list
[idx
].max_size
= output
->max_size
;
4017 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4018 sizeof(list
[idx
].name
))) {
4019 ret
= -LTTNG_ERR_INVALID
;
4022 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4023 if (lttng_strncpy(list
[idx
].ctrl_url
,
4024 output
->consumer
->dst
.session_root_path
,
4025 sizeof(list
[idx
].ctrl_url
))) {
4026 ret
= -LTTNG_ERR_INVALID
;
4031 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4032 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4034 ret
= -LTTNG_ERR_NOMEM
;
4039 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4040 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4042 ret
= -LTTNG_ERR_NOMEM
;
4051 ret
= session
->snapshot
.nb_output
;
4060 * Check if we can regenerate the metadata for this session.
4061 * Only kernel, UST per-uid and non-live sessions are supported.
4063 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4066 int check_regenerate_metadata_support(struct ltt_session
*session
)
4072 if (session
->live_timer
!= 0) {
4073 ret
= LTTNG_ERR_LIVE_SESSION
;
4076 if (!session
->active
) {
4077 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4080 if (session
->ust_session
) {
4081 switch (session
->ust_session
->buffer_type
) {
4082 case LTTNG_BUFFER_PER_UID
:
4084 case LTTNG_BUFFER_PER_PID
:
4085 ret
= LTTNG_ERR_PER_PID_SESSION
;
4089 ret
= LTTNG_ERR_UNK
;
4093 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4094 session
->consumer
->relay_minor_version
< 8) {
4095 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4105 int clear_metadata_file(int fd
)
4110 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4111 if (lseek_ret
< 0) {
4117 ret
= ftruncate(fd
, 0);
4119 PERROR("ftruncate");
4128 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4131 struct buffer_reg_uid
*uid_reg
= NULL
;
4132 struct buffer_reg_session
*session_reg
= NULL
;
4135 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4136 struct ust_registry_session
*registry
;
4137 struct ust_registry_channel
*chan
;
4138 struct lttng_ht_iter iter_chan
;
4140 session_reg
= uid_reg
->registry
;
4141 registry
= session_reg
->reg
.ust
;
4143 pthread_mutex_lock(®istry
->lock
);
4144 registry
->metadata_len_sent
= 0;
4145 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4146 registry
->metadata_len
= 0;
4147 registry
->metadata_version
++;
4148 if (registry
->metadata_fd
> 0) {
4149 /* Clear the metadata file's content. */
4150 ret
= clear_metadata_file(registry
->metadata_fd
);
4152 pthread_mutex_unlock(®istry
->lock
);
4157 ret
= ust_metadata_session_statedump(registry
, NULL
,
4158 registry
->major
, registry
->minor
);
4160 pthread_mutex_unlock(®istry
->lock
);
4161 ERR("Failed to generate session metadata (err = %d)",
4165 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4167 struct ust_registry_event
*event
;
4168 struct lttng_ht_iter iter_event
;
4170 ret
= ust_metadata_channel_statedump(registry
, chan
);
4172 pthread_mutex_unlock(®istry
->lock
);
4173 ERR("Failed to generate channel metadata "
4177 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4179 ret
= ust_metadata_event_statedump(registry
,
4182 pthread_mutex_unlock(®istry
->lock
);
4183 ERR("Failed to generate event metadata "
4189 pthread_mutex_unlock(®istry
->lock
);
4198 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4200 * Ask the consumer to truncate the existing metadata file(s) and
4201 * then regenerate the metadata. Live and per-pid sessions are not
4202 * supported and return an error.
4204 * Return 0 on success or else a LTTNG_ERR code.
4206 int cmd_regenerate_metadata(struct ltt_session
*session
)
4212 ret
= check_regenerate_metadata_support(session
);
4217 if (session
->kernel_session
) {
4218 ret
= kernctl_session_regenerate_metadata(
4219 session
->kernel_session
->fd
);
4221 ERR("Failed to regenerate the kernel metadata");
4226 if (session
->ust_session
) {
4227 ret
= ust_regenerate_metadata(session
->ust_session
);
4229 ERR("Failed to regenerate the UST metadata");
4233 DBG("Cmd metadata regenerate for session %s", session
->name
);
4241 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4243 * Ask the tracer to regenerate a new statedump.
4245 * Return 0 on success or else a LTTNG_ERR code.
4247 int cmd_regenerate_statedump(struct ltt_session
*session
)
4253 if (!session
->active
) {
4254 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4258 if (session
->kernel_session
) {
4259 ret
= kernctl_session_regenerate_statedump(
4260 session
->kernel_session
->fd
);
4262 * Currently, the statedump in kernel can only fail if out
4266 if (ret
== -ENOMEM
) {
4267 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4269 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4271 ERR("Failed to regenerate the kernel statedump");
4276 if (session
->ust_session
) {
4277 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4279 * Currently, the statedump in UST always returns 0.
4282 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4283 ERR("Failed to regenerate the UST statedump");
4287 DBG("Cmd regenerate statedump for session %s", session
->name
);
4294 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4295 struct notification_thread_handle
*notification_thread
)
4299 ssize_t sock_recv_len
;
4300 struct lttng_trigger
*trigger
= NULL
;
4301 struct lttng_buffer_view view
;
4302 struct lttng_dynamic_buffer trigger_buffer
;
4304 lttng_dynamic_buffer_init(&trigger_buffer
);
4305 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4306 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4308 ret
= LTTNG_ERR_NOMEM
;
4312 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4314 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4315 ERR("Failed to receive \"register trigger\" command payload");
4316 /* TODO: should this be a new error enum ? */
4317 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4321 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4322 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4324 ERR("Invalid trigger payload received in \"register trigger\" command");
4325 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4329 ret
= notification_thread_command_register_trigger(notification_thread
,
4331 /* Ownership of trigger was transferred. */
4334 lttng_trigger_destroy(trigger
);
4335 lttng_dynamic_buffer_reset(&trigger_buffer
);
4339 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4340 struct notification_thread_handle
*notification_thread
)
4344 ssize_t sock_recv_len
;
4345 struct lttng_trigger
*trigger
= NULL
;
4346 struct lttng_buffer_view view
;
4347 struct lttng_dynamic_buffer trigger_buffer
;
4349 lttng_dynamic_buffer_init(&trigger_buffer
);
4350 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4351 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4353 ret
= LTTNG_ERR_NOMEM
;
4357 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4359 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4360 ERR("Failed to receive \"unregister trigger\" command payload");
4361 /* TODO: should this be a new error enum ? */
4362 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4366 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4367 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4369 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4370 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4374 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4377 lttng_trigger_destroy(trigger
);
4378 lttng_dynamic_buffer_reset(&trigger_buffer
);
4383 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4384 * snapshot output is *not* set with a remote destination.
4386 * Return LTTNG_OK on success or a LTTNG_ERR code.
4388 static enum lttng_error_code
set_relayd_for_snapshot(
4389 struct consumer_output
*output
,
4390 const struct ltt_session
*session
)
4392 enum lttng_error_code status
= LTTNG_OK
;
4393 struct lttng_ht_iter iter
;
4394 struct consumer_socket
*socket
;
4395 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4396 const char *base_path
;
4401 DBG2("Set relayd object from snapshot output");
4403 if (session
->current_trace_chunk
) {
4404 enum lttng_trace_chunk_status chunk_status
=
4405 lttng_trace_chunk_get_id(
4406 session
->current_trace_chunk
,
4407 ¤t_chunk_id
.value
);
4409 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4410 current_chunk_id
.is_set
= true;
4412 ERR("Failed to get current trace chunk id");
4413 status
= LTTNG_ERR_UNK
;
4418 /* Ignore if snapshot consumer output is not network. */
4419 if (output
->type
!= CONSUMER_DST_NET
) {
4424 * The snapshot record URI base path overrides the session
4427 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4428 base_path
= output
->dst
.net
.control
.subdir
;
4430 base_path
= session
->base_path
;
4434 * For each consumer socket, create and send the relayd object of the
4438 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4439 socket
, node
.node
) {
4440 pthread_mutex_lock(socket
->lock
);
4441 status
= send_consumer_relayd_sockets(0, session
->id
,
4443 session
->name
, session
->hostname
,
4445 session
->live_timer
,
4446 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4447 session
->creation_time
,
4448 session
->name_contains_creation_time
);
4449 pthread_mutex_unlock(socket
->lock
);
4450 if (status
!= LTTNG_OK
) {
4462 * Record a kernel snapshot.
4464 * Return LTTNG_OK on success or a LTTNG_ERR code.
4466 static enum lttng_error_code
record_kernel_snapshot(
4467 struct ltt_kernel_session
*ksess
,
4468 const struct consumer_output
*output
,
4469 const struct ltt_session
*session
,
4470 int wait
, uint64_t nb_packets_per_stream
)
4472 enum lttng_error_code status
;
4478 status
= kernel_snapshot_record(
4479 ksess
, output
, wait
, nb_packets_per_stream
);
4484 * Record a UST snapshot.
4486 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4488 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4489 const struct consumer_output
*output
,
4490 const struct ltt_session
*session
,
4491 int wait
, uint64_t nb_packets_per_stream
)
4493 enum lttng_error_code status
;
4499 status
= ust_app_snapshot_record(
4500 usess
, output
, wait
, nb_packets_per_stream
);
4505 uint64_t get_session_size_one_more_packet_per_stream(
4506 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4508 uint64_t tot_size
= 0;
4510 if (session
->kernel_session
) {
4511 struct ltt_kernel_channel
*chan
;
4512 const struct ltt_kernel_session
*ksess
=
4513 session
->kernel_session
;
4515 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4516 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4518 * Don't take channel into account if we
4519 * already grab all its packets.
4523 tot_size
+= chan
->channel
->attr
.subbuf_size
4524 * chan
->stream_count
;
4528 if (session
->ust_session
) {
4529 const struct ltt_ust_session
*usess
= session
->ust_session
;
4531 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4539 * Calculate the number of packets we can grab from each stream that
4540 * fits within the overall snapshot max size.
4542 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4543 * the number of packets per stream.
4545 * TODO: this approach is not perfect: we consider the worse case
4546 * (packet filling the sub-buffers) as an upper bound, but we could do
4547 * better if we do this calculation while we actually grab the packet
4548 * content: we would know how much padding we don't actually store into
4551 * This algorithm is currently bounded by the number of packets per
4554 * Since we call this algorithm before actually grabbing the data, it's
4555 * an approximation: for instance, applications could appear/disappear
4556 * in between this call and actually grabbing data.
4559 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4563 uint64_t cur_nb_packets
= 0;
4566 return 0; /* Infinite */
4569 size_left
= max_size
;
4571 uint64_t one_more_packet_tot_size
;
4573 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4574 session
, cur_nb_packets
);
4575 if (!one_more_packet_tot_size
) {
4576 /* We are already grabbing all packets. */
4579 size_left
-= one_more_packet_tot_size
;
4580 if (size_left
< 0) {
4585 if (!cur_nb_packets
) {
4586 /* Not enough room to grab one packet of each stream, error. */
4589 return cur_nb_packets
;
4593 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4594 const struct snapshot_output
*snapshot_output
, int wait
)
4596 int64_t nb_packets_per_stream
;
4597 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4599 enum lttng_error_code ret_code
= LTTNG_OK
;
4600 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4601 struct consumer_output
*original_ust_consumer_output
= NULL
;
4602 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4603 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4604 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4606 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4608 snapshot_output
->name
,
4609 snapshot_output
->datetime
,
4610 snapshot_output
->nb_snapshot
);
4611 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4612 ERR("Failed to format snapshot name");
4613 ret_code
= LTTNG_ERR_INVALID
;
4616 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4617 snapshot_output
->name
, session
->name
,
4618 snapshot_chunk_name
);
4619 if (!session
->kernel_session
&& !session
->ust_session
) {
4620 ERR("Failed to record snapshot as no channels exist");
4621 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4625 if (session
->kernel_session
) {
4626 original_kernel_consumer_output
=
4627 session
->kernel_session
->consumer
;
4628 snapshot_kernel_consumer_output
=
4629 consumer_copy_output(snapshot_output
->consumer
);
4630 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4631 snapshot_chunk_name
);
4632 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4633 original_kernel_consumer_output
);
4635 ERR("Failed to copy consumer sockets from snapshot output configuration");
4636 ret_code
= LTTNG_ERR_NOMEM
;
4639 ret_code
= set_relayd_for_snapshot(
4640 snapshot_kernel_consumer_output
, session
);
4641 if (ret_code
!= LTTNG_OK
) {
4642 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4645 session
->kernel_session
->consumer
=
4646 snapshot_kernel_consumer_output
;
4648 if (session
->ust_session
) {
4649 original_ust_consumer_output
= session
->ust_session
->consumer
;
4650 snapshot_ust_consumer_output
=
4651 consumer_copy_output(snapshot_output
->consumer
);
4652 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4653 snapshot_chunk_name
);
4654 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4655 original_ust_consumer_output
);
4657 ERR("Failed to copy consumer sockets from snapshot output configuration");
4658 ret_code
= LTTNG_ERR_NOMEM
;
4661 ret_code
= set_relayd_for_snapshot(
4662 snapshot_ust_consumer_output
, session
);
4663 if (ret_code
!= LTTNG_OK
) {
4664 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4667 session
->ust_session
->consumer
=
4668 snapshot_ust_consumer_output
;
4671 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4672 snapshot_kernel_consumer_output
?:
4673 snapshot_ust_consumer_output
,
4674 consumer_output_get_base_path(
4675 snapshot_output
->consumer
),
4676 snapshot_chunk_name
);
4677 if (!snapshot_trace_chunk
) {
4678 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4680 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4683 assert(!session
->current_trace_chunk
);
4684 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4685 lttng_trace_chunk_put(snapshot_trace_chunk
);
4686 snapshot_trace_chunk
= NULL
;
4688 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4690 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4694 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4695 snapshot_output
->max_size
);
4696 if (nb_packets_per_stream
< 0) {
4697 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4701 if (session
->kernel_session
) {
4702 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4703 snapshot_kernel_consumer_output
, session
,
4704 wait
, nb_packets_per_stream
);
4705 if (ret_code
!= LTTNG_OK
) {
4710 if (session
->ust_session
) {
4711 ret_code
= record_ust_snapshot(session
->ust_session
,
4712 snapshot_ust_consumer_output
, session
,
4713 wait
, nb_packets_per_stream
);
4714 if (ret_code
!= LTTNG_OK
) {
4719 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4720 ERR("Failed to release the current trace chunk of session \"%s\"",
4722 ret_code
= LTTNG_ERR_UNK
;
4725 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4726 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4728 * Don't goto end; make sure the chunk is closed for the session
4729 * to allow future snapshots.
4731 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4733 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4736 if (original_ust_consumer_output
) {
4737 session
->ust_session
->consumer
= original_ust_consumer_output
;
4739 if (original_kernel_consumer_output
) {
4740 session
->kernel_session
->consumer
=
4741 original_kernel_consumer_output
;
4743 consumer_output_put(snapshot_ust_consumer_output
);
4744 consumer_output_put(snapshot_kernel_consumer_output
);
4749 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4751 * The wait parameter is ignored so this call always wait for the snapshot to
4752 * complete before returning.
4754 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4756 int cmd_snapshot_record(struct ltt_session
*session
,
4757 const struct lttng_snapshot_output
*output
, int wait
)
4759 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4761 unsigned int snapshot_success
= 0;
4763 struct snapshot_output
*tmp_output
= NULL
;
4768 DBG("Cmd snapshot record for session %s", session
->name
);
4770 /* Get the datetime for the snapshot output directory. */
4771 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4774 cmd_ret
= LTTNG_ERR_INVALID
;
4779 * Permission denied to create an output if the session is not
4780 * set in no output mode.
4782 if (session
->output_traces
) {
4783 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4787 /* The session needs to be started at least once. */
4788 if (!session
->has_been_started
) {
4789 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4793 /* Use temporary output for the session. */
4794 if (*output
->ctrl_url
!= '\0') {
4795 tmp_output
= snapshot_output_alloc();
4797 cmd_ret
= LTTNG_ERR_NOMEM
;
4801 ret
= snapshot_output_init(session
, output
->max_size
,
4803 output
->ctrl_url
, output
->data_url
,
4807 if (ret
== -ENOMEM
) {
4808 cmd_ret
= LTTNG_ERR_NOMEM
;
4810 cmd_ret
= LTTNG_ERR_INVALID
;
4814 /* Use the global session count for the temporary snapshot. */
4815 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4817 /* Use the global datetime */
4818 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4819 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4820 if (cmd_ret
!= LTTNG_OK
) {
4823 snapshot_success
= 1;
4825 struct snapshot_output
*sout
;
4826 struct lttng_ht_iter iter
;
4829 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4830 &iter
.iter
, sout
, node
.node
) {
4831 struct snapshot_output output_copy
;
4834 * Make a local copy of the output and override output
4835 * parameters with those provided as part of the
4838 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4840 if (output
->max_size
!= (uint64_t) -1ULL) {
4841 output_copy
.max_size
= output
->max_size
;
4844 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4845 memcpy(output_copy
.datetime
, datetime
,
4848 /* Use temporary name. */
4849 if (*output
->name
!= '\0') {
4850 if (lttng_strncpy(output_copy
.name
,
4852 sizeof(output_copy
.name
))) {
4853 cmd_ret
= LTTNG_ERR_INVALID
;
4859 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4860 if (cmd_ret
!= LTTNG_OK
) {
4864 snapshot_success
= 1;
4869 if (snapshot_success
) {
4870 session
->snapshot
.nb_snapshot
++;
4872 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4877 snapshot_output_destroy(tmp_output
);
4883 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4885 int cmd_set_session_shm_path(struct ltt_session
*session
,
4886 const char *shm_path
)
4892 * Can only set shm path before session is started.
4894 if (session
->has_been_started
) {
4895 return LTTNG_ERR_SESSION_STARTED
;
4898 strncpy(session
->shm_path
, shm_path
,
4899 sizeof(session
->shm_path
));
4900 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4906 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4908 * Ask the consumer to rotate the session output directory.
4909 * The session lock must be held.
4911 * Returns LTTNG_OK on success or else a negative LTTng error code.
4913 int cmd_rotate_session(struct ltt_session
*session
,
4914 struct lttng_rotate_session_return
*rotate_return
,
4915 bool quiet_rotation
,
4916 enum lttng_trace_chunk_command_type command
)
4919 uint64_t ongoing_rotation_chunk_id
;
4920 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4921 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4922 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4923 enum lttng_trace_chunk_status chunk_status
;
4924 bool failed_to_rotate
= false;
4925 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4929 if (!session
->has_been_started
) {
4930 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4935 * Explicit rotation is not supported for live sessions.
4936 * However, live sessions can perform a quiet rotation on
4938 * Rotation is not supported for snapshot traces (no output).
4940 if ((!quiet_rotation
&& session
->live_timer
) ||
4941 !session
->output_traces
) {
4942 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4946 /* Unsupported feature in lttng-relayd before 2.11. */
4947 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
4948 (session
->consumer
->relay_major_version
== 2 &&
4949 session
->consumer
->relay_minor_version
< 11)) {
4950 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4954 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
4955 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
4956 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
4960 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4961 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4963 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4968 * After a stop, we only allow one rotation to occur, the other ones are
4969 * useless until a new start.
4971 if (session
->rotated_after_last_stop
) {
4972 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4974 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4979 * After a stop followed by a clear, disallow following rotations a they would
4980 * generate empty chunks.
4982 if (session
->cleared_after_last_stop
) {
4983 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
4985 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
4989 if (session
->active
) {
4990 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
4992 if (!new_trace_chunk
) {
4993 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4999 * The current trace chunk becomes the chunk being archived.
5001 * After this point, "chunk_being_archived" must absolutely
5002 * be closed on the consumer(s), otherwise it will never be
5003 * cleaned-up, which will result in a leak.
5005 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5006 &chunk_being_archived
);
5008 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5012 if (session
->kernel_session
) {
5013 cmd_ret
= kernel_rotate_session(session
);
5014 if (cmd_ret
!= LTTNG_OK
) {
5015 failed_to_rotate
= true;
5016 rotation_fail_code
= cmd_ret
;
5019 if (session
->ust_session
) {
5020 cmd_ret
= ust_app_rotate_session(session
);
5021 if (cmd_ret
!= LTTNG_OK
) {
5022 failed_to_rotate
= true;
5023 rotation_fail_code
= cmd_ret
;
5027 if (!session
->active
) {
5028 session
->rotated_after_last_stop
= true;
5031 if (!chunk_being_archived
) {
5032 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5034 if (failed_to_rotate
) {
5035 cmd_ret
= rotation_fail_code
;
5042 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5043 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5044 &ongoing_rotation_chunk_id
);
5045 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5047 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5048 command
, session
->last_chunk_path
);
5050 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5054 if (failed_to_rotate
) {
5055 cmd_ret
= rotation_fail_code
;
5059 session
->quiet_rotation
= quiet_rotation
;
5060 ret
= timer_session_rotation_pending_check_start(session
,
5061 DEFAULT_ROTATE_PENDING_TIMER
);
5063 cmd_ret
= LTTNG_ERR_UNK
;
5067 if (rotate_return
) {
5068 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5071 session
->chunk_being_archived
= chunk_being_archived
;
5072 chunk_being_archived
= NULL
;
5073 if (!quiet_rotation
) {
5074 ret
= notification_thread_command_session_rotation_ongoing(
5075 notification_thread_handle
,
5076 session
->name
, session
->uid
, session
->gid
,
5077 ongoing_rotation_chunk_id
);
5078 if (ret
!= LTTNG_OK
) {
5079 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5085 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5086 session
->name
, ongoing_rotation_chunk_id
);
5088 lttng_trace_chunk_put(new_trace_chunk
);
5089 lttng_trace_chunk_put(chunk_being_archived
);
5090 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5093 if (session_reset_rotation_state(session
,
5094 LTTNG_ROTATION_STATE_ERROR
)) {
5095 ERR("Failed to reset rotation state of session \"%s\"",
5102 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5104 * Check if the session has finished its rotation.
5106 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5108 int cmd_rotate_get_info(struct ltt_session
*session
,
5109 struct lttng_rotation_get_info_return
*info_return
,
5110 uint64_t rotation_id
)
5112 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5113 enum lttng_rotation_state rotation_state
;
5115 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5116 session
->most_recent_chunk_id
.value
);
5118 if (session
->chunk_being_archived
) {
5119 enum lttng_trace_chunk_status chunk_status
;
5122 chunk_status
= lttng_trace_chunk_get_id(
5123 session
->chunk_being_archived
,
5125 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5127 rotation_state
= rotation_id
== chunk_id
?
5128 LTTNG_ROTATION_STATE_ONGOING
:
5129 LTTNG_ROTATION_STATE_EXPIRED
;
5131 if (session
->last_archived_chunk_id
.is_set
&&
5132 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5133 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5135 rotation_state
= session
->rotation_state
;
5139 switch (rotation_state
) {
5140 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5141 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5144 case LTTNG_ROTATION_STATE_EXPIRED
:
5145 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5146 rotation_id
, session
->name
);
5148 case LTTNG_ROTATION_STATE_ONGOING
:
5149 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5150 rotation_id
, session
->name
);
5152 case LTTNG_ROTATION_STATE_COMPLETED
:
5156 char *current_tracing_path_reply
;
5157 size_t current_tracing_path_reply_len
;
5159 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5160 rotation_id
, session
->name
);
5162 switch (session_get_consumer_destination_type(session
)) {
5163 case CONSUMER_DST_LOCAL
:
5164 current_tracing_path_reply
=
5165 info_return
->location
.local
.absolute_path
;
5166 current_tracing_path_reply_len
=
5167 sizeof(info_return
->location
.local
.absolute_path
);
5168 info_return
->location_type
=
5169 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5170 fmt_ret
= asprintf(&chunk_path
,
5171 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5172 session_get_base_path(session
),
5173 session
->last_archived_chunk_name
);
5174 if (fmt_ret
== -1) {
5175 PERROR("Failed to format the path of the last archived trace chunk");
5176 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5177 cmd_ret
= LTTNG_ERR_UNK
;
5181 case CONSUMER_DST_NET
:
5183 uint16_t ctrl_port
, data_port
;
5185 current_tracing_path_reply
=
5186 info_return
->location
.relay
.relative_path
;
5187 current_tracing_path_reply_len
=
5188 sizeof(info_return
->location
.relay
.relative_path
);
5189 /* Currently the only supported relay protocol. */
5190 info_return
->location
.relay
.protocol
=
5191 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5193 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5194 session_get_net_consumer_hostname(session
),
5195 sizeof(info_return
->location
.relay
.host
));
5197 ERR("Failed to copy host name to rotate_get_info reply");
5198 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5199 cmd_ret
= LTTNG_ERR_SET_URL
;
5203 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5204 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5205 info_return
->location
.relay
.ports
.data
= data_port
;
5206 info_return
->location_type
=
5207 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5208 chunk_path
= strdup(session
->last_chunk_path
);
5210 ERR("Failed to allocate the path of the last archived trace chunk");
5211 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5212 cmd_ret
= LTTNG_ERR_UNK
;
5221 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5222 chunk_path
, current_tracing_path_reply_len
);
5225 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5226 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5227 cmd_ret
= LTTNG_ERR_UNK
;
5233 case LTTNG_ROTATION_STATE_ERROR
:
5234 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5235 rotation_id
, session
->name
);
5243 info_return
->status
= (int32_t) rotation_state
;
5248 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5250 * Configure the automatic rotation parameters.
5251 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5252 * 'activate' to false means deactivate the rotation schedule and validate that
5253 * 'new_value' has the same value as the currently active value.
5255 * Return 0 on success or else a positive LTTNG_ERR code.
5257 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5258 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5260 struct notification_thread_handle
*notification_thread_handle
)
5263 uint64_t *parameter_value
;
5267 DBG("Cmd rotate set schedule session %s", session
->name
);
5269 if (session
->live_timer
|| !session
->output_traces
) {
5270 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5271 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5275 switch (schedule_type
) {
5276 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5277 parameter_value
= &session
->rotate_size
;
5279 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5280 parameter_value
= &session
->rotate_timer_period
;
5281 if (new_value
>= UINT_MAX
) {
5282 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5283 new_value
, UINT_MAX
);
5284 ret
= LTTNG_ERR_INVALID
;
5289 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5290 ret
= LTTNG_ERR_INVALID
;
5294 /* Improper use of the API. */
5295 if (new_value
== -1ULL) {
5296 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5297 ret
= LTTNG_ERR_INVALID
;
5302 * As indicated in struct ltt_session's comments, a value of == 0 means
5303 * this schedule rotation type is not in use.
5305 * Reject the command if we were asked to activate a schedule that was
5308 if (activate
&& *parameter_value
!= 0) {
5309 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5310 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5315 * Reject the command if we were asked to deactivate a schedule that was
5318 if (!activate
&& *parameter_value
== 0) {
5319 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5320 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5325 * Reject the command if we were asked to deactivate a schedule that
5328 if (!activate
&& *parameter_value
!= new_value
) {
5329 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5330 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5334 *parameter_value
= activate
? new_value
: 0;
5336 switch (schedule_type
) {
5337 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5338 if (activate
&& session
->active
) {
5340 * Only start the timer if the session is active,
5341 * otherwise it will be started when the session starts.
5343 ret
= timer_session_rotation_schedule_timer_start(
5344 session
, new_value
);
5346 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5347 ret
= LTTNG_ERR_UNK
;
5351 ret
= timer_session_rotation_schedule_timer_stop(
5354 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5355 ret
= LTTNG_ERR_UNK
;
5360 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5362 ret
= subscribe_session_consumed_size_rotation(session
,
5363 new_value
, notification_thread_handle
);
5365 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5366 ret
= LTTNG_ERR_UNK
;
5370 ret
= unsubscribe_session_consumed_size_rotation(session
,
5371 notification_thread_handle
);
5373 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5374 ret
= LTTNG_ERR_UNK
;
5381 /* Would have been caught before. */
5393 /* Wait for a given path to be removed before continuing. */
5394 static enum lttng_error_code
wait_on_path(void *path_data
)
5396 const char *shm_path
= path_data
;
5398 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5404 ret
= stat(shm_path
, &st
);
5406 if (errno
!= ENOENT
) {
5407 PERROR("stat() returned an error while checking for the existence of the shm path");
5409 DBG("shm path no longer exists, completing the destruction of session");
5413 if (!S_ISDIR(st
.st_mode
)) {
5414 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5419 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5425 * Returns a pointer to a handler to run on completion of a command.
5426 * Returns NULL if no handler has to be run for the last command executed.
5428 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5430 struct cmd_completion_handler
*handler
= current_completion_handler
;
5432 current_completion_handler
= NULL
;
5437 * Init command subsystem.
5442 * Set network sequence index to 1 for streams to match a relayd
5443 * socket on the consumer side.
5445 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5446 relayd_net_seq_idx
= 1;
5447 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5449 DBG("Command subsystem initialized");