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 void 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
;
331 static void increment_extended_len(const char *filter_expression
,
332 struct lttng_event_exclusion
*exclusion
, size_t *extended_len
)
334 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
336 if (filter_expression
) {
337 *extended_len
+= strlen(filter_expression
) + 1;
341 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
345 static void append_extended_info(const char *filter_expression
,
346 struct lttng_event_exclusion
*exclusion
, void **extended_at
)
348 struct lttcomm_event_extended_header extended_header
;
349 size_t filter_len
= 0;
350 size_t nb_exclusions
= 0;
352 if (filter_expression
) {
353 filter_len
= strlen(filter_expression
) + 1;
357 nb_exclusions
= exclusion
->count
;
360 /* Set header fields */
361 extended_header
.filter_len
= filter_len
;
362 extended_header
.nb_exclusions
= nb_exclusions
;
365 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
366 *extended_at
+= sizeof(extended_header
);
368 /* Copy filter string */
369 if (filter_expression
) {
370 memcpy(*extended_at
, filter_expression
, filter_len
);
371 *extended_at
+= filter_len
;
374 /* Copy exclusion names */
376 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
378 memcpy(*extended_at
, &exclusion
->names
, len
);
384 * Create a list of agent domain events.
386 * Return number of events in list on success or else a negative value.
388 static int list_lttng_agent_events(struct agent
*agt
,
389 struct lttng_event
**events
, size_t *total_size
)
392 unsigned int nb_event
= 0;
393 struct agent_event
*event
;
394 struct lttng_event
*tmp_events
;
395 struct lttng_ht_iter iter
;
396 size_t extended_len
= 0;
402 DBG3("Listing agent events");
405 nb_event
= lttng_ht_get_count(agt
->events
);
413 /* Compute required extended infos size */
414 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
417 * This is only valid because the commands which add events are
418 * processed in the same thread as the listing.
421 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
422 increment_extended_len(event
->filter_expression
, NULL
,
427 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
428 tmp_events
= zmalloc(*total_size
);
430 PERROR("zmalloc agent events session");
431 ret
= -LTTNG_ERR_FATAL
;
435 extended_at
= ((uint8_t *) tmp_events
) +
436 nb_event
* sizeof(struct lttng_event
);
439 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
440 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
441 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
442 tmp_events
[i
].enabled
= event
->enabled
;
443 tmp_events
[i
].loglevel
= event
->loglevel_value
;
444 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
447 /* Append extended info */
448 append_extended_info(event
->filter_expression
, NULL
,
453 *events
= tmp_events
;
457 assert(nb_event
== i
);
462 * Create a list of ust global domain events.
464 static int list_lttng_ust_global_events(char *channel_name
,
465 struct ltt_ust_domain_global
*ust_global
,
466 struct lttng_event
**events
, size_t *total_size
)
469 unsigned int nb_event
= 0;
470 struct lttng_ht_iter iter
;
471 struct lttng_ht_node_str
*node
;
472 struct ltt_ust_channel
*uchan
;
473 struct ltt_ust_event
*uevent
;
474 struct lttng_event
*tmp
;
475 size_t extended_len
= 0;
478 DBG("Listing UST global events for channel %s", channel_name
);
482 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
483 node
= lttng_ht_iter_get_node_str(&iter
);
485 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
489 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
491 nb_event
= lttng_ht_get_count(uchan
->events
);
498 DBG3("Listing UST global %d events", nb_event
);
500 /* Compute required extended infos size */
501 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
502 if (uevent
->internal
) {
507 increment_extended_len(uevent
->filter_expression
,
508 uevent
->exclusion
, &extended_len
);
511 /* All events are internal, skip. */
517 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
518 tmp
= zmalloc(*total_size
);
520 ret
= -LTTNG_ERR_FATAL
;
524 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
526 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
527 if (uevent
->internal
) {
528 /* This event should remain hidden from clients */
531 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
532 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
533 tmp
[i
].enabled
= uevent
->enabled
;
535 switch (uevent
->attr
.instrumentation
) {
536 case LTTNG_UST_TRACEPOINT
:
537 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
539 case LTTNG_UST_PROBE
:
540 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
542 case LTTNG_UST_FUNCTION
:
543 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
547 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
548 switch (uevent
->attr
.loglevel_type
) {
549 case LTTNG_UST_LOGLEVEL_ALL
:
550 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
552 case LTTNG_UST_LOGLEVEL_RANGE
:
553 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
555 case LTTNG_UST_LOGLEVEL_SINGLE
:
556 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
559 if (uevent
->filter
) {
562 if (uevent
->exclusion
) {
563 tmp
[i
].exclusion
= 1;
567 /* Append extended info */
568 append_extended_info(uevent
->filter_expression
,
569 uevent
->exclusion
, &extended_at
);
580 * Fill lttng_event array of all kernel events in the channel.
582 static int list_lttng_kernel_events(char *channel_name
,
583 struct ltt_kernel_session
*kernel_session
,
584 struct lttng_event
**events
, size_t *total_size
)
587 unsigned int nb_event
;
588 struct ltt_kernel_event
*event
;
589 struct ltt_kernel_channel
*kchan
;
590 size_t extended_len
= 0;
593 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
595 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
599 nb_event
= kchan
->event_count
;
601 DBG("Listing events for channel %s", kchan
->channel
->name
);
609 /* Compute required extended infos size */
610 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
611 increment_extended_len(event
->filter_expression
, NULL
,
615 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
616 *events
= zmalloc(*total_size
);
617 if (*events
== NULL
) {
618 ret
= LTTNG_ERR_FATAL
;
622 extended_at
= ((void *) *events
) +
623 nb_event
* sizeof(struct lttng_event
);
625 /* Kernel channels */
626 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
627 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
628 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
629 (*events
)[i
].enabled
= event
->enabled
;
630 (*events
)[i
].filter
=
631 (unsigned char) !!event
->filter_expression
;
633 switch (event
->event
->instrumentation
) {
634 case LTTNG_KERNEL_TRACEPOINT
:
635 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
637 case LTTNG_KERNEL_KRETPROBE
:
638 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
639 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
640 sizeof(struct lttng_kernel_kprobe
));
642 case LTTNG_KERNEL_KPROBE
:
643 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
644 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
645 sizeof(struct lttng_kernel_kprobe
));
647 case LTTNG_KERNEL_FUNCTION
:
648 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
649 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
650 sizeof(struct lttng_kernel_function
));
652 case LTTNG_KERNEL_NOOP
:
653 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
655 case LTTNG_KERNEL_SYSCALL
:
656 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
658 case LTTNG_KERNEL_ALL
:
664 /* Append extended info */
665 append_extended_info(event
->filter_expression
, NULL
,
673 /* Negate the error code to differentiate the size from an error */
678 * Add URI so the consumer output object. Set the correct path depending on the
679 * domain adding the default trace directory.
681 static int add_uri_to_consumer(struct consumer_output
*consumer
,
682 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
683 const char *session_name
)
686 const char *default_trace_dir
;
690 if (consumer
== NULL
) {
691 DBG("No consumer detected. Don't add URI. Stopping.");
692 ret
= LTTNG_ERR_NO_CONSUMER
;
697 case LTTNG_DOMAIN_KERNEL
:
698 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
700 case LTTNG_DOMAIN_UST
:
701 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
705 * This case is possible is we try to add the URI to the global tracing
706 * session consumer object which in this case there is no subdir.
708 default_trace_dir
= "";
711 switch (uri
->dtype
) {
714 DBG2("Setting network URI to consumer");
716 if (consumer
->type
== CONSUMER_DST_NET
) {
717 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
718 consumer
->dst
.net
.control_isset
) ||
719 (uri
->stype
== LTTNG_STREAM_DATA
&&
720 consumer
->dst
.net
.data_isset
)) {
721 ret
= LTTNG_ERR_URL_EXIST
;
725 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
728 consumer
->type
= CONSUMER_DST_NET
;
730 /* Set URI into consumer output object */
731 ret
= consumer_set_network_uri(consumer
, uri
);
735 } else if (ret
== 1) {
737 * URI was the same in the consumer so we do not append the subdir
738 * again so to not duplicate output dir.
744 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
745 ret
= consumer_set_subdir(consumer
, session_name
);
747 ret
= LTTNG_ERR_FATAL
;
752 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
753 /* On a new subdir, reappend the default trace dir. */
754 strncat(consumer
->subdir
, default_trace_dir
,
755 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
756 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
761 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
762 memset(consumer
->dst
.trace_path
, 0,
763 sizeof(consumer
->dst
.trace_path
));
764 /* Explicit length checks for strcpy and strcat. */
765 if (strlen(uri
->dst
.path
) + strlen(default_trace_dir
)
766 >= sizeof(consumer
->dst
.trace_path
)) {
767 ret
= LTTNG_ERR_FATAL
;
770 strcpy(consumer
->dst
.trace_path
, uri
->dst
.path
);
771 /* Append default trace dir */
772 strcat(consumer
->dst
.trace_path
, default_trace_dir
);
773 /* Flag consumer as local. */
774 consumer
->type
= CONSUMER_DST_LOCAL
;
785 * Init tracing by creating trace directory and sending fds kernel consumer.
787 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
790 struct lttng_ht_iter iter
;
791 struct consumer_socket
*socket
;
797 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
798 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
800 pthread_mutex_lock(socket
->lock
);
801 ret
= kernel_consumer_send_session(socket
, session
);
802 pthread_mutex_unlock(socket
->lock
);
804 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
816 * Create a socket to the relayd using the URI.
818 * On success, the relayd_sock pointer is set to the created socket.
819 * Else, it's stays untouched and a lttcomm error code is returned.
821 static int create_connect_relayd(struct lttng_uri
*uri
,
822 struct lttcomm_relayd_sock
**relayd_sock
,
823 struct consumer_output
*consumer
)
826 struct lttcomm_relayd_sock
*rsock
;
828 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
829 RELAYD_VERSION_COMM_MINOR
);
831 ret
= LTTNG_ERR_FATAL
;
836 * Connect to relayd so we can proceed with a session creation. This call
837 * can possibly block for an arbitrary amount of time to set the health
838 * state to be in poll execution.
841 ret
= relayd_connect(rsock
);
844 ERR("Unable to reach lttng-relayd");
845 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
849 /* Create socket for control stream. */
850 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
851 DBG3("Creating relayd stream socket from URI");
853 /* Check relayd version */
854 ret
= relayd_version_check(rsock
);
856 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
859 consumer
->relay_major_version
= rsock
->major
;
860 consumer
->relay_minor_version
= rsock
->minor
;
861 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
862 DBG3("Creating relayd data socket from URI");
864 /* Command is not valid */
865 ERR("Relayd invalid stream type: %d", uri
->stype
);
866 ret
= LTTNG_ERR_INVALID
;
870 *relayd_sock
= rsock
;
875 /* The returned value is not useful since we are on an error path. */
876 (void) relayd_close(rsock
);
884 * Connect to the relayd using URI and send the socket to the right consumer.
886 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
887 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
888 struct consumer_output
*consumer
,
889 struct consumer_socket
*consumer_sock
,
890 char *session_name
, char *hostname
, int session_live_timer
)
893 struct lttcomm_relayd_sock
*rsock
= NULL
;
895 /* Connect to relayd and make version check if uri is the control. */
896 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
897 if (ret
!= LTTNG_OK
) {
902 /* Set the network sequence index if not set. */
903 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
904 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
906 * Increment net_seq_idx because we are about to transfer the
907 * new relayd socket to the consumer.
908 * Assign unique key so the consumer can match streams.
910 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
911 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
914 /* Send relayd socket to consumer. */
915 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
916 relayd_uri
->stype
, session_id
,
917 session_name
, hostname
, session_live_timer
);
919 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
923 /* Flag that the corresponding socket was sent. */
924 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
925 consumer_sock
->control_sock_sent
= 1;
926 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
927 consumer_sock
->data_sock_sent
= 1;
933 * Close socket which was dup on the consumer side. The session daemon does
934 * NOT keep track of the relayd socket(s) once transfer to the consumer.
938 (void) relayd_close(rsock
);
942 if (ret
!= LTTNG_OK
) {
944 * The consumer output for this session should not be used anymore
945 * since the relayd connection failed thus making any tracing or/and
946 * streaming not usable.
948 consumer
->enabled
= 0;
954 * Send both relayd sockets to a specific consumer and domain. This is a
955 * helper function to facilitate sending the information to the consumer for a
958 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
959 unsigned int session_id
, struct consumer_output
*consumer
,
960 struct consumer_socket
*sock
, char *session_name
,
961 char *hostname
, int session_live_timer
)
968 /* Sending control relayd socket. */
969 if (!sock
->control_sock_sent
) {
970 ret
= send_consumer_relayd_socket(domain
, session_id
,
971 &consumer
->dst
.net
.control
, consumer
, sock
,
972 session_name
, hostname
, session_live_timer
);
973 if (ret
!= LTTNG_OK
) {
978 /* Sending data relayd socket. */
979 if (!sock
->data_sock_sent
) {
980 ret
= send_consumer_relayd_socket(domain
, session_id
,
981 &consumer
->dst
.net
.data
, consumer
, sock
,
982 session_name
, hostname
, session_live_timer
);
983 if (ret
!= LTTNG_OK
) {
993 * Setup relayd connections for a tracing session. First creates the socket to
994 * the relayd and send them to the right domain consumer. Consumer type MUST be
997 int cmd_setup_relayd(struct ltt_session
*session
)
1000 struct ltt_ust_session
*usess
;
1001 struct ltt_kernel_session
*ksess
;
1002 struct consumer_socket
*socket
;
1003 struct lttng_ht_iter iter
;
1007 usess
= session
->ust_session
;
1008 ksess
= session
->kernel_session
;
1010 DBG("Setting relayd for session %s", session
->name
);
1014 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1015 && usess
->consumer
->enabled
) {
1016 /* For each consumer socket, send relayd sockets */
1017 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1018 socket
, node
.node
) {
1019 pthread_mutex_lock(socket
->lock
);
1020 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1021 usess
->consumer
, socket
,
1022 session
->name
, session
->hostname
,
1023 session
->live_timer
);
1024 pthread_mutex_unlock(socket
->lock
);
1025 if (ret
!= LTTNG_OK
) {
1028 /* Session is now ready for network streaming. */
1029 session
->net_handle
= 1;
1031 session
->consumer
->relay_major_version
=
1032 usess
->consumer
->relay_major_version
;
1033 session
->consumer
->relay_minor_version
=
1034 usess
->consumer
->relay_minor_version
;
1037 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1038 && ksess
->consumer
->enabled
) {
1039 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1040 socket
, node
.node
) {
1041 pthread_mutex_lock(socket
->lock
);
1042 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1043 ksess
->consumer
, socket
,
1044 session
->name
, session
->hostname
,
1045 session
->live_timer
);
1046 pthread_mutex_unlock(socket
->lock
);
1047 if (ret
!= LTTNG_OK
) {
1050 /* Session is now ready for network streaming. */
1051 session
->net_handle
= 1;
1053 session
->consumer
->relay_major_version
=
1054 ksess
->consumer
->relay_major_version
;
1055 session
->consumer
->relay_minor_version
=
1056 ksess
->consumer
->relay_minor_version
;
1065 * Start a kernel session by opening all necessary streams.
1067 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1070 struct ltt_kernel_channel
*kchan
;
1072 /* Open kernel metadata */
1073 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1074 ret
= kernel_open_metadata(ksess
);
1076 ret
= LTTNG_ERR_KERN_META_FAIL
;
1081 /* Open kernel metadata stream */
1082 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1083 ret
= kernel_open_metadata_stream(ksess
);
1085 ERR("Kernel create metadata stream failed");
1086 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1091 /* For each channel */
1092 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1093 if (kchan
->stream_count
== 0) {
1094 ret
= kernel_open_channel_stream(kchan
);
1096 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1099 /* Update the stream global counter */
1100 ksess
->stream_count_global
+= ret
;
1104 /* Setup kernel consumer socket and send fds to it */
1105 ret
= init_kernel_tracing(ksess
);
1107 ret
= LTTNG_ERR_KERN_START_FAIL
;
1111 /* This start the kernel tracing */
1112 ret
= kernel_start_session(ksess
);
1114 ret
= LTTNG_ERR_KERN_START_FAIL
;
1118 /* Quiescent wait after starting trace */
1119 kernel_wait_quiescent(kernel_tracer_fd
);
1130 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1132 int cmd_disable_channel(struct ltt_session
*session
,
1133 enum lttng_domain_type domain
, char *channel_name
)
1136 struct ltt_ust_session
*usess
;
1138 usess
= session
->ust_session
;
1143 case LTTNG_DOMAIN_KERNEL
:
1145 ret
= channel_kernel_disable(session
->kernel_session
,
1147 if (ret
!= LTTNG_OK
) {
1151 kernel_wait_quiescent(kernel_tracer_fd
);
1154 case LTTNG_DOMAIN_UST
:
1156 struct ltt_ust_channel
*uchan
;
1157 struct lttng_ht
*chan_ht
;
1159 chan_ht
= usess
->domain_global
.channels
;
1161 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1162 if (uchan
== NULL
) {
1163 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1167 ret
= channel_ust_disable(usess
, uchan
);
1168 if (ret
!= LTTNG_OK
) {
1174 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1186 * Command LTTNG_TRACK_PID processed by the client thread.
1188 * Called with session lock held.
1190 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1198 case LTTNG_DOMAIN_KERNEL
:
1200 struct ltt_kernel_session
*ksess
;
1202 ksess
= session
->kernel_session
;
1204 ret
= kernel_track_pid(ksess
, pid
);
1205 if (ret
!= LTTNG_OK
) {
1209 kernel_wait_quiescent(kernel_tracer_fd
);
1212 case LTTNG_DOMAIN_UST
:
1214 struct ltt_ust_session
*usess
;
1216 usess
= session
->ust_session
;
1218 ret
= trace_ust_track_pid(usess
, pid
);
1219 if (ret
!= LTTNG_OK
) {
1225 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1237 * Command LTTNG_UNTRACK_PID processed by the client thread.
1239 * Called with session lock held.
1241 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1249 case LTTNG_DOMAIN_KERNEL
:
1251 struct ltt_kernel_session
*ksess
;
1253 ksess
= session
->kernel_session
;
1255 ret
= kernel_untrack_pid(ksess
, pid
);
1256 if (ret
!= LTTNG_OK
) {
1260 kernel_wait_quiescent(kernel_tracer_fd
);
1263 case LTTNG_DOMAIN_UST
:
1265 struct ltt_ust_session
*usess
;
1267 usess
= session
->ust_session
;
1269 ret
= trace_ust_untrack_pid(usess
, pid
);
1270 if (ret
!= LTTNG_OK
) {
1276 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1288 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1290 * The wpipe arguments is used as a notifier for the kernel thread.
1292 int cmd_enable_channel(struct ltt_session
*session
,
1293 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1296 struct ltt_ust_session
*usess
= session
->ust_session
;
1297 struct lttng_ht
*chan_ht
;
1304 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1306 /* Validate channel name */
1307 if (attr
->name
[0] == '.' ||
1308 memchr(attr
->name
, '/', len
) != NULL
) {
1309 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1313 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1318 * Don't try to enable a channel if the session has been started at
1319 * some point in time before. The tracer does not allow it.
1321 if (session
->has_been_started
) {
1322 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1327 * If the session is a live session, remove the switch timer, the
1328 * live timer does the same thing but sends also synchronisation
1329 * beacons for inactive streams.
1331 if (session
->live_timer
> 0) {
1332 attr
->attr
.live_timer_interval
= session
->live_timer
;
1333 attr
->attr
.switch_timer_interval
= 0;
1336 switch (domain
->type
) {
1337 case LTTNG_DOMAIN_KERNEL
:
1339 struct ltt_kernel_channel
*kchan
;
1341 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1342 session
->kernel_session
);
1343 if (kchan
== NULL
) {
1344 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1345 if (attr
->name
[0] != '\0') {
1346 session
->kernel_session
->has_non_default_channel
= 1;
1349 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1352 if (ret
!= LTTNG_OK
) {
1356 kernel_wait_quiescent(kernel_tracer_fd
);
1359 case LTTNG_DOMAIN_UST
:
1360 case LTTNG_DOMAIN_JUL
:
1361 case LTTNG_DOMAIN_LOG4J
:
1362 case LTTNG_DOMAIN_PYTHON
:
1364 struct ltt_ust_channel
*uchan
;
1369 * Current agent implementation limitations force us to allow
1370 * only one channel at once in "agent" subdomains. Each
1371 * subdomain has a default channel name which must be strictly
1374 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1375 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1376 LTTNG_SYMBOL_NAME_LEN
)) {
1377 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1380 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1381 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1382 LTTNG_SYMBOL_NAME_LEN
)) {
1383 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1386 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1387 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1388 LTTNG_SYMBOL_NAME_LEN
)) {
1389 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1394 chan_ht
= usess
->domain_global
.channels
;
1396 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1397 if (uchan
== NULL
) {
1398 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1399 if (attr
->name
[0] != '\0') {
1400 usess
->has_non_default_channel
= 1;
1403 ret
= channel_ust_enable(usess
, uchan
);
1408 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1419 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1421 int cmd_disable_event(struct ltt_session
*session
,
1422 enum lttng_domain_type domain
, char *channel_name
,
1423 struct lttng_event
*event
)
1428 DBG("Disable event command for event \'%s\'", event
->name
);
1430 event_name
= event
->name
;
1431 if (validate_event_name(event_name
)) {
1432 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1436 /* Error out on unhandled search criteria */
1437 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1438 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1439 ret
= LTTNG_ERR_UNK
;
1446 case LTTNG_DOMAIN_KERNEL
:
1448 struct ltt_kernel_channel
*kchan
;
1449 struct ltt_kernel_session
*ksess
;
1451 ksess
= session
->kernel_session
;
1454 * If a non-default channel has been created in the
1455 * session, explicitely require that -c chan_name needs
1458 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1459 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1463 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1464 if (kchan
== NULL
) {
1465 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1469 switch (event
->type
) {
1470 case LTTNG_EVENT_ALL
:
1471 case LTTNG_EVENT_TRACEPOINT
:
1472 case LTTNG_EVENT_SYSCALL
:
1473 case LTTNG_EVENT_PROBE
:
1474 case LTTNG_EVENT_FUNCTION
:
1475 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1476 if (event_name
[0] == '\0') {
1477 ret
= event_kernel_disable_event(kchan
,
1480 ret
= event_kernel_disable_event(kchan
,
1481 event_name
, event
->type
);
1483 if (ret
!= LTTNG_OK
) {
1488 ret
= LTTNG_ERR_UNK
;
1492 kernel_wait_quiescent(kernel_tracer_fd
);
1495 case LTTNG_DOMAIN_UST
:
1497 struct ltt_ust_channel
*uchan
;
1498 struct ltt_ust_session
*usess
;
1500 usess
= session
->ust_session
;
1502 if (validate_ust_event_name(event_name
)) {
1503 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1508 * If a non-default channel has been created in the
1509 * session, explicitly require that -c chan_name needs
1512 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1513 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1517 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1519 if (uchan
== NULL
) {
1520 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1524 switch (event
->type
) {
1525 case LTTNG_EVENT_ALL
:
1527 * An empty event name means that everything
1528 * should be disabled.
1530 if (event
->name
[0] == '\0') {
1531 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1533 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1536 if (ret
!= LTTNG_OK
) {
1541 ret
= LTTNG_ERR_UNK
;
1545 DBG3("Disable UST event %s in channel %s completed", event_name
,
1549 case LTTNG_DOMAIN_LOG4J
:
1550 case LTTNG_DOMAIN_JUL
:
1551 case LTTNG_DOMAIN_PYTHON
:
1554 struct ltt_ust_session
*usess
= session
->ust_session
;
1558 switch (event
->type
) {
1559 case LTTNG_EVENT_ALL
:
1562 ret
= LTTNG_ERR_UNK
;
1566 agt
= trace_ust_find_agent(usess
, domain
);
1568 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1572 * An empty event name means that everything
1573 * should be disabled.
1575 if (event
->name
[0] == '\0') {
1576 ret
= event_agent_disable_all(usess
, agt
);
1578 ret
= event_agent_disable(usess
, agt
, event_name
);
1580 if (ret
!= LTTNG_OK
) {
1587 ret
= LTTNG_ERR_UND
;
1600 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1602 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1603 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1605 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1606 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1608 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1609 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1610 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1614 case LTTNG_DOMAIN_KERNEL
:
1615 assert(session
->kernel_session
);
1617 if (session
->kernel_session
->channel_count
== 0) {
1618 /* Create default channel */
1619 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1620 if (ret
!= LTTNG_OK
) {
1623 chan_kern_created
= 1;
1625 /* Add kernel context to kernel tracer */
1626 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1627 if (ret
!= LTTNG_OK
) {
1631 case LTTNG_DOMAIN_JUL
:
1632 case LTTNG_DOMAIN_LOG4J
:
1635 * Validate channel name.
1636 * If no channel name is given and the domain is JUL or LOG4J,
1637 * set it to the appropriate domain-specific channel name. If
1638 * a name is provided but does not match the expexted channel
1639 * name, return an error.
1641 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1642 strcmp(channel_name
,
1643 DEFAULT_JUL_CHANNEL_NAME
)) {
1644 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1646 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1647 strcmp(channel_name
,
1648 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1649 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1652 /* break is _not_ missing here. */
1654 case LTTNG_DOMAIN_UST
:
1656 struct ltt_ust_session
*usess
= session
->ust_session
;
1657 unsigned int chan_count
;
1661 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1662 if (chan_count
== 0) {
1663 struct lttng_channel
*attr
;
1664 /* Create default channel */
1665 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1667 ret
= LTTNG_ERR_FATAL
;
1671 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1672 if (ret
!= LTTNG_OK
) {
1677 chan_ust_created
= 1;
1680 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1681 free(app_ctx_provider_name
);
1683 app_ctx_name
= NULL
;
1684 app_ctx_provider_name
= NULL
;
1685 if (ret
!= LTTNG_OK
) {
1691 ret
= LTTNG_ERR_UND
;
1699 if (chan_kern_created
) {
1700 struct ltt_kernel_channel
*kchan
=
1701 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1702 session
->kernel_session
);
1703 /* Created previously, this should NOT fail. */
1705 kernel_destroy_channel(kchan
);
1708 if (chan_ust_created
) {
1709 struct ltt_ust_channel
*uchan
=
1710 trace_ust_find_channel_by_name(
1711 session
->ust_session
->domain_global
.channels
,
1712 DEFAULT_CHANNEL_NAME
);
1713 /* Created previously, this should NOT fail. */
1715 /* Remove from the channel list of the session. */
1716 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1718 trace_ust_destroy_channel(uchan
);
1721 free(app_ctx_provider_name
);
1726 static int validate_event_name(const char *name
)
1729 const char *c
= name
;
1730 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1731 bool null_terminated
= false;
1734 * Make sure that unescaped wildcards are only used as the last
1735 * character of the event name.
1737 while (c
< event_name_end
) {
1740 null_terminated
= true;
1746 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1747 /* Wildcard is not the last character */
1748 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1757 if (!ret
&& !null_terminated
) {
1758 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1763 static inline bool name_starts_with(const char *name
, const char *prefix
)
1765 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1767 return !strncmp(name
, prefix
, max_cmp_len
);
1770 /* Perform userspace-specific event name validation */
1771 static int validate_ust_event_name(const char *name
)
1781 * Check name against all internal UST event component namespaces used
1784 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1785 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1786 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1795 * Internal version of cmd_enable_event() with a supplemental
1796 * "internal_event" flag which is used to enable internal events which should
1797 * be hidden from clients. Such events are used in the agent implementation to
1798 * enable the events through which all "agent" events are funeled.
1800 static int _cmd_enable_event(struct ltt_session
*session
,
1801 struct lttng_domain
*domain
,
1802 char *channel_name
, struct lttng_event
*event
,
1803 char *filter_expression
,
1804 struct lttng_filter_bytecode
*filter
,
1805 struct lttng_event_exclusion
*exclusion
,
1806 int wpipe
, bool internal_event
)
1808 int ret
, channel_created
= 0;
1809 struct lttng_channel
*attr
= NULL
;
1813 assert(channel_name
);
1815 /* If we have a filter, we must have its filter expression */
1816 assert(!(!!filter_expression
^ !!filter
));
1818 DBG("Enable event command for event \'%s\'", event
->name
);
1822 ret
= validate_event_name(event
->name
);
1827 switch (domain
->type
) {
1828 case LTTNG_DOMAIN_KERNEL
:
1830 struct ltt_kernel_channel
*kchan
;
1833 * If a non-default channel has been created in the
1834 * session, explicitely require that -c chan_name needs
1837 if (session
->kernel_session
->has_non_default_channel
1838 && channel_name
[0] == '\0') {
1839 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1843 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1844 session
->kernel_session
);
1845 if (kchan
== NULL
) {
1846 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1847 LTTNG_BUFFER_GLOBAL
);
1849 ret
= LTTNG_ERR_FATAL
;
1852 if (lttng_strncpy(attr
->name
, channel_name
,
1853 sizeof(attr
->name
))) {
1854 ret
= LTTNG_ERR_INVALID
;
1858 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1859 if (ret
!= LTTNG_OK
) {
1862 channel_created
= 1;
1865 /* Get the newly created kernel channel pointer */
1866 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1867 session
->kernel_session
);
1868 if (kchan
== NULL
) {
1869 /* This sould not happen... */
1870 ret
= LTTNG_ERR_FATAL
;
1874 switch (event
->type
) {
1875 case LTTNG_EVENT_ALL
:
1877 char *filter_expression_a
= NULL
;
1878 struct lttng_filter_bytecode
*filter_a
= NULL
;
1881 * We need to duplicate filter_expression and filter,
1882 * because ownership is passed to first enable
1885 if (filter_expression
) {
1886 filter_expression_a
= strdup(filter_expression
);
1887 if (!filter_expression_a
) {
1888 ret
= LTTNG_ERR_FATAL
;
1893 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1895 free(filter_expression_a
);
1896 ret
= LTTNG_ERR_FATAL
;
1899 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1901 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1902 ret
= event_kernel_enable_event(kchan
, event
,
1903 filter_expression
, filter
);
1904 /* We have passed ownership */
1905 filter_expression
= NULL
;
1907 if (ret
!= LTTNG_OK
) {
1908 if (channel_created
) {
1909 /* Let's not leak a useless channel. */
1910 kernel_destroy_channel(kchan
);
1912 free(filter_expression_a
);
1916 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1917 ret
= event_kernel_enable_event(kchan
, event
,
1918 filter_expression_a
, filter_a
);
1919 /* We have passed ownership */
1920 filter_expression_a
= NULL
;
1922 if (ret
!= LTTNG_OK
) {
1927 case LTTNG_EVENT_PROBE
:
1928 case LTTNG_EVENT_FUNCTION
:
1929 case LTTNG_EVENT_FUNCTION_ENTRY
:
1930 case LTTNG_EVENT_TRACEPOINT
:
1931 ret
= event_kernel_enable_event(kchan
, event
,
1932 filter_expression
, filter
);
1933 /* We have passed ownership */
1934 filter_expression
= NULL
;
1936 if (ret
!= LTTNG_OK
) {
1937 if (channel_created
) {
1938 /* Let's not leak a useless channel. */
1939 kernel_destroy_channel(kchan
);
1944 case LTTNG_EVENT_SYSCALL
:
1945 ret
= event_kernel_enable_event(kchan
, event
,
1946 filter_expression
, filter
);
1947 /* We have passed ownership */
1948 filter_expression
= NULL
;
1950 if (ret
!= LTTNG_OK
) {
1955 ret
= LTTNG_ERR_UNK
;
1959 kernel_wait_quiescent(kernel_tracer_fd
);
1962 case LTTNG_DOMAIN_UST
:
1964 struct ltt_ust_channel
*uchan
;
1965 struct ltt_ust_session
*usess
= session
->ust_session
;
1970 * If a non-default channel has been created in the
1971 * session, explicitely require that -c chan_name needs
1974 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1975 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1979 /* Get channel from global UST domain */
1980 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1982 if (uchan
== NULL
) {
1983 /* Create default channel */
1984 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1985 usess
->buffer_type
);
1987 ret
= LTTNG_ERR_FATAL
;
1990 if (lttng_strncpy(attr
->name
, channel_name
,
1991 sizeof(attr
->name
))) {
1992 ret
= LTTNG_ERR_INVALID
;
1996 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1997 if (ret
!= LTTNG_OK
) {
2001 /* Get the newly created channel reference back */
2002 uchan
= trace_ust_find_channel_by_name(
2003 usess
->domain_global
.channels
, channel_name
);
2007 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2009 * Don't allow users to add UST events to channels which
2010 * are assigned to a userspace subdomain (JUL, Log4J,
2013 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2017 if (!internal_event
) {
2019 * Ensure the event name is not reserved for internal
2022 ret
= validate_ust_event_name(event
->name
);
2024 WARN("Userspace event name %s failed validation.",
2026 event
->name
: "NULL");
2027 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2032 /* At this point, the session and channel exist on the tracer */
2033 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2034 filter_expression
, filter
, exclusion
,
2036 /* We have passed ownership */
2037 filter_expression
= NULL
;
2040 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2041 goto already_enabled
;
2042 } else if (ret
!= LTTNG_OK
) {
2047 case LTTNG_DOMAIN_LOG4J
:
2048 case LTTNG_DOMAIN_JUL
:
2049 case LTTNG_DOMAIN_PYTHON
:
2051 const char *default_event_name
, *default_chan_name
;
2053 struct lttng_event uevent
;
2054 struct lttng_domain tmp_dom
;
2055 struct ltt_ust_session
*usess
= session
->ust_session
;
2059 agt
= trace_ust_find_agent(usess
, domain
->type
);
2061 agt
= agent_create(domain
->type
);
2063 ret
= LTTNG_ERR_NOMEM
;
2066 agent_add(agt
, usess
->agents
);
2069 /* Create the default tracepoint. */
2070 memset(&uevent
, 0, sizeof(uevent
));
2071 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2072 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2073 default_event_name
= event_get_default_agent_ust_name(
2075 if (!default_event_name
) {
2076 ret
= LTTNG_ERR_FATAL
;
2079 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2080 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2083 * The domain type is changed because we are about to enable the
2084 * default channel and event for the JUL domain that are hardcoded.
2085 * This happens in the UST domain.
2087 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2088 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2090 switch (domain
->type
) {
2091 case LTTNG_DOMAIN_LOG4J
:
2092 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2094 case LTTNG_DOMAIN_JUL
:
2095 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2097 case LTTNG_DOMAIN_PYTHON
:
2098 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2101 /* The switch/case we are in makes this impossible */
2106 char *filter_expression_copy
= NULL
;
2107 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2110 const size_t filter_size
= sizeof(
2111 struct lttng_filter_bytecode
)
2114 filter_copy
= zmalloc(filter_size
);
2116 ret
= LTTNG_ERR_NOMEM
;
2119 memcpy(filter_copy
, filter
, filter_size
);
2121 filter_expression_copy
=
2122 strdup(filter_expression
);
2123 if (!filter_expression
) {
2124 ret
= LTTNG_ERR_NOMEM
;
2127 if (!filter_expression_copy
|| !filter_copy
) {
2128 free(filter_expression_copy
);
2134 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2135 (char *) default_chan_name
,
2136 &uevent
, filter_expression_copy
,
2137 filter_copy
, NULL
, wpipe
);
2140 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2141 goto already_enabled
;
2142 } else if (ret
!= LTTNG_OK
) {
2146 /* The wild card * means that everything should be enabled. */
2147 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2148 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2151 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2155 filter_expression
= NULL
;
2156 if (ret
!= LTTNG_OK
) {
2163 ret
= LTTNG_ERR_UND
;
2171 free(filter_expression
);
2180 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2181 * We own filter, exclusion, and filter_expression.
2183 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2184 char *channel_name
, struct lttng_event
*event
,
2185 char *filter_expression
,
2186 struct lttng_filter_bytecode
*filter
,
2187 struct lttng_event_exclusion
*exclusion
,
2190 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2191 filter_expression
, filter
, exclusion
, wpipe
, false);
2195 * Enable an event which is internal to LTTng. An internal should
2196 * never be made visible to clients and are immune to checks such as
2199 static int cmd_enable_event_internal(struct ltt_session
*session
,
2200 struct lttng_domain
*domain
,
2201 char *channel_name
, struct lttng_event
*event
,
2202 char *filter_expression
,
2203 struct lttng_filter_bytecode
*filter
,
2204 struct lttng_event_exclusion
*exclusion
,
2207 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2208 filter_expression
, filter
, exclusion
, wpipe
, true);
2212 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2214 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2215 struct lttng_event
**events
)
2218 ssize_t nb_events
= 0;
2221 case LTTNG_DOMAIN_KERNEL
:
2222 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2223 if (nb_events
< 0) {
2224 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2228 case LTTNG_DOMAIN_UST
:
2229 nb_events
= ust_app_list_events(events
);
2230 if (nb_events
< 0) {
2231 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2235 case LTTNG_DOMAIN_LOG4J
:
2236 case LTTNG_DOMAIN_JUL
:
2237 case LTTNG_DOMAIN_PYTHON
:
2238 nb_events
= agent_list_events(events
, domain
);
2239 if (nb_events
< 0) {
2240 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2245 ret
= LTTNG_ERR_UND
;
2252 /* Return negative value to differentiate return code */
2257 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2259 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2260 struct lttng_event_field
**fields
)
2263 ssize_t nb_fields
= 0;
2266 case LTTNG_DOMAIN_UST
:
2267 nb_fields
= ust_app_list_event_fields(fields
);
2268 if (nb_fields
< 0) {
2269 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2273 case LTTNG_DOMAIN_KERNEL
:
2274 default: /* fall-through */
2275 ret
= LTTNG_ERR_UND
;
2282 /* Return negative value to differentiate return code */
2286 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2288 return syscall_table_list(events
);
2292 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2294 * Called with session lock held.
2296 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2297 enum lttng_domain_type domain
, int32_t **pids
)
2300 ssize_t nr_pids
= 0;
2303 case LTTNG_DOMAIN_KERNEL
:
2305 struct ltt_kernel_session
*ksess
;
2307 ksess
= session
->kernel_session
;
2308 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2310 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2315 case LTTNG_DOMAIN_UST
:
2317 struct ltt_ust_session
*usess
;
2319 usess
= session
->ust_session
;
2320 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2322 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2327 case LTTNG_DOMAIN_LOG4J
:
2328 case LTTNG_DOMAIN_JUL
:
2329 case LTTNG_DOMAIN_PYTHON
:
2331 ret
= LTTNG_ERR_UND
;
2338 /* Return negative value to differentiate return code */
2343 * Command LTTNG_START_TRACE processed by the client thread.
2345 * Called with session mutex held.
2347 int cmd_start_trace(struct ltt_session
*session
)
2350 unsigned long nb_chan
= 0;
2351 struct ltt_kernel_session
*ksession
;
2352 struct ltt_ust_session
*usess
;
2356 /* Ease our life a bit ;) */
2357 ksession
= session
->kernel_session
;
2358 usess
= session
->ust_session
;
2360 /* Is the session already started? */
2361 if (session
->active
) {
2362 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2367 * Starting a session without channel is useless since after that it's not
2368 * possible to enable channel thus inform the client.
2370 if (usess
&& usess
->domain_global
.channels
) {
2371 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2374 nb_chan
+= ksession
->channel_count
;
2377 ret
= LTTNG_ERR_NO_CHANNEL
;
2381 /* Kernel tracing */
2382 if (ksession
!= NULL
) {
2383 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2384 if (ret
!= LTTNG_OK
) {
2389 /* Flag session that trace should start automatically */
2392 * Even though the start trace might fail, flag this session active so
2393 * other application coming in are started by default.
2397 ret
= ust_app_start_trace_all(usess
);
2399 ret
= LTTNG_ERR_UST_START_FAIL
;
2404 /* Flag this after a successful start. */
2405 session
->has_been_started
= 1;
2406 session
->active
= 1;
2415 * Command LTTNG_STOP_TRACE processed by the client thread.
2417 int cmd_stop_trace(struct ltt_session
*session
)
2420 struct ltt_kernel_channel
*kchan
;
2421 struct ltt_kernel_session
*ksession
;
2422 struct ltt_ust_session
*usess
;
2427 ksession
= session
->kernel_session
;
2428 usess
= session
->ust_session
;
2430 /* Session is not active. Skip everythong and inform the client. */
2431 if (!session
->active
) {
2432 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2437 if (ksession
&& ksession
->active
) {
2438 DBG("Stop kernel tracing");
2440 ret
= kernel_stop_session(ksession
);
2442 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2446 kernel_wait_quiescent(kernel_tracer_fd
);
2448 /* Flush metadata after stopping (if exists) */
2449 if (ksession
->metadata_stream_fd
>= 0) {
2450 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2452 ERR("Kernel metadata flush failed");
2456 /* Flush all buffers after stopping */
2457 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2458 ret
= kernel_flush_buffer(kchan
);
2460 ERR("Kernel flush buffer error");
2464 ksession
->active
= 0;
2467 if (usess
&& usess
->active
) {
2469 * Even though the stop trace might fail, flag this session inactive so
2470 * other application coming in are not started by default.
2474 ret
= ust_app_stop_trace_all(usess
);
2476 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2481 /* Flag inactive after a successful stop. */
2482 session
->active
= 0;
2490 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2492 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2493 struct lttng_uri
*uris
)
2496 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2497 struct ltt_ust_session
*usess
= session
->ust_session
;
2503 /* Can't set consumer URI if the session is active. */
2504 if (session
->active
) {
2505 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2509 /* Set the "global" consumer URIs */
2510 for (i
= 0; i
< nb_uri
; i
++) {
2511 ret
= add_uri_to_consumer(session
->consumer
,
2512 &uris
[i
], 0, session
->name
);
2513 if (ret
!= LTTNG_OK
) {
2518 /* Set UST session URIs */
2519 if (session
->ust_session
) {
2520 for (i
= 0; i
< nb_uri
; i
++) {
2521 ret
= add_uri_to_consumer(
2522 session
->ust_session
->consumer
,
2523 &uris
[i
], LTTNG_DOMAIN_UST
,
2525 if (ret
!= LTTNG_OK
) {
2531 /* Set kernel session URIs */
2532 if (session
->kernel_session
) {
2533 for (i
= 0; i
< nb_uri
; i
++) {
2534 ret
= add_uri_to_consumer(
2535 session
->kernel_session
->consumer
,
2536 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2538 if (ret
!= LTTNG_OK
) {
2545 * Make sure to set the session in output mode after we set URI since a
2546 * session can be created without URL (thus flagged in no output mode).
2548 session
->output_traces
= 1;
2550 ksess
->output_traces
= 1;
2554 usess
->output_traces
= 1;
2565 * Command LTTNG_CREATE_SESSION processed by the client thread.
2567 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2568 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2571 struct ltt_session
*session
;
2577 * Verify if the session already exist
2579 * XXX: There is no need for the session lock list here since the caller
2580 * (process_client_msg) is holding it. We might want to change that so a
2581 * single command does not lock the entire session list.
2583 session
= session_find_by_name(name
);
2584 if (session
!= NULL
) {
2585 ret
= LTTNG_ERR_EXIST_SESS
;
2589 /* Create tracing session in the registry */
2590 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2591 LTTNG_SOCK_GET_GID_CRED(creds
));
2592 if (ret
!= LTTNG_OK
) {
2597 * Get the newly created session pointer back
2599 * XXX: There is no need for the session lock list here since the caller
2600 * (process_client_msg) is holding it. We might want to change that so a
2601 * single command does not lock the entire session list.
2603 session
= session_find_by_name(name
);
2606 session
->live_timer
= live_timer
;
2607 /* Create default consumer output for the session not yet created. */
2608 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2609 if (session
->consumer
== NULL
) {
2610 ret
= LTTNG_ERR_FATAL
;
2611 goto consumer_error
;
2615 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2616 if (ret
!= LTTNG_OK
) {
2617 goto consumer_error
;
2619 session
->output_traces
= 1;
2621 session
->output_traces
= 0;
2622 DBG2("Session %s created with no output", session
->name
);
2625 session
->consumer
->enabled
= 1;
2630 session_destroy(session
);
2637 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2639 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2640 size_t nb_uri
, lttng_sock_cred
*creds
)
2643 struct ltt_session
*session
;
2644 struct snapshot_output
*new_output
= NULL
;
2650 * Create session in no output mode with URIs set to NULL. The uris we've
2651 * received are for a default snapshot output if one.
2653 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2654 if (ret
!= LTTNG_OK
) {
2658 /* Get the newly created session pointer back. This should NEVER fail. */
2659 session
= session_find_by_name(name
);
2662 /* Flag session for snapshot mode. */
2663 session
->snapshot_mode
= 1;
2665 /* Skip snapshot output creation if no URI is given. */
2670 new_output
= snapshot_output_alloc();
2672 ret
= LTTNG_ERR_NOMEM
;
2673 goto error_snapshot_alloc
;
2676 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2677 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2679 if (ret
== -ENOMEM
) {
2680 ret
= LTTNG_ERR_NOMEM
;
2682 ret
= LTTNG_ERR_INVALID
;
2684 goto error_snapshot
;
2688 snapshot_add_output(&session
->snapshot
, new_output
);
2695 snapshot_output_destroy(new_output
);
2696 error_snapshot_alloc
:
2697 session_destroy(session
);
2703 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2705 * Called with session lock held.
2707 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2710 struct ltt_ust_session
*usess
;
2711 struct ltt_kernel_session
*ksess
;
2716 usess
= session
->ust_session
;
2717 ksess
= session
->kernel_session
;
2719 /* Clean kernel session teardown */
2720 kernel_destroy_session(ksess
);
2722 /* UST session teardown */
2724 /* Close any relayd session */
2725 consumer_output_send_destroy_relayd(usess
->consumer
);
2727 /* Destroy every UST application related to this session. */
2728 ret
= ust_app_destroy_trace_all(usess
);
2730 ERR("Error in ust_app_destroy_trace_all");
2733 /* Clean up the rest. */
2734 trace_ust_destroy_session(usess
);
2738 * Must notify the kernel thread here to update it's poll set in order to
2739 * remove the channel(s)' fd just destroyed.
2741 ret
= notify_thread_pipe(wpipe
);
2743 PERROR("write kernel poll pipe");
2746 ret
= session_destroy(session
);
2752 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2754 int cmd_register_consumer(struct ltt_session
*session
,
2755 enum lttng_domain_type domain
, const char *sock_path
,
2756 struct consumer_data
*cdata
)
2759 struct consumer_socket
*socket
= NULL
;
2766 case LTTNG_DOMAIN_KERNEL
:
2768 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2772 /* Can't register a consumer if there is already one */
2773 if (ksess
->consumer_fds_sent
!= 0) {
2774 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2778 sock
= lttcomm_connect_unix_sock(sock_path
);
2780 ret
= LTTNG_ERR_CONNECT_FAIL
;
2783 cdata
->cmd_sock
= sock
;
2785 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2786 if (socket
== NULL
) {
2789 PERROR("close register consumer");
2791 cdata
->cmd_sock
= -1;
2792 ret
= LTTNG_ERR_FATAL
;
2796 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2797 if (socket
->lock
== NULL
) {
2798 PERROR("zmalloc pthread mutex");
2799 ret
= LTTNG_ERR_FATAL
;
2802 pthread_mutex_init(socket
->lock
, NULL
);
2803 socket
->registered
= 1;
2806 consumer_add_socket(socket
, ksess
->consumer
);
2809 pthread_mutex_lock(&cdata
->pid_mutex
);
2811 pthread_mutex_unlock(&cdata
->pid_mutex
);
2816 /* TODO: Userspace tracing */
2817 ret
= LTTNG_ERR_UND
;
2825 consumer_destroy_socket(socket
);
2831 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2833 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2834 struct lttng_domain
**domains
)
2839 struct lttng_ht_iter iter
;
2841 if (session
->kernel_session
!= NULL
) {
2842 DBG3("Listing domains found kernel domain");
2846 if (session
->ust_session
!= NULL
) {
2847 DBG3("Listing domains found UST global domain");
2851 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2853 if (agt
->being_used
) {
2864 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2865 if (*domains
== NULL
) {
2866 ret
= LTTNG_ERR_FATAL
;
2870 if (session
->kernel_session
!= NULL
) {
2871 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2873 /* Kernel session buffer type is always GLOBAL */
2874 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2879 if (session
->ust_session
!= NULL
) {
2880 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2881 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2885 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2887 if (agt
->being_used
) {
2888 (*domains
)[index
].type
= agt
->domain
;
2889 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2899 /* Return negative value to differentiate return code */
2905 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2907 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2908 struct ltt_session
*session
, struct lttng_channel
**channels
)
2910 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
2913 case LTTNG_DOMAIN_KERNEL
:
2914 if (session
->kernel_session
!= NULL
) {
2915 nb_chan
= session
->kernel_session
->channel_count
;
2917 DBG3("Number of kernel channels %zd", nb_chan
);
2919 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2923 case LTTNG_DOMAIN_UST
:
2924 if (session
->ust_session
!= NULL
) {
2926 nb_chan
= lttng_ht_get_count(
2927 session
->ust_session
->domain_global
.channels
);
2930 DBG3("Number of UST global channels %zd", nb_chan
);
2932 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2937 ret
= -LTTNG_ERR_UND
;
2942 const size_t channel_size
= sizeof(struct lttng_channel
) +
2943 sizeof(struct lttcomm_channel_extended
);
2944 struct lttcomm_channel_extended
*channel_exts
;
2946 payload_size
= nb_chan
* channel_size
;
2947 *channels
= zmalloc(payload_size
);
2948 if (*channels
== NULL
) {
2949 ret
= -LTTNG_ERR_FATAL
;
2953 channel_exts
= ((void *) *channels
) +
2954 (nb_chan
* sizeof(struct lttng_channel
));
2955 list_lttng_channels(domain
, session
, *channels
, channel_exts
);
2966 * Command LTTNG_LIST_EVENTS processed by the client thread.
2968 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2969 struct ltt_session
*session
, char *channel_name
,
2970 struct lttng_event
**events
, size_t *total_size
)
2973 ssize_t nb_event
= 0;
2976 case LTTNG_DOMAIN_KERNEL
:
2977 if (session
->kernel_session
!= NULL
) {
2978 nb_event
= list_lttng_kernel_events(channel_name
,
2979 session
->kernel_session
, events
,
2983 case LTTNG_DOMAIN_UST
:
2985 if (session
->ust_session
!= NULL
) {
2986 nb_event
= list_lttng_ust_global_events(channel_name
,
2987 &session
->ust_session
->domain_global
, events
,
2992 case LTTNG_DOMAIN_LOG4J
:
2993 case LTTNG_DOMAIN_JUL
:
2994 case LTTNG_DOMAIN_PYTHON
:
2995 if (session
->ust_session
) {
2996 struct lttng_ht_iter iter
;
3000 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3001 &iter
.iter
, agt
, node
.node
) {
3002 if (agt
->domain
== domain
) {
3003 nb_event
= list_lttng_agent_events(
3013 ret
= LTTNG_ERR_UND
;
3020 /* Return negative value to differentiate return code */
3025 * Using the session list, filled a lttng_session array to send back to the
3026 * client for session listing.
3028 * The session list lock MUST be acquired before calling this function. Use
3029 * session_lock_list() and session_unlock_list().
3031 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3036 struct ltt_session
*session
;
3037 struct ltt_session_list
*list
= session_get_list();
3039 DBG("Getting all available session for UID %d GID %d",
3042 * Iterate over session list and append data after the control struct in
3045 cds_list_for_each_entry(session
, &list
->head
, list
) {
3047 * Only list the sessions the user can control.
3049 if (!session_access_ok(session
, uid
, gid
)) {
3053 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3054 struct ltt_ust_session
*usess
= session
->ust_session
;
3056 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3057 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3058 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3059 ret
= build_network_session_path(sessions
[i
].path
,
3060 sizeof(sessions
[i
].path
), session
);
3062 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3063 session
->consumer
->dst
.trace_path
);
3066 PERROR("snprintf session path");
3070 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3071 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3072 sessions
[i
].enabled
= session
->active
;
3073 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3074 sessions
[i
].live_timer_interval
= session
->live_timer
;
3080 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3081 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3083 int cmd_data_pending(struct ltt_session
*session
)
3086 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3087 struct ltt_ust_session
*usess
= session
->ust_session
;
3091 /* Session MUST be stopped to ask for data availability. */
3092 if (session
->active
) {
3093 ret
= LTTNG_ERR_SESSION_STARTED
;
3097 * If stopped, just make sure we've started before else the above call
3098 * will always send that there is data pending.
3100 * The consumer assumes that when the data pending command is received,
3101 * the trace has been started before or else no output data is written
3102 * by the streams which is a condition for data pending. So, this is
3103 * *VERY* important that we don't ask the consumer before a start
3106 if (!session
->has_been_started
) {
3112 if (ksess
&& ksess
->consumer
) {
3113 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3115 /* Data is still being extracted for the kernel. */
3120 if (usess
&& usess
->consumer
) {
3121 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3123 /* Data is still being extracted for the kernel. */
3128 /* Data is ready to be read by a viewer */
3136 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3138 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3140 int cmd_snapshot_add_output(struct ltt_session
*session
,
3141 struct lttng_snapshot_output
*output
, uint32_t *id
)
3144 struct snapshot_output
*new_output
;
3149 DBG("Cmd snapshot add output for session %s", session
->name
);
3152 * Can't create an output if the session is not set in no-output mode.
3154 if (session
->output_traces
) {
3155 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3159 /* Only one output is allowed until we have the "tee" feature. */
3160 if (session
->snapshot
.nb_output
== 1) {
3161 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3165 new_output
= snapshot_output_alloc();
3167 ret
= LTTNG_ERR_NOMEM
;
3171 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3172 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3173 &session
->snapshot
);
3175 if (ret
== -ENOMEM
) {
3176 ret
= LTTNG_ERR_NOMEM
;
3178 ret
= LTTNG_ERR_INVALID
;
3184 snapshot_add_output(&session
->snapshot
, new_output
);
3186 *id
= new_output
->id
;
3193 snapshot_output_destroy(new_output
);
3199 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3201 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3203 int cmd_snapshot_del_output(struct ltt_session
*session
,
3204 struct lttng_snapshot_output
*output
)
3207 struct snapshot_output
*sout
= NULL
;
3215 * Permission denied to create an output if the session is not
3216 * set in no output mode.
3218 if (session
->output_traces
) {
3219 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3224 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3226 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3227 } else if (*output
->name
!= '\0') {
3228 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3230 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3233 ret
= LTTNG_ERR_INVALID
;
3237 snapshot_delete_output(&session
->snapshot
, sout
);
3238 snapshot_output_destroy(sout
);
3247 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3249 * If no output is available, outputs is untouched and 0 is returned.
3251 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3253 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3254 struct lttng_snapshot_output
**outputs
)
3257 struct lttng_snapshot_output
*list
= NULL
;
3258 struct lttng_ht_iter iter
;
3259 struct snapshot_output
*output
;
3264 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3267 * Permission denied to create an output if the session is not
3268 * set in no output mode.
3270 if (session
->output_traces
) {
3271 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;