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>
25 #include <common/defaults.h>
26 #include <common/common.h>
27 #include <common/sessiond-comm/sessiond-comm.h>
28 #include <common/relayd/relayd.h>
29 #include <common/utils.h>
30 #include <common/compat/string.h>
31 #include <common/kernel-ctl/kernel-ctl.h>
36 #include "health-sessiond.h"
38 #include "kernel-consumer.h"
39 #include "lttng-sessiond.h"
43 #include "buffer-registry.h"
48 * Used to keep a unique index for each relayd socket created where this value
49 * is associated with streams on the consumer so it can match the right relayd
50 * to send to. It must be accessed with the relayd_net_seq_idx_lock
53 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
54 static uint64_t relayd_net_seq_idx
;
56 static int validate_event_name(const char *);
57 static int validate_ust_event_name(const char *);
58 static int cmd_enable_event_internal(struct ltt_session
*session
,
59 struct lttng_domain
*domain
,
60 char *channel_name
, struct lttng_event
*event
,
61 char *filter_expression
,
62 struct lttng_filter_bytecode
*filter
,
63 struct lttng_event_exclusion
*exclusion
,
67 * Create a session path used by list_lttng_sessions for the case that the
68 * session consumer is on the network.
70 static int build_network_session_path(char *dst
, size_t size
,
71 struct ltt_session
*session
)
73 int ret
, kdata_port
, udata_port
;
74 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
75 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
80 memset(tmp_urls
, 0, sizeof(tmp_urls
));
81 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
83 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
85 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
86 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
87 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
90 if (session
->ust_session
&& session
->ust_session
->consumer
) {
91 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
92 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
95 if (uuri
== NULL
&& kuri
== NULL
) {
96 uri
= &session
->consumer
->dst
.net
.control
;
97 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
98 } else if (kuri
&& uuri
) {
99 ret
= uri_compare(kuri
, uuri
);
103 /* Build uuri URL string */
104 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
111 } else if (kuri
&& uuri
== NULL
) {
113 } else if (uuri
&& kuri
== NULL
) {
117 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
123 * Do we have a UST url set. If yes, this means we have both kernel and UST
126 if (*tmp_uurl
!= '\0') {
127 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
128 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
131 if (kuri
|| (!kuri
&& !uuri
)) {
134 /* No kernel URI, use the UST port. */
137 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
145 * Get run-time attributes if the session has been started (discarded events,
148 static int get_kernel_runtime_stats(struct ltt_session
*session
,
149 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
150 uint64_t *lost_packets
)
154 if (!session
->has_been_started
) {
156 *discarded_events
= 0;
161 ret
= consumer_get_discarded_events(session
->id
, kchan
->fd
,
162 session
->kernel_session
->consumer
,
168 ret
= consumer_get_lost_packets(session
->id
, kchan
->fd
,
169 session
->kernel_session
->consumer
,
180 * Get run-time attributes if the session has been started (discarded events,
183 static int get_ust_runtime_stats(struct ltt_session
*session
,
184 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
185 uint64_t *lost_packets
)
188 struct ltt_ust_session
*usess
;
190 if (!discarded_events
|| !lost_packets
) {
195 usess
= session
->ust_session
;
196 assert(discarded_events
);
197 assert(lost_packets
);
199 if (!usess
|| !session
->has_been_started
) {
200 *discarded_events
= 0;
206 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
207 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
208 &usess
->buffer_reg_uid_list
,
209 usess
->consumer
, uchan
->id
,
210 uchan
->attr
.overwrite
,
213 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
214 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
215 uchan
, usess
->consumer
,
216 uchan
->attr
.overwrite
,
222 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
223 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
225 ERR("Unsupported buffer type");
236 * Fill lttng_channel array of all channels.
238 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
239 struct ltt_session
*session
, struct lttng_channel
*channels
,
240 struct lttcomm_channel_extended
*chan_exts
)
243 struct ltt_kernel_channel
*kchan
;
245 DBG("Listing channels for session %s", session
->name
);
248 case LTTNG_DOMAIN_KERNEL
:
249 /* Kernel channels */
250 if (session
->kernel_session
!= NULL
) {
251 cds_list_for_each_entry(kchan
,
252 &session
->kernel_session
->channel_list
.head
, list
) {
253 uint64_t discarded_events
, lost_packets
;
255 ret
= get_kernel_runtime_stats(session
, kchan
,
256 &discarded_events
, &lost_packets
);
260 /* Copy lttng_channel struct to array */
261 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
262 channels
[i
].enabled
= kchan
->enabled
;
263 chan_exts
[i
].discarded_events
=
265 chan_exts
[i
].lost_packets
= lost_packets
;
270 case LTTNG_DOMAIN_UST
:
272 struct lttng_ht_iter iter
;
273 struct ltt_ust_channel
*uchan
;
276 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
277 &iter
.iter
, uchan
, node
.node
) {
278 uint64_t discarded_events
= 0, lost_packets
= 0;
280 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
281 LTTNG_SYMBOL_NAME_LEN
)) {
284 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
285 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
286 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
287 channels
[i
].attr
.switch_timer_interval
=
288 uchan
->attr
.switch_timer_interval
;
289 channels
[i
].attr
.read_timer_interval
=
290 uchan
->attr
.read_timer_interval
;
291 channels
[i
].enabled
= uchan
->enabled
;
292 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
293 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
296 * Map enum lttng_ust_output to enum lttng_event_output.
298 switch (uchan
->attr
.output
) {
300 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
304 * LTTNG_UST_MMAP is the only supported UST
311 ret
= get_ust_runtime_stats(session
, uchan
,
312 &discarded_events
, &lost_packets
);
316 chan_exts
[i
].discarded_events
= discarded_events
;
317 chan_exts
[i
].lost_packets
= lost_packets
;
329 return -LTTNG_ERR_FATAL
;
335 static void increment_extended_len(const char *filter_expression
,
336 struct lttng_event_exclusion
*exclusion
, size_t *extended_len
)
338 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
340 if (filter_expression
) {
341 *extended_len
+= strlen(filter_expression
) + 1;
345 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
349 static void append_extended_info(const char *filter_expression
,
350 struct lttng_event_exclusion
*exclusion
, void **extended_at
)
352 struct lttcomm_event_extended_header extended_header
;
353 size_t filter_len
= 0;
354 size_t nb_exclusions
= 0;
356 if (filter_expression
) {
357 filter_len
= strlen(filter_expression
) + 1;
361 nb_exclusions
= exclusion
->count
;
364 /* Set header fields */
365 extended_header
.filter_len
= filter_len
;
366 extended_header
.nb_exclusions
= nb_exclusions
;
369 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
370 *extended_at
+= sizeof(extended_header
);
372 /* Copy filter string */
373 if (filter_expression
) {
374 memcpy(*extended_at
, filter_expression
, filter_len
);
375 *extended_at
+= filter_len
;
378 /* Copy exclusion names */
380 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
382 memcpy(*extended_at
, &exclusion
->names
, len
);
388 * Create a list of agent domain events.
390 * Return number of events in list on success or else a negative value.
392 static int list_lttng_agent_events(struct agent
*agt
,
393 struct lttng_event
**events
, size_t *total_size
)
396 unsigned int nb_event
= 0;
397 struct agent_event
*event
;
398 struct lttng_event
*tmp_events
;
399 struct lttng_ht_iter iter
;
400 size_t extended_len
= 0;
406 DBG3("Listing agent events");
409 nb_event
= lttng_ht_get_count(agt
->events
);
417 /* Compute required extended infos size */
418 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
421 * This is only valid because the commands which add events are
422 * processed in the same thread as the listing.
425 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
426 increment_extended_len(event
->filter_expression
, NULL
,
431 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
432 tmp_events
= zmalloc(*total_size
);
434 PERROR("zmalloc agent events session");
435 ret
= -LTTNG_ERR_FATAL
;
439 extended_at
= ((uint8_t *) tmp_events
) +
440 nb_event
* sizeof(struct lttng_event
);
443 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
444 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
445 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
446 tmp_events
[i
].enabled
= event
->enabled
;
447 tmp_events
[i
].loglevel
= event
->loglevel_value
;
448 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
451 /* Append extended info */
452 append_extended_info(event
->filter_expression
, NULL
,
457 *events
= tmp_events
;
461 assert(nb_event
== i
);
466 * Create a list of ust global domain events.
468 static int list_lttng_ust_global_events(char *channel_name
,
469 struct ltt_ust_domain_global
*ust_global
,
470 struct lttng_event
**events
, size_t *total_size
)
473 unsigned int nb_event
= 0;
474 struct lttng_ht_iter iter
;
475 struct lttng_ht_node_str
*node
;
476 struct ltt_ust_channel
*uchan
;
477 struct ltt_ust_event
*uevent
;
478 struct lttng_event
*tmp
;
479 size_t extended_len
= 0;
482 DBG("Listing UST global events for channel %s", channel_name
);
486 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
487 node
= lttng_ht_iter_get_node_str(&iter
);
489 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
493 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
495 nb_event
= lttng_ht_get_count(uchan
->events
);
502 DBG3("Listing UST global %d events", nb_event
);
504 /* Compute required extended infos size */
505 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
506 if (uevent
->internal
) {
511 increment_extended_len(uevent
->filter_expression
,
512 uevent
->exclusion
, &extended_len
);
515 /* All events are internal, skip. */
521 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
522 tmp
= zmalloc(*total_size
);
524 ret
= -LTTNG_ERR_FATAL
;
528 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
530 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
531 if (uevent
->internal
) {
532 /* This event should remain hidden from clients */
535 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
536 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
537 tmp
[i
].enabled
= uevent
->enabled
;
539 switch (uevent
->attr
.instrumentation
) {
540 case LTTNG_UST_TRACEPOINT
:
541 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
543 case LTTNG_UST_PROBE
:
544 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
546 case LTTNG_UST_FUNCTION
:
547 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
551 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
552 switch (uevent
->attr
.loglevel_type
) {
553 case LTTNG_UST_LOGLEVEL_ALL
:
554 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
556 case LTTNG_UST_LOGLEVEL_RANGE
:
557 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
559 case LTTNG_UST_LOGLEVEL_SINGLE
:
560 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
563 if (uevent
->filter
) {
566 if (uevent
->exclusion
) {
567 tmp
[i
].exclusion
= 1;
571 /* Append extended info */
572 append_extended_info(uevent
->filter_expression
,
573 uevent
->exclusion
, &extended_at
);
584 * Fill lttng_event array of all kernel events in the channel.
586 static int list_lttng_kernel_events(char *channel_name
,
587 struct ltt_kernel_session
*kernel_session
,
588 struct lttng_event
**events
, size_t *total_size
)
591 unsigned int nb_event
;
592 struct ltt_kernel_event
*event
;
593 struct ltt_kernel_channel
*kchan
;
594 size_t extended_len
= 0;
597 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
599 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
603 nb_event
= kchan
->event_count
;
605 DBG("Listing events for channel %s", kchan
->channel
->name
);
613 /* Compute required extended infos size */
614 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
615 increment_extended_len(event
->filter_expression
, NULL
,
619 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
620 *events
= zmalloc(*total_size
);
621 if (*events
== NULL
) {
622 ret
= LTTNG_ERR_FATAL
;
626 extended_at
= ((void *) *events
) +
627 nb_event
* sizeof(struct lttng_event
);
629 /* Kernel channels */
630 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
631 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
632 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
633 (*events
)[i
].enabled
= event
->enabled
;
634 (*events
)[i
].filter
=
635 (unsigned char) !!event
->filter_expression
;
637 switch (event
->event
->instrumentation
) {
638 case LTTNG_KERNEL_TRACEPOINT
:
639 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
641 case LTTNG_KERNEL_KRETPROBE
:
642 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
643 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
644 sizeof(struct lttng_kernel_kprobe
));
646 case LTTNG_KERNEL_KPROBE
:
647 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
648 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
649 sizeof(struct lttng_kernel_kprobe
));
651 case LTTNG_KERNEL_FUNCTION
:
652 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
653 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
654 sizeof(struct lttng_kernel_function
));
656 case LTTNG_KERNEL_NOOP
:
657 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
659 case LTTNG_KERNEL_SYSCALL
:
660 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
662 case LTTNG_KERNEL_ALL
:
668 /* Append extended info */
669 append_extended_info(event
->filter_expression
, NULL
,
677 /* Negate the error code to differentiate the size from an error */
682 * Add URI so the consumer output object. Set the correct path depending on the
683 * domain adding the default trace directory.
685 static int add_uri_to_consumer(struct consumer_output
*consumer
,
686 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
687 const char *session_name
)
690 const char *default_trace_dir
;
694 if (consumer
== NULL
) {
695 DBG("No consumer detected. Don't add URI. Stopping.");
696 ret
= LTTNG_ERR_NO_CONSUMER
;
701 case LTTNG_DOMAIN_KERNEL
:
702 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
704 case LTTNG_DOMAIN_UST
:
705 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
709 * This case is possible is we try to add the URI to the global tracing
710 * session consumer object which in this case there is no subdir.
712 default_trace_dir
= "";
715 switch (uri
->dtype
) {
718 DBG2("Setting network URI to consumer");
720 if (consumer
->type
== CONSUMER_DST_NET
) {
721 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
722 consumer
->dst
.net
.control_isset
) ||
723 (uri
->stype
== LTTNG_STREAM_DATA
&&
724 consumer
->dst
.net
.data_isset
)) {
725 ret
= LTTNG_ERR_URL_EXIST
;
729 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
732 consumer
->type
= CONSUMER_DST_NET
;
734 /* Set URI into consumer output object */
735 ret
= consumer_set_network_uri(consumer
, uri
);
739 } else if (ret
== 1) {
741 * URI was the same in the consumer so we do not append the subdir
742 * again so to not duplicate output dir.
748 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
749 ret
= consumer_set_subdir(consumer
, session_name
);
751 ret
= LTTNG_ERR_FATAL
;
756 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
757 /* On a new subdir, reappend the default trace dir. */
758 strncat(consumer
->subdir
, default_trace_dir
,
759 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
760 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
765 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
766 memset(consumer
->dst
.trace_path
, 0,
767 sizeof(consumer
->dst
.trace_path
));
768 /* Explicit length checks for strcpy and strcat. */
769 if (strlen(uri
->dst
.path
) + strlen(default_trace_dir
)
770 >= sizeof(consumer
->dst
.trace_path
)) {
771 ret
= LTTNG_ERR_FATAL
;
774 strcpy(consumer
->dst
.trace_path
, uri
->dst
.path
);
775 /* Append default trace dir */
776 strcat(consumer
->dst
.trace_path
, default_trace_dir
);
777 /* Flag consumer as local. */
778 consumer
->type
= CONSUMER_DST_LOCAL
;
789 * Init tracing by creating trace directory and sending fds kernel consumer.
791 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
794 struct lttng_ht_iter iter
;
795 struct consumer_socket
*socket
;
801 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
802 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
804 pthread_mutex_lock(socket
->lock
);
805 ret
= kernel_consumer_send_session(socket
, session
);
806 pthread_mutex_unlock(socket
->lock
);
808 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
820 * Create a socket to the relayd using the URI.
822 * On success, the relayd_sock pointer is set to the created socket.
823 * Else, it's stays untouched and a lttcomm error code is returned.
825 static int create_connect_relayd(struct lttng_uri
*uri
,
826 struct lttcomm_relayd_sock
**relayd_sock
,
827 struct consumer_output
*consumer
)
830 struct lttcomm_relayd_sock
*rsock
;
832 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
833 RELAYD_VERSION_COMM_MINOR
);
835 ret
= LTTNG_ERR_FATAL
;
840 * Connect to relayd so we can proceed with a session creation. This call
841 * can possibly block for an arbitrary amount of time to set the health
842 * state to be in poll execution.
845 ret
= relayd_connect(rsock
);
848 ERR("Unable to reach lttng-relayd");
849 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
853 /* Create socket for control stream. */
854 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
855 DBG3("Creating relayd stream socket from URI");
857 /* Check relayd version */
858 ret
= relayd_version_check(rsock
);
860 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
863 consumer
->relay_major_version
= rsock
->major
;
864 consumer
->relay_minor_version
= rsock
->minor
;
865 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
866 DBG3("Creating relayd data socket from URI");
868 /* Command is not valid */
869 ERR("Relayd invalid stream type: %d", uri
->stype
);
870 ret
= LTTNG_ERR_INVALID
;
874 *relayd_sock
= rsock
;
879 /* The returned value is not useful since we are on an error path. */
880 (void) relayd_close(rsock
);
888 * Connect to the relayd using URI and send the socket to the right consumer.
890 * The consumer socket lock must be held by the caller.
892 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
893 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
894 struct consumer_output
*consumer
,
895 struct consumer_socket
*consumer_sock
,
896 char *session_name
, char *hostname
, int session_live_timer
)
899 struct lttcomm_relayd_sock
*rsock
= NULL
;
901 /* Connect to relayd and make version check if uri is the control. */
902 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
903 if (ret
!= LTTNG_OK
) {
904 goto relayd_comm_error
;
908 /* Set the network sequence index if not set. */
909 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
910 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
912 * Increment net_seq_idx because we are about to transfer the
913 * new relayd socket to the consumer.
914 * Assign unique key so the consumer can match streams.
916 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
917 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
920 /* Send relayd socket to consumer. */
921 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
922 relayd_uri
->stype
, session_id
,
923 session_name
, hostname
, session_live_timer
);
925 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
929 /* Flag that the corresponding socket was sent. */
930 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
931 consumer_sock
->control_sock_sent
= 1;
932 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
933 consumer_sock
->data_sock_sent
= 1;
939 * Close socket which was dup on the consumer side. The session daemon does
940 * NOT keep track of the relayd socket(s) once transfer to the consumer.
944 if (ret
!= LTTNG_OK
) {
946 * The consumer output for this session should not be used anymore
947 * since the relayd connection failed thus making any tracing or/and
948 * streaming not usable.
950 consumer
->enabled
= 0;
952 (void) relayd_close(rsock
);
960 * Send both relayd sockets to a specific consumer and domain. This is a
961 * helper function to facilitate sending the information to the consumer for a
964 * The consumer socket lock must be held by the caller.
966 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
967 unsigned int session_id
, struct consumer_output
*consumer
,
968 struct consumer_socket
*sock
, char *session_name
,
969 char *hostname
, int session_live_timer
)
976 /* Sending control relayd socket. */
977 if (!sock
->control_sock_sent
) {
978 ret
= send_consumer_relayd_socket(domain
, session_id
,
979 &consumer
->dst
.net
.control
, consumer
, sock
,
980 session_name
, hostname
, session_live_timer
);
981 if (ret
!= LTTNG_OK
) {
986 /* Sending data relayd socket. */
987 if (!sock
->data_sock_sent
) {
988 ret
= send_consumer_relayd_socket(domain
, session_id
,
989 &consumer
->dst
.net
.data
, consumer
, sock
,
990 session_name
, hostname
, session_live_timer
);
991 if (ret
!= LTTNG_OK
) {
1001 * Setup relayd connections for a tracing session. First creates the socket to
1002 * the relayd and send them to the right domain consumer. Consumer type MUST be
1005 int cmd_setup_relayd(struct ltt_session
*session
)
1008 struct ltt_ust_session
*usess
;
1009 struct ltt_kernel_session
*ksess
;
1010 struct consumer_socket
*socket
;
1011 struct lttng_ht_iter iter
;
1015 usess
= session
->ust_session
;
1016 ksess
= session
->kernel_session
;
1018 DBG("Setting relayd for session %s", session
->name
);
1022 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1023 && usess
->consumer
->enabled
) {
1024 /* For each consumer socket, send relayd sockets */
1025 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1026 socket
, node
.node
) {
1027 pthread_mutex_lock(socket
->lock
);
1028 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1029 usess
->consumer
, socket
,
1030 session
->name
, session
->hostname
,
1031 session
->live_timer
);
1032 pthread_mutex_unlock(socket
->lock
);
1033 if (ret
!= LTTNG_OK
) {
1036 /* Session is now ready for network streaming. */
1037 session
->net_handle
= 1;
1039 session
->consumer
->relay_major_version
=
1040 usess
->consumer
->relay_major_version
;
1041 session
->consumer
->relay_minor_version
=
1042 usess
->consumer
->relay_minor_version
;
1045 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1046 && ksess
->consumer
->enabled
) {
1047 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1048 socket
, node
.node
) {
1049 pthread_mutex_lock(socket
->lock
);
1050 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1051 ksess
->consumer
, socket
,
1052 session
->name
, session
->hostname
,
1053 session
->live_timer
);
1054 pthread_mutex_unlock(socket
->lock
);
1055 if (ret
!= LTTNG_OK
) {
1058 /* Session is now ready for network streaming. */
1059 session
->net_handle
= 1;
1061 session
->consumer
->relay_major_version
=
1062 ksess
->consumer
->relay_major_version
;
1063 session
->consumer
->relay_minor_version
=
1064 ksess
->consumer
->relay_minor_version
;
1073 * Start a kernel session by opening all necessary streams.
1075 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1078 struct ltt_kernel_channel
*kchan
;
1080 /* Open kernel metadata */
1081 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1082 ret
= kernel_open_metadata(ksess
);
1084 ret
= LTTNG_ERR_KERN_META_FAIL
;
1089 /* Open kernel metadata stream */
1090 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1091 ret
= kernel_open_metadata_stream(ksess
);
1093 ERR("Kernel create metadata stream failed");
1094 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1099 /* For each channel */
1100 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1101 if (kchan
->stream_count
== 0) {
1102 ret
= kernel_open_channel_stream(kchan
);
1104 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1107 /* Update the stream global counter */
1108 ksess
->stream_count_global
+= ret
;
1112 /* Setup kernel consumer socket and send fds to it */
1113 ret
= init_kernel_tracing(ksess
);
1115 ret
= LTTNG_ERR_KERN_START_FAIL
;
1119 /* This start the kernel tracing */
1120 ret
= kernel_start_session(ksess
);
1122 ret
= LTTNG_ERR_KERN_START_FAIL
;
1126 /* Quiescent wait after starting trace */
1127 kernel_wait_quiescent(kernel_tracer_fd
);
1138 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1140 int cmd_disable_channel(struct ltt_session
*session
,
1141 enum lttng_domain_type domain
, char *channel_name
)
1144 struct ltt_ust_session
*usess
;
1146 usess
= session
->ust_session
;
1151 case LTTNG_DOMAIN_KERNEL
:
1153 ret
= channel_kernel_disable(session
->kernel_session
,
1155 if (ret
!= LTTNG_OK
) {
1159 kernel_wait_quiescent(kernel_tracer_fd
);
1162 case LTTNG_DOMAIN_UST
:
1164 struct ltt_ust_channel
*uchan
;
1165 struct lttng_ht
*chan_ht
;
1167 chan_ht
= usess
->domain_global
.channels
;
1169 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1170 if (uchan
== NULL
) {
1171 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1175 ret
= channel_ust_disable(usess
, uchan
);
1176 if (ret
!= LTTNG_OK
) {
1182 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1194 * Command LTTNG_TRACK_PID processed by the client thread.
1196 * Called with session lock held.
1198 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1206 case LTTNG_DOMAIN_KERNEL
:
1208 struct ltt_kernel_session
*ksess
;
1210 ksess
= session
->kernel_session
;
1212 ret
= kernel_track_pid(ksess
, pid
);
1213 if (ret
!= LTTNG_OK
) {
1217 kernel_wait_quiescent(kernel_tracer_fd
);
1220 case LTTNG_DOMAIN_UST
:
1222 struct ltt_ust_session
*usess
;
1224 usess
= session
->ust_session
;
1226 ret
= trace_ust_track_pid(usess
, pid
);
1227 if (ret
!= LTTNG_OK
) {
1233 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1245 * Command LTTNG_UNTRACK_PID processed by the client thread.
1247 * Called with session lock held.
1249 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1257 case LTTNG_DOMAIN_KERNEL
:
1259 struct ltt_kernel_session
*ksess
;
1261 ksess
= session
->kernel_session
;
1263 ret
= kernel_untrack_pid(ksess
, pid
);
1264 if (ret
!= LTTNG_OK
) {
1268 kernel_wait_quiescent(kernel_tracer_fd
);
1271 case LTTNG_DOMAIN_UST
:
1273 struct ltt_ust_session
*usess
;
1275 usess
= session
->ust_session
;
1277 ret
= trace_ust_untrack_pid(usess
, pid
);
1278 if (ret
!= LTTNG_OK
) {
1284 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1296 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1298 * The wpipe arguments is used as a notifier for the kernel thread.
1300 int cmd_enable_channel(struct ltt_session
*session
,
1301 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1304 struct ltt_ust_session
*usess
= session
->ust_session
;
1305 struct lttng_ht
*chan_ht
;
1312 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1314 /* Validate channel name */
1315 if (attr
->name
[0] == '.' ||
1316 memchr(attr
->name
, '/', len
) != NULL
) {
1317 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1321 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1326 * Don't try to enable a channel if the session has been started at
1327 * some point in time before. The tracer does not allow it.
1329 if (session
->has_been_started
) {
1330 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1335 * If the session is a live session, remove the switch timer, the
1336 * live timer does the same thing but sends also synchronisation
1337 * beacons for inactive streams.
1339 if (session
->live_timer
> 0) {
1340 attr
->attr
.live_timer_interval
= session
->live_timer
;
1341 attr
->attr
.switch_timer_interval
= 0;
1344 switch (domain
->type
) {
1345 case LTTNG_DOMAIN_KERNEL
:
1347 struct ltt_kernel_channel
*kchan
;
1349 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1350 session
->kernel_session
);
1351 if (kchan
== NULL
) {
1352 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1353 if (attr
->name
[0] != '\0') {
1354 session
->kernel_session
->has_non_default_channel
= 1;
1357 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1360 if (ret
!= LTTNG_OK
) {
1364 kernel_wait_quiescent(kernel_tracer_fd
);
1367 case LTTNG_DOMAIN_UST
:
1368 case LTTNG_DOMAIN_JUL
:
1369 case LTTNG_DOMAIN_LOG4J
:
1370 case LTTNG_DOMAIN_PYTHON
:
1372 struct ltt_ust_channel
*uchan
;
1377 * Current agent implementation limitations force us to allow
1378 * only one channel at once in "agent" subdomains. Each
1379 * subdomain has a default channel name which must be strictly
1382 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1383 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1384 LTTNG_SYMBOL_NAME_LEN
)) {
1385 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1388 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1389 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1390 LTTNG_SYMBOL_NAME_LEN
)) {
1391 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1394 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1395 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1396 LTTNG_SYMBOL_NAME_LEN
)) {
1397 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1402 chan_ht
= usess
->domain_global
.channels
;
1404 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1405 if (uchan
== NULL
) {
1406 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1407 if (attr
->name
[0] != '\0') {
1408 usess
->has_non_default_channel
= 1;
1411 ret
= channel_ust_enable(usess
, uchan
);
1416 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1427 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1429 int cmd_disable_event(struct ltt_session
*session
,
1430 enum lttng_domain_type domain
, char *channel_name
,
1431 struct lttng_event
*event
)
1436 DBG("Disable event command for event \'%s\'", event
->name
);
1438 event_name
= event
->name
;
1439 if (validate_event_name(event_name
)) {
1440 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1444 /* Error out on unhandled search criteria */
1445 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1446 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1447 ret
= LTTNG_ERR_UNK
;
1454 case LTTNG_DOMAIN_KERNEL
:
1456 struct ltt_kernel_channel
*kchan
;
1457 struct ltt_kernel_session
*ksess
;
1459 ksess
= session
->kernel_session
;
1462 * If a non-default channel has been created in the
1463 * session, explicitely require that -c chan_name needs
1466 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1467 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1471 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1472 if (kchan
== NULL
) {
1473 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1477 switch (event
->type
) {
1478 case LTTNG_EVENT_ALL
:
1479 case LTTNG_EVENT_TRACEPOINT
:
1480 case LTTNG_EVENT_SYSCALL
:
1481 case LTTNG_EVENT_PROBE
:
1482 case LTTNG_EVENT_FUNCTION
:
1483 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1484 if (event_name
[0] == '\0') {
1485 ret
= event_kernel_disable_event(kchan
,
1488 ret
= event_kernel_disable_event(kchan
,
1489 event_name
, event
->type
);
1491 if (ret
!= LTTNG_OK
) {
1496 ret
= LTTNG_ERR_UNK
;
1500 kernel_wait_quiescent(kernel_tracer_fd
);
1503 case LTTNG_DOMAIN_UST
:
1505 struct ltt_ust_channel
*uchan
;
1506 struct ltt_ust_session
*usess
;
1508 usess
= session
->ust_session
;
1510 if (validate_ust_event_name(event_name
)) {
1511 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1516 * If a non-default channel has been created in the
1517 * session, explicitly require that -c chan_name needs
1520 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1521 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1525 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1527 if (uchan
== NULL
) {
1528 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1532 switch (event
->type
) {
1533 case LTTNG_EVENT_ALL
:
1535 * An empty event name means that everything
1536 * should be disabled.
1538 if (event
->name
[0] == '\0') {
1539 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1541 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1544 if (ret
!= LTTNG_OK
) {
1549 ret
= LTTNG_ERR_UNK
;
1553 DBG3("Disable UST event %s in channel %s completed", event_name
,
1557 case LTTNG_DOMAIN_LOG4J
:
1558 case LTTNG_DOMAIN_JUL
:
1559 case LTTNG_DOMAIN_PYTHON
:
1562 struct ltt_ust_session
*usess
= session
->ust_session
;
1566 switch (event
->type
) {
1567 case LTTNG_EVENT_ALL
:
1570 ret
= LTTNG_ERR_UNK
;
1574 agt
= trace_ust_find_agent(usess
, domain
);
1576 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1580 * An empty event name means that everything
1581 * should be disabled.
1583 if (event
->name
[0] == '\0') {
1584 ret
= event_agent_disable_all(usess
, agt
);
1586 ret
= event_agent_disable(usess
, agt
, event_name
);
1588 if (ret
!= LTTNG_OK
) {
1595 ret
= LTTNG_ERR_UND
;
1608 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1610 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1611 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1613 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1614 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1617 * Don't try to add a context if the session has been started at
1618 * some point in time before. The tracer does not allow it and would
1619 * result in a corrupted trace.
1621 if (session
->has_been_started
) {
1622 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1626 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1627 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1628 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1632 case LTTNG_DOMAIN_KERNEL
:
1633 assert(session
->kernel_session
);
1635 if (session
->kernel_session
->channel_count
== 0) {
1636 /* Create default channel */
1637 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1638 if (ret
!= LTTNG_OK
) {
1641 chan_kern_created
= 1;
1643 /* Add kernel context to kernel tracer */
1644 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1645 if (ret
!= LTTNG_OK
) {
1649 case LTTNG_DOMAIN_JUL
:
1650 case LTTNG_DOMAIN_LOG4J
:
1653 * Validate channel name.
1654 * If no channel name is given and the domain is JUL or LOG4J,
1655 * set it to the appropriate domain-specific channel name. If
1656 * a name is provided but does not match the expexted channel
1657 * name, return an error.
1659 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1660 strcmp(channel_name
,
1661 DEFAULT_JUL_CHANNEL_NAME
)) {
1662 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1664 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1665 strcmp(channel_name
,
1666 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1667 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1670 /* break is _not_ missing here. */
1672 case LTTNG_DOMAIN_UST
:
1674 struct ltt_ust_session
*usess
= session
->ust_session
;
1675 unsigned int chan_count
;
1679 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1680 if (chan_count
== 0) {
1681 struct lttng_channel
*attr
;
1682 /* Create default channel */
1683 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1685 ret
= LTTNG_ERR_FATAL
;
1689 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1690 if (ret
!= LTTNG_OK
) {
1695 chan_ust_created
= 1;
1698 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1699 free(app_ctx_provider_name
);
1701 app_ctx_name
= NULL
;
1702 app_ctx_provider_name
= NULL
;
1703 if (ret
!= LTTNG_OK
) {
1709 ret
= LTTNG_ERR_UND
;
1717 if (chan_kern_created
) {
1718 struct ltt_kernel_channel
*kchan
=
1719 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1720 session
->kernel_session
);
1721 /* Created previously, this should NOT fail. */
1723 kernel_destroy_channel(kchan
);
1726 if (chan_ust_created
) {
1727 struct ltt_ust_channel
*uchan
=
1728 trace_ust_find_channel_by_name(
1729 session
->ust_session
->domain_global
.channels
,
1730 DEFAULT_CHANNEL_NAME
);
1731 /* Created previously, this should NOT fail. */
1733 /* Remove from the channel list of the session. */
1734 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1736 trace_ust_destroy_channel(uchan
);
1739 free(app_ctx_provider_name
);
1744 static int validate_event_name(const char *name
)
1747 const char *c
= name
;
1748 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1749 bool null_terminated
= false;
1752 * Make sure that unescaped wildcards are only used as the last
1753 * character of the event name.
1755 while (c
< event_name_end
) {
1758 null_terminated
= true;
1764 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1765 /* Wildcard is not the last character */
1766 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1775 if (!ret
&& !null_terminated
) {
1776 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1781 static inline bool name_starts_with(const char *name
, const char *prefix
)
1783 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1785 return !strncmp(name
, prefix
, max_cmp_len
);
1788 /* Perform userspace-specific event name validation */
1789 static int validate_ust_event_name(const char *name
)
1799 * Check name against all internal UST event component namespaces used
1802 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1803 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1804 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1813 * Internal version of cmd_enable_event() with a supplemental
1814 * "internal_event" flag which is used to enable internal events which should
1815 * be hidden from clients. Such events are used in the agent implementation to
1816 * enable the events through which all "agent" events are funeled.
1818 static int _cmd_enable_event(struct ltt_session
*session
,
1819 struct lttng_domain
*domain
,
1820 char *channel_name
, struct lttng_event
*event
,
1821 char *filter_expression
,
1822 struct lttng_filter_bytecode
*filter
,
1823 struct lttng_event_exclusion
*exclusion
,
1824 int wpipe
, bool internal_event
)
1826 int ret
, channel_created
= 0;
1827 struct lttng_channel
*attr
= NULL
;
1831 assert(channel_name
);
1833 /* If we have a filter, we must have its filter expression */
1834 assert(!(!!filter_expression
^ !!filter
));
1836 DBG("Enable event command for event \'%s\'", event
->name
);
1840 ret
= validate_event_name(event
->name
);
1845 switch (domain
->type
) {
1846 case LTTNG_DOMAIN_KERNEL
:
1848 struct ltt_kernel_channel
*kchan
;
1851 * If a non-default channel has been created in the
1852 * session, explicitely require that -c chan_name needs
1855 if (session
->kernel_session
->has_non_default_channel
1856 && channel_name
[0] == '\0') {
1857 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1861 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1862 session
->kernel_session
);
1863 if (kchan
== NULL
) {
1864 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1865 LTTNG_BUFFER_GLOBAL
);
1867 ret
= LTTNG_ERR_FATAL
;
1870 if (lttng_strncpy(attr
->name
, channel_name
,
1871 sizeof(attr
->name
))) {
1872 ret
= LTTNG_ERR_INVALID
;
1876 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1877 if (ret
!= LTTNG_OK
) {
1880 channel_created
= 1;
1883 /* Get the newly created kernel channel pointer */
1884 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1885 session
->kernel_session
);
1886 if (kchan
== NULL
) {
1887 /* This sould not happen... */
1888 ret
= LTTNG_ERR_FATAL
;
1892 switch (event
->type
) {
1893 case LTTNG_EVENT_ALL
:
1895 char *filter_expression_a
= NULL
;
1896 struct lttng_filter_bytecode
*filter_a
= NULL
;
1899 * We need to duplicate filter_expression and filter,
1900 * because ownership is passed to first enable
1903 if (filter_expression
) {
1904 filter_expression_a
= strdup(filter_expression
);
1905 if (!filter_expression_a
) {
1906 ret
= LTTNG_ERR_FATAL
;
1911 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1913 free(filter_expression_a
);
1914 ret
= LTTNG_ERR_FATAL
;
1917 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1919 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1920 ret
= event_kernel_enable_event(kchan
, event
,
1921 filter_expression
, filter
);
1922 /* We have passed ownership */
1923 filter_expression
= NULL
;
1925 if (ret
!= LTTNG_OK
) {
1926 if (channel_created
) {
1927 /* Let's not leak a useless channel. */
1928 kernel_destroy_channel(kchan
);
1930 free(filter_expression_a
);
1934 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1935 ret
= event_kernel_enable_event(kchan
, event
,
1936 filter_expression_a
, filter_a
);
1937 /* We have passed ownership */
1938 filter_expression_a
= NULL
;
1940 if (ret
!= LTTNG_OK
) {
1945 case LTTNG_EVENT_PROBE
:
1946 case LTTNG_EVENT_FUNCTION
:
1947 case LTTNG_EVENT_FUNCTION_ENTRY
:
1948 case LTTNG_EVENT_TRACEPOINT
:
1949 ret
= event_kernel_enable_event(kchan
, event
,
1950 filter_expression
, filter
);
1951 /* We have passed ownership */
1952 filter_expression
= NULL
;
1954 if (ret
!= LTTNG_OK
) {
1955 if (channel_created
) {
1956 /* Let's not leak a useless channel. */
1957 kernel_destroy_channel(kchan
);
1962 case LTTNG_EVENT_SYSCALL
:
1963 ret
= event_kernel_enable_event(kchan
, event
,
1964 filter_expression
, filter
);
1965 /* We have passed ownership */
1966 filter_expression
= NULL
;
1968 if (ret
!= LTTNG_OK
) {
1973 ret
= LTTNG_ERR_UNK
;
1977 kernel_wait_quiescent(kernel_tracer_fd
);
1980 case LTTNG_DOMAIN_UST
:
1982 struct ltt_ust_channel
*uchan
;
1983 struct ltt_ust_session
*usess
= session
->ust_session
;
1988 * If a non-default channel has been created in the
1989 * session, explicitely require that -c chan_name needs
1992 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1993 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1997 /* Get channel from global UST domain */
1998 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2000 if (uchan
== NULL
) {
2001 /* Create default channel */
2002 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2003 usess
->buffer_type
);
2005 ret
= LTTNG_ERR_FATAL
;
2008 if (lttng_strncpy(attr
->name
, channel_name
,
2009 sizeof(attr
->name
))) {
2010 ret
= LTTNG_ERR_INVALID
;
2014 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2015 if (ret
!= LTTNG_OK
) {
2019 /* Get the newly created channel reference back */
2020 uchan
= trace_ust_find_channel_by_name(
2021 usess
->domain_global
.channels
, channel_name
);
2025 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2027 * Don't allow users to add UST events to channels which
2028 * are assigned to a userspace subdomain (JUL, Log4J,
2031 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2035 if (!internal_event
) {
2037 * Ensure the event name is not reserved for internal
2040 ret
= validate_ust_event_name(event
->name
);
2042 WARN("Userspace event name %s failed validation.",
2044 event
->name
: "NULL");
2045 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2050 /* At this point, the session and channel exist on the tracer */
2051 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2052 filter_expression
, filter
, exclusion
,
2054 /* We have passed ownership */
2055 filter_expression
= NULL
;
2058 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2059 goto already_enabled
;
2060 } else if (ret
!= LTTNG_OK
) {
2065 case LTTNG_DOMAIN_LOG4J
:
2066 case LTTNG_DOMAIN_JUL
:
2067 case LTTNG_DOMAIN_PYTHON
:
2069 const char *default_event_name
, *default_chan_name
;
2071 struct lttng_event uevent
;
2072 struct lttng_domain tmp_dom
;
2073 struct ltt_ust_session
*usess
= session
->ust_session
;
2077 agt
= trace_ust_find_agent(usess
, domain
->type
);
2079 agt
= agent_create(domain
->type
);
2081 ret
= LTTNG_ERR_NOMEM
;
2084 agent_add(agt
, usess
->agents
);
2087 /* Create the default tracepoint. */
2088 memset(&uevent
, 0, sizeof(uevent
));
2089 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2090 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2091 default_event_name
= event_get_default_agent_ust_name(
2093 if (!default_event_name
) {
2094 ret
= LTTNG_ERR_FATAL
;
2097 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2098 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2101 * The domain type is changed because we are about to enable the
2102 * default channel and event for the JUL domain that are hardcoded.
2103 * This happens in the UST domain.
2105 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2106 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2108 switch (domain
->type
) {
2109 case LTTNG_DOMAIN_LOG4J
:
2110 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2112 case LTTNG_DOMAIN_JUL
:
2113 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2115 case LTTNG_DOMAIN_PYTHON
:
2116 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2119 /* The switch/case we are in makes this impossible */
2124 char *filter_expression_copy
= NULL
;
2125 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2128 const size_t filter_size
= sizeof(
2129 struct lttng_filter_bytecode
)
2132 filter_copy
= zmalloc(filter_size
);
2134 ret
= LTTNG_ERR_NOMEM
;
2137 memcpy(filter_copy
, filter
, filter_size
);
2139 filter_expression_copy
=
2140 strdup(filter_expression
);
2141 if (!filter_expression
) {
2142 ret
= LTTNG_ERR_NOMEM
;
2145 if (!filter_expression_copy
|| !filter_copy
) {
2146 free(filter_expression_copy
);
2152 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2153 (char *) default_chan_name
,
2154 &uevent
, filter_expression_copy
,
2155 filter_copy
, NULL
, wpipe
);
2158 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2159 goto already_enabled
;
2160 } else if (ret
!= LTTNG_OK
) {
2164 /* The wild card * means that everything should be enabled. */
2165 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2166 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2169 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2173 filter_expression
= NULL
;
2174 if (ret
!= LTTNG_OK
) {
2181 ret
= LTTNG_ERR_UND
;
2189 free(filter_expression
);
2198 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2199 * We own filter, exclusion, and filter_expression.
2201 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2202 char *channel_name
, struct lttng_event
*event
,
2203 char *filter_expression
,
2204 struct lttng_filter_bytecode
*filter
,
2205 struct lttng_event_exclusion
*exclusion
,
2208 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2209 filter_expression
, filter
, exclusion
, wpipe
, false);
2213 * Enable an event which is internal to LTTng. An internal should
2214 * never be made visible to clients and are immune to checks such as
2217 static int cmd_enable_event_internal(struct ltt_session
*session
,
2218 struct lttng_domain
*domain
,
2219 char *channel_name
, struct lttng_event
*event
,
2220 char *filter_expression
,
2221 struct lttng_filter_bytecode
*filter
,
2222 struct lttng_event_exclusion
*exclusion
,
2225 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2226 filter_expression
, filter
, exclusion
, wpipe
, true);
2230 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2232 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2233 struct lttng_event
**events
)
2236 ssize_t nb_events
= 0;
2239 case LTTNG_DOMAIN_KERNEL
:
2240 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2241 if (nb_events
< 0) {
2242 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2246 case LTTNG_DOMAIN_UST
:
2247 nb_events
= ust_app_list_events(events
);
2248 if (nb_events
< 0) {
2249 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2253 case LTTNG_DOMAIN_LOG4J
:
2254 case LTTNG_DOMAIN_JUL
:
2255 case LTTNG_DOMAIN_PYTHON
:
2256 nb_events
= agent_list_events(events
, domain
);
2257 if (nb_events
< 0) {
2258 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2263 ret
= LTTNG_ERR_UND
;
2270 /* Return negative value to differentiate return code */
2275 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2277 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2278 struct lttng_event_field
**fields
)
2281 ssize_t nb_fields
= 0;
2284 case LTTNG_DOMAIN_UST
:
2285 nb_fields
= ust_app_list_event_fields(fields
);
2286 if (nb_fields
< 0) {
2287 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2291 case LTTNG_DOMAIN_KERNEL
:
2292 default: /* fall-through */
2293 ret
= LTTNG_ERR_UND
;
2300 /* Return negative value to differentiate return code */
2304 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2306 return syscall_table_list(events
);
2310 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2312 * Called with session lock held.
2314 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2315 enum lttng_domain_type domain
, int32_t **pids
)
2318 ssize_t nr_pids
= 0;
2321 case LTTNG_DOMAIN_KERNEL
:
2323 struct ltt_kernel_session
*ksess
;
2325 ksess
= session
->kernel_session
;
2326 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2328 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2333 case LTTNG_DOMAIN_UST
:
2335 struct ltt_ust_session
*usess
;
2337 usess
= session
->ust_session
;
2338 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2340 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2345 case LTTNG_DOMAIN_LOG4J
:
2346 case LTTNG_DOMAIN_JUL
:
2347 case LTTNG_DOMAIN_PYTHON
:
2349 ret
= LTTNG_ERR_UND
;
2356 /* Return negative value to differentiate return code */
2361 * Command LTTNG_START_TRACE processed by the client thread.
2363 * Called with session mutex held.
2365 int cmd_start_trace(struct ltt_session
*session
)
2368 unsigned long nb_chan
= 0;
2369 struct ltt_kernel_session
*ksession
;
2370 struct ltt_ust_session
*usess
;
2374 /* Ease our life a bit ;) */
2375 ksession
= session
->kernel_session
;
2376 usess
= session
->ust_session
;
2378 /* Is the session already started? */
2379 if (session
->active
) {
2380 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2385 * Starting a session without channel is useless since after that it's not
2386 * possible to enable channel thus inform the client.
2388 if (usess
&& usess
->domain_global
.channels
) {
2389 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2392 nb_chan
+= ksession
->channel_count
;
2395 ret
= LTTNG_ERR_NO_CHANNEL
;
2399 /* Kernel tracing */
2400 if (ksession
!= NULL
) {
2401 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2402 if (ret
!= LTTNG_OK
) {
2407 /* Flag session that trace should start automatically */
2410 * Even though the start trace might fail, flag this session active so
2411 * other application coming in are started by default.
2415 ret
= ust_app_start_trace_all(usess
);
2417 ret
= LTTNG_ERR_UST_START_FAIL
;
2422 /* Flag this after a successful start. */
2423 session
->has_been_started
= 1;
2424 session
->active
= 1;
2433 * Command LTTNG_STOP_TRACE processed by the client thread.
2435 int cmd_stop_trace(struct ltt_session
*session
)
2438 struct ltt_kernel_channel
*kchan
;
2439 struct ltt_kernel_session
*ksession
;
2440 struct ltt_ust_session
*usess
;
2445 ksession
= session
->kernel_session
;
2446 usess
= session
->ust_session
;
2448 /* Session is not active. Skip everythong and inform the client. */
2449 if (!session
->active
) {
2450 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2455 if (ksession
&& ksession
->active
) {
2456 DBG("Stop kernel tracing");
2458 ret
= kernel_stop_session(ksession
);
2460 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2464 kernel_wait_quiescent(kernel_tracer_fd
);
2466 /* Flush metadata after stopping (if exists) */
2467 if (ksession
->metadata_stream_fd
>= 0) {
2468 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2470 ERR("Kernel metadata flush failed");
2474 /* Flush all buffers after stopping */
2475 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2476 ret
= kernel_flush_buffer(kchan
);
2478 ERR("Kernel flush buffer error");
2482 ksession
->active
= 0;
2485 if (usess
&& usess
->active
) {
2487 * Even though the stop trace might fail, flag this session inactive so
2488 * other application coming in are not started by default.
2492 ret
= ust_app_stop_trace_all(usess
);
2494 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2499 /* Flag inactive after a successful stop. */
2500 session
->active
= 0;
2508 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2510 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2511 struct lttng_uri
*uris
)
2514 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2515 struct ltt_ust_session
*usess
= session
->ust_session
;
2521 /* Can't set consumer URI if the session is active. */
2522 if (session
->active
) {
2523 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2527 /* Set the "global" consumer URIs */
2528 for (i
= 0; i
< nb_uri
; i
++) {
2529 ret
= add_uri_to_consumer(session
->consumer
,
2530 &uris
[i
], 0, session
->name
);
2531 if (ret
!= LTTNG_OK
) {
2536 /* Set UST session URIs */
2537 if (session
->ust_session
) {
2538 for (i
= 0; i
< nb_uri
; i
++) {
2539 ret
= add_uri_to_consumer(
2540 session
->ust_session
->consumer
,
2541 &uris
[i
], LTTNG_DOMAIN_UST
,
2543 if (ret
!= LTTNG_OK
) {
2549 /* Set kernel session URIs */
2550 if (session
->kernel_session
) {
2551 for (i
= 0; i
< nb_uri
; i
++) {
2552 ret
= add_uri_to_consumer(
2553 session
->kernel_session
->consumer
,
2554 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2556 if (ret
!= LTTNG_OK
) {
2563 * Make sure to set the session in output mode after we set URI since a
2564 * session can be created without URL (thus flagged in no output mode).
2566 session
->output_traces
= 1;
2568 ksess
->output_traces
= 1;
2572 usess
->output_traces
= 1;
2583 * Command LTTNG_CREATE_SESSION processed by the client thread.
2585 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2586 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2589 struct ltt_session
*session
;
2595 * Verify if the session already exist
2597 * XXX: There is no need for the session lock list here since the caller
2598 * (process_client_msg) is holding it. We might want to change that so a
2599 * single command does not lock the entire session list.
2601 session
= session_find_by_name(name
);
2602 if (session
!= NULL
) {
2603 ret
= LTTNG_ERR_EXIST_SESS
;
2607 /* Create tracing session in the registry */
2608 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2609 LTTNG_SOCK_GET_GID_CRED(creds
));
2610 if (ret
!= LTTNG_OK
) {
2615 * Get the newly created session pointer back
2617 * XXX: There is no need for the session lock list here since the caller
2618 * (process_client_msg) is holding it. We might want to change that so a
2619 * single command does not lock the entire session list.
2621 session
= session_find_by_name(name
);
2624 session
->live_timer
= live_timer
;
2625 /* Create default consumer output for the session not yet created. */
2626 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2627 if (session
->consumer
== NULL
) {
2628 ret
= LTTNG_ERR_FATAL
;
2629 goto consumer_error
;
2633 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2634 if (ret
!= LTTNG_OK
) {
2635 goto consumer_error
;
2637 session
->output_traces
= 1;
2639 session
->output_traces
= 0;
2640 DBG2("Session %s created with no output", session
->name
);
2643 session
->consumer
->enabled
= 1;
2648 session_destroy(session
);
2655 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2657 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2658 size_t nb_uri
, lttng_sock_cred
*creds
)
2661 struct ltt_session
*session
;
2662 struct snapshot_output
*new_output
= NULL
;
2668 * Create session in no output mode with URIs set to NULL. The uris we've
2669 * received are for a default snapshot output if one.
2671 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2672 if (ret
!= LTTNG_OK
) {
2676 /* Get the newly created session pointer back. This should NEVER fail. */
2677 session
= session_find_by_name(name
);
2680 /* Flag session for snapshot mode. */
2681 session
->snapshot_mode
= 1;
2683 /* Skip snapshot output creation if no URI is given. */
2688 new_output
= snapshot_output_alloc();
2690 ret
= LTTNG_ERR_NOMEM
;
2691 goto error_snapshot_alloc
;
2694 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2695 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2697 if (ret
== -ENOMEM
) {
2698 ret
= LTTNG_ERR_NOMEM
;
2700 ret
= LTTNG_ERR_INVALID
;
2702 goto error_snapshot
;
2706 snapshot_add_output(&session
->snapshot
, new_output
);
2713 snapshot_output_destroy(new_output
);
2714 error_snapshot_alloc
:
2715 session_destroy(session
);
2721 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2723 * Called with session lock held.
2725 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2728 struct ltt_ust_session
*usess
;
2729 struct ltt_kernel_session
*ksess
;
2734 usess
= session
->ust_session
;
2735 ksess
= session
->kernel_session
;
2737 /* Clean kernel session teardown */
2738 kernel_destroy_session(ksess
);
2740 /* UST session teardown */
2742 /* Close any relayd session */
2743 consumer_output_send_destroy_relayd(usess
->consumer
);
2745 /* Destroy every UST application related to this session. */
2746 ret
= ust_app_destroy_trace_all(usess
);
2748 ERR("Error in ust_app_destroy_trace_all");
2751 /* Clean up the rest. */
2752 trace_ust_destroy_session(usess
);
2756 * Must notify the kernel thread here to update it's poll set in order to
2757 * remove the channel(s)' fd just destroyed.
2759 ret
= notify_thread_pipe(wpipe
);
2761 PERROR("write kernel poll pipe");
2764 ret
= session_destroy(session
);
2770 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2772 int cmd_register_consumer(struct ltt_session
*session
,
2773 enum lttng_domain_type domain
, const char *sock_path
,
2774 struct consumer_data
*cdata
)
2777 struct consumer_socket
*socket
= NULL
;
2784 case LTTNG_DOMAIN_KERNEL
:
2786 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2790 /* Can't register a consumer if there is already one */
2791 if (ksess
->consumer_fds_sent
!= 0) {
2792 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2796 sock
= lttcomm_connect_unix_sock(sock_path
);
2798 ret
= LTTNG_ERR_CONNECT_FAIL
;
2801 cdata
->cmd_sock
= sock
;
2803 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2804 if (socket
== NULL
) {
2807 PERROR("close register consumer");
2809 cdata
->cmd_sock
= -1;
2810 ret
= LTTNG_ERR_FATAL
;
2814 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2815 if (socket
->lock
== NULL
) {
2816 PERROR("zmalloc pthread mutex");
2817 ret
= LTTNG_ERR_FATAL
;
2820 pthread_mutex_init(socket
->lock
, NULL
);
2821 socket
->registered
= 1;
2824 consumer_add_socket(socket
, ksess
->consumer
);
2827 pthread_mutex_lock(&cdata
->pid_mutex
);
2829 pthread_mutex_unlock(&cdata
->pid_mutex
);
2834 /* TODO: Userspace tracing */
2835 ret
= LTTNG_ERR_UND
;
2843 consumer_destroy_socket(socket
);
2849 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2851 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2852 struct lttng_domain
**domains
)
2857 struct lttng_ht_iter iter
;
2859 if (session
->kernel_session
!= NULL
) {
2860 DBG3("Listing domains found kernel domain");
2864 if (session
->ust_session
!= NULL
) {
2865 DBG3("Listing domains found UST global domain");
2869 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2871 if (agt
->being_used
) {
2882 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2883 if (*domains
== NULL
) {
2884 ret
= LTTNG_ERR_FATAL
;
2888 if (session
->kernel_session
!= NULL
) {
2889 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2891 /* Kernel session buffer type is always GLOBAL */
2892 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2897 if (session
->ust_session
!= NULL
) {
2898 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2899 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2903 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2905 if (agt
->being_used
) {
2906 (*domains
)[index
].type
= agt
->domain
;
2907 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2917 /* Return negative value to differentiate return code */
2923 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2925 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2926 struct ltt_session
*session
, struct lttng_channel
**channels
)
2928 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
2931 case LTTNG_DOMAIN_KERNEL
:
2932 if (session
->kernel_session
!= NULL
) {
2933 nb_chan
= session
->kernel_session
->channel_count
;
2935 DBG3("Number of kernel channels %zd", nb_chan
);
2937 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2941 case LTTNG_DOMAIN_UST
:
2942 if (session
->ust_session
!= NULL
) {
2944 nb_chan
= lttng_ht_get_count(
2945 session
->ust_session
->domain_global
.channels
);
2948 DBG3("Number of UST global channels %zd", nb_chan
);
2950 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2955 ret
= -LTTNG_ERR_UND
;
2960 const size_t channel_size
= sizeof(struct lttng_channel
) +
2961 sizeof(struct lttcomm_channel_extended
);
2962 struct lttcomm_channel_extended
*channel_exts
;
2964 payload_size
= nb_chan
* channel_size
;
2965 *channels
= zmalloc(payload_size
);
2966 if (*channels
== NULL
) {
2967 ret
= -LTTNG_ERR_FATAL
;
2971 channel_exts
= ((void *) *channels
) +
2972 (nb_chan
* sizeof(struct lttng_channel
));
2973 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
2974 if (ret
!= LTTNG_OK
) {
2989 * Command LTTNG_LIST_EVENTS processed by the client thread.
2991 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2992 struct ltt_session
*session
, char *channel_name
,
2993 struct lttng_event
**events
, size_t *total_size
)
2996 ssize_t nb_event
= 0;
2999 case LTTNG_DOMAIN_KERNEL
:
3000 if (session
->kernel_session
!= NULL
) {
3001 nb_event
= list_lttng_kernel_events(channel_name
,
3002 session
->kernel_session
, events
,
3006 case LTTNG_DOMAIN_UST
:
3008 if (session
->ust_session
!= NULL
) {
3009 nb_event
= list_lttng_ust_global_events(channel_name
,
3010 &session
->ust_session
->domain_global
, events
,
3015 case LTTNG_DOMAIN_LOG4J
:
3016 case LTTNG_DOMAIN_JUL
:
3017 case LTTNG_DOMAIN_PYTHON
:
3018 if (session
->ust_session
) {
3019 struct lttng_ht_iter iter
;
3023 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3024 &iter
.iter
, agt
, node
.node
) {
3025 if (agt
->domain
== domain
) {
3026 nb_event
= list_lttng_agent_events(
3036 ret
= LTTNG_ERR_UND
;
3043 /* Return negative value to differentiate return code */
3048 * Using the session list, filled a lttng_session array to send back to the
3049 * client for session listing.
3051 * The session list lock MUST be acquired before calling this function. Use
3052 * session_lock_list() and session_unlock_list().
3054 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3059 struct ltt_session
*session
;
3060 struct ltt_session_list
*list
= session_get_list();
3062 DBG("Getting all available session for UID %d GID %d",
3065 * Iterate over session list and append data after the control struct in
3068 cds_list_for_each_entry(session
, &list
->head
, list
) {
3070 * Only list the sessions the user can control.
3072 if (!session_access_ok(session
, uid
, gid
)) {
3076 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3077 struct ltt_ust_session
*usess
= session
->ust_session
;
3079 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3080 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3081 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3082 ret
= build_network_session_path(sessions
[i
].path
,
3083 sizeof(sessions
[i
].path
), session
);
3085 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3086 session
->consumer
->dst
.trace_path
);
3089 PERROR("snprintf session path");
3093 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3094 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3095 sessions
[i
].enabled
= session
->active
;
3096 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3097 sessions
[i
].live_timer_interval
= session
->live_timer
;
3103 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3104 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3106 int cmd_data_pending(struct ltt_session
*session
)
3109 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3110 struct ltt_ust_session
*usess
= session
->ust_session
;
3114 /* Session MUST be stopped to ask for data availability. */
3115 if (session
->active
) {
3116 ret
= LTTNG_ERR_SESSION_STARTED
;
3120 * If stopped, just make sure we've started before else the above call
3121 * will always send that there is data pending.
3123 * The consumer assumes that when the data pending command is received,
3124 * the trace has been started before or else no output data is written
3125 * by the streams which is a condition for data pending. So, this is
3126 * *VERY* important that we don't ask the consumer before a start
3129 if (!session
->has_been_started
) {
3135 if (ksess
&& ksess
->consumer
) {
3136 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3138 /* Data is still being extracted for the kernel. */
3143 if (usess
&& usess
->consumer
) {
3144 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3146 /* Data is still being extracted for the kernel. */
3151 /* Data is ready to be read by a viewer */
3159 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3161 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3163 int cmd_snapshot_add_output(struct ltt_session
*session
,
3164 struct lttng_snapshot_output
*output
, uint32_t *id
)
3167 struct snapshot_output
*new_output
;
3172 DBG("Cmd snapshot add output for session %s", session
->name
);
3175 * Can't create an output if the session is not set in no-output mode.
3177 if (session
->output_traces
) {
3178 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3182 /* Only one output is allowed until we have the "tee" feature. */
3183 if (session
->snapshot
.nb_output
== 1) {
3184 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3188 new_output
= snapshot_output_alloc();
3190 ret
= LTTNG_ERR_NOMEM
;
3194 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3195 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3196 &session
->snapshot
);
3198 if (ret
== -ENOMEM
) {
3199 ret
= LTTNG_ERR_NOMEM
;
3201 ret
= LTTNG_ERR_INVALID
;
3207 snapshot_add_output(&session
->snapshot
, new_output
);
3209 *id
= new_output
->id
;
3216 snapshot_output_destroy(new_output
);
3222 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3224 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3226 int cmd_snapshot_del_output(struct ltt_session
*session
,
3227 struct lttng_snapshot_output
*output
)
3230 struct snapshot_output
*sout
= NULL
;
3238 * Permission denied to create an output if the session is not
3239 * set in no output mode.
3241 if (session
->output_traces
) {
3242 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3247 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3249 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3250 } else if (*output
->name
!= '\0') {
3251 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3253 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3256 ret
= LTTNG_ERR_INVALID
;
3260 snapshot_delete_output(&session
->snapshot
, sout
);
3261 snapshot_output_destroy(sout
);
3270 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3272 * If no output is available, outputs is untouched and 0 is returned.
3274 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3276 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3277 struct lttng_snapshot_output
**outputs
)
3280 struct lttng_snapshot_output
*list
= NULL
;
3281 struct lttng_ht_iter iter
;
3282 struct snapshot_output
*output
;
3287 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3290 * Permission denied to create an output if the session is not
3291 * set in no output mode.
3293 if (session
->output_traces
) {
3294 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3298 if (session
->snapshot
.nb_output
== 0) {
3303 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3305 ret
= -LTTNG_ERR_NOMEM
;
3309 /* Copy list from session to the new list object. */
3311 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3312 output
, node
.node
) {
3313 assert(output
->consumer
);
3314 list
[idx
].id
= output
->id
;
3315 list
[idx
].max_size
= output
->max_size
;
3316 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3317 sizeof(list
[idx
].name
))) {
3318 ret
= -LTTNG_ERR_INVALID
;
3321 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3322 if (lttng_strncpy(list
[idx
].ctrl_url
,
3323 output
->consumer
->dst
.trace_path
,
3324 sizeof(list
[idx
].ctrl_url
))) {
3325 ret
= -LTTNG_ERR_INVALID
;
3330 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3331 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3333 ret
= -LTTNG_ERR_NOMEM
;
3338 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3339 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3341 ret
= -LTTNG_ERR_NOMEM
;
3350 ret
= session
->snapshot
.nb_output
;
3359 * Check if we can regenerate the metadata for this session.
3360 * Only kernel, UST per-uid and non-live sessions are supported.
3362 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3365 int check_regenerate_metadata_support(struct ltt_session
*session
)
3371 if (session
->live_timer
!= 0) {
3372 ret
= LTTNG_ERR_LIVE_SESSION
;
3375 if (!session
->active
) {
3376 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3379 if (session
->ust_session
) {
3380 switch (session
->ust_session
->buffer_type
) {
3381 case LTTNG_BUFFER_PER_UID
:
3383 case LTTNG_BUFFER_PER_PID
:
3384 ret
= LTTNG_ERR_PER_PID_SESSION
;
3388 ret
= LTTNG_ERR_UNK
;
3392 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3393 session
->consumer
->relay_minor_version
< 8) {
3394 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3404 int clear_metadata_file(int fd
)
3408 ret
= lseek(fd
, 0, SEEK_SET
);
3414 ret
= ftruncate(fd
, 0);
3416 PERROR("ftruncate");
3425 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3428 struct buffer_reg_uid
*uid_reg
= NULL
;
3429 struct buffer_reg_session
*session_reg
= NULL
;
3432 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3433 struct ust_registry_session
*registry
;
3434 struct ust_registry_channel
*chan
;
3435 struct lttng_ht_iter iter_chan
;
3437 session_reg
= uid_reg
->registry
;
3438 registry
= session_reg
->reg
.ust
;
3440 pthread_mutex_lock(®istry
->lock
);
3441 registry
->metadata_len_sent
= 0;
3442 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3443 registry
->metadata_len
= 0;
3444 registry
->metadata_version
++;
3445 if (registry
->metadata_fd
> 0) {
3446 /* Clear the metadata file's content. */
3447 ret
= clear_metadata_file(registry
->metadata_fd
);
3449 pthread_mutex_unlock(®istry
->lock
);
3454 ret
= ust_metadata_session_statedump(registry
, NULL
,
3455 registry
->major
, registry
->minor
);
3457 pthread_mutex_unlock(®istry
->lock
);
3458 ERR("Failed to generate session metadata (err = %d)",
3462 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3464 struct ust_registry_event
*event
;
3465 struct lttng_ht_iter iter_event
;
3467 ret
= ust_metadata_channel_statedump(registry
, chan
);
3469 pthread_mutex_unlock(®istry
->lock
);
3470 ERR("Failed to generate channel metadata "
3474 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3476 ret
= ust_metadata_event_statedump(registry
,
3479 pthread_mutex_unlock(®istry
->lock
);
3480 ERR("Failed to generate event metadata "
3486 pthread_mutex_unlock(®istry
->lock
);
3495 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3497 * Ask the consumer to truncate the existing metadata file(s) and
3498 * then regenerate the metadata. Live and per-pid sessions are not
3499 * supported and return an error.
3501 * Return 0 on success or else a LTTNG_ERR code.
3503 int cmd_regenerate_metadata(struct ltt_session
*session
)
3509 ret
= check_regenerate_metadata_support(session
);
3514 if (session
->kernel_session
) {
3515 ret
= kernctl_session_regenerate_metadata(
3516 session
->kernel_session
->fd
);
3518 ERR("Failed to regenerate the kernel metadata");
3523 if (session
->ust_session
) {
3524 ret
= ust_regenerate_metadata(session
->ust_session
);
3526 ERR("Failed to regenerate the UST metadata");
3530 DBG("Cmd metadata regenerate for session %s", session
->name
);
3538 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
3540 * Ask the tracer to regenerate a new statedump.
3542 * Return 0 on success or else a LTTNG_ERR code.
3544 int cmd_regenerate_statedump(struct ltt_session
*session
)
3550 if (!session
->active
) {
3551 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3556 if (session
->kernel_session
) {
3557 ret
= kernctl_session_regenerate_statedump(
3558 session
->kernel_session
->fd
);
3560 * Currently, the statedump in kernel can only fail if out
3564 if (ret
== -ENOMEM
) {
3565 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
3567 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3569 ERR("Failed to regenerate the kernel statedump");
3574 if (session
->ust_session
) {
3575 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
3577 * Currently, the statedump in UST always returns 0.
3580 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3581 ERR("Failed to regenerate the UST statedump");
3585 DBG("Cmd regenerate statedump for session %s", session
->name
);
3593 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3594 * snapshot output is *not* set with a remote destination.
3596 * Return 0 on success or a LTTNG_ERR code.
3598 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3599 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3602 struct lttng_ht_iter iter
;
3603 struct consumer_socket
*socket
;
3606 assert(snap_output
);
3609 DBG2("Set relayd object from snapshot output");
3611 /* Ignore if snapshot consumer output is not network. */
3612 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3617 * For each consumer socket, create and send the relayd object of the
3621 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3622 socket
, node
.node
) {
3623 pthread_mutex_lock(socket
->lock
);
3624 ret
= send_consumer_relayd_sockets(0, session
->id
,
3625 snap_output
->consumer
, socket
,
3626 session
->name
, session
->hostname
,
3627 session
->live_timer
);
3628 pthread_mutex_unlock(socket
->lock
);
3629 if (ret
!= LTTNG_OK
) {
3641 * Record a kernel snapshot.
3643 * Return LTTNG_OK on success or a LTTNG_ERR code.
3645 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3646 struct snapshot_output
*output
, struct ltt_session
*session
,
3647 int wait
, uint64_t nb_packets_per_stream
)
3657 * Copy kernel session sockets so we can communicate with the right
3658 * consumer for the snapshot record command.
3660 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3662 ret
= LTTNG_ERR_NOMEM
;
3666 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3667 if (ret
!= LTTNG_OK
) {
3668 goto error_snapshot
;
3671 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3672 if (ret
!= LTTNG_OK
) {
3673 goto error_snapshot
;
3680 /* Clean up copied sockets so this output can use some other later on. */
3681 consumer_destroy_output_sockets(output
->consumer
);
3688 * Record a UST snapshot.
3690 * Return 0 on success or a LTTNG_ERR error code.
3692 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3693 struct snapshot_output
*output
, struct ltt_session
*session
,
3694 int wait
, uint64_t nb_packets_per_stream
)
3703 * Copy UST session sockets so we can communicate with the right
3704 * consumer for the snapshot record command.
3706 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3708 ret
= LTTNG_ERR_NOMEM
;
3712 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3713 if (ret
!= LTTNG_OK
) {
3714 goto error_snapshot
;
3717 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3721 ret
= LTTNG_ERR_INVALID
;
3724 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3727 goto error_snapshot
;
3733 /* Clean up copied sockets so this output can use some other later on. */
3734 consumer_destroy_output_sockets(output
->consumer
);
3740 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3741 uint64_t cur_nr_packets
)
3743 uint64_t tot_size
= 0;
3745 if (session
->kernel_session
) {
3746 struct ltt_kernel_channel
*chan
;
3747 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3749 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3750 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3752 * Don't take channel into account if we
3753 * already grab all its packets.
3757 tot_size
+= chan
->channel
->attr
.subbuf_size
3758 * chan
->stream_count
;
3762 if (session
->ust_session
) {
3763 struct ltt_ust_session
*usess
= session
->ust_session
;
3765 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3773 * Calculate the number of packets we can grab from each stream that
3774 * fits within the overall snapshot max size.
3776 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3777 * the number of packets per stream.
3779 * TODO: this approach is not perfect: we consider the worse case
3780 * (packet filling the sub-buffers) as an upper bound, but we could do
3781 * better if we do this calculation while we actually grab the packet
3782 * content: we would know how much padding we don't actually store into
3785 * This algorithm is currently bounded by the number of packets per
3788 * Since we call this algorithm before actually grabbing the data, it's
3789 * an approximation: for instance, applications could appear/disappear
3790 * in between this call and actually grabbing data.
3793 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3796 uint64_t cur_nb_packets
= 0;
3799 return 0; /* Infinite */
3802 size_left
= max_size
;
3804 uint64_t one_more_packet_tot_size
;
3806 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3808 if (!one_more_packet_tot_size
) {
3809 /* We are already grabbing all packets. */
3812 size_left
-= one_more_packet_tot_size
;
3813 if (size_left
< 0) {
3818 if (!cur_nb_packets
) {
3819 /* Not enough room to grab one packet of each stream, error. */
3822 return cur_nb_packets
;
3826 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3828 * The wait parameter is ignored so this call always wait for the snapshot to
3829 * complete before returning.
3831 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3833 int cmd_snapshot_record(struct ltt_session
*session
,
3834 struct lttng_snapshot_output
*output
, int wait
)
3837 unsigned int use_tmp_output
= 0;
3838 struct snapshot_output tmp_output
;
3839 unsigned int snapshot_success
= 0;
3845 DBG("Cmd snapshot record for session %s", session
->name
);
3847 /* Get the datetime for the snapshot output directory. */
3848 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3851 ret
= LTTNG_ERR_INVALID
;
3856 * Permission denied to create an output if the session is not
3857 * set in no output mode.
3859 if (session
->output_traces
) {
3860 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3864 /* The session needs to be started at least once. */
3865 if (!session
->has_been_started
) {
3866 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3870 /* Use temporary output for the session. */
3871 if (*output
->ctrl_url
!= '\0') {
3872 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3873 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3876 if (ret
== -ENOMEM
) {
3877 ret
= LTTNG_ERR_NOMEM
;
3879 ret
= LTTNG_ERR_INVALID
;
3883 /* Use the global session count for the temporary snapshot. */
3884 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3886 /* Use the global datetime */
3887 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3891 if (use_tmp_output
) {
3892 int64_t nb_packets_per_stream
;
3894 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3895 tmp_output
.max_size
);
3896 if (nb_packets_per_stream
< 0) {
3897 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3901 if (session
->kernel_session
) {
3902 ret
= record_kernel_snapshot(session
->kernel_session
,
3903 &tmp_output
, session
,
3904 wait
, nb_packets_per_stream
);
3905 if (ret
!= LTTNG_OK
) {
3910 if (session
->ust_session
) {
3911 ret
= record_ust_snapshot(session
->ust_session
,
3912 &tmp_output
, session
,
3913 wait
, nb_packets_per_stream
);
3914 if (ret
!= LTTNG_OK
) {
3919 snapshot_success
= 1;
3921 struct snapshot_output
*sout
;
3922 struct lttng_ht_iter iter
;
3925 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3926 &iter
.iter
, sout
, node
.node
) {
3927 int64_t nb_packets_per_stream
;
3930 * Make a local copy of the output and assign the possible
3931 * temporary value given by the caller.
3933 memset(&tmp_output
, 0, sizeof(tmp_output
));
3934 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3936 if (output
->max_size
!= (uint64_t) -1ULL) {
3937 tmp_output
.max_size
= output
->max_size
;
3940 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3941 tmp_output
.max_size
);
3942 if (nb_packets_per_stream
< 0) {
3943 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3948 /* Use temporary name. */
3949 if (*output
->name
!= '\0') {
3950 if (lttng_strncpy(tmp_output
.name
, output
->name
,
3951 sizeof(tmp_output
.name
))) {
3952 ret
= LTTNG_ERR_INVALID
;
3958 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3959 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3961 if (session
->kernel_session
) {
3962 ret
= record_kernel_snapshot(session
->kernel_session
,
3963 &tmp_output
, session
,
3964 wait
, nb_packets_per_stream
);
3965 if (ret
!= LTTNG_OK
) {
3971 if (session
->ust_session
) {
3972 ret
= record_ust_snapshot(session
->ust_session
,
3973 &tmp_output
, session
,
3974 wait
, nb_packets_per_stream
);
3975 if (ret
!= LTTNG_OK
) {
3980 snapshot_success
= 1;
3985 if (snapshot_success
) {
3986 session
->snapshot
.nb_snapshot
++;
3988 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3996 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3998 int cmd_set_session_shm_path(struct ltt_session
*session
,
3999 const char *shm_path
)
4005 * Can only set shm path before session is started.
4007 if (session
->has_been_started
) {
4008 return LTTNG_ERR_SESSION_STARTED
;
4011 strncpy(session
->shm_path
, shm_path
,
4012 sizeof(session
->shm_path
));
4013 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4019 * Init command subsystem.
4024 * Set network sequence index to 1 for streams to match a relayd
4025 * socket on the consumer side.
4027 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
4028 relayd_net_seq_idx
= 1;
4029 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
4031 DBG("Command subsystem initialized");