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
,
1042 const uint64_t *current_chunk_id
)
1045 struct lttcomm_relayd_sock
*rsock
= NULL
;
1046 enum lttng_error_code status
;
1048 /* Connect to relayd and make version check if uri is the control. */
1049 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1050 if (status
!= LTTNG_OK
) {
1051 goto relayd_comm_error
;
1055 /* Set the network sequence index if not set. */
1056 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1057 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1059 * Increment net_seq_idx because we are about to transfer the
1060 * new relayd socket to the consumer.
1061 * Assign unique key so the consumer can match streams.
1063 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1064 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1067 /* Send relayd socket to consumer. */
1068 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1069 relayd_uri
->stype
, session_id
,
1070 session_name
, hostname
, session_live_timer
,
1073 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1077 /* Flag that the corresponding socket was sent. */
1078 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1079 consumer_sock
->control_sock_sent
= 1;
1080 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1081 consumer_sock
->data_sock_sent
= 1;
1085 * Close socket which was dup on the consumer side. The session daemon does
1086 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1090 if (status
!= LTTNG_OK
) {
1092 * The consumer output for this session should not be used anymore
1093 * since the relayd connection failed thus making any tracing or/and
1094 * streaming not usable.
1096 consumer
->enabled
= 0;
1098 (void) relayd_close(rsock
);
1106 * Send both relayd sockets to a specific consumer and domain. This is a
1107 * helper function to facilitate sending the information to the consumer for a
1110 * The consumer socket lock must be held by the caller.
1112 * Returns LTTNG_OK, or an LTTng error code on failure.
1114 static enum lttng_error_code
send_consumer_relayd_sockets(
1115 enum lttng_domain_type domain
,
1116 unsigned int session_id
, struct consumer_output
*consumer
,
1117 struct consumer_socket
*sock
, const char *session_name
,
1118 const char *hostname
, int session_live_timer
,
1119 const uint64_t *current_chunk_id
)
1121 enum lttng_error_code status
= LTTNG_OK
;
1126 /* Sending control relayd socket. */
1127 if (!sock
->control_sock_sent
) {
1128 status
= send_consumer_relayd_socket(session_id
,
1129 &consumer
->dst
.net
.control
, consumer
, sock
,
1130 session_name
, hostname
, session_live_timer
,
1132 if (status
!= LTTNG_OK
) {
1137 /* Sending data relayd socket. */
1138 if (!sock
->data_sock_sent
) {
1139 status
= send_consumer_relayd_socket(session_id
,
1140 &consumer
->dst
.net
.data
, consumer
, sock
,
1141 session_name
, hostname
, session_live_timer
,
1143 if (status
!= LTTNG_OK
) {
1153 * Setup relayd connections for a tracing session. First creates the socket to
1154 * the relayd and send them to the right domain consumer. Consumer type MUST be
1157 int cmd_setup_relayd(struct ltt_session
*session
)
1160 struct ltt_ust_session
*usess
;
1161 struct ltt_kernel_session
*ksess
;
1162 struct consumer_socket
*socket
;
1163 struct lttng_ht_iter iter
;
1164 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1168 usess
= session
->ust_session
;
1169 ksess
= session
->kernel_session
;
1171 DBG("Setting relayd for session %s", session
->name
);
1173 if (session
->current_trace_chunk
) {
1174 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1175 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1177 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1178 current_chunk_id
.is_set
= true;
1180 ERR("Failed to get current trace chunk id");
1181 ret
= LTTNG_ERR_UNK
;
1188 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1189 && usess
->consumer
->enabled
) {
1190 /* For each consumer socket, send relayd sockets */
1191 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1192 socket
, node
.node
) {
1193 pthread_mutex_lock(socket
->lock
);
1194 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1195 usess
->consumer
, socket
,
1196 session
->name
, session
->hostname
,
1197 session
->live_timer
,
1198 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
);
1199 pthread_mutex_unlock(socket
->lock
);
1200 if (ret
!= LTTNG_OK
) {
1203 /* Session is now ready for network streaming. */
1204 session
->net_handle
= 1;
1206 session
->consumer
->relay_major_version
=
1207 usess
->consumer
->relay_major_version
;
1208 session
->consumer
->relay_minor_version
=
1209 usess
->consumer
->relay_minor_version
;
1212 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1213 && ksess
->consumer
->enabled
) {
1214 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1215 socket
, node
.node
) {
1216 pthread_mutex_lock(socket
->lock
);
1217 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1218 ksess
->consumer
, socket
,
1219 session
->name
, session
->hostname
,
1220 session
->live_timer
,
1221 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
);
1222 pthread_mutex_unlock(socket
->lock
);
1223 if (ret
!= LTTNG_OK
) {
1226 /* Session is now ready for network streaming. */
1227 session
->net_handle
= 1;
1229 session
->consumer
->relay_major_version
=
1230 ksess
->consumer
->relay_major_version
;
1231 session
->consumer
->relay_minor_version
=
1232 ksess
->consumer
->relay_minor_version
;
1241 * Start a kernel session by opening all necessary streams.
1243 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1246 struct ltt_kernel_channel
*kchan
;
1248 /* Open kernel metadata */
1249 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1250 ret
= kernel_open_metadata(ksess
);
1252 ret
= LTTNG_ERR_KERN_META_FAIL
;
1257 /* Open kernel metadata stream */
1258 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1259 ret
= kernel_open_metadata_stream(ksess
);
1261 ERR("Kernel create metadata stream failed");
1262 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1267 /* For each channel */
1268 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1269 if (kchan
->stream_count
== 0) {
1270 ret
= kernel_open_channel_stream(kchan
);
1272 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1275 /* Update the stream global counter */
1276 ksess
->stream_count_global
+= ret
;
1280 /* Setup kernel consumer socket and send fds to it */
1281 ret
= init_kernel_tracing(ksess
);
1283 ret
= LTTNG_ERR_KERN_START_FAIL
;
1287 /* This start the kernel tracing */
1288 ret
= kernel_start_session(ksess
);
1290 ret
= LTTNG_ERR_KERN_START_FAIL
;
1294 /* Quiescent wait after starting trace */
1295 kernel_wait_quiescent(wpipe
);
1306 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1308 int cmd_disable_channel(struct ltt_session
*session
,
1309 enum lttng_domain_type domain
, char *channel_name
)
1312 struct ltt_ust_session
*usess
;
1314 usess
= session
->ust_session
;
1319 case LTTNG_DOMAIN_KERNEL
:
1321 ret
= channel_kernel_disable(session
->kernel_session
,
1323 if (ret
!= LTTNG_OK
) {
1327 kernel_wait_quiescent(kernel_tracer_fd
);
1330 case LTTNG_DOMAIN_UST
:
1332 struct ltt_ust_channel
*uchan
;
1333 struct lttng_ht
*chan_ht
;
1335 chan_ht
= usess
->domain_global
.channels
;
1337 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1338 if (uchan
== NULL
) {
1339 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1343 ret
= channel_ust_disable(usess
, uchan
);
1344 if (ret
!= LTTNG_OK
) {
1350 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1362 * Command LTTNG_TRACK_PID processed by the client thread.
1364 * Called with session lock held.
1366 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1374 case LTTNG_DOMAIN_KERNEL
:
1376 struct ltt_kernel_session
*ksess
;
1378 ksess
= session
->kernel_session
;
1380 ret
= kernel_track_pid(ksess
, pid
);
1381 if (ret
!= LTTNG_OK
) {
1385 kernel_wait_quiescent(kernel_tracer_fd
);
1388 case LTTNG_DOMAIN_UST
:
1390 struct ltt_ust_session
*usess
;
1392 usess
= session
->ust_session
;
1394 ret
= trace_ust_track_pid(usess
, pid
);
1395 if (ret
!= LTTNG_OK
) {
1401 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1413 * Command LTTNG_UNTRACK_PID processed by the client thread.
1415 * Called with session lock held.
1417 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1425 case LTTNG_DOMAIN_KERNEL
:
1427 struct ltt_kernel_session
*ksess
;
1429 ksess
= session
->kernel_session
;
1431 ret
= kernel_untrack_pid(ksess
, pid
);
1432 if (ret
!= LTTNG_OK
) {
1436 kernel_wait_quiescent(kernel_tracer_fd
);
1439 case LTTNG_DOMAIN_UST
:
1441 struct ltt_ust_session
*usess
;
1443 usess
= session
->ust_session
;
1445 ret
= trace_ust_untrack_pid(usess
, pid
);
1446 if (ret
!= LTTNG_OK
) {
1452 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1464 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1466 * The wpipe arguments is used as a notifier for the kernel thread.
1468 int cmd_enable_channel(struct ltt_session
*session
,
1469 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1472 struct ltt_ust_session
*usess
= session
->ust_session
;
1473 struct lttng_ht
*chan_ht
;
1480 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1482 /* Validate channel name */
1483 if (attr
->name
[0] == '.' ||
1484 memchr(attr
->name
, '/', len
) != NULL
) {
1485 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1489 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1494 * Don't try to enable a channel if the session has been started at
1495 * some point in time before. The tracer does not allow it.
1497 if (session
->has_been_started
) {
1498 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1503 * If the session is a live session, remove the switch timer, the
1504 * live timer does the same thing but sends also synchronisation
1505 * beacons for inactive streams.
1507 if (session
->live_timer
> 0) {
1508 attr
->attr
.live_timer_interval
= session
->live_timer
;
1509 attr
->attr
.switch_timer_interval
= 0;
1512 /* Check for feature support */
1513 switch (domain
->type
) {
1514 case LTTNG_DOMAIN_KERNEL
:
1516 if (kernel_supports_ring_buffer_snapshot_sample_positions(kernel_tracer_fd
) != 1) {
1517 /* Sampling position of buffer is not supported */
1518 WARN("Kernel tracer does not support buffer monitoring. "
1519 "Setting the monitor interval timer to 0 "
1520 "(disabled) for channel '%s' of session '%s'",
1521 attr
-> name
, session
->name
);
1522 lttng_channel_set_monitor_timer_interval(attr
, 0);
1526 case LTTNG_DOMAIN_UST
:
1528 case LTTNG_DOMAIN_JUL
:
1529 case LTTNG_DOMAIN_LOG4J
:
1530 case LTTNG_DOMAIN_PYTHON
:
1531 if (!agent_tracing_is_enabled()) {
1532 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1533 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1538 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1542 switch (domain
->type
) {
1543 case LTTNG_DOMAIN_KERNEL
:
1545 struct ltt_kernel_channel
*kchan
;
1547 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1548 session
->kernel_session
);
1549 if (kchan
== NULL
) {
1550 if (session
->snapshot
.nb_output
> 0 ||
1551 session
->snapshot_mode
) {
1552 /* Enforce mmap output for snapshot sessions. */
1553 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1555 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1556 if (attr
->name
[0] != '\0') {
1557 session
->kernel_session
->has_non_default_channel
= 1;
1560 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1563 if (ret
!= LTTNG_OK
) {
1567 kernel_wait_quiescent(kernel_tracer_fd
);
1570 case LTTNG_DOMAIN_UST
:
1571 case LTTNG_DOMAIN_JUL
:
1572 case LTTNG_DOMAIN_LOG4J
:
1573 case LTTNG_DOMAIN_PYTHON
:
1575 struct ltt_ust_channel
*uchan
;
1580 * Current agent implementation limitations force us to allow
1581 * only one channel at once in "agent" subdomains. Each
1582 * subdomain has a default channel name which must be strictly
1585 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1586 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1587 LTTNG_SYMBOL_NAME_LEN
)) {
1588 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1591 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1592 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1593 LTTNG_SYMBOL_NAME_LEN
)) {
1594 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1597 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1598 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1599 LTTNG_SYMBOL_NAME_LEN
)) {
1600 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1605 chan_ht
= usess
->domain_global
.channels
;
1607 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1608 if (uchan
== NULL
) {
1609 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1610 if (attr
->name
[0] != '\0') {
1611 usess
->has_non_default_channel
= 1;
1614 ret
= channel_ust_enable(usess
, uchan
);
1619 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1623 if (ret
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1624 session
->has_non_mmap_channel
= true;
1633 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1635 int cmd_disable_event(struct ltt_session
*session
,
1636 enum lttng_domain_type domain
, char *channel_name
,
1637 struct lttng_event
*event
)
1642 DBG("Disable event command for event \'%s\'", event
->name
);
1644 event_name
= event
->name
;
1646 /* Error out on unhandled search criteria */
1647 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1648 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1649 ret
= LTTNG_ERR_UNK
;
1656 case LTTNG_DOMAIN_KERNEL
:
1658 struct ltt_kernel_channel
*kchan
;
1659 struct ltt_kernel_session
*ksess
;
1661 ksess
= session
->kernel_session
;
1664 * If a non-default channel has been created in the
1665 * session, explicitely require that -c chan_name needs
1668 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1669 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1673 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1674 if (kchan
== NULL
) {
1675 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1679 switch (event
->type
) {
1680 case LTTNG_EVENT_ALL
:
1681 case LTTNG_EVENT_TRACEPOINT
:
1682 case LTTNG_EVENT_SYSCALL
:
1683 case LTTNG_EVENT_PROBE
:
1684 case LTTNG_EVENT_FUNCTION
:
1685 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1686 if (event_name
[0] == '\0') {
1687 ret
= event_kernel_disable_event(kchan
,
1690 ret
= event_kernel_disable_event(kchan
,
1691 event_name
, event
->type
);
1693 if (ret
!= LTTNG_OK
) {
1698 ret
= LTTNG_ERR_UNK
;
1702 kernel_wait_quiescent(kernel_tracer_fd
);
1705 case LTTNG_DOMAIN_UST
:
1707 struct ltt_ust_channel
*uchan
;
1708 struct ltt_ust_session
*usess
;
1710 usess
= session
->ust_session
;
1712 if (validate_ust_event_name(event_name
)) {
1713 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1718 * If a non-default channel has been created in the
1719 * session, explicitly require that -c chan_name needs
1722 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1723 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1727 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1729 if (uchan
== NULL
) {
1730 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1734 switch (event
->type
) {
1735 case LTTNG_EVENT_ALL
:
1737 * An empty event name means that everything
1738 * should be disabled.
1740 if (event
->name
[0] == '\0') {
1741 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1743 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1746 if (ret
!= LTTNG_OK
) {
1751 ret
= LTTNG_ERR_UNK
;
1755 DBG3("Disable UST event %s in channel %s completed", event_name
,
1759 case LTTNG_DOMAIN_LOG4J
:
1760 case LTTNG_DOMAIN_JUL
:
1761 case LTTNG_DOMAIN_PYTHON
:
1764 struct ltt_ust_session
*usess
= session
->ust_session
;
1768 switch (event
->type
) {
1769 case LTTNG_EVENT_ALL
:
1772 ret
= LTTNG_ERR_UNK
;
1776 agt
= trace_ust_find_agent(usess
, domain
);
1778 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1782 * An empty event name means that everything
1783 * should be disabled.
1785 if (event
->name
[0] == '\0') {
1786 ret
= event_agent_disable_all(usess
, agt
);
1788 ret
= event_agent_disable(usess
, agt
, event_name
);
1790 if (ret
!= LTTNG_OK
) {
1797 ret
= LTTNG_ERR_UND
;
1810 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1812 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1813 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1815 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1816 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1819 * Don't try to add a context if the session has been started at
1820 * some point in time before. The tracer does not allow it and would
1821 * result in a corrupted trace.
1823 if (session
->has_been_started
) {
1824 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1828 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1829 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1830 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1834 case LTTNG_DOMAIN_KERNEL
:
1835 assert(session
->kernel_session
);
1837 if (session
->kernel_session
->channel_count
== 0) {
1838 /* Create default channel */
1839 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1840 if (ret
!= LTTNG_OK
) {
1843 chan_kern_created
= 1;
1845 /* Add kernel context to kernel tracer */
1846 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1847 if (ret
!= LTTNG_OK
) {
1851 case LTTNG_DOMAIN_JUL
:
1852 case LTTNG_DOMAIN_LOG4J
:
1855 * Validate channel name.
1856 * If no channel name is given and the domain is JUL or LOG4J,
1857 * set it to the appropriate domain-specific channel name. If
1858 * a name is provided but does not match the expexted channel
1859 * name, return an error.
1861 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1862 strcmp(channel_name
,
1863 DEFAULT_JUL_CHANNEL_NAME
)) {
1864 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1866 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1867 strcmp(channel_name
,
1868 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1869 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1872 /* break is _not_ missing here. */
1874 case LTTNG_DOMAIN_UST
:
1876 struct ltt_ust_session
*usess
= session
->ust_session
;
1877 unsigned int chan_count
;
1881 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1882 if (chan_count
== 0) {
1883 struct lttng_channel
*attr
;
1884 /* Create default channel */
1885 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1887 ret
= LTTNG_ERR_FATAL
;
1891 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1892 if (ret
!= LTTNG_OK
) {
1896 channel_attr_destroy(attr
);
1897 chan_ust_created
= 1;
1900 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1901 free(app_ctx_provider_name
);
1903 app_ctx_name
= NULL
;
1904 app_ctx_provider_name
= NULL
;
1905 if (ret
!= LTTNG_OK
) {
1911 ret
= LTTNG_ERR_UND
;
1919 if (chan_kern_created
) {
1920 struct ltt_kernel_channel
*kchan
=
1921 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1922 session
->kernel_session
);
1923 /* Created previously, this should NOT fail. */
1925 kernel_destroy_channel(kchan
);
1928 if (chan_ust_created
) {
1929 struct ltt_ust_channel
*uchan
=
1930 trace_ust_find_channel_by_name(
1931 session
->ust_session
->domain_global
.channels
,
1932 DEFAULT_CHANNEL_NAME
);
1933 /* Created previously, this should NOT fail. */
1935 /* Remove from the channel list of the session. */
1936 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1938 trace_ust_destroy_channel(uchan
);
1941 free(app_ctx_provider_name
);
1946 static inline bool name_starts_with(const char *name
, const char *prefix
)
1948 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1950 return !strncmp(name
, prefix
, max_cmp_len
);
1953 /* Perform userspace-specific event name validation */
1954 static int validate_ust_event_name(const char *name
)
1964 * Check name against all internal UST event component namespaces used
1967 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1968 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1969 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1978 * Internal version of cmd_enable_event() with a supplemental
1979 * "internal_event" flag which is used to enable internal events which should
1980 * be hidden from clients. Such events are used in the agent implementation to
1981 * enable the events through which all "agent" events are funeled.
1983 static int _cmd_enable_event(struct ltt_session
*session
,
1984 struct lttng_domain
*domain
,
1985 char *channel_name
, struct lttng_event
*event
,
1986 char *filter_expression
,
1987 struct lttng_filter_bytecode
*filter
,
1988 struct lttng_event_exclusion
*exclusion
,
1989 int wpipe
, bool internal_event
)
1991 int ret
= 0, channel_created
= 0;
1992 struct lttng_channel
*attr
= NULL
;
1996 assert(channel_name
);
1998 /* If we have a filter, we must have its filter expression */
1999 assert(!(!!filter_expression
^ !!filter
));
2001 /* Normalize event name as a globbing pattern */
2002 strutils_normalize_star_glob_pattern(event
->name
);
2004 /* Normalize exclusion names as globbing patterns */
2008 for (i
= 0; i
< exclusion
->count
; i
++) {
2009 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2011 strutils_normalize_star_glob_pattern(name
);
2015 DBG("Enable event command for event \'%s\'", event
->name
);
2019 switch (domain
->type
) {
2020 case LTTNG_DOMAIN_KERNEL
:
2022 struct ltt_kernel_channel
*kchan
;
2025 * If a non-default channel has been created in the
2026 * session, explicitely require that -c chan_name needs
2029 if (session
->kernel_session
->has_non_default_channel
2030 && channel_name
[0] == '\0') {
2031 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2035 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2036 session
->kernel_session
);
2037 if (kchan
== NULL
) {
2038 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2039 LTTNG_BUFFER_GLOBAL
);
2041 ret
= LTTNG_ERR_FATAL
;
2044 if (lttng_strncpy(attr
->name
, channel_name
,
2045 sizeof(attr
->name
))) {
2046 ret
= LTTNG_ERR_INVALID
;
2050 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2051 if (ret
!= LTTNG_OK
) {
2054 channel_created
= 1;
2057 /* Get the newly created kernel channel pointer */
2058 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2059 session
->kernel_session
);
2060 if (kchan
== NULL
) {
2061 /* This sould not happen... */
2062 ret
= LTTNG_ERR_FATAL
;
2066 switch (event
->type
) {
2067 case LTTNG_EVENT_ALL
:
2069 char *filter_expression_a
= NULL
;
2070 struct lttng_filter_bytecode
*filter_a
= NULL
;
2073 * We need to duplicate filter_expression and filter,
2074 * because ownership is passed to first enable
2077 if (filter_expression
) {
2078 filter_expression_a
= strdup(filter_expression
);
2079 if (!filter_expression_a
) {
2080 ret
= LTTNG_ERR_FATAL
;
2085 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2087 free(filter_expression_a
);
2088 ret
= LTTNG_ERR_FATAL
;
2091 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2093 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2094 ret
= event_kernel_enable_event(kchan
, event
,
2095 filter_expression
, filter
);
2096 /* We have passed ownership */
2097 filter_expression
= NULL
;
2099 if (ret
!= LTTNG_OK
) {
2100 if (channel_created
) {
2101 /* Let's not leak a useless channel. */
2102 kernel_destroy_channel(kchan
);
2104 free(filter_expression_a
);
2108 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2109 ret
= event_kernel_enable_event(kchan
, event
,
2110 filter_expression_a
, filter_a
);
2111 /* We have passed ownership */
2112 filter_expression_a
= NULL
;
2114 if (ret
!= LTTNG_OK
) {
2119 case LTTNG_EVENT_PROBE
:
2120 case LTTNG_EVENT_USERSPACE_PROBE
:
2121 case LTTNG_EVENT_FUNCTION
:
2122 case LTTNG_EVENT_FUNCTION_ENTRY
:
2123 case LTTNG_EVENT_TRACEPOINT
:
2124 ret
= event_kernel_enable_event(kchan
, event
,
2125 filter_expression
, filter
);
2126 /* We have passed ownership */
2127 filter_expression
= NULL
;
2129 if (ret
!= LTTNG_OK
) {
2130 if (channel_created
) {
2131 /* Let's not leak a useless channel. */
2132 kernel_destroy_channel(kchan
);
2137 case LTTNG_EVENT_SYSCALL
:
2138 ret
= event_kernel_enable_event(kchan
, event
,
2139 filter_expression
, filter
);
2140 /* We have passed ownership */
2141 filter_expression
= NULL
;
2143 if (ret
!= LTTNG_OK
) {
2148 ret
= LTTNG_ERR_UNK
;
2152 kernel_wait_quiescent(kernel_tracer_fd
);
2155 case LTTNG_DOMAIN_UST
:
2157 struct ltt_ust_channel
*uchan
;
2158 struct ltt_ust_session
*usess
= session
->ust_session
;
2163 * If a non-default channel has been created in the
2164 * session, explicitely require that -c chan_name needs
2167 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2168 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2172 /* Get channel from global UST domain */
2173 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2175 if (uchan
== NULL
) {
2176 /* Create default channel */
2177 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2178 usess
->buffer_type
);
2180 ret
= LTTNG_ERR_FATAL
;
2183 if (lttng_strncpy(attr
->name
, channel_name
,
2184 sizeof(attr
->name
))) {
2185 ret
= LTTNG_ERR_INVALID
;
2189 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2190 if (ret
!= LTTNG_OK
) {
2194 /* Get the newly created channel reference back */
2195 uchan
= trace_ust_find_channel_by_name(
2196 usess
->domain_global
.channels
, channel_name
);
2200 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2202 * Don't allow users to add UST events to channels which
2203 * are assigned to a userspace subdomain (JUL, Log4J,
2206 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2210 if (!internal_event
) {
2212 * Ensure the event name is not reserved for internal
2215 ret
= validate_ust_event_name(event
->name
);
2217 WARN("Userspace event name %s failed validation.",
2219 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2224 /* At this point, the session and channel exist on the tracer */
2225 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2226 filter_expression
, filter
, exclusion
,
2228 /* We have passed ownership */
2229 filter_expression
= NULL
;
2232 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2233 goto already_enabled
;
2234 } else if (ret
!= LTTNG_OK
) {
2239 case LTTNG_DOMAIN_LOG4J
:
2240 case LTTNG_DOMAIN_JUL
:
2241 case LTTNG_DOMAIN_PYTHON
:
2243 const char *default_event_name
, *default_chan_name
;
2245 struct lttng_event uevent
;
2246 struct lttng_domain tmp_dom
;
2247 struct ltt_ust_session
*usess
= session
->ust_session
;
2251 if (!agent_tracing_is_enabled()) {
2252 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2253 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2257 agt
= trace_ust_find_agent(usess
, domain
->type
);
2259 agt
= agent_create(domain
->type
);
2261 ret
= LTTNG_ERR_NOMEM
;
2264 agent_add(agt
, usess
->agents
);
2267 /* Create the default tracepoint. */
2268 memset(&uevent
, 0, sizeof(uevent
));
2269 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2270 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2271 default_event_name
= event_get_default_agent_ust_name(
2273 if (!default_event_name
) {
2274 ret
= LTTNG_ERR_FATAL
;
2277 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2278 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2281 * The domain type is changed because we are about to enable the
2282 * default channel and event for the JUL domain that are hardcoded.
2283 * This happens in the UST domain.
2285 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2286 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2288 switch (domain
->type
) {
2289 case LTTNG_DOMAIN_LOG4J
:
2290 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2292 case LTTNG_DOMAIN_JUL
:
2293 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2295 case LTTNG_DOMAIN_PYTHON
:
2296 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2299 /* The switch/case we are in makes this impossible */
2304 char *filter_expression_copy
= NULL
;
2305 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2308 const size_t filter_size
= sizeof(
2309 struct lttng_filter_bytecode
)
2312 filter_copy
= zmalloc(filter_size
);
2314 ret
= LTTNG_ERR_NOMEM
;
2317 memcpy(filter_copy
, filter
, filter_size
);
2319 filter_expression_copy
=
2320 strdup(filter_expression
);
2321 if (!filter_expression
) {
2322 ret
= LTTNG_ERR_NOMEM
;
2325 if (!filter_expression_copy
|| !filter_copy
) {
2326 free(filter_expression_copy
);
2332 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2333 (char *) default_chan_name
,
2334 &uevent
, filter_expression_copy
,
2335 filter_copy
, NULL
, wpipe
);
2338 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2339 goto already_enabled
;
2340 } else if (ret
!= LTTNG_OK
) {
2344 /* The wild card * means that everything should be enabled. */
2345 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2346 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2349 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2353 filter_expression
= NULL
;
2354 if (ret
!= LTTNG_OK
) {
2361 ret
= LTTNG_ERR_UND
;
2369 free(filter_expression
);
2372 channel_attr_destroy(attr
);
2378 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2379 * We own filter, exclusion, and filter_expression.
2381 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2382 char *channel_name
, struct lttng_event
*event
,
2383 char *filter_expression
,
2384 struct lttng_filter_bytecode
*filter
,
2385 struct lttng_event_exclusion
*exclusion
,
2388 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2389 filter_expression
, filter
, exclusion
, wpipe
, false);
2393 * Enable an event which is internal to LTTng. An internal should
2394 * never be made visible to clients and are immune to checks such as
2397 static int cmd_enable_event_internal(struct ltt_session
*session
,
2398 struct lttng_domain
*domain
,
2399 char *channel_name
, struct lttng_event
*event
,
2400 char *filter_expression
,
2401 struct lttng_filter_bytecode
*filter
,
2402 struct lttng_event_exclusion
*exclusion
,
2405 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2406 filter_expression
, filter
, exclusion
, wpipe
, true);
2410 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2412 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2413 struct lttng_event
**events
)
2416 ssize_t nb_events
= 0;
2419 case LTTNG_DOMAIN_KERNEL
:
2420 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2421 if (nb_events
< 0) {
2422 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2426 case LTTNG_DOMAIN_UST
:
2427 nb_events
= ust_app_list_events(events
);
2428 if (nb_events
< 0) {
2429 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2433 case LTTNG_DOMAIN_LOG4J
:
2434 case LTTNG_DOMAIN_JUL
:
2435 case LTTNG_DOMAIN_PYTHON
:
2436 nb_events
= agent_list_events(events
, domain
);
2437 if (nb_events
< 0) {
2438 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2443 ret
= LTTNG_ERR_UND
;
2450 /* Return negative value to differentiate return code */
2455 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2457 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2458 struct lttng_event_field
**fields
)
2461 ssize_t nb_fields
= 0;
2464 case LTTNG_DOMAIN_UST
:
2465 nb_fields
= ust_app_list_event_fields(fields
);
2466 if (nb_fields
< 0) {
2467 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2471 case LTTNG_DOMAIN_KERNEL
:
2472 default: /* fall-through */
2473 ret
= LTTNG_ERR_UND
;
2480 /* Return negative value to differentiate return code */
2484 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2486 return syscall_table_list(events
);
2490 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2492 * Called with session lock held.
2494 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2495 enum lttng_domain_type domain
, int32_t **pids
)
2498 ssize_t nr_pids
= 0;
2501 case LTTNG_DOMAIN_KERNEL
:
2503 struct ltt_kernel_session
*ksess
;
2505 ksess
= session
->kernel_session
;
2506 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2508 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2513 case LTTNG_DOMAIN_UST
:
2515 struct ltt_ust_session
*usess
;
2517 usess
= session
->ust_session
;
2518 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2520 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2525 case LTTNG_DOMAIN_LOG4J
:
2526 case LTTNG_DOMAIN_JUL
:
2527 case LTTNG_DOMAIN_PYTHON
:
2529 ret
= LTTNG_ERR_UND
;
2536 /* Return negative value to differentiate return code */
2541 * Command LTTNG_START_TRACE processed by the client thread.
2543 * Called with session mutex held.
2545 int cmd_start_trace(struct ltt_session
*session
)
2547 enum lttng_error_code ret
;
2548 unsigned long nb_chan
= 0;
2549 struct ltt_kernel_session
*ksession
;
2550 struct ltt_ust_session
*usess
;
2554 /* Ease our life a bit ;) */
2555 ksession
= session
->kernel_session
;
2556 usess
= session
->ust_session
;
2558 /* Is the session already started? */
2559 if (session
->active
) {
2560 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2565 * Starting a session without channel is useless since after that it's not
2566 * possible to enable channel thus inform the client.
2568 if (usess
&& usess
->domain_global
.channels
) {
2569 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2572 nb_chan
+= ksession
->channel_count
;
2575 ret
= LTTNG_ERR_NO_CHANNEL
;
2579 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2580 struct lttng_trace_chunk
*trace_chunk
;
2582 trace_chunk
= session_create_new_trace_chunk(
2583 session
, NULL
, NULL
);
2585 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2588 assert(!session
->current_trace_chunk
);
2589 ret
= session_set_trace_chunk(session
, trace_chunk
, NULL
);
2590 lttng_trace_chunk_put(trace_chunk
);
2592 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2597 /* Kernel tracing */
2598 if (ksession
!= NULL
) {
2599 DBG("Start kernel tracing session %s", session
->name
);
2600 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2601 if (ret
!= LTTNG_OK
) {
2606 /* Flag session that trace should start automatically */
2608 int int_ret
= ust_app_start_trace_all(usess
);
2611 ret
= LTTNG_ERR_UST_START_FAIL
;
2616 /* Flag this after a successful start. */
2617 session
->has_been_started
= 1;
2618 session
->active
= 1;
2621 * Clear the flag that indicates that a rotation was done while the
2622 * session was stopped.
2624 session
->rotated_after_last_stop
= false;
2626 if (session
->rotate_timer_period
) {
2627 int int_ret
= timer_session_rotation_schedule_timer_start(
2628 session
, session
->rotate_timer_period
);
2631 ERR("Failed to enable rotate timer");
2632 ret
= LTTNG_ERR_UNK
;
2644 * Command LTTNG_STOP_TRACE processed by the client thread.
2646 int cmd_stop_trace(struct ltt_session
*session
)
2649 struct ltt_kernel_channel
*kchan
;
2650 struct ltt_kernel_session
*ksession
;
2651 struct ltt_ust_session
*usess
;
2652 bool error_occurred
= false;
2656 DBG("Begin stop session %s (id %" PRIu64
")", session
->name
, session
->id
);
2658 ksession
= session
->kernel_session
;
2659 usess
= session
->ust_session
;
2661 /* Session is not active. Skip everythong and inform the client. */
2662 if (!session
->active
) {
2663 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2668 if (ksession
&& ksession
->active
) {
2669 DBG("Stop kernel tracing");
2671 ret
= kernel_stop_session(ksession
);
2673 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2677 kernel_wait_quiescent(kernel_tracer_fd
);
2679 /* Flush metadata after stopping (if exists) */
2680 if (ksession
->metadata_stream_fd
>= 0) {
2681 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2683 ERR("Kernel metadata flush failed");
2687 /* Flush all buffers after stopping */
2688 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2689 ret
= kernel_flush_buffer(kchan
);
2691 ERR("Kernel flush buffer error");
2695 ksession
->active
= 0;
2696 DBG("Kernel session stopped %s (id %" PRIu64
")", session
->name
,
2700 if (usess
&& usess
->active
) {
2701 ret
= ust_app_stop_trace_all(usess
);
2703 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2708 /* Flag inactive after a successful stop. */
2709 session
->active
= 0;
2710 ret
= !error_occurred
? LTTNG_OK
: LTTNG_ERR_UNK
;
2717 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2719 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2720 struct lttng_uri
*uris
)
2723 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2724 struct ltt_ust_session
*usess
= session
->ust_session
;
2730 /* Can't set consumer URI if the session is active. */
2731 if (session
->active
) {
2732 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2736 /* Set the "global" consumer URIs */
2737 for (i
= 0; i
< nb_uri
; i
++) {
2738 ret
= add_uri_to_consumer(session
,
2740 &uris
[i
], LTTNG_DOMAIN_NONE
);
2741 if (ret
!= LTTNG_OK
) {
2746 /* Set UST session URIs */
2747 if (session
->ust_session
) {
2748 for (i
= 0; i
< nb_uri
; i
++) {
2749 ret
= add_uri_to_consumer(session
,
2750 session
->ust_session
->consumer
,
2751 &uris
[i
], LTTNG_DOMAIN_UST
);
2752 if (ret
!= LTTNG_OK
) {
2758 /* Set kernel session URIs */
2759 if (session
->kernel_session
) {
2760 for (i
= 0; i
< nb_uri
; i
++) {
2761 ret
= add_uri_to_consumer(session
,
2762 session
->kernel_session
->consumer
,
2763 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2764 if (ret
!= LTTNG_OK
) {
2771 * Make sure to set the session in output mode after we set URI since a
2772 * session can be created without URL (thus flagged in no output mode).
2774 session
->output_traces
= 1;
2776 ksess
->output_traces
= 1;
2780 usess
->output_traces
= 1;
2791 enum lttng_error_code
set_session_output_from_descriptor(
2792 struct ltt_session
*session
,
2793 const struct lttng_session_descriptor
*descriptor
)
2796 enum lttng_error_code ret_code
= LTTNG_OK
;
2797 enum lttng_session_descriptor_type session_type
=
2798 lttng_session_descriptor_get_type(descriptor
);
2799 enum lttng_session_descriptor_output_type output_type
=
2800 lttng_session_descriptor_get_output_type(descriptor
);
2801 struct lttng_uri uris
[2] = {};
2802 size_t uri_count
= 0;
2804 switch (output_type
) {
2805 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
2807 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
2808 lttng_session_descriptor_get_local_output_uri(descriptor
,
2812 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
2813 lttng_session_descriptor_get_network_output_uris(descriptor
,
2814 &uris
[0], &uris
[1]);
2818 ret_code
= LTTNG_ERR_INVALID
;
2822 switch (session_type
) {
2823 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2825 struct snapshot_output
*new_output
= NULL
;
2827 new_output
= snapshot_output_alloc();
2829 ret_code
= LTTNG_ERR_NOMEM
;
2833 ret
= snapshot_output_init_with_uri(session
,
2834 DEFAULT_SNAPSHOT_MAX_SIZE
,
2835 NULL
, uris
, uri_count
, session
->consumer
,
2836 new_output
, &session
->snapshot
);
2838 ret_code
= (ret
== -ENOMEM
) ?
2839 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
2840 snapshot_output_destroy(new_output
);
2843 snapshot_add_output(&session
->snapshot
, new_output
);
2846 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
2847 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2849 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
2853 ret_code
= LTTNG_ERR_INVALID
;
2861 enum lttng_error_code
cmd_create_session_from_descriptor(
2862 struct lttng_session_descriptor
*descriptor
,
2863 const lttng_sock_cred
*creds
,
2864 const char *home_path
)
2867 enum lttng_error_code ret_code
;
2868 const char *session_name
;
2869 struct ltt_session
*new_session
= NULL
;
2870 enum lttng_session_descriptor_status descriptor_status
;
2872 session_lock_list();
2874 if (*home_path
!= '/') {
2875 ERR("Home path provided by client is not absolute");
2876 ret_code
= LTTNG_ERR_INVALID
;
2881 descriptor_status
= lttng_session_descriptor_get_session_name(
2882 descriptor
, &session_name
);
2883 switch (descriptor_status
) {
2884 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
2886 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
2887 session_name
= NULL
;
2890 ret_code
= LTTNG_ERR_INVALID
;
2893 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
2895 if (ret_code
!= LTTNG_OK
) {
2899 if (!session_name
) {
2900 ret
= lttng_session_descriptor_set_session_name(descriptor
,
2903 ret_code
= LTTNG_ERR_SESSION_FAIL
;
2908 if (!lttng_session_descriptor_is_output_destination_initialized(
2911 * Only include the session's creation time in the output
2912 * destination if the name of the session itself was
2913 * not auto-generated.
2915 ret_code
= lttng_session_descriptor_set_default_output(
2917 session_name
? &new_session
->creation_time
: NULL
,
2919 if (ret_code
!= LTTNG_OK
) {
2923 new_session
->has_user_specified_directory
=
2924 lttng_session_descriptor_has_output_directory(
2928 switch (lttng_session_descriptor_get_type(descriptor
)) {
2929 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
2930 new_session
->snapshot_mode
= 1;
2932 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
2933 new_session
->live_timer
=
2934 lttng_session_descriptor_live_get_timer_interval(
2941 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
2942 if (ret_code
!= LTTNG_OK
) {
2945 new_session
->consumer
->enabled
= 1;
2946 ret_code
= LTTNG_OK
;
2948 /* Release reference provided by the session_create function. */
2949 session_put(new_session
);
2950 if (ret_code
!= LTTNG_OK
&& new_session
) {
2951 /* Release the global reference on error. */
2952 session_destroy(new_session
);
2954 session_unlock_list();
2958 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
2959 struct lttng_session_descriptor
**return_descriptor
)
2962 size_t payload_size
;
2963 struct lttng_dynamic_buffer payload
;
2964 struct lttng_buffer_view home_dir_view
;
2965 struct lttng_buffer_view session_descriptor_view
;
2966 struct lttng_session_descriptor
*session_descriptor
= NULL
;
2967 enum lttng_error_code ret_code
;
2969 lttng_dynamic_buffer_init(&payload
);
2970 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
2972 ret_code
= LTTNG_ERR_INVALID
;
2975 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
2976 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
2977 ret_code
= LTTNG_ERR_INVALID
;
2981 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
2982 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
2983 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
2985 ret_code
= LTTNG_ERR_NOMEM
;
2989 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
2991 ERR("Reception of session descriptor failed, aborting.");
2992 ret_code
= LTTNG_ERR_SESSION_FAIL
;
2996 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
2999 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3000 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3002 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3003 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3005 ret
= lttng_session_descriptor_create_from_buffer(
3006 &session_descriptor_view
, &session_descriptor
);
3008 ERR("Failed to create session descriptor from payload of \"create session\" command");
3009 ret_code
= LTTNG_ERR_INVALID
;
3014 * Sets the descriptor's auto-generated properties (name, output) if
3017 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3019 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3020 if (ret_code
!= LTTNG_OK
) {
3024 ret_code
= LTTNG_OK
;
3025 *return_descriptor
= session_descriptor
;
3026 session_descriptor
= NULL
;
3028 lttng_dynamic_buffer_reset(&payload
);
3029 lttng_session_descriptor_destroy(session_descriptor
);
3034 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3035 void *_reply_context
)
3039 const struct cmd_destroy_session_reply_context
*reply_context
=
3041 struct lttng_dynamic_buffer payload
;
3042 struct lttcomm_session_destroy_command_header cmd_header
;
3043 struct lttng_trace_archive_location
*location
= NULL
;
3044 struct lttcomm_lttng_msg llm
= {
3045 .cmd_type
= LTTNG_DESTROY_SESSION
,
3046 .ret_code
= LTTNG_OK
,
3049 sizeof(struct lttcomm_session_destroy_command_header
),
3052 size_t payload_size_before_location
;
3054 lttng_dynamic_buffer_init(&payload
);
3056 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3058 ERR("Failed to append session destruction message");
3062 cmd_header
.rotation_state
=
3063 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3064 session
->rotation_state
:
3065 LTTNG_ROTATION_STATE_NO_ROTATION
);
3066 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3067 sizeof(cmd_header
));
3069 ERR("Failed to append session destruction command header");
3073 if (!reply_context
->implicit_rotation_on_destroy
) {
3074 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3078 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3079 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3084 location
= session_get_trace_archive_location(session
);
3086 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3091 payload_size_before_location
= payload
.size
;
3092 comm_ret
= lttng_trace_archive_location_serialize(location
,
3095 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3099 /* Update the message to indicate the location's length. */
3100 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3101 payload
.size
- payload_size_before_location
;
3103 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3104 payload
.data
, payload
.size
);
3105 if (comm_ret
!= (ssize_t
) payload
.size
) {
3106 ERR("Failed to send result of the destruction of session \"%s\" to client",
3110 ret
= close(reply_context
->reply_sock_fd
);
3112 PERROR("Failed to close client socket in deferred session destroy reply");
3114 lttng_dynamic_buffer_reset(&payload
);
3115 free(_reply_context
);
3119 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3121 * Called with session lock held.
3123 int cmd_destroy_session(struct ltt_session
*session
,
3124 struct notification_thread_handle
*notification_thread_handle
,
3128 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3131 reply_context
= zmalloc(sizeof(*reply_context
));
3132 if (!reply_context
) {
3133 ret
= LTTNG_ERR_NOMEM
;
3136 reply_context
->reply_sock_fd
= *sock_fd
;
3142 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3144 if (session
->active
) {
3145 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3147 ret
= cmd_stop_trace(session
);
3148 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3149 /* Carry on with the destruction of the session. */
3150 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3151 session
->name
, lttng_strerror(-ret
));
3155 if (session
->rotation_schedule_timer_enabled
) {
3156 if (timer_session_rotation_schedule_timer_stop(
3158 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3163 if (session
->rotate_size
) {
3164 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3165 session
->rotate_size
= 0;
3168 if (session
->most_recent_chunk_id
.is_set
&&
3169 session
->most_recent_chunk_id
.value
!= 0 &&
3170 session
->current_trace_chunk
) {
3171 ret
= cmd_rotate_session(session
, NULL
);
3172 if (ret
!= LTTNG_OK
) {
3173 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3174 session
->name
, lttng_strerror(-ret
));
3176 if (reply_context
) {
3177 reply_context
->implicit_rotation_on_destroy
= true;
3181 if (session
->shm_path
[0]) {
3183 * When a session is created with an explicit shm_path,
3184 * the consumer daemon will create its shared memory files
3185 * at that location and will *not* unlink them. This is normal
3186 * as the intention of that feature is to make it possible
3187 * to retrieve the content of those files should a crash occur.
3189 * To ensure the content of those files can be used, the
3190 * sessiond daemon will replicate the content of the metadata
3191 * cache in a metadata file.
3193 * On clean-up, it is expected that the consumer daemon will
3194 * unlink the shared memory files and that the session daemon
3195 * will unlink the metadata file. Then, the session's directory
3196 * in the shm path can be removed.
3198 * Unfortunately, a flaw in the design of the sessiond's and
3199 * consumerd's tear down of channels makes it impossible to
3200 * determine when the sessiond _and_ the consumerd have both
3201 * destroyed their representation of a channel. For one, the
3202 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3203 * callbacks in both daemons.
3205 * However, it is also impossible for the sessiond to know when
3206 * the consumer daemon is done destroying its channel(s) since
3207 * it occurs as a reaction to the closing of the channel's file
3208 * descriptor. There is no resulting communication initiated
3209 * from the consumerd to the sessiond to confirm that the
3210 * operation is completed (and was successful).
3212 * Until this is all fixed, the session daemon checks for the
3213 * removal of the session's shm path which makes it possible
3214 * to safely advertise a session as having been destroyed.
3216 * Prior to this fix, it was not possible to reliably save
3217 * a session making use of the --shm-path option, destroy it,
3218 * and load it again. This is because the creation of the
3219 * session would fail upon seeing the session's shm path
3220 * already in existence.
3222 * Note that none of the error paths in the check for the
3223 * directory's existence return an error. This is normal
3224 * as there isn't much that can be done. The session will
3225 * be destroyed properly, except that we can't offer the
3226 * guarantee that the same session can be re-created.
3228 current_completion_handler
= &destroy_completion_handler
.handler
;
3229 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3231 sizeof(destroy_completion_handler
.shm_path
));
3236 * The session is destroyed. However, note that the command context
3237 * still holds a reference to the session, thus delaying its destruction
3238 * _at least_ up to the point when that reference is released.
3240 session_destroy(session
);
3241 if (reply_context
) {
3242 ret
= session_add_destroy_notifier(session
,
3243 cmd_destroy_session_reply
,
3244 (void *) reply_context
);
3246 ret
= LTTNG_ERR_FATAL
;
3258 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3260 int cmd_register_consumer(struct ltt_session
*session
,
3261 enum lttng_domain_type domain
, const char *sock_path
,
3262 struct consumer_data
*cdata
)
3265 struct consumer_socket
*socket
= NULL
;
3272 case LTTNG_DOMAIN_KERNEL
:
3274 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3278 /* Can't register a consumer if there is already one */
3279 if (ksess
->consumer_fds_sent
!= 0) {
3280 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3284 sock
= lttcomm_connect_unix_sock(sock_path
);
3286 ret
= LTTNG_ERR_CONNECT_FAIL
;
3289 cdata
->cmd_sock
= sock
;
3291 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3292 if (socket
== NULL
) {
3295 PERROR("close register consumer");
3297 cdata
->cmd_sock
= -1;
3298 ret
= LTTNG_ERR_FATAL
;
3302 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3303 if (socket
->lock
== NULL
) {
3304 PERROR("zmalloc pthread mutex");
3305 ret
= LTTNG_ERR_FATAL
;
3308 pthread_mutex_init(socket
->lock
, NULL
);
3309 socket
->registered
= 1;
3312 consumer_add_socket(socket
, ksess
->consumer
);
3315 pthread_mutex_lock(&cdata
->pid_mutex
);
3317 pthread_mutex_unlock(&cdata
->pid_mutex
);
3322 /* TODO: Userspace tracing */
3323 ret
= LTTNG_ERR_UND
;
3331 consumer_destroy_socket(socket
);
3337 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3339 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3340 struct lttng_domain
**domains
)
3345 struct lttng_ht_iter iter
;
3347 if (session
->kernel_session
!= NULL
) {
3348 DBG3("Listing domains found kernel domain");
3352 if (session
->ust_session
!= NULL
) {
3353 DBG3("Listing domains found UST global domain");
3357 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3359 if (agt
->being_used
) {
3370 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3371 if (*domains
== NULL
) {
3372 ret
= LTTNG_ERR_FATAL
;
3376 if (session
->kernel_session
!= NULL
) {
3377 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3379 /* Kernel session buffer type is always GLOBAL */
3380 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3385 if (session
->ust_session
!= NULL
) {
3386 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3387 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3391 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3393 if (agt
->being_used
) {
3394 (*domains
)[index
].type
= agt
->domain
;
3395 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3405 /* Return negative value to differentiate return code */
3411 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3413 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3414 struct ltt_session
*session
, struct lttng_channel
**channels
)
3416 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3419 case LTTNG_DOMAIN_KERNEL
:
3420 if (session
->kernel_session
!= NULL
) {
3421 nb_chan
= session
->kernel_session
->channel_count
;
3423 DBG3("Number of kernel channels %zd", nb_chan
);
3425 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3429 case LTTNG_DOMAIN_UST
:
3430 if (session
->ust_session
!= NULL
) {
3432 nb_chan
= lttng_ht_get_count(
3433 session
->ust_session
->domain_global
.channels
);
3436 DBG3("Number of UST global channels %zd", nb_chan
);
3438 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3443 ret
= -LTTNG_ERR_UND
;
3448 const size_t channel_size
= sizeof(struct lttng_channel
) +
3449 sizeof(struct lttng_channel_extended
);
3450 struct lttng_channel_extended
*channel_exts
;
3452 payload_size
= nb_chan
* channel_size
;
3453 *channels
= zmalloc(payload_size
);
3454 if (*channels
== NULL
) {
3455 ret
= -LTTNG_ERR_FATAL
;
3459 channel_exts
= ((void *) *channels
) +
3460 (nb_chan
* sizeof(struct lttng_channel
));
3461 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3462 if (ret
!= LTTNG_OK
) {
3477 * Command LTTNG_LIST_EVENTS processed by the client thread.
3479 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3480 struct ltt_session
*session
, char *channel_name
,
3481 struct lttng_event
**events
, size_t *total_size
)
3484 ssize_t nb_event
= 0;
3487 case LTTNG_DOMAIN_KERNEL
:
3488 if (session
->kernel_session
!= NULL
) {
3489 nb_event
= list_lttng_kernel_events(channel_name
,
3490 session
->kernel_session
, events
,
3494 case LTTNG_DOMAIN_UST
:
3496 if (session
->ust_session
!= NULL
) {
3497 nb_event
= list_lttng_ust_global_events(channel_name
,
3498 &session
->ust_session
->domain_global
, events
,
3503 case LTTNG_DOMAIN_LOG4J
:
3504 case LTTNG_DOMAIN_JUL
:
3505 case LTTNG_DOMAIN_PYTHON
:
3506 if (session
->ust_session
) {
3507 struct lttng_ht_iter iter
;
3511 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3512 &iter
.iter
, agt
, node
.node
) {
3513 if (agt
->domain
== domain
) {
3514 nb_event
= list_lttng_agent_events(
3524 ret
= LTTNG_ERR_UND
;
3531 /* Return negative value to differentiate return code */
3536 * Using the session list, filled a lttng_session array to send back to the
3537 * client for session listing.
3539 * The session list lock MUST be acquired before calling this function. Use
3540 * session_lock_list() and session_unlock_list().
3542 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3543 size_t session_count
, uid_t uid
, gid_t gid
)
3547 struct ltt_session
*session
;
3548 struct ltt_session_list
*list
= session_get_list();
3549 struct lttng_session_extended
*extended
=
3550 (typeof(extended
)) (&sessions
[session_count
]);
3552 DBG("Getting all available session for UID %d GID %d",
3555 * Iterate over session list and append data after the control struct in
3558 cds_list_for_each_entry(session
, &list
->head
, list
) {
3559 if (!session_get(session
)) {
3563 * Only list the sessions the user can control.
3565 if (!session_access_ok(session
, uid
, gid
) ||
3566 session
->destroyed
) {
3567 session_put(session
);
3571 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3572 struct ltt_ust_session
*usess
= session
->ust_session
;
3574 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3575 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3576 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3577 ret
= build_network_session_path(sessions
[i
].path
,
3578 sizeof(sessions
[i
].path
), session
);
3580 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3581 session
->consumer
->dst
.session_root_path
);
3584 PERROR("snprintf session path");
3585 session_put(session
);
3589 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3590 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3591 sessions
[i
].enabled
= session
->active
;
3592 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3593 sessions
[i
].live_timer_interval
= session
->live_timer
;
3594 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3595 extended
[i
].creation_time
.is_set
= 1;
3597 session_put(session
);
3602 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3603 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3605 int cmd_data_pending(struct ltt_session
*session
)
3608 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3609 struct ltt_ust_session
*usess
= session
->ust_session
;
3613 DBG("Data pending for session %s", session
->name
);
3615 /* Session MUST be stopped to ask for data availability. */
3616 if (session
->active
) {
3617 ret
= LTTNG_ERR_SESSION_STARTED
;
3621 * If stopped, just make sure we've started before else the above call
3622 * will always send that there is data pending.
3624 * The consumer assumes that when the data pending command is received,
3625 * the trace has been started before or else no output data is written
3626 * by the streams which is a condition for data pending. So, this is
3627 * *VERY* important that we don't ask the consumer before a start
3630 if (!session
->has_been_started
) {
3636 /* A rotation is still pending, we have to wait. */
3637 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3638 DBG("Rotate still pending for session %s", session
->name
);
3643 if (ksess
&& ksess
->consumer
) {
3644 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3646 /* Data is still being extracted for the kernel. */
3651 if (usess
&& usess
->consumer
) {
3652 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3654 /* Data is still being extracted for the kernel. */
3659 /* Data is ready to be read by a viewer */
3667 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3669 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3671 int cmd_snapshot_add_output(struct ltt_session
*session
,
3672 struct lttng_snapshot_output
*output
, uint32_t *id
)
3675 struct snapshot_output
*new_output
;
3680 DBG("Cmd snapshot add output for session %s", session
->name
);
3683 * Can't create an output if the session is not set in no-output mode.
3685 if (session
->output_traces
) {
3686 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3690 if (session
->has_non_mmap_channel
) {
3691 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3695 /* Only one output is allowed until we have the "tee" feature. */
3696 if (session
->snapshot
.nb_output
== 1) {
3697 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3701 new_output
= snapshot_output_alloc();
3703 ret
= LTTNG_ERR_NOMEM
;
3707 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3708 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3709 &session
->snapshot
);
3711 if (ret
== -ENOMEM
) {
3712 ret
= LTTNG_ERR_NOMEM
;
3714 ret
= LTTNG_ERR_INVALID
;
3720 snapshot_add_output(&session
->snapshot
, new_output
);
3722 *id
= new_output
->id
;
3729 snapshot_output_destroy(new_output
);
3735 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3737 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3739 int cmd_snapshot_del_output(struct ltt_session
*session
,
3740 struct lttng_snapshot_output
*output
)
3743 struct snapshot_output
*sout
= NULL
;
3751 * Permission denied to create an output if the session is not
3752 * set in no output mode.
3754 if (session
->output_traces
) {
3755 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3760 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3762 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3763 } else if (*output
->name
!= '\0') {
3764 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3766 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3769 ret
= LTTNG_ERR_INVALID
;
3773 snapshot_delete_output(&session
->snapshot
, sout
);
3774 snapshot_output_destroy(sout
);
3783 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3785 * If no output is available, outputs is untouched and 0 is returned.
3787 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3789 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3790 struct lttng_snapshot_output
**outputs
)
3793 struct lttng_snapshot_output
*list
= NULL
;
3794 struct lttng_ht_iter iter
;
3795 struct snapshot_output
*output
;
3800 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3803 * Permission denied to create an output if the session is not
3804 * set in no output mode.
3806 if (session
->output_traces
) {
3807 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3811 if (session
->snapshot
.nb_output
== 0) {
3816 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3818 ret
= -LTTNG_ERR_NOMEM
;
3822 /* Copy list from session to the new list object. */
3824 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3825 output
, node
.node
) {
3826 assert(output
->consumer
);
3827 list
[idx
].id
= output
->id
;
3828 list
[idx
].max_size
= output
->max_size
;
3829 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3830 sizeof(list
[idx
].name
))) {
3831 ret
= -LTTNG_ERR_INVALID
;
3834 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3835 if (lttng_strncpy(list
[idx
].ctrl_url
,
3836 output
->consumer
->dst
.session_root_path
,
3837 sizeof(list
[idx
].ctrl_url
))) {
3838 ret
= -LTTNG_ERR_INVALID
;
3843 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3844 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3846 ret
= -LTTNG_ERR_NOMEM
;
3851 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3852 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3854 ret
= -LTTNG_ERR_NOMEM
;
3863 ret
= session
->snapshot
.nb_output
;
3872 * Check if we can regenerate the metadata for this session.
3873 * Only kernel, UST per-uid and non-live sessions are supported.
3875 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3878 int check_regenerate_metadata_support(struct ltt_session
*session
)
3884 if (session
->live_timer
!= 0) {
3885 ret
= LTTNG_ERR_LIVE_SESSION
;
3888 if (!session
->active
) {
3889 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3892 if (session
->ust_session
) {
3893 switch (session
->ust_session
->buffer_type
) {
3894 case LTTNG_BUFFER_PER_UID
:
3896 case LTTNG_BUFFER_PER_PID
:
3897 ret
= LTTNG_ERR_PER_PID_SESSION
;
3901 ret
= LTTNG_ERR_UNK
;
3905 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3906 session
->consumer
->relay_minor_version
< 8) {
3907 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3917 int clear_metadata_file(int fd
)
3922 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
3923 if (lseek_ret
< 0) {
3929 ret
= ftruncate(fd
, 0);
3931 PERROR("ftruncate");
3940 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3943 struct buffer_reg_uid
*uid_reg
= NULL
;
3944 struct buffer_reg_session
*session_reg
= NULL
;
3947 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3948 struct ust_registry_session
*registry
;
3949 struct ust_registry_channel
*chan
;
3950 struct lttng_ht_iter iter_chan
;
3952 session_reg
= uid_reg
->registry
;
3953 registry
= session_reg
->reg
.ust
;
3955 pthread_mutex_lock(®istry
->lock
);
3956 registry
->metadata_len_sent
= 0;
3957 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3958 registry
->metadata_len
= 0;
3959 registry
->metadata_version
++;
3960 if (registry
->metadata_fd
> 0) {
3961 /* Clear the metadata file's content. */
3962 ret
= clear_metadata_file(registry
->metadata_fd
);
3964 pthread_mutex_unlock(®istry
->lock
);
3969 ret
= ust_metadata_session_statedump(registry
, NULL
,
3970 registry
->major
, registry
->minor
);
3972 pthread_mutex_unlock(®istry
->lock
);
3973 ERR("Failed to generate session metadata (err = %d)",
3977 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3979 struct ust_registry_event
*event
;
3980 struct lttng_ht_iter iter_event
;
3982 ret
= ust_metadata_channel_statedump(registry
, chan
);
3984 pthread_mutex_unlock(®istry
->lock
);
3985 ERR("Failed to generate channel metadata "
3989 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3991 ret
= ust_metadata_event_statedump(registry
,
3994 pthread_mutex_unlock(®istry
->lock
);
3995 ERR("Failed to generate event metadata "
4001 pthread_mutex_unlock(®istry
->lock
);
4010 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4012 * Ask the consumer to truncate the existing metadata file(s) and
4013 * then regenerate the metadata. Live and per-pid sessions are not
4014 * supported and return an error.
4016 * Return 0 on success or else a LTTNG_ERR code.
4018 int cmd_regenerate_metadata(struct ltt_session
*session
)
4024 ret
= check_regenerate_metadata_support(session
);
4029 if (session
->kernel_session
) {
4030 ret
= kernctl_session_regenerate_metadata(
4031 session
->kernel_session
->fd
);
4033 ERR("Failed to regenerate the kernel metadata");
4038 if (session
->ust_session
) {
4039 ret
= ust_regenerate_metadata(session
->ust_session
);
4041 ERR("Failed to regenerate the UST metadata");
4045 DBG("Cmd metadata regenerate for session %s", session
->name
);
4053 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4055 * Ask the tracer to regenerate a new statedump.
4057 * Return 0 on success or else a LTTNG_ERR code.
4059 int cmd_regenerate_statedump(struct ltt_session
*session
)
4065 if (!session
->active
) {
4066 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4070 if (session
->kernel_session
) {
4071 ret
= kernctl_session_regenerate_statedump(
4072 session
->kernel_session
->fd
);
4074 * Currently, the statedump in kernel can only fail if out
4078 if (ret
== -ENOMEM
) {
4079 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4081 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4083 ERR("Failed to regenerate the kernel statedump");
4088 if (session
->ust_session
) {
4089 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4091 * Currently, the statedump in UST always returns 0.
4094 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4095 ERR("Failed to regenerate the UST statedump");
4099 DBG("Cmd regenerate statedump for session %s", session
->name
);
4106 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4107 struct notification_thread_handle
*notification_thread
)
4111 ssize_t sock_recv_len
;
4112 struct lttng_trigger
*trigger
= NULL
;
4113 struct lttng_buffer_view view
;
4114 struct lttng_dynamic_buffer trigger_buffer
;
4116 lttng_dynamic_buffer_init(&trigger_buffer
);
4117 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4118 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4120 ret
= LTTNG_ERR_NOMEM
;
4124 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4126 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4127 ERR("Failed to receive \"register trigger\" command payload");
4128 /* TODO: should this be a new error enum ? */
4129 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4133 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4134 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4136 ERR("Invalid trigger payload received in \"register trigger\" command");
4137 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4141 ret
= notification_thread_command_register_trigger(notification_thread
,
4143 /* Ownership of trigger was transferred. */
4146 lttng_trigger_destroy(trigger
);
4147 lttng_dynamic_buffer_reset(&trigger_buffer
);
4151 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4152 struct notification_thread_handle
*notification_thread
)
4156 ssize_t sock_recv_len
;
4157 struct lttng_trigger
*trigger
= NULL
;
4158 struct lttng_buffer_view view
;
4159 struct lttng_dynamic_buffer trigger_buffer
;
4161 lttng_dynamic_buffer_init(&trigger_buffer
);
4162 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4163 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4165 ret
= LTTNG_ERR_NOMEM
;
4169 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4171 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4172 ERR("Failed to receive \"unregister trigger\" command payload");
4173 /* TODO: should this be a new error enum ? */
4174 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4178 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4179 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4181 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4182 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4186 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4189 lttng_trigger_destroy(trigger
);
4190 lttng_dynamic_buffer_reset(&trigger_buffer
);
4195 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4196 * snapshot output is *not* set with a remote destination.
4198 * Return LTTNG_OK on success or a LTTNG_ERR code.
4200 static enum lttng_error_code
set_relayd_for_snapshot(
4201 struct consumer_output
*consumer
,
4202 const struct snapshot_output
*snap_output
,
4203 const struct ltt_session
*session
)
4205 enum lttng_error_code status
= LTTNG_OK
;
4206 struct lttng_ht_iter iter
;
4207 struct consumer_socket
*socket
;
4208 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4211 assert(snap_output
);
4214 DBG2("Set relayd object from snapshot output");
4216 if (session
->current_trace_chunk
) {
4217 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
4218 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
4220 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4221 current_chunk_id
.is_set
= true;
4223 ERR("Failed to get current trace chunk id");
4224 status
= LTTNG_ERR_UNK
;
4229 /* Ignore if snapshot consumer output is not network. */
4230 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
4235 * For each consumer socket, create and send the relayd object of the
4239 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
4240 socket
, node
.node
) {
4241 pthread_mutex_lock(socket
->lock
);
4242 status
= send_consumer_relayd_sockets(0, session
->id
,
4243 snap_output
->consumer
, socket
,
4244 session
->name
, session
->hostname
,
4245 session
->live_timer
,
4246 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
);
4247 pthread_mutex_unlock(socket
->lock
);
4248 if (status
!= LTTNG_OK
) {
4260 * Record a kernel snapshot.
4262 * Return LTTNG_OK on success or a LTTNG_ERR code.
4264 static enum lttng_error_code
record_kernel_snapshot(
4265 struct ltt_kernel_session
*ksess
,
4266 const struct snapshot_output
*output
,
4267 const struct ltt_session
*session
,
4268 int wait
, uint64_t nb_packets_per_stream
)
4271 enum lttng_error_code status
;
4278 * Copy kernel session sockets so we can communicate with the right
4279 * consumer for the snapshot record command.
4281 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
4283 status
= LTTNG_ERR_NOMEM
;
4287 status
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
4288 if (status
!= LTTNG_OK
) {
4289 goto error_snapshot
;
4292 status
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
4293 if (status
!= LTTNG_OK
) {
4294 goto error_snapshot
;
4300 /* Clean up copied sockets so this output can use some other later on. */
4301 consumer_destroy_output_sockets(output
->consumer
);
4308 * Record a UST snapshot.
4310 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4312 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4313 const struct snapshot_output
*output
,
4314 const struct ltt_session
*session
, int wait
,
4315 uint64_t nb_packets_per_stream
)
4318 enum lttng_error_code status
;
4325 * Copy UST session sockets so we can communicate with the right
4326 * consumer for the snapshot record command.
4328 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
4330 status
= LTTNG_ERR_NOMEM
;
4334 status
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
4335 if (status
!= LTTNG_OK
) {
4336 goto error_snapshot
;
4339 status
= ust_app_snapshot_record(usess
, output
, wait
,
4340 nb_packets_per_stream
);
4341 if (status
!= LTTNG_OK
) {
4342 goto error_snapshot
;
4348 /* Clean up copied sockets so this output can use some other later on. */
4349 consumer_destroy_output_sockets(output
->consumer
);
4356 uint64_t get_session_size_one_more_packet_per_stream(
4357 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4359 uint64_t tot_size
= 0;
4361 if (session
->kernel_session
) {
4362 struct ltt_kernel_channel
*chan
;
4363 const struct ltt_kernel_session
*ksess
=
4364 session
->kernel_session
;
4366 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4367 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4369 * Don't take channel into account if we
4370 * already grab all its packets.
4374 tot_size
+= chan
->channel
->attr
.subbuf_size
4375 * chan
->stream_count
;
4379 if (session
->ust_session
) {
4380 const struct ltt_ust_session
*usess
= session
->ust_session
;
4382 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4390 * Calculate the number of packets we can grab from each stream that
4391 * fits within the overall snapshot max size.
4393 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4394 * the number of packets per stream.
4396 * TODO: this approach is not perfect: we consider the worse case
4397 * (packet filling the sub-buffers) as an upper bound, but we could do
4398 * better if we do this calculation while we actually grab the packet
4399 * content: we would know how much padding we don't actually store into
4402 * This algorithm is currently bounded by the number of packets per
4405 * Since we call this algorithm before actually grabbing the data, it's
4406 * an approximation: for instance, applications could appear/disappear
4407 * in between this call and actually grabbing data.
4410 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4414 uint64_t cur_nb_packets
= 0;
4417 return 0; /* Infinite */
4420 size_left
= max_size
;
4422 uint64_t one_more_packet_tot_size
;
4424 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4425 session
, cur_nb_packets
);
4426 if (!one_more_packet_tot_size
) {
4427 /* We are already grabbing all packets. */
4430 size_left
-= one_more_packet_tot_size
;
4431 if (size_left
< 0) {
4436 if (!cur_nb_packets
) {
4437 /* Not enough room to grab one packet of each stream, error. */
4440 return cur_nb_packets
;
4444 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4445 const struct snapshot_output
*snapshot_output
, int wait
)
4448 int64_t nb_packets_per_stream
;
4449 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4450 enum lttng_error_code ret
= LTTNG_OK
;
4451 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4453 fmt_ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4455 snapshot_output
->name
,
4456 snapshot_output
->datetime
,
4457 snapshot_output
->nb_snapshot
);
4458 if (fmt_ret
< 0 || fmt_ret
>= sizeof(snapshot_chunk_name
)) {
4459 ERR("Failed to format snapshot name");
4460 ret
= LTTNG_ERR_INVALID
;
4463 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4464 snapshot_output
->name
, session
->name
,
4465 snapshot_chunk_name
);
4466 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4467 snapshot_output_get_base_path(snapshot_output
),
4468 snapshot_chunk_name
);
4469 if (!snapshot_trace_chunk
) {
4470 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4473 assert(!session
->current_trace_chunk
);
4474 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4475 lttng_trace_chunk_put(snapshot_trace_chunk
);
4476 snapshot_trace_chunk
= NULL
;
4478 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4482 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4483 snapshot_output
->max_size
);
4484 if (nb_packets_per_stream
< 0) {
4485 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4489 if (session
->kernel_session
) {
4490 ret
= record_kernel_snapshot(session
->kernel_session
,
4491 snapshot_output
, session
,
4492 wait
, nb_packets_per_stream
);
4493 if (ret
!= LTTNG_OK
) {
4498 if (session
->ust_session
) {
4499 ret
= record_ust_snapshot(session
->ust_session
,
4500 snapshot_output
, session
,
4501 wait
, nb_packets_per_stream
);
4502 if (ret
!= LTTNG_OK
) {
4507 if (session_close_trace_chunk(
4508 session
, session
->current_trace_chunk
, NULL
)) {
4510 * Don't goto end; make sure the chunk is closed for the session
4511 * to allow future snapshots.
4513 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4517 if (session_set_trace_chunk(session
, NULL
, NULL
)) {
4518 ERR("Failed to release the current trace chunk of session \"%s\"",
4527 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4529 * The wait parameter is ignored so this call always wait for the snapshot to
4530 * complete before returning.
4532 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4534 int cmd_snapshot_record(struct ltt_session
*session
,
4535 struct lttng_snapshot_output
*output
, int wait
)
4537 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4539 unsigned int use_tmp_output
= 0;
4540 struct snapshot_output tmp_output
;
4541 unsigned int snapshot_success
= 0;
4547 DBG("Cmd snapshot record for session %s", session
->name
);
4549 /* Get the datetime for the snapshot output directory. */
4550 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4553 cmd_ret
= LTTNG_ERR_INVALID
;
4558 * Permission denied to create an output if the session is not
4559 * set in no output mode.
4561 if (session
->output_traces
) {
4562 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4566 /* The session needs to be started at least once. */
4567 if (!session
->has_been_started
) {
4568 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4572 /* Use temporary output for the session. */
4573 if (*output
->ctrl_url
!= '\0') {
4574 ret
= snapshot_output_init(session
, output
->max_size
,
4576 output
->ctrl_url
, output
->data_url
,
4580 if (ret
== -ENOMEM
) {
4581 cmd_ret
= LTTNG_ERR_NOMEM
;
4583 cmd_ret
= LTTNG_ERR_INVALID
;
4587 /* Use the global session count for the temporary snapshot. */
4588 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4590 /* Use the global datetime */
4591 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4595 if (use_tmp_output
) {
4596 cmd_ret
= snapshot_record(session
, &tmp_output
, wait
);
4597 if (cmd_ret
!= LTTNG_OK
) {
4600 snapshot_success
= 1;
4602 struct snapshot_output
*sout
;
4603 struct lttng_ht_iter iter
;
4606 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4607 &iter
.iter
, sout
, node
.node
) {
4609 * Make a local copy of the output and assign the
4610 * possible temporary value given by the caller.
4612 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
4614 if (output
->max_size
!= (uint64_t) -1ULL) {
4615 tmp_output
.max_size
= output
->max_size
;
4618 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4619 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4621 /* Use temporary name. */
4622 if (*output
->name
!= '\0') {
4623 if (lttng_strncpy(tmp_output
.name
, output
->name
,
4624 sizeof(tmp_output
.name
))) {
4625 cmd_ret
= LTTNG_ERR_INVALID
;
4631 cmd_ret
= snapshot_record(session
, &tmp_output
, wait
);
4632 if (cmd_ret
!= LTTNG_OK
) {
4636 snapshot_success
= 1;
4641 if (snapshot_success
) {
4642 session
->snapshot
.nb_snapshot
++;
4644 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4652 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4654 int cmd_set_session_shm_path(struct ltt_session
*session
,
4655 const char *shm_path
)
4661 * Can only set shm path before session is started.
4663 if (session
->has_been_started
) {
4664 return LTTNG_ERR_SESSION_STARTED
;
4667 strncpy(session
->shm_path
, shm_path
,
4668 sizeof(session
->shm_path
));
4669 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4675 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4677 * Ask the consumer to rotate the session output directory.
4678 * The session lock must be held.
4680 * Returns LTTNG_OK on success or else a negative LTTng error code.
4682 int cmd_rotate_session(struct ltt_session
*session
,
4683 struct lttng_rotate_session_return
*rotate_return
)
4686 uint64_t ongoing_rotation_chunk_id
;
4687 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4688 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4689 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4690 enum lttng_trace_chunk_status chunk_status
;
4694 if (!session
->has_been_started
) {
4695 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4699 if (session
->live_timer
|| !session
->output_traces
) {
4700 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4704 /* Unsupported feature in lttng-relayd before 2.11. */
4705 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4706 (session
->consumer
->relay_major_version
== 2 &&
4707 session
->consumer
->relay_minor_version
< 11)) {
4708 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
4712 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4713 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
4715 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
4720 * After a stop, we only allow one rotation to occur, the other ones are
4721 * useless until a new start.
4723 if (session
->rotated_after_last_stop
) {
4724 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
4726 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
4730 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
4732 if (session
->active
) {
4733 new_trace_chunk
= session_create_new_trace_chunk(session
,
4735 if (!new_trace_chunk
) {
4736 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
4741 /* The current trace chunk becomes the chunk being archived. */
4742 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
4743 &chunk_being_archived
);
4745 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4749 assert(chunk_being_archived
);
4750 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
4751 &ongoing_rotation_chunk_id
);
4752 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4754 if (session
->kernel_session
) {
4755 cmd_ret
= kernel_rotate_session(session
);
4756 if (cmd_ret
!= LTTNG_OK
) {
4760 if (session
->ust_session
) {
4761 cmd_ret
= ust_app_rotate_session(session
);
4762 if (cmd_ret
!= LTTNG_OK
) {
4767 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
4768 &((enum lttng_trace_chunk_command_type
) {
4769 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
}));
4771 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4775 ret
= timer_session_rotation_pending_check_start(session
,
4776 DEFAULT_ROTATE_PENDING_TIMER
);
4778 cmd_ret
= LTTNG_ERR_UNK
;
4782 if (!session
->active
) {
4783 session
->rotated_after_last_stop
= true;
4786 if (rotate_return
) {
4787 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
4790 session
->chunk_being_archived
= chunk_being_archived
;
4791 chunk_being_archived
= NULL
;
4792 ret
= notification_thread_command_session_rotation_ongoing(
4793 notification_thread_handle
,
4794 session
->name
, session
->uid
, session
->gid
,
4795 ongoing_rotation_chunk_id
);
4796 if (ret
!= LTTNG_OK
) {
4797 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
4802 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
4803 session
->name
, ongoing_rotation_chunk_id
);
4805 lttng_trace_chunk_put(new_trace_chunk
);
4806 lttng_trace_chunk_put(chunk_being_archived
);
4807 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
4810 if (session_reset_rotation_state(session
,
4811 LTTNG_ROTATION_STATE_ERROR
)) {
4812 ERR("Failed to reset rotation state of session \"%s\"",
4819 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
4821 * Check if the session has finished its rotation.
4823 * Return LTTNG_OK on success or else an LTTNG_ERR code.
4825 int cmd_rotate_get_info(struct ltt_session
*session
,
4826 struct lttng_rotation_get_info_return
*info_return
,
4827 uint64_t rotation_id
)
4829 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4830 enum lttng_rotation_state rotation_state
;
4832 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
4833 session
->most_recent_chunk_id
.value
);
4835 if (session
->chunk_being_archived
) {
4836 enum lttng_trace_chunk_status chunk_status
;
4839 chunk_status
= lttng_trace_chunk_get_id(
4840 session
->chunk_being_archived
,
4842 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
4844 rotation_state
= rotation_id
== chunk_id
?
4845 LTTNG_ROTATION_STATE_ONGOING
:
4846 LTTNG_ROTATION_STATE_EXPIRED
;
4848 if (session
->last_archived_chunk_id
.is_set
&&
4849 rotation_id
!= session
->last_archived_chunk_id
.value
) {
4850 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
4852 rotation_state
= session
->rotation_state
;
4856 switch (rotation_state
) {
4857 case LTTNG_ROTATION_STATE_NO_ROTATION
:
4858 DBG("Reporting that no rotation has occured within the lifetime of session \"%s\"",
4861 case LTTNG_ROTATION_STATE_EXPIRED
:
4862 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
4863 rotation_id
, session
->name
);
4865 case LTTNG_ROTATION_STATE_ONGOING
:
4866 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
4867 rotation_id
, session
->name
);
4869 case LTTNG_ROTATION_STATE_COMPLETED
:
4873 char *current_tracing_path_reply
;
4874 size_t current_tracing_path_reply_len
;
4876 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
4877 rotation_id
, session
->name
);
4879 switch (session_get_consumer_destination_type(session
)) {
4880 case CONSUMER_DST_LOCAL
:
4881 current_tracing_path_reply
=
4882 info_return
->location
.local
.absolute_path
;
4883 current_tracing_path_reply_len
=
4884 sizeof(info_return
->location
.local
.absolute_path
);
4885 info_return
->location_type
=
4886 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
4888 case CONSUMER_DST_NET
:
4889 current_tracing_path_reply
=
4890 info_return
->location
.relay
.relative_path
;
4891 current_tracing_path_reply_len
=
4892 sizeof(info_return
->location
.relay
.relative_path
);
4893 /* Currently the only supported relay protocol. */
4894 info_return
->location
.relay
.protocol
=
4895 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
4897 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
4898 session_get_net_consumer_hostname(session
),
4899 sizeof(info_return
->location
.relay
.host
));
4901 ERR("Failed to copy host name to rotate_get_info reply");
4902 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4903 cmd_ret
= LTTNG_ERR_SET_URL
;
4907 session_get_net_consumer_ports(session
,
4908 &info_return
->location
.relay
.ports
.control
,
4909 &info_return
->location
.relay
.ports
.data
);
4910 info_return
->location_type
=
4911 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
4916 fmt_ret
= asprintf(&chunk_path
,
4917 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
4918 session_get_base_path(session
),
4919 session
->last_archived_chunk_name
);
4920 if (fmt_ret
== -1) {
4921 PERROR("Failed to format the path of the last archived trace chunk");
4922 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4923 cmd_ret
= LTTNG_ERR_UNK
;
4927 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
4928 chunk_path
, current_tracing_path_reply_len
);
4931 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
4932 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
4933 cmd_ret
= LTTNG_ERR_UNK
;
4939 case LTTNG_ROTATION_STATE_ERROR
:
4940 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
4941 rotation_id
, session
->name
);
4949 info_return
->status
= (int32_t) rotation_state
;
4954 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
4956 * Configure the automatic rotation parameters.
4957 * 'activate' to true means activate the rotation schedule type with 'new_value'.
4958 * 'activate' to false means deactivate the rotation schedule and validate that
4959 * 'new_value' has the same value as the currently active value.
4961 * Return 0 on success or else a positive LTTNG_ERR code.
4963 int cmd_rotation_set_schedule(struct ltt_session
*session
,
4964 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
4966 struct notification_thread_handle
*notification_thread_handle
)
4969 uint64_t *parameter_value
;
4973 DBG("Cmd rotate set schedule session %s", session
->name
);
4975 if (session
->live_timer
|| !session
->output_traces
) {
4976 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
4977 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
4981 switch (schedule_type
) {
4982 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
4983 parameter_value
= &session
->rotate_size
;
4985 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
4986 parameter_value
= &session
->rotate_timer_period
;
4987 if (new_value
>= UINT_MAX
) {
4988 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
4989 new_value
, UINT_MAX
);
4990 ret
= LTTNG_ERR_INVALID
;
4995 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
4996 ret
= LTTNG_ERR_INVALID
;
5000 /* Improper use of the API. */
5001 if (new_value
== -1ULL) {
5002 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5003 ret
= LTTNG_ERR_INVALID
;
5008 * As indicated in struct ltt_session's comments, a value of == 0 means
5009 * this schedule rotation type is not in use.
5011 * Reject the command if we were asked to activate a schedule that was
5014 if (activate
&& *parameter_value
!= 0) {
5015 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5016 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5021 * Reject the command if we were asked to deactivate a schedule that was
5024 if (!activate
&& *parameter_value
== 0) {
5025 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5026 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5031 * Reject the command if we were asked to deactivate a schedule that
5034 if (!activate
&& *parameter_value
!= new_value
) {
5035 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5036 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5040 *parameter_value
= activate
? new_value
: 0;
5042 switch (schedule_type
) {
5043 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5044 if (activate
&& session
->active
) {
5046 * Only start the timer if the session is active,
5047 * otherwise it will be started when the session starts.
5049 ret
= timer_session_rotation_schedule_timer_start(
5050 session
, new_value
);
5052 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5053 ret
= LTTNG_ERR_UNK
;
5057 ret
= timer_session_rotation_schedule_timer_stop(
5060 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5061 ret
= LTTNG_ERR_UNK
;
5066 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5068 ret
= subscribe_session_consumed_size_rotation(session
,
5069 new_value
, notification_thread_handle
);
5071 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5072 ret
= LTTNG_ERR_UNK
;
5076 ret
= unsubscribe_session_consumed_size_rotation(session
,
5077 notification_thread_handle
);
5079 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5080 ret
= LTTNG_ERR_UNK
;
5087 /* Would have been caught before. */
5099 /* Wait for a given path to be removed before continuing. */
5100 static enum lttng_error_code
wait_on_path(void *path_data
)
5102 const char *shm_path
= path_data
;
5104 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5110 ret
= stat(shm_path
, &st
);
5112 if (errno
!= ENOENT
) {
5113 PERROR("stat() returned an error while checking for the existence of the shm path");
5115 DBG("shm path no longer exists, completing the destruction of session");
5119 if (!S_ISDIR(st
.st_mode
)) {
5120 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5125 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5131 * Returns a pointer to a handler to run on completion of a command.
5132 * Returns NULL if no handler has to be run for the last command executed.
5134 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5136 struct cmd_completion_handler
*handler
= current_completion_handler
;
5138 current_completion_handler
= NULL
;
5143 * Init command subsystem.
5148 * Set network sequence index to 1 for streams to match a relayd
5149 * socket on the consumer side.
5151 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5152 relayd_net_seq_idx
= 1;
5153 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5155 DBG("Command subsystem initialized");