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 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
891 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
892 struct consumer_output
*consumer
,
893 struct consumer_socket
*consumer_sock
,
894 char *session_name
, char *hostname
, int session_live_timer
)
897 struct lttcomm_relayd_sock
*rsock
= NULL
;
899 /* Connect to relayd and make version check if uri is the control. */
900 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
901 if (ret
!= LTTNG_OK
) {
906 /* Set the network sequence index if not set. */
907 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
908 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
910 * Increment net_seq_idx because we are about to transfer the
911 * new relayd socket to the consumer.
912 * Assign unique key so the consumer can match streams.
914 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
915 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
918 /* Send relayd socket to consumer. */
919 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
920 relayd_uri
->stype
, session_id
,
921 session_name
, hostname
, session_live_timer
);
923 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
927 /* Flag that the corresponding socket was sent. */
928 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
929 consumer_sock
->control_sock_sent
= 1;
930 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
931 consumer_sock
->data_sock_sent
= 1;
937 * Close socket which was dup on the consumer side. The session daemon does
938 * NOT keep track of the relayd socket(s) once transfer to the consumer.
942 (void) relayd_close(rsock
);
946 if (ret
!= LTTNG_OK
) {
948 * The consumer output for this session should not be used anymore
949 * since the relayd connection failed thus making any tracing or/and
950 * streaming not usable.
952 consumer
->enabled
= 0;
958 * Send both relayd sockets to a specific consumer and domain. This is a
959 * helper function to facilitate sending the information to the consumer for a
962 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
963 unsigned int session_id
, struct consumer_output
*consumer
,
964 struct consumer_socket
*sock
, char *session_name
,
965 char *hostname
, int session_live_timer
)
972 /* Sending control relayd socket. */
973 if (!sock
->control_sock_sent
) {
974 ret
= send_consumer_relayd_socket(domain
, session_id
,
975 &consumer
->dst
.net
.control
, consumer
, sock
,
976 session_name
, hostname
, session_live_timer
);
977 if (ret
!= LTTNG_OK
) {
982 /* Sending data relayd socket. */
983 if (!sock
->data_sock_sent
) {
984 ret
= send_consumer_relayd_socket(domain
, session_id
,
985 &consumer
->dst
.net
.data
, consumer
, sock
,
986 session_name
, hostname
, session_live_timer
);
987 if (ret
!= LTTNG_OK
) {
997 * Setup relayd connections for a tracing session. First creates the socket to
998 * the relayd and send them to the right domain consumer. Consumer type MUST be
1001 int cmd_setup_relayd(struct ltt_session
*session
)
1004 struct ltt_ust_session
*usess
;
1005 struct ltt_kernel_session
*ksess
;
1006 struct consumer_socket
*socket
;
1007 struct lttng_ht_iter iter
;
1011 usess
= session
->ust_session
;
1012 ksess
= session
->kernel_session
;
1014 DBG("Setting relayd for session %s", session
->name
);
1018 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1019 && usess
->consumer
->enabled
) {
1020 /* For each consumer socket, send relayd sockets */
1021 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1022 socket
, node
.node
) {
1023 pthread_mutex_lock(socket
->lock
);
1024 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1025 usess
->consumer
, socket
,
1026 session
->name
, session
->hostname
,
1027 session
->live_timer
);
1028 pthread_mutex_unlock(socket
->lock
);
1029 if (ret
!= LTTNG_OK
) {
1032 /* Session is now ready for network streaming. */
1033 session
->net_handle
= 1;
1035 session
->consumer
->relay_major_version
=
1036 usess
->consumer
->relay_major_version
;
1037 session
->consumer
->relay_minor_version
=
1038 usess
->consumer
->relay_minor_version
;
1041 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1042 && ksess
->consumer
->enabled
) {
1043 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1044 socket
, node
.node
) {
1045 pthread_mutex_lock(socket
->lock
);
1046 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1047 ksess
->consumer
, socket
,
1048 session
->name
, session
->hostname
,
1049 session
->live_timer
);
1050 pthread_mutex_unlock(socket
->lock
);
1051 if (ret
!= LTTNG_OK
) {
1054 /* Session is now ready for network streaming. */
1055 session
->net_handle
= 1;
1057 session
->consumer
->relay_major_version
=
1058 ksess
->consumer
->relay_major_version
;
1059 session
->consumer
->relay_minor_version
=
1060 ksess
->consumer
->relay_minor_version
;
1069 * Start a kernel session by opening all necessary streams.
1071 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1074 struct ltt_kernel_channel
*kchan
;
1076 /* Open kernel metadata */
1077 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1078 ret
= kernel_open_metadata(ksess
);
1080 ret
= LTTNG_ERR_KERN_META_FAIL
;
1085 /* Open kernel metadata stream */
1086 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1087 ret
= kernel_open_metadata_stream(ksess
);
1089 ERR("Kernel create metadata stream failed");
1090 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1095 /* For each channel */
1096 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1097 if (kchan
->stream_count
== 0) {
1098 ret
= kernel_open_channel_stream(kchan
);
1100 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1103 /* Update the stream global counter */
1104 ksess
->stream_count_global
+= ret
;
1108 /* Setup kernel consumer socket and send fds to it */
1109 ret
= init_kernel_tracing(ksess
);
1111 ret
= LTTNG_ERR_KERN_START_FAIL
;
1115 /* This start the kernel tracing */
1116 ret
= kernel_start_session(ksess
);
1118 ret
= LTTNG_ERR_KERN_START_FAIL
;
1122 /* Quiescent wait after starting trace */
1123 kernel_wait_quiescent(kernel_tracer_fd
);
1134 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1136 int cmd_disable_channel(struct ltt_session
*session
,
1137 enum lttng_domain_type domain
, char *channel_name
)
1140 struct ltt_ust_session
*usess
;
1142 usess
= session
->ust_session
;
1147 case LTTNG_DOMAIN_KERNEL
:
1149 ret
= channel_kernel_disable(session
->kernel_session
,
1151 if (ret
!= LTTNG_OK
) {
1155 kernel_wait_quiescent(kernel_tracer_fd
);
1158 case LTTNG_DOMAIN_UST
:
1160 struct ltt_ust_channel
*uchan
;
1161 struct lttng_ht
*chan_ht
;
1163 chan_ht
= usess
->domain_global
.channels
;
1165 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1166 if (uchan
== NULL
) {
1167 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1171 ret
= channel_ust_disable(usess
, uchan
);
1172 if (ret
!= LTTNG_OK
) {
1178 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1190 * Command LTTNG_TRACK_PID processed by the client thread.
1192 * Called with session lock held.
1194 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1202 case LTTNG_DOMAIN_KERNEL
:
1204 struct ltt_kernel_session
*ksess
;
1206 ksess
= session
->kernel_session
;
1208 ret
= kernel_track_pid(ksess
, pid
);
1209 if (ret
!= LTTNG_OK
) {
1213 kernel_wait_quiescent(kernel_tracer_fd
);
1216 case LTTNG_DOMAIN_UST
:
1218 struct ltt_ust_session
*usess
;
1220 usess
= session
->ust_session
;
1222 ret
= trace_ust_track_pid(usess
, pid
);
1223 if (ret
!= LTTNG_OK
) {
1229 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1241 * Command LTTNG_UNTRACK_PID processed by the client thread.
1243 * Called with session lock held.
1245 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1253 case LTTNG_DOMAIN_KERNEL
:
1255 struct ltt_kernel_session
*ksess
;
1257 ksess
= session
->kernel_session
;
1259 ret
= kernel_untrack_pid(ksess
, pid
);
1260 if (ret
!= LTTNG_OK
) {
1264 kernel_wait_quiescent(kernel_tracer_fd
);
1267 case LTTNG_DOMAIN_UST
:
1269 struct ltt_ust_session
*usess
;
1271 usess
= session
->ust_session
;
1273 ret
= trace_ust_untrack_pid(usess
, pid
);
1274 if (ret
!= LTTNG_OK
) {
1280 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1292 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1294 * The wpipe arguments is used as a notifier for the kernel thread.
1296 int cmd_enable_channel(struct ltt_session
*session
,
1297 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1300 struct ltt_ust_session
*usess
= session
->ust_session
;
1301 struct lttng_ht
*chan_ht
;
1308 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1310 /* Validate channel name */
1311 if (attr
->name
[0] == '.' ||
1312 memchr(attr
->name
, '/', len
) != NULL
) {
1313 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1317 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1322 * Don't try to enable a channel if the session has been started at
1323 * some point in time before. The tracer does not allow it.
1325 if (session
->has_been_started
) {
1326 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1331 * If the session is a live session, remove the switch timer, the
1332 * live timer does the same thing but sends also synchronisation
1333 * beacons for inactive streams.
1335 if (session
->live_timer
> 0) {
1336 attr
->attr
.live_timer_interval
= session
->live_timer
;
1337 attr
->attr
.switch_timer_interval
= 0;
1340 switch (domain
->type
) {
1341 case LTTNG_DOMAIN_KERNEL
:
1343 struct ltt_kernel_channel
*kchan
;
1345 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1346 session
->kernel_session
);
1347 if (kchan
== NULL
) {
1348 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1349 if (attr
->name
[0] != '\0') {
1350 session
->kernel_session
->has_non_default_channel
= 1;
1353 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1356 if (ret
!= LTTNG_OK
) {
1360 kernel_wait_quiescent(kernel_tracer_fd
);
1363 case LTTNG_DOMAIN_UST
:
1364 case LTTNG_DOMAIN_JUL
:
1365 case LTTNG_DOMAIN_LOG4J
:
1366 case LTTNG_DOMAIN_PYTHON
:
1368 struct ltt_ust_channel
*uchan
;
1373 * Current agent implementation limitations force us to allow
1374 * only one channel at once in "agent" subdomains. Each
1375 * subdomain has a default channel name which must be strictly
1378 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1379 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1380 LTTNG_SYMBOL_NAME_LEN
)) {
1381 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1384 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1385 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1386 LTTNG_SYMBOL_NAME_LEN
)) {
1387 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1390 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1391 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1392 LTTNG_SYMBOL_NAME_LEN
)) {
1393 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1398 chan_ht
= usess
->domain_global
.channels
;
1400 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1401 if (uchan
== NULL
) {
1402 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1403 if (attr
->name
[0] != '\0') {
1404 usess
->has_non_default_channel
= 1;
1407 ret
= channel_ust_enable(usess
, uchan
);
1412 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1423 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1425 int cmd_disable_event(struct ltt_session
*session
,
1426 enum lttng_domain_type domain
, char *channel_name
,
1427 struct lttng_event
*event
)
1432 DBG("Disable event command for event \'%s\'", event
->name
);
1434 event_name
= event
->name
;
1435 if (validate_event_name(event_name
)) {
1436 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1440 /* Error out on unhandled search criteria */
1441 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1442 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1443 ret
= LTTNG_ERR_UNK
;
1450 case LTTNG_DOMAIN_KERNEL
:
1452 struct ltt_kernel_channel
*kchan
;
1453 struct ltt_kernel_session
*ksess
;
1455 ksess
= session
->kernel_session
;
1458 * If a non-default channel has been created in the
1459 * session, explicitely require that -c chan_name needs
1462 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1463 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1467 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1468 if (kchan
== NULL
) {
1469 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1473 switch (event
->type
) {
1474 case LTTNG_EVENT_ALL
:
1475 case LTTNG_EVENT_TRACEPOINT
:
1476 case LTTNG_EVENT_SYSCALL
:
1477 case LTTNG_EVENT_PROBE
:
1478 case LTTNG_EVENT_FUNCTION
:
1479 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1480 if (event_name
[0] == '\0') {
1481 ret
= event_kernel_disable_event(kchan
,
1484 ret
= event_kernel_disable_event(kchan
,
1485 event_name
, event
->type
);
1487 if (ret
!= LTTNG_OK
) {
1492 ret
= LTTNG_ERR_UNK
;
1496 kernel_wait_quiescent(kernel_tracer_fd
);
1499 case LTTNG_DOMAIN_UST
:
1501 struct ltt_ust_channel
*uchan
;
1502 struct ltt_ust_session
*usess
;
1504 usess
= session
->ust_session
;
1506 if (validate_ust_event_name(event_name
)) {
1507 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1512 * If a non-default channel has been created in the
1513 * session, explicitly require that -c chan_name needs
1516 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1517 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1521 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1523 if (uchan
== NULL
) {
1524 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1528 switch (event
->type
) {
1529 case LTTNG_EVENT_ALL
:
1531 * An empty event name means that everything
1532 * should be disabled.
1534 if (event
->name
[0] == '\0') {
1535 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1537 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1540 if (ret
!= LTTNG_OK
) {
1545 ret
= LTTNG_ERR_UNK
;
1549 DBG3("Disable UST event %s in channel %s completed", event_name
,
1553 case LTTNG_DOMAIN_LOG4J
:
1554 case LTTNG_DOMAIN_JUL
:
1555 case LTTNG_DOMAIN_PYTHON
:
1558 struct ltt_ust_session
*usess
= session
->ust_session
;
1562 switch (event
->type
) {
1563 case LTTNG_EVENT_ALL
:
1566 ret
= LTTNG_ERR_UNK
;
1570 agt
= trace_ust_find_agent(usess
, domain
);
1572 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1576 * An empty event name means that everything
1577 * should be disabled.
1579 if (event
->name
[0] == '\0') {
1580 ret
= event_agent_disable_all(usess
, agt
);
1582 ret
= event_agent_disable(usess
, agt
, event_name
);
1584 if (ret
!= LTTNG_OK
) {
1591 ret
= LTTNG_ERR_UND
;
1604 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1606 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1607 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1609 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1610 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1612 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1613 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1614 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1618 case LTTNG_DOMAIN_KERNEL
:
1619 assert(session
->kernel_session
);
1621 if (session
->kernel_session
->channel_count
== 0) {
1622 /* Create default channel */
1623 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1624 if (ret
!= LTTNG_OK
) {
1627 chan_kern_created
= 1;
1629 /* Add kernel context to kernel tracer */
1630 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1631 if (ret
!= LTTNG_OK
) {
1635 case LTTNG_DOMAIN_JUL
:
1636 case LTTNG_DOMAIN_LOG4J
:
1639 * Validate channel name.
1640 * If no channel name is given and the domain is JUL or LOG4J,
1641 * set it to the appropriate domain-specific channel name. If
1642 * a name is provided but does not match the expexted channel
1643 * name, return an error.
1645 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1646 strcmp(channel_name
,
1647 DEFAULT_JUL_CHANNEL_NAME
)) {
1648 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1650 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1651 strcmp(channel_name
,
1652 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1653 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1656 /* break is _not_ missing here. */
1658 case LTTNG_DOMAIN_UST
:
1660 struct ltt_ust_session
*usess
= session
->ust_session
;
1661 unsigned int chan_count
;
1665 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1666 if (chan_count
== 0) {
1667 struct lttng_channel
*attr
;
1668 /* Create default channel */
1669 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1671 ret
= LTTNG_ERR_FATAL
;
1675 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1676 if (ret
!= LTTNG_OK
) {
1681 chan_ust_created
= 1;
1684 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1685 free(app_ctx_provider_name
);
1687 app_ctx_name
= NULL
;
1688 app_ctx_provider_name
= NULL
;
1689 if (ret
!= LTTNG_OK
) {
1695 ret
= LTTNG_ERR_UND
;
1703 if (chan_kern_created
) {
1704 struct ltt_kernel_channel
*kchan
=
1705 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1706 session
->kernel_session
);
1707 /* Created previously, this should NOT fail. */
1709 kernel_destroy_channel(kchan
);
1712 if (chan_ust_created
) {
1713 struct ltt_ust_channel
*uchan
=
1714 trace_ust_find_channel_by_name(
1715 session
->ust_session
->domain_global
.channels
,
1716 DEFAULT_CHANNEL_NAME
);
1717 /* Created previously, this should NOT fail. */
1719 /* Remove from the channel list of the session. */
1720 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1722 trace_ust_destroy_channel(uchan
);
1725 free(app_ctx_provider_name
);
1730 static int validate_event_name(const char *name
)
1733 const char *c
= name
;
1734 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1735 bool null_terminated
= false;
1738 * Make sure that unescaped wildcards are only used as the last
1739 * character of the event name.
1741 while (c
< event_name_end
) {
1744 null_terminated
= true;
1750 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1751 /* Wildcard is not the last character */
1752 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1761 if (!ret
&& !null_terminated
) {
1762 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1767 static inline bool name_starts_with(const char *name
, const char *prefix
)
1769 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1771 return !strncmp(name
, prefix
, max_cmp_len
);
1774 /* Perform userspace-specific event name validation */
1775 static int validate_ust_event_name(const char *name
)
1785 * Check name against all internal UST event component namespaces used
1788 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1789 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1790 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1799 * Internal version of cmd_enable_event() with a supplemental
1800 * "internal_event" flag which is used to enable internal events which should
1801 * be hidden from clients. Such events are used in the agent implementation to
1802 * enable the events through which all "agent" events are funeled.
1804 static int _cmd_enable_event(struct ltt_session
*session
,
1805 struct lttng_domain
*domain
,
1806 char *channel_name
, struct lttng_event
*event
,
1807 char *filter_expression
,
1808 struct lttng_filter_bytecode
*filter
,
1809 struct lttng_event_exclusion
*exclusion
,
1810 int wpipe
, bool internal_event
)
1812 int ret
, channel_created
= 0;
1813 struct lttng_channel
*attr
= NULL
;
1817 assert(channel_name
);
1819 /* If we have a filter, we must have its filter expression */
1820 assert(!(!!filter_expression
^ !!filter
));
1822 DBG("Enable event command for event \'%s\'", event
->name
);
1826 ret
= validate_event_name(event
->name
);
1831 switch (domain
->type
) {
1832 case LTTNG_DOMAIN_KERNEL
:
1834 struct ltt_kernel_channel
*kchan
;
1837 * If a non-default channel has been created in the
1838 * session, explicitely require that -c chan_name needs
1841 if (session
->kernel_session
->has_non_default_channel
1842 && channel_name
[0] == '\0') {
1843 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1847 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1848 session
->kernel_session
);
1849 if (kchan
== NULL
) {
1850 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1851 LTTNG_BUFFER_GLOBAL
);
1853 ret
= LTTNG_ERR_FATAL
;
1856 if (lttng_strncpy(attr
->name
, channel_name
,
1857 sizeof(attr
->name
))) {
1858 ret
= LTTNG_ERR_INVALID
;
1862 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1863 if (ret
!= LTTNG_OK
) {
1866 channel_created
= 1;
1869 /* Get the newly created kernel channel pointer */
1870 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1871 session
->kernel_session
);
1872 if (kchan
== NULL
) {
1873 /* This sould not happen... */
1874 ret
= LTTNG_ERR_FATAL
;
1878 switch (event
->type
) {
1879 case LTTNG_EVENT_ALL
:
1881 char *filter_expression_a
= NULL
;
1882 struct lttng_filter_bytecode
*filter_a
= NULL
;
1885 * We need to duplicate filter_expression and filter,
1886 * because ownership is passed to first enable
1889 if (filter_expression
) {
1890 filter_expression_a
= strdup(filter_expression
);
1891 if (!filter_expression_a
) {
1892 ret
= LTTNG_ERR_FATAL
;
1897 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1899 free(filter_expression_a
);
1900 ret
= LTTNG_ERR_FATAL
;
1903 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1905 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1906 ret
= event_kernel_enable_event(kchan
, event
,
1907 filter_expression
, filter
);
1908 /* We have passed ownership */
1909 filter_expression
= NULL
;
1911 if (ret
!= LTTNG_OK
) {
1912 if (channel_created
) {
1913 /* Let's not leak a useless channel. */
1914 kernel_destroy_channel(kchan
);
1916 free(filter_expression_a
);
1920 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1921 ret
= event_kernel_enable_event(kchan
, event
,
1922 filter_expression_a
, filter_a
);
1923 /* We have passed ownership */
1924 filter_expression_a
= NULL
;
1926 if (ret
!= LTTNG_OK
) {
1931 case LTTNG_EVENT_PROBE
:
1932 case LTTNG_EVENT_FUNCTION
:
1933 case LTTNG_EVENT_FUNCTION_ENTRY
:
1934 case LTTNG_EVENT_TRACEPOINT
:
1935 ret
= event_kernel_enable_event(kchan
, event
,
1936 filter_expression
, filter
);
1937 /* We have passed ownership */
1938 filter_expression
= NULL
;
1940 if (ret
!= LTTNG_OK
) {
1941 if (channel_created
) {
1942 /* Let's not leak a useless channel. */
1943 kernel_destroy_channel(kchan
);
1948 case LTTNG_EVENT_SYSCALL
:
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
) {
1959 ret
= LTTNG_ERR_UNK
;
1963 kernel_wait_quiescent(kernel_tracer_fd
);
1966 case LTTNG_DOMAIN_UST
:
1968 struct ltt_ust_channel
*uchan
;
1969 struct ltt_ust_session
*usess
= session
->ust_session
;
1974 * If a non-default channel has been created in the
1975 * session, explicitely require that -c chan_name needs
1978 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1979 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1983 /* Get channel from global UST domain */
1984 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1986 if (uchan
== NULL
) {
1987 /* Create default channel */
1988 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1989 usess
->buffer_type
);
1991 ret
= LTTNG_ERR_FATAL
;
1994 if (lttng_strncpy(attr
->name
, channel_name
,
1995 sizeof(attr
->name
))) {
1996 ret
= LTTNG_ERR_INVALID
;
2000 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2001 if (ret
!= LTTNG_OK
) {
2005 /* Get the newly created channel reference back */
2006 uchan
= trace_ust_find_channel_by_name(
2007 usess
->domain_global
.channels
, channel_name
);
2011 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2013 * Don't allow users to add UST events to channels which
2014 * are assigned to a userspace subdomain (JUL, Log4J,
2017 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2021 if (!internal_event
) {
2023 * Ensure the event name is not reserved for internal
2026 ret
= validate_ust_event_name(event
->name
);
2028 WARN("Userspace event name %s failed validation.",
2030 event
->name
: "NULL");
2031 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2036 /* At this point, the session and channel exist on the tracer */
2037 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2038 filter_expression
, filter
, exclusion
,
2040 /* We have passed ownership */
2041 filter_expression
= NULL
;
2044 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2045 goto already_enabled
;
2046 } else if (ret
!= LTTNG_OK
) {
2051 case LTTNG_DOMAIN_LOG4J
:
2052 case LTTNG_DOMAIN_JUL
:
2053 case LTTNG_DOMAIN_PYTHON
:
2055 const char *default_event_name
, *default_chan_name
;
2057 struct lttng_event uevent
;
2058 struct lttng_domain tmp_dom
;
2059 struct ltt_ust_session
*usess
= session
->ust_session
;
2063 agt
= trace_ust_find_agent(usess
, domain
->type
);
2065 agt
= agent_create(domain
->type
);
2067 ret
= LTTNG_ERR_NOMEM
;
2070 agent_add(agt
, usess
->agents
);
2073 /* Create the default tracepoint. */
2074 memset(&uevent
, 0, sizeof(uevent
));
2075 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2076 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2077 default_event_name
= event_get_default_agent_ust_name(
2079 if (!default_event_name
) {
2080 ret
= LTTNG_ERR_FATAL
;
2083 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2084 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2087 * The domain type is changed because we are about to enable the
2088 * default channel and event for the JUL domain that are hardcoded.
2089 * This happens in the UST domain.
2091 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2092 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2094 switch (domain
->type
) {
2095 case LTTNG_DOMAIN_LOG4J
:
2096 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2098 case LTTNG_DOMAIN_JUL
:
2099 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2101 case LTTNG_DOMAIN_PYTHON
:
2102 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2105 /* The switch/case we are in makes this impossible */
2110 char *filter_expression_copy
= NULL
;
2111 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2114 const size_t filter_size
= sizeof(
2115 struct lttng_filter_bytecode
)
2118 filter_copy
= zmalloc(filter_size
);
2120 ret
= LTTNG_ERR_NOMEM
;
2123 memcpy(filter_copy
, filter
, filter_size
);
2125 filter_expression_copy
=
2126 strdup(filter_expression
);
2127 if (!filter_expression
) {
2128 ret
= LTTNG_ERR_NOMEM
;
2131 if (!filter_expression_copy
|| !filter_copy
) {
2132 free(filter_expression_copy
);
2138 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2139 (char *) default_chan_name
,
2140 &uevent
, filter_expression_copy
,
2141 filter_copy
, NULL
, wpipe
);
2144 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2145 goto already_enabled
;
2146 } else if (ret
!= LTTNG_OK
) {
2150 /* The wild card * means that everything should be enabled. */
2151 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2152 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2155 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2159 filter_expression
= NULL
;
2160 if (ret
!= LTTNG_OK
) {
2167 ret
= LTTNG_ERR_UND
;
2175 free(filter_expression
);
2184 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2185 * We own filter, exclusion, and filter_expression.
2187 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2188 char *channel_name
, struct lttng_event
*event
,
2189 char *filter_expression
,
2190 struct lttng_filter_bytecode
*filter
,
2191 struct lttng_event_exclusion
*exclusion
,
2194 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2195 filter_expression
, filter
, exclusion
, wpipe
, false);
2199 * Enable an event which is internal to LTTng. An internal should
2200 * never be made visible to clients and are immune to checks such as
2203 static int cmd_enable_event_internal(struct ltt_session
*session
,
2204 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
, true);
2216 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2218 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2219 struct lttng_event
**events
)
2222 ssize_t nb_events
= 0;
2225 case LTTNG_DOMAIN_KERNEL
:
2226 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2227 if (nb_events
< 0) {
2228 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2232 case LTTNG_DOMAIN_UST
:
2233 nb_events
= ust_app_list_events(events
);
2234 if (nb_events
< 0) {
2235 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2239 case LTTNG_DOMAIN_LOG4J
:
2240 case LTTNG_DOMAIN_JUL
:
2241 case LTTNG_DOMAIN_PYTHON
:
2242 nb_events
= agent_list_events(events
, domain
);
2243 if (nb_events
< 0) {
2244 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2249 ret
= LTTNG_ERR_UND
;
2256 /* Return negative value to differentiate return code */
2261 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2263 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2264 struct lttng_event_field
**fields
)
2267 ssize_t nb_fields
= 0;
2270 case LTTNG_DOMAIN_UST
:
2271 nb_fields
= ust_app_list_event_fields(fields
);
2272 if (nb_fields
< 0) {
2273 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2277 case LTTNG_DOMAIN_KERNEL
:
2278 default: /* fall-through */
2279 ret
= LTTNG_ERR_UND
;
2286 /* Return negative value to differentiate return code */
2290 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2292 return syscall_table_list(events
);
2296 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2298 * Called with session lock held.
2300 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2301 enum lttng_domain_type domain
, int32_t **pids
)
2304 ssize_t nr_pids
= 0;
2307 case LTTNG_DOMAIN_KERNEL
:
2309 struct ltt_kernel_session
*ksess
;
2311 ksess
= session
->kernel_session
;
2312 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2314 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2319 case LTTNG_DOMAIN_UST
:
2321 struct ltt_ust_session
*usess
;
2323 usess
= session
->ust_session
;
2324 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2326 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2331 case LTTNG_DOMAIN_LOG4J
:
2332 case LTTNG_DOMAIN_JUL
:
2333 case LTTNG_DOMAIN_PYTHON
:
2335 ret
= LTTNG_ERR_UND
;
2342 /* Return negative value to differentiate return code */
2347 * Command LTTNG_START_TRACE processed by the client thread.
2349 * Called with session mutex held.
2351 int cmd_start_trace(struct ltt_session
*session
)
2354 unsigned long nb_chan
= 0;
2355 struct ltt_kernel_session
*ksession
;
2356 struct ltt_ust_session
*usess
;
2360 /* Ease our life a bit ;) */
2361 ksession
= session
->kernel_session
;
2362 usess
= session
->ust_session
;
2364 /* Is the session already started? */
2365 if (session
->active
) {
2366 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2371 * Starting a session without channel is useless since after that it's not
2372 * possible to enable channel thus inform the client.
2374 if (usess
&& usess
->domain_global
.channels
) {
2375 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2378 nb_chan
+= ksession
->channel_count
;
2381 ret
= LTTNG_ERR_NO_CHANNEL
;
2385 /* Kernel tracing */
2386 if (ksession
!= NULL
) {
2387 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2388 if (ret
!= LTTNG_OK
) {
2393 /* Flag session that trace should start automatically */
2396 * Even though the start trace might fail, flag this session active so
2397 * other application coming in are started by default.
2401 ret
= ust_app_start_trace_all(usess
);
2403 ret
= LTTNG_ERR_UST_START_FAIL
;
2408 /* Flag this after a successful start. */
2409 session
->has_been_started
= 1;
2410 session
->active
= 1;
2419 * Command LTTNG_STOP_TRACE processed by the client thread.
2421 int cmd_stop_trace(struct ltt_session
*session
)
2424 struct ltt_kernel_channel
*kchan
;
2425 struct ltt_kernel_session
*ksession
;
2426 struct ltt_ust_session
*usess
;
2431 ksession
= session
->kernel_session
;
2432 usess
= session
->ust_session
;
2434 /* Session is not active. Skip everythong and inform the client. */
2435 if (!session
->active
) {
2436 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2441 if (ksession
&& ksession
->active
) {
2442 DBG("Stop kernel tracing");
2444 ret
= kernel_stop_session(ksession
);
2446 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2450 kernel_wait_quiescent(kernel_tracer_fd
);
2452 /* Flush metadata after stopping (if exists) */
2453 if (ksession
->metadata_stream_fd
>= 0) {
2454 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2456 ERR("Kernel metadata flush failed");
2460 /* Flush all buffers after stopping */
2461 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2462 ret
= kernel_flush_buffer(kchan
);
2464 ERR("Kernel flush buffer error");
2468 ksession
->active
= 0;
2471 if (usess
&& usess
->active
) {
2473 * Even though the stop trace might fail, flag this session inactive so
2474 * other application coming in are not started by default.
2478 ret
= ust_app_stop_trace_all(usess
);
2480 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2485 /* Flag inactive after a successful stop. */
2486 session
->active
= 0;
2494 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2496 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2497 struct lttng_uri
*uris
)
2500 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2501 struct ltt_ust_session
*usess
= session
->ust_session
;
2507 /* Can't set consumer URI if the session is active. */
2508 if (session
->active
) {
2509 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2513 /* Set the "global" consumer URIs */
2514 for (i
= 0; i
< nb_uri
; i
++) {
2515 ret
= add_uri_to_consumer(session
->consumer
,
2516 &uris
[i
], 0, session
->name
);
2517 if (ret
!= LTTNG_OK
) {
2522 /* Set UST session URIs */
2523 if (session
->ust_session
) {
2524 for (i
= 0; i
< nb_uri
; i
++) {
2525 ret
= add_uri_to_consumer(
2526 session
->ust_session
->consumer
,
2527 &uris
[i
], LTTNG_DOMAIN_UST
,
2529 if (ret
!= LTTNG_OK
) {
2535 /* Set kernel session URIs */
2536 if (session
->kernel_session
) {
2537 for (i
= 0; i
< nb_uri
; i
++) {
2538 ret
= add_uri_to_consumer(
2539 session
->kernel_session
->consumer
,
2540 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2542 if (ret
!= LTTNG_OK
) {
2549 * Make sure to set the session in output mode after we set URI since a
2550 * session can be created without URL (thus flagged in no output mode).
2552 session
->output_traces
= 1;
2554 ksess
->output_traces
= 1;
2558 usess
->output_traces
= 1;
2569 * Command LTTNG_CREATE_SESSION processed by the client thread.
2571 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2572 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2575 struct ltt_session
*session
;
2581 * Verify if the session already exist
2583 * XXX: There is no need for the session lock list here since the caller
2584 * (process_client_msg) is holding it. We might want to change that so a
2585 * single command does not lock the entire session list.
2587 session
= session_find_by_name(name
);
2588 if (session
!= NULL
) {
2589 ret
= LTTNG_ERR_EXIST_SESS
;
2593 /* Create tracing session in the registry */
2594 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2595 LTTNG_SOCK_GET_GID_CRED(creds
));
2596 if (ret
!= LTTNG_OK
) {
2601 * Get the newly created session pointer back
2603 * XXX: There is no need for the session lock list here since the caller
2604 * (process_client_msg) is holding it. We might want to change that so a
2605 * single command does not lock the entire session list.
2607 session
= session_find_by_name(name
);
2610 session
->live_timer
= live_timer
;
2611 /* Create default consumer output for the session not yet created. */
2612 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2613 if (session
->consumer
== NULL
) {
2614 ret
= LTTNG_ERR_FATAL
;
2615 goto consumer_error
;
2619 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2620 if (ret
!= LTTNG_OK
) {
2621 goto consumer_error
;
2623 session
->output_traces
= 1;
2625 session
->output_traces
= 0;
2626 DBG2("Session %s created with no output", session
->name
);
2629 session
->consumer
->enabled
= 1;
2634 session_destroy(session
);
2641 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2643 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2644 size_t nb_uri
, lttng_sock_cred
*creds
)
2647 struct ltt_session
*session
;
2648 struct snapshot_output
*new_output
= NULL
;
2654 * Create session in no output mode with URIs set to NULL. The uris we've
2655 * received are for a default snapshot output if one.
2657 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2658 if (ret
!= LTTNG_OK
) {
2662 /* Get the newly created session pointer back. This should NEVER fail. */
2663 session
= session_find_by_name(name
);
2666 /* Flag session for snapshot mode. */
2667 session
->snapshot_mode
= 1;
2669 /* Skip snapshot output creation if no URI is given. */
2674 new_output
= snapshot_output_alloc();
2676 ret
= LTTNG_ERR_NOMEM
;
2677 goto error_snapshot_alloc
;
2680 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2681 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2683 if (ret
== -ENOMEM
) {
2684 ret
= LTTNG_ERR_NOMEM
;
2686 ret
= LTTNG_ERR_INVALID
;
2688 goto error_snapshot
;
2692 snapshot_add_output(&session
->snapshot
, new_output
);
2699 snapshot_output_destroy(new_output
);
2700 error_snapshot_alloc
:
2701 session_destroy(session
);
2707 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2709 * Called with session lock held.
2711 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2714 struct ltt_ust_session
*usess
;
2715 struct ltt_kernel_session
*ksess
;
2720 usess
= session
->ust_session
;
2721 ksess
= session
->kernel_session
;
2723 /* Clean kernel session teardown */
2724 kernel_destroy_session(ksess
);
2726 /* UST session teardown */
2728 /* Close any relayd session */
2729 consumer_output_send_destroy_relayd(usess
->consumer
);
2731 /* Destroy every UST application related to this session. */
2732 ret
= ust_app_destroy_trace_all(usess
);
2734 ERR("Error in ust_app_destroy_trace_all");
2737 /* Clean up the rest. */
2738 trace_ust_destroy_session(usess
);
2742 * Must notify the kernel thread here to update it's poll set in order to
2743 * remove the channel(s)' fd just destroyed.
2745 ret
= notify_thread_pipe(wpipe
);
2747 PERROR("write kernel poll pipe");
2750 ret
= session_destroy(session
);
2756 * Command LTTNG_CALIBRATE processed by the client thread.
2758 int cmd_calibrate(enum lttng_domain_type domain
,
2759 struct lttng_calibrate
*calibrate
)
2764 case LTTNG_DOMAIN_KERNEL
:
2766 struct lttng_kernel_calibrate kcalibrate
;
2768 switch (calibrate
->type
) {
2769 case LTTNG_CALIBRATE_FUNCTION
:
2771 /* Default and only possible calibrate option. */
2772 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2776 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2778 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2783 case LTTNG_DOMAIN_UST
:
2785 struct lttng_ust_calibrate ucalibrate
;
2787 switch (calibrate
->type
) {
2788 case LTTNG_CALIBRATE_FUNCTION
:
2790 /* Default and only possible calibrate option. */
2791 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2795 ret
= ust_app_calibrate_glb(&ucalibrate
);
2797 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2803 ret
= LTTNG_ERR_UND
;
2814 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2816 int cmd_register_consumer(struct ltt_session
*session
,
2817 enum lttng_domain_type domain
, const char *sock_path
,
2818 struct consumer_data
*cdata
)
2821 struct consumer_socket
*socket
= NULL
;
2828 case LTTNG_DOMAIN_KERNEL
:
2830 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2834 /* Can't register a consumer if there is already one */
2835 if (ksess
->consumer_fds_sent
!= 0) {
2836 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2840 sock
= lttcomm_connect_unix_sock(sock_path
);
2842 ret
= LTTNG_ERR_CONNECT_FAIL
;
2845 cdata
->cmd_sock
= sock
;
2847 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2848 if (socket
== NULL
) {
2851 PERROR("close register consumer");
2853 cdata
->cmd_sock
= -1;
2854 ret
= LTTNG_ERR_FATAL
;
2858 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2859 if (socket
->lock
== NULL
) {
2860 PERROR("zmalloc pthread mutex");
2861 ret
= LTTNG_ERR_FATAL
;
2864 pthread_mutex_init(socket
->lock
, NULL
);
2865 socket
->registered
= 1;
2868 consumer_add_socket(socket
, ksess
->consumer
);
2871 pthread_mutex_lock(&cdata
->pid_mutex
);
2873 pthread_mutex_unlock(&cdata
->pid_mutex
);
2878 /* TODO: Userspace tracing */
2879 ret
= LTTNG_ERR_UND
;
2887 consumer_destroy_socket(socket
);
2893 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2895 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2896 struct lttng_domain
**domains
)
2901 struct lttng_ht_iter iter
;
2903 if (session
->kernel_session
!= NULL
) {
2904 DBG3("Listing domains found kernel domain");
2908 if (session
->ust_session
!= NULL
) {
2909 DBG3("Listing domains found UST global domain");
2913 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2915 if (agt
->being_used
) {
2926 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2927 if (*domains
== NULL
) {
2928 ret
= LTTNG_ERR_FATAL
;
2932 if (session
->kernel_session
!= NULL
) {
2933 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2935 /* Kernel session buffer type is always GLOBAL */
2936 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2941 if (session
->ust_session
!= NULL
) {
2942 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2943 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2947 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2949 if (agt
->being_used
) {
2950 (*domains
)[index
].type
= agt
->domain
;
2951 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2961 /* Return negative value to differentiate return code */
2967 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2969 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2970 struct ltt_session
*session
, struct lttng_channel
**channels
)
2972 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
2975 case LTTNG_DOMAIN_KERNEL
:
2976 if (session
->kernel_session
!= NULL
) {
2977 nb_chan
= session
->kernel_session
->channel_count
;
2979 DBG3("Number of kernel channels %zd", nb_chan
);
2981 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2985 case LTTNG_DOMAIN_UST
:
2986 if (session
->ust_session
!= NULL
) {
2988 nb_chan
= lttng_ht_get_count(
2989 session
->ust_session
->domain_global
.channels
);
2992 DBG3("Number of UST global channels %zd", nb_chan
);
2994 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2999 ret
= -LTTNG_ERR_UND
;
3004 const size_t channel_size
= sizeof(struct lttng_channel
) +
3005 sizeof(struct lttcomm_channel_extended
);
3006 struct lttcomm_channel_extended
*channel_exts
;
3008 payload_size
= nb_chan
* channel_size
;
3009 *channels
= zmalloc(payload_size
);
3010 if (*channels
== NULL
) {
3011 ret
= -LTTNG_ERR_FATAL
;
3015 channel_exts
= ((void *) *channels
) +
3016 (nb_chan
* sizeof(struct lttng_channel
));
3017 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3018 if (ret
!= LTTNG_OK
) {
3033 * Command LTTNG_LIST_EVENTS processed by the client thread.
3035 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3036 struct ltt_session
*session
, char *channel_name
,
3037 struct lttng_event
**events
, size_t *total_size
)
3040 ssize_t nb_event
= 0;
3043 case LTTNG_DOMAIN_KERNEL
:
3044 if (session
->kernel_session
!= NULL
) {
3045 nb_event
= list_lttng_kernel_events(channel_name
,
3046 session
->kernel_session
, events
,
3050 case LTTNG_DOMAIN_UST
:
3052 if (session
->ust_session
!= NULL
) {
3053 nb_event
= list_lttng_ust_global_events(channel_name
,
3054 &session
->ust_session
->domain_global
, events
,
3059 case LTTNG_DOMAIN_LOG4J
:
3060 case LTTNG_DOMAIN_JUL
:
3061 case LTTNG_DOMAIN_PYTHON
:
3062 if (session
->ust_session
) {
3063 struct lttng_ht_iter iter
;
3067 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3068 &iter
.iter
, agt
, node
.node
) {
3069 if (agt
->domain
== domain
) {
3070 nb_event
= list_lttng_agent_events(
3080 ret
= LTTNG_ERR_UND
;
3087 /* Return negative value to differentiate return code */
3092 * Using the session list, filled a lttng_session array to send back to the
3093 * client for session listing.
3095 * The session list lock MUST be acquired before calling this function. Use
3096 * session_lock_list() and session_unlock_list().
3098 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3103 struct ltt_session
*session
;
3104 struct ltt_session_list
*list
= session_get_list();
3106 DBG("Getting all available session for UID %d GID %d",
3109 * Iterate over session list and append data after the control struct in
3112 cds_list_for_each_entry(session
, &list
->head
, list
) {
3114 * Only list the sessions the user can control.
3116 if (!session_access_ok(session
, uid
, gid
)) {
3120 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3121 struct ltt_ust_session
*usess
= session
->ust_session
;
3123 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3124 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3125 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3126 ret
= build_network_session_path(sessions
[i
].path
,
3127 sizeof(sessions
[i
].path
), session
);
3129 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3130 session
->consumer
->dst
.trace_path
);
3133 PERROR("snprintf session path");
3137 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3138 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3139 sessions
[i
].enabled
= session
->active
;
3140 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3141 sessions
[i
].live_timer_interval
= session
->live_timer
;
3147 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3148 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3150 int cmd_data_pending(struct ltt_session
*session
)
3153 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3154 struct ltt_ust_session
*usess
= session
->ust_session
;
3158 /* Session MUST be stopped to ask for data availability. */
3159 if (session
->active
) {
3160 ret
= LTTNG_ERR_SESSION_STARTED
;
3164 * If stopped, just make sure we've started before else the above call
3165 * will always send that there is data pending.
3167 * The consumer assumes that when the data pending command is received,
3168 * the trace has been started before or else no output data is written
3169 * by the streams which is a condition for data pending. So, this is
3170 * *VERY* important that we don't ask the consumer before a start
3173 if (!session
->has_been_started
) {
3179 if (ksess
&& ksess
->consumer
) {
3180 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3182 /* Data is still being extracted for the kernel. */
3187 if (usess
&& usess
->consumer
) {
3188 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3190 /* Data is still being extracted for the kernel. */
3195 /* Data is ready to be read by a viewer */
3203 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3205 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3207 int cmd_snapshot_add_output(struct ltt_session
*session
,
3208 struct lttng_snapshot_output
*output
, uint32_t *id
)
3211 struct snapshot_output
*new_output
;
3216 DBG("Cmd snapshot add output for session %s", session
->name
);
3219 * Permission denied to create an output if the session is not
3220 * set in no output mode.
3222 if (session
->output_traces
) {
3223 ret
= LTTNG_ERR_EPERM
;
3227 /* Only one output is allowed until we have the "tee" feature. */
3228 if (session
->snapshot
.nb_output
== 1) {
3229 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3233 new_output
= snapshot_output_alloc();
3235 ret
= LTTNG_ERR_NOMEM
;
3239 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3240 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3241 &session
->snapshot
);
3243 if (ret
== -ENOMEM
) {
3244 ret
= LTTNG_ERR_NOMEM
;
3246 ret
= LTTNG_ERR_INVALID
;
3252 snapshot_add_output(&session
->snapshot
, new_output
);
3254 *id
= new_output
->id
;
3261 snapshot_output_destroy(new_output
);
3267 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3269 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3271 int cmd_snapshot_del_output(struct ltt_session
*session
,
3272 struct lttng_snapshot_output
*output
)
3275 struct snapshot_output
*sout
= NULL
;
3283 * Permission denied to create an output if the session is not
3284 * set in no output mode.
3286 if (session
->output_traces
) {
3287 ret
= LTTNG_ERR_EPERM
;
3292 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3294 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3295 } else if (*output
->name
!= '\0') {
3296 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3298 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3301 ret
= LTTNG_ERR_INVALID
;
3305 snapshot_delete_output(&session
->snapshot
, sout
);
3306 snapshot_output_destroy(sout
);
3315 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3317 * If no output is available, outputs is untouched and 0 is returned.
3319 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3321 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3322 struct lttng_snapshot_output
**outputs
)
3325 struct lttng_snapshot_output
*list
= NULL
;
3326 struct lttng_ht_iter iter
;
3327 struct snapshot_output
*output
;
3332 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3335 * Permission denied to create an output if the session is not
3336 * set in no output mode.
3338 if (session
->output_traces
) {
3339 ret
= -LTTNG_ERR_EPERM
;
3343 if (session
->snapshot
.nb_output
== 0) {
3348 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3350 ret
= -LTTNG_ERR_NOMEM
;
3354 /* Copy list from session to the new list object. */
3356 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3357 output
, node
.node
) {
3358 assert(output
->consumer
);
3359 list
[idx
].id
= output
->id
;
3360 list
[idx
].max_size
= output
->max_size
;
3361 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3362 sizeof(list
[idx
].name
))) {
3363 ret
= -LTTNG_ERR_INVALID
;
3366 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3367 if (lttng_strncpy(list
[idx
].ctrl_url
,
3368 output
->consumer
->dst
.trace_path
,
3369 sizeof(list
[idx
].ctrl_url
))) {
3370 ret
= -LTTNG_ERR_INVALID
;
3375 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3376 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3378 ret
= -LTTNG_ERR_NOMEM
;
3383 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3384 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3386 ret
= -LTTNG_ERR_NOMEM
;
3395 ret
= session
->snapshot
.nb_output
;
3404 * Check if we can regenerate the metadata for this session.
3405 * Only kernel, UST per-uid and non-live sessions are supported.
3407 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3410 int check_metadata_regenerate_support(struct ltt_session
*session
)
3416 if (session
->live_timer
!= 0) {
3417 ret
= LTTNG_ERR_LIVE_SESSION
;
3420 if (!session
->active
) {
3421 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3424 if (session
->ust_session
) {
3425 switch (session
->ust_session
->buffer_type
) {
3426 case LTTNG_BUFFER_PER_UID
:
3428 case LTTNG_BUFFER_PER_PID
:
3429 ret
= LTTNG_ERR_PER_PID_SESSION
;
3433 ret
= LTTNG_ERR_UNK
;
3437 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3438 session
->consumer
->relay_minor_version
< 8) {
3439 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3449 int clear_metadata_file(int fd
)
3453 ret
= lseek(fd
, 0, SEEK_SET
);
3459 ret
= ftruncate(fd
, 0);
3461 PERROR("ftruncate");
3470 int ust_metadata_regenerate(struct ltt_ust_session
*usess
)
3473 struct buffer_reg_uid
*uid_reg
= NULL
;
3474 struct buffer_reg_session
*session_reg
= NULL
;
3477 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3478 struct ust_registry_session
*registry
;
3479 struct ust_registry_channel
*chan
;
3480 struct lttng_ht_iter iter_chan
;
3482 session_reg
= uid_reg
->registry
;
3483 registry
= session_reg
->reg
.ust
;
3485 pthread_mutex_lock(®istry
->lock
);
3486 registry
->metadata_len_sent
= 0;
3487 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3488 registry
->metadata_len
= 0;
3489 registry
->metadata_version
++;
3490 if (registry
->metadata_fd
> 0) {
3491 /* Clear the metadata file's content. */
3492 ret
= clear_metadata_file(registry
->metadata_fd
);
3494 pthread_mutex_unlock(®istry
->lock
);
3499 ret
= ust_metadata_session_statedump(registry
, NULL
,
3500 registry
->major
, registry
->minor
);
3502 pthread_mutex_unlock(®istry
->lock
);
3503 ERR("Failed to generate session metadata (err = %d)",
3507 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3509 struct ust_registry_event
*event
;
3510 struct lttng_ht_iter iter_event
;
3512 ret
= ust_metadata_channel_statedump(registry
, chan
);
3514 pthread_mutex_unlock(®istry
->lock
);
3515 ERR("Failed to generate channel metadata "
3519 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3521 ret
= ust_metadata_event_statedump(registry
,
3524 pthread_mutex_unlock(®istry
->lock
);
3525 ERR("Failed to generate event metadata "
3531 pthread_mutex_unlock(®istry
->lock
);
3540 * Command LTTNG_METADATA_REGENERATE from the lttng-ctl library.
3542 * Ask the consumer to truncate the existing metadata file(s) and
3543 * then regenerate the metadata. Live and per-pid sessions are not
3544 * supported and return an error.
3546 * Return 0 on success or else a LTTNG_ERR code.
3548 int cmd_metadata_regenerate(struct ltt_session
*session
)
3554 ret
= check_metadata_regenerate_support(session
);
3559 if (session
->kernel_session
) {
3560 ret
= kernctl_session_metadata_regenerate(
3561 session
->kernel_session
->fd
);
3563 ERR("Failed to regenerate the kernel metadata");
3568 if (session
->ust_session
) {
3569 ret
= ust_metadata_regenerate(session
->ust_session
);
3571 ERR("Failed to regenerate the UST metadata");
3575 DBG("Cmd metadata regenerate for session %s", session
->name
);
3584 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3585 * snapshot output is *not* set with a remote destination.
3587 * Return 0 on success or a LTTNG_ERR code.
3589 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3590 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3593 struct lttng_ht_iter iter
;
3594 struct consumer_socket
*socket
;
3597 assert(snap_output
);
3600 DBG2("Set relayd object from snapshot output");
3602 /* Ignore if snapshot consumer output is not network. */
3603 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3608 * For each consumer socket, create and send the relayd object of the
3612 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3613 socket
, node
.node
) {
3614 ret
= send_consumer_relayd_sockets(0, session
->id
,
3615 snap_output
->consumer
, socket
,
3616 session
->name
, session
->hostname
,
3617 session
->live_timer
);
3618 if (ret
!= LTTNG_OK
) {
3630 * Record a kernel snapshot.
3632 * Return LTTNG_OK on success or a LTTNG_ERR code.
3634 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3635 struct snapshot_output
*output
, struct ltt_session
*session
,
3636 int wait
, uint64_t nb_packets_per_stream
)
3646 * Copy kernel session sockets so we can communicate with the right
3647 * consumer for the snapshot record command.
3649 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3651 ret
= LTTNG_ERR_NOMEM
;
3655 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3656 if (ret
!= LTTNG_OK
) {
3657 goto error_snapshot
;
3660 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3661 if (ret
!= LTTNG_OK
) {
3662 goto error_snapshot
;
3669 /* Clean up copied sockets so this output can use some other later on. */
3670 consumer_destroy_output_sockets(output
->consumer
);
3677 * Record a UST snapshot.
3679 * Return 0 on success or a LTTNG_ERR error code.
3681 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3682 struct snapshot_output
*output
, struct ltt_session
*session
,
3683 int wait
, uint64_t nb_packets_per_stream
)
3692 * Copy UST session sockets so we can communicate with the right
3693 * consumer for the snapshot record command.
3695 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3697 ret
= LTTNG_ERR_NOMEM
;
3701 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3702 if (ret
!= LTTNG_OK
) {
3703 goto error_snapshot
;
3706 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3710 ret
= LTTNG_ERR_INVALID
;
3713 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3716 goto error_snapshot
;
3722 /* Clean up copied sockets so this output can use some other later on. */
3723 consumer_destroy_output_sockets(output
->consumer
);
3729 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3730 uint64_t cur_nr_packets
)
3732 uint64_t tot_size
= 0;
3734 if (session
->kernel_session
) {
3735 struct ltt_kernel_channel
*chan
;
3736 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3738 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3739 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3741 * Don't take channel into account if we
3742 * already grab all its packets.
3746 tot_size
+= chan
->channel
->attr
.subbuf_size
3747 * chan
->stream_count
;
3751 if (session
->ust_session
) {
3752 struct ltt_ust_session
*usess
= session
->ust_session
;
3754 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3762 * Calculate the number of packets we can grab from each stream that
3763 * fits within the overall snapshot max size.
3765 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3766 * the number of packets per stream.
3768 * TODO: this approach is not perfect: we consider the worse case
3769 * (packet filling the sub-buffers) as an upper bound, but we could do
3770 * better if we do this calculation while we actually grab the packet
3771 * content: we would know how much padding we don't actually store into
3774 * This algorithm is currently bounded by the number of packets per
3777 * Since we call this algorithm before actually grabbing the data, it's
3778 * an approximation: for instance, applications could appear/disappear
3779 * in between this call and actually grabbing data.
3782 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3785 uint64_t cur_nb_packets
= 0;
3788 return 0; /* Infinite */
3791 size_left
= max_size
;
3793 uint64_t one_more_packet_tot_size
;
3795 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3797 if (!one_more_packet_tot_size
) {
3798 /* We are already grabbing all packets. */
3801 size_left
-= one_more_packet_tot_size
;
3802 if (size_left
< 0) {
3807 if (!cur_nb_packets
) {
3808 /* Not enough room to grab one packet of each stream, error. */
3811 return cur_nb_packets
;
3815 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3817 * The wait parameter is ignored so this call always wait for the snapshot to
3818 * complete before returning.
3820 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3822 int cmd_snapshot_record(struct ltt_session
*session
,
3823 struct lttng_snapshot_output
*output
, int wait
)
3826 unsigned int use_tmp_output
= 0;
3827 struct snapshot_output tmp_output
;
3828 unsigned int snapshot_success
= 0;
3834 DBG("Cmd snapshot record for session %s", session
->name
);
3836 /* Get the datetime for the snapshot output directory. */
3837 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3840 ret
= LTTNG_ERR_INVALID
;
3845 * Permission denied to create an output if the session is not
3846 * set in no output mode.
3848 if (session
->output_traces
) {
3849 ret
= LTTNG_ERR_EPERM
;
3853 /* The session needs to be started at least once. */
3854 if (!session
->has_been_started
) {
3855 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3859 /* Use temporary output for the session. */
3860 if (*output
->ctrl_url
!= '\0') {
3861 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3862 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3865 if (ret
== -ENOMEM
) {
3866 ret
= LTTNG_ERR_NOMEM
;
3868 ret
= LTTNG_ERR_INVALID
;
3872 /* Use the global session count for the temporary snapshot. */
3873 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3875 /* Use the global datetime */
3876 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3880 if (use_tmp_output
) {
3881 int64_t nb_packets_per_stream
;
3883 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3884 tmp_output
.max_size
);
3885 if (nb_packets_per_stream
< 0) {
3886 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3890 if (session
->kernel_session
) {
3891 ret
= record_kernel_snapshot(session
->kernel_session
,
3892 &tmp_output
, session
,
3893 wait
, nb_packets_per_stream
);
3894 if (ret
!= LTTNG_OK
) {
3899 if (session
->ust_session
) {
3900 ret
= record_ust_snapshot(session
->ust_session
,
3901 &tmp_output
, session
,
3902 wait
, nb_packets_per_stream
);
3903 if (ret
!= LTTNG_OK
) {
3908 snapshot_success
= 1;
3910 struct snapshot_output
*sout
;
3911 struct lttng_ht_iter iter
;
3914 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3915 &iter
.iter
, sout
, node
.node
) {
3916 int64_t nb_packets_per_stream
;
3919 * Make a local copy of the output and assign the possible
3920 * temporary value given by the caller.
3922 memset(&tmp_output
, 0, sizeof(tmp_output
));
3923 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3925 if (output
->max_size
!= (uint64_t) -1ULL) {
3926 tmp_output
.max_size
= output
->max_size
;
3929 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3930 tmp_output
.max_size
);
3931 if (nb_packets_per_stream
< 0) {
3932 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3937 /* Use temporary name. */
3938 if (*output
->name
!= '\0') {
3939 if (lttng_strncpy(tmp_output
.name
, output
->name
,
3940 sizeof(tmp_output
.name
))) {
3941 ret
= LTTNG_ERR_INVALID
;
3947 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3948 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3950 if (session
->kernel_session
) {
3951 ret
= record_kernel_snapshot(session
->kernel_session
,
3952 &tmp_output
, session
,
3953 wait
, nb_packets_per_stream
);
3954 if (ret
!= LTTNG_OK
) {
3960 if (session
->ust_session
) {
3961 ret
= record_ust_snapshot(session
->ust_session
,
3962 &tmp_output
, session
,
3963 wait
, nb_packets_per_stream
);
3964 if (ret
!= LTTNG_OK
) {
3969 snapshot_success
= 1;
3974 if (snapshot_success
) {
3975 session
->snapshot
.nb_snapshot
++;
3977 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3985 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3987 int cmd_set_session_shm_path(struct ltt_session
*session
,
3988 const char *shm_path
)
3994 * Can only set shm path before session is started.
3996 if (session
->has_been_started
) {
3997 return LTTNG_ERR_SESSION_STARTED
;
4000 strncpy(session
->shm_path
, shm_path
,
4001 sizeof(session
->shm_path
));
4002 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4008 * Init command subsystem.
4013 * Set network sequence index to 1 for streams to match a relayd
4014 * socket on the consumer side.
4016 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
4017 relayd_net_seq_idx
= 1;
4018 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
4020 DBG("Command subsystem initialized");