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>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
31 #include <common/compat/string.h>
32 #include <common/kernel-ctl/kernel-ctl.h>
33 #include <common/dynamic-buffer.h>
34 #include <common/buffer-view.h>
35 #include <lttng/trigger/trigger-internal.h>
36 #include <lttng/condition/condition.h>
37 #include <lttng/action/action.h>
38 #include <lttng/channel.h>
39 #include <lttng/channel-internal.h>
40 #include <lttng/rotate-internal.h>
41 #include <lttng/location-internal.h>
42 #include <lttng/userspace-probe-internal.h>
43 #include <common/string-utils/string-utils.h>
48 #include "health-sessiond.h"
50 #include "kernel-consumer.h"
51 #include "lttng-sessiond.h"
53 #include "lttng-syscall.h"
55 #include "buffer-registry.h"
56 #include "notification-thread.h"
57 #include "notification-thread-commands.h"
59 #include "rotation-thread.h"
60 #include "sessiond-timer.h"
61 #include "agent-thread.h"
65 /* Sleep for 100ms between each check for the shm path's deletion. */
66 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
68 static enum lttng_error_code
wait_on_path(void *path
);
71 * Command completion handler that is used by the destroy command
72 * when a session that has a non-default shm_path is being destroyed.
74 * See comment in cmd_destroy_session() for the rationale.
76 static struct destroy_completion_handler
{
77 struct cmd_completion_handler handler
;
78 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
79 } destroy_completion_handler
= {
82 .data
= destroy_completion_handler
.shm_path
87 static struct cmd_completion_handler
*current_completion_handler
;
90 * Used to keep a unique index for each relayd socket created where this value
91 * is associated with streams on the consumer so it can match the right relayd
92 * to send to. It must be accessed with the relayd_net_seq_idx_lock
95 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
96 static uint64_t relayd_net_seq_idx
;
98 static int validate_ust_event_name(const char *);
99 static int cmd_enable_event_internal(struct ltt_session
*session
,
100 struct lttng_domain
*domain
,
101 char *channel_name
, struct lttng_event
*event
,
102 char *filter_expression
,
103 struct lttng_filter_bytecode
*filter
,
104 struct lttng_event_exclusion
*exclusion
,
108 * Create a session path used by list_lttng_sessions for the case that the
109 * session consumer is on the network.
111 static int build_network_session_path(char *dst
, size_t size
,
112 struct ltt_session
*session
)
114 int ret
, kdata_port
, udata_port
;
115 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
116 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
121 memset(tmp_urls
, 0, sizeof(tmp_urls
));
122 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
124 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
126 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
127 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
128 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
131 if (session
->ust_session
&& session
->ust_session
->consumer
) {
132 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
133 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
136 if (uuri
== NULL
&& kuri
== NULL
) {
137 uri
= &session
->consumer
->dst
.net
.control
;
138 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
139 } else if (kuri
&& uuri
) {
140 ret
= uri_compare(kuri
, uuri
);
144 /* Build uuri URL string */
145 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
152 } else if (kuri
&& uuri
== NULL
) {
154 } else if (uuri
&& kuri
== NULL
) {
158 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
164 * Do we have a UST url set. If yes, this means we have both kernel and UST
167 if (*tmp_uurl
!= '\0') {
168 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
169 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
172 if (kuri
|| (!kuri
&& !uuri
)) {
175 /* No kernel URI, use the UST port. */
178 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
186 * Get run-time attributes if the session has been started (discarded events,
189 static int get_kernel_runtime_stats(struct ltt_session
*session
,
190 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
191 uint64_t *lost_packets
)
195 if (!session
->has_been_started
) {
197 *discarded_events
= 0;
202 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
203 session
->kernel_session
->consumer
,
209 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
210 session
->kernel_session
->consumer
,
221 * Get run-time attributes if the session has been started (discarded events,
224 static int get_ust_runtime_stats(struct ltt_session
*session
,
225 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
226 uint64_t *lost_packets
)
229 struct ltt_ust_session
*usess
;
231 if (!discarded_events
|| !lost_packets
) {
236 usess
= session
->ust_session
;
237 assert(discarded_events
);
238 assert(lost_packets
);
240 if (!usess
|| !session
->has_been_started
) {
241 *discarded_events
= 0;
247 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
248 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
249 &usess
->buffer_reg_uid_list
,
250 usess
->consumer
, uchan
->id
,
251 uchan
->attr
.overwrite
,
254 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
255 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
256 uchan
, usess
->consumer
,
257 uchan
->attr
.overwrite
,
263 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
264 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
266 ERR("Unsupported buffer type");
277 * Fill lttng_channel array of all channels.
279 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
280 struct ltt_session
*session
, struct lttng_channel
*channels
,
281 struct lttng_channel_extended
*chan_exts
)
284 struct ltt_kernel_channel
*kchan
;
286 DBG("Listing channels for session %s", session
->name
);
289 case LTTNG_DOMAIN_KERNEL
:
290 /* Kernel channels */
291 if (session
->kernel_session
!= NULL
) {
292 cds_list_for_each_entry(kchan
,
293 &session
->kernel_session
->channel_list
.head
, list
) {
294 uint64_t discarded_events
, lost_packets
;
295 struct lttng_channel_extended
*extended
;
297 extended
= (struct lttng_channel_extended
*)
298 kchan
->channel
->attr
.extended
.ptr
;
300 ret
= get_kernel_runtime_stats(session
, kchan
,
301 &discarded_events
, &lost_packets
);
305 /* Copy lttng_channel struct to array */
306 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
307 channels
[i
].enabled
= kchan
->enabled
;
308 chan_exts
[i
].discarded_events
=
310 chan_exts
[i
].lost_packets
= lost_packets
;
311 chan_exts
[i
].monitor_timer_interval
=
312 extended
->monitor_timer_interval
;
313 chan_exts
[i
].blocking_timeout
= 0;
318 case LTTNG_DOMAIN_UST
:
320 struct lttng_ht_iter iter
;
321 struct ltt_ust_channel
*uchan
;
324 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
325 &iter
.iter
, uchan
, node
.node
) {
326 uint64_t discarded_events
= 0, lost_packets
= 0;
328 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
329 LTTNG_SYMBOL_NAME_LEN
)) {
332 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
333 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
334 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
335 channels
[i
].attr
.switch_timer_interval
=
336 uchan
->attr
.switch_timer_interval
;
337 channels
[i
].attr
.read_timer_interval
=
338 uchan
->attr
.read_timer_interval
;
339 channels
[i
].enabled
= uchan
->enabled
;
340 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
341 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
344 * Map enum lttng_ust_output to enum lttng_event_output.
346 switch (uchan
->attr
.output
) {
348 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
352 * LTTNG_UST_MMAP is the only supported UST
359 chan_exts
[i
].monitor_timer_interval
=
360 uchan
->monitor_timer_interval
;
361 chan_exts
[i
].blocking_timeout
=
362 uchan
->attr
.u
.s
.blocking_timeout
;
364 ret
= get_ust_runtime_stats(session
, uchan
,
365 &discarded_events
, &lost_packets
);
369 chan_exts
[i
].discarded_events
= discarded_events
;
370 chan_exts
[i
].lost_packets
= lost_packets
;
382 return -LTTNG_ERR_FATAL
;
388 static int increment_extended_len(const char *filter_expression
,
389 struct lttng_event_exclusion
*exclusion
,
390 const struct lttng_userspace_probe_location
*probe_location
,
391 size_t *extended_len
)
395 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
397 if (filter_expression
) {
398 *extended_len
+= strlen(filter_expression
) + 1;
402 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
405 if (probe_location
) {
406 ret
= lttng_userspace_probe_location_serialize(probe_location
,
411 *extended_len
+= ret
;
418 static int append_extended_info(const char *filter_expression
,
419 struct lttng_event_exclusion
*exclusion
,
420 struct lttng_userspace_probe_location
*probe_location
,
424 size_t filter_len
= 0;
425 size_t nb_exclusions
= 0;
426 size_t userspace_probe_location_len
= 0;
427 struct lttng_dynamic_buffer location_buffer
;
428 struct lttcomm_event_extended_header extended_header
;
430 if (filter_expression
) {
431 filter_len
= strlen(filter_expression
) + 1;
435 nb_exclusions
= exclusion
->count
;
438 if (probe_location
) {
439 lttng_dynamic_buffer_init(&location_buffer
);
440 ret
= lttng_userspace_probe_location_serialize(probe_location
,
441 &location_buffer
, NULL
);
446 userspace_probe_location_len
= location_buffer
.size
;
449 /* Set header fields */
450 extended_header
.filter_len
= filter_len
;
451 extended_header
.nb_exclusions
= nb_exclusions
;
452 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
455 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
456 *extended_at
+= sizeof(extended_header
);
458 /* Copy filter string */
459 if (filter_expression
) {
460 memcpy(*extended_at
, filter_expression
, filter_len
);
461 *extended_at
+= filter_len
;
464 /* Copy exclusion names */
466 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
468 memcpy(*extended_at
, &exclusion
->names
, len
);
472 if (probe_location
) {
473 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
474 *extended_at
+= location_buffer
.size
;
475 lttng_dynamic_buffer_reset(&location_buffer
);
483 * Create a list of agent domain events.
485 * Return number of events in list on success or else a negative value.
487 static int list_lttng_agent_events(struct agent
*agt
,
488 struct lttng_event
**events
, size_t *total_size
)
491 unsigned int nb_event
= 0;
492 struct agent_event
*event
;
493 struct lttng_event
*tmp_events
;
494 struct lttng_ht_iter iter
;
495 size_t extended_len
= 0;
501 DBG3("Listing agent events");
504 nb_event
= lttng_ht_get_count(agt
->events
);
512 /* Compute required extended infos size */
513 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
516 * This is only valid because the commands which add events are
517 * processed in the same thread as the listing.
520 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
521 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
524 DBG("Error computing the length of extended info message");
525 ret
= -LTTNG_ERR_FATAL
;
531 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
532 tmp_events
= zmalloc(*total_size
);
534 PERROR("zmalloc agent events session");
535 ret
= -LTTNG_ERR_FATAL
;
539 extended_at
= ((uint8_t *) tmp_events
) +
540 nb_event
* sizeof(struct lttng_event
);
543 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
544 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
545 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
546 tmp_events
[i
].enabled
= event
->enabled
;
547 tmp_events
[i
].loglevel
= event
->loglevel_value
;
548 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
551 /* Append extended info */
552 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
555 DBG("Error appending extended info message");
556 ret
= -LTTNG_ERR_FATAL
;
561 *events
= tmp_events
;
563 assert(nb_event
== i
);
571 * Create a list of ust global domain events.
573 static int list_lttng_ust_global_events(char *channel_name
,
574 struct ltt_ust_domain_global
*ust_global
,
575 struct lttng_event
**events
, size_t *total_size
)
578 unsigned int nb_event
= 0;
579 struct lttng_ht_iter iter
;
580 struct lttng_ht_node_str
*node
;
581 struct ltt_ust_channel
*uchan
;
582 struct ltt_ust_event
*uevent
;
583 struct lttng_event
*tmp
;
584 size_t extended_len
= 0;
587 DBG("Listing UST global events for channel %s", channel_name
);
591 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
592 node
= lttng_ht_iter_get_node_str(&iter
);
594 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
598 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
600 nb_event
= lttng_ht_get_count(uchan
->events
);
607 DBG3("Listing UST global %d events", nb_event
);
609 /* Compute required extended infos size */
610 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
611 if (uevent
->internal
) {
616 ret
= increment_extended_len(uevent
->filter_expression
,
617 uevent
->exclusion
, NULL
, &extended_len
);
619 DBG("Error computing the length of extended info message");
620 ret
= -LTTNG_ERR_FATAL
;
625 /* All events are internal, skip. */
631 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
632 tmp
= zmalloc(*total_size
);
634 ret
= -LTTNG_ERR_FATAL
;
638 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
640 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
641 if (uevent
->internal
) {
642 /* This event should remain hidden from clients */
645 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
646 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
647 tmp
[i
].enabled
= uevent
->enabled
;
649 switch (uevent
->attr
.instrumentation
) {
650 case LTTNG_UST_TRACEPOINT
:
651 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
653 case LTTNG_UST_PROBE
:
654 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
656 case LTTNG_UST_FUNCTION
:
657 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
661 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
662 switch (uevent
->attr
.loglevel_type
) {
663 case LTTNG_UST_LOGLEVEL_ALL
:
664 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
666 case LTTNG_UST_LOGLEVEL_RANGE
:
667 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
669 case LTTNG_UST_LOGLEVEL_SINGLE
:
670 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
673 if (uevent
->filter
) {
676 if (uevent
->exclusion
) {
677 tmp
[i
].exclusion
= 1;
681 /* Append extended info */
682 ret
= append_extended_info(uevent
->filter_expression
,
683 uevent
->exclusion
, NULL
, &extended_at
);
685 DBG("Error appending extended info message");
686 ret
= -LTTNG_ERR_FATAL
;
699 * Fill lttng_event array of all kernel events in the channel.
701 static int list_lttng_kernel_events(char *channel_name
,
702 struct ltt_kernel_session
*kernel_session
,
703 struct lttng_event
**events
, size_t *total_size
)
706 unsigned int nb_event
;
707 struct ltt_kernel_event
*event
;
708 struct ltt_kernel_channel
*kchan
;
709 size_t extended_len
= 0;
712 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
714 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
718 nb_event
= kchan
->event_count
;
720 DBG("Listing events for channel %s", kchan
->channel
->name
);
728 /* Compute required extended infos size */
729 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
730 ret
= increment_extended_len(event
->filter_expression
, NULL
,
731 event
->userspace_probe_location
,
734 DBG("Error computing the length of extended info message");
735 ret
= -LTTNG_ERR_FATAL
;
740 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
741 *events
= zmalloc(*total_size
);
742 if (*events
== NULL
) {
743 ret
= -LTTNG_ERR_FATAL
;
747 extended_at
= ((void *) *events
) +
748 nb_event
* sizeof(struct lttng_event
);
750 /* Kernel channels */
751 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
752 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
753 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
754 (*events
)[i
].enabled
= event
->enabled
;
755 (*events
)[i
].filter
=
756 (unsigned char) !!event
->filter_expression
;
758 switch (event
->event
->instrumentation
) {
759 case LTTNG_KERNEL_TRACEPOINT
:
760 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
762 case LTTNG_KERNEL_KRETPROBE
:
763 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
764 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
765 sizeof(struct lttng_kernel_kprobe
));
767 case LTTNG_KERNEL_KPROBE
:
768 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
769 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
770 sizeof(struct lttng_kernel_kprobe
));
772 case LTTNG_KERNEL_UPROBE
:
773 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
775 case LTTNG_KERNEL_FUNCTION
:
776 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
777 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
778 sizeof(struct lttng_kernel_function
));
780 case LTTNG_KERNEL_NOOP
:
781 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
783 case LTTNG_KERNEL_SYSCALL
:
784 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
786 case LTTNG_KERNEL_ALL
:
794 /* Append extended info */
795 ret
= append_extended_info(event
->filter_expression
, NULL
,
796 event
->userspace_probe_location
, &extended_at
);
798 DBG("Error appending extended info message");
799 ret
= -LTTNG_ERR_FATAL
;
808 /* Negate the error code to differentiate the size from an error */
813 * Add URI so the consumer output object. Set the correct path depending on the
814 * domain adding the default trace directory.
816 static int add_uri_to_consumer(struct consumer_output
*consumer
,
817 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
818 const char *session_name
)
821 const char *default_trace_dir
;
825 if (consumer
== NULL
) {
826 DBG("No consumer detected. Don't add URI. Stopping.");
827 ret
= LTTNG_ERR_NO_CONSUMER
;
832 case LTTNG_DOMAIN_KERNEL
:
833 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
835 case LTTNG_DOMAIN_UST
:
836 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
840 * This case is possible is we try to add the URI to the global tracing
841 * session consumer object which in this case there is no subdir.
843 default_trace_dir
= "";
846 switch (uri
->dtype
) {
849 DBG2("Setting network URI to consumer");
851 if (consumer
->type
== CONSUMER_DST_NET
) {
852 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
853 consumer
->dst
.net
.control_isset
) ||
854 (uri
->stype
== LTTNG_STREAM_DATA
&&
855 consumer
->dst
.net
.data_isset
)) {
856 ret
= LTTNG_ERR_URL_EXIST
;
860 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
863 consumer
->type
= CONSUMER_DST_NET
;
865 /* Set URI into consumer output object */
866 ret
= consumer_set_network_uri(consumer
, uri
);
870 } else if (ret
== 1) {
872 * URI was the same in the consumer so we do not append the subdir
873 * again so to not duplicate output dir.
879 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
880 ret
= consumer_set_subdir(consumer
, session_name
);
882 ret
= LTTNG_ERR_FATAL
;
887 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
888 /* On a new subdir, reappend the default trace dir. */
889 strncat(consumer
->subdir
, default_trace_dir
,
890 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
891 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
896 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
897 memset(consumer
->dst
.session_root_path
, 0,
898 sizeof(consumer
->dst
.session_root_path
));
899 /* Explicit length checks for strcpy and strcat. */
900 if (strlen(uri
->dst
.path
) + strlen(default_trace_dir
)
901 >= sizeof(consumer
->dst
.session_root_path
)) {
902 ret
= LTTNG_ERR_FATAL
;
905 strcpy(consumer
->dst
.session_root_path
, uri
->dst
.path
);
906 /* Append default trace dir */
907 strcat(consumer
->dst
.session_root_path
, default_trace_dir
);
908 /* Flag consumer as local. */
909 consumer
->type
= CONSUMER_DST_LOCAL
;
920 * Init tracing by creating trace directory and sending fds kernel consumer.
922 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
925 struct lttng_ht_iter iter
;
926 struct consumer_socket
*socket
;
932 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
933 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
935 pthread_mutex_lock(socket
->lock
);
936 ret
= kernel_consumer_send_session(socket
, session
);
937 pthread_mutex_unlock(socket
->lock
);
939 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
951 * Create a socket to the relayd using the URI.
953 * On success, the relayd_sock pointer is set to the created socket.
954 * Else, it's stays untouched and a lttcomm error code is returned.
956 static int create_connect_relayd(struct lttng_uri
*uri
,
957 struct lttcomm_relayd_sock
**relayd_sock
,
958 struct consumer_output
*consumer
)
961 struct lttcomm_relayd_sock
*rsock
;
963 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
964 RELAYD_VERSION_COMM_MINOR
);
966 ret
= LTTNG_ERR_FATAL
;
971 * Connect to relayd so we can proceed with a session creation. This call
972 * can possibly block for an arbitrary amount of time to set the health
973 * state to be in poll execution.
976 ret
= relayd_connect(rsock
);
979 ERR("Unable to reach lttng-relayd");
980 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
984 /* Create socket for control stream. */
985 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
986 DBG3("Creating relayd stream socket from URI");
988 /* Check relayd version */
989 ret
= relayd_version_check(rsock
);
990 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
992 } else if (ret
< 0) {
993 ERR("Unable to reach lttng-relayd");
994 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
997 consumer
->relay_major_version
= rsock
->major
;
998 consumer
->relay_minor_version
= rsock
->minor
;
999 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1000 DBG3("Creating relayd data socket from URI");
1002 /* Command is not valid */
1003 ERR("Relayd invalid stream type: %d", uri
->stype
);
1004 ret
= LTTNG_ERR_INVALID
;
1008 *relayd_sock
= rsock
;
1013 /* The returned value is not useful since we are on an error path. */
1014 (void) relayd_close(rsock
);
1022 * Connect to the relayd using URI and send the socket to the right consumer.
1024 * The consumer socket lock must be held by the caller.
1026 static int send_consumer_relayd_socket(unsigned int session_id
,
1027 struct lttng_uri
*relayd_uri
,
1028 struct consumer_output
*consumer
,
1029 struct consumer_socket
*consumer_sock
,
1030 char *session_name
, char *hostname
, int session_live_timer
)
1033 struct lttcomm_relayd_sock
*rsock
= NULL
;
1035 /* Connect to relayd and make version check if uri is the control. */
1036 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1037 if (ret
!= LTTNG_OK
) {
1038 goto relayd_comm_error
;
1042 /* Set the network sequence index if not set. */
1043 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1044 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1046 * Increment net_seq_idx because we are about to transfer the
1047 * new relayd socket to the consumer.
1048 * Assign unique key so the consumer can match streams.
1050 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1051 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1054 /* Send relayd socket to consumer. */
1055 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1056 relayd_uri
->stype
, session_id
,
1057 session_name
, hostname
, session_live_timer
);
1059 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1063 /* Flag that the corresponding socket was sent. */
1064 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1065 consumer_sock
->control_sock_sent
= 1;
1066 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1067 consumer_sock
->data_sock_sent
= 1;
1073 * Close socket which was dup on the consumer side. The session daemon does
1074 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1078 if (ret
!= LTTNG_OK
) {
1080 * The consumer output for this session should not be used anymore
1081 * since the relayd connection failed thus making any tracing or/and
1082 * streaming not usable.
1084 consumer
->enabled
= 0;
1086 (void) relayd_close(rsock
);
1094 * Send both relayd sockets to a specific consumer and domain. This is a
1095 * helper function to facilitate sending the information to the consumer for a
1098 * The consumer socket lock must be held by the caller.
1100 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
1101 unsigned int session_id
, struct consumer_output
*consumer
,
1102 struct consumer_socket
*sock
, char *session_name
,
1103 char *hostname
, int session_live_timer
)
1110 /* Sending control relayd socket. */
1111 if (!sock
->control_sock_sent
) {
1112 ret
= send_consumer_relayd_socket(session_id
,
1113 &consumer
->dst
.net
.control
, consumer
, sock
,
1114 session_name
, hostname
, session_live_timer
);
1115 if (ret
!= LTTNG_OK
) {
1120 /* Sending data relayd socket. */
1121 if (!sock
->data_sock_sent
) {
1122 ret
= send_consumer_relayd_socket(session_id
,
1123 &consumer
->dst
.net
.data
, consumer
, sock
,
1124 session_name
, hostname
, session_live_timer
);
1125 if (ret
!= LTTNG_OK
) {
1135 * Setup relayd connections for a tracing session. First creates the socket to
1136 * the relayd and send them to the right domain consumer. Consumer type MUST be
1139 int cmd_setup_relayd(struct ltt_session
*session
)
1142 struct ltt_ust_session
*usess
;
1143 struct ltt_kernel_session
*ksess
;
1144 struct consumer_socket
*socket
;
1145 struct lttng_ht_iter iter
;
1149 usess
= session
->ust_session
;
1150 ksess
= session
->kernel_session
;
1152 DBG("Setting relayd for session %s", session
->name
);
1156 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1157 && usess
->consumer
->enabled
) {
1158 /* For each consumer socket, send relayd sockets */
1159 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1160 socket
, node
.node
) {
1161 pthread_mutex_lock(socket
->lock
);
1162 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1163 usess
->consumer
, socket
,
1164 session
->name
, session
->hostname
,
1165 session
->live_timer
);
1166 pthread_mutex_unlock(socket
->lock
);
1167 if (ret
!= LTTNG_OK
) {
1170 /* Session is now ready for network streaming. */
1171 session
->net_handle
= 1;
1173 session
->consumer
->relay_major_version
=
1174 usess
->consumer
->relay_major_version
;
1175 session
->consumer
->relay_minor_version
=
1176 usess
->consumer
->relay_minor_version
;
1179 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1180 && ksess
->consumer
->enabled
) {
1181 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1182 socket
, node
.node
) {
1183 pthread_mutex_lock(socket
->lock
);
1184 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1185 ksess
->consumer
, socket
,
1186 session
->name
, session
->hostname
,
1187 session
->live_timer
);
1188 pthread_mutex_unlock(socket
->lock
);
1189 if (ret
!= LTTNG_OK
) {
1192 /* Session is now ready for network streaming. */
1193 session
->net_handle
= 1;
1195 session
->consumer
->relay_major_version
=
1196 ksess
->consumer
->relay_major_version
;
1197 session
->consumer
->relay_minor_version
=
1198 ksess
->consumer
->relay_minor_version
;
1207 * Start a kernel session by opening all necessary streams.
1209 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1212 struct ltt_kernel_channel
*kchan
;
1214 /* Open kernel metadata */
1215 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1216 ret
= kernel_open_metadata(ksess
);
1218 ret
= LTTNG_ERR_KERN_META_FAIL
;
1223 /* Open kernel metadata stream */
1224 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1225 ret
= kernel_open_metadata_stream(ksess
);
1227 ERR("Kernel create metadata stream failed");
1228 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1233 /* For each channel */
1234 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1235 if (kchan
->stream_count
== 0) {
1236 ret
= kernel_open_channel_stream(kchan
);
1238 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1241 /* Update the stream global counter */
1242 ksess
->stream_count_global
+= ret
;
1246 /* Setup kernel consumer socket and send fds to it */
1247 ret
= init_kernel_tracing(ksess
);
1249 ret
= LTTNG_ERR_KERN_START_FAIL
;
1253 /* This start the kernel tracing */
1254 ret
= kernel_start_session(ksess
);
1256 ret
= LTTNG_ERR_KERN_START_FAIL
;
1260 /* Quiescent wait after starting trace */
1261 kernel_wait_quiescent(wpipe
);
1272 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1274 int cmd_disable_channel(struct ltt_session
*session
,
1275 enum lttng_domain_type domain
, char *channel_name
)
1278 struct ltt_ust_session
*usess
;
1280 usess
= session
->ust_session
;
1285 case LTTNG_DOMAIN_KERNEL
:
1287 ret
= channel_kernel_disable(session
->kernel_session
,
1289 if (ret
!= LTTNG_OK
) {
1293 kernel_wait_quiescent(kernel_tracer_fd
);
1296 case LTTNG_DOMAIN_UST
:
1298 struct ltt_ust_channel
*uchan
;
1299 struct lttng_ht
*chan_ht
;
1301 chan_ht
= usess
->domain_global
.channels
;
1303 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1304 if (uchan
== NULL
) {
1305 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1309 ret
= channel_ust_disable(usess
, uchan
);
1310 if (ret
!= LTTNG_OK
) {
1316 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1328 * Command LTTNG_TRACK_PID processed by the client thread.
1330 * Called with session lock held.
1332 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1340 case LTTNG_DOMAIN_KERNEL
:
1342 struct ltt_kernel_session
*ksess
;
1344 ksess
= session
->kernel_session
;
1346 ret
= kernel_track_pid(ksess
, pid
);
1347 if (ret
!= LTTNG_OK
) {
1351 kernel_wait_quiescent(kernel_tracer_fd
);
1354 case LTTNG_DOMAIN_UST
:
1356 struct ltt_ust_session
*usess
;
1358 usess
= session
->ust_session
;
1360 ret
= trace_ust_track_pid(usess
, pid
);
1361 if (ret
!= LTTNG_OK
) {
1367 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1379 * Command LTTNG_UNTRACK_PID processed by the client thread.
1381 * Called with session lock held.
1383 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1391 case LTTNG_DOMAIN_KERNEL
:
1393 struct ltt_kernel_session
*ksess
;
1395 ksess
= session
->kernel_session
;
1397 ret
= kernel_untrack_pid(ksess
, pid
);
1398 if (ret
!= LTTNG_OK
) {
1402 kernel_wait_quiescent(kernel_tracer_fd
);
1405 case LTTNG_DOMAIN_UST
:
1407 struct ltt_ust_session
*usess
;
1409 usess
= session
->ust_session
;
1411 ret
= trace_ust_untrack_pid(usess
, pid
);
1412 if (ret
!= LTTNG_OK
) {
1418 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1430 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1432 * The wpipe arguments is used as a notifier for the kernel thread.
1434 int cmd_enable_channel(struct ltt_session
*session
,
1435 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1438 struct ltt_ust_session
*usess
= session
->ust_session
;
1439 struct lttng_ht
*chan_ht
;
1446 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1448 /* Validate channel name */
1449 if (attr
->name
[0] == '.' ||
1450 memchr(attr
->name
, '/', len
) != NULL
) {
1451 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1455 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1460 * Don't try to enable a channel if the session has been started at
1461 * some point in time before. The tracer does not allow it.
1463 if (session
->has_been_started
) {
1464 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1469 * If the session is a live session, remove the switch timer, the
1470 * live timer does the same thing but sends also synchronisation
1471 * beacons for inactive streams.
1473 if (session
->live_timer
> 0) {
1474 attr
->attr
.live_timer_interval
= session
->live_timer
;
1475 attr
->attr
.switch_timer_interval
= 0;
1478 /* Check for feature support */
1479 switch (domain
->type
) {
1480 case LTTNG_DOMAIN_KERNEL
:
1482 if (kernel_supports_ring_buffer_snapshot_sample_positions(kernel_tracer_fd
) != 1) {
1483 /* Sampling position of buffer is not supported */
1484 WARN("Kernel tracer does not support buffer monitoring. "
1485 "Setting the monitor interval timer to 0 "
1486 "(disabled) for channel '%s' of session '%s'",
1487 attr
-> name
, session
->name
);
1488 lttng_channel_set_monitor_timer_interval(attr
, 0);
1492 case LTTNG_DOMAIN_UST
:
1494 case LTTNG_DOMAIN_JUL
:
1495 case LTTNG_DOMAIN_LOG4J
:
1496 case LTTNG_DOMAIN_PYTHON
:
1497 if (!agent_tracing_is_enabled()) {
1498 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1499 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1504 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1508 switch (domain
->type
) {
1509 case LTTNG_DOMAIN_KERNEL
:
1511 struct ltt_kernel_channel
*kchan
;
1513 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1514 session
->kernel_session
);
1515 if (kchan
== NULL
) {
1516 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1517 if (attr
->name
[0] != '\0') {
1518 session
->kernel_session
->has_non_default_channel
= 1;
1521 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1524 if (ret
!= LTTNG_OK
) {
1528 kernel_wait_quiescent(kernel_tracer_fd
);
1531 case LTTNG_DOMAIN_UST
:
1532 case LTTNG_DOMAIN_JUL
:
1533 case LTTNG_DOMAIN_LOG4J
:
1534 case LTTNG_DOMAIN_PYTHON
:
1536 struct ltt_ust_channel
*uchan
;
1541 * Current agent implementation limitations force us to allow
1542 * only one channel at once in "agent" subdomains. Each
1543 * subdomain has a default channel name which must be strictly
1546 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1547 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1548 LTTNG_SYMBOL_NAME_LEN
)) {
1549 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1552 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1553 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1554 LTTNG_SYMBOL_NAME_LEN
)) {
1555 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1558 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1559 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1560 LTTNG_SYMBOL_NAME_LEN
)) {
1561 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1566 chan_ht
= usess
->domain_global
.channels
;
1568 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1569 if (uchan
== NULL
) {
1570 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1571 if (attr
->name
[0] != '\0') {
1572 usess
->has_non_default_channel
= 1;
1575 ret
= channel_ust_enable(usess
, uchan
);
1580 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1591 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1593 int cmd_disable_event(struct ltt_session
*session
,
1594 enum lttng_domain_type domain
, char *channel_name
,
1595 struct lttng_event
*event
)
1600 DBG("Disable event command for event \'%s\'", event
->name
);
1602 event_name
= event
->name
;
1604 /* Error out on unhandled search criteria */
1605 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1606 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1607 ret
= LTTNG_ERR_UNK
;
1614 case LTTNG_DOMAIN_KERNEL
:
1616 struct ltt_kernel_channel
*kchan
;
1617 struct ltt_kernel_session
*ksess
;
1619 ksess
= session
->kernel_session
;
1622 * If a non-default channel has been created in the
1623 * session, explicitely require that -c chan_name needs
1626 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1627 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1631 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1632 if (kchan
== NULL
) {
1633 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1637 switch (event
->type
) {
1638 case LTTNG_EVENT_ALL
:
1639 case LTTNG_EVENT_TRACEPOINT
:
1640 case LTTNG_EVENT_SYSCALL
:
1641 case LTTNG_EVENT_PROBE
:
1642 case LTTNG_EVENT_FUNCTION
:
1643 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1644 if (event_name
[0] == '\0') {
1645 ret
= event_kernel_disable_event(kchan
,
1648 ret
= event_kernel_disable_event(kchan
,
1649 event_name
, event
->type
);
1651 if (ret
!= LTTNG_OK
) {
1656 ret
= LTTNG_ERR_UNK
;
1660 kernel_wait_quiescent(kernel_tracer_fd
);
1663 case LTTNG_DOMAIN_UST
:
1665 struct ltt_ust_channel
*uchan
;
1666 struct ltt_ust_session
*usess
;
1668 usess
= session
->ust_session
;
1670 if (validate_ust_event_name(event_name
)) {
1671 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1676 * If a non-default channel has been created in the
1677 * session, explicitly require that -c chan_name needs
1680 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1681 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1685 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1687 if (uchan
== NULL
) {
1688 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1692 switch (event
->type
) {
1693 case LTTNG_EVENT_ALL
:
1695 * An empty event name means that everything
1696 * should be disabled.
1698 if (event
->name
[0] == '\0') {
1699 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1701 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1704 if (ret
!= LTTNG_OK
) {
1709 ret
= LTTNG_ERR_UNK
;
1713 DBG3("Disable UST event %s in channel %s completed", event_name
,
1717 case LTTNG_DOMAIN_LOG4J
:
1718 case LTTNG_DOMAIN_JUL
:
1719 case LTTNG_DOMAIN_PYTHON
:
1722 struct ltt_ust_session
*usess
= session
->ust_session
;
1726 switch (event
->type
) {
1727 case LTTNG_EVENT_ALL
:
1730 ret
= LTTNG_ERR_UNK
;
1734 agt
= trace_ust_find_agent(usess
, domain
);
1736 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1740 * An empty event name means that everything
1741 * should be disabled.
1743 if (event
->name
[0] == '\0') {
1744 ret
= event_agent_disable_all(usess
, agt
);
1746 ret
= event_agent_disable(usess
, agt
, event_name
);
1748 if (ret
!= LTTNG_OK
) {
1755 ret
= LTTNG_ERR_UND
;
1768 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1770 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1771 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1773 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1774 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1777 * Don't try to add a context if the session has been started at
1778 * some point in time before. The tracer does not allow it and would
1779 * result in a corrupted trace.
1781 if (session
->has_been_started
) {
1782 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1786 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1787 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1788 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1792 case LTTNG_DOMAIN_KERNEL
:
1793 assert(session
->kernel_session
);
1795 if (session
->kernel_session
->channel_count
== 0) {
1796 /* Create default channel */
1797 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1798 if (ret
!= LTTNG_OK
) {
1801 chan_kern_created
= 1;
1803 /* Add kernel context to kernel tracer */
1804 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1805 if (ret
!= LTTNG_OK
) {
1809 case LTTNG_DOMAIN_JUL
:
1810 case LTTNG_DOMAIN_LOG4J
:
1813 * Validate channel name.
1814 * If no channel name is given and the domain is JUL or LOG4J,
1815 * set it to the appropriate domain-specific channel name. If
1816 * a name is provided but does not match the expexted channel
1817 * name, return an error.
1819 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1820 strcmp(channel_name
,
1821 DEFAULT_JUL_CHANNEL_NAME
)) {
1822 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1824 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1825 strcmp(channel_name
,
1826 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1827 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1830 /* break is _not_ missing here. */
1832 case LTTNG_DOMAIN_UST
:
1834 struct ltt_ust_session
*usess
= session
->ust_session
;
1835 unsigned int chan_count
;
1839 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1840 if (chan_count
== 0) {
1841 struct lttng_channel
*attr
;
1842 /* Create default channel */
1843 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1845 ret
= LTTNG_ERR_FATAL
;
1849 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1850 if (ret
!= LTTNG_OK
) {
1854 channel_attr_destroy(attr
);
1855 chan_ust_created
= 1;
1858 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1859 free(app_ctx_provider_name
);
1861 app_ctx_name
= NULL
;
1862 app_ctx_provider_name
= NULL
;
1863 if (ret
!= LTTNG_OK
) {
1869 ret
= LTTNG_ERR_UND
;
1877 if (chan_kern_created
) {
1878 struct ltt_kernel_channel
*kchan
=
1879 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1880 session
->kernel_session
);
1881 /* Created previously, this should NOT fail. */
1883 kernel_destroy_channel(kchan
);
1886 if (chan_ust_created
) {
1887 struct ltt_ust_channel
*uchan
=
1888 trace_ust_find_channel_by_name(
1889 session
->ust_session
->domain_global
.channels
,
1890 DEFAULT_CHANNEL_NAME
);
1891 /* Created previously, this should NOT fail. */
1893 /* Remove from the channel list of the session. */
1894 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1896 trace_ust_destroy_channel(uchan
);
1899 free(app_ctx_provider_name
);
1904 static inline bool name_starts_with(const char *name
, const char *prefix
)
1906 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1908 return !strncmp(name
, prefix
, max_cmp_len
);
1911 /* Perform userspace-specific event name validation */
1912 static int validate_ust_event_name(const char *name
)
1922 * Check name against all internal UST event component namespaces used
1925 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1926 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1927 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1936 * Internal version of cmd_enable_event() with a supplemental
1937 * "internal_event" flag which is used to enable internal events which should
1938 * be hidden from clients. Such events are used in the agent implementation to
1939 * enable the events through which all "agent" events are funeled.
1941 static int _cmd_enable_event(struct ltt_session
*session
,
1942 struct lttng_domain
*domain
,
1943 char *channel_name
, struct lttng_event
*event
,
1944 char *filter_expression
,
1945 struct lttng_filter_bytecode
*filter
,
1946 struct lttng_event_exclusion
*exclusion
,
1947 int wpipe
, bool internal_event
)
1949 int ret
= 0, channel_created
= 0;
1950 struct lttng_channel
*attr
= NULL
;
1954 assert(channel_name
);
1956 /* If we have a filter, we must have its filter expression */
1957 assert(!(!!filter_expression
^ !!filter
));
1959 /* Normalize event name as a globbing pattern */
1960 strutils_normalize_star_glob_pattern(event
->name
);
1962 /* Normalize exclusion names as globbing patterns */
1966 for (i
= 0; i
< exclusion
->count
; i
++) {
1967 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
1969 strutils_normalize_star_glob_pattern(name
);
1973 DBG("Enable event command for event \'%s\'", event
->name
);
1977 switch (domain
->type
) {
1978 case LTTNG_DOMAIN_KERNEL
:
1980 struct ltt_kernel_channel
*kchan
;
1983 * If a non-default channel has been created in the
1984 * session, explicitely require that -c chan_name needs
1987 if (session
->kernel_session
->has_non_default_channel
1988 && channel_name
[0] == '\0') {
1989 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1993 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1994 session
->kernel_session
);
1995 if (kchan
== NULL
) {
1996 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1997 LTTNG_BUFFER_GLOBAL
);
1999 ret
= LTTNG_ERR_FATAL
;
2002 if (lttng_strncpy(attr
->name
, channel_name
,
2003 sizeof(attr
->name
))) {
2004 ret
= LTTNG_ERR_INVALID
;
2008 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2009 if (ret
!= LTTNG_OK
) {
2012 channel_created
= 1;
2015 /* Get the newly created kernel channel pointer */
2016 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2017 session
->kernel_session
);
2018 if (kchan
== NULL
) {
2019 /* This sould not happen... */
2020 ret
= LTTNG_ERR_FATAL
;
2024 switch (event
->type
) {
2025 case LTTNG_EVENT_ALL
:
2027 char *filter_expression_a
= NULL
;
2028 struct lttng_filter_bytecode
*filter_a
= NULL
;
2031 * We need to duplicate filter_expression and filter,
2032 * because ownership is passed to first enable
2035 if (filter_expression
) {
2036 filter_expression_a
= strdup(filter_expression
);
2037 if (!filter_expression_a
) {
2038 ret
= LTTNG_ERR_FATAL
;
2043 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2045 free(filter_expression_a
);
2046 ret
= LTTNG_ERR_FATAL
;
2049 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2051 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2052 ret
= event_kernel_enable_event(kchan
, event
,
2053 filter_expression
, filter
);
2054 /* We have passed ownership */
2055 filter_expression
= NULL
;
2057 if (ret
!= LTTNG_OK
) {
2058 if (channel_created
) {
2059 /* Let's not leak a useless channel. */
2060 kernel_destroy_channel(kchan
);
2062 free(filter_expression_a
);
2066 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2067 ret
= event_kernel_enable_event(kchan
, event
,
2068 filter_expression_a
, filter_a
);
2069 /* We have passed ownership */
2070 filter_expression_a
= NULL
;
2072 if (ret
!= LTTNG_OK
) {
2077 case LTTNG_EVENT_PROBE
:
2078 case LTTNG_EVENT_USERSPACE_PROBE
:
2079 case LTTNG_EVENT_FUNCTION
:
2080 case LTTNG_EVENT_FUNCTION_ENTRY
:
2081 case LTTNG_EVENT_TRACEPOINT
:
2082 ret
= event_kernel_enable_event(kchan
, event
,
2083 filter_expression
, filter
);
2084 /* We have passed ownership */
2085 filter_expression
= NULL
;
2087 if (ret
!= LTTNG_OK
) {
2088 if (channel_created
) {
2089 /* Let's not leak a useless channel. */
2090 kernel_destroy_channel(kchan
);
2095 case LTTNG_EVENT_SYSCALL
:
2096 ret
= event_kernel_enable_event(kchan
, event
,
2097 filter_expression
, filter
);
2098 /* We have passed ownership */
2099 filter_expression
= NULL
;
2101 if (ret
!= LTTNG_OK
) {
2106 ret
= LTTNG_ERR_UNK
;
2110 kernel_wait_quiescent(kernel_tracer_fd
);
2113 case LTTNG_DOMAIN_UST
:
2115 struct ltt_ust_channel
*uchan
;
2116 struct ltt_ust_session
*usess
= session
->ust_session
;
2121 * If a non-default channel has been created in the
2122 * session, explicitely require that -c chan_name needs
2125 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2126 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2130 /* Get channel from global UST domain */
2131 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2133 if (uchan
== NULL
) {
2134 /* Create default channel */
2135 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2136 usess
->buffer_type
);
2138 ret
= LTTNG_ERR_FATAL
;
2141 if (lttng_strncpy(attr
->name
, channel_name
,
2142 sizeof(attr
->name
))) {
2143 ret
= LTTNG_ERR_INVALID
;
2147 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2148 if (ret
!= LTTNG_OK
) {
2152 /* Get the newly created channel reference back */
2153 uchan
= trace_ust_find_channel_by_name(
2154 usess
->domain_global
.channels
, channel_name
);
2158 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2160 * Don't allow users to add UST events to channels which
2161 * are assigned to a userspace subdomain (JUL, Log4J,
2164 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2168 if (!internal_event
) {
2170 * Ensure the event name is not reserved for internal
2173 ret
= validate_ust_event_name(event
->name
);
2175 WARN("Userspace event name %s failed validation.",
2177 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2182 /* At this point, the session and channel exist on the tracer */
2183 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2184 filter_expression
, filter
, exclusion
,
2186 /* We have passed ownership */
2187 filter_expression
= NULL
;
2190 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2191 goto already_enabled
;
2192 } else if (ret
!= LTTNG_OK
) {
2197 case LTTNG_DOMAIN_LOG4J
:
2198 case LTTNG_DOMAIN_JUL
:
2199 case LTTNG_DOMAIN_PYTHON
:
2201 const char *default_event_name
, *default_chan_name
;
2203 struct lttng_event uevent
;
2204 struct lttng_domain tmp_dom
;
2205 struct ltt_ust_session
*usess
= session
->ust_session
;
2209 if (!agent_tracing_is_enabled()) {
2210 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2211 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2215 agt
= trace_ust_find_agent(usess
, domain
->type
);
2217 agt
= agent_create(domain
->type
);
2219 ret
= LTTNG_ERR_NOMEM
;
2222 agent_add(agt
, usess
->agents
);
2225 /* Create the default tracepoint. */
2226 memset(&uevent
, 0, sizeof(uevent
));
2227 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2228 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2229 default_event_name
= event_get_default_agent_ust_name(
2231 if (!default_event_name
) {
2232 ret
= LTTNG_ERR_FATAL
;
2235 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2236 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2239 * The domain type is changed because we are about to enable the
2240 * default channel and event for the JUL domain that are hardcoded.
2241 * This happens in the UST domain.
2243 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2244 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2246 switch (domain
->type
) {
2247 case LTTNG_DOMAIN_LOG4J
:
2248 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2250 case LTTNG_DOMAIN_JUL
:
2251 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2253 case LTTNG_DOMAIN_PYTHON
:
2254 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2257 /* The switch/case we are in makes this impossible */
2262 char *filter_expression_copy
= NULL
;
2263 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2266 const size_t filter_size
= sizeof(
2267 struct lttng_filter_bytecode
)
2270 filter_copy
= zmalloc(filter_size
);
2272 ret
= LTTNG_ERR_NOMEM
;
2275 memcpy(filter_copy
, filter
, filter_size
);
2277 filter_expression_copy
=
2278 strdup(filter_expression
);
2279 if (!filter_expression
) {
2280 ret
= LTTNG_ERR_NOMEM
;
2283 if (!filter_expression_copy
|| !filter_copy
) {
2284 free(filter_expression_copy
);
2290 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2291 (char *) default_chan_name
,
2292 &uevent
, filter_expression_copy
,
2293 filter_copy
, NULL
, wpipe
);
2296 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2297 goto already_enabled
;
2298 } else if (ret
!= LTTNG_OK
) {
2302 /* The wild card * means that everything should be enabled. */
2303 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2304 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2307 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2311 filter_expression
= NULL
;
2312 if (ret
!= LTTNG_OK
) {
2319 ret
= LTTNG_ERR_UND
;
2327 free(filter_expression
);
2330 channel_attr_destroy(attr
);
2336 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2337 * We own filter, exclusion, and filter_expression.
2339 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2340 char *channel_name
, struct lttng_event
*event
,
2341 char *filter_expression
,
2342 struct lttng_filter_bytecode
*filter
,
2343 struct lttng_event_exclusion
*exclusion
,
2346 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2347 filter_expression
, filter
, exclusion
, wpipe
, false);
2351 * Enable an event which is internal to LTTng. An internal should
2352 * never be made visible to clients and are immune to checks such as
2355 static int cmd_enable_event_internal(struct ltt_session
*session
,
2356 struct lttng_domain
*domain
,
2357 char *channel_name
, struct lttng_event
*event
,
2358 char *filter_expression
,
2359 struct lttng_filter_bytecode
*filter
,
2360 struct lttng_event_exclusion
*exclusion
,
2363 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2364 filter_expression
, filter
, exclusion
, wpipe
, true);
2368 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2370 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2371 struct lttng_event
**events
)
2374 ssize_t nb_events
= 0;
2377 case LTTNG_DOMAIN_KERNEL
:
2378 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2379 if (nb_events
< 0) {
2380 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2384 case LTTNG_DOMAIN_UST
:
2385 nb_events
= ust_app_list_events(events
);
2386 if (nb_events
< 0) {
2387 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2391 case LTTNG_DOMAIN_LOG4J
:
2392 case LTTNG_DOMAIN_JUL
:
2393 case LTTNG_DOMAIN_PYTHON
:
2394 nb_events
= agent_list_events(events
, domain
);
2395 if (nb_events
< 0) {
2396 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2401 ret
= LTTNG_ERR_UND
;
2408 /* Return negative value to differentiate return code */
2413 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2415 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2416 struct lttng_event_field
**fields
)
2419 ssize_t nb_fields
= 0;
2422 case LTTNG_DOMAIN_UST
:
2423 nb_fields
= ust_app_list_event_fields(fields
);
2424 if (nb_fields
< 0) {
2425 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2429 case LTTNG_DOMAIN_KERNEL
:
2430 default: /* fall-through */
2431 ret
= LTTNG_ERR_UND
;
2438 /* Return negative value to differentiate return code */
2442 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2444 return syscall_table_list(events
);
2448 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2450 * Called with session lock held.
2452 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2453 enum lttng_domain_type domain
, int32_t **pids
)
2456 ssize_t nr_pids
= 0;
2459 case LTTNG_DOMAIN_KERNEL
:
2461 struct ltt_kernel_session
*ksess
;
2463 ksess
= session
->kernel_session
;
2464 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2466 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2471 case LTTNG_DOMAIN_UST
:
2473 struct ltt_ust_session
*usess
;
2475 usess
= session
->ust_session
;
2476 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2478 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2483 case LTTNG_DOMAIN_LOG4J
:
2484 case LTTNG_DOMAIN_JUL
:
2485 case LTTNG_DOMAIN_PYTHON
:
2487 ret
= LTTNG_ERR_UND
;
2494 /* Return negative value to differentiate return code */
2499 int domain_mkdir(const struct consumer_output
*output
,
2500 const struct ltt_session
*session
,
2501 uid_t uid
, gid_t gid
)
2503 struct consumer_socket
*socket
;
2504 struct lttng_ht_iter iter
;
2508 if (!output
|| !output
->socks
) {
2509 ERR("No consumer output found");
2514 path
= zmalloc(LTTNG_PATH_MAX
* sizeof(char));
2516 ERR("Cannot allocate mkdir path");
2521 ret
= snprintf(path
, LTTNG_PATH_MAX
, "%s%s%s",
2522 session_get_base_path(session
),
2523 output
->chunk_path
, output
->subdir
);
2524 if (ret
< 0 || ret
>= LTTNG_PATH_MAX
) {
2530 DBG("Domain mkdir %s for session %" PRIu64
, path
, session
->id
);
2533 * We have to iterate to find a socket, but we only need to send the
2534 * rename command to one consumer, so we break after the first one.
2536 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
2537 pthread_mutex_lock(socket
->lock
);
2538 ret
= consumer_mkdir(socket
, session
->id
, output
, path
, uid
, gid
);
2539 pthread_mutex_unlock(socket
->lock
);
2541 ERR("Consumer mkdir");
2558 int session_mkdir(const struct ltt_session
*session
)
2561 struct consumer_output
*output
;
2566 * Unsupported feature in lttng-relayd before 2.11, not an error since it
2567 * is only needed for session rotation and the user will get an error
2570 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
2571 session
->consumer
->relay_major_version
== 2 &&
2572 session
->consumer
->relay_minor_version
< 11) {
2577 if (session
->kernel_session
) {
2578 output
= session
->kernel_session
->consumer
;
2579 uid
= session
->kernel_session
->uid
;
2580 gid
= session
->kernel_session
->gid
;
2581 ret
= domain_mkdir(output
, session
, uid
, gid
);
2583 ERR("Mkdir kernel");
2588 if (session
->ust_session
) {
2589 output
= session
->ust_session
->consumer
;
2590 uid
= session
->ust_session
->uid
;
2591 gid
= session
->ust_session
->gid
;
2592 ret
= domain_mkdir(output
, session
, uid
, gid
);
2606 * Command LTTNG_START_TRACE processed by the client thread.
2608 * Called with session mutex held.
2610 int cmd_start_trace(struct ltt_session
*session
)
2613 unsigned long nb_chan
= 0;
2614 struct ltt_kernel_session
*ksession
;
2615 struct ltt_ust_session
*usess
;
2619 /* Ease our life a bit ;) */
2620 ksession
= session
->kernel_session
;
2621 usess
= session
->ust_session
;
2623 /* Is the session already started? */
2624 if (session
->active
) {
2625 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2630 * Starting a session without channel is useless since after that it's not
2631 * possible to enable channel thus inform the client.
2633 if (usess
&& usess
->domain_global
.channels
) {
2634 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2637 nb_chan
+= ksession
->channel_count
;
2640 ret
= LTTNG_ERR_NO_CHANNEL
;
2645 * Record the timestamp of the first time the session is started for
2646 * an eventual session rotation call.
2648 if (!session
->has_been_started
) {
2649 session
->current_chunk_start_ts
= time(NULL
);
2650 if (session
->current_chunk_start_ts
== (time_t) -1) {
2651 PERROR("Failed to retrieve the \"%s\" session's start time",
2653 ret
= LTTNG_ERR_FATAL
;
2656 if (!session
->snapshot_mode
&& session
->output_traces
) {
2657 ret
= session_mkdir(session
);
2659 ERR("Failed to create the session directories");
2660 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2666 /* Kernel tracing */
2667 if (ksession
!= NULL
) {
2668 DBG("Start kernel tracing session %s", session
->name
);
2669 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2670 if (ret
!= LTTNG_OK
) {
2675 /* Flag session that trace should start automatically */
2678 * Even though the start trace might fail, flag this session active so
2679 * other application coming in are started by default.
2683 ret
= ust_app_start_trace_all(usess
);
2685 ret
= LTTNG_ERR_UST_START_FAIL
;
2690 /* Flag this after a successful start. */
2691 session
->has_been_started
= 1;
2692 session
->active
= 1;
2695 * Clear the flag that indicates that a rotation was done while the
2696 * session was stopped.
2698 session
->rotated_after_last_stop
= false;
2700 if (session
->rotate_timer_period
) {
2701 ret
= sessiond_rotate_timer_start(session
,
2702 session
->rotate_timer_period
);
2704 ERR("Failed to enable rotate timer");
2705 ret
= LTTNG_ERR_UNK
;
2717 int rename_active_chunk(struct ltt_session
*session
)
2721 session
->current_archive_id
++;
2724 * The currently active tracing path is now the folder we
2727 ret
= lttng_strncpy(session
->rotation_chunk
.current_rotate_path
,
2728 session
->rotation_chunk
.active_tracing_path
,
2729 sizeof(session
->rotation_chunk
.current_rotate_path
));
2731 ERR("Failed to copy active tracing path");
2735 ret
= rename_complete_chunk(session
, time(NULL
));
2737 ERR("Failed to rename current rotate path");
2742 * We just renamed, the folder, we didn't do an actual rotation, so
2743 * the active tracing path is now the renamed folder and we have to
2744 * restore the rotate count.
2746 ret
= lttng_strncpy(session
->rotation_chunk
.active_tracing_path
,
2747 session
->rotation_chunk
.current_rotate_path
,
2748 sizeof(session
->rotation_chunk
.active_tracing_path
));
2750 ERR("Failed to rename active session chunk tracing path");
2754 session
->current_archive_id
--;
2759 * Command LTTNG_STOP_TRACE processed by the client thread.
2761 int cmd_stop_trace(struct ltt_session
*session
)
2764 struct ltt_kernel_channel
*kchan
;
2765 struct ltt_kernel_session
*ksession
;
2766 struct ltt_ust_session
*usess
;
2767 bool error_occured
= false;
2771 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2773 ksession
= session
->kernel_session
;
2774 usess
= session
->ust_session
;
2776 /* Session is not active. Skip everythong and inform the client. */
2777 if (!session
->active
) {
2778 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2782 if (session
->rotate_relay_pending_timer_enabled
) {
2783 sessiond_timer_rotate_pending_stop(session
);
2786 if (session
->rotate_timer_enabled
) {
2787 sessiond_rotate_timer_stop(session
);
2790 if (session
->current_archive_id
> 0 && !session
->rotate_pending
) {
2791 ret
= rename_active_chunk(session
);
2794 * This error should not prevent the user from stopping
2795 * the session. However, it will be reported at the end.
2797 error_occured
= true;
2802 if (ksession
&& ksession
->active
) {
2803 DBG("Stop kernel tracing");
2805 ret
= kernel_stop_session(ksession
);
2807 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2811 kernel_wait_quiescent(kernel_tracer_fd
);
2813 /* Flush metadata after stopping (if exists) */
2814 if (ksession
->metadata_stream_fd
>= 0) {
2815 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2817 ERR("Kernel metadata flush failed");
2821 /* Flush all buffers after stopping */
2822 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2823 ret
= kernel_flush_buffer(kchan
);
2825 ERR("Kernel flush buffer error");
2829 ksession
->active
= 0;
2830 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2834 if (usess
&& usess
->active
) {
2836 * Even though the stop trace might fail, flag this session inactive so
2837 * other application coming in are not started by default.
2841 ret
= ust_app_stop_trace_all(usess
);
2843 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2848 /* Flag inactive after a successful stop. */
2849 session
->active
= 0;
2850 ret
= !error_occured
? LTTNG_OK
: LTTNG_ERR_UNK
;
2857 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2859 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2860 struct lttng_uri
*uris
)
2863 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2864 struct ltt_ust_session
*usess
= session
->ust_session
;
2870 /* Can't set consumer URI if the session is active. */
2871 if (session
->active
) {
2872 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2876 /* Set the "global" consumer URIs */
2877 for (i
= 0; i
< nb_uri
; i
++) {
2878 ret
= add_uri_to_consumer(session
->consumer
,
2879 &uris
[i
], 0, session
->name
);
2880 if (ret
!= LTTNG_OK
) {
2885 /* Set UST session URIs */
2886 if (session
->ust_session
) {
2887 for (i
= 0; i
< nb_uri
; i
++) {
2888 ret
= add_uri_to_consumer(
2889 session
->ust_session
->consumer
,
2890 &uris
[i
], LTTNG_DOMAIN_UST
,
2892 if (ret
!= LTTNG_OK
) {
2898 /* Set kernel session URIs */
2899 if (session
->kernel_session
) {
2900 for (i
= 0; i
< nb_uri
; i
++) {
2901 ret
= add_uri_to_consumer(
2902 session
->kernel_session
->consumer
,
2903 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2905 if (ret
!= LTTNG_OK
) {
2912 * Make sure to set the session in output mode after we set URI since a
2913 * session can be created without URL (thus flagged in no output mode).
2915 session
->output_traces
= 1;
2917 ksess
->output_traces
= 1;
2921 usess
->output_traces
= 1;
2932 * Command LTTNG_CREATE_SESSION processed by the client thread.
2934 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2935 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2938 struct ltt_session
*session
;
2944 * Verify if the session already exist
2946 * XXX: There is no need for the session lock list here since the caller
2947 * (process_client_msg) is holding it. We might want to change that so a
2948 * single command does not lock the entire session list.
2950 session
= session_find_by_name(name
);
2951 if (session
!= NULL
) {
2952 ret
= LTTNG_ERR_EXIST_SESS
;
2956 /* Create tracing session in the registry */
2957 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2958 LTTNG_SOCK_GET_GID_CRED(creds
));
2959 if (ret
!= LTTNG_OK
) {
2964 * Get the newly created session pointer back
2966 * XXX: There is no need for the session lock list here since the caller
2967 * (process_client_msg) is holding it. We might want to change that so a
2968 * single command does not lock the entire session list.
2970 session
= session_find_by_name(name
);
2973 session
->live_timer
= live_timer
;
2974 /* Create default consumer output for the session not yet created. */
2975 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2976 if (session
->consumer
== NULL
) {
2977 ret
= LTTNG_ERR_FATAL
;
2978 goto consumer_error
;
2982 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2983 if (ret
!= LTTNG_OK
) {
2984 goto consumer_error
;
2986 session
->output_traces
= 1;
2988 session
->output_traces
= 0;
2989 DBG2("Session %s created with no output", session
->name
);
2992 session
->consumer
->enabled
= 1;
2997 session_destroy(session
);
3004 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
3006 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
3007 size_t nb_uri
, lttng_sock_cred
*creds
)
3010 struct ltt_session
*session
;
3011 struct snapshot_output
*new_output
= NULL
;
3017 * Create session in no output mode with URIs set to NULL. The uris we've
3018 * received are for a default snapshot output if one.
3020 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
3021 if (ret
!= LTTNG_OK
) {
3025 /* Get the newly created session pointer back. This should NEVER fail. */
3026 session
= session_find_by_name(name
);
3029 /* Flag session for snapshot mode. */
3030 session
->snapshot_mode
= 1;
3032 /* Skip snapshot output creation if no URI is given. */
3037 new_output
= snapshot_output_alloc();
3039 ret
= LTTNG_ERR_NOMEM
;
3040 goto error_snapshot_alloc
;
3043 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
3044 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
3046 if (ret
== -ENOMEM
) {
3047 ret
= LTTNG_ERR_NOMEM
;
3049 ret
= LTTNG_ERR_INVALID
;
3051 goto error_snapshot
;
3055 snapshot_add_output(&session
->snapshot
, new_output
);
3062 snapshot_output_destroy(new_output
);
3063 error_snapshot_alloc
:
3064 session_destroy(session
);
3070 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3072 * Called with session lock held.
3074 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
,
3075 struct notification_thread_handle
*notification_thread_handle
)
3078 struct ltt_ust_session
*usess
;
3079 struct ltt_kernel_session
*ksess
;
3084 usess
= session
->ust_session
;
3085 ksess
= session
->kernel_session
;
3087 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
, session
->id
);
3089 if (session
->rotate_relay_pending_timer_enabled
) {
3090 sessiond_timer_rotate_pending_stop(session
);
3093 if (session
->rotate_timer_enabled
) {
3094 sessiond_rotate_timer_stop(session
);
3097 if (session
->rotate_size
) {
3098 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3099 session
->rotate_size
= 0;
3103 * The rename of the current chunk is performed at stop, but if we rotated
3104 * the session after the previous stop command, we need to rename the
3105 * new (and empty) chunk that was started in between.
3107 if (session
->rotated_after_last_stop
) {
3108 rename_active_chunk(session
);
3111 /* Clean kernel session teardown */
3112 kernel_destroy_session(ksess
);
3114 /* UST session teardown */
3116 /* Close any relayd session */
3117 consumer_output_send_destroy_relayd(usess
->consumer
);
3119 /* Destroy every UST application related to this session. */
3120 ret
= ust_app_destroy_trace_all(usess
);
3122 ERR("Error in ust_app_destroy_trace_all");
3125 /* Clean up the rest. */
3126 trace_ust_destroy_session(usess
);
3130 * Must notify the kernel thread here to update it's poll set in order to
3131 * remove the channel(s)' fd just destroyed.
3133 ret
= notify_thread_pipe(wpipe
);
3135 PERROR("write kernel poll pipe");
3138 if (session
->shm_path
[0]) {
3140 * When a session is created with an explicit shm_path,
3141 * the consumer daemon will create its shared memory files
3142 * at that location and will *not* unlink them. This is normal
3143 * as the intention of that feature is to make it possible
3144 * to retrieve the content of those files should a crash occur.
3146 * To ensure the content of those files can be used, the
3147 * sessiond daemon will replicate the content of the metadata
3148 * cache in a metadata file.
3150 * On clean-up, it is expected that the consumer daemon will
3151 * unlink the shared memory files and that the session daemon
3152 * will unlink the metadata file. Then, the session's directory
3153 * in the shm path can be removed.
3155 * Unfortunately, a flaw in the design of the sessiond's and
3156 * consumerd's tear down of channels makes it impossible to
3157 * determine when the sessiond _and_ the consumerd have both
3158 * destroyed their representation of a channel. For one, the
3159 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3160 * callbacks in both daemons.
3162 * However, it is also impossible for the sessiond to know when
3163 * the consumer daemon is done destroying its channel(s) since
3164 * it occurs as a reaction to the closing of the channel's file
3165 * descriptor. There is no resulting communication initiated
3166 * from the consumerd to the sessiond to confirm that the
3167 * operation is completed (and was successful).
3169 * Until this is all fixed, the session daemon checks for the
3170 * removal of the session's shm path which makes it possible
3171 * to safely advertise a session as having been destroyed.
3173 * Prior to this fix, it was not possible to reliably save
3174 * a session making use of the --shm-path option, destroy it,
3175 * and load it again. This is because the creation of the
3176 * session would fail upon seeing the session's shm path
3177 * already in existence.
3179 * Note that none of the error paths in the check for the
3180 * directory's existence return an error. This is normal
3181 * as there isn't much that can be done. The session will
3182 * be destroyed properly, except that we can't offer the
3183 * guarantee that the same session can be re-created.
3185 current_completion_handler
= &destroy_completion_handler
.handler
;
3186 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3188 sizeof(destroy_completion_handler
.shm_path
));
3191 ret
= session_destroy(session
);
3197 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3199 int cmd_register_consumer(struct ltt_session
*session
,
3200 enum lttng_domain_type domain
, const char *sock_path
,
3201 struct consumer_data
*cdata
)
3204 struct consumer_socket
*socket
= NULL
;
3211 case LTTNG_DOMAIN_KERNEL
:
3213 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3217 /* Can't register a consumer if there is already one */
3218 if (ksess
->consumer_fds_sent
!= 0) {
3219 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3223 sock
= lttcomm_connect_unix_sock(sock_path
);
3225 ret
= LTTNG_ERR_CONNECT_FAIL
;
3228 cdata
->cmd_sock
= sock
;
3230 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3231 if (socket
== NULL
) {
3234 PERROR("close register consumer");
3236 cdata
->cmd_sock
= -1;
3237 ret
= LTTNG_ERR_FATAL
;
3241 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3242 if (socket
->lock
== NULL
) {
3243 PERROR("zmalloc pthread mutex");
3244 ret
= LTTNG_ERR_FATAL
;
3247 pthread_mutex_init(socket
->lock
, NULL
);
3248 socket
->registered
= 1;
3251 consumer_add_socket(socket
, ksess
->consumer
);
3254 pthread_mutex_lock(&cdata
->pid_mutex
);
3256 pthread_mutex_unlock(&cdata
->pid_mutex
);
3261 /* TODO: Userspace tracing */
3262 ret
= LTTNG_ERR_UND
;
3270 consumer_destroy_socket(socket
);
3276 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3278 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3279 struct lttng_domain
**domains
)
3284 struct lttng_ht_iter iter
;
3286 if (session
->kernel_session
!= NULL
) {
3287 DBG3("Listing domains found kernel domain");
3291 if (session
->ust_session
!= NULL
) {
3292 DBG3("Listing domains found UST global domain");
3296 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3298 if (agt
->being_used
) {
3309 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3310 if (*domains
== NULL
) {
3311 ret
= LTTNG_ERR_FATAL
;
3315 if (session
->kernel_session
!= NULL
) {
3316 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3318 /* Kernel session buffer type is always GLOBAL */
3319 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3324 if (session
->ust_session
!= NULL
) {
3325 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3326 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3330 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3332 if (agt
->being_used
) {
3333 (*domains
)[index
].type
= agt
->domain
;
3334 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3344 /* Return negative value to differentiate return code */
3350 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3352 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3353 struct ltt_session
*session
, struct lttng_channel
**channels
)
3355 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3358 case LTTNG_DOMAIN_KERNEL
:
3359 if (session
->kernel_session
!= NULL
) {
3360 nb_chan
= session
->kernel_session
->channel_count
;
3362 DBG3("Number of kernel channels %zd", nb_chan
);
3364 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3368 case LTTNG_DOMAIN_UST
:
3369 if (session
->ust_session
!= NULL
) {
3371 nb_chan
= lttng_ht_get_count(
3372 session
->ust_session
->domain_global
.channels
);
3375 DBG3("Number of UST global channels %zd", nb_chan
);
3377 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3382 ret
= -LTTNG_ERR_UND
;
3387 const size_t channel_size
= sizeof(struct lttng_channel
) +
3388 sizeof(struct lttng_channel_extended
);
3389 struct lttng_channel_extended
*channel_exts
;
3391 payload_size
= nb_chan
* channel_size
;
3392 *channels
= zmalloc(payload_size
);
3393 if (*channels
== NULL
) {
3394 ret
= -LTTNG_ERR_FATAL
;
3398 channel_exts
= ((void *) *channels
) +
3399 (nb_chan
* sizeof(struct lttng_channel
));
3400 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3401 if (ret
!= LTTNG_OK
) {
3416 * Command LTTNG_LIST_EVENTS processed by the client thread.
3418 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3419 struct ltt_session
*session
, char *channel_name
,
3420 struct lttng_event
**events
, size_t *total_size
)
3423 ssize_t nb_event
= 0;
3426 case LTTNG_DOMAIN_KERNEL
:
3427 if (session
->kernel_session
!= NULL
) {
3428 nb_event
= list_lttng_kernel_events(channel_name
,
3429 session
->kernel_session
, events
,
3433 case LTTNG_DOMAIN_UST
:
3435 if (session
->ust_session
!= NULL
) {
3436 nb_event
= list_lttng_ust_global_events(channel_name
,
3437 &session
->ust_session
->domain_global
, events
,
3442 case LTTNG_DOMAIN_LOG4J
:
3443 case LTTNG_DOMAIN_JUL
:
3444 case LTTNG_DOMAIN_PYTHON
:
3445 if (session
->ust_session
) {
3446 struct lttng_ht_iter iter
;
3450 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3451 &iter
.iter
, agt
, node
.node
) {
3452 if (agt
->domain
== domain
) {
3453 nb_event
= list_lttng_agent_events(
3463 ret
= LTTNG_ERR_UND
;
3470 /* Return negative value to differentiate return code */
3475 * Using the session list, filled a lttng_session array to send back to the
3476 * client for session listing.
3478 * The session list lock MUST be acquired before calling this function. Use
3479 * session_lock_list() and session_unlock_list().
3481 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3486 struct ltt_session
*session
;
3487 struct ltt_session_list
*list
= session_get_list();
3489 DBG("Getting all available session for UID %d GID %d",
3492 * Iterate over session list and append data after the control struct in
3495 cds_list_for_each_entry(session
, &list
->head
, list
) {
3497 * Only list the sessions the user can control.
3499 if (!session_access_ok(session
, uid
, gid
)) {
3503 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3504 struct ltt_ust_session
*usess
= session
->ust_session
;
3506 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3507 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3508 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3509 ret
= build_network_session_path(sessions
[i
].path
,
3510 sizeof(sessions
[i
].path
), session
);
3512 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3513 session
->consumer
->dst
.session_root_path
);
3516 PERROR("snprintf session path");
3520 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3521 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3522 sessions
[i
].enabled
= session
->active
;
3523 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3524 sessions
[i
].live_timer_interval
= session
->live_timer
;
3530 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3531 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3533 int cmd_data_pending(struct ltt_session
*session
)
3536 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3537 struct ltt_ust_session
*usess
= session
->ust_session
;
3541 DBG("Data pending for session %s", session
->name
);
3543 /* Session MUST be stopped to ask for data availability. */
3544 if (session
->active
) {
3545 ret
= LTTNG_ERR_SESSION_STARTED
;
3549 * If stopped, just make sure we've started before else the above call
3550 * will always send that there is data pending.
3552 * The consumer assumes that when the data pending command is received,
3553 * the trace has been started before or else no output data is written
3554 * by the streams which is a condition for data pending. So, this is
3555 * *VERY* important that we don't ask the consumer before a start
3558 if (!session
->has_been_started
) {
3565 * A rotation is still pending, we have to wait.
3567 if (session
->rotate_pending
) {
3568 DBG("Rotate still pending for session %s", session
->name
);
3573 if (ksess
&& ksess
->consumer
) {
3574 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3576 /* Data is still being extracted for the kernel. */
3581 if (usess
&& usess
->consumer
) {
3582 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3584 /* Data is still being extracted for the kernel. */
3589 /* Data is ready to be read by a viewer */
3597 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3599 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3601 int cmd_snapshot_add_output(struct ltt_session
*session
,
3602 struct lttng_snapshot_output
*output
, uint32_t *id
)
3605 struct snapshot_output
*new_output
;
3610 DBG("Cmd snapshot add output for session %s", session
->name
);
3613 * Can't create an output if the session is not set in no-output mode.
3615 if (session
->output_traces
) {
3616 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3620 /* Only one output is allowed until we have the "tee" feature. */
3621 if (session
->snapshot
.nb_output
== 1) {
3622 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3626 new_output
= snapshot_output_alloc();
3628 ret
= LTTNG_ERR_NOMEM
;
3632 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3633 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3634 &session
->snapshot
);
3636 if (ret
== -ENOMEM
) {
3637 ret
= LTTNG_ERR_NOMEM
;
3639 ret
= LTTNG_ERR_INVALID
;
3645 snapshot_add_output(&session
->snapshot
, new_output
);
3647 *id
= new_output
->id
;
3654 snapshot_output_destroy(new_output
);
3660 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3662 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3664 int cmd_snapshot_del_output(struct ltt_session
*session
,
3665 struct lttng_snapshot_output
*output
)
3668 struct snapshot_output
*sout
= NULL
;
3676 * Permission denied to create an output if the session is not
3677 * set in no output mode.
3679 if (session
->output_traces
) {
3680 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3685 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3687 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3688 } else if (*output
->name
!= '\0') {
3689 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3691 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3694 ret
= LTTNG_ERR_INVALID
;
3698 snapshot_delete_output(&session
->snapshot
, sout
);
3699 snapshot_output_destroy(sout
);
3708 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3710 * If no output is available, outputs is untouched and 0 is returned.
3712 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3714 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3715 struct lttng_snapshot_output
**outputs
)
3718 struct lttng_snapshot_output
*list
= NULL
;
3719 struct lttng_ht_iter iter
;
3720 struct snapshot_output
*output
;
3725 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3728 * Permission denied to create an output if the session is not
3729 * set in no output mode.
3731 if (session
->output_traces
) {
3732 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3736 if (session
->snapshot
.nb_output
== 0) {
3741 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3743 ret
= -LTTNG_ERR_NOMEM
;
3747 /* Copy list from session to the new list object. */
3749 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3750 output
, node
.node
) {
3751 assert(output
->consumer
);
3752 list
[idx
].id
= output
->id
;
3753 list
[idx
].max_size
= output
->max_size
;
3754 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3755 sizeof(list
[idx
].name
))) {
3756 ret
= -LTTNG_ERR_INVALID
;
3759 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3760 if (lttng_strncpy(list
[idx
].ctrl_url
,
3761 output
->consumer
->dst
.session_root_path
,
3762 sizeof(list
[idx
].ctrl_url
))) {
3763 ret
= -LTTNG_ERR_INVALID
;
3768 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3769 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3771 ret
= -LTTNG_ERR_NOMEM
;
3776 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3777 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3779 ret
= -LTTNG_ERR_NOMEM
;
3788 ret
= session
->snapshot
.nb_output
;
3797 * Check if we can regenerate the metadata for this session.
3798 * Only kernel, UST per-uid and non-live sessions are supported.
3800 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3803 int check_regenerate_metadata_support(struct ltt_session
*session
)
3809 if (session
->live_timer
!= 0) {
3810 ret
= LTTNG_ERR_LIVE_SESSION
;
3813 if (!session
->active
) {
3814 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3817 if (session
->ust_session
) {
3818 switch (session
->ust_session
->buffer_type
) {
3819 case LTTNG_BUFFER_PER_UID
:
3821 case LTTNG_BUFFER_PER_PID
:
3822 ret
= LTTNG_ERR_PER_PID_SESSION
;
3826 ret
= LTTNG_ERR_UNK
;
3830 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3831 session
->consumer
->relay_minor_version
< 8) {
3832 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3842 int clear_metadata_file(int fd
)
3847 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
3848 if (lseek_ret
< 0) {
3854 ret
= ftruncate(fd
, 0);
3856 PERROR("ftruncate");
3865 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3868 struct buffer_reg_uid
*uid_reg
= NULL
;
3869 struct buffer_reg_session
*session_reg
= NULL
;
3872 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3873 struct ust_registry_session
*registry
;
3874 struct ust_registry_channel
*chan
;
3875 struct lttng_ht_iter iter_chan
;
3877 session_reg
= uid_reg
->registry
;
3878 registry
= session_reg
->reg
.ust
;
3880 pthread_mutex_lock(®istry
->lock
);
3881 registry
->metadata_len_sent
= 0;
3882 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3883 registry
->metadata_len
= 0;
3884 registry
->metadata_version
++;
3885 if (registry
->metadata_fd
> 0) {
3886 /* Clear the metadata file's content. */
3887 ret
= clear_metadata_file(registry
->metadata_fd
);
3889 pthread_mutex_unlock(®istry
->lock
);
3894 ret
= ust_metadata_session_statedump(registry
, NULL
,
3895 registry
->major
, registry
->minor
);
3897 pthread_mutex_unlock(®istry
->lock
);
3898 ERR("Failed to generate session metadata (err = %d)",
3902 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3904 struct ust_registry_event
*event
;
3905 struct lttng_ht_iter iter_event
;
3907 ret
= ust_metadata_channel_statedump(registry
, chan
);
3909 pthread_mutex_unlock(®istry
->lock
);
3910 ERR("Failed to generate channel metadata "
3914 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3916 ret
= ust_metadata_event_statedump(registry
,
3919 pthread_mutex_unlock(®istry
->lock
);
3920 ERR("Failed to generate event metadata "
3926 pthread_mutex_unlock(®istry
->lock
);
3935 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3937 * Ask the consumer to truncate the existing metadata file(s) and
3938 * then regenerate the metadata. Live and per-pid sessions are not
3939 * supported and return an error.
3941 * Return 0 on success or else a LTTNG_ERR code.
3943 int cmd_regenerate_metadata(struct ltt_session
*session
)
3949 ret
= check_regenerate_metadata_support(session
);
3954 if (session
->kernel_session
) {
3955 ret
= kernctl_session_regenerate_metadata(
3956 session
->kernel_session
->fd
);
3958 ERR("Failed to regenerate the kernel metadata");
3963 if (session
->ust_session
) {
3964 ret
= ust_regenerate_metadata(session
->ust_session
);
3966 ERR("Failed to regenerate the UST metadata");
3970 DBG("Cmd metadata regenerate for session %s", session
->name
);
3978 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
3980 * Ask the tracer to regenerate a new statedump.
3982 * Return 0 on success or else a LTTNG_ERR code.
3984 int cmd_regenerate_statedump(struct ltt_session
*session
)
3990 if (!session
->active
) {
3991 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3995 if (session
->kernel_session
) {
3996 ret
= kernctl_session_regenerate_statedump(
3997 session
->kernel_session
->fd
);
3999 * Currently, the statedump in kernel can only fail if out
4003 if (ret
== -ENOMEM
) {
4004 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4006 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4008 ERR("Failed to regenerate the kernel statedump");
4013 if (session
->ust_session
) {
4014 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4016 * Currently, the statedump in UST always returns 0.
4019 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4020 ERR("Failed to regenerate the UST statedump");
4024 DBG("Cmd regenerate statedump for session %s", session
->name
);
4031 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4032 struct notification_thread_handle
*notification_thread
)
4036 ssize_t sock_recv_len
;
4037 struct lttng_trigger
*trigger
= NULL
;
4038 struct lttng_buffer_view view
;
4039 struct lttng_dynamic_buffer trigger_buffer
;
4041 lttng_dynamic_buffer_init(&trigger_buffer
);
4042 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4043 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4045 ret
= LTTNG_ERR_NOMEM
;
4049 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4051 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4052 ERR("Failed to receive \"register trigger\" command payload");
4053 /* TODO: should this be a new error enum ? */
4054 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4058 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4059 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4061 ERR("Invalid trigger payload received in \"register trigger\" command");
4062 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4066 ret
= notification_thread_command_register_trigger(notification_thread
,
4068 /* Ownership of trigger was transferred. */
4071 lttng_trigger_destroy(trigger
);
4072 lttng_dynamic_buffer_reset(&trigger_buffer
);
4076 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4077 struct notification_thread_handle
*notification_thread
)
4081 ssize_t sock_recv_len
;
4082 struct lttng_trigger
*trigger
= NULL
;
4083 struct lttng_buffer_view view
;
4084 struct lttng_dynamic_buffer trigger_buffer
;
4086 lttng_dynamic_buffer_init(&trigger_buffer
);
4087 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4088 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4090 ret
= LTTNG_ERR_NOMEM
;
4094 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4096 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4097 ERR("Failed to receive \"unregister trigger\" command payload");
4098 /* TODO: should this be a new error enum ? */
4099 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4103 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4104 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4106 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4107 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4111 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4114 lttng_trigger_destroy(trigger
);
4115 lttng_dynamic_buffer_reset(&trigger_buffer
);
4120 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4121 * snapshot output is *not* set with a remote destination.
4123 * Return 0 on success or a LTTNG_ERR code.
4125 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
4126 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
4129 struct lttng_ht_iter iter
;
4130 struct consumer_socket
*socket
;
4133 assert(snap_output
);
4136 DBG2("Set relayd object from snapshot output");
4138 /* Ignore if snapshot consumer output is not network. */
4139 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
4144 * For each consumer socket, create and send the relayd object of the
4148 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
4149 socket
, node
.node
) {
4150 pthread_mutex_lock(socket
->lock
);
4151 ret
= send_consumer_relayd_sockets(0, session
->id
,
4152 snap_output
->consumer
, socket
,
4153 session
->name
, session
->hostname
,
4154 session
->live_timer
);
4155 pthread_mutex_unlock(socket
->lock
);
4156 if (ret
!= LTTNG_OK
) {
4168 * Record a kernel snapshot.
4170 * Return LTTNG_OK on success or a LTTNG_ERR code.
4172 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
4173 struct snapshot_output
*output
, struct ltt_session
*session
,
4174 int wait
, uint64_t nb_packets_per_stream
)
4184 * Copy kernel session sockets so we can communicate with the right
4185 * consumer for the snapshot record command.
4187 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
4189 ret
= LTTNG_ERR_NOMEM
;
4193 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
4194 if (ret
!= LTTNG_OK
) {
4195 goto error_snapshot
;
4198 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
4199 if (ret
!= LTTNG_OK
) {
4200 goto error_snapshot
;
4207 /* Clean up copied sockets so this output can use some other later on. */
4208 consumer_destroy_output_sockets(output
->consumer
);
4215 * Record a UST snapshot.
4217 * Return 0 on success or a LTTNG_ERR error code.
4219 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
4220 struct snapshot_output
*output
, struct ltt_session
*session
,
4221 int wait
, uint64_t nb_packets_per_stream
)
4230 * Copy UST session sockets so we can communicate with the right
4231 * consumer for the snapshot record command.
4233 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
4235 ret
= LTTNG_ERR_NOMEM
;
4239 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
4240 if (ret
!= LTTNG_OK
) {
4241 goto error_snapshot
;
4244 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
4248 ret
= LTTNG_ERR_INVALID
;
4251 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4254 goto error_snapshot
;
4260 /* Clean up copied sockets so this output can use some other later on. */
4261 consumer_destroy_output_sockets(output
->consumer
);
4267 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
4268 uint64_t cur_nr_packets
)
4270 uint64_t tot_size
= 0;
4272 if (session
->kernel_session
) {
4273 struct ltt_kernel_channel
*chan
;
4274 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4276 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4277 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4279 * Don't take channel into account if we
4280 * already grab all its packets.
4284 tot_size
+= chan
->channel
->attr
.subbuf_size
4285 * chan
->stream_count
;
4289 if (session
->ust_session
) {
4290 struct ltt_ust_session
*usess
= session
->ust_session
;
4292 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4300 * Calculate the number of packets we can grab from each stream that
4301 * fits within the overall snapshot max size.
4303 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4304 * the number of packets per stream.
4306 * TODO: this approach is not perfect: we consider the worse case
4307 * (packet filling the sub-buffers) as an upper bound, but we could do
4308 * better if we do this calculation while we actually grab the packet
4309 * content: we would know how much padding we don't actually store into
4312 * This algorithm is currently bounded by the number of packets per
4315 * Since we call this algorithm before actually grabbing the data, it's
4316 * an approximation: for instance, applications could appear/disappear
4317 * in between this call and actually grabbing data.
4320 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
4323 uint64_t cur_nb_packets
= 0;
4326 return 0; /* Infinite */
4329 size_left
= max_size
;
4331 uint64_t one_more_packet_tot_size
;
4333 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
4335 if (!one_more_packet_tot_size
) {
4336 /* We are already grabbing all packets. */
4339 size_left
-= one_more_packet_tot_size
;
4340 if (size_left
< 0) {
4345 if (!cur_nb_packets
) {
4346 /* Not enough room to grab one packet of each stream, error. */
4349 return cur_nb_packets
;
4353 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4355 * The wait parameter is ignored so this call always wait for the snapshot to
4356 * complete before returning.
4358 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4360 int cmd_snapshot_record(struct ltt_session
*session
,
4361 struct lttng_snapshot_output
*output
, int wait
)
4364 unsigned int use_tmp_output
= 0;
4365 struct snapshot_output tmp_output
;
4366 unsigned int snapshot_success
= 0;
4372 DBG("Cmd snapshot record for session %s", session
->name
);
4374 /* Get the datetime for the snapshot output directory. */
4375 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4378 ret
= LTTNG_ERR_INVALID
;
4383 * Permission denied to create an output if the session is not
4384 * set in no output mode.
4386 if (session
->output_traces
) {
4387 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4391 /* The session needs to be started at least once. */
4392 if (!session
->has_been_started
) {
4393 ret
= LTTNG_ERR_START_SESSION_ONCE
;
4397 /* Use temporary output for the session. */
4398 if (*output
->ctrl_url
!= '\0') {
4399 ret
= snapshot_output_init(output
->max_size
, output
->name
,
4400 output
->ctrl_url
, output
->data_url
, session
->consumer
,
4403 if (ret
== -ENOMEM
) {
4404 ret
= LTTNG_ERR_NOMEM
;
4406 ret
= LTTNG_ERR_INVALID
;
4410 /* Use the global session count for the temporary snapshot. */
4411 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4413 /* Use the global datetime */
4414 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4418 if (use_tmp_output
) {
4419 int64_t nb_packets_per_stream
;
4421 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4422 tmp_output
.max_size
);
4423 if (nb_packets_per_stream
< 0) {
4424 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4428 if (session
->kernel_session
) {
4429 ret
= record_kernel_snapshot(session
->kernel_session
,
4430 &tmp_output
, session
,
4431 wait
, nb_packets_per_stream
);
4432 if (ret
!= LTTNG_OK
) {
4437 if (session
->ust_session
) {
4438 ret
= record_ust_snapshot(session
->ust_session
,
4439 &tmp_output
, session
,
4440 wait
, nb_packets_per_stream
);
4441 if (ret
!= LTTNG_OK
) {
4446 snapshot_success
= 1;
4448 struct snapshot_output
*sout
;
4449 struct lttng_ht_iter iter
;
4452 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4453 &iter
.iter
, sout
, node
.node
) {
4454 int64_t nb_packets_per_stream
;
4457 * Make a local copy of the output and assign the possible
4458 * temporary value given by the caller.
4460 memset(&tmp_output
, 0, sizeof(tmp_output
));
4461 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
4463 if (output
->max_size
!= (uint64_t) -1ULL) {
4464 tmp_output
.max_size
= output
->max_size
;
4467 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4468 tmp_output
.max_size
);
4469 if (nb_packets_per_stream
< 0) {
4470 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4475 /* Use temporary name. */
4476 if (*output
->name
!= '\0') {
4477 if (lttng_strncpy(tmp_output
.name
, output
->name
,
4478 sizeof(tmp_output
.name
))) {
4479 ret
= LTTNG_ERR_INVALID
;
4485 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4486 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4488 if (session
->kernel_session
) {
4489 ret
= record_kernel_snapshot(session
->kernel_session
,
4490 &tmp_output
, session
,
4491 wait
, nb_packets_per_stream
);
4492 if (ret
!= LTTNG_OK
) {
4498 if (session
->ust_session
) {
4499 ret
= record_ust_snapshot(session
->ust_session
,
4500 &tmp_output
, session
,
4501 wait
, nb_packets_per_stream
);
4502 if (ret
!= LTTNG_OK
) {
4507 snapshot_success
= 1;
4512 if (snapshot_success
) {
4513 session
->snapshot
.nb_snapshot
++;
4515 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4523 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4525 int cmd_set_session_shm_path(struct ltt_session
*session
,
4526 const char *shm_path
)
4532 * Can only set shm path before session is started.
4534 if (session
->has_been_started
) {
4535 return LTTNG_ERR_SESSION_STARTED
;
4538 strncpy(session
->shm_path
, shm_path
,
4539 sizeof(session
->shm_path
));
4540 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4546 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4548 * Ask the consumer to rotate the session output directory.
4549 * The session lock must be held.
4551 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4553 int cmd_rotate_session(struct ltt_session
*session
,
4554 struct lttng_rotate_session_return
*rotate_return
)
4558 struct tm
*timeinfo
;
4561 bool ust_active
= false;
4565 if (!session
->has_been_started
) {
4566 ret
= -LTTNG_ERR_START_SESSION_ONCE
;
4570 if (session
->live_timer
|| session
->snapshot_mode
||
4571 !session
->output_traces
) {
4572 ret
= -LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4577 * Unsupported feature in lttng-relayd before 2.11.
4579 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4580 (session
->consumer
->relay_major_version
== 2 &&
4581 session
->consumer
->relay_minor_version
< 11)) {
4582 ret
= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4586 if (session
->rotate_pending
|| session
->rotate_pending_relay
) {
4587 ret
= -LTTNG_ERR_ROTATION_PENDING
;
4588 DBG("Rotate already in progress");
4593 * After a stop, we only allow one rotation to occur, the other ones are
4594 * useless until a new start.
4596 if (session
->rotated_after_last_stop
) {
4597 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4599 ret
= -LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4603 /* Special case for the first rotation. */
4604 if (session
->current_archive_id
== 0) {
4605 const char *base_path
= NULL
;
4607 /* Either one of the two sessions is enough to get the root path. */
4608 if (session
->kernel_session
) {
4609 base_path
= session_get_base_path(session
);
4610 } else if (session
->ust_session
) {
4611 base_path
= session_get_base_path(session
);
4616 ret
= lttng_strncpy(session
->rotation_chunk
.current_rotate_path
,
4618 sizeof(session
->rotation_chunk
.current_rotate_path
));
4620 ERR("Failed to copy session base path to current rotation chunk path");
4621 ret
= -LTTNG_ERR_UNK
;
4626 * The currently active tracing path is now the folder we
4629 ret
= lttng_strncpy(session
->rotation_chunk
.current_rotate_path
,
4630 session
->rotation_chunk
.active_tracing_path
,
4631 sizeof(session
->rotation_chunk
.current_rotate_path
));
4633 ERR("Failed to copy the active tracing path to the current rotate path");
4634 ret
= -LTTNG_ERR_UNK
;
4638 DBG("Current rotate path %s", session
->rotation_chunk
.current_rotate_path
);
4640 session
->current_archive_id
++;
4641 session
->rotate_pending
= true;
4642 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4643 ret
= notification_thread_command_session_rotation_ongoing(
4644 notification_thread_handle
,
4645 session
->name
, session
->uid
, session
->gid
,
4646 session
->current_archive_id
);
4647 if (ret
!= LTTNG_OK
) {
4648 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
4653 * Create the path name for the next chunk.
4656 if (now
== (time_t) -1) {
4657 ret
= -LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4660 session
->last_chunk_start_ts
= session
->current_chunk_start_ts
;
4661 session
->current_chunk_start_ts
= now
;
4663 timeinfo
= localtime(&now
);
4665 PERROR("Failed to sample local time in rotate session command");
4666 ret
= -LTTNG_ERR_UNK
;
4669 strf_ret
= strftime(datetime
, sizeof(datetime
), "%Y%m%dT%H%M%S%z",
4672 ERR("Failed to format local time timestamp in rotate session command");
4673 ret
= -LTTNG_ERR_UNK
;
4676 if (session
->kernel_session
) {
4678 * The active path for the next rotation/destroy.
4679 * Ex: ~/lttng-traces/auto-20170922-111748/20170922-111754-42
4681 ret
= snprintf(session
->rotation_chunk
.active_tracing_path
,
4682 sizeof(session
->rotation_chunk
.active_tracing_path
),
4684 session_get_base_path(session
),
4685 datetime
, session
->current_archive_id
+ 1);
4686 if (ret
< 0 || ret
== sizeof(session
->rotation_chunk
.active_tracing_path
)) {
4687 ERR("Failed to format active kernel tracing path in rotate session command");
4688 ret
= -LTTNG_ERR_UNK
;
4692 * The sub-directory for the consumer
4693 * Ex: /20170922-111754-42/kernel
4695 ret
= snprintf(session
->kernel_session
->consumer
->chunk_path
,
4696 sizeof(session
->kernel_session
->consumer
->chunk_path
),
4697 "/%s-%" PRIu64
, datetime
,
4698 session
->current_archive_id
+ 1);
4699 if (ret
< 0 || ret
== sizeof(session
->kernel_session
->consumer
->chunk_path
)) {
4700 ERR("Failed to format the kernel consumer's sub-directory in rotate session command");
4701 ret
= -LTTNG_ERR_UNK
;
4705 * Create the new chunk folder, before the rotation begins so we don't
4706 * race with the consumer/tracer activity.
4708 ret
= domain_mkdir(session
->kernel_session
->consumer
, session
,
4709 session
->kernel_session
->uid
,
4710 session
->kernel_session
->gid
);
4712 ERR("Failed to create kernel session tracing path at %s",
4713 session
->kernel_session
->consumer
->chunk_path
);
4714 ret
= -LTTNG_ERR_CREATE_DIR_FAIL
;
4717 ret
= kernel_rotate_session(session
);
4718 if (ret
!= LTTNG_OK
) {
4723 if (session
->ust_session
) {
4724 ret
= snprintf(session
->rotation_chunk
.active_tracing_path
,
4725 PATH_MAX
, "%s/%s-%" PRIu64
,
4726 session_get_base_path(session
),
4727 datetime
, session
->current_archive_id
+ 1);
4729 ERR("Failed to format active UST tracing path in rotate session command");
4730 ret
= -LTTNG_ERR_UNK
;
4733 ret
= snprintf(session
->ust_session
->consumer
->chunk_path
,
4734 PATH_MAX
, "/%s-%" PRIu64
, datetime
,
4735 session
->current_archive_id
+ 1);
4737 ERR("Failed to format the UST consumer's sub-directory in rotate session command");
4738 ret
= -LTTNG_ERR_UNK
;
4742 * Create the new chunk folder, before the rotation begins so we don't
4743 * race with the consumer/tracer activity.
4745 ret
= domain_mkdir(session
->ust_session
->consumer
, session
,
4746 session
->ust_session
->uid
,
4747 session
->ust_session
->gid
);
4749 ret
= -LTTNG_ERR_CREATE_DIR_FAIL
;
4752 ret
= ust_app_rotate_session(session
, &ust_active
);
4753 if (ret
!= LTTNG_OK
) {
4757 * Handle the case where we did not start a rotation on any channel.
4758 * The consumer will never wake up the rotation thread to perform the
4759 * rename, so we have to do it here while we hold the session and
4760 * session_list locks.
4762 if (!session
->kernel_session
&& !ust_active
) {
4763 struct lttng_trace_archive_location
*location
;
4765 session
->rotate_pending
= false;
4766 session
->rotation_state
= LTTNG_ROTATION_STATE_COMPLETED
;
4767 ret
= rename_complete_chunk(session
, now
);
4769 ERR("Failed to rename completed rotation chunk");
4773 /* Ownership of location is transferred. */
4774 location
= session_get_trace_archive_location(session
);
4775 ret
= notification_thread_command_session_rotation_completed(
4776 notification_thread_handle
,
4780 session
->current_archive_id
,
4782 if (ret
!= LTTNG_OK
) {
4783 ERR("Failed to notify notification thread that rotation is complete for session %s",
4789 if (!session
->active
) {
4790 session
->rotated_after_last_stop
= true;
4793 if (rotate_return
) {
4794 rotate_return
->rotation_id
= session
->current_archive_id
;
4797 DBG("Cmd rotate session %s, current_archive_id %" PRIu64
" sent",
4798 session
->name
, session
->current_archive_id
);
4806 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
4808 * Check if the session has finished its rotation.
4810 * Return 0 on success or else a LTTNG_ERR code.
4812 int cmd_rotate_get_info(struct ltt_session
*session
,
4813 struct lttng_rotation_get_info_return
*info_return
,
4814 uint64_t rotation_id
)
4820 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
4821 session
->current_archive_id
);
4823 if (session
->current_archive_id
!= rotation_id
) {
4824 info_return
->status
= (int32_t) LTTNG_ROTATION_STATE_EXPIRED
;
4829 switch (session
->rotation_state
) {
4830 case LTTNG_ROTATION_STATE_ONGOING
:
4831 DBG("Reporting that rotation id %" PRIu64
" of session %s is still pending",
4832 rotation_id
, session
->name
);
4834 case LTTNG_ROTATION_STATE_COMPLETED
:
4836 char *current_tracing_path_reply
;
4837 size_t current_tracing_path_reply_len
;
4839 switch (session_get_consumer_destination_type(session
)) {
4840 case CONSUMER_DST_LOCAL
:
4841 current_tracing_path_reply
=
4842 info_return
->location
.local
.absolute_path
;
4843 current_tracing_path_reply_len
=
4844 sizeof(info_return
->location
.local
.absolute_path
);
4845 info_return
->location_type
=
4846 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
4848 case CONSUMER_DST_NET
:
4849 current_tracing_path_reply
=
4850 info_return
->location
.relay
.relative_path
;
4851 current_tracing_path_reply_len
=
4852 sizeof(info_return
->location
.relay
.relative_path
);
4853 /* Currently the only supported relay protocol. */
4854 info_return
->location
.relay
.protocol
=
4855 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
4857 ret
= lttng_strncpy(info_return
->location
.relay
.host
,
4858 session_get_net_consumer_hostname(session
),
4859 sizeof(info_return
->location
.relay
.host
));
4861 ERR("Failed to host name to rotate_get_info reply");
4862 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4863 ret
= -LTTNG_ERR_UNK
;
4867 session_get_net_consumer_ports(session
,
4868 &info_return
->location
.relay
.ports
.control
,
4869 &info_return
->location
.relay
.ports
.data
);
4870 info_return
->location_type
=
4871 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
4876 ret
= lttng_strncpy(current_tracing_path_reply
,
4877 session
->rotation_chunk
.current_rotate_path
,
4878 current_tracing_path_reply_len
);
4880 ERR("Failed to copy current tracing path to rotate_get_info reply");
4881 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4882 ret
= -LTTNG_ERR_UNK
;
4888 case LTTNG_ROTATION_STATE_ERROR
:
4889 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session %s",
4890 rotation_id
, session
->name
);
4896 info_return
->status
= (int32_t) session
->rotation_state
;
4903 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
4905 * Configure the automatic rotation parameters.
4906 * 'activate' to true means activate the rotation schedule type with 'new_value'.
4907 * 'activate' to false means deactivate the rotation schedule and validate that
4908 * 'new_value' has the same value as the currently active value.
4910 * Return 0 on success or else a positive LTTNG_ERR code.
4912 int cmd_rotation_set_schedule(struct ltt_session
*session
,
4913 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
4915 struct notification_thread_handle
*notification_thread_handle
)
4918 uint64_t *parameter_value
;
4922 DBG("Cmd rotate set schedule session %s", session
->name
);
4924 if (session
->live_timer
|| session
->snapshot_mode
||
4925 !session
->output_traces
) {
4926 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
4927 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4931 switch (schedule_type
) {
4932 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
4933 parameter_value
= &session
->rotate_size
;
4935 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
4936 parameter_value
= &session
->rotate_timer_period
;
4937 if (new_value
>= UINT_MAX
) {
4938 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
4939 new_value
, UINT_MAX
);
4940 ret
= LTTNG_ERR_INVALID
;
4945 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
4946 ret
= LTTNG_ERR_INVALID
;
4950 /* Improper use of the API. */
4951 if (new_value
== -1ULL) {
4952 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
4953 ret
= LTTNG_ERR_INVALID
;
4958 * As indicated in struct ltt_session's comments, a value of == 0 means
4959 * this schedule rotation type is not in use.
4961 * Reject the command if we were asked to activate a schedule that was
4964 if (activate
&& *parameter_value
!= 0) {
4965 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
4966 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
4971 * Reject the command if we were asked to deactivate a schedule that was
4974 if (!activate
&& *parameter_value
== 0) {
4975 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
4976 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
4981 * Reject the command if we were asked to deactivate a schedule that
4984 if (!activate
&& *parameter_value
!= new_value
) {
4985 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
4986 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
4990 *parameter_value
= activate
? new_value
: 0;
4992 switch (schedule_type
) {
4993 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
4994 if (activate
&& session
->active
) {
4996 * Only start the timer if the session is active,
4997 * otherwise it will be started when the session starts.
4999 ret
= sessiond_rotate_timer_start(session
, new_value
);
5001 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5002 ret
= LTTNG_ERR_UNK
;
5006 ret
= sessiond_rotate_timer_stop(session
);
5008 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5009 ret
= LTTNG_ERR_UNK
;
5014 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5016 ret
= subscribe_session_consumed_size_rotation(session
,
5017 new_value
, notification_thread_handle
);
5019 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5020 ret
= LTTNG_ERR_UNK
;
5024 ret
= unsubscribe_session_consumed_size_rotation(session
,
5025 notification_thread_handle
);
5027 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5028 ret
= LTTNG_ERR_UNK
;
5035 /* Would have been caught before. */
5048 * Command ROTATE_GET_CURRENT_PATH from the lttng-ctl library.
5050 * Configure the automatic rotation parameters.
5051 * Set to -1ULL to disable them.
5053 * Return LTTNG_OK on success or else a LTTNG_ERR code.
5055 int cmd_session_get_current_output(struct ltt_session
*session
,
5056 struct lttng_session_get_current_output_return
*output_return
)
5061 if (!session
->snapshot_mode
) {
5062 if (session
->current_archive_id
== 0) {
5063 if (session
->kernel_session
) {
5064 path
= session_get_base_path(session
);
5065 } else if (session
->ust_session
) {
5066 path
= session_get_base_path(session
);
5072 path
= session
->rotation_chunk
.active_tracing_path
;
5076 * A snapshot session does not have a "current" trace archive
5082 DBG("Cmd get current output for session %s, returning %s",
5083 session
->name
, path
);
5085 ret
= lttng_strncpy(output_return
->path
,
5087 sizeof(output_return
->path
));
5089 ERR("Failed to copy trace output path to session get current output command reply");
5090 ret
= -LTTNG_ERR_UNK
;
5099 /* Wait for a given path to be removed before continuing. */
5100 static enum lttng_error_code
wait_on_path(void *path_data
)
5102 const char *shm_path
= path_data
;
5104 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5110 ret
= stat(shm_path
, &st
);
5112 if (errno
!= ENOENT
) {
5113 PERROR("stat() returned an error while checking for the existence of the shm path");
5115 DBG("shm path no longer exists, completing the destruction of session");
5119 if (!S_ISDIR(st
.st_mode
)) {
5120 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5125 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5131 * Returns a pointer to a handler to run on completion of a command.
5132 * Returns NULL if no handler has to be run for the last command executed.
5134 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5136 struct cmd_completion_handler
*handler
= current_completion_handler
;
5138 current_completion_handler
= NULL
;
5143 * Init command subsystem.
5148 * Set network sequence index to 1 for streams to match a relayd
5149 * socket on the consumer side.
5151 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5152 relayd_net_seq_idx
= 1;
5153 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5155 DBG("Command subsystem initialized");