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
);
859 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
861 } else if (ret
< 0) {
862 ERR("Unable to reach lttng-relayd");
863 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
866 consumer
->relay_major_version
= rsock
->major
;
867 consumer
->relay_minor_version
= rsock
->minor
;
868 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
869 DBG3("Creating relayd data socket from URI");
871 /* Command is not valid */
872 ERR("Relayd invalid stream type: %d", uri
->stype
);
873 ret
= LTTNG_ERR_INVALID
;
877 *relayd_sock
= rsock
;
882 /* The returned value is not useful since we are on an error path. */
883 (void) relayd_close(rsock
);
891 * Connect to the relayd using URI and send the socket to the right consumer.
893 * The consumer socket lock must be held by the caller.
895 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
896 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
897 struct consumer_output
*consumer
,
898 struct consumer_socket
*consumer_sock
,
899 char *session_name
, char *hostname
, int session_live_timer
)
902 struct lttcomm_relayd_sock
*rsock
= NULL
;
904 /* Connect to relayd and make version check if uri is the control. */
905 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
906 if (ret
!= LTTNG_OK
) {
907 goto relayd_comm_error
;
911 /* Set the network sequence index if not set. */
912 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
913 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
915 * Increment net_seq_idx because we are about to transfer the
916 * new relayd socket to the consumer.
917 * Assign unique key so the consumer can match streams.
919 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
920 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
923 /* Send relayd socket to consumer. */
924 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
925 relayd_uri
->stype
, session_id
,
926 session_name
, hostname
, session_live_timer
);
928 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
932 /* Flag that the corresponding socket was sent. */
933 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
934 consumer_sock
->control_sock_sent
= 1;
935 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
936 consumer_sock
->data_sock_sent
= 1;
942 * Close socket which was dup on the consumer side. The session daemon does
943 * NOT keep track of the relayd socket(s) once transfer to the consumer.
947 if (ret
!= LTTNG_OK
) {
949 * The consumer output for this session should not be used anymore
950 * since the relayd connection failed thus making any tracing or/and
951 * streaming not usable.
953 consumer
->enabled
= 0;
955 (void) relayd_close(rsock
);
963 * Send both relayd sockets to a specific consumer and domain. This is a
964 * helper function to facilitate sending the information to the consumer for a
967 * The consumer socket lock must be held by the caller.
969 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
970 unsigned int session_id
, struct consumer_output
*consumer
,
971 struct consumer_socket
*sock
, char *session_name
,
972 char *hostname
, int session_live_timer
)
979 /* Sending control relayd socket. */
980 if (!sock
->control_sock_sent
) {
981 ret
= send_consumer_relayd_socket(domain
, session_id
,
982 &consumer
->dst
.net
.control
, consumer
, sock
,
983 session_name
, hostname
, session_live_timer
);
984 if (ret
!= LTTNG_OK
) {
989 /* Sending data relayd socket. */
990 if (!sock
->data_sock_sent
) {
991 ret
= send_consumer_relayd_socket(domain
, session_id
,
992 &consumer
->dst
.net
.data
, consumer
, sock
,
993 session_name
, hostname
, session_live_timer
);
994 if (ret
!= LTTNG_OK
) {
1004 * Setup relayd connections for a tracing session. First creates the socket to
1005 * the relayd and send them to the right domain consumer. Consumer type MUST be
1008 int cmd_setup_relayd(struct ltt_session
*session
)
1011 struct ltt_ust_session
*usess
;
1012 struct ltt_kernel_session
*ksess
;
1013 struct consumer_socket
*socket
;
1014 struct lttng_ht_iter iter
;
1018 usess
= session
->ust_session
;
1019 ksess
= session
->kernel_session
;
1021 DBG("Setting relayd for session %s", session
->name
);
1025 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1026 && usess
->consumer
->enabled
) {
1027 /* For each consumer socket, send relayd sockets */
1028 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1029 socket
, node
.node
) {
1030 pthread_mutex_lock(socket
->lock
);
1031 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1032 usess
->consumer
, socket
,
1033 session
->name
, session
->hostname
,
1034 session
->live_timer
);
1035 pthread_mutex_unlock(socket
->lock
);
1036 if (ret
!= LTTNG_OK
) {
1039 /* Session is now ready for network streaming. */
1040 session
->net_handle
= 1;
1042 session
->consumer
->relay_major_version
=
1043 usess
->consumer
->relay_major_version
;
1044 session
->consumer
->relay_minor_version
=
1045 usess
->consumer
->relay_minor_version
;
1048 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1049 && ksess
->consumer
->enabled
) {
1050 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1051 socket
, node
.node
) {
1052 pthread_mutex_lock(socket
->lock
);
1053 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1054 ksess
->consumer
, socket
,
1055 session
->name
, session
->hostname
,
1056 session
->live_timer
);
1057 pthread_mutex_unlock(socket
->lock
);
1058 if (ret
!= LTTNG_OK
) {
1061 /* Session is now ready for network streaming. */
1062 session
->net_handle
= 1;
1064 session
->consumer
->relay_major_version
=
1065 ksess
->consumer
->relay_major_version
;
1066 session
->consumer
->relay_minor_version
=
1067 ksess
->consumer
->relay_minor_version
;
1076 * Start a kernel session by opening all necessary streams.
1078 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1081 struct ltt_kernel_channel
*kchan
;
1083 /* Open kernel metadata */
1084 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1085 ret
= kernel_open_metadata(ksess
);
1087 ret
= LTTNG_ERR_KERN_META_FAIL
;
1092 /* Open kernel metadata stream */
1093 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1094 ret
= kernel_open_metadata_stream(ksess
);
1096 ERR("Kernel create metadata stream failed");
1097 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1102 /* For each channel */
1103 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1104 if (kchan
->stream_count
== 0) {
1105 ret
= kernel_open_channel_stream(kchan
);
1107 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1110 /* Update the stream global counter */
1111 ksess
->stream_count_global
+= ret
;
1115 /* Setup kernel consumer socket and send fds to it */
1116 ret
= init_kernel_tracing(ksess
);
1118 ret
= LTTNG_ERR_KERN_START_FAIL
;
1122 /* This start the kernel tracing */
1123 ret
= kernel_start_session(ksess
);
1125 ret
= LTTNG_ERR_KERN_START_FAIL
;
1129 /* Quiescent wait after starting trace */
1130 kernel_wait_quiescent(kernel_tracer_fd
);
1141 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1143 int cmd_disable_channel(struct ltt_session
*session
,
1144 enum lttng_domain_type domain
, char *channel_name
)
1147 struct ltt_ust_session
*usess
;
1149 usess
= session
->ust_session
;
1154 case LTTNG_DOMAIN_KERNEL
:
1156 ret
= channel_kernel_disable(session
->kernel_session
,
1158 if (ret
!= LTTNG_OK
) {
1162 kernel_wait_quiescent(kernel_tracer_fd
);
1165 case LTTNG_DOMAIN_UST
:
1167 struct ltt_ust_channel
*uchan
;
1168 struct lttng_ht
*chan_ht
;
1170 chan_ht
= usess
->domain_global
.channels
;
1172 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1173 if (uchan
== NULL
) {
1174 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1178 ret
= channel_ust_disable(usess
, uchan
);
1179 if (ret
!= LTTNG_OK
) {
1185 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1197 * Command LTTNG_TRACK_PID processed by the client thread.
1199 * Called with session lock held.
1201 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1209 case LTTNG_DOMAIN_KERNEL
:
1211 struct ltt_kernel_session
*ksess
;
1213 ksess
= session
->kernel_session
;
1215 ret
= kernel_track_pid(ksess
, pid
);
1216 if (ret
!= LTTNG_OK
) {
1220 kernel_wait_quiescent(kernel_tracer_fd
);
1223 case LTTNG_DOMAIN_UST
:
1225 struct ltt_ust_session
*usess
;
1227 usess
= session
->ust_session
;
1229 ret
= trace_ust_track_pid(usess
, pid
);
1230 if (ret
!= LTTNG_OK
) {
1236 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1248 * Command LTTNG_UNTRACK_PID processed by the client thread.
1250 * Called with session lock held.
1252 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1260 case LTTNG_DOMAIN_KERNEL
:
1262 struct ltt_kernel_session
*ksess
;
1264 ksess
= session
->kernel_session
;
1266 ret
= kernel_untrack_pid(ksess
, pid
);
1267 if (ret
!= LTTNG_OK
) {
1271 kernel_wait_quiescent(kernel_tracer_fd
);
1274 case LTTNG_DOMAIN_UST
:
1276 struct ltt_ust_session
*usess
;
1278 usess
= session
->ust_session
;
1280 ret
= trace_ust_untrack_pid(usess
, pid
);
1281 if (ret
!= LTTNG_OK
) {
1287 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1299 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1301 * The wpipe arguments is used as a notifier for the kernel thread.
1303 int cmd_enable_channel(struct ltt_session
*session
,
1304 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1307 struct ltt_ust_session
*usess
= session
->ust_session
;
1308 struct lttng_ht
*chan_ht
;
1315 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1317 /* Validate channel name */
1318 if (attr
->name
[0] == '.' ||
1319 memchr(attr
->name
, '/', len
) != NULL
) {
1320 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1324 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1329 * Don't try to enable a channel if the session has been started at
1330 * some point in time before. The tracer does not allow it.
1332 if (session
->has_been_started
) {
1333 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1338 * If the session is a live session, remove the switch timer, the
1339 * live timer does the same thing but sends also synchronisation
1340 * beacons for inactive streams.
1342 if (session
->live_timer
> 0) {
1343 attr
->attr
.live_timer_interval
= session
->live_timer
;
1344 attr
->attr
.switch_timer_interval
= 0;
1347 switch (domain
->type
) {
1348 case LTTNG_DOMAIN_KERNEL
:
1350 struct ltt_kernel_channel
*kchan
;
1352 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1353 session
->kernel_session
);
1354 if (kchan
== NULL
) {
1355 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1356 if (attr
->name
[0] != '\0') {
1357 session
->kernel_session
->has_non_default_channel
= 1;
1360 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1363 if (ret
!= LTTNG_OK
) {
1367 kernel_wait_quiescent(kernel_tracer_fd
);
1370 case LTTNG_DOMAIN_UST
:
1371 case LTTNG_DOMAIN_JUL
:
1372 case LTTNG_DOMAIN_LOG4J
:
1373 case LTTNG_DOMAIN_PYTHON
:
1375 struct ltt_ust_channel
*uchan
;
1380 * Current agent implementation limitations force us to allow
1381 * only one channel at once in "agent" subdomains. Each
1382 * subdomain has a default channel name which must be strictly
1385 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1386 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1387 LTTNG_SYMBOL_NAME_LEN
)) {
1388 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1391 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1392 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1393 LTTNG_SYMBOL_NAME_LEN
)) {
1394 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1397 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1398 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1399 LTTNG_SYMBOL_NAME_LEN
)) {
1400 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1405 chan_ht
= usess
->domain_global
.channels
;
1407 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1408 if (uchan
== NULL
) {
1409 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1410 if (attr
->name
[0] != '\0') {
1411 usess
->has_non_default_channel
= 1;
1414 ret
= channel_ust_enable(usess
, uchan
);
1419 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1430 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1432 int cmd_disable_event(struct ltt_session
*session
,
1433 enum lttng_domain_type domain
, char *channel_name
,
1434 struct lttng_event
*event
)
1439 DBG("Disable event command for event \'%s\'", event
->name
);
1441 event_name
= event
->name
;
1442 if (validate_event_name(event_name
)) {
1443 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1447 /* Error out on unhandled search criteria */
1448 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1449 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1450 ret
= LTTNG_ERR_UNK
;
1457 case LTTNG_DOMAIN_KERNEL
:
1459 struct ltt_kernel_channel
*kchan
;
1460 struct ltt_kernel_session
*ksess
;
1462 ksess
= session
->kernel_session
;
1465 * If a non-default channel has been created in the
1466 * session, explicitely require that -c chan_name needs
1469 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1470 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1474 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1475 if (kchan
== NULL
) {
1476 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1480 switch (event
->type
) {
1481 case LTTNG_EVENT_ALL
:
1482 case LTTNG_EVENT_TRACEPOINT
:
1483 case LTTNG_EVENT_SYSCALL
:
1484 case LTTNG_EVENT_PROBE
:
1485 case LTTNG_EVENT_FUNCTION
:
1486 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1487 if (event_name
[0] == '\0') {
1488 ret
= event_kernel_disable_event(kchan
,
1491 ret
= event_kernel_disable_event(kchan
,
1492 event_name
, event
->type
);
1494 if (ret
!= LTTNG_OK
) {
1499 ret
= LTTNG_ERR_UNK
;
1503 kernel_wait_quiescent(kernel_tracer_fd
);
1506 case LTTNG_DOMAIN_UST
:
1508 struct ltt_ust_channel
*uchan
;
1509 struct ltt_ust_session
*usess
;
1511 usess
= session
->ust_session
;
1513 if (validate_ust_event_name(event_name
)) {
1514 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1519 * If a non-default channel has been created in the
1520 * session, explicitly require that -c chan_name needs
1523 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1524 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1528 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1530 if (uchan
== NULL
) {
1531 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1535 switch (event
->type
) {
1536 case LTTNG_EVENT_ALL
:
1538 * An empty event name means that everything
1539 * should be disabled.
1541 if (event
->name
[0] == '\0') {
1542 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1544 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1547 if (ret
!= LTTNG_OK
) {
1552 ret
= LTTNG_ERR_UNK
;
1556 DBG3("Disable UST event %s in channel %s completed", event_name
,
1560 case LTTNG_DOMAIN_LOG4J
:
1561 case LTTNG_DOMAIN_JUL
:
1562 case LTTNG_DOMAIN_PYTHON
:
1565 struct ltt_ust_session
*usess
= session
->ust_session
;
1569 switch (event
->type
) {
1570 case LTTNG_EVENT_ALL
:
1573 ret
= LTTNG_ERR_UNK
;
1577 agt
= trace_ust_find_agent(usess
, domain
);
1579 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1583 * An empty event name means that everything
1584 * should be disabled.
1586 if (event
->name
[0] == '\0') {
1587 ret
= event_agent_disable_all(usess
, agt
);
1589 ret
= event_agent_disable(usess
, agt
, event_name
);
1591 if (ret
!= LTTNG_OK
) {
1598 ret
= LTTNG_ERR_UND
;
1611 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1613 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1614 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1616 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1617 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1620 * Don't try to add a context if the session has been started at
1621 * some point in time before. The tracer does not allow it and would
1622 * result in a corrupted trace.
1624 if (session
->has_been_started
) {
1625 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1629 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1630 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1631 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1635 case LTTNG_DOMAIN_KERNEL
:
1636 assert(session
->kernel_session
);
1638 if (session
->kernel_session
->channel_count
== 0) {
1639 /* Create default channel */
1640 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1641 if (ret
!= LTTNG_OK
) {
1644 chan_kern_created
= 1;
1646 /* Add kernel context to kernel tracer */
1647 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1648 if (ret
!= LTTNG_OK
) {
1652 case LTTNG_DOMAIN_JUL
:
1653 case LTTNG_DOMAIN_LOG4J
:
1656 * Validate channel name.
1657 * If no channel name is given and the domain is JUL or LOG4J,
1658 * set it to the appropriate domain-specific channel name. If
1659 * a name is provided but does not match the expexted channel
1660 * name, return an error.
1662 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1663 strcmp(channel_name
,
1664 DEFAULT_JUL_CHANNEL_NAME
)) {
1665 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1667 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1668 strcmp(channel_name
,
1669 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1670 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1673 /* break is _not_ missing here. */
1675 case LTTNG_DOMAIN_UST
:
1677 struct ltt_ust_session
*usess
= session
->ust_session
;
1678 unsigned int chan_count
;
1682 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1683 if (chan_count
== 0) {
1684 struct lttng_channel
*attr
;
1685 /* Create default channel */
1686 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1688 ret
= LTTNG_ERR_FATAL
;
1692 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1693 if (ret
!= LTTNG_OK
) {
1698 chan_ust_created
= 1;
1701 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1702 free(app_ctx_provider_name
);
1704 app_ctx_name
= NULL
;
1705 app_ctx_provider_name
= NULL
;
1706 if (ret
!= LTTNG_OK
) {
1712 ret
= LTTNG_ERR_UND
;
1720 if (chan_kern_created
) {
1721 struct ltt_kernel_channel
*kchan
=
1722 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1723 session
->kernel_session
);
1724 /* Created previously, this should NOT fail. */
1726 kernel_destroy_channel(kchan
);
1729 if (chan_ust_created
) {
1730 struct ltt_ust_channel
*uchan
=
1731 trace_ust_find_channel_by_name(
1732 session
->ust_session
->domain_global
.channels
,
1733 DEFAULT_CHANNEL_NAME
);
1734 /* Created previously, this should NOT fail. */
1736 /* Remove from the channel list of the session. */
1737 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1739 trace_ust_destroy_channel(uchan
);
1742 free(app_ctx_provider_name
);
1747 static int validate_event_name(const char *name
)
1750 const char *c
= name
;
1751 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1752 bool null_terminated
= false;
1755 * Make sure that unescaped wildcards are only used as the last
1756 * character of the event name.
1758 while (c
< event_name_end
) {
1761 null_terminated
= true;
1767 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1768 /* Wildcard is not the last character */
1769 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1778 if (!ret
&& !null_terminated
) {
1779 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1784 static inline bool name_starts_with(const char *name
, const char *prefix
)
1786 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1788 return !strncmp(name
, prefix
, max_cmp_len
);
1791 /* Perform userspace-specific event name validation */
1792 static int validate_ust_event_name(const char *name
)
1802 * Check name against all internal UST event component namespaces used
1805 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1806 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1807 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1816 * Internal version of cmd_enable_event() with a supplemental
1817 * "internal_event" flag which is used to enable internal events which should
1818 * be hidden from clients. Such events are used in the agent implementation to
1819 * enable the events through which all "agent" events are funeled.
1821 static int _cmd_enable_event(struct ltt_session
*session
,
1822 struct lttng_domain
*domain
,
1823 char *channel_name
, struct lttng_event
*event
,
1824 char *filter_expression
,
1825 struct lttng_filter_bytecode
*filter
,
1826 struct lttng_event_exclusion
*exclusion
,
1827 int wpipe
, bool internal_event
)
1829 int ret
, channel_created
= 0;
1830 struct lttng_channel
*attr
= NULL
;
1834 assert(channel_name
);
1836 /* If we have a filter, we must have its filter expression */
1837 assert(!(!!filter_expression
^ !!filter
));
1839 DBG("Enable event command for event \'%s\'", event
->name
);
1843 ret
= validate_event_name(event
->name
);
1848 switch (domain
->type
) {
1849 case LTTNG_DOMAIN_KERNEL
:
1851 struct ltt_kernel_channel
*kchan
;
1854 * If a non-default channel has been created in the
1855 * session, explicitely require that -c chan_name needs
1858 if (session
->kernel_session
->has_non_default_channel
1859 && channel_name
[0] == '\0') {
1860 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1864 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1865 session
->kernel_session
);
1866 if (kchan
== NULL
) {
1867 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1868 LTTNG_BUFFER_GLOBAL
);
1870 ret
= LTTNG_ERR_FATAL
;
1873 if (lttng_strncpy(attr
->name
, channel_name
,
1874 sizeof(attr
->name
))) {
1875 ret
= LTTNG_ERR_INVALID
;
1879 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1880 if (ret
!= LTTNG_OK
) {
1883 channel_created
= 1;
1886 /* Get the newly created kernel channel pointer */
1887 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1888 session
->kernel_session
);
1889 if (kchan
== NULL
) {
1890 /* This sould not happen... */
1891 ret
= LTTNG_ERR_FATAL
;
1895 switch (event
->type
) {
1896 case LTTNG_EVENT_ALL
:
1898 char *filter_expression_a
= NULL
;
1899 struct lttng_filter_bytecode
*filter_a
= NULL
;
1902 * We need to duplicate filter_expression and filter,
1903 * because ownership is passed to first enable
1906 if (filter_expression
) {
1907 filter_expression_a
= strdup(filter_expression
);
1908 if (!filter_expression_a
) {
1909 ret
= LTTNG_ERR_FATAL
;
1914 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1916 free(filter_expression_a
);
1917 ret
= LTTNG_ERR_FATAL
;
1920 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1922 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1923 ret
= event_kernel_enable_event(kchan
, event
,
1924 filter_expression
, filter
);
1925 /* We have passed ownership */
1926 filter_expression
= NULL
;
1928 if (ret
!= LTTNG_OK
) {
1929 if (channel_created
) {
1930 /* Let's not leak a useless channel. */
1931 kernel_destroy_channel(kchan
);
1933 free(filter_expression_a
);
1937 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1938 ret
= event_kernel_enable_event(kchan
, event
,
1939 filter_expression_a
, filter_a
);
1940 /* We have passed ownership */
1941 filter_expression_a
= NULL
;
1943 if (ret
!= LTTNG_OK
) {
1948 case LTTNG_EVENT_PROBE
:
1949 case LTTNG_EVENT_FUNCTION
:
1950 case LTTNG_EVENT_FUNCTION_ENTRY
:
1951 case LTTNG_EVENT_TRACEPOINT
:
1952 ret
= event_kernel_enable_event(kchan
, event
,
1953 filter_expression
, filter
);
1954 /* We have passed ownership */
1955 filter_expression
= NULL
;
1957 if (ret
!= LTTNG_OK
) {
1958 if (channel_created
) {
1959 /* Let's not leak a useless channel. */
1960 kernel_destroy_channel(kchan
);
1965 case LTTNG_EVENT_SYSCALL
:
1966 ret
= event_kernel_enable_event(kchan
, event
,
1967 filter_expression
, filter
);
1968 /* We have passed ownership */
1969 filter_expression
= NULL
;
1971 if (ret
!= LTTNG_OK
) {
1976 ret
= LTTNG_ERR_UNK
;
1980 kernel_wait_quiescent(kernel_tracer_fd
);
1983 case LTTNG_DOMAIN_UST
:
1985 struct ltt_ust_channel
*uchan
;
1986 struct ltt_ust_session
*usess
= session
->ust_session
;
1991 * If a non-default channel has been created in the
1992 * session, explicitely require that -c chan_name needs
1995 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1996 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2000 /* Get channel from global UST domain */
2001 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2003 if (uchan
== NULL
) {
2004 /* Create default channel */
2005 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2006 usess
->buffer_type
);
2008 ret
= LTTNG_ERR_FATAL
;
2011 if (lttng_strncpy(attr
->name
, channel_name
,
2012 sizeof(attr
->name
))) {
2013 ret
= LTTNG_ERR_INVALID
;
2017 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2018 if (ret
!= LTTNG_OK
) {
2022 /* Get the newly created channel reference back */
2023 uchan
= trace_ust_find_channel_by_name(
2024 usess
->domain_global
.channels
, channel_name
);
2028 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2030 * Don't allow users to add UST events to channels which
2031 * are assigned to a userspace subdomain (JUL, Log4J,
2034 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2038 if (!internal_event
) {
2040 * Ensure the event name is not reserved for internal
2043 ret
= validate_ust_event_name(event
->name
);
2045 WARN("Userspace event name %s failed validation.",
2047 event
->name
: "NULL");
2048 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2053 /* At this point, the session and channel exist on the tracer */
2054 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2055 filter_expression
, filter
, exclusion
,
2057 /* We have passed ownership */
2058 filter_expression
= NULL
;
2061 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2062 goto already_enabled
;
2063 } else if (ret
!= LTTNG_OK
) {
2068 case LTTNG_DOMAIN_LOG4J
:
2069 case LTTNG_DOMAIN_JUL
:
2070 case LTTNG_DOMAIN_PYTHON
:
2072 const char *default_event_name
, *default_chan_name
;
2074 struct lttng_event uevent
;
2075 struct lttng_domain tmp_dom
;
2076 struct ltt_ust_session
*usess
= session
->ust_session
;
2080 agt
= trace_ust_find_agent(usess
, domain
->type
);
2082 agt
= agent_create(domain
->type
);
2084 ret
= LTTNG_ERR_NOMEM
;
2087 agent_add(agt
, usess
->agents
);
2090 /* Create the default tracepoint. */
2091 memset(&uevent
, 0, sizeof(uevent
));
2092 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2093 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2094 default_event_name
= event_get_default_agent_ust_name(
2096 if (!default_event_name
) {
2097 ret
= LTTNG_ERR_FATAL
;
2100 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2101 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2104 * The domain type is changed because we are about to enable the
2105 * default channel and event for the JUL domain that are hardcoded.
2106 * This happens in the UST domain.
2108 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2109 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2111 switch (domain
->type
) {
2112 case LTTNG_DOMAIN_LOG4J
:
2113 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2115 case LTTNG_DOMAIN_JUL
:
2116 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2118 case LTTNG_DOMAIN_PYTHON
:
2119 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2122 /* The switch/case we are in makes this impossible */
2127 char *filter_expression_copy
= NULL
;
2128 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2131 const size_t filter_size
= sizeof(
2132 struct lttng_filter_bytecode
)
2135 filter_copy
= zmalloc(filter_size
);
2137 ret
= LTTNG_ERR_NOMEM
;
2140 memcpy(filter_copy
, filter
, filter_size
);
2142 filter_expression_copy
=
2143 strdup(filter_expression
);
2144 if (!filter_expression
) {
2145 ret
= LTTNG_ERR_NOMEM
;
2148 if (!filter_expression_copy
|| !filter_copy
) {
2149 free(filter_expression_copy
);
2155 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2156 (char *) default_chan_name
,
2157 &uevent
, filter_expression_copy
,
2158 filter_copy
, NULL
, wpipe
);
2161 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2162 goto already_enabled
;
2163 } else if (ret
!= LTTNG_OK
) {
2167 /* The wild card * means that everything should be enabled. */
2168 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2169 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2172 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2176 filter_expression
= NULL
;
2177 if (ret
!= LTTNG_OK
) {
2184 ret
= LTTNG_ERR_UND
;
2192 free(filter_expression
);
2201 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2202 * We own filter, exclusion, and filter_expression.
2204 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2205 char *channel_name
, struct lttng_event
*event
,
2206 char *filter_expression
,
2207 struct lttng_filter_bytecode
*filter
,
2208 struct lttng_event_exclusion
*exclusion
,
2211 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2212 filter_expression
, filter
, exclusion
, wpipe
, false);
2216 * Enable an event which is internal to LTTng. An internal should
2217 * never be made visible to clients and are immune to checks such as
2220 static int cmd_enable_event_internal(struct ltt_session
*session
,
2221 struct lttng_domain
*domain
,
2222 char *channel_name
, struct lttng_event
*event
,
2223 char *filter_expression
,
2224 struct lttng_filter_bytecode
*filter
,
2225 struct lttng_event_exclusion
*exclusion
,
2228 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2229 filter_expression
, filter
, exclusion
, wpipe
, true);
2233 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2235 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2236 struct lttng_event
**events
)
2239 ssize_t nb_events
= 0;
2242 case LTTNG_DOMAIN_KERNEL
:
2243 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2244 if (nb_events
< 0) {
2245 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2249 case LTTNG_DOMAIN_UST
:
2250 nb_events
= ust_app_list_events(events
);
2251 if (nb_events
< 0) {
2252 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2256 case LTTNG_DOMAIN_LOG4J
:
2257 case LTTNG_DOMAIN_JUL
:
2258 case LTTNG_DOMAIN_PYTHON
:
2259 nb_events
= agent_list_events(events
, domain
);
2260 if (nb_events
< 0) {
2261 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2266 ret
= LTTNG_ERR_UND
;
2273 /* Return negative value to differentiate return code */
2278 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2280 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2281 struct lttng_event_field
**fields
)
2284 ssize_t nb_fields
= 0;
2287 case LTTNG_DOMAIN_UST
:
2288 nb_fields
= ust_app_list_event_fields(fields
);
2289 if (nb_fields
< 0) {
2290 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2294 case LTTNG_DOMAIN_KERNEL
:
2295 default: /* fall-through */
2296 ret
= LTTNG_ERR_UND
;
2303 /* Return negative value to differentiate return code */
2307 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2309 return syscall_table_list(events
);
2313 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2315 * Called with session lock held.
2317 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2318 enum lttng_domain_type domain
, int32_t **pids
)
2321 ssize_t nr_pids
= 0;
2324 case LTTNG_DOMAIN_KERNEL
:
2326 struct ltt_kernel_session
*ksess
;
2328 ksess
= session
->kernel_session
;
2329 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2331 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2336 case LTTNG_DOMAIN_UST
:
2338 struct ltt_ust_session
*usess
;
2340 usess
= session
->ust_session
;
2341 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2343 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2348 case LTTNG_DOMAIN_LOG4J
:
2349 case LTTNG_DOMAIN_JUL
:
2350 case LTTNG_DOMAIN_PYTHON
:
2352 ret
= LTTNG_ERR_UND
;
2359 /* Return negative value to differentiate return code */
2364 * Command LTTNG_START_TRACE processed by the client thread.
2366 * Called with session mutex held.
2368 int cmd_start_trace(struct ltt_session
*session
)
2371 unsigned long nb_chan
= 0;
2372 struct ltt_kernel_session
*ksession
;
2373 struct ltt_ust_session
*usess
;
2377 /* Ease our life a bit ;) */
2378 ksession
= session
->kernel_session
;
2379 usess
= session
->ust_session
;
2381 /* Is the session already started? */
2382 if (session
->active
) {
2383 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2388 * Starting a session without channel is useless since after that it's not
2389 * possible to enable channel thus inform the client.
2391 if (usess
&& usess
->domain_global
.channels
) {
2392 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2395 nb_chan
+= ksession
->channel_count
;
2398 ret
= LTTNG_ERR_NO_CHANNEL
;
2402 /* Kernel tracing */
2403 if (ksession
!= NULL
) {
2404 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2405 if (ret
!= LTTNG_OK
) {
2410 /* Flag session that trace should start automatically */
2413 * Even though the start trace might fail, flag this session active so
2414 * other application coming in are started by default.
2418 ret
= ust_app_start_trace_all(usess
);
2420 ret
= LTTNG_ERR_UST_START_FAIL
;
2425 /* Flag this after a successful start. */
2426 session
->has_been_started
= 1;
2427 session
->active
= 1;
2436 * Command LTTNG_STOP_TRACE processed by the client thread.
2438 int cmd_stop_trace(struct ltt_session
*session
)
2441 struct ltt_kernel_channel
*kchan
;
2442 struct ltt_kernel_session
*ksession
;
2443 struct ltt_ust_session
*usess
;
2448 ksession
= session
->kernel_session
;
2449 usess
= session
->ust_session
;
2451 /* Session is not active. Skip everythong and inform the client. */
2452 if (!session
->active
) {
2453 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2458 if (ksession
&& ksession
->active
) {
2459 DBG("Stop kernel tracing");
2461 ret
= kernel_stop_session(ksession
);
2463 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2467 kernel_wait_quiescent(kernel_tracer_fd
);
2469 /* Flush metadata after stopping (if exists) */
2470 if (ksession
->metadata_stream_fd
>= 0) {
2471 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2473 ERR("Kernel metadata flush failed");
2477 /* Flush all buffers after stopping */
2478 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2479 ret
= kernel_flush_buffer(kchan
);
2481 ERR("Kernel flush buffer error");
2485 ksession
->active
= 0;
2488 if (usess
&& usess
->active
) {
2490 * Even though the stop trace might fail, flag this session inactive so
2491 * other application coming in are not started by default.
2495 ret
= ust_app_stop_trace_all(usess
);
2497 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2502 /* Flag inactive after a successful stop. */
2503 session
->active
= 0;
2511 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2513 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2514 struct lttng_uri
*uris
)
2517 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2518 struct ltt_ust_session
*usess
= session
->ust_session
;
2524 /* Can't set consumer URI if the session is active. */
2525 if (session
->active
) {
2526 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2530 /* Set the "global" consumer URIs */
2531 for (i
= 0; i
< nb_uri
; i
++) {
2532 ret
= add_uri_to_consumer(session
->consumer
,
2533 &uris
[i
], 0, session
->name
);
2534 if (ret
!= LTTNG_OK
) {
2539 /* Set UST session URIs */
2540 if (session
->ust_session
) {
2541 for (i
= 0; i
< nb_uri
; i
++) {
2542 ret
= add_uri_to_consumer(
2543 session
->ust_session
->consumer
,
2544 &uris
[i
], LTTNG_DOMAIN_UST
,
2546 if (ret
!= LTTNG_OK
) {
2552 /* Set kernel session URIs */
2553 if (session
->kernel_session
) {
2554 for (i
= 0; i
< nb_uri
; i
++) {
2555 ret
= add_uri_to_consumer(
2556 session
->kernel_session
->consumer
,
2557 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2559 if (ret
!= LTTNG_OK
) {
2566 * Make sure to set the session in output mode after we set URI since a
2567 * session can be created without URL (thus flagged in no output mode).
2569 session
->output_traces
= 1;
2571 ksess
->output_traces
= 1;
2575 usess
->output_traces
= 1;
2586 * Command LTTNG_CREATE_SESSION processed by the client thread.
2588 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2589 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2592 struct ltt_session
*session
;
2598 * Verify if the session already exist
2600 * XXX: There is no need for the session lock list here since the caller
2601 * (process_client_msg) is holding it. We might want to change that so a
2602 * single command does not lock the entire session list.
2604 session
= session_find_by_name(name
);
2605 if (session
!= NULL
) {
2606 ret
= LTTNG_ERR_EXIST_SESS
;
2610 /* Create tracing session in the registry */
2611 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2612 LTTNG_SOCK_GET_GID_CRED(creds
));
2613 if (ret
!= LTTNG_OK
) {
2618 * Get the newly created session pointer back
2620 * XXX: There is no need for the session lock list here since the caller
2621 * (process_client_msg) is holding it. We might want to change that so a
2622 * single command does not lock the entire session list.
2624 session
= session_find_by_name(name
);
2627 session
->live_timer
= live_timer
;
2628 /* Create default consumer output for the session not yet created. */
2629 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2630 if (session
->consumer
== NULL
) {
2631 ret
= LTTNG_ERR_FATAL
;
2632 goto consumer_error
;
2636 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2637 if (ret
!= LTTNG_OK
) {
2638 goto consumer_error
;
2640 session
->output_traces
= 1;
2642 session
->output_traces
= 0;
2643 DBG2("Session %s created with no output", session
->name
);
2646 session
->consumer
->enabled
= 1;
2651 session_destroy(session
);
2658 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2660 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2661 size_t nb_uri
, lttng_sock_cred
*creds
)
2664 struct ltt_session
*session
;
2665 struct snapshot_output
*new_output
= NULL
;
2671 * Create session in no output mode with URIs set to NULL. The uris we've
2672 * received are for a default snapshot output if one.
2674 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2675 if (ret
!= LTTNG_OK
) {
2679 /* Get the newly created session pointer back. This should NEVER fail. */
2680 session
= session_find_by_name(name
);
2683 /* Flag session for snapshot mode. */
2684 session
->snapshot_mode
= 1;
2686 /* Skip snapshot output creation if no URI is given. */
2691 new_output
= snapshot_output_alloc();
2693 ret
= LTTNG_ERR_NOMEM
;
2694 goto error_snapshot_alloc
;
2697 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2698 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2700 if (ret
== -ENOMEM
) {
2701 ret
= LTTNG_ERR_NOMEM
;
2703 ret
= LTTNG_ERR_INVALID
;
2705 goto error_snapshot
;
2709 snapshot_add_output(&session
->snapshot
, new_output
);
2716 snapshot_output_destroy(new_output
);
2717 error_snapshot_alloc
:
2718 session_destroy(session
);
2724 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2726 * Called with session lock held.
2728 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2731 struct ltt_ust_session
*usess
;
2732 struct ltt_kernel_session
*ksess
;
2737 usess
= session
->ust_session
;
2738 ksess
= session
->kernel_session
;
2740 /* Clean kernel session teardown */
2741 kernel_destroy_session(ksess
);
2743 /* UST session teardown */
2745 /* Close any relayd session */
2746 consumer_output_send_destroy_relayd(usess
->consumer
);
2748 /* Destroy every UST application related to this session. */
2749 ret
= ust_app_destroy_trace_all(usess
);
2751 ERR("Error in ust_app_destroy_trace_all");
2754 /* Clean up the rest. */
2755 trace_ust_destroy_session(usess
);
2759 * Must notify the kernel thread here to update it's poll set in order to
2760 * remove the channel(s)' fd just destroyed.
2762 ret
= notify_thread_pipe(wpipe
);
2764 PERROR("write kernel poll pipe");
2767 ret
= session_destroy(session
);
2773 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2775 int cmd_register_consumer(struct ltt_session
*session
,
2776 enum lttng_domain_type domain
, const char *sock_path
,
2777 struct consumer_data
*cdata
)
2780 struct consumer_socket
*socket
= NULL
;
2787 case LTTNG_DOMAIN_KERNEL
:
2789 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2793 /* Can't register a consumer if there is already one */
2794 if (ksess
->consumer_fds_sent
!= 0) {
2795 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2799 sock
= lttcomm_connect_unix_sock(sock_path
);
2801 ret
= LTTNG_ERR_CONNECT_FAIL
;
2804 cdata
->cmd_sock
= sock
;
2806 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2807 if (socket
== NULL
) {
2810 PERROR("close register consumer");
2812 cdata
->cmd_sock
= -1;
2813 ret
= LTTNG_ERR_FATAL
;
2817 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2818 if (socket
->lock
== NULL
) {
2819 PERROR("zmalloc pthread mutex");
2820 ret
= LTTNG_ERR_FATAL
;
2823 pthread_mutex_init(socket
->lock
, NULL
);
2824 socket
->registered
= 1;
2827 consumer_add_socket(socket
, ksess
->consumer
);
2830 pthread_mutex_lock(&cdata
->pid_mutex
);
2832 pthread_mutex_unlock(&cdata
->pid_mutex
);
2837 /* TODO: Userspace tracing */
2838 ret
= LTTNG_ERR_UND
;
2846 consumer_destroy_socket(socket
);
2852 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2854 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2855 struct lttng_domain
**domains
)
2860 struct lttng_ht_iter iter
;
2862 if (session
->kernel_session
!= NULL
) {
2863 DBG3("Listing domains found kernel domain");
2867 if (session
->ust_session
!= NULL
) {
2868 DBG3("Listing domains found UST global domain");
2872 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2874 if (agt
->being_used
) {
2885 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2886 if (*domains
== NULL
) {
2887 ret
= LTTNG_ERR_FATAL
;
2891 if (session
->kernel_session
!= NULL
) {
2892 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2894 /* Kernel session buffer type is always GLOBAL */
2895 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2900 if (session
->ust_session
!= NULL
) {
2901 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2902 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2906 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2908 if (agt
->being_used
) {
2909 (*domains
)[index
].type
= agt
->domain
;
2910 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2920 /* Return negative value to differentiate return code */
2926 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2928 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2929 struct ltt_session
*session
, struct lttng_channel
**channels
)
2931 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
2934 case LTTNG_DOMAIN_KERNEL
:
2935 if (session
->kernel_session
!= NULL
) {
2936 nb_chan
= session
->kernel_session
->channel_count
;
2938 DBG3("Number of kernel channels %zd", nb_chan
);
2940 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2944 case LTTNG_DOMAIN_UST
:
2945 if (session
->ust_session
!= NULL
) {
2947 nb_chan
= lttng_ht_get_count(
2948 session
->ust_session
->domain_global
.channels
);
2951 DBG3("Number of UST global channels %zd", nb_chan
);
2953 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2958 ret
= -LTTNG_ERR_UND
;
2963 const size_t channel_size
= sizeof(struct lttng_channel
) +
2964 sizeof(struct lttcomm_channel_extended
);
2965 struct lttcomm_channel_extended
*channel_exts
;
2967 payload_size
= nb_chan
* channel_size
;
2968 *channels
= zmalloc(payload_size
);
2969 if (*channels
== NULL
) {
2970 ret
= -LTTNG_ERR_FATAL
;
2974 channel_exts
= ((void *) *channels
) +
2975 (nb_chan
* sizeof(struct lttng_channel
));
2976 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
2977 if (ret
!= LTTNG_OK
) {
2992 * Command LTTNG_LIST_EVENTS processed by the client thread.
2994 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2995 struct ltt_session
*session
, char *channel_name
,
2996 struct lttng_event
**events
, size_t *total_size
)
2999 ssize_t nb_event
= 0;
3002 case LTTNG_DOMAIN_KERNEL
:
3003 if (session
->kernel_session
!= NULL
) {
3004 nb_event
= list_lttng_kernel_events(channel_name
,
3005 session
->kernel_session
, events
,
3009 case LTTNG_DOMAIN_UST
:
3011 if (session
->ust_session
!= NULL
) {
3012 nb_event
= list_lttng_ust_global_events(channel_name
,
3013 &session
->ust_session
->domain_global
, events
,
3018 case LTTNG_DOMAIN_LOG4J
:
3019 case LTTNG_DOMAIN_JUL
:
3020 case LTTNG_DOMAIN_PYTHON
:
3021 if (session
->ust_session
) {
3022 struct lttng_ht_iter iter
;
3026 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3027 &iter
.iter
, agt
, node
.node
) {
3028 if (agt
->domain
== domain
) {
3029 nb_event
= list_lttng_agent_events(
3039 ret
= LTTNG_ERR_UND
;
3046 /* Return negative value to differentiate return code */
3051 * Using the session list, filled a lttng_session array to send back to the
3052 * client for session listing.
3054 * The session list lock MUST be acquired before calling this function. Use
3055 * session_lock_list() and session_unlock_list().
3057 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3062 struct ltt_session
*session
;
3063 struct ltt_session_list
*list
= session_get_list();
3065 DBG("Getting all available session for UID %d GID %d",
3068 * Iterate over session list and append data after the control struct in
3071 cds_list_for_each_entry(session
, &list
->head
, list
) {
3073 * Only list the sessions the user can control.
3075 if (!session_access_ok(session
, uid
, gid
)) {
3079 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3080 struct ltt_ust_session
*usess
= session
->ust_session
;
3082 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3083 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3084 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3085 ret
= build_network_session_path(sessions
[i
].path
,
3086 sizeof(sessions
[i
].path
), session
);
3088 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3089 session
->consumer
->dst
.trace_path
);
3092 PERROR("snprintf session path");
3096 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3097 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3098 sessions
[i
].enabled
= session
->active
;
3099 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3100 sessions
[i
].live_timer_interval
= session
->live_timer
;
3106 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3107 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3109 int cmd_data_pending(struct ltt_session
*session
)
3112 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3113 struct ltt_ust_session
*usess
= session
->ust_session
;
3117 /* Session MUST be stopped to ask for data availability. */
3118 if (session
->active
) {
3119 ret
= LTTNG_ERR_SESSION_STARTED
;
3123 * If stopped, just make sure we've started before else the above call
3124 * will always send that there is data pending.
3126 * The consumer assumes that when the data pending command is received,
3127 * the trace has been started before or else no output data is written
3128 * by the streams which is a condition for data pending. So, this is
3129 * *VERY* important that we don't ask the consumer before a start
3132 if (!session
->has_been_started
) {
3138 if (ksess
&& ksess
->consumer
) {
3139 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3141 /* Data is still being extracted for the kernel. */
3146 if (usess
&& usess
->consumer
) {
3147 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3149 /* Data is still being extracted for the kernel. */
3154 /* Data is ready to be read by a viewer */
3162 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3164 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3166 int cmd_snapshot_add_output(struct ltt_session
*session
,
3167 struct lttng_snapshot_output
*output
, uint32_t *id
)
3170 struct snapshot_output
*new_output
;
3175 DBG("Cmd snapshot add output for session %s", session
->name
);
3178 * Can't create an output if the session is not set in no-output mode.
3180 if (session
->output_traces
) {
3181 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3185 /* Only one output is allowed until we have the "tee" feature. */
3186 if (session
->snapshot
.nb_output
== 1) {
3187 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3191 new_output
= snapshot_output_alloc();
3193 ret
= LTTNG_ERR_NOMEM
;
3197 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3198 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3199 &session
->snapshot
);
3201 if (ret
== -ENOMEM
) {
3202 ret
= LTTNG_ERR_NOMEM
;
3204 ret
= LTTNG_ERR_INVALID
;
3210 snapshot_add_output(&session
->snapshot
, new_output
);
3212 *id
= new_output
->id
;
3219 snapshot_output_destroy(new_output
);
3225 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3227 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3229 int cmd_snapshot_del_output(struct ltt_session
*session
,
3230 struct lttng_snapshot_output
*output
)
3233 struct snapshot_output
*sout
= NULL
;
3241 * Permission denied to create an output if the session is not
3242 * set in no output mode.
3244 if (session
->output_traces
) {
3245 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3250 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3252 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3253 } else if (*output
->name
!= '\0') {
3254 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3256 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3259 ret
= LTTNG_ERR_INVALID
;
3263 snapshot_delete_output(&session
->snapshot
, sout
);
3264 snapshot_output_destroy(sout
);
3273 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3275 * If no output is available, outputs is untouched and 0 is returned.
3277 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3279 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3280 struct lttng_snapshot_output
**outputs
)
3283 struct lttng_snapshot_output
*list
= NULL
;
3284 struct lttng_ht_iter iter
;
3285 struct snapshot_output
*output
;
3290 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3293 * Permission denied to create an output if the session is not
3294 * set in no output mode.
3296 if (session
->output_traces
) {
3297 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3301 if (session
->snapshot
.nb_output
== 0) {
3306 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3308 ret
= -LTTNG_ERR_NOMEM
;
3312 /* Copy list from session to the new list object. */
3314 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3315 output
, node
.node
) {
3316 assert(output
->consumer
);
3317 list
[idx
].id
= output
->id
;
3318 list
[idx
].max_size
= output
->max_size
;
3319 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3320 sizeof(list
[idx
].name
))) {
3321 ret
= -LTTNG_ERR_INVALID
;
3324 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3325 if (lttng_strncpy(list
[idx
].ctrl_url
,
3326 output
->consumer
->dst
.trace_path
,
3327 sizeof(list
[idx
].ctrl_url
))) {
3328 ret
= -LTTNG_ERR_INVALID
;
3333 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3334 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3336 ret
= -LTTNG_ERR_NOMEM
;
3341 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3342 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3344 ret
= -LTTNG_ERR_NOMEM
;
3353 ret
= session
->snapshot
.nb_output
;
3362 * Check if we can regenerate the metadata for this session.
3363 * Only kernel, UST per-uid and non-live sessions are supported.
3365 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3368 int check_regenerate_metadata_support(struct ltt_session
*session
)
3374 if (session
->live_timer
!= 0) {
3375 ret
= LTTNG_ERR_LIVE_SESSION
;
3378 if (!session
->active
) {
3379 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3382 if (session
->ust_session
) {
3383 switch (session
->ust_session
->buffer_type
) {
3384 case LTTNG_BUFFER_PER_UID
:
3386 case LTTNG_BUFFER_PER_PID
:
3387 ret
= LTTNG_ERR_PER_PID_SESSION
;
3391 ret
= LTTNG_ERR_UNK
;
3395 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3396 session
->consumer
->relay_minor_version
< 8) {
3397 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3407 int clear_metadata_file(int fd
)
3411 ret
= lseek(fd
, 0, SEEK_SET
);
3417 ret
= ftruncate(fd
, 0);
3419 PERROR("ftruncate");
3428 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3431 struct buffer_reg_uid
*uid_reg
= NULL
;
3432 struct buffer_reg_session
*session_reg
= NULL
;
3435 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3436 struct ust_registry_session
*registry
;
3437 struct ust_registry_channel
*chan
;
3438 struct lttng_ht_iter iter_chan
;
3440 session_reg
= uid_reg
->registry
;
3441 registry
= session_reg
->reg
.ust
;
3443 pthread_mutex_lock(®istry
->lock
);
3444 registry
->metadata_len_sent
= 0;
3445 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3446 registry
->metadata_len
= 0;
3447 registry
->metadata_version
++;
3448 if (registry
->metadata_fd
> 0) {
3449 /* Clear the metadata file's content. */
3450 ret
= clear_metadata_file(registry
->metadata_fd
);
3452 pthread_mutex_unlock(®istry
->lock
);
3457 ret
= ust_metadata_session_statedump(registry
, NULL
,
3458 registry
->major
, registry
->minor
);
3460 pthread_mutex_unlock(®istry
->lock
);
3461 ERR("Failed to generate session metadata (err = %d)",
3465 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3467 struct ust_registry_event
*event
;
3468 struct lttng_ht_iter iter_event
;
3470 ret
= ust_metadata_channel_statedump(registry
, chan
);
3472 pthread_mutex_unlock(®istry
->lock
);
3473 ERR("Failed to generate channel metadata "
3477 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3479 ret
= ust_metadata_event_statedump(registry
,
3482 pthread_mutex_unlock(®istry
->lock
);
3483 ERR("Failed to generate event metadata "
3489 pthread_mutex_unlock(®istry
->lock
);
3498 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3500 * Ask the consumer to truncate the existing metadata file(s) and
3501 * then regenerate the metadata. Live and per-pid sessions are not
3502 * supported and return an error.
3504 * Return 0 on success or else a LTTNG_ERR code.
3506 int cmd_regenerate_metadata(struct ltt_session
*session
)
3512 ret
= check_regenerate_metadata_support(session
);
3517 if (session
->kernel_session
) {
3518 ret
= kernctl_session_regenerate_metadata(
3519 session
->kernel_session
->fd
);
3521 ERR("Failed to regenerate the kernel metadata");
3526 if (session
->ust_session
) {
3527 ret
= ust_regenerate_metadata(session
->ust_session
);
3529 ERR("Failed to regenerate the UST metadata");
3533 DBG("Cmd metadata regenerate for session %s", session
->name
);
3541 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
3543 * Ask the tracer to regenerate a new statedump.
3545 * Return 0 on success or else a LTTNG_ERR code.
3547 int cmd_regenerate_statedump(struct ltt_session
*session
)
3553 if (!session
->active
) {
3554 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3559 if (session
->kernel_session
) {
3560 ret
= kernctl_session_regenerate_statedump(
3561 session
->kernel_session
->fd
);
3563 * Currently, the statedump in kernel can only fail if out
3567 if (ret
== -ENOMEM
) {
3568 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
3570 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3572 ERR("Failed to regenerate the kernel statedump");
3577 if (session
->ust_session
) {
3578 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
3580 * Currently, the statedump in UST always returns 0.
3583 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3584 ERR("Failed to regenerate the UST statedump");
3588 DBG("Cmd regenerate statedump for session %s", session
->name
);
3596 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3597 * snapshot output is *not* set with a remote destination.
3599 * Return 0 on success or a LTTNG_ERR code.
3601 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3602 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3605 struct lttng_ht_iter iter
;
3606 struct consumer_socket
*socket
;
3609 assert(snap_output
);
3612 DBG2("Set relayd object from snapshot output");
3614 /* Ignore if snapshot consumer output is not network. */
3615 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3620 * For each consumer socket, create and send the relayd object of the
3624 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3625 socket
, node
.node
) {
3626 pthread_mutex_lock(socket
->lock
);
3627 ret
= send_consumer_relayd_sockets(0, session
->id
,
3628 snap_output
->consumer
, socket
,
3629 session
->name
, session
->hostname
,
3630 session
->live_timer
);
3631 pthread_mutex_unlock(socket
->lock
);
3632 if (ret
!= LTTNG_OK
) {
3644 * Record a kernel snapshot.
3646 * Return LTTNG_OK on success or a LTTNG_ERR code.
3648 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3649 struct snapshot_output
*output
, struct ltt_session
*session
,
3650 int wait
, uint64_t nb_packets_per_stream
)
3660 * Copy kernel session sockets so we can communicate with the right
3661 * consumer for the snapshot record command.
3663 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3665 ret
= LTTNG_ERR_NOMEM
;
3669 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3670 if (ret
!= LTTNG_OK
) {
3671 goto error_snapshot
;
3674 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3675 if (ret
!= LTTNG_OK
) {
3676 goto error_snapshot
;
3683 /* Clean up copied sockets so this output can use some other later on. */
3684 consumer_destroy_output_sockets(output
->consumer
);
3691 * Record a UST snapshot.
3693 * Return 0 on success or a LTTNG_ERR error code.
3695 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3696 struct snapshot_output
*output
, struct ltt_session
*session
,
3697 int wait
, uint64_t nb_packets_per_stream
)
3706 * Copy UST session sockets so we can communicate with the right
3707 * consumer for the snapshot record command.
3709 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3711 ret
= LTTNG_ERR_NOMEM
;
3715 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3716 if (ret
!= LTTNG_OK
) {
3717 goto error_snapshot
;
3720 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3724 ret
= LTTNG_ERR_INVALID
;
3727 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3730 goto error_snapshot
;
3736 /* Clean up copied sockets so this output can use some other later on. */
3737 consumer_destroy_output_sockets(output
->consumer
);
3743 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3744 uint64_t cur_nr_packets
)
3746 uint64_t tot_size
= 0;
3748 if (session
->kernel_session
) {
3749 struct ltt_kernel_channel
*chan
;
3750 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3752 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3753 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3755 * Don't take channel into account if we
3756 * already grab all its packets.
3760 tot_size
+= chan
->channel
->attr
.subbuf_size
3761 * chan
->stream_count
;
3765 if (session
->ust_session
) {
3766 struct ltt_ust_session
*usess
= session
->ust_session
;
3768 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3776 * Calculate the number of packets we can grab from each stream that
3777 * fits within the overall snapshot max size.
3779 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3780 * the number of packets per stream.
3782 * TODO: this approach is not perfect: we consider the worse case
3783 * (packet filling the sub-buffers) as an upper bound, but we could do
3784 * better if we do this calculation while we actually grab the packet
3785 * content: we would know how much padding we don't actually store into
3788 * This algorithm is currently bounded by the number of packets per
3791 * Since we call this algorithm before actually grabbing the data, it's
3792 * an approximation: for instance, applications could appear/disappear
3793 * in between this call and actually grabbing data.
3796 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3799 uint64_t cur_nb_packets
= 0;
3802 return 0; /* Infinite */
3805 size_left
= max_size
;
3807 uint64_t one_more_packet_tot_size
;
3809 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3811 if (!one_more_packet_tot_size
) {
3812 /* We are already grabbing all packets. */
3815 size_left
-= one_more_packet_tot_size
;
3816 if (size_left
< 0) {
3821 if (!cur_nb_packets
) {
3822 /* Not enough room to grab one packet of each stream, error. */
3825 return cur_nb_packets
;
3829 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3831 * The wait parameter is ignored so this call always wait for the snapshot to
3832 * complete before returning.
3834 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3836 int cmd_snapshot_record(struct ltt_session
*session
,
3837 struct lttng_snapshot_output
*output
, int wait
)
3840 unsigned int use_tmp_output
= 0;
3841 struct snapshot_output tmp_output
;
3842 unsigned int snapshot_success
= 0;
3848 DBG("Cmd snapshot record for session %s", session
->name
);
3850 /* Get the datetime for the snapshot output directory. */
3851 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3854 ret
= LTTNG_ERR_INVALID
;
3859 * Permission denied to create an output if the session is not
3860 * set in no output mode.
3862 if (session
->output_traces
) {
3863 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3867 /* The session needs to be started at least once. */
3868 if (!session
->has_been_started
) {
3869 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3873 /* Use temporary output for the session. */
3874 if (*output
->ctrl_url
!= '\0') {
3875 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3876 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3879 if (ret
== -ENOMEM
) {
3880 ret
= LTTNG_ERR_NOMEM
;
3882 ret
= LTTNG_ERR_INVALID
;
3886 /* Use the global session count for the temporary snapshot. */
3887 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3889 /* Use the global datetime */
3890 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3894 if (use_tmp_output
) {
3895 int64_t nb_packets_per_stream
;
3897 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3898 tmp_output
.max_size
);
3899 if (nb_packets_per_stream
< 0) {
3900 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3904 if (session
->kernel_session
) {
3905 ret
= record_kernel_snapshot(session
->kernel_session
,
3906 &tmp_output
, session
,
3907 wait
, nb_packets_per_stream
);
3908 if (ret
!= LTTNG_OK
) {
3913 if (session
->ust_session
) {
3914 ret
= record_ust_snapshot(session
->ust_session
,
3915 &tmp_output
, session
,
3916 wait
, nb_packets_per_stream
);
3917 if (ret
!= LTTNG_OK
) {
3922 snapshot_success
= 1;
3924 struct snapshot_output
*sout
;
3925 struct lttng_ht_iter iter
;
3928 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3929 &iter
.iter
, sout
, node
.node
) {
3930 int64_t nb_packets_per_stream
;
3933 * Make a local copy of the output and assign the possible
3934 * temporary value given by the caller.
3936 memset(&tmp_output
, 0, sizeof(tmp_output
));
3937 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3939 if (output
->max_size
!= (uint64_t) -1ULL) {
3940 tmp_output
.max_size
= output
->max_size
;
3943 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3944 tmp_output
.max_size
);
3945 if (nb_packets_per_stream
< 0) {
3946 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3951 /* Use temporary name. */
3952 if (*output
->name
!= '\0') {
3953 if (lttng_strncpy(tmp_output
.name
, output
->name
,
3954 sizeof(tmp_output
.name
))) {
3955 ret
= LTTNG_ERR_INVALID
;
3961 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3962 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3964 if (session
->kernel_session
) {
3965 ret
= record_kernel_snapshot(session
->kernel_session
,
3966 &tmp_output
, session
,
3967 wait
, nb_packets_per_stream
);
3968 if (ret
!= LTTNG_OK
) {
3974 if (session
->ust_session
) {
3975 ret
= record_ust_snapshot(session
->ust_session
,
3976 &tmp_output
, session
,
3977 wait
, nb_packets_per_stream
);
3978 if (ret
!= LTTNG_OK
) {
3983 snapshot_success
= 1;
3988 if (snapshot_success
) {
3989 session
->snapshot
.nb_snapshot
++;
3991 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3999 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4001 int cmd_set_session_shm_path(struct ltt_session
*session
,
4002 const char *shm_path
)
4008 * Can only set shm path before session is started.
4010 if (session
->has_been_started
) {
4011 return LTTNG_ERR_SESSION_STARTED
;
4014 strncpy(session
->shm_path
, shm_path
,
4015 sizeof(session
->shm_path
));
4016 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4022 * Init command subsystem.
4027 * Set network sequence index to 1 for streams to match a relayd
4028 * socket on the consumer side.
4030 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
4031 relayd_net_seq_idx
= 1;
4032 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
4034 DBG("Command subsystem initialized");