2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
27 #include <common/defaults.h>
28 #include <common/common.h>
29 #include <common/sessiond-comm/sessiond-comm.h>
30 #include <common/relayd/relayd.h>
31 #include <common/utils.h>
32 #include <common/compat/string.h>
33 #include <common/kernel-ctl/kernel-ctl.h>
34 #include <common/dynamic-buffer.h>
35 #include <common/buffer-view.h>
36 #include <common/trace-chunk.h>
37 #include <lttng/location-internal.h>
38 #include <lttng/trigger/trigger-internal.h>
39 #include <lttng/condition/condition.h>
40 #include <lttng/action/action.h>
41 #include <lttng/channel.h>
42 #include <lttng/channel-internal.h>
43 #include <lttng/rotate-internal.h>
44 #include <lttng/location-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/userspace-probe-internal.h>
47 #include <lttng/session-descriptor-internal.h>
48 #include <common/string-utils/string-utils.h>
53 #include "health-sessiond.h"
55 #include "kernel-consumer.h"
56 #include "lttng-sessiond.h"
58 #include "lttng-syscall.h"
60 #include "buffer-registry.h"
61 #include "notification-thread.h"
62 #include "notification-thread-commands.h"
64 #include "rotation-thread.h"
66 #include "agent-thread.h"
70 /* Sleep for 100ms between each check for the shm path's deletion. */
71 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
73 struct cmd_destroy_session_reply_context
{
75 bool implicit_rotation_on_destroy
;
78 static enum lttng_error_code
wait_on_path(void *path
);
81 * Command completion handler that is used by the destroy command
82 * when a session that has a non-default shm_path is being destroyed.
84 * See comment in cmd_destroy_session() for the rationale.
86 static struct destroy_completion_handler
{
87 struct cmd_completion_handler handler
;
88 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
89 } destroy_completion_handler
= {
92 .data
= destroy_completion_handler
.shm_path
97 static struct cmd_completion_handler
*current_completion_handler
;
100 * Used to keep a unique index for each relayd socket created where this value
101 * is associated with streams on the consumer so it can match the right relayd
102 * to send to. It must be accessed with the relayd_net_seq_idx_lock
105 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
106 static uint64_t relayd_net_seq_idx
;
108 static int validate_ust_event_name(const char *);
109 static int cmd_enable_event_internal(struct ltt_session
*session
,
110 struct lttng_domain
*domain
,
111 char *channel_name
, struct lttng_event
*event
,
112 char *filter_expression
,
113 struct lttng_filter_bytecode
*filter
,
114 struct lttng_event_exclusion
*exclusion
,
118 * Create a session path used by list_lttng_sessions for the case that the
119 * session consumer is on the network.
121 static int build_network_session_path(char *dst
, size_t size
,
122 struct ltt_session
*session
)
124 int ret
, kdata_port
, udata_port
;
125 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
126 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
131 memset(tmp_urls
, 0, sizeof(tmp_urls
));
132 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
134 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
136 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
137 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
138 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
141 if (session
->ust_session
&& session
->ust_session
->consumer
) {
142 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
143 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
146 if (uuri
== NULL
&& kuri
== NULL
) {
147 uri
= &session
->consumer
->dst
.net
.control
;
148 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
149 } else if (kuri
&& uuri
) {
150 ret
= uri_compare(kuri
, uuri
);
154 /* Build uuri URL string */
155 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
162 } else if (kuri
&& uuri
== NULL
) {
164 } else if (uuri
&& kuri
== NULL
) {
168 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
174 * Do we have a UST url set. If yes, this means we have both kernel and UST
177 if (*tmp_uurl
!= '\0') {
178 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
179 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
182 if (kuri
|| (!kuri
&& !uuri
)) {
185 /* No kernel URI, use the UST port. */
188 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
196 * Get run-time attributes if the session has been started (discarded events,
199 static int get_kernel_runtime_stats(struct ltt_session
*session
,
200 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
201 uint64_t *lost_packets
)
205 if (!session
->has_been_started
) {
207 *discarded_events
= 0;
212 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
213 session
->kernel_session
->consumer
,
219 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
220 session
->kernel_session
->consumer
,
231 * Get run-time attributes if the session has been started (discarded events,
234 static int get_ust_runtime_stats(struct ltt_session
*session
,
235 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
236 uint64_t *lost_packets
)
239 struct ltt_ust_session
*usess
;
241 if (!discarded_events
|| !lost_packets
) {
246 usess
= session
->ust_session
;
247 assert(discarded_events
);
248 assert(lost_packets
);
250 if (!usess
|| !session
->has_been_started
) {
251 *discarded_events
= 0;
257 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
258 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
259 &usess
->buffer_reg_uid_list
,
260 usess
->consumer
, uchan
->id
,
261 uchan
->attr
.overwrite
,
264 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
265 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
266 uchan
, usess
->consumer
,
267 uchan
->attr
.overwrite
,
273 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
274 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
276 ERR("Unsupported buffer type");
287 * Fill lttng_channel array of all channels.
289 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
290 struct ltt_session
*session
, struct lttng_channel
*channels
,
291 struct lttng_channel_extended
*chan_exts
)
294 struct ltt_kernel_channel
*kchan
;
296 DBG("Listing channels for session %s", session
->name
);
299 case LTTNG_DOMAIN_KERNEL
:
300 /* Kernel channels */
301 if (session
->kernel_session
!= NULL
) {
302 cds_list_for_each_entry(kchan
,
303 &session
->kernel_session
->channel_list
.head
, list
) {
304 uint64_t discarded_events
, lost_packets
;
305 struct lttng_channel_extended
*extended
;
307 extended
= (struct lttng_channel_extended
*)
308 kchan
->channel
->attr
.extended
.ptr
;
310 ret
= get_kernel_runtime_stats(session
, kchan
,
311 &discarded_events
, &lost_packets
);
315 /* Copy lttng_channel struct to array */
316 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
317 channels
[i
].enabled
= kchan
->enabled
;
318 chan_exts
[i
].discarded_events
=
320 chan_exts
[i
].lost_packets
= lost_packets
;
321 chan_exts
[i
].monitor_timer_interval
=
322 extended
->monitor_timer_interval
;
323 chan_exts
[i
].blocking_timeout
= 0;
328 case LTTNG_DOMAIN_UST
:
330 struct lttng_ht_iter iter
;
331 struct ltt_ust_channel
*uchan
;
334 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
335 &iter
.iter
, uchan
, node
.node
) {
336 uint64_t discarded_events
= 0, lost_packets
= 0;
338 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
339 LTTNG_SYMBOL_NAME_LEN
)) {
342 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
343 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
344 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
345 channels
[i
].attr
.switch_timer_interval
=
346 uchan
->attr
.switch_timer_interval
;
347 channels
[i
].attr
.read_timer_interval
=
348 uchan
->attr
.read_timer_interval
;
349 channels
[i
].enabled
= uchan
->enabled
;
350 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
351 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
354 * Map enum lttng_ust_output to enum lttng_event_output.
356 switch (uchan
->attr
.output
) {
358 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
362 * LTTNG_UST_MMAP is the only supported UST
369 chan_exts
[i
].monitor_timer_interval
=
370 uchan
->monitor_timer_interval
;
371 chan_exts
[i
].blocking_timeout
=
372 uchan
->attr
.u
.s
.blocking_timeout
;
374 ret
= get_ust_runtime_stats(session
, uchan
,
375 &discarded_events
, &lost_packets
);
379 chan_exts
[i
].discarded_events
= discarded_events
;
380 chan_exts
[i
].lost_packets
= lost_packets
;
392 return -LTTNG_ERR_FATAL
;
398 static int increment_extended_len(const char *filter_expression
,
399 struct lttng_event_exclusion
*exclusion
,
400 const struct lttng_userspace_probe_location
*probe_location
,
401 size_t *extended_len
)
405 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
407 if (filter_expression
) {
408 *extended_len
+= strlen(filter_expression
) + 1;
412 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
415 if (probe_location
) {
416 ret
= lttng_userspace_probe_location_serialize(probe_location
,
421 *extended_len
+= ret
;
428 static int append_extended_info(const char *filter_expression
,
429 struct lttng_event_exclusion
*exclusion
,
430 struct lttng_userspace_probe_location
*probe_location
,
434 size_t filter_len
= 0;
435 size_t nb_exclusions
= 0;
436 size_t userspace_probe_location_len
= 0;
437 struct lttng_dynamic_buffer location_buffer
;
438 struct lttcomm_event_extended_header extended_header
;
440 if (filter_expression
) {
441 filter_len
= strlen(filter_expression
) + 1;
445 nb_exclusions
= exclusion
->count
;
448 if (probe_location
) {
449 lttng_dynamic_buffer_init(&location_buffer
);
450 ret
= lttng_userspace_probe_location_serialize(probe_location
,
451 &location_buffer
, NULL
);
456 userspace_probe_location_len
= location_buffer
.size
;
459 /* Set header fields */
460 extended_header
.filter_len
= filter_len
;
461 extended_header
.nb_exclusions
= nb_exclusions
;
462 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
465 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
466 *extended_at
+= sizeof(extended_header
);
468 /* Copy filter string */
469 if (filter_expression
) {
470 memcpy(*extended_at
, filter_expression
, filter_len
);
471 *extended_at
+= filter_len
;
474 /* Copy exclusion names */
476 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
478 memcpy(*extended_at
, &exclusion
->names
, len
);
482 if (probe_location
) {
483 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
484 *extended_at
+= location_buffer
.size
;
485 lttng_dynamic_buffer_reset(&location_buffer
);
493 * Create a list of agent domain events.
495 * Return number of events in list on success or else a negative value.
497 static int list_lttng_agent_events(struct agent
*agt
,
498 struct lttng_event
**events
, size_t *total_size
)
501 unsigned int nb_event
= 0;
502 struct agent_event
*event
;
503 struct lttng_event
*tmp_events
= NULL
;
504 struct lttng_ht_iter iter
;
505 size_t extended_len
= 0;
511 DBG3("Listing agent events");
514 nb_event
= lttng_ht_get_count(agt
->events
);
522 /* Compute required extended infos size */
523 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
526 * This is only valid because the commands which add events are
527 * processed in the same thread as the listing.
530 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
531 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
534 DBG("Error computing the length of extended info message");
535 ret
= -LTTNG_ERR_FATAL
;
541 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
542 tmp_events
= zmalloc(*total_size
);
544 PERROR("zmalloc agent events session");
545 ret
= -LTTNG_ERR_FATAL
;
549 extended_at
= ((uint8_t *) tmp_events
) +
550 nb_event
* sizeof(struct lttng_event
);
553 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
554 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
555 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
556 tmp_events
[i
].enabled
= event
->enabled
;
557 tmp_events
[i
].loglevel
= event
->loglevel_value
;
558 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
561 /* Append extended info */
562 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
565 DBG("Error appending extended info message");
566 ret
= -LTTNG_ERR_FATAL
;
571 *events
= tmp_events
;
573 assert(nb_event
== i
);
584 * Create a list of ust global domain events.
586 static int list_lttng_ust_global_events(char *channel_name
,
587 struct ltt_ust_domain_global
*ust_global
,
588 struct lttng_event
**events
, size_t *total_size
)
591 unsigned int nb_event
= 0;
592 struct lttng_ht_iter iter
;
593 struct lttng_ht_node_str
*node
;
594 struct ltt_ust_channel
*uchan
;
595 struct ltt_ust_event
*uevent
;
596 struct lttng_event
*tmp
;
597 size_t extended_len
= 0;
600 DBG("Listing UST global events for channel %s", channel_name
);
604 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
605 node
= lttng_ht_iter_get_node_str(&iter
);
607 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
611 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
613 nb_event
= lttng_ht_get_count(uchan
->events
);
620 DBG3("Listing UST global %d events", nb_event
);
622 /* Compute required extended infos size */
623 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
624 if (uevent
->internal
) {
629 ret
= increment_extended_len(uevent
->filter_expression
,
630 uevent
->exclusion
, NULL
, &extended_len
);
632 DBG("Error computing the length of extended info message");
633 ret
= -LTTNG_ERR_FATAL
;
638 /* All events are internal, skip. */
644 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
645 tmp
= zmalloc(*total_size
);
647 ret
= -LTTNG_ERR_FATAL
;
651 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
653 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
654 if (uevent
->internal
) {
655 /* This event should remain hidden from clients */
658 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
659 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
660 tmp
[i
].enabled
= uevent
->enabled
;
662 switch (uevent
->attr
.instrumentation
) {
663 case LTTNG_UST_TRACEPOINT
:
664 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
666 case LTTNG_UST_PROBE
:
667 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
669 case LTTNG_UST_FUNCTION
:
670 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
674 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
675 switch (uevent
->attr
.loglevel_type
) {
676 case LTTNG_UST_LOGLEVEL_ALL
:
677 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
679 case LTTNG_UST_LOGLEVEL_RANGE
:
680 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
682 case LTTNG_UST_LOGLEVEL_SINGLE
:
683 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
686 if (uevent
->filter
) {
689 if (uevent
->exclusion
) {
690 tmp
[i
].exclusion
= 1;
694 /* Append extended info */
695 ret
= append_extended_info(uevent
->filter_expression
,
696 uevent
->exclusion
, NULL
, &extended_at
);
698 DBG("Error appending extended info message");
699 ret
= -LTTNG_ERR_FATAL
;
712 * Fill lttng_event array of all kernel events in the channel.
714 static int list_lttng_kernel_events(char *channel_name
,
715 struct ltt_kernel_session
*kernel_session
,
716 struct lttng_event
**events
, size_t *total_size
)
719 unsigned int nb_event
;
720 struct ltt_kernel_event
*event
;
721 struct ltt_kernel_channel
*kchan
;
722 size_t extended_len
= 0;
725 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
727 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
731 nb_event
= kchan
->event_count
;
733 DBG("Listing events for channel %s", kchan
->channel
->name
);
741 /* Compute required extended infos size */
742 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
743 ret
= increment_extended_len(event
->filter_expression
, NULL
,
744 event
->userspace_probe_location
,
747 DBG("Error computing the length of extended info message");
748 ret
= -LTTNG_ERR_FATAL
;
753 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
754 *events
= zmalloc(*total_size
);
755 if (*events
== NULL
) {
756 ret
= -LTTNG_ERR_FATAL
;
760 extended_at
= ((void *) *events
) +
761 nb_event
* sizeof(struct lttng_event
);
763 /* Kernel channels */
764 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
765 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
766 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
767 (*events
)[i
].enabled
= event
->enabled
;
768 (*events
)[i
].filter
=
769 (unsigned char) !!event
->filter_expression
;
771 switch (event
->event
->instrumentation
) {
772 case LTTNG_KERNEL_TRACEPOINT
:
773 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
775 case LTTNG_KERNEL_KRETPROBE
:
776 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
777 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
778 sizeof(struct lttng_kernel_kprobe
));
780 case LTTNG_KERNEL_KPROBE
:
781 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
782 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
783 sizeof(struct lttng_kernel_kprobe
));
785 case LTTNG_KERNEL_UPROBE
:
786 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
788 case LTTNG_KERNEL_FUNCTION
:
789 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
790 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
791 sizeof(struct lttng_kernel_function
));
793 case LTTNG_KERNEL_NOOP
:
794 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
796 case LTTNG_KERNEL_SYSCALL
:
797 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
799 case LTTNG_KERNEL_ALL
:
807 /* Append extended info */
808 ret
= append_extended_info(event
->filter_expression
, NULL
,
809 event
->userspace_probe_location
, &extended_at
);
811 DBG("Error appending extended info message");
812 ret
= -LTTNG_ERR_FATAL
;
821 /* Negate the error code to differentiate the size from an error */
826 * Add URI so the consumer output object. Set the correct path depending on the
827 * domain adding the default trace directory.
829 static enum lttng_error_code
add_uri_to_consumer(
830 const struct ltt_session
*session
,
831 struct consumer_output
*consumer
,
832 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
835 enum lttng_error_code ret_code
= LTTNG_OK
;
839 if (consumer
== NULL
) {
840 DBG("No consumer detected. Don't add URI. Stopping.");
841 ret_code
= LTTNG_ERR_NO_CONSUMER
;
846 case LTTNG_DOMAIN_KERNEL
:
847 ret
= lttng_strncpy(consumer
->domain_subdir
,
848 DEFAULT_KERNEL_TRACE_DIR
,
849 sizeof(consumer
->domain_subdir
));
851 case LTTNG_DOMAIN_UST
:
852 ret
= lttng_strncpy(consumer
->domain_subdir
,
853 DEFAULT_UST_TRACE_DIR
,
854 sizeof(consumer
->domain_subdir
));
858 * This case is possible is we try to add the URI to the global
859 * tracing session consumer object which in this case there is
862 memset(consumer
->domain_subdir
, 0,
863 sizeof(consumer
->domain_subdir
));
867 ERR("Failed to initialize consumer output domain subdirectory");
868 ret_code
= LTTNG_ERR_FATAL
;
872 switch (uri
->dtype
) {
875 DBG2("Setting network URI to consumer");
877 if (consumer
->type
== CONSUMER_DST_NET
) {
878 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
879 consumer
->dst
.net
.control_isset
) ||
880 (uri
->stype
== LTTNG_STREAM_DATA
&&
881 consumer
->dst
.net
.data_isset
)) {
882 ret_code
= LTTNG_ERR_URL_EXIST
;
886 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
889 /* Set URI into consumer output object */
890 ret
= consumer_set_network_uri(session
, consumer
, uri
);
894 } else if (ret
== 1) {
896 * URI was the same in the consumer so we do not append the subdir
897 * again so to not duplicate output dir.
904 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
905 ret_code
= LTTNG_ERR_INVALID
;
908 DBG2("Setting trace directory path from URI to %s",
910 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
912 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
914 sizeof(consumer
->dst
.session_root_path
));
915 consumer
->type
= CONSUMER_DST_LOCAL
;
925 * Init tracing by creating trace directory and sending fds kernel consumer.
927 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
930 struct lttng_ht_iter iter
;
931 struct consumer_socket
*socket
;
937 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
938 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
940 pthread_mutex_lock(socket
->lock
);
941 ret
= kernel_consumer_send_session(socket
, session
);
942 pthread_mutex_unlock(socket
->lock
);
944 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
956 * Create a socket to the relayd using the URI.
958 * On success, the relayd_sock pointer is set to the created socket.
959 * Else, it remains untouched and an LTTng error code is returned.
961 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
962 struct lttcomm_relayd_sock
**relayd_sock
,
963 struct consumer_output
*consumer
)
966 enum lttng_error_code status
= LTTNG_OK
;
967 struct lttcomm_relayd_sock
*rsock
;
969 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
970 RELAYD_VERSION_COMM_MINOR
);
972 status
= LTTNG_ERR_FATAL
;
977 * Connect to relayd so we can proceed with a session creation. This call
978 * can possibly block for an arbitrary amount of time to set the health
979 * state to be in poll execution.
982 ret
= relayd_connect(rsock
);
985 ERR("Unable to reach lttng-relayd");
986 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
990 /* Create socket for control stream. */
991 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
992 DBG3("Creating relayd stream socket from URI");
994 /* Check relayd version */
995 ret
= relayd_version_check(rsock
);
996 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
997 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
999 } else if (ret
< 0) {
1000 ERR("Unable to reach lttng-relayd");
1001 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1004 consumer
->relay_major_version
= rsock
->major
;
1005 consumer
->relay_minor_version
= rsock
->minor
;
1006 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1007 DBG3("Creating relayd data socket from URI");
1009 /* Command is not valid */
1010 ERR("Relayd invalid stream type: %d", uri
->stype
);
1011 status
= LTTNG_ERR_INVALID
;
1015 *relayd_sock
= rsock
;
1020 /* The returned value is not useful since we are on an error path. */
1021 (void) relayd_close(rsock
);
1029 * Connect to the relayd using URI and send the socket to the right consumer.
1031 * The consumer socket lock must be held by the caller.
1033 * Returns LTTNG_OK on success or an LTTng error code on failure.
1035 static enum lttng_error_code
send_consumer_relayd_socket(
1036 unsigned int session_id
,
1037 struct lttng_uri
*relayd_uri
,
1038 struct consumer_output
*consumer
,
1039 struct consumer_socket
*consumer_sock
,
1040 const char *session_name
, const char *hostname
,
1041 int session_live_timer
)
1044 struct lttcomm_relayd_sock
*rsock
= NULL
;
1045 enum lttng_error_code status
;
1047 /* Connect to relayd and make version check if uri is the control. */
1048 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1049 if (status
!= LTTNG_OK
) {
1050 goto relayd_comm_error
;
1054 /* Set the network sequence index if not set. */
1055 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1056 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1058 * Increment net_seq_idx because we are about to transfer the
1059 * new relayd socket to the consumer.
1060 * Assign unique key so the consumer can match streams.
1062 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1063 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1066 /* Send relayd socket to consumer. */
1067 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1068 relayd_uri
->stype
, session_id
,
1069 session_name
, hostname
, session_live_timer
);
1071 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1075 /* Flag that the corresponding socket was sent. */
1076 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1077 consumer_sock
->control_sock_sent
= 1;
1078 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1079 consumer_sock
->data_sock_sent
= 1;
1083 * Close socket which was dup on the consumer side. The session daemon does
1084 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1088 if (status
!= LTTNG_OK
) {
1090 * The consumer output for this session should not be used anymore
1091 * since the relayd connection failed thus making any tracing or/and
1092 * streaming not usable.
1094 consumer
->enabled
= 0;
1096 (void) relayd_close(rsock
);
1104 * Send both relayd sockets to a specific consumer and domain. This is a
1105 * helper function to facilitate sending the information to the consumer for a
1108 * The consumer socket lock must be held by the caller.
1110 * Returns LTTNG_OK, or an LTTng error code on failure.
1112 static enum lttng_error_code
send_consumer_relayd_sockets(
1113 enum lttng_domain_type domain
,
1114 unsigned int session_id
, struct consumer_output
*consumer
,
1115 struct consumer_socket
*sock
, const char *session_name
,
1116 const char *hostname
, int session_live_timer
)
1118 enum lttng_error_code status
= LTTNG_OK
;
1123 /* Sending control relayd socket. */
1124 if (!sock
->control_sock_sent
) {
1125 status
= send_consumer_relayd_socket(session_id
,
1126 &consumer
->dst
.net
.control
, consumer
, sock
,
1127 session_name
, hostname
, session_live_timer
);
1128 if (status
!= LTTNG_OK
) {
1133 /* Sending data relayd socket. */
1134 if (!sock
->data_sock_sent
) {
1135 status
= send_consumer_relayd_socket(session_id
,
1136 &consumer
->dst
.net
.data
, consumer
, sock
,
1137 session_name
, hostname
, session_live_timer
);
1138 if (status
!= LTTNG_OK
) {
1148 * Setup relayd connections for a tracing session. First creates the socket to
1149 * the relayd and send them to the right domain consumer. Consumer type MUST be
1152 int cmd_setup_relayd(struct ltt_session
*session
)
1155 struct ltt_ust_session
*usess
;
1156 struct ltt_kernel_session
*ksess
;
1157 struct consumer_socket
*socket
;
1158 struct lttng_ht_iter iter
;
1162 usess
= session
->ust_session
;
1163 ksess
= session
->kernel_session
;
1165 DBG("Setting relayd for session %s", session
->name
);
1169 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1170 && usess
->consumer
->enabled
) {
1171 /* For each consumer socket, send relayd sockets */
1172 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1173 socket
, node
.node
) {
1174 pthread_mutex_lock(socket
->lock
);
1175 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1176 usess
->consumer
, socket
,
1177 session
->name
, session
->hostname
,
1178 session
->live_timer
);
1179 pthread_mutex_unlock(socket
->lock
);
1180 if (ret
!= LTTNG_OK
) {
1183 /* Session is now ready for network streaming. */
1184 session
->net_handle
= 1;
1186 session
->consumer
->relay_major_version
=
1187 usess
->consumer
->relay_major_version
;
1188 session
->consumer
->relay_minor_version
=
1189 usess
->consumer
->relay_minor_version
;
1192 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1193 && ksess
->consumer
->enabled
) {
1194 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1195 socket
, node
.node
) {
1196 pthread_mutex_lock(socket
->lock
);
1197 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1198 ksess
->consumer
, socket
,
1199 session
->name
, session
->hostname
,
1200 session
->live_timer
);
1201 pthread_mutex_unlock(socket
->lock
);
1202 if (ret
!= LTTNG_OK
) {
1205 /* Session is now ready for network streaming. */
1206 session
->net_handle
= 1;
1208 session
->consumer
->relay_major_version
=
1209 ksess
->consumer
->relay_major_version
;
1210 session
->consumer
->relay_minor_version
=
1211 ksess
->consumer
->relay_minor_version
;
1220 * Start a kernel session by opening all necessary streams.
1222 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1225 struct ltt_kernel_channel
*kchan
;
1227 /* Open kernel metadata */
1228 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1229 ret
= kernel_open_metadata(ksess
);
1231 ret
= LTTNG_ERR_KERN_META_FAIL
;
1236 /* Open kernel metadata stream */
1237 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1238 ret
= kernel_open_metadata_stream(ksess
);
1240 ERR("Kernel create metadata stream failed");
1241 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1246 /* For each channel */
1247 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1248 if (kchan
->stream_count
== 0) {
1249 ret
= kernel_open_channel_stream(kchan
);
1251 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1254 /* Update the stream global counter */
1255 ksess
->stream_count_global
+= ret
;
1259 /* Setup kernel consumer socket and send fds to it */
1260 ret
= init_kernel_tracing(ksess
);
1262 ret
= LTTNG_ERR_KERN_START_FAIL
;
1266 /* This start the kernel tracing */
1267 ret
= kernel_start_session(ksess
);
1269 ret
= LTTNG_ERR_KERN_START_FAIL
;
1273 /* Quiescent wait after starting trace */
1274 kernel_wait_quiescent(wpipe
);
1285 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1287 int cmd_disable_channel(struct ltt_session
*session
,
1288 enum lttng_domain_type domain
, char *channel_name
)
1291 struct ltt_ust_session
*usess
;
1293 usess
= session
->ust_session
;
1298 case LTTNG_DOMAIN_KERNEL
:
1300 ret
= channel_kernel_disable(session
->kernel_session
,
1302 if (ret
!= LTTNG_OK
) {
1306 kernel_wait_quiescent(kernel_tracer_fd
);
1309 case LTTNG_DOMAIN_UST
:
1311 struct ltt_ust_channel
*uchan
;
1312 struct lttng_ht
*chan_ht
;
1314 chan_ht
= usess
->domain_global
.channels
;
1316 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1317 if (uchan
== NULL
) {
1318 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1322 ret
= channel_ust_disable(usess
, uchan
);
1323 if (ret
!= LTTNG_OK
) {
1329 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1341 * Command LTTNG_TRACK_PID processed by the client thread.
1343 * Called with session lock held.
1345 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1353 case LTTNG_DOMAIN_KERNEL
:
1355 struct ltt_kernel_session
*ksess
;
1357 ksess
= session
->kernel_session
;
1359 ret
= kernel_track_pid(ksess
, pid
);
1360 if (ret
!= LTTNG_OK
) {
1364 kernel_wait_quiescent(kernel_tracer_fd
);
1367 case LTTNG_DOMAIN_UST
:
1369 struct ltt_ust_session
*usess
;
1371 usess
= session
->ust_session
;
1373 ret
= trace_ust_track_pid(usess
, pid
);
1374 if (ret
!= LTTNG_OK
) {
1380 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1392 * Command LTTNG_UNTRACK_PID processed by the client thread.
1394 * Called with session lock held.
1396 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1404 case LTTNG_DOMAIN_KERNEL
:
1406 struct ltt_kernel_session
*ksess
;
1408 ksess
= session
->kernel_session
;
1410 ret
= kernel_untrack_pid(ksess
, pid
);
1411 if (ret
!= LTTNG_OK
) {
1415 kernel_wait_quiescent(kernel_tracer_fd
);
1418 case LTTNG_DOMAIN_UST
:
1420 struct ltt_ust_session
*usess
;
1422 usess
= session
->ust_session
;
1424 ret
= trace_ust_untrack_pid(usess
, pid
);
1425 if (ret
!= LTTNG_OK
) {
1431 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1443 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1445 * The wpipe arguments is used as a notifier for the kernel thread.
1447 int cmd_enable_channel(struct ltt_session
*session
,
1448 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1451 struct ltt_ust_session
*usess
= session
->ust_session
;
1452 struct lttng_ht
*chan_ht
;
1459 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1461 /* Validate channel name */
1462 if (attr
->name
[0] == '.' ||
1463 memchr(attr
->name
, '/', len
) != NULL
) {
1464 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1468 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1473 * Don't try to enable a channel if the session has been started at
1474 * some point in time before. The tracer does not allow it.
1476 if (session
->has_been_started
) {
1477 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1482 * If the session is a live session, remove the switch timer, the
1483 * live timer does the same thing but sends also synchronisation
1484 * beacons for inactive streams.
1486 if (session
->live_timer
> 0) {
1487 attr
->attr
.live_timer_interval
= session
->live_timer
;
1488 attr
->attr
.switch_timer_interval
= 0;
1491 /* Check for feature support */
1492 switch (domain
->type
) {
1493 case LTTNG_DOMAIN_KERNEL
:
1495 if (kernel_supports_ring_buffer_snapshot_sample_positions(kernel_tracer_fd
) != 1) {
1496 /* Sampling position of buffer is not supported */
1497 WARN("Kernel tracer does not support buffer monitoring. "
1498 "Setting the monitor interval timer to 0 "
1499 "(disabled) for channel '%s' of session '%s'",
1500 attr
-> name
, session
->name
);
1501 lttng_channel_set_monitor_timer_interval(attr
, 0);
1505 case LTTNG_DOMAIN_UST
:
1507 case LTTNG_DOMAIN_JUL
:
1508 case LTTNG_DOMAIN_LOG4J
:
1509 case LTTNG_DOMAIN_PYTHON
:
1510 if (!agent_tracing_is_enabled()) {
1511 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1512 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1517 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1521 switch (domain
->type
) {
1522 case LTTNG_DOMAIN_KERNEL
:
1524 struct ltt_kernel_channel
*kchan
;
1526 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1527 session
->kernel_session
);
1528 if (kchan
== NULL
) {
1529 if (session
->snapshot
.nb_output
> 0 ||
1530 session
->snapshot_mode
) {
1531 /* Enforce mmap output for snapshot sessions. */
1532 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1534 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1535 if (attr
->name
[0] != '\0') {
1536 session
->kernel_session
->has_non_default_channel
= 1;
1539 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1542 if (ret
!= LTTNG_OK
) {
1546 kernel_wait_quiescent(kernel_tracer_fd
);
1549 case LTTNG_DOMAIN_UST
:
1550 case LTTNG_DOMAIN_JUL
:
1551 case LTTNG_DOMAIN_LOG4J
:
1552 case LTTNG_DOMAIN_PYTHON
:
1554 struct ltt_ust_channel
*uchan
;
1559 * Current agent implementation limitations force us to allow
1560 * only one channel at once in "agent" subdomains. Each
1561 * subdomain has a default channel name which must be strictly
1564 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1565 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1566 LTTNG_SYMBOL_NAME_LEN
)) {
1567 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1570 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1571 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1572 LTTNG_SYMBOL_NAME_LEN
)) {
1573 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1576 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1577 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1578 LTTNG_SYMBOL_NAME_LEN
)) {
1579 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1584 chan_ht
= usess
->domain_global
.channels
;
1586 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1587 if (uchan
== NULL
) {
1588 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1589 if (attr
->name
[0] != '\0') {
1590 usess
->has_non_default_channel
= 1;
1593 ret
= channel_ust_enable(usess
, uchan
);
1598 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1602 if (ret
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1603 session
->has_non_mmap_channel
= true;
1612 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1614 int cmd_disable_event(struct ltt_session
*session
,
1615 enum lttng_domain_type domain
, char *channel_name
,
1616 struct lttng_event
*event
)
1621 DBG("Disable event command for event \'%s\'", event
->name
);
1623 event_name
= event
->name
;
1625 /* Error out on unhandled search criteria */
1626 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1627 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1628 ret
= LTTNG_ERR_UNK
;
1635 case LTTNG_DOMAIN_KERNEL
:
1637 struct ltt_kernel_channel
*kchan
;
1638 struct ltt_kernel_session
*ksess
;
1640 ksess
= session
->kernel_session
;
1643 * If a non-default channel has been created in the
1644 * session, explicitely require that -c chan_name needs
1647 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1648 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1652 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1653 if (kchan
== NULL
) {
1654 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1658 switch (event
->type
) {
1659 case LTTNG_EVENT_ALL
:
1660 case LTTNG_EVENT_TRACEPOINT
:
1661 case LTTNG_EVENT_SYSCALL
:
1662 case LTTNG_EVENT_PROBE
:
1663 case LTTNG_EVENT_FUNCTION
:
1664 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1665 if (event_name
[0] == '\0') {
1666 ret
= event_kernel_disable_event(kchan
,
1669 ret
= event_kernel_disable_event(kchan
,
1670 event_name
, event
->type
);
1672 if (ret
!= LTTNG_OK
) {
1677 ret
= LTTNG_ERR_UNK
;
1681 kernel_wait_quiescent(kernel_tracer_fd
);
1684 case LTTNG_DOMAIN_UST
:
1686 struct ltt_ust_channel
*uchan
;
1687 struct ltt_ust_session
*usess
;
1689 usess
= session
->ust_session
;
1691 if (validate_ust_event_name(event_name
)) {
1692 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1697 * If a non-default channel has been created in the
1698 * session, explicitly require that -c chan_name needs
1701 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1702 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1706 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1708 if (uchan
== NULL
) {
1709 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1713 switch (event
->type
) {
1714 case LTTNG_EVENT_ALL
:
1716 * An empty event name means that everything
1717 * should be disabled.
1719 if (event
->name
[0] == '\0') {
1720 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1722 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1725 if (ret
!= LTTNG_OK
) {
1730 ret
= LTTNG_ERR_UNK
;
1734 DBG3("Disable UST event %s in channel %s completed", event_name
,
1738 case LTTNG_DOMAIN_LOG4J
:
1739 case LTTNG_DOMAIN_JUL
:
1740 case LTTNG_DOMAIN_PYTHON
:
1743 struct ltt_ust_session
*usess
= session
->ust_session
;
1747 switch (event
->type
) {
1748 case LTTNG_EVENT_ALL
:
1751 ret
= LTTNG_ERR_UNK
;
1755 agt
= trace_ust_find_agent(usess
, domain
);
1757 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1761 * An empty event name means that everything
1762 * should be disabled.
1764 if (event
->name
[0] == '\0') {
1765 ret
= event_agent_disable_all(usess
, agt
);
1767 ret
= event_agent_disable(usess
, agt
, event_name
);
1769 if (ret
!= LTTNG_OK
) {
1776 ret
= LTTNG_ERR_UND
;
1789 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1791 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1792 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1794 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1795 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1798 * Don't try to add a context if the session has been started at
1799 * some point in time before. The tracer does not allow it and would
1800 * result in a corrupted trace.
1802 if (session
->has_been_started
) {
1803 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1807 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1808 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1809 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1813 case LTTNG_DOMAIN_KERNEL
:
1814 assert(session
->kernel_session
);
1816 if (session
->kernel_session
->channel_count
== 0) {
1817 /* Create default channel */
1818 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1819 if (ret
!= LTTNG_OK
) {
1822 chan_kern_created
= 1;
1824 /* Add kernel context to kernel tracer */
1825 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1826 if (ret
!= LTTNG_OK
) {
1830 case LTTNG_DOMAIN_JUL
:
1831 case LTTNG_DOMAIN_LOG4J
:
1834 * Validate channel name.
1835 * If no channel name is given and the domain is JUL or LOG4J,
1836 * set it to the appropriate domain-specific channel name. If
1837 * a name is provided but does not match the expexted channel
1838 * name, return an error.
1840 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1841 strcmp(channel_name
,
1842 DEFAULT_JUL_CHANNEL_NAME
)) {
1843 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1845 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1846 strcmp(channel_name
,
1847 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1848 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1851 /* break is _not_ missing here. */
1853 case LTTNG_DOMAIN_UST
:
1855 struct ltt_ust_session
*usess
= session
->ust_session
;
1856 unsigned int chan_count
;
1860 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1861 if (chan_count
== 0) {
1862 struct lttng_channel
*attr
;
1863 /* Create default channel */
1864 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1866 ret
= LTTNG_ERR_FATAL
;
1870 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1871 if (ret
!= LTTNG_OK
) {
1875 channel_attr_destroy(attr
);
1876 chan_ust_created
= 1;
1879 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1880 free(app_ctx_provider_name
);
1882 app_ctx_name
= NULL
;
1883 app_ctx_provider_name
= NULL
;
1884 if (ret
!= LTTNG_OK
) {
1890 ret
= LTTNG_ERR_UND
;
1898 if (chan_kern_created
) {
1899 struct ltt_kernel_channel
*kchan
=
1900 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1901 session
->kernel_session
);
1902 /* Created previously, this should NOT fail. */
1904 kernel_destroy_channel(kchan
);
1907 if (chan_ust_created
) {
1908 struct ltt_ust_channel
*uchan
=
1909 trace_ust_find_channel_by_name(
1910 session
->ust_session
->domain_global
.channels
,
1911 DEFAULT_CHANNEL_NAME
);
1912 /* Created previously, this should NOT fail. */
1914 /* Remove from the channel list of the session. */
1915 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1917 trace_ust_destroy_channel(uchan
);
1920 free(app_ctx_provider_name
);
1925 static inline bool name_starts_with(const char *name
, const char *prefix
)
1927 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1929 return !strncmp(name
, prefix
, max_cmp_len
);
1932 /* Perform userspace-specific event name validation */
1933 static int validate_ust_event_name(const char *name
)
1943 * Check name against all internal UST event component namespaces used
1946 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1947 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1948 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1957 * Internal version of cmd_enable_event() with a supplemental
1958 * "internal_event" flag which is used to enable internal events which should
1959 * be hidden from clients. Such events are used in the agent implementation to
1960 * enable the events through which all "agent" events are funeled.
1962 static int _cmd_enable_event(struct ltt_session
*session
,
1963 struct lttng_domain
*domain
,
1964 char *channel_name
, struct lttng_event
*event
,
1965 char *filter_expression
,
1966 struct lttng_filter_bytecode
*filter
,
1967 struct lttng_event_exclusion
*exclusion
,
1968 int wpipe
, bool internal_event
)
1970 int ret
= 0, channel_created
= 0;
1971 struct lttng_channel
*attr
= NULL
;
1975 assert(channel_name
);
1977 /* If we have a filter, we must have its filter expression */
1978 assert(!(!!filter_expression
^ !!filter
));
1980 /* Normalize event name as a globbing pattern */
1981 strutils_normalize_star_glob_pattern(event
->name
);
1983 /* Normalize exclusion names as globbing patterns */
1987 for (i
= 0; i
< exclusion
->count
; i
++) {
1988 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
1990 strutils_normalize_star_glob_pattern(name
);
1994 DBG("Enable event command for event \'%s\'", event
->name
);
1998 switch (domain
->type
) {
1999 case LTTNG_DOMAIN_KERNEL
:
2001 struct ltt_kernel_channel
*kchan
;
2004 * If a non-default channel has been created in the
2005 * session, explicitely require that -c chan_name needs
2008 if (session
->kernel_session
->has_non_default_channel
2009 && channel_name
[0] == '\0') {
2010 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2014 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2015 session
->kernel_session
);
2016 if (kchan
== NULL
) {
2017 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2018 LTTNG_BUFFER_GLOBAL
);
2020 ret
= LTTNG_ERR_FATAL
;
2023 if (lttng_strncpy(attr
->name
, channel_name
,
2024 sizeof(attr
->name
))) {
2025 ret
= LTTNG_ERR_INVALID
;
2029 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2030 if (ret
!= LTTNG_OK
) {
2033 channel_created
= 1;
2036 /* Get the newly created kernel channel pointer */
2037 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2038 session
->kernel_session
);
2039 if (kchan
== NULL
) {
2040 /* This sould not happen... */
2041 ret
= LTTNG_ERR_FATAL
;
2045 switch (event
->type
) {
2046 case LTTNG_EVENT_ALL
:
2048 char *filter_expression_a
= NULL
;
2049 struct lttng_filter_bytecode
*filter_a
= NULL
;
2052 * We need to duplicate filter_expression and filter,
2053 * because ownership is passed to first enable
2056 if (filter_expression
) {
2057 filter_expression_a
= strdup(filter_expression
);
2058 if (!filter_expression_a
) {
2059 ret
= LTTNG_ERR_FATAL
;
2064 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2066 free(filter_expression_a
);
2067 ret
= LTTNG_ERR_FATAL
;
2070 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2072 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2073 ret
= event_kernel_enable_event(kchan
, event
,
2074 filter_expression
, filter
);
2075 /* We have passed ownership */
2076 filter_expression
= NULL
;
2078 if (ret
!= LTTNG_OK
) {
2079 if (channel_created
) {
2080 /* Let's not leak a useless channel. */
2081 kernel_destroy_channel(kchan
);
2083 free(filter_expression_a
);
2087 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2088 ret
= event_kernel_enable_event(kchan
, event
,
2089 filter_expression_a
, filter_a
);
2090 /* We have passed ownership */
2091 filter_expression_a
= NULL
;
2093 if (ret
!= LTTNG_OK
) {
2098 case LTTNG_EVENT_PROBE
:
2099 case LTTNG_EVENT_USERSPACE_PROBE
:
2100 case LTTNG_EVENT_FUNCTION
:
2101 case LTTNG_EVENT_FUNCTION_ENTRY
:
2102 case LTTNG_EVENT_TRACEPOINT
:
2103 ret
= event_kernel_enable_event(kchan
, event
,
2104 filter_expression
, filter
);
2105 /* We have passed ownership */
2106 filter_expression
= NULL
;
2108 if (ret
!= LTTNG_OK
) {
2109 if (channel_created
) {
2110 /* Let's not leak a useless channel. */
2111 kernel_destroy_channel(kchan
);
2116 case LTTNG_EVENT_SYSCALL
:
2117 ret
= event_kernel_enable_event(kchan
, event
,
2118 filter_expression
, filter
);
2119 /* We have passed ownership */
2120 filter_expression
= NULL
;
2122 if (ret
!= LTTNG_OK
) {
2127 ret
= LTTNG_ERR_UNK
;
2131 kernel_wait_quiescent(kernel_tracer_fd
);
2134 case LTTNG_DOMAIN_UST
:
2136 struct ltt_ust_channel
*uchan
;
2137 struct ltt_ust_session
*usess
= session
->ust_session
;
2142 * If a non-default channel has been created in the
2143 * session, explicitely require that -c chan_name needs
2146 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2147 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2151 /* Get channel from global UST domain */
2152 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2154 if (uchan
== NULL
) {
2155 /* Create default channel */
2156 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2157 usess
->buffer_type
);
2159 ret
= LTTNG_ERR_FATAL
;
2162 if (lttng_strncpy(attr
->name
, channel_name
,
2163 sizeof(attr
->name
))) {
2164 ret
= LTTNG_ERR_INVALID
;
2168 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2169 if (ret
!= LTTNG_OK
) {
2173 /* Get the newly created channel reference back */
2174 uchan
= trace_ust_find_channel_by_name(
2175 usess
->domain_global
.channels
, channel_name
);
2179 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2181 * Don't allow users to add UST events to channels which
2182 * are assigned to a userspace subdomain (JUL, Log4J,
2185 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2189 if (!internal_event
) {
2191 * Ensure the event name is not reserved for internal
2194 ret
= validate_ust_event_name(event
->name
);
2196 WARN("Userspace event name %s failed validation.",
2198 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2203 /* At this point, the session and channel exist on the tracer */
2204 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2205 filter_expression
, filter
, exclusion
,
2207 /* We have passed ownership */
2208 filter_expression
= NULL
;
2211 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2212 goto already_enabled
;
2213 } else if (ret
!= LTTNG_OK
) {
2218 case LTTNG_DOMAIN_LOG4J
:
2219 case LTTNG_DOMAIN_JUL
:
2220 case LTTNG_DOMAIN_PYTHON
:
2222 const char *default_event_name
, *default_chan_name
;
2224 struct lttng_event uevent
;
2225 struct lttng_domain tmp_dom
;
2226 struct ltt_ust_session
*usess
= session
->ust_session
;
2230 if (!agent_tracing_is_enabled()) {
2231 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2232 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2236 agt
= trace_ust_find_agent(usess
, domain
->type
);
2238 agt
= agent_create(domain
->type
);
2240 ret
= LTTNG_ERR_NOMEM
;
2243 agent_add(agt
, usess
->agents
);
2246 /* Create the default tracepoint. */
2247 memset(&uevent
, 0, sizeof(uevent
));
2248 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2249 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2250 default_event_name
= event_get_default_agent_ust_name(
2252 if (!default_event_name
) {
2253 ret
= LTTNG_ERR_FATAL
;
2256 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2257 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2260 * The domain type is changed because we are about to enable the
2261 * default channel and event for the JUL domain that are hardcoded.
2262 * This happens in the UST domain.
2264 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2265 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2267 switch (domain
->type
) {
2268 case LTTNG_DOMAIN_LOG4J
:
2269 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2271 case LTTNG_DOMAIN_JUL
:
2272 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2274 case LTTNG_DOMAIN_PYTHON
:
2275 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2278 /* The switch/case we are in makes this impossible */
2283 char *filter_expression_copy
= NULL
;
2284 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2287 const size_t filter_size
= sizeof(
2288 struct lttng_filter_bytecode
)
2291 filter_copy
= zmalloc(filter_size
);
2293 ret
= LTTNG_ERR_NOMEM
;
2296 memcpy(filter_copy
, filter
, filter_size
);
2298 filter_expression_copy
=
2299 strdup(filter_expression
);
2300 if (!filter_expression
) {
2301 ret
= LTTNG_ERR_NOMEM
;
2304 if (!filter_expression_copy
|| !filter_copy
) {
2305 free(filter_expression_copy
);
2311 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2312 (char *) default_chan_name
,
2313 &uevent
, filter_expression_copy
,
2314 filter_copy
, NULL
, wpipe
);
2317 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2318 goto already_enabled
;
2319 } else if (ret
!= LTTNG_OK
) {
2323 /* The wild card * means that everything should be enabled. */
2324 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2325 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2328 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2332 filter_expression
= NULL
;
2333 if (ret
!= LTTNG_OK
) {
2340 ret
= LTTNG_ERR_UND
;
2348 free(filter_expression
);
2351 channel_attr_destroy(attr
);
2357 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2358 * We own filter, exclusion, and filter_expression.
2360 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2361 char *channel_name
, struct lttng_event
*event
,
2362 char *filter_expression
,
2363 struct lttng_filter_bytecode
*filter
,
2364 struct lttng_event_exclusion
*exclusion
,
2367 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2368 filter_expression
, filter
, exclusion
, wpipe
, false);
2372 * Enable an event which is internal to LTTng. An internal should
2373 * never be made visible to clients and are immune to checks such as
2376 static int cmd_enable_event_internal(struct ltt_session
*session
,
2377 struct lttng_domain
*domain
,
2378 char *channel_name
, struct lttng_event
*event
,
2379 char *filter_expression
,
2380 struct lttng_filter_bytecode
*filter
,
2381 struct lttng_event_exclusion
*exclusion
,
2384 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2385 filter_expression
, filter
, exclusion
, wpipe
, true);
2389 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2391 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2392 struct lttng_event
**events
)
2395 ssize_t nb_events
= 0;
2398 case LTTNG_DOMAIN_KERNEL
:
2399 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2400 if (nb_events
< 0) {
2401 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2405 case LTTNG_DOMAIN_UST
:
2406 nb_events
= ust_app_list_events(events
);
2407 if (nb_events
< 0) {
2408 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2412 case LTTNG_DOMAIN_LOG4J
:
2413 case LTTNG_DOMAIN_JUL
:
2414 case LTTNG_DOMAIN_PYTHON
:
2415 nb_events
= agent_list_events(events
, domain
);
2416 if (nb_events
< 0) {
2417 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2422 ret
= LTTNG_ERR_UND
;
2429 /* Return negative value to differentiate return code */
2434 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2436 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2437 struct lttng_event_field
**fields
)
2440 ssize_t nb_fields
= 0;
2443 case LTTNG_DOMAIN_UST
:
2444 nb_fields
= ust_app_list_event_fields(fields
);
2445 if (nb_fields
< 0) {
2446 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2450 case LTTNG_DOMAIN_KERNEL
:
2451 default: /* fall-through */
2452 ret
= LTTNG_ERR_UND
;
2459 /* Return negative value to differentiate return code */
2463 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2465 return syscall_table_list(events
);
2469 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2471 * Called with session lock held.
2473 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2474 enum lttng_domain_type domain
, int32_t **pids
)
2477 ssize_t nr_pids
= 0;
2480 case LTTNG_DOMAIN_KERNEL
:
2482 struct ltt_kernel_session
*ksess
;
2484 ksess
= session
->kernel_session
;
2485 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2487 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2492 case LTTNG_DOMAIN_UST
:
2494 struct ltt_ust_session
*usess
;
2496 usess
= session
->ust_session
;
2497 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2499 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2504 case LTTNG_DOMAIN_LOG4J
:
2505 case LTTNG_DOMAIN_JUL
:
2506 case LTTNG_DOMAIN_PYTHON
:
2508 ret
= LTTNG_ERR_UND
;
2515 /* Return negative value to differentiate return code */
2520 * Command LTTNG_START_TRACE processed by the client thread.
2522 * Called with session mutex held.
2524 int cmd_start_trace(struct ltt_session
*session
)
2526 enum lttng_error_code ret
;
2527 unsigned long nb_chan
= 0;
2528 struct ltt_kernel_session
*ksession
;
2529 struct ltt_ust_session
*usess
;
2533 /* Ease our life a bit ;) */
2534 ksession
= session
->kernel_session
;
2535 usess
= session
->ust_session
;
2537 /* Is the session already started? */
2538 if (session
->active
) {
2539 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2544 * Starting a session without channel is useless since after that it's not
2545 * possible to enable channel thus inform the client.
2547 if (usess
&& usess
->domain_global
.channels
) {
2548 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2551 nb_chan
+= ksession
->channel_count
;
2554 ret
= LTTNG_ERR_NO_CHANNEL
;
2558 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2559 struct lttng_trace_chunk
*trace_chunk
;
2561 trace_chunk
= session_create_new_trace_chunk(
2562 session
, NULL
, NULL
);
2564 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2567 assert(!session
->current_trace_chunk
);
2568 ret
= session_set_trace_chunk(session
, trace_chunk
, NULL
);
2569 lttng_trace_chunk_put(trace_chunk
);
2571 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2576 /* Kernel tracing */
2577 if (ksession
!= NULL
) {
2578 DBG("Start kernel tracing session %s", session
->name
);
2579 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2580 if (ret
!= LTTNG_OK
) {
2585 /* Flag session that trace should start automatically */
2587 int int_ret
= ust_app_start_trace_all(usess
);
2590 ret
= LTTNG_ERR_UST_START_FAIL
;
2595 /* Flag this after a successful start. */
2596 session
->has_been_started
= 1;
2597 session
->active
= 1;
2600 * Clear the flag that indicates that a rotation was done while the
2601 * session was stopped.
2603 session
->rotated_after_last_stop
= false;
2605 if (session
->rotate_timer_period
) {
2606 int int_ret
= timer_session_rotation_schedule_timer_start(
2607 session
, session
->rotate_timer_period
);
2610 ERR("Failed to enable rotate timer");
2611 ret
= LTTNG_ERR_UNK
;
2623 * Command LTTNG_STOP_TRACE processed by the client thread.
2625 int cmd_stop_trace(struct ltt_session
*session
)
2628 struct ltt_kernel_channel
*kchan
;
2629 struct ltt_kernel_session
*ksession
;
2630 struct ltt_ust_session
*usess
;
2631 bool error_occurred
= false;
2635 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2637 ksession
= session
->kernel_session
;
2638 usess
= session
->ust_session
;
2640 /* Session is not active. Skip everythong and inform the client. */
2641 if (!session
->active
) {
2642 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2647 if (ksession
&& ksession
->active
) {
2648 DBG("Stop kernel tracing");
2650 ret
= kernel_stop_session(ksession
);
2652 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2656 kernel_wait_quiescent(kernel_tracer_fd
);
2658 /* Flush metadata after stopping (if exists) */
2659 if (ksession
->metadata_stream_fd
>= 0) {
2660 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2662 ERR("Kernel metadata flush failed");
2666 /* Flush all buffers after stopping */
2667 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2668 ret
= kernel_flush_buffer(kchan
);
2670 ERR("Kernel flush buffer error");
2674 ksession
->active
= 0;
2675 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2679 if (usess
&& usess
->active
) {
2680 ret
= ust_app_stop_trace_all(usess
);
2682 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2687 /* Flag inactive after a successful stop. */
2688 session
->active
= 0;
2689 ret
= !error_occurred
? LTTNG_OK
: LTTNG_ERR_UNK
;
2696 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2698 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2699 struct lttng_uri
*uris
)
2702 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2703 struct ltt_ust_session
*usess
= session
->ust_session
;
2709 /* Can't set consumer URI if the session is active. */
2710 if (session
->active
) {
2711 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2715 /* Set the "global" consumer URIs */
2716 for (i
= 0; i
< nb_uri
; i
++) {
2717 ret
= add_uri_to_consumer(session
,
2719 &uris
[i
], LTTNG_DOMAIN_NONE
);
2720 if (ret
!= LTTNG_OK
) {
2725 /* Set UST session URIs */
2726 if (session
->ust_session
) {
2727 for (i
= 0; i
< nb_uri
; i
++) {
2728 ret
= add_uri_to_consumer(session
,
2729 session
->ust_session
->consumer
,
2730 &uris
[i
], LTTNG_DOMAIN_UST
);
2731 if (ret
!= LTTNG_OK
) {
2737 /* Set kernel session URIs */
2738 if (session
->kernel_session
) {
2739 for (i
= 0; i
< nb_uri
; i
++) {
2740 ret
= add_uri_to_consumer(session
,
2741 session
->kernel_session
->consumer
,
2742 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2743 if (ret
!= LTTNG_OK
) {
2750 * Make sure to set the session in output mode after we set URI since a
2751 * session can be created without URL (thus flagged in no output mode).
2753 session
->output_traces
= 1;
2755 ksess
->output_traces
= 1;
2759 usess
->output_traces
= 1;
2770 enum lttng_error_code
set_session_output_from_descriptor(
2771 struct ltt_session
*session
,
2772 const struct lttng_session_descriptor
*descriptor
)
2775 enum lttng_error_code ret_code
= LTTNG_OK
;
2776 enum lttng_session_descriptor_type session_type
=
2777 lttng_session_descriptor_get_type(descriptor
);
2778 enum lttng_session_descriptor_output_type output_type
=
2779 lttng_session_descriptor_get_output_type(descriptor
);
2780 struct lttng_uri uris
[2] = {};
2781 size_t uri_count
= 0;
2783 switch (output_type
) {
2784 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2786 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2787 lttng_session_descriptor_get_local_output_uri(descriptor
,
2791 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2792 lttng_session_descriptor_get_network_output_uris(descriptor
,
2793 &uris
[0], &uris
[1]);
2797 ret_code
= LTTNG_ERR_INVALID
;
2801 switch (session_type
) {
2802 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2804 struct snapshot_output
*new_output
= NULL
;
2806 new_output
= snapshot_output_alloc();
2808 ret_code
= LTTNG_ERR_NOMEM
;
2812 ret
= snapshot_output_init_with_uri(session
,
2813 DEFAULT_SNAPSHOT_MAX_SIZE
,
2814 NULL
, uris
, uri_count
, session
->consumer
,
2815 new_output
, &session
->snapshot
);
2817 ret_code
= (ret
== -ENOMEM
) ?
2818 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2819 snapshot_output_destroy(new_output
);
2822 snapshot_add_output(&session
->snapshot
, new_output
);
2825 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2826 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2828 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2832 ret_code
= LTTNG_ERR_INVALID
;
2840 enum lttng_error_code
cmd_create_session_from_descriptor(
2841 struct lttng_session_descriptor
*descriptor
,
2842 const lttng_sock_cred
*creds
,
2843 const char *home_path
)
2846 enum lttng_error_code ret_code
;
2847 const char *session_name
;
2848 struct ltt_session
*new_session
= NULL
;
2849 enum lttng_session_descriptor_status descriptor_status
;
2851 session_lock_list();
2853 if (*home_path
!= '/') {
2854 ERR("Home path provided by client is not absolute");
2855 ret_code
= LTTNG_ERR_INVALID
;
2860 descriptor_status
= lttng_session_descriptor_get_session_name(
2861 descriptor
, &session_name
);
2862 switch (descriptor_status
) {
2863 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
2865 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
2866 session_name
= NULL
;
2869 ret_code
= LTTNG_ERR_INVALID
;
2872 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
2874 if (ret_code
!= LTTNG_OK
) {
2878 if (!session_name
) {
2879 ret
= lttng_session_descriptor_set_session_name(descriptor
,
2882 ret_code
= LTTNG_ERR_SESSION_FAIL
;
2887 if (!lttng_session_descriptor_is_output_destination_initialized(
2890 * Only include the session's creation time in the output
2891 * destination if the name of the session itself was
2892 * not auto-generated.
2894 ret_code
= lttng_session_descriptor_set_default_output(
2896 session_name
? &new_session
->creation_time
: NULL
,
2898 if (ret_code
!= LTTNG_OK
) {
2902 new_session
->has_user_specified_directory
=
2903 lttng_session_descriptor_has_output_directory(
2907 switch (lttng_session_descriptor_get_type(descriptor
)) {
2908 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2909 new_session
->snapshot_mode
= 1;
2911 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2912 new_session
->live_timer
=
2913 lttng_session_descriptor_live_get_timer_interval(
2920 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
2921 if (ret_code
!= LTTNG_OK
) {
2924 new_session
->consumer
->enabled
= 1;
2925 ret_code
= LTTNG_OK
;
2927 /* Release reference provided by the session_create function. */
2928 session_put(new_session
);
2929 if (ret_code
!= LTTNG_OK
&& new_session
) {
2930 /* Release the global reference on error. */
2931 session_destroy(new_session
);
2933 session_unlock_list();
2937 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
2938 struct lttng_session_descriptor
**return_descriptor
)
2941 size_t payload_size
;
2942 struct lttng_dynamic_buffer payload
;
2943 struct lttng_buffer_view home_dir_view
;
2944 struct lttng_buffer_view session_descriptor_view
;
2945 struct lttng_session_descriptor
*session_descriptor
= NULL
;
2946 enum lttng_error_code ret_code
;
2948 lttng_dynamic_buffer_init(&payload
);
2949 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
2951 ret_code
= LTTNG_ERR_INVALID
;
2954 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
2955 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
2956 ret_code
= LTTNG_ERR_INVALID
;
2960 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
2961 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
2962 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
2964 ret_code
= LTTNG_ERR_NOMEM
;
2968 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
2970 ERR("Reception of session descriptor failed, aborting.");
2971 ret_code
= LTTNG_ERR_SESSION_FAIL
;
2975 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
2978 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
2979 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
2981 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
2982 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
2984 ret
= lttng_session_descriptor_create_from_buffer(
2985 &session_descriptor_view
, &session_descriptor
);
2987 ERR("Failed to create session descriptor from payload of \"create session\" command");
2988 ret_code
= LTTNG_ERR_INVALID
;
2993 * Sets the descriptor's auto-generated properties (name, output) if
2996 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
2998 home_dir_view
.size
? home_dir_view
.data
: NULL
);
2999 if (ret_code
!= LTTNG_OK
) {
3003 ret_code
= LTTNG_OK
;
3004 *return_descriptor
= session_descriptor
;
3005 session_descriptor
= NULL
;
3007 lttng_dynamic_buffer_reset(&payload
);
3008 lttng_session_descriptor_destroy(session_descriptor
);
3013 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3014 void *_reply_context
)
3018 const struct cmd_destroy_session_reply_context
*reply_context
=
3020 struct lttng_dynamic_buffer payload
;
3021 struct lttcomm_session_destroy_command_header cmd_header
;
3022 struct lttng_trace_archive_location
*location
= NULL
;
3023 struct lttcomm_lttng_msg llm
= {
3024 .cmd_type
= LTTNG_DESTROY_SESSION
,
3025 .ret_code
= LTTNG_OK
,
3028 sizeof(struct lttcomm_session_destroy_command_header
),
3031 size_t payload_size_before_location
;
3033 lttng_dynamic_buffer_init(&payload
);
3035 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3037 ERR("Failed to append session destruction message");
3041 cmd_header
.rotation_state
=
3042 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3043 session
->rotation_state
:
3044 LTTNG_ROTATION_STATE_NO_ROTATION
);
3045 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3046 sizeof(cmd_header
));
3048 ERR("Failed to append session destruction command header");
3052 if (!reply_context
->implicit_rotation_on_destroy
) {
3053 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3057 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3058 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3063 location
= session_get_trace_archive_location(session
);
3065 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3070 payload_size_before_location
= payload
.size
;
3071 comm_ret
= lttng_trace_archive_location_serialize(location
,
3074 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3078 /* Update the message to indicate the location's length. */
3079 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3080 payload
.size
- payload_size_before_location
;
3082 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3083 payload
.data
, payload
.size
);
3084 if (comm_ret
!= (ssize_t
) payload
.size
) {
3085 ERR("Failed to send result of the destruction of session \"%s\" to client",
3089 ret
= close(reply_context
->reply_sock_fd
);
3091 PERROR("Failed to close client socket in deferred session destroy reply");
3093 lttng_dynamic_buffer_reset(&payload
);
3094 free(_reply_context
);
3098 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3100 * Called with session lock held.
3102 int cmd_destroy_session(struct ltt_session
*session
,
3103 struct notification_thread_handle
*notification_thread_handle
,
3107 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3110 reply_context
= zmalloc(sizeof(*reply_context
));
3111 if (!reply_context
) {
3112 ret
= LTTNG_ERR_NOMEM
;
3115 reply_context
->reply_sock_fd
= *sock_fd
;
3121 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3123 if (session
->active
) {
3124 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3126 ret
= cmd_stop_trace(session
);
3127 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3128 /* Carry on with the destruction of the session. */
3129 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3130 session
->name
, lttng_strerror(-ret
));
3134 if (session
->rotation_schedule_timer_enabled
) {
3135 if (timer_session_rotation_schedule_timer_stop(
3137 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3142 if (session
->rotate_size
) {
3143 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3144 session
->rotate_size
= 0;
3147 if (session
->most_recent_chunk_id
.is_set
&&
3148 session
->most_recent_chunk_id
.value
!= 0 &&
3149 session
->current_trace_chunk
) {
3150 ret
= cmd_rotate_session(session
, NULL
);
3151 if (ret
!= LTTNG_OK
) {
3152 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3153 session
->name
, lttng_strerror(-ret
));
3155 if (reply_context
) {
3156 reply_context
->implicit_rotation_on_destroy
= true;
3160 if (session
->shm_path
[0]) {
3162 * When a session is created with an explicit shm_path,
3163 * the consumer daemon will create its shared memory files
3164 * at that location and will *not* unlink them. This is normal
3165 * as the intention of that feature is to make it possible
3166 * to retrieve the content of those files should a crash occur.
3168 * To ensure the content of those files can be used, the
3169 * sessiond daemon will replicate the content of the metadata
3170 * cache in a metadata file.
3172 * On clean-up, it is expected that the consumer daemon will
3173 * unlink the shared memory files and that the session daemon
3174 * will unlink the metadata file. Then, the session's directory
3175 * in the shm path can be removed.
3177 * Unfortunately, a flaw in the design of the sessiond's and
3178 * consumerd's tear down of channels makes it impossible to
3179 * determine when the sessiond _and_ the consumerd have both
3180 * destroyed their representation of a channel. For one, the
3181 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3182 * callbacks in both daemons.
3184 * However, it is also impossible for the sessiond to know when
3185 * the consumer daemon is done destroying its channel(s) since
3186 * it occurs as a reaction to the closing of the channel's file
3187 * descriptor. There is no resulting communication initiated
3188 * from the consumerd to the sessiond to confirm that the
3189 * operation is completed (and was successful).
3191 * Until this is all fixed, the session daemon checks for the
3192 * removal of the session's shm path which makes it possible
3193 * to safely advertise a session as having been destroyed.
3195 * Prior to this fix, it was not possible to reliably save
3196 * a session making use of the --shm-path option, destroy it,
3197 * and load it again. This is because the creation of the
3198 * session would fail upon seeing the session's shm path
3199 * already in existence.
3201 * Note that none of the error paths in the check for the
3202 * directory's existence return an error. This is normal
3203 * as there isn't much that can be done. The session will
3204 * be destroyed properly, except that we can't offer the
3205 * guarantee that the same session can be re-created.
3207 current_completion_handler
= &destroy_completion_handler
.handler
;
3208 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3210 sizeof(destroy_completion_handler
.shm_path
));
3215 * The session is destroyed. However, note that the command context
3216 * still holds a reference to the session, thus delaying its destruction
3217 * _at least_ up to the point when that reference is released.
3219 session_destroy(session
);
3220 if (reply_context
) {
3221 ret
= session_add_destroy_notifier(session
,
3222 cmd_destroy_session_reply
,
3223 (void *) reply_context
);
3225 ret
= LTTNG_ERR_FATAL
;
3237 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3239 int cmd_register_consumer(struct ltt_session
*session
,
3240 enum lttng_domain_type domain
, const char *sock_path
,
3241 struct consumer_data
*cdata
)
3244 struct consumer_socket
*socket
= NULL
;
3251 case LTTNG_DOMAIN_KERNEL
:
3253 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3257 /* Can't register a consumer if there is already one */
3258 if (ksess
->consumer_fds_sent
!= 0) {
3259 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3263 sock
= lttcomm_connect_unix_sock(sock_path
);
3265 ret
= LTTNG_ERR_CONNECT_FAIL
;
3268 cdata
->cmd_sock
= sock
;
3270 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3271 if (socket
== NULL
) {
3274 PERROR("close register consumer");
3276 cdata
->cmd_sock
= -1;
3277 ret
= LTTNG_ERR_FATAL
;
3281 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3282 if (socket
->lock
== NULL
) {
3283 PERROR("zmalloc pthread mutex");
3284 ret
= LTTNG_ERR_FATAL
;
3287 pthread_mutex_init(socket
->lock
, NULL
);
3288 socket
->registered
= 1;
3291 consumer_add_socket(socket
, ksess
->consumer
);
3294 pthread_mutex_lock(&cdata
->pid_mutex
);
3296 pthread_mutex_unlock(&cdata
->pid_mutex
);
3301 /* TODO: Userspace tracing */
3302 ret
= LTTNG_ERR_UND
;
3310 consumer_destroy_socket(socket
);
3316 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3318 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3319 struct lttng_domain
**domains
)
3324 struct lttng_ht_iter iter
;
3326 if (session
->kernel_session
!= NULL
) {
3327 DBG3("Listing domains found kernel domain");
3331 if (session
->ust_session
!= NULL
) {
3332 DBG3("Listing domains found UST global domain");
3336 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3338 if (agt
->being_used
) {
3349 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3350 if (*domains
== NULL
) {
3351 ret
= LTTNG_ERR_FATAL
;
3355 if (session
->kernel_session
!= NULL
) {
3356 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3358 /* Kernel session buffer type is always GLOBAL */
3359 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3364 if (session
->ust_session
!= NULL
) {
3365 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3366 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3370 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3372 if (agt
->being_used
) {
3373 (*domains
)[index
].type
= agt
->domain
;
3374 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3384 /* Return negative value to differentiate return code */
3390 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3392 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3393 struct ltt_session
*session
, struct lttng_channel
**channels
)
3395 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3398 case LTTNG_DOMAIN_KERNEL
:
3399 if (session
->kernel_session
!= NULL
) {
3400 nb_chan
= session
->kernel_session
->channel_count
;
3402 DBG3("Number of kernel channels %zd", nb_chan
);
3404 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3408 case LTTNG_DOMAIN_UST
:
3409 if (session
->ust_session
!= NULL
) {
3411 nb_chan
= lttng_ht_get_count(
3412 session
->ust_session
->domain_global
.channels
);
3415 DBG3("Number of UST global channels %zd", nb_chan
);
3417 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3422 ret
= -LTTNG_ERR_UND
;
3427 const size_t channel_size
= sizeof(struct lttng_channel
) +
3428 sizeof(struct lttng_channel_extended
);
3429 struct lttng_channel_extended
*channel_exts
;
3431 payload_size
= nb_chan
* channel_size
;
3432 *channels
= zmalloc(payload_size
);
3433 if (*channels
== NULL
) {
3434 ret
= -LTTNG_ERR_FATAL
;
3438 channel_exts
= ((void *) *channels
) +
3439 (nb_chan
* sizeof(struct lttng_channel
));
3440 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3441 if (ret
!= LTTNG_OK
) {
3456 * Command LTTNG_LIST_EVENTS processed by the client thread.
3458 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3459 struct ltt_session
*session
, char *channel_name
,
3460 struct lttng_event
**events
, size_t *total_size
)
3463 ssize_t nb_event
= 0;
3466 case LTTNG_DOMAIN_KERNEL
:
3467 if (session
->kernel_session
!= NULL
) {
3468 nb_event
= list_lttng_kernel_events(channel_name
,
3469 session
->kernel_session
, events
,
3473 case LTTNG_DOMAIN_UST
:
3475 if (session
->ust_session
!= NULL
) {
3476 nb_event
= list_lttng_ust_global_events(channel_name
,
3477 &session
->ust_session
->domain_global
, events
,
3482 case LTTNG_DOMAIN_LOG4J
:
3483 case LTTNG_DOMAIN_JUL
:
3484 case LTTNG_DOMAIN_PYTHON
:
3485 if (session
->ust_session
) {
3486 struct lttng_ht_iter iter
;
3490 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3491 &iter
.iter
, agt
, node
.node
) {
3492 if (agt
->domain
== domain
) {
3493 nb_event
= list_lttng_agent_events(
3503 ret
= LTTNG_ERR_UND
;
3510 /* Return negative value to differentiate return code */
3515 * Using the session list, filled a lttng_session array to send back to the
3516 * client for session listing.
3518 * The session list lock MUST be acquired before calling this function. Use
3519 * session_lock_list() and session_unlock_list().
3521 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3522 size_t session_count
, uid_t uid
, gid_t gid
)
3526 struct ltt_session
*session
;
3527 struct ltt_session_list
*list
= session_get_list();
3528 struct lttng_session_extended
*extended
=
3529 (typeof(extended
)) (&sessions
[session_count
]);
3531 DBG("Getting all available session for UID %d GID %d",
3534 * Iterate over session list and append data after the control struct in
3537 cds_list_for_each_entry(session
, &list
->head
, list
) {
3538 if (!session_get(session
)) {
3542 * Only list the sessions the user can control.
3544 if (!session_access_ok(session
, uid
, gid
) ||
3545 session
->destroyed
) {
3546 session_put(session
);
3550 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3551 struct ltt_ust_session
*usess
= session
->ust_session
;
3553 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3554 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3555 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3556 ret
= build_network_session_path(sessions
[i
].path
,
3557 sizeof(sessions
[i
].path
), session
);
3559 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3560 session
->consumer
->dst
.session_root_path
);
3563 PERROR("snprintf session path");
3564 session_put(session
);
3568 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3569 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3570 sessions
[i
].enabled
= session
->active
;
3571 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3572 sessions
[i
].live_timer_interval
= session
->live_timer
;
3573 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3574 extended
[i
].creation_time
.is_set
= 1;
3576 session_put(session
);
3581 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3582 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3584 int cmd_data_pending(struct ltt_session
*session
)
3587 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3588 struct ltt_ust_session
*usess
= session
->ust_session
;
3592 DBG("Data pending for session %s", session
->name
);
3594 /* Session MUST be stopped to ask for data availability. */
3595 if (session
->active
) {
3596 ret
= LTTNG_ERR_SESSION_STARTED
;
3600 * If stopped, just make sure we've started before else the above call
3601 * will always send that there is data pending.
3603 * The consumer assumes that when the data pending command is received,
3604 * the trace has been started before or else no output data is written
3605 * by the streams which is a condition for data pending. So, this is
3606 * *VERY* important that we don't ask the consumer before a start
3609 if (!session
->has_been_started
) {
3615 /* A rotation is still pending, we have to wait. */
3616 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3617 DBG("Rotate still pending for session %s", session
->name
);
3622 if (ksess
&& ksess
->consumer
) {
3623 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3625 /* Data is still being extracted for the kernel. */
3630 if (usess
&& usess
->consumer
) {
3631 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3633 /* Data is still being extracted for the kernel. */
3638 /* Data is ready to be read by a viewer */
3646 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3648 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3650 int cmd_snapshot_add_output(struct ltt_session
*session
,
3651 struct lttng_snapshot_output
*output
, uint32_t *id
)
3654 struct snapshot_output
*new_output
;
3659 DBG("Cmd snapshot add output for session %s", session
->name
);
3662 * Can't create an output if the session is not set in no-output mode.
3664 if (session
->output_traces
) {
3665 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3669 if (session
->has_non_mmap_channel
) {
3670 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3674 /* Only one output is allowed until we have the "tee" feature. */
3675 if (session
->snapshot
.nb_output
== 1) {
3676 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3680 new_output
= snapshot_output_alloc();
3682 ret
= LTTNG_ERR_NOMEM
;
3686 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3687 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3688 &session
->snapshot
);
3690 if (ret
== -ENOMEM
) {
3691 ret
= LTTNG_ERR_NOMEM
;
3693 ret
= LTTNG_ERR_INVALID
;
3699 snapshot_add_output(&session
->snapshot
, new_output
);
3701 *id
= new_output
->id
;
3708 snapshot_output_destroy(new_output
);
3714 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3716 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3718 int cmd_snapshot_del_output(struct ltt_session
*session
,
3719 struct lttng_snapshot_output
*output
)
3722 struct snapshot_output
*sout
= NULL
;
3730 * Permission denied to create an output if the session is not
3731 * set in no output mode.
3733 if (session
->output_traces
) {
3734 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3739 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3741 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3742 } else if (*output
->name
!= '\0') {
3743 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3745 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3748 ret
= LTTNG_ERR_INVALID
;
3752 snapshot_delete_output(&session
->snapshot
, sout
);
3753 snapshot_output_destroy(sout
);
3762 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3764 * If no output is available, outputs is untouched and 0 is returned.
3766 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3768 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3769 struct lttng_snapshot_output
**outputs
)
3772 struct lttng_snapshot_output
*list
= NULL
;
3773 struct lttng_ht_iter iter
;
3774 struct snapshot_output
*output
;
3779 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3782 * Permission denied to create an output if the session is not
3783 * set in no output mode.
3785 if (session
->output_traces
) {
3786 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3790 if (session
->snapshot
.nb_output
== 0) {
3795 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3797 ret
= -LTTNG_ERR_NOMEM
;
3801 /* Copy list from session to the new list object. */
3803 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3804 output
, node
.node
) {
3805 assert(output
->consumer
);
3806 list
[idx
].id
= output
->id
;
3807 list
[idx
].max_size
= output
->max_size
;
3808 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3809 sizeof(list
[idx
].name
))) {
3810 ret
= -LTTNG_ERR_INVALID
;
3813 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3814 if (lttng_strncpy(list
[idx
].ctrl_url
,
3815 output
->consumer
->dst
.session_root_path
,
3816 sizeof(list
[idx
].ctrl_url
))) {
3817 ret
= -LTTNG_ERR_INVALID
;
3822 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3823 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3825 ret
= -LTTNG_ERR_NOMEM
;
3830 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3831 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3833 ret
= -LTTNG_ERR_NOMEM
;
3842 ret
= session
->snapshot
.nb_output
;
3851 * Check if we can regenerate the metadata for this session.
3852 * Only kernel, UST per-uid and non-live sessions are supported.
3854 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3857 int check_regenerate_metadata_support(struct ltt_session
*session
)
3863 if (session
->live_timer
!= 0) {
3864 ret
= LTTNG_ERR_LIVE_SESSION
;
3867 if (!session
->active
) {
3868 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3871 if (session
->ust_session
) {
3872 switch (session
->ust_session
->buffer_type
) {
3873 case LTTNG_BUFFER_PER_UID
:
3875 case LTTNG_BUFFER_PER_PID
:
3876 ret
= LTTNG_ERR_PER_PID_SESSION
;
3880 ret
= LTTNG_ERR_UNK
;
3884 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3885 session
->consumer
->relay_minor_version
< 8) {
3886 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3896 int clear_metadata_file(int fd
)
3901 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
3902 if (lseek_ret
< 0) {
3908 ret
= ftruncate(fd
, 0);
3910 PERROR("ftruncate");
3919 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3922 struct buffer_reg_uid
*uid_reg
= NULL
;
3923 struct buffer_reg_session
*session_reg
= NULL
;
3926 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3927 struct ust_registry_session
*registry
;
3928 struct ust_registry_channel
*chan
;
3929 struct lttng_ht_iter iter_chan
;
3931 session_reg
= uid_reg
->registry
;
3932 registry
= session_reg
->reg
.ust
;
3934 pthread_mutex_lock(®istry
->lock
);
3935 registry
->metadata_len_sent
= 0;
3936 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3937 registry
->metadata_len
= 0;
3938 registry
->metadata_version
++;
3939 if (registry
->metadata_fd
> 0) {
3940 /* Clear the metadata file's content. */
3941 ret
= clear_metadata_file(registry
->metadata_fd
);
3943 pthread_mutex_unlock(®istry
->lock
);
3948 ret
= ust_metadata_session_statedump(registry
, NULL
,
3949 registry
->major
, registry
->minor
);
3951 pthread_mutex_unlock(®istry
->lock
);
3952 ERR("Failed to generate session metadata (err = %d)",
3956 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3958 struct ust_registry_event
*event
;
3959 struct lttng_ht_iter iter_event
;
3961 ret
= ust_metadata_channel_statedump(registry
, chan
);
3963 pthread_mutex_unlock(®istry
->lock
);
3964 ERR("Failed to generate channel metadata "
3968 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3970 ret
= ust_metadata_event_statedump(registry
,
3973 pthread_mutex_unlock(®istry
->lock
);
3974 ERR("Failed to generate event metadata "
3980 pthread_mutex_unlock(®istry
->lock
);
3989 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3991 * Ask the consumer to truncate the existing metadata file(s) and
3992 * then regenerate the metadata. Live and per-pid sessions are not
3993 * supported and return an error.
3995 * Return 0 on success or else a LTTNG_ERR code.
3997 int cmd_regenerate_metadata(struct ltt_session
*session
)
4003 ret
= check_regenerate_metadata_support(session
);
4008 if (session
->kernel_session
) {
4009 ret
= kernctl_session_regenerate_metadata(
4010 session
->kernel_session
->fd
);
4012 ERR("Failed to regenerate the kernel metadata");
4017 if (session
->ust_session
) {
4018 ret
= ust_regenerate_metadata(session
->ust_session
);
4020 ERR("Failed to regenerate the UST metadata");
4024 DBG("Cmd metadata regenerate for session %s", session
->name
);
4032 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4034 * Ask the tracer to regenerate a new statedump.
4036 * Return 0 on success or else a LTTNG_ERR code.
4038 int cmd_regenerate_statedump(struct ltt_session
*session
)
4044 if (!session
->active
) {
4045 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4049 if (session
->kernel_session
) {
4050 ret
= kernctl_session_regenerate_statedump(
4051 session
->kernel_session
->fd
);
4053 * Currently, the statedump in kernel can only fail if out
4057 if (ret
== -ENOMEM
) {
4058 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4060 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4062 ERR("Failed to regenerate the kernel statedump");
4067 if (session
->ust_session
) {
4068 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4070 * Currently, the statedump in UST always returns 0.
4073 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4074 ERR("Failed to regenerate the UST statedump");
4078 DBG("Cmd regenerate statedump for session %s", session
->name
);
4085 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4086 struct notification_thread_handle
*notification_thread
)
4090 ssize_t sock_recv_len
;
4091 struct lttng_trigger
*trigger
= NULL
;
4092 struct lttng_buffer_view view
;
4093 struct lttng_dynamic_buffer trigger_buffer
;
4095 lttng_dynamic_buffer_init(&trigger_buffer
);
4096 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4097 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4099 ret
= LTTNG_ERR_NOMEM
;
4103 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4105 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4106 ERR("Failed to receive \"register trigger\" command payload");
4107 /* TODO: should this be a new error enum ? */
4108 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4112 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4113 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4115 ERR("Invalid trigger payload received in \"register trigger\" command");
4116 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4120 ret
= notification_thread_command_register_trigger(notification_thread
,
4122 /* Ownership of trigger was transferred. */
4125 lttng_trigger_destroy(trigger
);
4126 lttng_dynamic_buffer_reset(&trigger_buffer
);
4130 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4131 struct notification_thread_handle
*notification_thread
)
4135 ssize_t sock_recv_len
;
4136 struct lttng_trigger
*trigger
= NULL
;
4137 struct lttng_buffer_view view
;
4138 struct lttng_dynamic_buffer trigger_buffer
;
4140 lttng_dynamic_buffer_init(&trigger_buffer
);
4141 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4142 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4144 ret
= LTTNG_ERR_NOMEM
;
4148 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4150 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4151 ERR("Failed to receive \"unregister trigger\" command payload");
4152 /* TODO: should this be a new error enum ? */
4153 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4157 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4158 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4160 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4161 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4165 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4168 lttng_trigger_destroy(trigger
);
4169 lttng_dynamic_buffer_reset(&trigger_buffer
);
4174 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4175 * snapshot output is *not* set with a remote destination.
4177 * Return LTTNG_OK on success or a LTTNG_ERR code.
4179 static enum lttng_error_code
set_relayd_for_snapshot(
4180 struct consumer_output
*consumer
,
4181 const struct snapshot_output
*snap_output
,
4182 const struct ltt_session
*session
)
4184 enum lttng_error_code status
= LTTNG_OK
;
4185 struct lttng_ht_iter iter
;
4186 struct consumer_socket
*socket
;
4189 assert(snap_output
);
4192 DBG2("Set relayd object from snapshot output");
4194 /* Ignore if snapshot consumer output is not network. */
4195 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
4200 * For each consumer socket, create and send the relayd object of the
4204 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
4205 socket
, node
.node
) {
4206 pthread_mutex_lock(socket
->lock
);
4207 status
= send_consumer_relayd_sockets(0, session
->id
,
4208 snap_output
->consumer
, socket
,
4209 session
->name
, session
->hostname
,
4210 session
->live_timer
);
4211 pthread_mutex_unlock(socket
->lock
);
4212 if (status
!= LTTNG_OK
) {
4224 * Record a kernel snapshot.
4226 * Return LTTNG_OK on success or a LTTNG_ERR code.
4228 static enum lttng_error_code
record_kernel_snapshot(
4229 struct ltt_kernel_session
*ksess
,
4230 const struct snapshot_output
*output
,
4231 const struct ltt_session
*session
,
4232 int wait
, uint64_t nb_packets_per_stream
)
4235 enum lttng_error_code status
;
4242 * Copy kernel session sockets so we can communicate with the right
4243 * consumer for the snapshot record command.
4245 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
4247 status
= LTTNG_ERR_NOMEM
;
4251 status
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
4252 if (status
!= LTTNG_OK
) {
4253 goto error_snapshot
;
4256 status
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
4257 if (status
!= LTTNG_OK
) {
4258 goto error_snapshot
;
4264 /* Clean up copied sockets so this output can use some other later on. */
4265 consumer_destroy_output_sockets(output
->consumer
);
4272 * Record a UST snapshot.
4274 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4276 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4277 const struct snapshot_output
*output
,
4278 const struct ltt_session
*session
, int wait
,
4279 uint64_t nb_packets_per_stream
)
4282 enum lttng_error_code status
;
4289 * Copy UST session sockets so we can communicate with the right
4290 * consumer for the snapshot record command.
4292 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
4294 status
= LTTNG_ERR_NOMEM
;
4298 status
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
4299 if (status
!= LTTNG_OK
) {
4300 goto error_snapshot
;
4303 status
= ust_app_snapshot_record(usess
, output
, wait
,
4304 nb_packets_per_stream
);
4305 if (status
!= LTTNG_OK
) {
4306 goto error_snapshot
;
4312 /* Clean up copied sockets so this output can use some other later on. */
4313 consumer_destroy_output_sockets(output
->consumer
);
4320 uint64_t get_session_size_one_more_packet_per_stream(
4321 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4323 uint64_t tot_size
= 0;
4325 if (session
->kernel_session
) {
4326 struct ltt_kernel_channel
*chan
;
4327 const struct ltt_kernel_session
*ksess
=
4328 session
->kernel_session
;
4330 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4331 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4333 * Don't take channel into account if we
4334 * already grab all its packets.
4338 tot_size
+= chan
->channel
->attr
.subbuf_size
4339 * chan
->stream_count
;
4343 if (session
->ust_session
) {
4344 const struct ltt_ust_session
*usess
= session
->ust_session
;
4346 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4354 * Calculate the number of packets we can grab from each stream that
4355 * fits within the overall snapshot max size.
4357 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4358 * the number of packets per stream.
4360 * TODO: this approach is not perfect: we consider the worse case
4361 * (packet filling the sub-buffers) as an upper bound, but we could do
4362 * better if we do this calculation while we actually grab the packet
4363 * content: we would know how much padding we don't actually store into
4366 * This algorithm is currently bounded by the number of packets per
4369 * Since we call this algorithm before actually grabbing the data, it's
4370 * an approximation: for instance, applications could appear/disappear
4371 * in between this call and actually grabbing data.
4374 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4378 uint64_t cur_nb_packets
= 0;
4381 return 0; /* Infinite */
4384 size_left
= max_size
;
4386 uint64_t one_more_packet_tot_size
;
4388 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4389 session
, cur_nb_packets
);
4390 if (!one_more_packet_tot_size
) {
4391 /* We are already grabbing all packets. */
4394 size_left
-= one_more_packet_tot_size
;
4395 if (size_left
< 0) {
4400 if (!cur_nb_packets
) {
4401 /* Not enough room to grab one packet of each stream, error. */
4404 return cur_nb_packets
;
4408 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4409 const struct snapshot_output
*snapshot_output
, int wait
)
4412 int64_t nb_packets_per_stream
;
4413 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4414 enum lttng_error_code ret
= LTTNG_OK
;
4415 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4417 fmt_ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4419 snapshot_output
->name
,
4420 snapshot_output
->datetime
,
4421 snapshot_output
->nb_snapshot
);
4422 if (fmt_ret
< 0 || fmt_ret
>= sizeof(snapshot_chunk_name
)) {
4423 ERR("Failed to format snapshot name");
4424 ret
= LTTNG_ERR_INVALID
;
4427 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4428 snapshot_output
->name
, session
->name
,
4429 snapshot_chunk_name
);
4430 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4431 snapshot_output_get_base_path(snapshot_output
),
4432 snapshot_chunk_name
);
4433 if (!snapshot_trace_chunk
) {
4434 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4437 assert(!session
->current_trace_chunk
);
4438 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4439 lttng_trace_chunk_put(snapshot_trace_chunk
);
4440 snapshot_trace_chunk
= NULL
;
4442 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4446 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4447 snapshot_output
->max_size
);
4448 if (nb_packets_per_stream
< 0) {
4449 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4453 if (session
->kernel_session
) {
4454 ret
= record_kernel_snapshot(session
->kernel_session
,
4455 snapshot_output
, session
,
4456 wait
, nb_packets_per_stream
);
4457 if (ret
!= LTTNG_OK
) {
4462 if (session
->ust_session
) {
4463 ret
= record_ust_snapshot(session
->ust_session
,
4464 snapshot_output
, session
,
4465 wait
, nb_packets_per_stream
);
4466 if (ret
!= LTTNG_OK
) {
4471 if (session_close_trace_chunk(session
, session
->current_trace_chunk
)) {
4473 * Don't goto end; make sure the chunk is closed for the session
4474 * to allow future snapshots.
4476 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4480 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4481 ERR("Failed to release the current trace chunk of session \"%s\"",
4490 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4492 * The wait parameter is ignored so this call always wait for the snapshot to
4493 * complete before returning.
4495 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4497 int cmd_snapshot_record(struct ltt_session
*session
,
4498 struct lttng_snapshot_output
*output
, int wait
)
4500 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4502 unsigned int use_tmp_output
= 0;
4503 struct snapshot_output tmp_output
;
4504 unsigned int snapshot_success
= 0;
4510 DBG("Cmd snapshot record for session %s", session
->name
);
4512 /* Get the datetime for the snapshot output directory. */
4513 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4516 cmd_ret
= LTTNG_ERR_INVALID
;
4521 * Permission denied to create an output if the session is not
4522 * set in no output mode.
4524 if (session
->output_traces
) {
4525 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4529 /* The session needs to be started at least once. */
4530 if (!session
->has_been_started
) {
4531 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4535 /* Use temporary output for the session. */
4536 if (*output
->ctrl_url
!= '\0') {
4537 ret
= snapshot_output_init(session
, output
->max_size
,
4539 output
->ctrl_url
, output
->data_url
,
4543 if (ret
== -ENOMEM
) {
4544 cmd_ret
= LTTNG_ERR_NOMEM
;
4546 cmd_ret
= LTTNG_ERR_INVALID
;
4550 /* Use the global session count for the temporary snapshot. */
4551 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4553 /* Use the global datetime */
4554 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4558 if (use_tmp_output
) {
4559 cmd_ret
= snapshot_record(session
, &tmp_output
, wait
);
4560 if (cmd_ret
!= LTTNG_OK
) {
4563 snapshot_success
= 1;
4565 struct snapshot_output
*sout
;
4566 struct lttng_ht_iter iter
;
4569 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4570 &iter
.iter
, sout
, node
.node
) {
4572 * Make a local copy of the output and assign the
4573 * possible temporary value given by the caller.
4575 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
4577 if (output
->max_size
!= (uint64_t) -1ULL) {
4578 tmp_output
.max_size
= output
->max_size
;
4581 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4582 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4584 /* Use temporary name. */
4585 if (*output
->name
!= '\0') {
4586 if (lttng_strncpy(tmp_output
.name
, output
->name
,
4587 sizeof(tmp_output
.name
))) {
4588 cmd_ret
= LTTNG_ERR_INVALID
;
4594 cmd_ret
= snapshot_record(session
, &tmp_output
, wait
);
4595 if (cmd_ret
!= LTTNG_OK
) {
4599 snapshot_success
= 1;
4604 if (snapshot_success
) {
4605 session
->snapshot
.nb_snapshot
++;
4607 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4615 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4617 int cmd_set_session_shm_path(struct ltt_session
*session
,
4618 const char *shm_path
)
4624 * Can only set shm path before session is started.
4626 if (session
->has_been_started
) {
4627 return LTTNG_ERR_SESSION_STARTED
;
4630 strncpy(session
->shm_path
, shm_path
,
4631 sizeof(session
->shm_path
));
4632 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4638 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4640 * Ask the consumer to rotate the session output directory.
4641 * The session lock must be held.
4643 * Returns LTTNG_OK on success or else a negative LTTng error code.
4645 int cmd_rotate_session(struct ltt_session
*session
,
4646 struct lttng_rotate_session_return
*rotate_return
)
4649 uint64_t ongoing_rotation_chunk_id
;
4650 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4651 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4652 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4653 enum lttng_trace_chunk_status chunk_status
;
4657 if (!session
->has_been_started
) {
4658 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4662 if (session
->live_timer
|| !session
->output_traces
) {
4663 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4667 /* Unsupported feature in lttng-relayd before 2.11. */
4668 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4669 (session
->consumer
->relay_major_version
== 2 &&
4670 session
->consumer
->relay_minor_version
< 11)) {
4671 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4675 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4676 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4678 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4683 * After a stop, we only allow one rotation to occur, the other ones are
4684 * useless until a new start.
4686 if (session
->rotated_after_last_stop
) {
4687 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4689 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4693 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4695 if (session
->active
) {
4696 new_trace_chunk
= session_create_new_trace_chunk(session
,
4698 if (!new_trace_chunk
) {
4699 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4704 /* The current trace chunk becomes the chunk being archived. */
4705 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4706 &chunk_being_archived
);
4708 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4712 assert(chunk_being_archived
);
4713 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
4714 &ongoing_rotation_chunk_id
);
4715 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4717 chunk_status
= lttng_trace_chunk_set_close_command(
4718 chunk_being_archived
,
4719 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
4720 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4721 cmd_ret
= LTTNG_ERR_FATAL
;
4725 if (session
->kernel_session
) {
4726 cmd_ret
= kernel_rotate_session(session
);
4727 if (cmd_ret
!= LTTNG_OK
) {
4731 if (session
->ust_session
) {
4732 cmd_ret
= ust_app_rotate_session(session
);
4733 if (cmd_ret
!= LTTNG_OK
) {
4738 ret
= session_close_trace_chunk(session
, chunk_being_archived
);
4740 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4744 ret
= timer_session_rotation_pending_check_start(session
,
4745 DEFAULT_ROTATE_PENDING_TIMER
);
4747 cmd_ret
= LTTNG_ERR_UNK
;
4751 if (!session
->active
) {
4752 session
->rotated_after_last_stop
= true;
4755 if (rotate_return
) {
4756 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
4759 session
->chunk_being_archived
= chunk_being_archived
;
4760 chunk_being_archived
= NULL
;
4761 ret
= notification_thread_command_session_rotation_ongoing(
4762 notification_thread_handle
,
4763 session
->name
, session
->uid
, session
->gid
,
4764 ongoing_rotation_chunk_id
);
4765 if (ret
!= LTTNG_OK
) {
4766 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
4771 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
4772 session
->name
, ongoing_rotation_chunk_id
);
4774 lttng_trace_chunk_put(new_trace_chunk
);
4775 lttng_trace_chunk_put(chunk_being_archived
);
4776 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
4779 if (session_reset_rotation_state(session
,
4780 LTTNG_ROTATION_STATE_ERROR
)) {
4781 ERR("Failed to reset rotation state of session \"%s\"",
4788 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
4790 * Check if the session has finished its rotation.
4792 * Return LTTNG_OK on success or else an LTTNG_ERR code.
4794 int cmd_rotate_get_info(struct ltt_session
*session
,
4795 struct lttng_rotation_get_info_return
*info_return
,
4796 uint64_t rotation_id
)
4798 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4799 enum lttng_rotation_state rotation_state
;
4801 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
4802 session
->most_recent_chunk_id
.value
);
4804 if (session
->chunk_being_archived
) {
4805 enum lttng_trace_chunk_status chunk_status
;
4808 chunk_status
= lttng_trace_chunk_get_id(
4809 session
->chunk_being_archived
,
4811 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4813 rotation_state
= rotation_id
== chunk_id
?
4814 LTTNG_ROTATION_STATE_ONGOING
:
4815 LTTNG_ROTATION_STATE_EXPIRED
;
4817 if (session
->last_archived_chunk_id
.is_set
&&
4818 rotation_id
!= session
->last_archived_chunk_id
.value
) {
4819 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
4821 rotation_state
= session
->rotation_state
;
4825 switch (rotation_state
) {
4826 case LTTNG_ROTATION_STATE_NO_ROTATION
:
4827 DBG("Reporting that no rotation has occured within the lifetime of session \"%s\"",
4830 case LTTNG_ROTATION_STATE_EXPIRED
:
4831 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
4832 rotation_id
, session
->name
);
4834 case LTTNG_ROTATION_STATE_ONGOING
:
4835 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
4836 rotation_id
, session
->name
);
4838 case LTTNG_ROTATION_STATE_COMPLETED
:
4842 char *current_tracing_path_reply
;
4843 size_t current_tracing_path_reply_len
;
4845 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
4846 rotation_id
, session
->name
);
4848 switch (session_get_consumer_destination_type(session
)) {
4849 case CONSUMER_DST_LOCAL
:
4850 current_tracing_path_reply
=
4851 info_return
->location
.local
.absolute_path
;
4852 current_tracing_path_reply_len
=
4853 sizeof(info_return
->location
.local
.absolute_path
);
4854 info_return
->location_type
=
4855 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
4857 case CONSUMER_DST_NET
:
4858 current_tracing_path_reply
=
4859 info_return
->location
.relay
.relative_path
;
4860 current_tracing_path_reply_len
=
4861 sizeof(info_return
->location
.relay
.relative_path
);
4862 /* Currently the only supported relay protocol. */
4863 info_return
->location
.relay
.protocol
=
4864 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
4866 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
4867 session_get_net_consumer_hostname(session
),
4868 sizeof(info_return
->location
.relay
.host
));
4870 ERR("Failed to copy host name to rotate_get_info reply");
4871 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4872 cmd_ret
= LTTNG_ERR_SET_URL
;
4876 session_get_net_consumer_ports(session
,
4877 &info_return
->location
.relay
.ports
.control
,
4878 &info_return
->location
.relay
.ports
.data
);
4879 info_return
->location_type
=
4880 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
4885 fmt_ret
= asprintf(&chunk_path
,
4886 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
4887 session_get_base_path(session
),
4888 session
->last_archived_chunk_name
);
4889 if (fmt_ret
== -1) {
4890 PERROR("Failed to format the path of the last archived trace chunk");
4891 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4892 cmd_ret
= LTTNG_ERR_UNK
;
4896 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
4897 chunk_path
, current_tracing_path_reply_len
);
4900 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
4901 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4902 cmd_ret
= LTTNG_ERR_UNK
;
4908 case LTTNG_ROTATION_STATE_ERROR
:
4909 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
4910 rotation_id
, session
->name
);
4918 info_return
->status
= (int32_t) rotation_state
;
4923 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
4925 * Configure the automatic rotation parameters.
4926 * 'activate' to true means activate the rotation schedule type with 'new_value'.
4927 * 'activate' to false means deactivate the rotation schedule and validate that
4928 * 'new_value' has the same value as the currently active value.
4930 * Return 0 on success or else a positive LTTNG_ERR code.
4932 int cmd_rotation_set_schedule(struct ltt_session
*session
,
4933 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
4935 struct notification_thread_handle
*notification_thread_handle
)
4938 uint64_t *parameter_value
;
4942 DBG("Cmd rotate set schedule session %s", session
->name
);
4944 if (session
->live_timer
|| !session
->output_traces
) {
4945 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
4946 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4950 switch (schedule_type
) {
4951 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
4952 parameter_value
= &session
->rotate_size
;
4954 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
4955 parameter_value
= &session
->rotate_timer_period
;
4956 if (new_value
>= UINT_MAX
) {
4957 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
4958 new_value
, UINT_MAX
);
4959 ret
= LTTNG_ERR_INVALID
;
4964 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
4965 ret
= LTTNG_ERR_INVALID
;
4969 /* Improper use of the API. */
4970 if (new_value
== -1ULL) {
4971 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
4972 ret
= LTTNG_ERR_INVALID
;
4977 * As indicated in struct ltt_session's comments, a value of == 0 means
4978 * this schedule rotation type is not in use.
4980 * Reject the command if we were asked to activate a schedule that was
4983 if (activate
&& *parameter_value
!= 0) {
4984 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
4985 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
4990 * Reject the command if we were asked to deactivate a schedule that was
4993 if (!activate
&& *parameter_value
== 0) {
4994 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
4995 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5000 * Reject the command if we were asked to deactivate a schedule that
5003 if (!activate
&& *parameter_value
!= new_value
) {
5004 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5005 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5009 *parameter_value
= activate
? new_value
: 0;
5011 switch (schedule_type
) {
5012 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5013 if (activate
&& session
->active
) {
5015 * Only start the timer if the session is active,
5016 * otherwise it will be started when the session starts.
5018 ret
= timer_session_rotation_schedule_timer_start(
5019 session
, new_value
);
5021 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5022 ret
= LTTNG_ERR_UNK
;
5026 ret
= timer_session_rotation_schedule_timer_stop(
5029 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5030 ret
= LTTNG_ERR_UNK
;
5035 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5037 ret
= subscribe_session_consumed_size_rotation(session
,
5038 new_value
, notification_thread_handle
);
5040 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5041 ret
= LTTNG_ERR_UNK
;
5045 ret
= unsubscribe_session_consumed_size_rotation(session
,
5046 notification_thread_handle
);
5048 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5049 ret
= LTTNG_ERR_UNK
;
5056 /* Would have been caught before. */
5068 /* Wait for a given path to be removed before continuing. */
5069 static enum lttng_error_code
wait_on_path(void *path_data
)
5071 const char *shm_path
= path_data
;
5073 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5079 ret
= stat(shm_path
, &st
);
5081 if (errno
!= ENOENT
) {
5082 PERROR("stat() returned an error while checking for the existence of the shm path");
5084 DBG("shm path no longer exists, completing the destruction of session");
5088 if (!S_ISDIR(st
.st_mode
)) {
5089 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5094 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5100 * Returns a pointer to a handler to run on completion of a command.
5101 * Returns NULL if no handler has to be run for the last command executed.
5103 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5105 struct cmd_completion_handler
*handler
= current_completion_handler
;
5107 current_completion_handler
= NULL
;
5112 * Init command subsystem.
5117 * Set network sequence index to 1 for streams to match a relayd
5118 * socket on the consumer side.
5120 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5121 relayd_net_seq_idx
= 1;
5122 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5124 DBG("Command subsystem initialized");