2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <lttng/ust-ctl.h>
28 #include <sys/socket.h>
30 #include <sys/types.h>
33 #include <urcu/list.h>
38 #include <bin/lttng-consumerd/health-consumerd.h>
39 #include <common/common.h>
40 #include <common/sessiond-comm/sessiond-comm.h>
41 #include <common/relayd/relayd.h>
42 #include <common/compat/fcntl.h>
43 #include <common/compat/endian.h>
44 #include <common/consumer/consumer-metadata-cache.h>
45 #include <common/consumer/consumer-stream.h>
46 #include <common/consumer/consumer-timer.h>
47 #include <common/utils.h>
48 #include <common/index/index.h>
49 #include <common/consumer/consumer.h>
51 #include "ust-consumer.h"
53 #define INT_MAX_STR_LEN 12 /* includes \0 */
55 extern struct lttng_consumer_global_data consumer_data
;
56 extern int consumer_poll_timeout
;
59 * Free channel object and all streams associated with it. This MUST be used
60 * only and only if the channel has _NEVER_ been added to the global channel
63 static void destroy_channel(struct lttng_consumer_channel
*channel
)
65 struct lttng_consumer_stream
*stream
, *stmp
;
69 DBG("UST consumer cleaning stream list");
71 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
76 cds_list_del(&stream
->send_node
);
77 ustctl_destroy_stream(stream
->ustream
);
78 lttng_trace_chunk_put(stream
->trace_chunk
);
83 * If a channel is available meaning that was created before the streams
87 lttng_ustconsumer_del_channel(channel
);
88 lttng_ustconsumer_free_channel(channel
);
94 * Add channel to internal consumer state.
96 * Returns 0 on success or else a negative value.
98 static int add_channel(struct lttng_consumer_channel
*channel
,
99 struct lttng_consumer_local_data
*ctx
)
106 if (ctx
->on_recv_channel
!= NULL
) {
107 ret
= ctx
->on_recv_channel(channel
);
109 ret
= consumer_add_channel(channel
, ctx
);
110 } else if (ret
< 0) {
111 /* Most likely an ENOMEM. */
112 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
116 ret
= consumer_add_channel(channel
, ctx
);
119 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
126 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
127 * error value if applicable is set in it else it is kept untouched.
129 * Return NULL on error else the newly allocated stream object.
131 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
132 struct lttng_consumer_channel
*channel
,
133 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
136 struct lttng_consumer_stream
*stream
= NULL
;
141 stream
= consumer_stream_create(
148 channel
->trace_chunk
,
153 if (stream
== NULL
) {
157 * We could not find the channel. Can happen if cpu hotplug
158 * happens while tearing down.
160 DBG3("Could not find channel");
165 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
171 consumer_stream_update_channel_attributes(stream
, channel
);
175 *_alloc_ret
= alloc_ret
;
181 * Send the given stream pointer to the corresponding thread.
183 * Returns 0 on success else a negative value.
185 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
186 struct lttng_consumer_local_data
*ctx
)
189 struct lttng_pipe
*stream_pipe
;
191 /* Get the right pipe where the stream will be sent. */
192 if (stream
->metadata_flag
) {
193 consumer_add_metadata_stream(stream
);
194 stream_pipe
= ctx
->consumer_metadata_pipe
;
196 consumer_add_data_stream(stream
);
197 stream_pipe
= ctx
->consumer_data_pipe
;
201 * From this point on, the stream's ownership has been moved away from
202 * the channel and it becomes globally visible. Hence, remove it from
203 * the local stream list to prevent the stream from being both local and
206 stream
->globally_visible
= 1;
207 cds_list_del(&stream
->send_node
);
209 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
211 ERR("Consumer write %s stream to pipe %d",
212 stream
->metadata_flag
? "metadata" : "data",
213 lttng_pipe_get_writefd(stream_pipe
));
214 if (stream
->metadata_flag
) {
215 consumer_del_stream_for_metadata(stream
);
217 consumer_del_stream_for_data(stream
);
227 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
229 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
232 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
233 stream_shm_path
[PATH_MAX
- 1] = '\0';
234 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
239 strncat(stream_shm_path
, cpu_nr
,
240 PATH_MAX
- strlen(stream_shm_path
) - 1);
247 * Create streams for the given channel using liblttng-ust-ctl.
248 * The channel lock must be acquired by the caller.
250 * Return 0 on success else a negative value.
252 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
253 struct lttng_consumer_local_data
*ctx
)
256 struct ustctl_consumer_stream
*ustream
;
257 struct lttng_consumer_stream
*stream
;
258 pthread_mutex_t
*current_stream_lock
= NULL
;
264 * While a stream is available from ustctl. When NULL is returned, we've
265 * reached the end of the possible stream for the channel.
267 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
269 int ust_metadata_pipe
[2];
271 health_code_update();
273 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
274 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
276 ERR("Create ust metadata poll pipe");
279 wait_fd
= ust_metadata_pipe
[0];
281 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
284 /* Allocate consumer stream object. */
285 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
289 stream
->ustream
= ustream
;
291 * Store it so we can save multiple function calls afterwards since
292 * this value is used heavily in the stream threads. This is UST
293 * specific so this is why it's done after allocation.
295 stream
->wait_fd
= wait_fd
;
298 * Increment channel refcount since the channel reference has now been
299 * assigned in the allocation process above.
301 if (stream
->chan
->monitor
) {
302 uatomic_inc(&stream
->chan
->refcount
);
305 pthread_mutex_lock(&stream
->lock
);
306 current_stream_lock
= &stream
->lock
;
308 * Order is important this is why a list is used. On error, the caller
309 * should clean this list.
311 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
313 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
314 &stream
->max_sb_size
);
316 ERR("ustctl_get_max_subbuf_size failed for stream %s",
321 /* Do actions once stream has been received. */
322 if (ctx
->on_recv_stream
) {
323 ret
= ctx
->on_recv_stream(stream
);
329 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
330 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
332 /* Set next CPU stream. */
333 channel
->streams
.count
= ++cpu
;
335 /* Keep stream reference when creating metadata. */
336 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
337 channel
->metadata_stream
= stream
;
338 if (channel
->monitor
) {
339 /* Set metadata poll pipe if we created one */
340 memcpy(stream
->ust_metadata_poll_pipe
,
342 sizeof(ust_metadata_pipe
));
345 pthread_mutex_unlock(&stream
->lock
);
346 current_stream_lock
= NULL
;
353 if (current_stream_lock
) {
354 pthread_mutex_unlock(current_stream_lock
);
360 * create_posix_shm is never called concurrently within a process.
363 int create_posix_shm(void)
365 char tmp_name
[NAME_MAX
];
368 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
374 * Allocate shm, and immediately unlink its shm oject, keeping
375 * only the file descriptor as a reference to the object.
376 * We specifically do _not_ use the / at the beginning of the
377 * pathname so that some OS implementations can keep it local to
378 * the process (POSIX leaves this implementation-defined).
380 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
385 ret
= shm_unlink(tmp_name
);
386 if (ret
< 0 && errno
!= ENOENT
) {
387 PERROR("shm_unlink");
388 goto error_shm_release
;
401 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
,
402 const struct lttng_credentials
*session_credentials
)
404 char shm_path
[PATH_MAX
];
407 if (!channel
->shm_path
[0]) {
408 return create_posix_shm();
410 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
414 return run_as_open(shm_path
,
415 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
416 session_credentials
->uid
, session_credentials
->gid
);
423 * Create an UST channel with the given attributes and send it to the session
424 * daemon using the ust ctl API.
426 * Return 0 on success or else a negative value.
428 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
429 struct ustctl_consumer_channel_attr
*attr
,
430 struct ustctl_consumer_channel
**ust_chanp
)
432 int ret
, nr_stream_fds
, i
, j
;
434 struct ustctl_consumer_channel
*ust_channel
;
439 assert(channel
->buffer_credentials
.is_set
);
441 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
442 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
443 "switch_timer_interval: %u, read_timer_interval: %u, "
444 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
445 attr
->num_subbuf
, attr
->switch_timer_interval
,
446 attr
->read_timer_interval
, attr
->output
, attr
->type
);
448 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
451 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
452 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
457 for (i
= 0; i
< nr_stream_fds
; i
++) {
458 stream_fds
[i
] = open_ust_stream_fd(channel
, i
,
459 &channel
->buffer_credentials
.value
);
460 if (stream_fds
[i
] < 0) {
465 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
470 channel
->nr_stream_fds
= nr_stream_fds
;
471 channel
->stream_fds
= stream_fds
;
472 *ust_chanp
= ust_channel
;
478 for (j
= i
- 1; j
>= 0; j
--) {
481 closeret
= close(stream_fds
[j
]);
485 if (channel
->shm_path
[0]) {
486 char shm_path
[PATH_MAX
];
488 closeret
= get_stream_shm_path(shm_path
,
489 channel
->shm_path
, j
);
491 ERR("Cannot get stream shm path");
493 closeret
= run_as_unlink(shm_path
,
494 channel
->buffer_credentials
.value
.uid
,
495 channel
->buffer_credentials
.value
.gid
);
497 PERROR("unlink %s", shm_path
);
501 /* Try to rmdir all directories under shm_path root. */
502 if (channel
->root_shm_path
[0]) {
503 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
504 channel
->buffer_credentials
.value
.uid
,
505 channel
->buffer_credentials
.value
.gid
,
506 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
514 * Send a single given stream to the session daemon using the sock.
516 * Return 0 on success else a negative value.
518 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
525 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
527 /* Send stream to session daemon. */
528 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
538 * Send channel to sessiond and relayd if applicable.
540 * Return 0 on success or else a negative value.
542 static int send_channel_to_sessiond_and_relayd(int sock
,
543 struct lttng_consumer_channel
*channel
,
544 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
546 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
547 struct lttng_consumer_stream
*stream
;
548 uint64_t net_seq_idx
= -1ULL;
554 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
556 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
557 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
559 health_code_update();
561 /* Try to send the stream to the relayd if one is available. */
562 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
563 stream
->key
, channel
->name
);
564 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
567 * Flag that the relayd was the problem here probably due to a
568 * communicaton error on the socket.
573 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
575 if (net_seq_idx
== -1ULL) {
576 net_seq_idx
= stream
->net_seq_idx
;
581 /* Inform sessiond that we are about to send channel and streams. */
582 ret
= consumer_send_status_msg(sock
, ret_code
);
583 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
585 * Either the session daemon is not responding or the relayd died so we
591 /* Send channel to sessiond. */
592 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
597 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
602 /* The channel was sent successfully to the sessiond at this point. */
603 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
605 health_code_update();
607 /* Send stream to session daemon. */
608 ret
= send_sessiond_stream(sock
, stream
);
614 /* Tell sessiond there is no more stream. */
615 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
620 DBG("UST consumer NULL stream sent to sessiond");
625 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
632 * Creates a channel and streams and add the channel it to the channel internal
633 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
636 * Return 0 on success or else, a negative value is returned and the channel
637 * MUST be destroyed by consumer_del_channel().
639 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
640 struct lttng_consumer_channel
*channel
,
641 struct ustctl_consumer_channel_attr
*attr
)
650 * This value is still used by the kernel consumer since for the kernel,
651 * the stream ownership is not IN the consumer so we need to have the
652 * number of left stream that needs to be initialized so we can know when
653 * to delete the channel (see consumer.c).
655 * As for the user space tracer now, the consumer creates and sends the
656 * stream to the session daemon which only sends them to the application
657 * once every stream of a channel is received making this value useless
658 * because we they will be added to the poll thread before the application
659 * receives them. This ensures that a stream can not hang up during
660 * initilization of a channel.
662 channel
->nb_init_stream_left
= 0;
664 /* The reply msg status is handled in the following call. */
665 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
670 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
673 * For the snapshots (no monitor), we create the metadata streams
674 * on demand, not during the channel creation.
676 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
681 /* Open all streams for this channel. */
682 pthread_mutex_lock(&channel
->lock
);
683 ret
= create_ust_streams(channel
, ctx
);
684 pthread_mutex_unlock(&channel
->lock
);
694 * Send all stream of a channel to the right thread handling it.
696 * On error, return a negative value else 0 on success.
698 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
699 struct lttng_consumer_local_data
*ctx
)
702 struct lttng_consumer_stream
*stream
, *stmp
;
707 /* Send streams to the corresponding thread. */
708 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
711 health_code_update();
713 /* Sending the stream to the thread. */
714 ret
= send_stream_to_thread(stream
, ctx
);
717 * If we are unable to send the stream to the thread, there is
718 * a big problem so just stop everything.
729 * Flush channel's streams using the given key to retrieve the channel.
731 * Return 0 on success else an LTTng error code.
733 static int flush_channel(uint64_t chan_key
)
736 struct lttng_consumer_channel
*channel
;
737 struct lttng_consumer_stream
*stream
;
739 struct lttng_ht_iter iter
;
741 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
744 channel
= consumer_find_channel(chan_key
);
746 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
747 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
751 ht
= consumer_data
.stream_per_chan_id_ht
;
753 /* For each stream of the channel id, flush it. */
754 cds_lfht_for_each_entry_duplicate(ht
->ht
,
755 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
756 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
758 health_code_update();
760 pthread_mutex_lock(&stream
->lock
);
763 * Protect against concurrent teardown of a stream.
765 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
769 if (!stream
->quiescent
) {
770 ustctl_flush_buffer(stream
->ustream
, 0);
771 stream
->quiescent
= true;
774 pthread_mutex_unlock(&stream
->lock
);
782 * Clear quiescent state from channel's streams using the given key to
783 * retrieve the channel.
785 * Return 0 on success else an LTTng error code.
787 static int clear_quiescent_channel(uint64_t chan_key
)
790 struct lttng_consumer_channel
*channel
;
791 struct lttng_consumer_stream
*stream
;
793 struct lttng_ht_iter iter
;
795 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
798 channel
= consumer_find_channel(chan_key
);
800 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
801 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
805 ht
= consumer_data
.stream_per_chan_id_ht
;
807 /* For each stream of the channel id, clear quiescent state. */
808 cds_lfht_for_each_entry_duplicate(ht
->ht
,
809 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
810 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
812 health_code_update();
814 pthread_mutex_lock(&stream
->lock
);
815 stream
->quiescent
= false;
816 pthread_mutex_unlock(&stream
->lock
);
824 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
826 * Return 0 on success else an LTTng error code.
828 static int close_metadata(uint64_t chan_key
)
831 struct lttng_consumer_channel
*channel
;
832 unsigned int channel_monitor
;
834 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
836 channel
= consumer_find_channel(chan_key
);
839 * This is possible if the metadata thread has issue a delete because
840 * the endpoint point of the stream hung up. There is no way the
841 * session daemon can know about it thus use a DBG instead of an actual
844 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
845 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
849 pthread_mutex_lock(&consumer_data
.lock
);
850 pthread_mutex_lock(&channel
->lock
);
851 channel_monitor
= channel
->monitor
;
852 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
856 lttng_ustconsumer_close_metadata(channel
);
857 pthread_mutex_unlock(&channel
->lock
);
858 pthread_mutex_unlock(&consumer_data
.lock
);
861 * The ownership of a metadata channel depends on the type of
862 * session to which it belongs. In effect, the monitor flag is checked
863 * to determine if this metadata channel is in "snapshot" mode or not.
865 * In the non-snapshot case, the metadata channel is created along with
866 * a single stream which will remain present until the metadata channel
867 * is destroyed (on the destruction of its session). In this case, the
868 * metadata stream in "monitored" by the metadata poll thread and holds
869 * the ownership of its channel.
871 * Closing the metadata will cause the metadata stream's "metadata poll
872 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
873 * thread which will teardown the metadata stream which, in return,
874 * deletes the metadata channel.
876 * In the snapshot case, the metadata stream is created and destroyed
877 * on every snapshot record. Since the channel doesn't have an owner
878 * other than the session daemon, it is safe to destroy it immediately
879 * on reception of the CLOSE_METADATA command.
881 if (!channel_monitor
) {
883 * The channel and consumer_data locks must be
884 * released before this call since consumer_del_channel
885 * re-acquires the channel and consumer_data locks to teardown
886 * the channel and queue its reclamation by the "call_rcu"
889 consumer_del_channel(channel
);
894 pthread_mutex_unlock(&channel
->lock
);
895 pthread_mutex_unlock(&consumer_data
.lock
);
901 * RCU read side lock MUST be acquired before calling this function.
903 * Return 0 on success else an LTTng error code.
905 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
908 struct lttng_consumer_channel
*metadata
;
910 DBG("UST consumer setup metadata key %" PRIu64
, key
);
912 metadata
= consumer_find_channel(key
);
914 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
915 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
920 * In no monitor mode, the metadata channel has no stream(s) so skip the
921 * ownership transfer to the metadata thread.
923 if (!metadata
->monitor
) {
924 DBG("Metadata channel in no monitor");
930 * Send metadata stream to relayd if one available. Availability is
931 * known if the stream is still in the list of the channel.
933 if (cds_list_empty(&metadata
->streams
.head
)) {
934 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
935 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
936 goto error_no_stream
;
939 /* Send metadata stream to relayd if needed. */
940 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
941 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
944 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
947 ret
= consumer_send_relayd_streams_sent(
948 metadata
->metadata_stream
->net_seq_idx
);
950 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
956 * Ownership of metadata stream is passed along. Freeing is handled by
959 ret
= send_streams_to_thread(metadata
, ctx
);
962 * If we are unable to send the stream to the thread, there is
963 * a big problem so just stop everything.
965 ret
= LTTCOMM_CONSUMERD_FATAL
;
966 goto send_streams_error
;
968 /* List MUST be empty after or else it could be reused. */
969 assert(cds_list_empty(&metadata
->streams
.head
));
976 * Delete metadata channel on error. At this point, the metadata stream can
977 * NOT be monitored by the metadata thread thus having the guarantee that
978 * the stream is still in the local stream list of the channel. This call
979 * will make sure to clean that list.
981 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
982 cds_list_del(&metadata
->metadata_stream
->send_node
);
983 metadata
->metadata_stream
= NULL
;
991 * Snapshot the whole metadata.
992 * RCU read-side lock must be held by the caller.
994 * Returns 0 on success, < 0 on error
996 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
997 uint64_t key
, char *path
, uint64_t relayd_id
,
998 struct lttng_consumer_local_data
*ctx
)
1001 struct lttng_consumer_stream
*metadata_stream
;
1006 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
1011 assert(!metadata_channel
->monitor
);
1013 health_code_update();
1016 * Ask the sessiond if we have new metadata waiting and update the
1017 * consumer metadata cache.
1019 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
1024 health_code_update();
1027 * The metadata stream is NOT created in no monitor mode when the channel
1028 * is created on a sessiond ask channel command.
1030 ret
= create_ust_streams(metadata_channel
, ctx
);
1035 metadata_stream
= metadata_channel
->metadata_stream
;
1036 assert(metadata_stream
);
1038 pthread_mutex_lock(&metadata_stream
->lock
);
1039 if (relayd_id
!= (uint64_t) -1ULL) {
1040 metadata_stream
->net_seq_idx
= relayd_id
;
1041 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1043 ret
= consumer_stream_create_output_files(metadata_stream
,
1046 pthread_mutex_unlock(&metadata_stream
->lock
);
1052 health_code_update();
1054 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
, true);
1062 * Clean up the stream completly because the next snapshot will use a new
1065 consumer_stream_destroy(metadata_stream
, NULL
);
1066 cds_list_del(&metadata_stream
->send_node
);
1067 metadata_channel
->metadata_stream
= NULL
;
1075 int get_current_subbuf_addr(struct lttng_consumer_stream
*stream
,
1079 unsigned long mmap_offset
;
1080 const char *mmap_base
;
1082 mmap_base
= ustctl_get_mmap_base(stream
->ustream
);
1084 ERR("Failed to get mmap base for stream `%s`",
1090 ret
= ustctl_get_mmap_read_offset(stream
->ustream
, &mmap_offset
);
1092 ERR("Failed to get mmap offset for stream `%s`", stream
->name
);
1097 *addr
= mmap_base
+ mmap_offset
;
1104 * Take a snapshot of all the stream of a channel.
1105 * RCU read-side lock and the channel lock must be held by the caller.
1107 * Returns 0 on success, < 0 on error
1109 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1110 uint64_t key
, char *path
, uint64_t relayd_id
,
1111 uint64_t nb_packets_per_stream
,
1112 struct lttng_consumer_local_data
*ctx
)
1115 unsigned use_relayd
= 0;
1116 unsigned long consumed_pos
, produced_pos
;
1117 struct lttng_consumer_stream
*stream
;
1124 if (relayd_id
!= (uint64_t) -1ULL) {
1128 assert(!channel
->monitor
);
1129 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1131 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1132 health_code_update();
1134 /* Lock stream because we are about to change its state. */
1135 pthread_mutex_lock(&stream
->lock
);
1136 assert(channel
->trace_chunk
);
1137 if (!lttng_trace_chunk_get(channel
->trace_chunk
)) {
1139 * Can't happen barring an internal error as the channel
1140 * holds a reference to the trace chunk.
1142 ERR("Failed to acquire reference to channel's trace chunk");
1146 assert(!stream
->trace_chunk
);
1147 stream
->trace_chunk
= channel
->trace_chunk
;
1149 stream
->net_seq_idx
= relayd_id
;
1152 ret
= consumer_send_relayd_stream(stream
, path
);
1157 ret
= consumer_stream_create_output_files(stream
,
1162 DBG("UST consumer snapshot stream (%" PRIu64
")",
1167 * If tracing is active, we want to perform a "full" buffer flush.
1168 * Else, if quiescent, it has already been done by the prior stop.
1170 if (!stream
->quiescent
) {
1171 ustctl_flush_buffer(stream
->ustream
, 0);
1174 ret
= lttng_ustconsumer_take_snapshot(stream
);
1176 ERR("Taking UST snapshot");
1180 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1182 ERR("Produced UST snapshot position");
1186 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1188 ERR("Consumerd UST snapshot position");
1193 * The original value is sent back if max stream size is larger than
1194 * the possible size of the snapshot. Also, we assume that the session
1195 * daemon should never send a maximum stream size that is lower than
1198 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1199 produced_pos
, nb_packets_per_stream
,
1200 stream
->max_sb_size
);
1202 while ((long) (consumed_pos
- produced_pos
) < 0) {
1204 unsigned long len
, padded_len
;
1205 const char *subbuf_addr
;
1206 struct lttng_buffer_view subbuf_view
;
1208 health_code_update();
1210 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1212 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1214 if (ret
!= -EAGAIN
) {
1215 PERROR("ustctl_get_subbuf snapshot");
1216 goto error_close_stream
;
1218 DBG("UST consumer get subbuf failed. Skipping it.");
1219 consumed_pos
+= stream
->max_sb_size
;
1220 stream
->chan
->lost_packets
++;
1224 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1226 ERR("Snapshot ustctl_get_subbuf_size");
1227 goto error_put_subbuf
;
1230 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1232 ERR("Snapshot ustctl_get_padded_subbuf_size");
1233 goto error_put_subbuf
;
1236 ret
= get_current_subbuf_addr(stream
, &subbuf_addr
);
1238 goto error_put_subbuf
;
1241 subbuf_view
= lttng_buffer_view_init(
1242 subbuf_addr
, 0, padded_len
);
1243 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
,
1244 stream
, &subbuf_view
, padded_len
- len
);
1246 if (read_len
!= len
) {
1248 goto error_put_subbuf
;
1251 if (read_len
!= padded_len
) {
1253 goto error_put_subbuf
;
1257 ret
= ustctl_put_subbuf(stream
->ustream
);
1259 ERR("Snapshot ustctl_put_subbuf");
1260 goto error_close_stream
;
1262 consumed_pos
+= stream
->max_sb_size
;
1265 /* Simply close the stream so we can use it on the next snapshot. */
1266 consumer_stream_close(stream
);
1267 pthread_mutex_unlock(&stream
->lock
);
1274 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1275 ERR("Snapshot ustctl_put_subbuf");
1278 consumer_stream_close(stream
);
1280 pthread_mutex_unlock(&stream
->lock
);
1286 * Receive the metadata updates from the sessiond. Supports receiving
1287 * overlapping metadata, but is needs to always belong to a contiguous
1288 * range starting from 0.
1289 * Be careful about the locks held when calling this function: it needs
1290 * the metadata cache flush to concurrently progress in order to
1293 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1294 uint64_t len
, uint64_t version
,
1295 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1297 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1300 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1302 metadata_str
= zmalloc(len
* sizeof(char));
1303 if (!metadata_str
) {
1304 PERROR("zmalloc metadata string");
1305 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1309 health_code_update();
1311 /* Receive metadata string. */
1312 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1314 /* Session daemon is dead so return gracefully. */
1319 health_code_update();
1321 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1322 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1325 /* Unable to handle metadata. Notify session daemon. */
1326 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1328 * Skip metadata flush on write error since the offset and len might
1329 * not have been updated which could create an infinite loop below when
1330 * waiting for the metadata cache to be flushed.
1332 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1335 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1340 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1341 DBG("Waiting for metadata to be flushed");
1343 health_code_update();
1345 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1355 * Receive command from session daemon and process it.
1357 * Return 1 on success else a negative value or 0.
1359 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1360 int sock
, struct pollfd
*consumer_sockpoll
)
1363 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1364 struct lttcomm_consumer_msg msg
;
1365 struct lttng_consumer_channel
*channel
= NULL
;
1367 health_code_update();
1369 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1370 if (ret
!= sizeof(msg
)) {
1371 DBG("Consumer received unexpected message size %zd (expects %zu)",
1374 * The ret value might 0 meaning an orderly shutdown but this is ok
1375 * since the caller handles this.
1378 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1384 health_code_update();
1387 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1389 health_code_update();
1391 /* relayd needs RCU read-side lock */
1394 switch (msg
.cmd_type
) {
1395 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1397 /* Session daemon status message are handled in the following call. */
1398 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1399 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1400 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1401 msg
.u
.relayd_sock
.relayd_session_id
);
1404 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1406 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1407 struct consumer_relayd_sock_pair
*relayd
;
1409 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1411 /* Get relayd reference if exists. */
1412 relayd
= consumer_find_relayd(index
);
1413 if (relayd
== NULL
) {
1414 DBG("Unable to find relayd %" PRIu64
, index
);
1415 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1419 * Each relayd socket pair has a refcount of stream attached to it
1420 * which tells if the relayd is still active or not depending on the
1423 * This will set the destroy flag of the relayd object and destroy it
1424 * if the refcount reaches zero when called.
1426 * The destroy can happen either here or when a stream fd hangs up.
1429 consumer_flag_relayd_for_destroy(relayd
);
1432 goto end_msg_sessiond
;
1434 case LTTNG_CONSUMER_UPDATE_STREAM
:
1439 case LTTNG_CONSUMER_DATA_PENDING
:
1441 int ret
, is_data_pending
;
1442 uint64_t id
= msg
.u
.data_pending
.session_id
;
1444 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1446 is_data_pending
= consumer_data_pending(id
);
1448 /* Send back returned value to session daemon */
1449 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1450 sizeof(is_data_pending
));
1452 DBG("Error when sending the data pending ret code: %d", ret
);
1457 * No need to send back a status message since the data pending
1458 * returned value is the response.
1462 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1465 struct ustctl_consumer_channel_attr attr
;
1466 const uint64_t chunk_id
= msg
.u
.ask_channel
.chunk_id
.value
;
1467 const struct lttng_credentials buffer_credentials
= {
1468 .uid
= msg
.u
.ask_channel
.buffer_credentials
.uid
,
1469 .gid
= msg
.u
.ask_channel
.buffer_credentials
.gid
,
1472 /* Create a plain object and reserve a channel key. */
1473 channel
= consumer_allocate_channel(
1474 msg
.u
.ask_channel
.key
,
1475 msg
.u
.ask_channel
.session_id
,
1476 msg
.u
.ask_channel
.chunk_id
.is_set
?
1478 msg
.u
.ask_channel
.pathname
,
1479 msg
.u
.ask_channel
.name
,
1480 msg
.u
.ask_channel
.relayd_id
,
1481 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1482 msg
.u
.ask_channel
.tracefile_size
,
1483 msg
.u
.ask_channel
.tracefile_count
,
1484 msg
.u
.ask_channel
.session_id_per_pid
,
1485 msg
.u
.ask_channel
.monitor
,
1486 msg
.u
.ask_channel
.live_timer_interval
,
1487 msg
.u
.ask_channel
.is_live
,
1488 msg
.u
.ask_channel
.root_shm_path
,
1489 msg
.u
.ask_channel
.shm_path
);
1491 goto end_channel_error
;
1494 LTTNG_OPTIONAL_SET(&channel
->buffer_credentials
,
1495 buffer_credentials
);
1498 * Assign UST application UID to the channel. This value is ignored for
1499 * per PID buffers. This is specific to UST thus setting this after the
1502 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1504 /* Build channel attributes from received message. */
1505 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1506 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1507 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1508 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1509 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1510 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1511 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1512 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1514 /* Match channel buffer type to the UST abi. */
1515 switch (msg
.u
.ask_channel
.output
) {
1516 case LTTNG_EVENT_MMAP
:
1518 attr
.output
= LTTNG_UST_MMAP
;
1522 /* Translate and save channel type. */
1523 switch (msg
.u
.ask_channel
.type
) {
1524 case LTTNG_UST_CHAN_PER_CPU
:
1525 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1526 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1528 * Set refcount to 1 for owner. Below, we will
1529 * pass ownership to the
1530 * consumer_thread_channel_poll() thread.
1532 channel
->refcount
= 1;
1534 case LTTNG_UST_CHAN_METADATA
:
1535 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1536 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1543 health_code_update();
1545 ret
= ask_channel(ctx
, channel
, &attr
);
1547 goto end_channel_error
;
1550 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1551 ret
= consumer_metadata_cache_allocate(channel
);
1553 ERR("Allocating metadata cache");
1554 goto end_channel_error
;
1556 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1557 attr
.switch_timer_interval
= 0;
1559 int monitor_start_ret
;
1561 consumer_timer_live_start(channel
,
1562 msg
.u
.ask_channel
.live_timer_interval
);
1563 monitor_start_ret
= consumer_timer_monitor_start(
1565 msg
.u
.ask_channel
.monitor_timer_interval
);
1566 if (monitor_start_ret
< 0) {
1567 ERR("Starting channel monitoring timer failed");
1568 goto end_channel_error
;
1572 health_code_update();
1575 * Add the channel to the internal state AFTER all streams were created
1576 * and successfully sent to session daemon. This way, all streams must
1577 * be ready before this channel is visible to the threads.
1578 * If add_channel succeeds, ownership of the channel is
1579 * passed to consumer_thread_channel_poll().
1581 ret
= add_channel(channel
, ctx
);
1583 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1584 if (channel
->switch_timer_enabled
== 1) {
1585 consumer_timer_switch_stop(channel
);
1587 consumer_metadata_cache_destroy(channel
);
1589 if (channel
->live_timer_enabled
== 1) {
1590 consumer_timer_live_stop(channel
);
1592 if (channel
->monitor_timer_enabled
== 1) {
1593 consumer_timer_monitor_stop(channel
);
1595 goto end_channel_error
;
1598 health_code_update();
1601 * Channel and streams are now created. Inform the session daemon that
1602 * everything went well and should wait to receive the channel and
1603 * streams with ustctl API.
1605 ret
= consumer_send_status_channel(sock
, channel
);
1608 * There is probably a problem on the socket.
1615 case LTTNG_CONSUMER_GET_CHANNEL
:
1617 int ret
, relayd_err
= 0;
1618 uint64_t key
= msg
.u
.get_channel
.key
;
1619 struct lttng_consumer_channel
*channel
;
1621 channel
= consumer_find_channel(key
);
1623 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1624 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1625 goto end_get_channel
;
1628 health_code_update();
1630 /* Send the channel to sessiond (and relayd, if applicable). */
1631 ret
= send_channel_to_sessiond_and_relayd(sock
, channel
, ctx
,
1636 * We were unable to send to the relayd the stream so avoid
1637 * sending back a fatal error to the thread since this is OK
1638 * and the consumer can continue its work. The above call
1639 * has sent the error status message to the sessiond.
1641 goto end_get_channel_nosignal
;
1644 * The communicaton was broken hence there is a bad state between
1645 * the consumer and sessiond so stop everything.
1647 goto error_get_channel_fatal
;
1650 health_code_update();
1653 * In no monitor mode, the streams ownership is kept inside the channel
1654 * so don't send them to the data thread.
1656 if (!channel
->monitor
) {
1657 goto end_get_channel
;
1660 ret
= send_streams_to_thread(channel
, ctx
);
1663 * If we are unable to send the stream to the thread, there is
1664 * a big problem so just stop everything.
1666 goto error_get_channel_fatal
;
1668 /* List MUST be empty after or else it could be reused. */
1669 assert(cds_list_empty(&channel
->streams
.head
));
1671 goto end_msg_sessiond
;
1672 error_get_channel_fatal
:
1674 end_get_channel_nosignal
:
1677 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1679 uint64_t key
= msg
.u
.destroy_channel
.key
;
1682 * Only called if streams have not been sent to stream
1683 * manager thread. However, channel has been sent to
1684 * channel manager thread.
1686 notify_thread_del_channel(ctx
, key
);
1687 goto end_msg_sessiond
;
1689 case LTTNG_CONSUMER_CLOSE_METADATA
:
1693 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1698 goto end_msg_sessiond
;
1700 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1704 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1709 goto end_msg_sessiond
;
1711 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1715 ret
= clear_quiescent_channel(
1716 msg
.u
.clear_quiescent_channel
.key
);
1721 goto end_msg_sessiond
;
1723 case LTTNG_CONSUMER_PUSH_METADATA
:
1726 uint64_t len
= msg
.u
.push_metadata
.len
;
1727 uint64_t key
= msg
.u
.push_metadata
.key
;
1728 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1729 uint64_t version
= msg
.u
.push_metadata
.version
;
1730 struct lttng_consumer_channel
*channel
;
1732 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1735 channel
= consumer_find_channel(key
);
1738 * This is possible if the metadata creation on the consumer side
1739 * is in flight vis-a-vis a concurrent push metadata from the
1740 * session daemon. Simply return that the channel failed and the
1741 * session daemon will handle that message correctly considering
1742 * that this race is acceptable thus the DBG() statement here.
1744 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1745 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1746 goto end_push_metadata_msg_sessiond
;
1749 health_code_update();
1753 * There is nothing to receive. We have simply
1754 * checked whether the channel can be found.
1756 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1757 goto end_push_metadata_msg_sessiond
;
1760 /* Tell session daemon we are ready to receive the metadata. */
1761 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1763 /* Somehow, the session daemon is not responding anymore. */
1764 goto error_push_metadata_fatal
;
1767 health_code_update();
1769 /* Wait for more data. */
1770 health_poll_entry();
1771 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1774 goto error_push_metadata_fatal
;
1777 health_code_update();
1779 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1780 len
, version
, channel
, 0, 1);
1782 /* error receiving from sessiond */
1783 goto error_push_metadata_fatal
;
1786 goto end_push_metadata_msg_sessiond
;
1788 end_push_metadata_msg_sessiond
:
1789 goto end_msg_sessiond
;
1790 error_push_metadata_fatal
:
1793 case LTTNG_CONSUMER_SETUP_METADATA
:
1797 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1801 goto end_msg_sessiond
;
1803 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1805 struct lttng_consumer_channel
*channel
;
1806 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1808 channel
= consumer_find_channel(key
);
1810 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1811 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1813 if (msg
.u
.snapshot_channel
.metadata
) {
1814 ret
= snapshot_metadata(channel
, key
,
1815 msg
.u
.snapshot_channel
.pathname
,
1816 msg
.u
.snapshot_channel
.relayd_id
,
1819 ERR("Snapshot metadata failed");
1820 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1823 ret
= snapshot_channel(channel
, key
,
1824 msg
.u
.snapshot_channel
.pathname
,
1825 msg
.u
.snapshot_channel
.relayd_id
,
1826 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1829 ERR("Snapshot channel failed");
1830 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1834 health_code_update();
1835 ret
= consumer_send_status_msg(sock
, ret_code
);
1837 /* Somehow, the session daemon is not responding anymore. */
1840 health_code_update();
1843 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1846 uint64_t discarded_events
;
1847 struct lttng_ht_iter iter
;
1848 struct lttng_ht
*ht
;
1849 struct lttng_consumer_stream
*stream
;
1850 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1851 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1853 DBG("UST consumer discarded events command for session id %"
1856 pthread_mutex_lock(&consumer_data
.lock
);
1858 ht
= consumer_data
.stream_list_ht
;
1861 * We only need a reference to the channel, but they are not
1862 * directly indexed, so we just use the first matching stream
1863 * to extract the information we need, we default to 0 if not
1864 * found (no events are dropped if the channel is not yet in
1867 discarded_events
= 0;
1868 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1869 ht
->hash_fct(&id
, lttng_ht_seed
),
1871 &iter
.iter
, stream
, node_session_id
.node
) {
1872 if (stream
->chan
->key
== key
) {
1873 discarded_events
= stream
->chan
->discarded_events
;
1877 pthread_mutex_unlock(&consumer_data
.lock
);
1880 DBG("UST consumer discarded events command for session id %"
1881 PRIu64
", channel key %" PRIu64
, id
, key
);
1883 health_code_update();
1885 /* Send back returned value to session daemon */
1886 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1888 PERROR("send discarded events");
1894 case LTTNG_CONSUMER_LOST_PACKETS
:
1897 uint64_t lost_packets
;
1898 struct lttng_ht_iter iter
;
1899 struct lttng_ht
*ht
;
1900 struct lttng_consumer_stream
*stream
;
1901 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1902 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1904 DBG("UST consumer lost packets command for session id %"
1907 pthread_mutex_lock(&consumer_data
.lock
);
1909 ht
= consumer_data
.stream_list_ht
;
1912 * We only need a reference to the channel, but they are not
1913 * directly indexed, so we just use the first matching stream
1914 * to extract the information we need, we default to 0 if not
1915 * found (no packets lost if the channel is not yet in use).
1918 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1919 ht
->hash_fct(&id
, lttng_ht_seed
),
1921 &iter
.iter
, stream
, node_session_id
.node
) {
1922 if (stream
->chan
->key
== key
) {
1923 lost_packets
= stream
->chan
->lost_packets
;
1927 pthread_mutex_unlock(&consumer_data
.lock
);
1930 DBG("UST consumer lost packets command for session id %"
1931 PRIu64
", channel key %" PRIu64
, id
, key
);
1933 health_code_update();
1935 /* Send back returned value to session daemon */
1936 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1937 sizeof(lost_packets
));
1939 PERROR("send lost packets");
1945 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1947 int channel_monitor_pipe
;
1949 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1950 /* Successfully received the command's type. */
1951 ret
= consumer_send_status_msg(sock
, ret_code
);
1956 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1958 if (ret
!= sizeof(channel_monitor_pipe
)) {
1959 ERR("Failed to receive channel monitor pipe");
1963 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1964 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1965 channel_monitor_pipe
);
1969 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1970 /* Set the pipe as non-blocking. */
1971 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1973 PERROR("fcntl get flags of the channel monitoring pipe");
1978 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1979 flags
| O_NONBLOCK
);
1981 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1984 DBG("Channel monitor pipe set as non-blocking");
1986 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1988 goto end_msg_sessiond
;
1990 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
1992 struct lttng_consumer_channel
*channel
;
1993 uint64_t key
= msg
.u
.rotate_channel
.key
;
1995 channel
= consumer_find_channel(key
);
1997 DBG("Channel %" PRIu64
" not found", key
);
1998 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2001 * Sample the rotate position of all the streams in
2004 ret
= lttng_consumer_rotate_channel(channel
, key
,
2005 msg
.u
.rotate_channel
.relayd_id
,
2006 msg
.u
.rotate_channel
.metadata
,
2009 ERR("Rotate channel failed");
2010 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
2013 health_code_update();
2015 ret
= consumer_send_status_msg(sock
, ret_code
);
2017 /* Somehow, the session daemon is not responding anymore. */
2018 goto end_rotate_channel_nosignal
;
2022 * Rotate the streams that are ready right now.
2023 * FIXME: this is a second consecutive iteration over the
2024 * streams in a channel, there is probably a better way to
2025 * handle this, but it needs to be after the
2026 * consumer_send_status_msg() call.
2029 ret
= lttng_consumer_rotate_ready_streams(
2032 ERR("Rotate channel failed");
2036 end_rotate_channel_nosignal
:
2039 case LTTNG_CONSUMER_INIT
:
2041 ret_code
= lttng_consumer_init_command(ctx
,
2042 msg
.u
.init
.sessiond_uuid
);
2043 health_code_update();
2044 ret
= consumer_send_status_msg(sock
, ret_code
);
2046 /* Somehow, the session daemon is not responding anymore. */
2051 case LTTNG_CONSUMER_CREATE_TRACE_CHUNK
:
2053 const struct lttng_credentials credentials
= {
2054 .uid
= msg
.u
.create_trace_chunk
.credentials
.value
.uid
,
2055 .gid
= msg
.u
.create_trace_chunk
.credentials
.value
.gid
,
2057 const bool is_local_trace
=
2058 !msg
.u
.create_trace_chunk
.relayd_id
.is_set
;
2059 const uint64_t relayd_id
=
2060 msg
.u
.create_trace_chunk
.relayd_id
.value
;
2061 const char *chunk_override_name
=
2062 *msg
.u
.create_trace_chunk
.override_name
?
2063 msg
.u
.create_trace_chunk
.override_name
:
2065 LTTNG_OPTIONAL(struct lttng_directory_handle
) chunk_directory_handle
=
2066 LTTNG_OPTIONAL_INIT
;
2069 * The session daemon will only provide a chunk directory file
2070 * descriptor for local traces.
2072 if (is_local_trace
) {
2075 /* Acnowledge the reception of the command. */
2076 ret
= consumer_send_status_msg(sock
,
2077 LTTCOMM_CONSUMERD_SUCCESS
);
2079 /* Somehow, the session daemon is not responding anymore. */
2083 ret
= lttcomm_recv_fds_unix_sock(sock
, &chunk_dirfd
, 1);
2084 if (ret
!= sizeof(chunk_dirfd
)) {
2085 ERR("Failed to receive trace chunk directory file descriptor");
2089 DBG("Received trace chunk directory fd (%d)",
2091 ret
= lttng_directory_handle_init_from_dirfd(
2092 &chunk_directory_handle
.value
,
2095 ERR("Failed to initialize chunk directory handle from directory file descriptor");
2096 if (close(chunk_dirfd
)) {
2097 PERROR("Failed to close chunk directory file descriptor");
2101 chunk_directory_handle
.is_set
= true;
2104 ret_code
= lttng_consumer_create_trace_chunk(
2105 !is_local_trace
? &relayd_id
: NULL
,
2106 msg
.u
.create_trace_chunk
.session_id
,
2107 msg
.u
.create_trace_chunk
.chunk_id
,
2108 (time_t) msg
.u
.create_trace_chunk
2109 .creation_timestamp
,
2110 chunk_override_name
,
2111 msg
.u
.create_trace_chunk
.credentials
.is_set
?
2114 chunk_directory_handle
.is_set
?
2115 &chunk_directory_handle
.value
:
2118 if (chunk_directory_handle
.is_set
) {
2119 lttng_directory_handle_fini(
2120 &chunk_directory_handle
.value
);
2122 goto end_msg_sessiond
;
2124 case LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
:
2126 enum lttng_trace_chunk_command_type close_command
=
2127 msg
.u
.close_trace_chunk
.close_command
.value
;
2128 const uint64_t relayd_id
=
2129 msg
.u
.close_trace_chunk
.relayd_id
.value
;
2130 struct lttcomm_consumer_close_trace_chunk_reply reply
;
2131 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2134 ret_code
= lttng_consumer_close_trace_chunk(
2135 msg
.u
.close_trace_chunk
.relayd_id
.is_set
?
2138 msg
.u
.close_trace_chunk
.session_id
,
2139 msg
.u
.close_trace_chunk
.chunk_id
,
2140 (time_t) msg
.u
.close_trace_chunk
.close_timestamp
,
2141 msg
.u
.close_trace_chunk
.close_command
.is_set
?
2143 NULL
, closed_trace_chunk_path
);
2144 reply
.ret_code
= ret_code
;
2145 reply
.path_length
= strlen(closed_trace_chunk_path
) + 1;
2146 ret
= lttcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2147 if (ret
!= sizeof(reply
)) {
2150 ret
= lttcomm_send_unix_sock(sock
, closed_trace_chunk_path
,
2152 if (ret
!= reply
.path_length
) {
2157 case LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
:
2159 const uint64_t relayd_id
=
2160 msg
.u
.trace_chunk_exists
.relayd_id
.value
;
2162 ret_code
= lttng_consumer_trace_chunk_exists(
2163 msg
.u
.trace_chunk_exists
.relayd_id
.is_set
?
2165 msg
.u
.trace_chunk_exists
.session_id
,
2166 msg
.u
.trace_chunk_exists
.chunk_id
);
2167 goto end_msg_sessiond
;
2175 * Return 1 to indicate success since the 0 value can be a socket
2176 * shutdown during the recv() or send() call.
2183 * The returned value here is not useful since either way we'll return 1 to
2184 * the caller because the session daemon socket management is done
2185 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
2187 ret
= consumer_send_status_msg(sock
, ret_code
);
2197 * Free channel here since no one has a reference to it. We don't
2198 * free after that because a stream can store this pointer.
2200 destroy_channel(channel
);
2202 /* We have to send a status channel message indicating an error. */
2203 ret
= consumer_send_status_channel(sock
, NULL
);
2205 /* Stop everything if session daemon can not be notified. */
2212 /* This will issue a consumer stop. */
2218 health_code_update();
2222 void lttng_ustctl_flush_buffer(struct lttng_consumer_stream
*stream
,
2223 int producer_active
)
2226 assert(stream
->ustream
);
2228 ustctl_flush_buffer(stream
->ustream
, producer_active
);
2232 * Take a snapshot for a specific stream.
2234 * Returns 0 on success, < 0 on error
2236 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2239 assert(stream
->ustream
);
2241 return ustctl_snapshot(stream
->ustream
);
2245 * Sample consumed and produced positions for a specific stream.
2247 * Returns 0 on success, < 0 on error.
2249 int lttng_ustconsumer_sample_snapshot_positions(
2250 struct lttng_consumer_stream
*stream
)
2253 assert(stream
->ustream
);
2255 return ustctl_snapshot_sample_positions(stream
->ustream
);
2259 * Get the produced position
2261 * Returns 0 on success, < 0 on error
2263 int lttng_ustconsumer_get_produced_snapshot(
2264 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2267 assert(stream
->ustream
);
2270 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2274 * Get the consumed position
2276 * Returns 0 on success, < 0 on error
2278 int lttng_ustconsumer_get_consumed_snapshot(
2279 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2282 assert(stream
->ustream
);
2285 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2288 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2292 assert(stream
->ustream
);
2294 ustctl_flush_buffer(stream
->ustream
, producer
);
2297 int lttng_ustconsumer_get_current_timestamp(
2298 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2301 assert(stream
->ustream
);
2304 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2307 int lttng_ustconsumer_get_sequence_number(
2308 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2311 assert(stream
->ustream
);
2314 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2318 * Called when the stream signals the consumer that it has hung up.
2320 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2323 assert(stream
->ustream
);
2325 pthread_mutex_lock(&stream
->lock
);
2326 if (!stream
->quiescent
) {
2327 ustctl_flush_buffer(stream
->ustream
, 0);
2328 stream
->quiescent
= true;
2330 pthread_mutex_unlock(&stream
->lock
);
2331 stream
->hangup_flush_done
= 1;
2334 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2339 assert(chan
->uchan
);
2340 assert(chan
->buffer_credentials
.is_set
);
2342 if (chan
->switch_timer_enabled
== 1) {
2343 consumer_timer_switch_stop(chan
);
2345 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2348 ret
= close(chan
->stream_fds
[i
]);
2352 if (chan
->shm_path
[0]) {
2353 char shm_path
[PATH_MAX
];
2355 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2357 ERR("Cannot get stream shm path");
2359 ret
= run_as_unlink(shm_path
,
2360 chan
->buffer_credentials
.value
.uid
,
2361 chan
->buffer_credentials
.value
.gid
);
2363 PERROR("unlink %s", shm_path
);
2369 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2372 assert(chan
->uchan
);
2373 assert(chan
->buffer_credentials
.is_set
);
2375 consumer_metadata_cache_destroy(chan
);
2376 ustctl_destroy_channel(chan
->uchan
);
2377 /* Try to rmdir all directories under shm_path root. */
2378 if (chan
->root_shm_path
[0]) {
2379 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2380 chan
->buffer_credentials
.value
.uid
,
2381 chan
->buffer_credentials
.value
.gid
,
2382 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
2384 free(chan
->stream_fds
);
2387 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2390 assert(stream
->ustream
);
2392 if (stream
->chan
->switch_timer_enabled
== 1) {
2393 consumer_timer_switch_stop(stream
->chan
);
2395 ustctl_destroy_stream(stream
->ustream
);
2398 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2401 assert(stream
->ustream
);
2403 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2406 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2409 assert(stream
->ustream
);
2411 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2415 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
)
2417 DBG("Reset metadata cache of session %" PRIu64
,
2418 stream
->chan
->session_id
);
2419 stream
->ust_metadata_pushed
= 0;
2420 stream
->metadata_version
= stream
->chan
->metadata_cache
->version
;
2421 stream
->reset_metadata_flag
= 1;
2425 * Write up to one packet from the metadata cache to the channel.
2427 * Returns the number of bytes pushed in the cache, or a negative value
2431 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2436 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2437 if (stream
->chan
->metadata_cache
->max_offset
2438 == stream
->ust_metadata_pushed
) {
2443 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2444 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2445 stream
->chan
->metadata_cache
->max_offset
2446 - stream
->ust_metadata_pushed
);
2447 assert(write_len
!= 0);
2448 if (write_len
< 0) {
2449 ERR("Writing one metadata packet");
2453 stream
->ust_metadata_pushed
+= write_len
;
2455 assert(stream
->chan
->metadata_cache
->max_offset
>=
2456 stream
->ust_metadata_pushed
);
2460 * Switch packet (but don't open the next one) on every commit of
2461 * a metadata packet. Since the subbuffer is fully filled (with padding,
2462 * if needed), the stream is "quiescent" after this commit.
2464 ustctl_flush_buffer(stream
->ustream
, 1);
2465 stream
->quiescent
= true;
2467 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2473 * Sync metadata meaning request them to the session daemon and snapshot to the
2474 * metadata thread can consumer them.
2476 * Metadata stream lock is held here, but we need to release it when
2477 * interacting with sessiond, else we cause a deadlock with live
2478 * awaiting on metadata to be pushed out.
2480 * The RCU read side lock must be held by the caller.
2482 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2483 * is empty or a negative value on error.
2485 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2486 struct lttng_consumer_stream
*metadata_stream
)
2490 struct lttng_consumer_channel
*metadata_channel
;
2493 assert(metadata_stream
);
2495 metadata_channel
= metadata_stream
->chan
;
2496 pthread_mutex_unlock(&metadata_stream
->lock
);
2498 * Request metadata from the sessiond, but don't wait for the flush
2499 * because we locked the metadata thread.
2501 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 0);
2502 pthread_mutex_lock(&metadata_stream
->lock
);
2508 * The metadata stream and channel can be deleted while the
2509 * metadata stream lock was released. The streamed is checked
2510 * for deletion before we use it further.
2512 * Note that it is safe to access a logically-deleted stream since its
2513 * existence is still guaranteed by the RCU read side lock. However,
2514 * it should no longer be used. The close/deletion of the metadata
2515 * channel and stream already guarantees that all metadata has been
2516 * consumed. Therefore, there is nothing left to do in this function.
2518 if (consumer_stream_is_deleted(metadata_stream
)) {
2519 DBG("Metadata stream %" PRIu64
" was deleted during the metadata synchronization",
2520 metadata_stream
->key
);
2525 ret
= commit_one_metadata_packet(metadata_stream
);
2528 } else if (ret
> 0) {
2532 ret
= ustctl_snapshot(metadata_stream
->ustream
);
2534 if (errno
!= EAGAIN
) {
2535 ERR("Sync metadata, taking UST snapshot");
2538 DBG("No new metadata when syncing them.");
2539 /* No new metadata, exit. */
2545 * After this flush, we still need to extract metadata.
2556 * Return 0 on success else a negative value.
2558 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2559 struct lttng_consumer_local_data
*ctx
)
2562 struct ustctl_consumer_stream
*ustream
;
2567 ustream
= stream
->ustream
;
2570 * First, we are going to check if there is a new subbuffer available
2571 * before reading the stream wait_fd.
2573 /* Get the next subbuffer */
2574 ret
= ustctl_get_next_subbuf(ustream
);
2576 /* No more data found, flag the stream. */
2577 stream
->has_data
= 0;
2582 ret
= ustctl_put_subbuf(ustream
);
2585 /* This stream still has data. Flag it and wake up the data thread. */
2586 stream
->has_data
= 1;
2588 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2591 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2592 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2597 /* The wake up pipe has been notified. */
2598 ctx
->has_wakeup
= 1;
2606 static int consumer_stream_ust_on_wake_up(struct lttng_consumer_stream
*stream
)
2611 * We can consume the 1 byte written into the wait_fd by
2612 * UST. Don't trigger error if we cannot read this one byte
2613 * (read returns 0), or if the error is EAGAIN or EWOULDBLOCK.
2615 * This is only done when the stream is monitored by a thread,
2616 * before the flush is done after a hangup and if the stream
2617 * is not flagged with data since there might be nothing to
2618 * consume in the wait fd but still have data available
2619 * flagged by the consumer wake up pipe.
2621 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2625 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2626 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2634 static int extract_common_subbuffer_info(struct lttng_consumer_stream
*stream
,
2635 struct stream_subbuffer
*subbuf
)
2639 ret
= ustctl_get_subbuf_size(
2640 stream
->ustream
, &subbuf
->info
.data
.subbuf_size
);
2645 ret
= ustctl_get_padded_subbuf_size(
2646 stream
->ustream
, &subbuf
->info
.data
.padded_subbuf_size
);
2655 static int extract_metadata_subbuffer_info(struct lttng_consumer_stream
*stream
,
2656 struct stream_subbuffer
*subbuf
)
2660 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2665 subbuf
->info
.metadata
.version
= stream
->chan
->metadata_cache
->version
;
2671 static int extract_data_subbuffer_info(struct lttng_consumer_stream
*stream
,
2672 struct stream_subbuffer
*subbuf
)
2676 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2681 ret
= ustctl_get_packet_size(
2682 stream
->ustream
, &subbuf
->info
.data
.packet_size
);
2684 PERROR("Failed to get sub-buffer packet size");
2688 ret
= ustctl_get_content_size(
2689 stream
->ustream
, &subbuf
->info
.data
.content_size
);
2691 PERROR("Failed to get sub-buffer content size");
2695 ret
= ustctl_get_timestamp_begin(
2696 stream
->ustream
, &subbuf
->info
.data
.timestamp_begin
);
2698 PERROR("Failed to get sub-buffer begin timestamp");
2702 ret
= ustctl_get_timestamp_end(
2703 stream
->ustream
, &subbuf
->info
.data
.timestamp_end
);
2705 PERROR("Failed to get sub-buffer end timestamp");
2709 ret
= ustctl_get_events_discarded(
2710 stream
->ustream
, &subbuf
->info
.data
.events_discarded
);
2712 PERROR("Failed to get sub-buffer events discarded count");
2716 ret
= ustctl_get_sequence_number(stream
->ustream
,
2717 &subbuf
->info
.data
.sequence_number
.value
);
2719 /* May not be supported by older LTTng-modules. */
2720 if (ret
!= -ENOTTY
) {
2721 PERROR("Failed to get sub-buffer sequence number");
2725 subbuf
->info
.data
.sequence_number
.is_set
= true;
2728 ret
= ustctl_get_stream_id(
2729 stream
->ustream
, &subbuf
->info
.data
.stream_id
);
2731 PERROR("Failed to get stream id");
2735 ret
= ustctl_get_instance_id(stream
->ustream
,
2736 &subbuf
->info
.data
.stream_instance_id
.value
);
2738 /* May not be supported by older LTTng-modules. */
2739 if (ret
!= -ENOTTY
) {
2740 PERROR("Failed to get stream instance id");
2744 subbuf
->info
.data
.stream_instance_id
.is_set
= true;
2750 static int get_next_subbuffer_common(struct lttng_consumer_stream
*stream
,
2751 struct stream_subbuffer
*subbuffer
)
2756 ret
= stream
->read_subbuffer_ops
.extract_subbuffer_info(
2762 ret
= get_current_subbuf_addr(stream
, &addr
);
2767 subbuffer
->buffer
.buffer
= lttng_buffer_view_init(
2768 addr
, 0, subbuffer
->info
.data
.padded_subbuf_size
);
2769 assert(subbuffer
->buffer
.buffer
.data
!= NULL
);
2774 static int get_next_subbuffer(struct lttng_consumer_stream
*stream
,
2775 struct stream_subbuffer
*subbuffer
)
2779 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2784 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2792 static int get_next_subbuffer_metadata(struct lttng_consumer_stream
*stream
,
2793 struct stream_subbuffer
*subbuffer
)
2797 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2799 ret
= commit_one_metadata_packet(stream
);
2802 } else if (ret
== 0) {
2803 /* Not an error, the cache is empty. */
2808 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2814 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2822 static int put_next_subbuffer(struct lttng_consumer_stream
*stream
,
2823 struct stream_subbuffer
*subbuffer
)
2825 const int ret
= ustctl_put_next_subbuf(stream
->ustream
);
2831 static int signal_metadata(struct lttng_consumer_stream
*stream
,
2832 struct lttng_consumer_local_data
*ctx
)
2834 return pthread_cond_broadcast(&stream
->metadata_rdv
) ? -errno
: 0;
2837 static void lttng_ustconsumer_set_stream_ops(
2838 struct lttng_consumer_stream
*stream
)
2840 stream
->read_subbuffer_ops
.on_wake_up
= consumer_stream_ust_on_wake_up
;
2841 if (stream
->metadata_flag
) {
2842 stream
->read_subbuffer_ops
.get_next_subbuffer
=
2843 get_next_subbuffer_metadata
;
2844 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
2845 extract_metadata_subbuffer_info
;
2846 stream
->read_subbuffer_ops
.reset_metadata
=
2847 metadata_stream_reset_cache
;
2848 stream
->read_subbuffer_ops
.on_sleep
= signal_metadata
;
2850 stream
->read_subbuffer_ops
.get_next_subbuffer
=
2852 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
2853 extract_data_subbuffer_info
;
2854 stream
->read_subbuffer_ops
.on_sleep
= notify_if_more_data
;
2855 if (stream
->chan
->is_live
) {
2856 stream
->read_subbuffer_ops
.send_live_beacon
=
2857 consumer_flush_ust_index
;
2861 stream
->read_subbuffer_ops
.put_next_subbuffer
= put_next_subbuffer
;
2865 * Called when a stream is created.
2867 * Return 0 on success or else a negative value.
2869 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2876 * Don't create anything if this is set for streaming or if there is
2877 * no current trace chunk on the parent channel.
2879 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
&&
2880 stream
->chan
->trace_chunk
) {
2881 ret
= consumer_stream_create_output_files(stream
, true);
2887 lttng_ustconsumer_set_stream_ops(stream
);
2895 * Check if data is still being extracted from the buffers for a specific
2896 * stream. Consumer data lock MUST be acquired before calling this function
2897 * and the stream lock.
2899 * Return 1 if the traced data are still getting read else 0 meaning that the
2900 * data is available for trace viewer reading.
2902 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2907 assert(stream
->ustream
);
2909 DBG("UST consumer checking data pending");
2911 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2916 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2917 uint64_t contiguous
, pushed
;
2919 /* Ease our life a bit. */
2920 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2921 pushed
= stream
->ust_metadata_pushed
;
2924 * We can simply check whether all contiguously available data
2925 * has been pushed to the ring buffer, since the push operation
2926 * is performed within get_next_subbuf(), and because both
2927 * get_next_subbuf() and put_next_subbuf() are issued atomically
2928 * thanks to the stream lock within
2929 * lttng_ustconsumer_read_subbuffer(). This basically means that
2930 * whetnever ust_metadata_pushed is incremented, the associated
2931 * metadata has been consumed from the metadata stream.
2933 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2934 contiguous
, pushed
);
2935 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2936 if ((contiguous
!= pushed
) ||
2937 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2938 ret
= 1; /* Data is pending */
2942 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2945 * There is still data so let's put back this
2948 ret
= ustctl_put_subbuf(stream
->ustream
);
2950 ret
= 1; /* Data is pending */
2955 /* Data is NOT pending so ready to be read. */
2963 * Stop a given metadata channel timer if enabled and close the wait fd which
2964 * is the poll pipe of the metadata stream.
2966 * This MUST be called with the metadata channel lock acquired.
2968 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2973 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2975 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2977 if (metadata
->switch_timer_enabled
== 1) {
2978 consumer_timer_switch_stop(metadata
);
2981 if (!metadata
->metadata_stream
) {
2986 * Closing write side so the thread monitoring the stream wakes up if any
2987 * and clean the metadata stream.
2989 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2990 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2992 PERROR("closing metadata pipe write side");
2994 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3002 * Close every metadata stream wait fd of the metadata hash table. This
3003 * function MUST be used very carefully so not to run into a race between the
3004 * metadata thread handling streams and this function closing their wait fd.
3006 * For UST, this is used when the session daemon hangs up. Its the metadata
3007 * producer so calling this is safe because we are assured that no state change
3008 * can occur in the metadata thread for the streams in the hash table.
3010 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3012 struct lttng_ht_iter iter
;
3013 struct lttng_consumer_stream
*stream
;
3015 assert(metadata_ht
);
3016 assert(metadata_ht
->ht
);
3018 DBG("UST consumer closing all metadata streams");
3021 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3024 health_code_update();
3026 pthread_mutex_lock(&stream
->chan
->lock
);
3027 lttng_ustconsumer_close_metadata(stream
->chan
);
3028 pthread_mutex_unlock(&stream
->chan
->lock
);
3034 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3038 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
3040 ERR("Unable to close wakeup fd");
3045 * Please refer to consumer-timer.c before adding any lock within this
3046 * function or any of its callees. Timers have a very strict locking
3047 * semantic with respect to teardown. Failure to respect this semantic
3048 * introduces deadlocks.
3050 * DON'T hold the metadata lock when calling this function, else this
3051 * can cause deadlock involving consumer awaiting for metadata to be
3052 * pushed out due to concurrent interaction with the session daemon.
3054 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3055 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3057 struct lttcomm_metadata_request_msg request
;
3058 struct lttcomm_consumer_msg msg
;
3059 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3060 uint64_t len
, key
, offset
, version
;
3064 assert(channel
->metadata_cache
);
3066 memset(&request
, 0, sizeof(request
));
3068 /* send the metadata request to sessiond */
3069 switch (consumer_data
.type
) {
3070 case LTTNG_CONSUMER64_UST
:
3071 request
.bits_per_long
= 64;
3073 case LTTNG_CONSUMER32_UST
:
3074 request
.bits_per_long
= 32;
3077 request
.bits_per_long
= 0;
3081 request
.session_id
= channel
->session_id
;
3082 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3084 * Request the application UID here so the metadata of that application can
3085 * be sent back. The channel UID corresponds to the user UID of the session
3086 * used for the rights on the stream file(s).
3088 request
.uid
= channel
->ust_app_uid
;
3089 request
.key
= channel
->key
;
3091 DBG("Sending metadata request to sessiond, session id %" PRIu64
3092 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3093 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3096 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3098 health_code_update();
3100 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3103 ERR("Asking metadata to sessiond");
3107 health_code_update();
3109 /* Receive the metadata from sessiond */
3110 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3112 if (ret
!= sizeof(msg
)) {
3113 DBG("Consumer received unexpected message size %d (expects %zu)",
3115 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3117 * The ret value might 0 meaning an orderly shutdown but this is ok
3118 * since the caller handles this.
3123 health_code_update();
3125 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3126 /* No registry found */
3127 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3131 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3132 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3137 len
= msg
.u
.push_metadata
.len
;
3138 key
= msg
.u
.push_metadata
.key
;
3139 offset
= msg
.u
.push_metadata
.target_offset
;
3140 version
= msg
.u
.push_metadata
.version
;
3142 assert(key
== channel
->key
);
3144 DBG("No new metadata to receive for key %" PRIu64
, key
);
3147 health_code_update();
3149 /* Tell session daemon we are ready to receive the metadata. */
3150 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3151 LTTCOMM_CONSUMERD_SUCCESS
);
3152 if (ret
< 0 || len
== 0) {
3154 * Somehow, the session daemon is not responding anymore or there is
3155 * nothing to receive.
3160 health_code_update();
3162 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3163 key
, offset
, len
, version
, channel
, timer
, wait
);
3166 * Only send the status msg if the sessiond is alive meaning a positive
3169 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3174 health_code_update();
3176 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3181 * Return the ustctl call for the get stream id.
3183 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3184 uint64_t *stream_id
)
3189 return ustctl_get_stream_id(stream
->ustream
, stream_id
);