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>
32 #include <common/dynamic-buffer.h>
33 #include <common/buffer-view.h>
34 #include <lttng/trigger/trigger-internal.h>
35 #include <lttng/condition/condition.h>
36 #include <lttng/action/action.h>
37 #include <lttng/channel.h>
38 #include <lttng/channel-internal.h>
39 #include <common/string-utils/string-utils.h>
44 #include "health-sessiond.h"
46 #include "kernel-consumer.h"
47 #include "lttng-sessiond.h"
51 #include "buffer-registry.h"
52 #include "notification-thread.h"
53 #include "notification-thread-commands.h"
54 #include "rotation-thread.h"
59 * Used to keep a unique index for each relayd socket created where this value
60 * is associated with streams on the consumer so it can match the right relayd
61 * to send to. It must be accessed with the relayd_net_seq_idx_lock
64 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
65 static uint64_t relayd_net_seq_idx
;
67 static int validate_ust_event_name(const char *);
68 static int cmd_enable_event_internal(struct ltt_session
*session
,
69 struct lttng_domain
*domain
,
70 char *channel_name
, struct lttng_event
*event
,
71 char *filter_expression
,
72 struct lttng_filter_bytecode
*filter
,
73 struct lttng_event_exclusion
*exclusion
,
77 * Create a session path used by list_lttng_sessions for the case that the
78 * session consumer is on the network.
80 static int build_network_session_path(char *dst
, size_t size
,
81 struct ltt_session
*session
)
83 int ret
, kdata_port
, udata_port
;
84 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
85 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
90 memset(tmp_urls
, 0, sizeof(tmp_urls
));
91 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
93 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
95 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
96 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
97 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
100 if (session
->ust_session
&& session
->ust_session
->consumer
) {
101 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
102 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
105 if (uuri
== NULL
&& kuri
== NULL
) {
106 uri
= &session
->consumer
->dst
.net
.control
;
107 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
108 } else if (kuri
&& uuri
) {
109 ret
= uri_compare(kuri
, uuri
);
113 /* Build uuri URL string */
114 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
121 } else if (kuri
&& uuri
== NULL
) {
123 } else if (uuri
&& kuri
== NULL
) {
127 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
133 * Do we have a UST url set. If yes, this means we have both kernel and UST
136 if (*tmp_uurl
!= '\0') {
137 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
138 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
141 if (kuri
|| (!kuri
&& !uuri
)) {
144 /* No kernel URI, use the UST port. */
147 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
155 * Get run-time attributes if the session has been started (discarded events,
158 static int get_kernel_runtime_stats(struct ltt_session
*session
,
159 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
160 uint64_t *lost_packets
)
164 if (!session
->has_been_started
) {
166 *discarded_events
= 0;
171 ret
= consumer_get_discarded_events(session
->id
, kchan
->fd
,
172 session
->kernel_session
->consumer
,
178 ret
= consumer_get_lost_packets(session
->id
, kchan
->fd
,
179 session
->kernel_session
->consumer
,
190 * Get run-time attributes if the session has been started (discarded events,
193 static int get_ust_runtime_stats(struct ltt_session
*session
,
194 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
195 uint64_t *lost_packets
)
198 struct ltt_ust_session
*usess
;
200 if (!discarded_events
|| !lost_packets
) {
205 usess
= session
->ust_session
;
206 assert(discarded_events
);
207 assert(lost_packets
);
209 if (!usess
|| !session
->has_been_started
) {
210 *discarded_events
= 0;
216 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
217 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
218 &usess
->buffer_reg_uid_list
,
219 usess
->consumer
, uchan
->id
,
220 uchan
->attr
.overwrite
,
223 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
224 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
225 uchan
, usess
->consumer
,
226 uchan
->attr
.overwrite
,
232 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
233 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
235 ERR("Unsupported buffer type");
246 * Fill lttng_channel array of all channels.
248 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
249 struct ltt_session
*session
, struct lttng_channel
*channels
,
250 struct lttng_channel_extended
*chan_exts
)
253 struct ltt_kernel_channel
*kchan
;
255 DBG("Listing channels for session %s", session
->name
);
258 case LTTNG_DOMAIN_KERNEL
:
259 /* Kernel channels */
260 if (session
->kernel_session
!= NULL
) {
261 cds_list_for_each_entry(kchan
,
262 &session
->kernel_session
->channel_list
.head
, list
) {
263 uint64_t discarded_events
, lost_packets
;
264 struct lttng_channel_extended
*extended
;
266 extended
= (struct lttng_channel_extended
*)
267 kchan
->channel
->attr
.extended
.ptr
;
269 ret
= get_kernel_runtime_stats(session
, kchan
,
270 &discarded_events
, &lost_packets
);
274 /* Copy lttng_channel struct to array */
275 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
276 channels
[i
].enabled
= kchan
->enabled
;
277 chan_exts
[i
].discarded_events
=
279 chan_exts
[i
].lost_packets
= lost_packets
;
280 chan_exts
[i
].monitor_timer_interval
=
281 extended
->monitor_timer_interval
;
282 chan_exts
[i
].blocking_timeout
= 0;
287 case LTTNG_DOMAIN_UST
:
289 struct lttng_ht_iter iter
;
290 struct ltt_ust_channel
*uchan
;
293 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
294 &iter
.iter
, uchan
, node
.node
) {
295 uint64_t discarded_events
= 0, lost_packets
= 0;
297 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
298 LTTNG_SYMBOL_NAME_LEN
)) {
301 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
302 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
303 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
304 channels
[i
].attr
.switch_timer_interval
=
305 uchan
->attr
.switch_timer_interval
;
306 channels
[i
].attr
.read_timer_interval
=
307 uchan
->attr
.read_timer_interval
;
308 channels
[i
].enabled
= uchan
->enabled
;
309 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
310 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
313 * Map enum lttng_ust_output to enum lttng_event_output.
315 switch (uchan
->attr
.output
) {
317 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
321 * LTTNG_UST_MMAP is the only supported UST
328 chan_exts
[i
].monitor_timer_interval
=
329 uchan
->monitor_timer_interval
;
330 chan_exts
[i
].blocking_timeout
=
331 uchan
->attr
.u
.s
.blocking_timeout
;
333 ret
= get_ust_runtime_stats(session
, uchan
,
334 &discarded_events
, &lost_packets
);
338 chan_exts
[i
].discarded_events
= discarded_events
;
339 chan_exts
[i
].lost_packets
= lost_packets
;
351 return -LTTNG_ERR_FATAL
;
357 static void increment_extended_len(const char *filter_expression
,
358 struct lttng_event_exclusion
*exclusion
, size_t *extended_len
)
360 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
362 if (filter_expression
) {
363 *extended_len
+= strlen(filter_expression
) + 1;
367 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
371 static void append_extended_info(const char *filter_expression
,
372 struct lttng_event_exclusion
*exclusion
, void **extended_at
)
374 struct lttcomm_event_extended_header extended_header
;
375 size_t filter_len
= 0;
376 size_t nb_exclusions
= 0;
378 if (filter_expression
) {
379 filter_len
= strlen(filter_expression
) + 1;
383 nb_exclusions
= exclusion
->count
;
386 /* Set header fields */
387 extended_header
.filter_len
= filter_len
;
388 extended_header
.nb_exclusions
= nb_exclusions
;
391 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
392 *extended_at
+= sizeof(extended_header
);
394 /* Copy filter string */
395 if (filter_expression
) {
396 memcpy(*extended_at
, filter_expression
, filter_len
);
397 *extended_at
+= filter_len
;
400 /* Copy exclusion names */
402 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
404 memcpy(*extended_at
, &exclusion
->names
, len
);
410 * Create a list of agent domain events.
412 * Return number of events in list on success or else a negative value.
414 static int list_lttng_agent_events(struct agent
*agt
,
415 struct lttng_event
**events
, size_t *total_size
)
418 unsigned int nb_event
= 0;
419 struct agent_event
*event
;
420 struct lttng_event
*tmp_events
;
421 struct lttng_ht_iter iter
;
422 size_t extended_len
= 0;
428 DBG3("Listing agent events");
431 nb_event
= lttng_ht_get_count(agt
->events
);
439 /* Compute required extended infos size */
440 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
443 * This is only valid because the commands which add events are
444 * processed in the same thread as the listing.
447 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
448 increment_extended_len(event
->filter_expression
, NULL
,
453 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
454 tmp_events
= zmalloc(*total_size
);
456 PERROR("zmalloc agent events session");
457 ret
= -LTTNG_ERR_FATAL
;
461 extended_at
= ((uint8_t *) tmp_events
) +
462 nb_event
* sizeof(struct lttng_event
);
465 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
466 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
467 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
468 tmp_events
[i
].enabled
= event
->enabled
;
469 tmp_events
[i
].loglevel
= event
->loglevel_value
;
470 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
473 /* Append extended info */
474 append_extended_info(event
->filter_expression
, NULL
,
479 *events
= tmp_events
;
483 assert(nb_event
== i
);
488 * Create a list of ust global domain events.
490 static int list_lttng_ust_global_events(char *channel_name
,
491 struct ltt_ust_domain_global
*ust_global
,
492 struct lttng_event
**events
, size_t *total_size
)
495 unsigned int nb_event
= 0;
496 struct lttng_ht_iter iter
;
497 struct lttng_ht_node_str
*node
;
498 struct ltt_ust_channel
*uchan
;
499 struct ltt_ust_event
*uevent
;
500 struct lttng_event
*tmp
;
501 size_t extended_len
= 0;
504 DBG("Listing UST global events for channel %s", channel_name
);
508 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
509 node
= lttng_ht_iter_get_node_str(&iter
);
511 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
515 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
517 nb_event
= lttng_ht_get_count(uchan
->events
);
524 DBG3("Listing UST global %d events", nb_event
);
526 /* Compute required extended infos size */
527 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
528 if (uevent
->internal
) {
533 increment_extended_len(uevent
->filter_expression
,
534 uevent
->exclusion
, &extended_len
);
537 /* All events are internal, skip. */
543 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
544 tmp
= zmalloc(*total_size
);
546 ret
= -LTTNG_ERR_FATAL
;
550 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
552 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
553 if (uevent
->internal
) {
554 /* This event should remain hidden from clients */
557 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
558 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
559 tmp
[i
].enabled
= uevent
->enabled
;
561 switch (uevent
->attr
.instrumentation
) {
562 case LTTNG_UST_TRACEPOINT
:
563 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
565 case LTTNG_UST_PROBE
:
566 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
568 case LTTNG_UST_FUNCTION
:
569 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
573 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
574 switch (uevent
->attr
.loglevel_type
) {
575 case LTTNG_UST_LOGLEVEL_ALL
:
576 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
578 case LTTNG_UST_LOGLEVEL_RANGE
:
579 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
581 case LTTNG_UST_LOGLEVEL_SINGLE
:
582 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
585 if (uevent
->filter
) {
588 if (uevent
->exclusion
) {
589 tmp
[i
].exclusion
= 1;
593 /* Append extended info */
594 append_extended_info(uevent
->filter_expression
,
595 uevent
->exclusion
, &extended_at
);
606 * Fill lttng_event array of all kernel events in the channel.
608 static int list_lttng_kernel_events(char *channel_name
,
609 struct ltt_kernel_session
*kernel_session
,
610 struct lttng_event
**events
, size_t *total_size
)
613 unsigned int nb_event
;
614 struct ltt_kernel_event
*event
;
615 struct ltt_kernel_channel
*kchan
;
616 size_t extended_len
= 0;
619 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
621 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
625 nb_event
= kchan
->event_count
;
627 DBG("Listing events for channel %s", kchan
->channel
->name
);
635 /* Compute required extended infos size */
636 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
637 increment_extended_len(event
->filter_expression
, NULL
,
641 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
642 *events
= zmalloc(*total_size
);
643 if (*events
== NULL
) {
644 ret
= LTTNG_ERR_FATAL
;
648 extended_at
= ((void *) *events
) +
649 nb_event
* sizeof(struct lttng_event
);
651 /* Kernel channels */
652 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
653 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
654 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
655 (*events
)[i
].enabled
= event
->enabled
;
656 (*events
)[i
].filter
=
657 (unsigned char) !!event
->filter_expression
;
659 switch (event
->event
->instrumentation
) {
660 case LTTNG_KERNEL_TRACEPOINT
:
661 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
663 case LTTNG_KERNEL_KRETPROBE
:
664 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
665 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
666 sizeof(struct lttng_kernel_kprobe
));
668 case LTTNG_KERNEL_KPROBE
:
669 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
670 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
671 sizeof(struct lttng_kernel_kprobe
));
673 case LTTNG_KERNEL_FUNCTION
:
674 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
675 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
676 sizeof(struct lttng_kernel_function
));
678 case LTTNG_KERNEL_NOOP
:
679 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
681 case LTTNG_KERNEL_SYSCALL
:
682 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
684 case LTTNG_KERNEL_ALL
:
690 /* Append extended info */
691 append_extended_info(event
->filter_expression
, NULL
,
699 /* Negate the error code to differentiate the size from an error */
704 * Add URI so the consumer output object. Set the correct path depending on the
705 * domain adding the default trace directory.
707 static int add_uri_to_consumer(struct consumer_output
*consumer
,
708 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
709 const char *session_name
)
712 const char *default_trace_dir
;
716 if (consumer
== NULL
) {
717 DBG("No consumer detected. Don't add URI. Stopping.");
718 ret
= LTTNG_ERR_NO_CONSUMER
;
723 case LTTNG_DOMAIN_KERNEL
:
724 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
726 case LTTNG_DOMAIN_UST
:
727 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
731 * This case is possible is we try to add the URI to the global tracing
732 * session consumer object which in this case there is no subdir.
734 default_trace_dir
= "";
737 switch (uri
->dtype
) {
740 DBG2("Setting network URI to consumer");
742 if (consumer
->type
== CONSUMER_DST_NET
) {
743 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
744 consumer
->dst
.net
.control_isset
) ||
745 (uri
->stype
== LTTNG_STREAM_DATA
&&
746 consumer
->dst
.net
.data_isset
)) {
747 ret
= LTTNG_ERR_URL_EXIST
;
751 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
754 consumer
->type
= CONSUMER_DST_NET
;
756 /* Set URI into consumer output object */
757 ret
= consumer_set_network_uri(consumer
, uri
);
761 } else if (ret
== 1) {
763 * URI was the same in the consumer so we do not append the subdir
764 * again so to not duplicate output dir.
770 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
771 ret
= consumer_set_subdir(consumer
, session_name
);
773 ret
= LTTNG_ERR_FATAL
;
778 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
779 /* On a new subdir, reappend the default trace dir. */
780 strncat(consumer
->subdir
, default_trace_dir
,
781 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
782 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
787 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
788 memset(consumer
->dst
.session_root_path
, 0,
789 sizeof(consumer
->dst
.session_root_path
));
790 /* Explicit length checks for strcpy and strcat. */
791 if (strlen(uri
->dst
.path
) + strlen(default_trace_dir
)
792 >= sizeof(consumer
->dst
.session_root_path
)) {
793 ret
= LTTNG_ERR_FATAL
;
796 strcpy(consumer
->dst
.session_root_path
, uri
->dst
.path
);
797 /* Append default trace dir */
798 strcat(consumer
->dst
.session_root_path
, default_trace_dir
);
799 /* Flag consumer as local. */
800 consumer
->type
= CONSUMER_DST_LOCAL
;
811 * Init tracing by creating trace directory and sending fds kernel consumer.
813 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
816 struct lttng_ht_iter iter
;
817 struct consumer_socket
*socket
;
823 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
824 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
826 pthread_mutex_lock(socket
->lock
);
827 ret
= kernel_consumer_send_session(socket
, session
);
828 pthread_mutex_unlock(socket
->lock
);
830 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
842 * Create a socket to the relayd using the URI.
844 * On success, the relayd_sock pointer is set to the created socket.
845 * Else, it's stays untouched and a lttcomm error code is returned.
847 static int create_connect_relayd(struct lttng_uri
*uri
,
848 struct lttcomm_relayd_sock
**relayd_sock
,
849 struct consumer_output
*consumer
)
852 struct lttcomm_relayd_sock
*rsock
;
854 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
855 RELAYD_VERSION_COMM_MINOR
);
857 ret
= LTTNG_ERR_FATAL
;
862 * Connect to relayd so we can proceed with a session creation. This call
863 * can possibly block for an arbitrary amount of time to set the health
864 * state to be in poll execution.
867 ret
= relayd_connect(rsock
);
870 ERR("Unable to reach lttng-relayd");
871 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
875 /* Create socket for control stream. */
876 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
877 DBG3("Creating relayd stream socket from URI");
879 /* Check relayd version */
880 ret
= relayd_version_check(rsock
);
882 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
885 consumer
->relay_major_version
= rsock
->major
;
886 consumer
->relay_minor_version
= rsock
->minor
;
887 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
888 DBG3("Creating relayd data socket from URI");
890 /* Command is not valid */
891 ERR("Relayd invalid stream type: %d", uri
->stype
);
892 ret
= LTTNG_ERR_INVALID
;
896 *relayd_sock
= rsock
;
901 /* The returned value is not useful since we are on an error path. */
902 (void) relayd_close(rsock
);
910 * Connect to the relayd using URI and send the socket to the right consumer.
912 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
913 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
914 struct consumer_output
*consumer
,
915 struct consumer_socket
*consumer_sock
,
916 char *session_name
, char *hostname
, int session_live_timer
)
919 struct lttcomm_relayd_sock
*rsock
= NULL
;
921 /* Connect to relayd and make version check if uri is the control. */
922 ret
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
923 if (ret
!= LTTNG_OK
) {
928 /* Set the network sequence index if not set. */
929 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
930 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
932 * Increment net_seq_idx because we are about to transfer the
933 * new relayd socket to the consumer.
934 * Assign unique key so the consumer can match streams.
936 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
937 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
940 /* Send relayd socket to consumer. */
941 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
942 relayd_uri
->stype
, session_id
,
943 session_name
, hostname
, session_live_timer
);
945 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
949 /* Flag that the corresponding socket was sent. */
950 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
951 consumer_sock
->control_sock_sent
= 1;
952 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
953 consumer_sock
->data_sock_sent
= 1;
959 * Close socket which was dup on the consumer side. The session daemon does
960 * NOT keep track of the relayd socket(s) once transfer to the consumer.
964 (void) relayd_close(rsock
);
968 if (ret
!= LTTNG_OK
) {
970 * The consumer output for this session should not be used anymore
971 * since the relayd connection failed thus making any tracing or/and
972 * streaming not usable.
974 consumer
->enabled
= 0;
980 * Send both relayd sockets to a specific consumer and domain. This is a
981 * helper function to facilitate sending the information to the consumer for a
984 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
985 unsigned int session_id
, struct consumer_output
*consumer
,
986 struct consumer_socket
*sock
, char *session_name
,
987 char *hostname
, int session_live_timer
)
994 /* Sending control relayd socket. */
995 if (!sock
->control_sock_sent
) {
996 ret
= send_consumer_relayd_socket(domain
, session_id
,
997 &consumer
->dst
.net
.control
, consumer
, sock
,
998 session_name
, hostname
, session_live_timer
);
999 if (ret
!= LTTNG_OK
) {
1004 /* Sending data relayd socket. */
1005 if (!sock
->data_sock_sent
) {
1006 ret
= send_consumer_relayd_socket(domain
, session_id
,
1007 &consumer
->dst
.net
.data
, consumer
, sock
,
1008 session_name
, hostname
, session_live_timer
);
1009 if (ret
!= LTTNG_OK
) {
1019 * Setup relayd connections for a tracing session. First creates the socket to
1020 * the relayd and send them to the right domain consumer. Consumer type MUST be
1023 int cmd_setup_relayd(struct ltt_session
*session
)
1026 struct ltt_ust_session
*usess
;
1027 struct ltt_kernel_session
*ksess
;
1028 struct consumer_socket
*socket
;
1029 struct lttng_ht_iter iter
;
1033 usess
= session
->ust_session
;
1034 ksess
= session
->kernel_session
;
1036 DBG("Setting relayd for session %s", session
->name
);
1040 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1041 && usess
->consumer
->enabled
) {
1042 /* For each consumer socket, send relayd sockets */
1043 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1044 socket
, node
.node
) {
1045 pthread_mutex_lock(socket
->lock
);
1046 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1047 usess
->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 usess
->consumer
->relay_major_version
;
1059 session
->consumer
->relay_minor_version
=
1060 usess
->consumer
->relay_minor_version
;
1063 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1064 && ksess
->consumer
->enabled
) {
1065 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1066 socket
, node
.node
) {
1067 pthread_mutex_lock(socket
->lock
);
1068 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1069 ksess
->consumer
, socket
,
1070 session
->name
, session
->hostname
,
1071 session
->live_timer
);
1072 pthread_mutex_unlock(socket
->lock
);
1073 if (ret
!= LTTNG_OK
) {
1076 /* Session is now ready for network streaming. */
1077 session
->net_handle
= 1;
1079 session
->consumer
->relay_major_version
=
1080 ksess
->consumer
->relay_major_version
;
1081 session
->consumer
->relay_minor_version
=
1082 ksess
->consumer
->relay_minor_version
;
1091 * Start a kernel session by opening all necessary streams.
1093 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
1096 struct ltt_kernel_channel
*kchan
;
1098 /* Open kernel metadata */
1099 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1100 ret
= kernel_open_metadata(ksess
);
1102 ret
= LTTNG_ERR_KERN_META_FAIL
;
1107 /* Open kernel metadata stream */
1108 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1109 ret
= kernel_open_metadata_stream(ksess
);
1111 ERR("Kernel create metadata stream failed");
1112 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1117 /* For each channel */
1118 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1119 if (kchan
->stream_count
== 0) {
1120 ret
= kernel_open_channel_stream(kchan
);
1122 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1125 /* Update the stream global counter */
1126 ksess
->stream_count_global
+= ret
;
1130 /* Setup kernel consumer socket and send fds to it */
1131 ret
= init_kernel_tracing(ksess
);
1133 ret
= LTTNG_ERR_KERN_START_FAIL
;
1137 /* This start the kernel tracing */
1138 ret
= kernel_start_session(ksess
);
1140 ret
= LTTNG_ERR_KERN_START_FAIL
;
1144 /* Quiescent wait after starting trace */
1145 kernel_wait_quiescent(kernel_tracer_fd
);
1156 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1158 int cmd_disable_channel(struct ltt_session
*session
,
1159 enum lttng_domain_type domain
, char *channel_name
)
1162 struct ltt_ust_session
*usess
;
1164 usess
= session
->ust_session
;
1169 case LTTNG_DOMAIN_KERNEL
:
1171 ret
= channel_kernel_disable(session
->kernel_session
,
1173 if (ret
!= LTTNG_OK
) {
1177 kernel_wait_quiescent(kernel_tracer_fd
);
1180 case LTTNG_DOMAIN_UST
:
1182 struct ltt_ust_channel
*uchan
;
1183 struct lttng_ht
*chan_ht
;
1185 chan_ht
= usess
->domain_global
.channels
;
1187 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1188 if (uchan
== NULL
) {
1189 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1193 ret
= channel_ust_disable(usess
, uchan
);
1194 if (ret
!= LTTNG_OK
) {
1200 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1212 * Command LTTNG_TRACK_PID processed by the client thread.
1214 * Called with session lock held.
1216 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1224 case LTTNG_DOMAIN_KERNEL
:
1226 struct ltt_kernel_session
*ksess
;
1228 ksess
= session
->kernel_session
;
1230 ret
= kernel_track_pid(ksess
, pid
);
1231 if (ret
!= LTTNG_OK
) {
1235 kernel_wait_quiescent(kernel_tracer_fd
);
1238 case LTTNG_DOMAIN_UST
:
1240 struct ltt_ust_session
*usess
;
1242 usess
= session
->ust_session
;
1244 ret
= trace_ust_track_pid(usess
, pid
);
1245 if (ret
!= LTTNG_OK
) {
1251 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1263 * Command LTTNG_UNTRACK_PID processed by the client thread.
1265 * Called with session lock held.
1267 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
1275 case LTTNG_DOMAIN_KERNEL
:
1277 struct ltt_kernel_session
*ksess
;
1279 ksess
= session
->kernel_session
;
1281 ret
= kernel_untrack_pid(ksess
, pid
);
1282 if (ret
!= LTTNG_OK
) {
1286 kernel_wait_quiescent(kernel_tracer_fd
);
1289 case LTTNG_DOMAIN_UST
:
1291 struct ltt_ust_session
*usess
;
1293 usess
= session
->ust_session
;
1295 ret
= trace_ust_untrack_pid(usess
, pid
);
1296 if (ret
!= LTTNG_OK
) {
1302 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1314 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1316 * The wpipe arguments is used as a notifier for the kernel thread.
1318 int cmd_enable_channel(struct ltt_session
*session
,
1319 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1322 struct ltt_ust_session
*usess
= session
->ust_session
;
1323 struct lttng_ht
*chan_ht
;
1330 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1332 /* Validate channel name */
1333 if (attr
->name
[0] == '.' ||
1334 memchr(attr
->name
, '/', len
) != NULL
) {
1335 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1339 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1344 * Don't try to enable a channel if the session has been started at
1345 * some point in time before. The tracer does not allow it.
1347 if (session
->has_been_started
) {
1348 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1353 * If the session is a live session, remove the switch timer, the
1354 * live timer does the same thing but sends also synchronisation
1355 * beacons for inactive streams.
1357 if (session
->live_timer
> 0) {
1358 attr
->attr
.live_timer_interval
= session
->live_timer
;
1359 attr
->attr
.switch_timer_interval
= 0;
1362 /* Check for feature support */
1363 switch (domain
->type
) {
1364 case LTTNG_DOMAIN_KERNEL
:
1366 if (kernel_supports_ring_buffer_snapshot_sample_positions(kernel_tracer_fd
) != 1) {
1367 /* Sampling position of buffer is not supported */
1368 WARN("Kernel tracer does not support buffer monitoring. "
1369 "Setting the monitor interval timer to 0 "
1370 "(disabled) for channel '%s' of session '%s'",
1371 attr
-> name
, session
->name
);
1372 lttng_channel_set_monitor_timer_interval(attr
, 0);
1376 case LTTNG_DOMAIN_UST
:
1377 case LTTNG_DOMAIN_JUL
:
1378 case LTTNG_DOMAIN_LOG4J
:
1379 case LTTNG_DOMAIN_PYTHON
:
1382 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1386 switch (domain
->type
) {
1387 case LTTNG_DOMAIN_KERNEL
:
1389 struct ltt_kernel_channel
*kchan
;
1391 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1392 session
->kernel_session
);
1393 if (kchan
== NULL
) {
1394 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1395 if (attr
->name
[0] != '\0') {
1396 session
->kernel_session
->has_non_default_channel
= 1;
1399 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1402 if (ret
!= LTTNG_OK
) {
1406 kernel_wait_quiescent(kernel_tracer_fd
);
1409 case LTTNG_DOMAIN_UST
:
1410 case LTTNG_DOMAIN_JUL
:
1411 case LTTNG_DOMAIN_LOG4J
:
1412 case LTTNG_DOMAIN_PYTHON
:
1414 struct ltt_ust_channel
*uchan
;
1419 * Current agent implementation limitations force us to allow
1420 * only one channel at once in "agent" subdomains. Each
1421 * subdomain has a default channel name which must be strictly
1424 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1425 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1426 LTTNG_SYMBOL_NAME_LEN
)) {
1427 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1430 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1431 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1432 LTTNG_SYMBOL_NAME_LEN
)) {
1433 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1436 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1437 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1438 LTTNG_SYMBOL_NAME_LEN
)) {
1439 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1444 chan_ht
= usess
->domain_global
.channels
;
1446 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1447 if (uchan
== NULL
) {
1448 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1449 if (attr
->name
[0] != '\0') {
1450 usess
->has_non_default_channel
= 1;
1453 ret
= channel_ust_enable(usess
, uchan
);
1458 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1469 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1471 int cmd_disable_event(struct ltt_session
*session
,
1472 enum lttng_domain_type domain
, char *channel_name
,
1473 struct lttng_event
*event
)
1478 DBG("Disable event command for event \'%s\'", event
->name
);
1480 event_name
= event
->name
;
1482 /* Error out on unhandled search criteria */
1483 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1484 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1485 ret
= LTTNG_ERR_UNK
;
1492 case LTTNG_DOMAIN_KERNEL
:
1494 struct ltt_kernel_channel
*kchan
;
1495 struct ltt_kernel_session
*ksess
;
1497 ksess
= session
->kernel_session
;
1500 * If a non-default channel has been created in the
1501 * session, explicitely require that -c chan_name needs
1504 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1505 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1509 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1510 if (kchan
== NULL
) {
1511 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1515 switch (event
->type
) {
1516 case LTTNG_EVENT_ALL
:
1517 case LTTNG_EVENT_TRACEPOINT
:
1518 case LTTNG_EVENT_SYSCALL
:
1519 case LTTNG_EVENT_PROBE
:
1520 case LTTNG_EVENT_FUNCTION
:
1521 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1522 if (event_name
[0] == '\0') {
1523 ret
= event_kernel_disable_event(kchan
,
1526 ret
= event_kernel_disable_event(kchan
,
1527 event_name
, event
->type
);
1529 if (ret
!= LTTNG_OK
) {
1534 ret
= LTTNG_ERR_UNK
;
1538 kernel_wait_quiescent(kernel_tracer_fd
);
1541 case LTTNG_DOMAIN_UST
:
1543 struct ltt_ust_channel
*uchan
;
1544 struct ltt_ust_session
*usess
;
1546 usess
= session
->ust_session
;
1548 if (validate_ust_event_name(event_name
)) {
1549 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1554 * If a non-default channel has been created in the
1555 * session, explicitly require that -c chan_name needs
1558 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1559 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1563 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1565 if (uchan
== NULL
) {
1566 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1570 switch (event
->type
) {
1571 case LTTNG_EVENT_ALL
:
1573 * An empty event name means that everything
1574 * should be disabled.
1576 if (event
->name
[0] == '\0') {
1577 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1579 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1582 if (ret
!= LTTNG_OK
) {
1587 ret
= LTTNG_ERR_UNK
;
1591 DBG3("Disable UST event %s in channel %s completed", event_name
,
1595 case LTTNG_DOMAIN_LOG4J
:
1596 case LTTNG_DOMAIN_JUL
:
1597 case LTTNG_DOMAIN_PYTHON
:
1600 struct ltt_ust_session
*usess
= session
->ust_session
;
1604 switch (event
->type
) {
1605 case LTTNG_EVENT_ALL
:
1608 ret
= LTTNG_ERR_UNK
;
1612 agt
= trace_ust_find_agent(usess
, domain
);
1614 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1618 * An empty event name means that everything
1619 * should be disabled.
1621 if (event
->name
[0] == '\0') {
1622 ret
= event_agent_disable_all(usess
, agt
);
1624 ret
= event_agent_disable(usess
, agt
, event_name
);
1626 if (ret
!= LTTNG_OK
) {
1633 ret
= LTTNG_ERR_UND
;
1646 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1648 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1649 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1651 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1652 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1654 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1655 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1656 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1660 case LTTNG_DOMAIN_KERNEL
:
1661 assert(session
->kernel_session
);
1663 if (session
->kernel_session
->channel_count
== 0) {
1664 /* Create default channel */
1665 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1666 if (ret
!= LTTNG_OK
) {
1669 chan_kern_created
= 1;
1671 /* Add kernel context to kernel tracer */
1672 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1673 if (ret
!= LTTNG_OK
) {
1677 case LTTNG_DOMAIN_JUL
:
1678 case LTTNG_DOMAIN_LOG4J
:
1681 * Validate channel name.
1682 * If no channel name is given and the domain is JUL or LOG4J,
1683 * set it to the appropriate domain-specific channel name. If
1684 * a name is provided but does not match the expexted channel
1685 * name, return an error.
1687 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1688 strcmp(channel_name
,
1689 DEFAULT_JUL_CHANNEL_NAME
)) {
1690 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1692 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1693 strcmp(channel_name
,
1694 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1695 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1698 /* break is _not_ missing here. */
1700 case LTTNG_DOMAIN_UST
:
1702 struct ltt_ust_session
*usess
= session
->ust_session
;
1703 unsigned int chan_count
;
1707 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1708 if (chan_count
== 0) {
1709 struct lttng_channel
*attr
;
1710 /* Create default channel */
1711 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1713 ret
= LTTNG_ERR_FATAL
;
1717 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1718 if (ret
!= LTTNG_OK
) {
1722 channel_attr_destroy(attr
);
1723 chan_ust_created
= 1;
1726 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1727 free(app_ctx_provider_name
);
1729 app_ctx_name
= NULL
;
1730 app_ctx_provider_name
= NULL
;
1731 if (ret
!= LTTNG_OK
) {
1737 ret
= LTTNG_ERR_UND
;
1745 if (chan_kern_created
) {
1746 struct ltt_kernel_channel
*kchan
=
1747 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1748 session
->kernel_session
);
1749 /* Created previously, this should NOT fail. */
1751 kernel_destroy_channel(kchan
);
1754 if (chan_ust_created
) {
1755 struct ltt_ust_channel
*uchan
=
1756 trace_ust_find_channel_by_name(
1757 session
->ust_session
->domain_global
.channels
,
1758 DEFAULT_CHANNEL_NAME
);
1759 /* Created previously, this should NOT fail. */
1761 /* Remove from the channel list of the session. */
1762 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1764 trace_ust_destroy_channel(uchan
);
1767 free(app_ctx_provider_name
);
1772 static inline bool name_starts_with(const char *name
, const char *prefix
)
1774 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1776 return !strncmp(name
, prefix
, max_cmp_len
);
1779 /* Perform userspace-specific event name validation */
1780 static int validate_ust_event_name(const char *name
)
1790 * Check name against all internal UST event component namespaces used
1793 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1794 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1795 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1804 * Internal version of cmd_enable_event() with a supplemental
1805 * "internal_event" flag which is used to enable internal events which should
1806 * be hidden from clients. Such events are used in the agent implementation to
1807 * enable the events through which all "agent" events are funeled.
1809 static int _cmd_enable_event(struct ltt_session
*session
,
1810 struct lttng_domain
*domain
,
1811 char *channel_name
, struct lttng_event
*event
,
1812 char *filter_expression
,
1813 struct lttng_filter_bytecode
*filter
,
1814 struct lttng_event_exclusion
*exclusion
,
1815 int wpipe
, bool internal_event
)
1817 int ret
= 0, channel_created
= 0;
1818 struct lttng_channel
*attr
= NULL
;
1822 assert(channel_name
);
1824 /* If we have a filter, we must have its filter expression */
1825 assert(!(!!filter_expression
^ !!filter
));
1827 /* Normalize event name as a globbing pattern */
1828 strutils_normalize_star_glob_pattern(event
->name
);
1830 /* Normalize exclusion names as globbing patterns */
1834 for (i
= 0; i
< exclusion
->count
; i
++) {
1835 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
1837 strutils_normalize_star_glob_pattern(name
);
1841 DBG("Enable event command for event \'%s\'", event
->name
);
1845 switch (domain
->type
) {
1846 case LTTNG_DOMAIN_KERNEL
:
1848 struct ltt_kernel_channel
*kchan
;
1851 * If a non-default channel has been created in the
1852 * session, explicitely require that -c chan_name needs
1855 if (session
->kernel_session
->has_non_default_channel
1856 && channel_name
[0] == '\0') {
1857 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1861 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1862 session
->kernel_session
);
1863 if (kchan
== NULL
) {
1864 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1865 LTTNG_BUFFER_GLOBAL
);
1867 ret
= LTTNG_ERR_FATAL
;
1870 if (lttng_strncpy(attr
->name
, channel_name
,
1871 sizeof(attr
->name
))) {
1872 ret
= LTTNG_ERR_INVALID
;
1876 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1877 if (ret
!= LTTNG_OK
) {
1880 channel_created
= 1;
1883 /* Get the newly created kernel channel pointer */
1884 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1885 session
->kernel_session
);
1886 if (kchan
== NULL
) {
1887 /* This sould not happen... */
1888 ret
= LTTNG_ERR_FATAL
;
1892 switch (event
->type
) {
1893 case LTTNG_EVENT_ALL
:
1895 char *filter_expression_a
= NULL
;
1896 struct lttng_filter_bytecode
*filter_a
= NULL
;
1899 * We need to duplicate filter_expression and filter,
1900 * because ownership is passed to first enable
1903 if (filter_expression
) {
1904 filter_expression_a
= strdup(filter_expression
);
1905 if (!filter_expression_a
) {
1906 ret
= LTTNG_ERR_FATAL
;
1911 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1913 free(filter_expression_a
);
1914 ret
= LTTNG_ERR_FATAL
;
1917 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1919 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1920 ret
= event_kernel_enable_event(kchan
, event
,
1921 filter_expression
, filter
);
1922 /* We have passed ownership */
1923 filter_expression
= NULL
;
1925 if (ret
!= LTTNG_OK
) {
1926 if (channel_created
) {
1927 /* Let's not leak a useless channel. */
1928 kernel_destroy_channel(kchan
);
1930 free(filter_expression_a
);
1934 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1935 ret
= event_kernel_enable_event(kchan
, event
,
1936 filter_expression_a
, filter_a
);
1937 /* We have passed ownership */
1938 filter_expression_a
= NULL
;
1940 if (ret
!= LTTNG_OK
) {
1945 case LTTNG_EVENT_PROBE
:
1946 case LTTNG_EVENT_FUNCTION
:
1947 case LTTNG_EVENT_FUNCTION_ENTRY
:
1948 case LTTNG_EVENT_TRACEPOINT
:
1949 ret
= event_kernel_enable_event(kchan
, event
,
1950 filter_expression
, filter
);
1951 /* We have passed ownership */
1952 filter_expression
= NULL
;
1954 if (ret
!= LTTNG_OK
) {
1955 if (channel_created
) {
1956 /* Let's not leak a useless channel. */
1957 kernel_destroy_channel(kchan
);
1962 case LTTNG_EVENT_SYSCALL
:
1963 ret
= event_kernel_enable_event(kchan
, event
,
1964 filter_expression
, filter
);
1965 /* We have passed ownership */
1966 filter_expression
= NULL
;
1968 if (ret
!= LTTNG_OK
) {
1973 ret
= LTTNG_ERR_UNK
;
1977 kernel_wait_quiescent(kernel_tracer_fd
);
1980 case LTTNG_DOMAIN_UST
:
1982 struct ltt_ust_channel
*uchan
;
1983 struct ltt_ust_session
*usess
= session
->ust_session
;
1988 * If a non-default channel has been created in the
1989 * session, explicitely require that -c chan_name needs
1992 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1993 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1997 /* Get channel from global UST domain */
1998 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2000 if (uchan
== NULL
) {
2001 /* Create default channel */
2002 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2003 usess
->buffer_type
);
2005 ret
= LTTNG_ERR_FATAL
;
2008 if (lttng_strncpy(attr
->name
, channel_name
,
2009 sizeof(attr
->name
))) {
2010 ret
= LTTNG_ERR_INVALID
;
2014 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2015 if (ret
!= LTTNG_OK
) {
2019 /* Get the newly created channel reference back */
2020 uchan
= trace_ust_find_channel_by_name(
2021 usess
->domain_global
.channels
, channel_name
);
2025 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2027 * Don't allow users to add UST events to channels which
2028 * are assigned to a userspace subdomain (JUL, Log4J,
2031 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2035 if (!internal_event
) {
2037 * Ensure the event name is not reserved for internal
2040 ret
= validate_ust_event_name(event
->name
);
2042 WARN("Userspace event name %s failed validation.",
2044 event
->name
: "NULL");
2045 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2050 /* At this point, the session and channel exist on the tracer */
2051 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2052 filter_expression
, filter
, exclusion
,
2054 /* We have passed ownership */
2055 filter_expression
= NULL
;
2058 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2059 goto already_enabled
;
2060 } else if (ret
!= LTTNG_OK
) {
2065 case LTTNG_DOMAIN_LOG4J
:
2066 case LTTNG_DOMAIN_JUL
:
2067 case LTTNG_DOMAIN_PYTHON
:
2069 const char *default_event_name
, *default_chan_name
;
2071 struct lttng_event uevent
;
2072 struct lttng_domain tmp_dom
;
2073 struct ltt_ust_session
*usess
= session
->ust_session
;
2077 agt
= trace_ust_find_agent(usess
, domain
->type
);
2079 agt
= agent_create(domain
->type
);
2081 ret
= LTTNG_ERR_NOMEM
;
2084 agent_add(agt
, usess
->agents
);
2087 /* Create the default tracepoint. */
2088 memset(&uevent
, 0, sizeof(uevent
));
2089 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2090 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2091 default_event_name
= event_get_default_agent_ust_name(
2093 if (!default_event_name
) {
2094 ret
= LTTNG_ERR_FATAL
;
2097 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2098 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2101 * The domain type is changed because we are about to enable the
2102 * default channel and event for the JUL domain that are hardcoded.
2103 * This happens in the UST domain.
2105 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2106 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2108 switch (domain
->type
) {
2109 case LTTNG_DOMAIN_LOG4J
:
2110 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2112 case LTTNG_DOMAIN_JUL
:
2113 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2115 case LTTNG_DOMAIN_PYTHON
:
2116 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2119 /* The switch/case we are in makes this impossible */
2124 char *filter_expression_copy
= NULL
;
2125 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2128 const size_t filter_size
= sizeof(
2129 struct lttng_filter_bytecode
)
2132 filter_copy
= zmalloc(filter_size
);
2134 ret
= LTTNG_ERR_NOMEM
;
2137 memcpy(filter_copy
, filter
, filter_size
);
2139 filter_expression_copy
=
2140 strdup(filter_expression
);
2141 if (!filter_expression
) {
2142 ret
= LTTNG_ERR_NOMEM
;
2145 if (!filter_expression_copy
|| !filter_copy
) {
2146 free(filter_expression_copy
);
2152 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2153 (char *) default_chan_name
,
2154 &uevent
, filter_expression_copy
,
2155 filter_copy
, NULL
, wpipe
);
2158 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2159 goto already_enabled
;
2160 } else if (ret
!= LTTNG_OK
) {
2164 /* The wild card * means that everything should be enabled. */
2165 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2166 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2169 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2173 filter_expression
= NULL
;
2174 if (ret
!= LTTNG_OK
) {
2181 ret
= LTTNG_ERR_UND
;
2189 free(filter_expression
);
2192 channel_attr_destroy(attr
);
2198 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2199 * We own filter, exclusion, and filter_expression.
2201 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
2202 char *channel_name
, struct lttng_event
*event
,
2203 char *filter_expression
,
2204 struct lttng_filter_bytecode
*filter
,
2205 struct lttng_event_exclusion
*exclusion
,
2208 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2209 filter_expression
, filter
, exclusion
, wpipe
, false);
2213 * Enable an event which is internal to LTTng. An internal should
2214 * never be made visible to clients and are immune to checks such as
2217 static int cmd_enable_event_internal(struct ltt_session
*session
,
2218 struct lttng_domain
*domain
,
2219 char *channel_name
, struct lttng_event
*event
,
2220 char *filter_expression
,
2221 struct lttng_filter_bytecode
*filter
,
2222 struct lttng_event_exclusion
*exclusion
,
2225 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2226 filter_expression
, filter
, exclusion
, wpipe
, true);
2230 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2232 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2233 struct lttng_event
**events
)
2236 ssize_t nb_events
= 0;
2239 case LTTNG_DOMAIN_KERNEL
:
2240 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2241 if (nb_events
< 0) {
2242 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2246 case LTTNG_DOMAIN_UST
:
2247 nb_events
= ust_app_list_events(events
);
2248 if (nb_events
< 0) {
2249 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2253 case LTTNG_DOMAIN_LOG4J
:
2254 case LTTNG_DOMAIN_JUL
:
2255 case LTTNG_DOMAIN_PYTHON
:
2256 nb_events
= agent_list_events(events
, domain
);
2257 if (nb_events
< 0) {
2258 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2263 ret
= LTTNG_ERR_UND
;
2270 /* Return negative value to differentiate return code */
2275 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2277 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2278 struct lttng_event_field
**fields
)
2281 ssize_t nb_fields
= 0;
2284 case LTTNG_DOMAIN_UST
:
2285 nb_fields
= ust_app_list_event_fields(fields
);
2286 if (nb_fields
< 0) {
2287 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2291 case LTTNG_DOMAIN_KERNEL
:
2292 default: /* fall-through */
2293 ret
= LTTNG_ERR_UND
;
2300 /* Return negative value to differentiate return code */
2304 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2306 return syscall_table_list(events
);
2310 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2312 * Called with session lock held.
2314 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2315 enum lttng_domain_type domain
, int32_t **pids
)
2318 ssize_t nr_pids
= 0;
2321 case LTTNG_DOMAIN_KERNEL
:
2323 struct ltt_kernel_session
*ksess
;
2325 ksess
= session
->kernel_session
;
2326 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2328 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2333 case LTTNG_DOMAIN_UST
:
2335 struct ltt_ust_session
*usess
;
2337 usess
= session
->ust_session
;
2338 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2340 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2345 case LTTNG_DOMAIN_LOG4J
:
2346 case LTTNG_DOMAIN_JUL
:
2347 case LTTNG_DOMAIN_PYTHON
:
2349 ret
= LTTNG_ERR_UND
;
2356 /* Return negative value to differentiate return code */
2361 * Command LTTNG_START_TRACE processed by the client thread.
2363 * Called with session mutex held.
2365 int cmd_start_trace(struct ltt_session
*session
)
2368 unsigned long nb_chan
= 0;
2369 struct ltt_kernel_session
*ksession
;
2370 struct ltt_ust_session
*usess
;
2374 /* Ease our life a bit ;) */
2375 ksession
= session
->kernel_session
;
2376 usess
= session
->ust_session
;
2378 /* Is the session already started? */
2379 if (session
->active
) {
2380 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2385 * Starting a session without channel is useless since after that it's not
2386 * possible to enable channel thus inform the client.
2388 if (usess
&& usess
->domain_global
.channels
) {
2389 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2392 nb_chan
+= ksession
->channel_count
;
2395 ret
= LTTNG_ERR_NO_CHANNEL
;
2400 * Record the timestamp of the first time the session is started for
2401 * an eventual session rotation call.
2403 if (!session
->has_been_started
) {
2404 session
->session_start_ts
= time(NULL
);
2405 if (session
->session_start_ts
== (time_t) -1) {
2406 PERROR("Get start time");
2407 ret
= LTTNG_ERR_FATAL
;
2412 /* Kernel tracing */
2413 if (ksession
!= NULL
) {
2414 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2415 if (ret
!= LTTNG_OK
) {
2420 /* Flag session that trace should start automatically */
2423 * Even though the start trace might fail, flag this session active so
2424 * other application coming in are started by default.
2428 ret
= ust_app_start_trace_all(usess
);
2430 ret
= LTTNG_ERR_UST_START_FAIL
;
2435 /* Flag this after a successful start. */
2436 session
->has_been_started
= 1;
2437 session
->active
= 1;
2446 * Command LTTNG_STOP_TRACE processed by the client thread.
2448 int cmd_stop_trace(struct ltt_session
*session
)
2451 struct ltt_kernel_channel
*kchan
;
2452 struct ltt_kernel_session
*ksession
;
2453 struct ltt_ust_session
*usess
;
2458 ksession
= session
->kernel_session
;
2459 usess
= session
->ust_session
;
2461 /* Session is not active. Skip everythong and inform the client. */
2462 if (!session
->active
) {
2463 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2468 if (ksession
&& ksession
->active
) {
2469 DBG("Stop kernel tracing");
2471 ret
= kernel_stop_session(ksession
);
2473 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2477 kernel_wait_quiescent(kernel_tracer_fd
);
2479 /* Flush metadata after stopping (if exists) */
2480 if (ksession
->metadata_stream_fd
>= 0) {
2481 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2483 ERR("Kernel metadata flush failed");
2487 /* Flush all buffers after stopping */
2488 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2489 ret
= kernel_flush_buffer(kchan
);
2491 ERR("Kernel flush buffer error");
2495 ksession
->active
= 0;
2498 if (usess
&& usess
->active
) {
2500 * Even though the stop trace might fail, flag this session inactive so
2501 * other application coming in are not started by default.
2505 ret
= ust_app_stop_trace_all(usess
);
2507 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2512 session
->session_last_stop_ts
= time(NULL
);
2514 /* Flag inactive after a successful stop. */
2515 session
->active
= 0;
2523 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2525 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2526 struct lttng_uri
*uris
)
2529 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2530 struct ltt_ust_session
*usess
= session
->ust_session
;
2536 /* Can't set consumer URI if the session is active. */
2537 if (session
->active
) {
2538 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2542 /* Set the "global" consumer URIs */
2543 for (i
= 0; i
< nb_uri
; i
++) {
2544 ret
= add_uri_to_consumer(session
->consumer
,
2545 &uris
[i
], 0, session
->name
);
2546 if (ret
!= LTTNG_OK
) {
2551 /* Set UST session URIs */
2552 if (session
->ust_session
) {
2553 for (i
= 0; i
< nb_uri
; i
++) {
2554 ret
= add_uri_to_consumer(
2555 session
->ust_session
->consumer
,
2556 &uris
[i
], LTTNG_DOMAIN_UST
,
2558 if (ret
!= LTTNG_OK
) {
2564 /* Set kernel session URIs */
2565 if (session
->kernel_session
) {
2566 for (i
= 0; i
< nb_uri
; i
++) {
2567 ret
= add_uri_to_consumer(
2568 session
->kernel_session
->consumer
,
2569 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2571 if (ret
!= LTTNG_OK
) {
2578 * Make sure to set the session in output mode after we set URI since a
2579 * session can be created without URL (thus flagged in no output mode).
2581 session
->output_traces
= 1;
2583 ksess
->output_traces
= 1;
2587 usess
->output_traces
= 1;
2598 * Command LTTNG_CREATE_SESSION processed by the client thread.
2600 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2601 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2604 struct ltt_session
*session
;
2610 * Verify if the session already exist
2612 * XXX: There is no need for the session lock list here since the caller
2613 * (process_client_msg) is holding it. We might want to change that so a
2614 * single command does not lock the entire session list.
2616 session
= session_find_by_name(name
);
2617 if (session
!= NULL
) {
2618 ret
= LTTNG_ERR_EXIST_SESS
;
2622 /* Create tracing session in the registry */
2623 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2624 LTTNG_SOCK_GET_GID_CRED(creds
));
2625 if (ret
!= LTTNG_OK
) {
2630 * Get the newly created session pointer back
2632 * XXX: There is no need for the session lock list here since the caller
2633 * (process_client_msg) is holding it. We might want to change that so a
2634 * single command does not lock the entire session list.
2636 session
= session_find_by_name(name
);
2639 session
->live_timer
= live_timer
;
2640 /* Create default consumer output for the session not yet created. */
2641 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2642 if (session
->consumer
== NULL
) {
2643 ret
= LTTNG_ERR_FATAL
;
2644 goto consumer_error
;
2648 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2649 if (ret
!= LTTNG_OK
) {
2650 goto consumer_error
;
2652 session
->output_traces
= 1;
2654 session
->output_traces
= 0;
2655 DBG2("Session %s created with no output", session
->name
);
2658 session
->consumer
->enabled
= 1;
2663 session_destroy(session
);
2670 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2672 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2673 size_t nb_uri
, lttng_sock_cred
*creds
)
2676 struct ltt_session
*session
;
2677 struct snapshot_output
*new_output
= NULL
;
2683 * Create session in no output mode with URIs set to NULL. The uris we've
2684 * received are for a default snapshot output if one.
2686 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2687 if (ret
!= LTTNG_OK
) {
2691 /* Get the newly created session pointer back. This should NEVER fail. */
2692 session
= session_find_by_name(name
);
2695 /* Flag session for snapshot mode. */
2696 session
->snapshot_mode
= 1;
2698 /* Skip snapshot output creation if no URI is given. */
2703 new_output
= snapshot_output_alloc();
2705 ret
= LTTNG_ERR_NOMEM
;
2706 goto error_snapshot_alloc
;
2709 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2710 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2712 if (ret
== -ENOMEM
) {
2713 ret
= LTTNG_ERR_NOMEM
;
2715 ret
= LTTNG_ERR_INVALID
;
2717 goto error_snapshot
;
2721 snapshot_add_output(&session
->snapshot
, new_output
);
2728 snapshot_output_destroy(new_output
);
2729 error_snapshot_alloc
:
2730 session_destroy(session
);
2736 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2738 * Called with session lock held.
2740 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2743 struct ltt_ust_session
*usess
;
2744 struct ltt_kernel_session
*ksess
;
2749 usess
= session
->ust_session
;
2750 ksess
= session
->kernel_session
;
2752 /* Clean kernel session teardown */
2753 kernel_destroy_session(ksess
);
2755 /* UST session teardown */
2757 /* Close any relayd session */
2758 consumer_output_send_destroy_relayd(usess
->consumer
);
2760 /* Destroy every UST application related to this session. */
2761 ret
= ust_app_destroy_trace_all(usess
);
2763 ERR("Error in ust_app_destroy_trace_all");
2766 /* Clean up the rest. */
2767 trace_ust_destroy_session(usess
);
2770 if (session
->rotate_count
> 0) {
2771 session
->rotate_count
++;
2773 * The currently active tracing path is now the folder we
2776 snprintf(session
->rotation_chunk
.current_rotate_path
,
2778 session
->rotation_chunk
.active_tracing_path
);
2779 ret
= rename_complete_chunk(session
,
2780 session
->session_last_stop_ts
);
2782 ERR("Renaming session on destroy");
2787 * Must notify the kernel thread here to update it's poll set in order to
2788 * remove the channel(s)' fd just destroyed.
2790 ret
= notify_thread_pipe(wpipe
);
2792 PERROR("write kernel poll pipe");
2795 ret
= session_destroy(session
);
2801 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2803 int cmd_register_consumer(struct ltt_session
*session
,
2804 enum lttng_domain_type domain
, const char *sock_path
,
2805 struct consumer_data
*cdata
)
2808 struct consumer_socket
*socket
= NULL
;
2815 case LTTNG_DOMAIN_KERNEL
:
2817 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2821 /* Can't register a consumer if there is already one */
2822 if (ksess
->consumer_fds_sent
!= 0) {
2823 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2827 sock
= lttcomm_connect_unix_sock(sock_path
);
2829 ret
= LTTNG_ERR_CONNECT_FAIL
;
2832 cdata
->cmd_sock
= sock
;
2834 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2835 if (socket
== NULL
) {
2838 PERROR("close register consumer");
2840 cdata
->cmd_sock
= -1;
2841 ret
= LTTNG_ERR_FATAL
;
2845 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2846 if (socket
->lock
== NULL
) {
2847 PERROR("zmalloc pthread mutex");
2848 ret
= LTTNG_ERR_FATAL
;
2851 pthread_mutex_init(socket
->lock
, NULL
);
2852 socket
->registered
= 1;
2855 consumer_add_socket(socket
, ksess
->consumer
);
2858 pthread_mutex_lock(&cdata
->pid_mutex
);
2860 pthread_mutex_unlock(&cdata
->pid_mutex
);
2865 /* TODO: Userspace tracing */
2866 ret
= LTTNG_ERR_UND
;
2874 consumer_destroy_socket(socket
);
2880 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2882 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2883 struct lttng_domain
**domains
)
2888 struct lttng_ht_iter iter
;
2890 if (session
->kernel_session
!= NULL
) {
2891 DBG3("Listing domains found kernel domain");
2895 if (session
->ust_session
!= NULL
) {
2896 DBG3("Listing domains found UST global domain");
2900 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2902 if (agt
->being_used
) {
2913 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2914 if (*domains
== NULL
) {
2915 ret
= LTTNG_ERR_FATAL
;
2919 if (session
->kernel_session
!= NULL
) {
2920 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2922 /* Kernel session buffer type is always GLOBAL */
2923 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2928 if (session
->ust_session
!= NULL
) {
2929 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2930 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2934 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2936 if (agt
->being_used
) {
2937 (*domains
)[index
].type
= agt
->domain
;
2938 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2948 /* Return negative value to differentiate return code */
2954 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2956 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2957 struct ltt_session
*session
, struct lttng_channel
**channels
)
2959 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
2962 case LTTNG_DOMAIN_KERNEL
:
2963 if (session
->kernel_session
!= NULL
) {
2964 nb_chan
= session
->kernel_session
->channel_count
;
2966 DBG3("Number of kernel channels %zd", nb_chan
);
2968 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2972 case LTTNG_DOMAIN_UST
:
2973 if (session
->ust_session
!= NULL
) {
2975 nb_chan
= lttng_ht_get_count(
2976 session
->ust_session
->domain_global
.channels
);
2979 DBG3("Number of UST global channels %zd", nb_chan
);
2981 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2986 ret
= -LTTNG_ERR_UND
;
2991 const size_t channel_size
= sizeof(struct lttng_channel
) +
2992 sizeof(struct lttng_channel_extended
);
2993 struct lttng_channel_extended
*channel_exts
;
2995 payload_size
= nb_chan
* channel_size
;
2996 *channels
= zmalloc(payload_size
);
2997 if (*channels
== NULL
) {
2998 ret
= -LTTNG_ERR_FATAL
;
3002 channel_exts
= ((void *) *channels
) +
3003 (nb_chan
* sizeof(struct lttng_channel
));
3004 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3005 if (ret
!= LTTNG_OK
) {
3020 * Command LTTNG_LIST_EVENTS processed by the client thread.
3022 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3023 struct ltt_session
*session
, char *channel_name
,
3024 struct lttng_event
**events
, size_t *total_size
)
3027 ssize_t nb_event
= 0;
3030 case LTTNG_DOMAIN_KERNEL
:
3031 if (session
->kernel_session
!= NULL
) {
3032 nb_event
= list_lttng_kernel_events(channel_name
,
3033 session
->kernel_session
, events
,
3037 case LTTNG_DOMAIN_UST
:
3039 if (session
->ust_session
!= NULL
) {
3040 nb_event
= list_lttng_ust_global_events(channel_name
,
3041 &session
->ust_session
->domain_global
, events
,
3046 case LTTNG_DOMAIN_LOG4J
:
3047 case LTTNG_DOMAIN_JUL
:
3048 case LTTNG_DOMAIN_PYTHON
:
3049 if (session
->ust_session
) {
3050 struct lttng_ht_iter iter
;
3054 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3055 &iter
.iter
, agt
, node
.node
) {
3056 if (agt
->domain
== domain
) {
3057 nb_event
= list_lttng_agent_events(
3067 ret
= LTTNG_ERR_UND
;
3074 /* Return negative value to differentiate return code */
3079 * Using the session list, filled a lttng_session array to send back to the
3080 * client for session listing.
3082 * The session list lock MUST be acquired before calling this function. Use
3083 * session_lock_list() and session_unlock_list().
3085 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
3090 struct ltt_session
*session
;
3091 struct ltt_session_list
*list
= session_get_list();
3093 DBG("Getting all available session for UID %d GID %d",
3096 * Iterate over session list and append data after the control struct in
3099 cds_list_for_each_entry(session
, &list
->head
, list
) {
3101 * Only list the sessions the user can control.
3103 if (!session_access_ok(session
, uid
, gid
)) {
3107 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3108 struct ltt_ust_session
*usess
= session
->ust_session
;
3110 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3111 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3112 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3113 ret
= build_network_session_path(sessions
[i
].path
,
3114 sizeof(sessions
[i
].path
), session
);
3116 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3117 session
->consumer
->dst
.session_root_path
);
3120 PERROR("snprintf session path");
3124 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3125 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3126 sessions
[i
].enabled
= session
->active
;
3127 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3128 sessions
[i
].live_timer_interval
= session
->live_timer
;
3134 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3135 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3137 int cmd_data_pending(struct ltt_session
*session
)
3140 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3141 struct ltt_ust_session
*usess
= session
->ust_session
;
3145 /* Session MUST be stopped to ask for data availability. */
3146 if (session
->active
) {
3147 ret
= LTTNG_ERR_SESSION_STARTED
;
3151 * If stopped, just make sure we've started before else the above call
3152 * will always send that there is data pending.
3154 * The consumer assumes that when the data pending command is received,
3155 * the trace has been started before or else no output data is written
3156 * by the streams which is a condition for data pending. So, this is
3157 * *VERY* important that we don't ask the consumer before a start
3160 if (!session
->has_been_started
) {
3166 if (ksess
&& ksess
->consumer
) {
3167 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3169 /* Data is still being extracted for the kernel. */
3174 if (usess
&& usess
->consumer
) {
3175 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3177 /* Data is still being extracted for the kernel. */
3182 /* Data is ready to be read by a viewer */
3190 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3192 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3194 int cmd_snapshot_add_output(struct ltt_session
*session
,
3195 struct lttng_snapshot_output
*output
, uint32_t *id
)
3198 struct snapshot_output
*new_output
;
3203 DBG("Cmd snapshot add output for session %s", session
->name
);
3206 * Can't create an output if the session is not set in no-output mode.
3208 if (session
->output_traces
) {
3209 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3213 /* Only one output is allowed until we have the "tee" feature. */
3214 if (session
->snapshot
.nb_output
== 1) {
3215 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3219 new_output
= snapshot_output_alloc();
3221 ret
= LTTNG_ERR_NOMEM
;
3225 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3226 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3227 &session
->snapshot
);
3229 if (ret
== -ENOMEM
) {
3230 ret
= LTTNG_ERR_NOMEM
;
3232 ret
= LTTNG_ERR_INVALID
;
3238 snapshot_add_output(&session
->snapshot
, new_output
);
3240 *id
= new_output
->id
;
3247 snapshot_output_destroy(new_output
);
3253 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3255 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3257 int cmd_snapshot_del_output(struct ltt_session
*session
,
3258 struct lttng_snapshot_output
*output
)
3261 struct snapshot_output
*sout
= NULL
;
3269 * Permission denied to create an output if the session is not
3270 * set in no output mode.
3272 if (session
->output_traces
) {
3273 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3278 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3280 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3281 } else if (*output
->name
!= '\0') {
3282 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3284 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3287 ret
= LTTNG_ERR_INVALID
;
3291 snapshot_delete_output(&session
->snapshot
, sout
);
3292 snapshot_output_destroy(sout
);
3301 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3303 * If no output is available, outputs is untouched and 0 is returned.
3305 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3307 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3308 struct lttng_snapshot_output
**outputs
)
3311 struct lttng_snapshot_output
*list
= NULL
;
3312 struct lttng_ht_iter iter
;
3313 struct snapshot_output
*output
;
3318 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3321 * Permission denied to create an output if the session is not
3322 * set in no output mode.
3324 if (session
->output_traces
) {
3325 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3329 if (session
->snapshot
.nb_output
== 0) {
3334 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3336 ret
= -LTTNG_ERR_NOMEM
;
3340 /* Copy list from session to the new list object. */
3342 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3343 output
, node
.node
) {
3344 assert(output
->consumer
);
3345 list
[idx
].id
= output
->id
;
3346 list
[idx
].max_size
= output
->max_size
;
3347 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3348 sizeof(list
[idx
].name
))) {
3349 ret
= -LTTNG_ERR_INVALID
;
3352 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3353 if (lttng_strncpy(list
[idx
].ctrl_url
,
3354 output
->consumer
->dst
.session_root_path
,
3355 sizeof(list
[idx
].ctrl_url
))) {
3356 ret
= -LTTNG_ERR_INVALID
;
3361 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3362 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3364 ret
= -LTTNG_ERR_NOMEM
;
3369 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3370 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3372 ret
= -LTTNG_ERR_NOMEM
;
3381 ret
= session
->snapshot
.nb_output
;
3390 * Check if we can regenerate the metadata for this session.
3391 * Only kernel, UST per-uid and non-live sessions are supported.
3393 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3396 int check_regenerate_metadata_support(struct ltt_session
*session
)
3402 if (session
->live_timer
!= 0) {
3403 ret
= LTTNG_ERR_LIVE_SESSION
;
3406 if (!session
->active
) {
3407 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3410 if (session
->ust_session
) {
3411 switch (session
->ust_session
->buffer_type
) {
3412 case LTTNG_BUFFER_PER_UID
:
3414 case LTTNG_BUFFER_PER_PID
:
3415 ret
= LTTNG_ERR_PER_PID_SESSION
;
3419 ret
= LTTNG_ERR_UNK
;
3423 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
3424 session
->consumer
->relay_minor_version
< 8) {
3425 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
3435 int clear_metadata_file(int fd
)
3439 ret
= lseek(fd
, 0, SEEK_SET
);
3445 ret
= ftruncate(fd
, 0);
3447 PERROR("ftruncate");
3456 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
3459 struct buffer_reg_uid
*uid_reg
= NULL
;
3460 struct buffer_reg_session
*session_reg
= NULL
;
3463 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3464 struct ust_registry_session
*registry
;
3465 struct ust_registry_channel
*chan
;
3466 struct lttng_ht_iter iter_chan
;
3468 session_reg
= uid_reg
->registry
;
3469 registry
= session_reg
->reg
.ust
;
3471 pthread_mutex_lock(®istry
->lock
);
3472 registry
->metadata_len_sent
= 0;
3473 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
3474 registry
->metadata_len
= 0;
3475 registry
->metadata_version
++;
3476 if (registry
->metadata_fd
> 0) {
3477 /* Clear the metadata file's content. */
3478 ret
= clear_metadata_file(registry
->metadata_fd
);
3480 pthread_mutex_unlock(®istry
->lock
);
3485 ret
= ust_metadata_session_statedump(registry
, NULL
,
3486 registry
->major
, registry
->minor
);
3488 pthread_mutex_unlock(®istry
->lock
);
3489 ERR("Failed to generate session metadata (err = %d)",
3493 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
3495 struct ust_registry_event
*event
;
3496 struct lttng_ht_iter iter_event
;
3498 ret
= ust_metadata_channel_statedump(registry
, chan
);
3500 pthread_mutex_unlock(®istry
->lock
);
3501 ERR("Failed to generate channel metadata "
3505 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
3507 ret
= ust_metadata_event_statedump(registry
,
3510 pthread_mutex_unlock(®istry
->lock
);
3511 ERR("Failed to generate event metadata "
3517 pthread_mutex_unlock(®istry
->lock
);
3526 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3528 * Ask the consumer to truncate the existing metadata file(s) and
3529 * then regenerate the metadata. Live and per-pid sessions are not
3530 * supported and return an error.
3532 * Return 0 on success or else a LTTNG_ERR code.
3534 int cmd_regenerate_metadata(struct ltt_session
*session
)
3540 ret
= check_regenerate_metadata_support(session
);
3545 if (session
->kernel_session
) {
3546 ret
= kernctl_session_regenerate_metadata(
3547 session
->kernel_session
->fd
);
3549 ERR("Failed to regenerate the kernel metadata");
3554 if (session
->ust_session
) {
3555 ret
= ust_regenerate_metadata(session
->ust_session
);
3557 ERR("Failed to regenerate the UST metadata");
3561 DBG("Cmd metadata regenerate for session %s", session
->name
);
3569 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
3571 * Ask the tracer to regenerate a new statedump.
3573 * Return 0 on success or else a LTTNG_ERR code.
3575 int cmd_regenerate_statedump(struct ltt_session
*session
)
3581 if (!session
->active
) {
3582 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
3586 if (session
->kernel_session
) {
3587 ret
= kernctl_session_regenerate_statedump(
3588 session
->kernel_session
->fd
);
3590 * Currently, the statedump in kernel can only fail if out
3594 if (ret
== -ENOMEM
) {
3595 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
3597 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3599 ERR("Failed to regenerate the kernel statedump");
3604 if (session
->ust_session
) {
3605 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
3607 * Currently, the statedump in UST always returns 0.
3610 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
3611 ERR("Failed to regenerate the UST statedump");
3615 DBG("Cmd regenerate statedump for session %s", session
->name
);
3622 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
3623 struct notification_thread_handle
*notification_thread
)
3627 ssize_t sock_recv_len
;
3628 struct lttng_trigger
*trigger
= NULL
;
3629 struct lttng_buffer_view view
;
3630 struct lttng_dynamic_buffer trigger_buffer
;
3632 lttng_dynamic_buffer_init(&trigger_buffer
);
3633 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
3634 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
3636 ret
= LTTNG_ERR_NOMEM
;
3640 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
3642 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
3643 ERR("Failed to receive \"register trigger\" command payload");
3644 /* TODO: should this be a new error enum ? */
3645 ret
= LTTNG_ERR_INVALID_TRIGGER
;
3649 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
3650 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
3652 ERR("Invalid trigger payload received in \"register trigger\" command");
3653 ret
= LTTNG_ERR_INVALID_TRIGGER
;
3657 ret
= notification_thread_command_register_trigger(notification_thread
,
3659 /* Ownership of trigger was transferred. */
3662 lttng_trigger_destroy(trigger
);
3663 lttng_dynamic_buffer_reset(&trigger_buffer
);
3667 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
3668 struct notification_thread_handle
*notification_thread
)
3672 ssize_t sock_recv_len
;
3673 struct lttng_trigger
*trigger
= NULL
;
3674 struct lttng_buffer_view view
;
3675 struct lttng_dynamic_buffer trigger_buffer
;
3677 lttng_dynamic_buffer_init(&trigger_buffer
);
3678 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
3679 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
3681 ret
= LTTNG_ERR_NOMEM
;
3685 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
3687 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
3688 ERR("Failed to receive \"unregister trigger\" command payload");
3689 /* TODO: should this be a new error enum ? */
3690 ret
= LTTNG_ERR_INVALID_TRIGGER
;
3694 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
3695 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
3697 ERR("Invalid trigger payload received in \"unregister trigger\" command");
3698 ret
= LTTNG_ERR_INVALID_TRIGGER
;
3702 ret
= notification_thread_command_unregister_trigger(notification_thread
,
3705 lttng_trigger_destroy(trigger
);
3706 lttng_dynamic_buffer_reset(&trigger_buffer
);
3711 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3712 * snapshot output is *not* set with a remote destination.
3714 * Return 0 on success or a LTTNG_ERR code.
3716 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3717 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3720 struct lttng_ht_iter iter
;
3721 struct consumer_socket
*socket
;
3724 assert(snap_output
);
3727 DBG2("Set relayd object from snapshot output");
3729 /* Ignore if snapshot consumer output is not network. */
3730 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3735 * For each consumer socket, create and send the relayd object of the
3739 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3740 socket
, node
.node
) {
3741 ret
= send_consumer_relayd_sockets(0, session
->id
,
3742 snap_output
->consumer
, socket
,
3743 session
->name
, session
->hostname
,
3744 session
->live_timer
);
3745 if (ret
!= LTTNG_OK
) {
3757 * Record a kernel snapshot.
3759 * Return LTTNG_OK on success or a LTTNG_ERR code.
3761 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3762 struct snapshot_output
*output
, struct ltt_session
*session
,
3763 int wait
, uint64_t nb_packets_per_stream
)
3773 * Copy kernel session sockets so we can communicate with the right
3774 * consumer for the snapshot record command.
3776 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3778 ret
= LTTNG_ERR_NOMEM
;
3782 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3783 if (ret
!= LTTNG_OK
) {
3784 goto error_snapshot
;
3787 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3788 if (ret
!= LTTNG_OK
) {
3789 goto error_snapshot
;
3796 /* Clean up copied sockets so this output can use some other later on. */
3797 consumer_destroy_output_sockets(output
->consumer
);
3804 * Record a UST snapshot.
3806 * Return 0 on success or a LTTNG_ERR error code.
3808 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3809 struct snapshot_output
*output
, struct ltt_session
*session
,
3810 int wait
, uint64_t nb_packets_per_stream
)
3819 * Copy UST session sockets so we can communicate with the right
3820 * consumer for the snapshot record command.
3822 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3824 ret
= LTTNG_ERR_NOMEM
;
3828 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3829 if (ret
!= LTTNG_OK
) {
3830 goto error_snapshot
;
3833 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3837 ret
= LTTNG_ERR_INVALID
;
3840 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3843 goto error_snapshot
;
3849 /* Clean up copied sockets so this output can use some other later on. */
3850 consumer_destroy_output_sockets(output
->consumer
);
3856 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3857 uint64_t cur_nr_packets
)
3859 uint64_t tot_size
= 0;
3861 if (session
->kernel_session
) {
3862 struct ltt_kernel_channel
*chan
;
3863 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3865 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3866 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3868 * Don't take channel into account if we
3869 * already grab all its packets.
3873 tot_size
+= chan
->channel
->attr
.subbuf_size
3874 * chan
->stream_count
;
3878 if (session
->ust_session
) {
3879 struct ltt_ust_session
*usess
= session
->ust_session
;
3881 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3889 * Calculate the number of packets we can grab from each stream that
3890 * fits within the overall snapshot max size.
3892 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3893 * the number of packets per stream.
3895 * TODO: this approach is not perfect: we consider the worse case
3896 * (packet filling the sub-buffers) as an upper bound, but we could do
3897 * better if we do this calculation while we actually grab the packet
3898 * content: we would know how much padding we don't actually store into
3901 * This algorithm is currently bounded by the number of packets per
3904 * Since we call this algorithm before actually grabbing the data, it's
3905 * an approximation: for instance, applications could appear/disappear
3906 * in between this call and actually grabbing data.
3909 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3912 uint64_t cur_nb_packets
= 0;
3915 return 0; /* Infinite */
3918 size_left
= max_size
;
3920 uint64_t one_more_packet_tot_size
;
3922 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3924 if (!one_more_packet_tot_size
) {
3925 /* We are already grabbing all packets. */
3928 size_left
-= one_more_packet_tot_size
;
3929 if (size_left
< 0) {
3934 if (!cur_nb_packets
) {
3935 /* Not enough room to grab one packet of each stream, error. */
3938 return cur_nb_packets
;
3942 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3944 * The wait parameter is ignored so this call always wait for the snapshot to
3945 * complete before returning.
3947 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3949 int cmd_snapshot_record(struct ltt_session
*session
,
3950 struct lttng_snapshot_output
*output
, int wait
)
3953 unsigned int use_tmp_output
= 0;
3954 struct snapshot_output tmp_output
;
3955 unsigned int snapshot_success
= 0;
3961 DBG("Cmd snapshot record for session %s", session
->name
);
3963 /* Get the datetime for the snapshot output directory. */
3964 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3967 ret
= LTTNG_ERR_INVALID
;
3972 * Permission denied to create an output if the session is not
3973 * set in no output mode.
3975 if (session
->output_traces
) {
3976 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3980 /* The session needs to be started at least once. */
3981 if (!session
->has_been_started
) {
3982 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3986 /* Use temporary output for the session. */
3987 if (*output
->ctrl_url
!= '\0') {
3988 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3989 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3992 if (ret
== -ENOMEM
) {
3993 ret
= LTTNG_ERR_NOMEM
;
3995 ret
= LTTNG_ERR_INVALID
;
3999 /* Use the global session count for the temporary snapshot. */
4000 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4002 /* Use the global datetime */
4003 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4007 if (use_tmp_output
) {
4008 int64_t nb_packets_per_stream
;
4010 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4011 tmp_output
.max_size
);
4012 if (nb_packets_per_stream
< 0) {
4013 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4017 if (session
->kernel_session
) {
4018 ret
= record_kernel_snapshot(session
->kernel_session
,
4019 &tmp_output
, session
,
4020 wait
, nb_packets_per_stream
);
4021 if (ret
!= LTTNG_OK
) {
4026 if (session
->ust_session
) {
4027 ret
= record_ust_snapshot(session
->ust_session
,
4028 &tmp_output
, session
,
4029 wait
, nb_packets_per_stream
);
4030 if (ret
!= LTTNG_OK
) {
4035 snapshot_success
= 1;
4037 struct snapshot_output
*sout
;
4038 struct lttng_ht_iter iter
;
4041 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4042 &iter
.iter
, sout
, node
.node
) {
4043 int64_t nb_packets_per_stream
;
4046 * Make a local copy of the output and assign the possible
4047 * temporary value given by the caller.
4049 memset(&tmp_output
, 0, sizeof(tmp_output
));
4050 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
4052 if (output
->max_size
!= (uint64_t) -1ULL) {
4053 tmp_output
.max_size
= output
->max_size
;
4056 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4057 tmp_output
.max_size
);
4058 if (nb_packets_per_stream
< 0) {
4059 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
4064 /* Use temporary name. */
4065 if (*output
->name
!= '\0') {
4066 if (lttng_strncpy(tmp_output
.name
, output
->name
,
4067 sizeof(tmp_output
.name
))) {
4068 ret
= LTTNG_ERR_INVALID
;
4074 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4075 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
4077 if (session
->kernel_session
) {
4078 ret
= record_kernel_snapshot(session
->kernel_session
,
4079 &tmp_output
, session
,
4080 wait
, nb_packets_per_stream
);
4081 if (ret
!= LTTNG_OK
) {
4087 if (session
->ust_session
) {
4088 ret
= record_ust_snapshot(session
->ust_session
,
4089 &tmp_output
, session
,
4090 wait
, nb_packets_per_stream
);
4091 if (ret
!= LTTNG_OK
) {
4096 snapshot_success
= 1;
4101 if (snapshot_success
) {
4102 session
->snapshot
.nb_snapshot
++;
4104 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4112 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4114 int cmd_set_session_shm_path(struct ltt_session
*session
,
4115 const char *shm_path
)
4121 * Can only set shm path before session is started.
4123 if (session
->has_been_started
) {
4124 return LTTNG_ERR_SESSION_STARTED
;
4127 strncpy(session
->shm_path
, shm_path
,
4128 sizeof(session
->shm_path
));
4129 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4135 int rename_first_chunk(struct consumer_output
*consumer
, char *datetime
)
4138 char *tmppath
= NULL
, *tmppath2
= NULL
;
4140 tmppath
= zmalloc(PATH_MAX
* sizeof(char));
4142 ret
= -LTTNG_ERR_NOMEM
;
4145 tmppath2
= zmalloc(PATH_MAX
* sizeof(char));
4147 ret
= -LTTNG_ERR_NOMEM
;
4151 /* Current domain path: <session>/kernel */
4152 snprintf(tmppath
, PATH_MAX
, "%s/%s",
4153 consumer
->dst
.session_root_path
, consumer
->subdir
);
4154 /* New domain path: <session>/<start-date>-/kernel */
4155 snprintf(tmppath2
, PATH_MAX
, "%s/%s-/%s",
4156 consumer
->dst
.session_root_path
, datetime
,
4159 * Move the per-domain folder inside the first rotation
4162 ret
= rename(tmppath
, tmppath2
);
4164 PERROR("Rename first trace directory");
4165 ret
= -LTTNG_ERR_ROTATE_NO_DATA
;
4179 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4181 * Ask the consumer to rotate the session output directory.
4183 * Return 0 on success or else a LTTNG_ERR code.
4185 int cmd_rotate_session(struct ltt_session
*session
,
4186 struct lttng_rotate_session_return
**rotate_return
)
4189 struct tm
*timeinfo
;
4195 *rotate_return
= zmalloc(sizeof(struct lttng_rotate_session_return
));
4196 if (!*rotate_return
) {
4201 if (session
->live_timer
|| session
->snapshot_mode
||
4202 !session
->output_traces
) {
4203 ret
= -LTTNG_ERR_ROTATE_NOT_AVAILABLE
;
4207 if (session
->rotate_pending
) {
4208 ret
= -LTTNG_ERR_ROTATE_PENDING
;
4212 /* Special case for the first rotation. */
4213 if (session
->rotate_count
== 0) {
4214 timeinfo
= localtime(&session
->session_start_ts
);
4215 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
4216 if (session
->kernel_session
) {
4217 snprintf(session
->rotation_chunk
.current_rotate_path
,
4219 session
->kernel_session
->consumer
->dst
.session_root_path
,
4221 } else if (session
->ust_session
) {
4222 snprintf(session
->rotation_chunk
.current_rotate_path
,
4224 session
->ust_session
->consumer
->dst
.session_root_path
,
4231 * Create the first rotation folder to move the existing
4232 * kernel/ust folders into.
4234 ret
= run_as_mkdir_recursive(session
->rotation_chunk
.current_rotate_path
,
4235 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4237 if (errno
!= EEXIST
) {
4238 ERR("Trace directory creation error");
4239 ret
= -LTTNG_ERR_ROTATE_NOT_AVAILABLE
;
4243 if (session
->kernel_session
) {
4244 ret
= rename_first_chunk(session
->kernel_session
->consumer
,
4250 if (session
->ust_session
) {
4251 ret
= rename_first_chunk(session
->ust_session
->consumer
,
4259 * The currently active tracing path is now the folder we
4262 snprintf(session
->rotation_chunk
.current_rotate_path
,
4264 session
->rotation_chunk
.active_tracing_path
);
4267 session
->rotate_count
++;
4268 session
->rotate_pending
= 1;
4271 * Create the path name for the next chunk.
4274 if (now
== (time_t) -1) {
4275 ret
= -LTTNG_ERR_ROTATE_NOT_AVAILABLE
;
4279 timeinfo
= localtime(&now
);
4280 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
4281 if (session
->kernel_session
) {
4282 /* The active path for the next rotation/destroy. */
4283 snprintf(session
->rotation_chunk
.active_tracing_path
,
4285 session
->kernel_session
->consumer
->dst
.session_root_path
,
4287 /* The sub-directory for the consumer. */
4288 snprintf(session
->kernel_session
->consumer
->chunk_path
,
4289 PATH_MAX
, "/%s-/%s/", datetime
,
4290 session
->kernel_session
->consumer
->subdir
);
4291 ret
= kernel_rotate_session(session
);
4292 if (ret
!= LTTNG_OK
) {
4296 if (session
->ust_session
) {
4297 snprintf(session
->rotation_chunk
.active_tracing_path
,
4299 session
->ust_session
->consumer
->dst
.session_root_path
,
4301 snprintf(session
->ust_session
->consumer
->chunk_path
,
4302 PATH_MAX
, "/%s-/", datetime
);
4303 ret
= ust_app_rotate_session(session
);
4304 if (ret
!= LTTNG_OK
) {
4309 (*rotate_return
)->rotate_id
= session
->rotate_count
;
4310 (*rotate_return
)->status
= LTTNG_ROTATE_STARTED
;
4312 DBG("Cmd rotate session %s, rotate_id %" PRIu64
, session
->name
,
4313 session
->rotate_count
);
4319 (*rotate_return
)->status
= LTTNG_ROTATE_ERROR
;
4325 * Command LTTNG_ROTATE_PENDING from the lttng-ctl library.
4327 * Check if the session has finished its rotation.
4329 * Return 0 on success or else a LTTNG_ERR code.
4331 int cmd_rotate_pending(struct ltt_session
*session
,
4332 struct lttng_rotate_pending_return
**pending_return
,
4339 DBG("Cmd rotate pending session %s, rotate_id %" PRIu64
, session
->name
,
4340 session
->rotate_count
);
4342 *pending_return
= zmalloc(sizeof(struct lttng_rotate_pending_return
));
4343 if (!*pending_return
) {
4348 if (session
->rotate_count
!= rotate_id
) {
4349 (*pending_return
)->status
= LTTNG_ROTATE_EXPIRED
;
4354 if (session
->rotate_pending
) {
4355 DBG("Session %s, rotate_id %" PRIu64
" still pending",
4356 session
->name
, session
->rotate_count
);
4357 (*pending_return
)->status
= LTTNG_ROTATE_STARTED
;
4359 DBG("Session %s, rotate_id %" PRIu64
" finished",
4360 session
->name
, session
->rotate_count
);
4361 (*pending_return
)->status
= LTTNG_ROTATE_COMPLETED
;
4362 snprintf((*pending_return
)->output_path
, PATH_MAX
, "%s",
4363 session
->rotation_chunk
.current_rotate_path
);
4371 (*pending_return
)->status
= LTTNG_ROTATE_ERROR
;
4377 * Init command subsystem.
4382 * Set network sequence index to 1 for streams to match a relayd
4383 * socket on the consumer side.
4385 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
4386 relayd_net_seq_idx
= 1;
4387 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
4389 DBG("Command subsystem initialized");