2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * SPDX-License-Identifier: GPL-2.0-only
12 #include <lttng/ust-ctl.h>
13 #include <lttng/ust-sigbus.h>
19 #include <sys/socket.h>
21 #include <sys/types.h>
24 #include <urcu/list.h>
29 #include <bin/lttng-consumerd/health-consumerd.h>
30 #include <common/common.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
32 #include <common/relayd/relayd.h>
33 #include <common/compat/fcntl.h>
34 #include <common/compat/endian.h>
35 #include <common/consumer/consumer-metadata-cache.h>
36 #include <common/consumer/consumer-stream.h>
37 #include <common/consumer/consumer-timer.h>
38 #include <common/utils.h>
39 #include <common/index/index.h>
40 #include <common/consumer/consumer.h>
41 #include <common/shm.h>
42 #include <common/optional.h>
44 #include "ust-consumer.h"
46 #define INT_MAX_STR_LEN 12 /* includes \0 */
48 extern struct lttng_consumer_global_data the_consumer_data
;
49 extern int consumer_poll_timeout
;
51 DEFINE_LTTNG_UST_SIGBUS_STATE();
54 * Free channel object and all streams associated with it. This MUST be used
55 * only and only if the channel has _NEVER_ been added to the global channel
58 static void destroy_channel(struct lttng_consumer_channel
*channel
)
60 struct lttng_consumer_stream
*stream
, *stmp
;
64 DBG("UST consumer cleaning stream list");
66 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
71 cds_list_del_init(&stream
->send_node
);
72 lttng_ust_ctl_destroy_stream(stream
->ustream
);
73 lttng_trace_chunk_put(stream
->trace_chunk
);
78 * If a channel is available meaning that was created before the streams
82 lttng_ustconsumer_del_channel(channel
);
83 lttng_ustconsumer_free_channel(channel
);
86 if (channel
->trace_chunk
) {
87 lttng_trace_chunk_put(channel
->trace_chunk
);
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_init(&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 lttng_ust_ctl_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
= lttng_ust_ctl_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
= lttng_ust_ctl_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
= lttng_ust_ctl_get_max_subbuf_size(stream
->ustream
,
314 &stream
->max_sb_size
);
316 ERR("lttng_ust_ctl_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
);
359 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
,
360 const struct lttng_credentials
*session_credentials
)
362 char shm_path
[PATH_MAX
];
365 if (!channel
->shm_path
[0]) {
366 return shm_create_anonymous("ust-consumer");
368 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
372 return run_as_open(shm_path
,
373 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
374 lttng_credentials_get_uid(session_credentials
),
375 lttng_credentials_get_gid(session_credentials
));
382 * Create an UST channel with the given attributes and send it to the session
383 * daemon using the ust ctl API.
385 * Return 0 on success or else a negative value.
387 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
388 struct lttng_ust_ctl_consumer_channel_attr
*attr
,
389 struct lttng_ust_ctl_consumer_channel
**ust_chanp
)
391 int ret
, nr_stream_fds
, i
, j
;
393 struct lttng_ust_ctl_consumer_channel
*ust_channel
;
398 assert(channel
->buffer_credentials
.is_set
);
400 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
401 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
402 "switch_timer_interval: %u, read_timer_interval: %u, "
403 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
404 attr
->num_subbuf
, attr
->switch_timer_interval
,
405 attr
->read_timer_interval
, attr
->output
, attr
->type
);
407 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
410 nr_stream_fds
= lttng_ust_ctl_get_nr_stream_per_channel();
411 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
416 for (i
= 0; i
< nr_stream_fds
; i
++) {
417 stream_fds
[i
] = open_ust_stream_fd(channel
, i
,
418 &channel
->buffer_credentials
.value
);
419 if (stream_fds
[i
] < 0) {
424 ust_channel
= lttng_ust_ctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
429 channel
->nr_stream_fds
= nr_stream_fds
;
430 channel
->stream_fds
= stream_fds
;
431 *ust_chanp
= ust_channel
;
437 for (j
= i
- 1; j
>= 0; j
--) {
440 closeret
= close(stream_fds
[j
]);
444 if (channel
->shm_path
[0]) {
445 char shm_path
[PATH_MAX
];
447 closeret
= get_stream_shm_path(shm_path
,
448 channel
->shm_path
, j
);
450 ERR("Cannot get stream shm path");
452 closeret
= run_as_unlink(shm_path
,
453 lttng_credentials_get_uid(LTTNG_OPTIONAL_GET_PTR(
454 channel
->buffer_credentials
)),
455 lttng_credentials_get_gid(LTTNG_OPTIONAL_GET_PTR(
456 channel
->buffer_credentials
)));
458 PERROR("unlink %s", shm_path
);
462 /* Try to rmdir all directories under shm_path root. */
463 if (channel
->root_shm_path
[0]) {
464 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
465 lttng_credentials_get_uid(LTTNG_OPTIONAL_GET_PTR(
466 channel
->buffer_credentials
)),
467 lttng_credentials_get_gid(LTTNG_OPTIONAL_GET_PTR(
468 channel
->buffer_credentials
)),
469 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
477 * Send a single given stream to the session daemon using the sock.
479 * Return 0 on success else a negative value.
481 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
488 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
490 /* Send stream to session daemon. */
491 ret
= lttng_ust_ctl_send_stream_to_sessiond(sock
, stream
->ustream
);
501 * Send channel to sessiond and relayd if applicable.
503 * Return 0 on success or else a negative value.
505 static int send_channel_to_sessiond_and_relayd(int sock
,
506 struct lttng_consumer_channel
*channel
,
507 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
509 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
510 struct lttng_consumer_stream
*stream
;
511 uint64_t net_seq_idx
= -1ULL;
517 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
519 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
520 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
522 health_code_update();
524 /* Try to send the stream to the relayd if one is available. */
525 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
526 stream
->key
, channel
->name
);
527 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
530 * Flag that the relayd was the problem here probably due to a
531 * communicaton error on the socket.
536 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
538 if (net_seq_idx
== -1ULL) {
539 net_seq_idx
= stream
->net_seq_idx
;
544 /* Inform sessiond that we are about to send channel and streams. */
545 ret
= consumer_send_status_msg(sock
, ret_code
);
546 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
548 * Either the session daemon is not responding or the relayd died so we
554 /* Send channel to sessiond. */
555 ret
= lttng_ust_ctl_send_channel_to_sessiond(sock
, channel
->uchan
);
560 ret
= lttng_ust_ctl_channel_close_wakeup_fd(channel
->uchan
);
565 /* The channel was sent successfully to the sessiond at this point. */
566 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
568 health_code_update();
570 /* Send stream to session daemon. */
571 ret
= send_sessiond_stream(sock
, stream
);
577 /* Tell sessiond there is no more stream. */
578 ret
= lttng_ust_ctl_send_stream_to_sessiond(sock
, NULL
);
583 DBG("UST consumer NULL stream sent to sessiond");
588 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
595 * Creates a channel and streams and add the channel it to the channel internal
596 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
599 * Return 0 on success or else, a negative value is returned and the channel
600 * MUST be destroyed by consumer_del_channel().
602 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
603 struct lttng_consumer_channel
*channel
,
604 struct lttng_ust_ctl_consumer_channel_attr
*attr
)
613 * This value is still used by the kernel consumer since for the kernel,
614 * the stream ownership is not IN the consumer so we need to have the
615 * number of left stream that needs to be initialized so we can know when
616 * to delete the channel (see consumer.c).
618 * As for the user space tracer now, the consumer creates and sends the
619 * stream to the session daemon which only sends them to the application
620 * once every stream of a channel is received making this value useless
621 * because we they will be added to the poll thread before the application
622 * receives them. This ensures that a stream can not hang up during
623 * initilization of a channel.
625 channel
->nb_init_stream_left
= 0;
627 /* The reply msg status is handled in the following call. */
628 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
633 channel
->wait_fd
= lttng_ust_ctl_channel_get_wait_fd(channel
->uchan
);
636 * For the snapshots (no monitor), we create the metadata streams
637 * on demand, not during the channel creation.
639 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
644 /* Open all streams for this channel. */
645 pthread_mutex_lock(&channel
->lock
);
646 ret
= create_ust_streams(channel
, ctx
);
647 pthread_mutex_unlock(&channel
->lock
);
657 * Send all stream of a channel to the right thread handling it.
659 * On error, return a negative value else 0 on success.
661 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
662 struct lttng_consumer_local_data
*ctx
)
665 struct lttng_consumer_stream
*stream
, *stmp
;
670 /* Send streams to the corresponding thread. */
671 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
674 health_code_update();
676 /* Sending the stream to the thread. */
677 ret
= send_stream_to_thread(stream
, ctx
);
680 * If we are unable to send the stream to the thread, there is
681 * a big problem so just stop everything.
692 * Flush channel's streams using the given key to retrieve the channel.
694 * Return 0 on success else an LTTng error code.
696 static int flush_channel(uint64_t chan_key
)
699 struct lttng_consumer_channel
*channel
;
700 struct lttng_consumer_stream
*stream
;
702 struct lttng_ht_iter iter
;
704 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
707 channel
= consumer_find_channel(chan_key
);
709 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
710 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
714 ht
= the_consumer_data
.stream_per_chan_id_ht
;
716 /* For each stream of the channel id, flush it. */
717 cds_lfht_for_each_entry_duplicate(ht
->ht
,
718 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
719 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
721 health_code_update();
723 pthread_mutex_lock(&stream
->lock
);
726 * Protect against concurrent teardown of a stream.
728 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
732 if (!stream
->quiescent
) {
733 ret
= lttng_ust_ctl_flush_buffer(stream
->ustream
, 0);
735 ERR("Failed to flush buffer while flushing channel: channel key = %" PRIu64
", channel name = '%s'",
736 chan_key
, channel
->name
);
737 ret
= LTTNG_ERR_BUFFER_FLUSH_FAILED
;
738 pthread_mutex_unlock(&stream
->lock
);
741 stream
->quiescent
= true;
744 pthread_mutex_unlock(&stream
->lock
);
752 * Clear quiescent state from channel's streams using the given key to
753 * retrieve the channel.
755 * Return 0 on success else an LTTng error code.
757 static int clear_quiescent_channel(uint64_t chan_key
)
760 struct lttng_consumer_channel
*channel
;
761 struct lttng_consumer_stream
*stream
;
763 struct lttng_ht_iter iter
;
765 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
768 channel
= consumer_find_channel(chan_key
);
770 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
771 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
775 ht
= the_consumer_data
.stream_per_chan_id_ht
;
777 /* For each stream of the channel id, clear quiescent state. */
778 cds_lfht_for_each_entry_duplicate(ht
->ht
,
779 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
780 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
782 health_code_update();
784 pthread_mutex_lock(&stream
->lock
);
785 stream
->quiescent
= false;
786 pthread_mutex_unlock(&stream
->lock
);
794 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
796 * Return 0 on success else an LTTng error code.
798 static int close_metadata(uint64_t chan_key
)
801 struct lttng_consumer_channel
*channel
;
802 unsigned int channel_monitor
;
804 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
806 channel
= consumer_find_channel(chan_key
);
809 * This is possible if the metadata thread has issue a delete because
810 * the endpoint point of the stream hung up. There is no way the
811 * session daemon can know about it thus use a DBG instead of an actual
814 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
815 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
819 pthread_mutex_lock(&the_consumer_data
.lock
);
820 pthread_mutex_lock(&channel
->lock
);
821 channel_monitor
= channel
->monitor
;
822 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
826 lttng_ustconsumer_close_metadata(channel
);
827 pthread_mutex_unlock(&channel
->lock
);
828 pthread_mutex_unlock(&the_consumer_data
.lock
);
831 * The ownership of a metadata channel depends on the type of
832 * session to which it belongs. In effect, the monitor flag is checked
833 * to determine if this metadata channel is in "snapshot" mode or not.
835 * In the non-snapshot case, the metadata channel is created along with
836 * a single stream which will remain present until the metadata channel
837 * is destroyed (on the destruction of its session). In this case, the
838 * metadata stream in "monitored" by the metadata poll thread and holds
839 * the ownership of its channel.
841 * Closing the metadata will cause the metadata stream's "metadata poll
842 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
843 * thread which will teardown the metadata stream which, in return,
844 * deletes the metadata channel.
846 * In the snapshot case, the metadata stream is created and destroyed
847 * on every snapshot record. Since the channel doesn't have an owner
848 * other than the session daemon, it is safe to destroy it immediately
849 * on reception of the CLOSE_METADATA command.
851 if (!channel_monitor
) {
853 * The channel and consumer_data locks must be
854 * released before this call since consumer_del_channel
855 * re-acquires the channel and consumer_data locks to teardown
856 * the channel and queue its reclamation by the "call_rcu"
859 consumer_del_channel(channel
);
864 pthread_mutex_unlock(&channel
->lock
);
865 pthread_mutex_unlock(&the_consumer_data
.lock
);
871 * RCU read side lock MUST be acquired before calling this function.
873 * Return 0 on success else an LTTng error code.
875 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
878 struct lttng_consumer_channel
*metadata
;
880 DBG("UST consumer setup metadata key %" PRIu64
, key
);
882 metadata
= consumer_find_channel(key
);
884 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
885 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
890 * In no monitor mode, the metadata channel has no stream(s) so skip the
891 * ownership transfer to the metadata thread.
893 if (!metadata
->monitor
) {
894 DBG("Metadata channel in no monitor");
900 * Send metadata stream to relayd if one available. Availability is
901 * known if the stream is still in the list of the channel.
903 if (cds_list_empty(&metadata
->streams
.head
)) {
904 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
905 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
906 goto error_no_stream
;
909 /* Send metadata stream to relayd if needed. */
910 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
911 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
914 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
917 ret
= consumer_send_relayd_streams_sent(
918 metadata
->metadata_stream
->net_seq_idx
);
920 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
926 * Ownership of metadata stream is passed along. Freeing is handled by
929 ret
= send_streams_to_thread(metadata
, ctx
);
932 * If we are unable to send the stream to the thread, there is
933 * a big problem so just stop everything.
935 ret
= LTTCOMM_CONSUMERD_FATAL
;
936 goto send_streams_error
;
938 /* List MUST be empty after or else it could be reused. */
939 assert(cds_list_empty(&metadata
->streams
.head
));
946 * Delete metadata channel on error. At this point, the metadata stream can
947 * NOT be monitored by the metadata thread thus having the guarantee that
948 * the stream is still in the local stream list of the channel. This call
949 * will make sure to clean that list.
951 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
952 metadata
->metadata_stream
= NULL
;
960 * Snapshot the whole metadata.
961 * RCU read-side lock must be held by the caller.
963 * Returns 0 on success, < 0 on error
965 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
966 uint64_t key
, char *path
, uint64_t relayd_id
,
967 struct lttng_consumer_local_data
*ctx
)
970 struct lttng_consumer_stream
*metadata_stream
;
975 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
980 assert(!metadata_channel
->monitor
);
982 health_code_update();
985 * Ask the sessiond if we have new metadata waiting and update the
986 * consumer metadata cache.
988 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
993 health_code_update();
996 * The metadata stream is NOT created in no monitor mode when the channel
997 * is created on a sessiond ask channel command.
999 ret
= create_ust_streams(metadata_channel
, ctx
);
1004 metadata_stream
= metadata_channel
->metadata_stream
;
1005 assert(metadata_stream
);
1007 metadata_stream
->read_subbuffer_ops
.lock(metadata_stream
);
1008 if (relayd_id
!= (uint64_t) -1ULL) {
1009 metadata_stream
->net_seq_idx
= relayd_id
;
1010 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1012 ret
= consumer_stream_create_output_files(metadata_stream
,
1020 health_code_update();
1021 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
, true);
1028 metadata_stream
->read_subbuffer_ops
.unlock(metadata_stream
);
1030 * Clean up the stream completely because the next snapshot will use a
1031 * new metadata stream.
1033 consumer_stream_destroy(metadata_stream
, NULL
);
1034 metadata_channel
->metadata_stream
= NULL
;
1042 int get_current_subbuf_addr(struct lttng_consumer_stream
*stream
,
1046 unsigned long mmap_offset
;
1047 const char *mmap_base
;
1049 mmap_base
= lttng_ust_ctl_get_mmap_base(stream
->ustream
);
1051 ERR("Failed to get mmap base for stream `%s`",
1057 ret
= lttng_ust_ctl_get_mmap_read_offset(stream
->ustream
, &mmap_offset
);
1059 ERR("Failed to get mmap offset for stream `%s`", stream
->name
);
1064 *addr
= mmap_base
+ mmap_offset
;
1071 * Take a snapshot of all the stream of a channel.
1072 * RCU read-side lock and the channel lock must be held by the caller.
1074 * Returns 0 on success, < 0 on error
1076 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1077 uint64_t key
, char *path
, uint64_t relayd_id
,
1078 uint64_t nb_packets_per_stream
,
1079 struct lttng_consumer_local_data
*ctx
)
1082 unsigned use_relayd
= 0;
1083 unsigned long consumed_pos
, produced_pos
;
1084 struct lttng_consumer_stream
*stream
;
1091 if (relayd_id
!= (uint64_t) -1ULL) {
1095 assert(!channel
->monitor
);
1096 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1098 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1099 health_code_update();
1101 /* Lock stream because we are about to change its state. */
1102 pthread_mutex_lock(&stream
->lock
);
1103 assert(channel
->trace_chunk
);
1104 if (!lttng_trace_chunk_get(channel
->trace_chunk
)) {
1106 * Can't happen barring an internal error as the channel
1107 * holds a reference to the trace chunk.
1109 ERR("Failed to acquire reference to channel's trace chunk");
1113 assert(!stream
->trace_chunk
);
1114 stream
->trace_chunk
= channel
->trace_chunk
;
1116 stream
->net_seq_idx
= relayd_id
;
1119 ret
= consumer_send_relayd_stream(stream
, path
);
1124 ret
= consumer_stream_create_output_files(stream
,
1129 DBG("UST consumer snapshot stream (%" PRIu64
")",
1134 * If tracing is active, we want to perform a "full" buffer flush.
1135 * Else, if quiescent, it has already been done by the prior stop.
1137 if (!stream
->quiescent
) {
1138 ret
= lttng_ust_ctl_flush_buffer(stream
->ustream
, 0);
1140 ERR("Failed to flush buffer during snapshot of channel: channel key = %" PRIu64
", channel name = '%s'",
1141 channel
->key
, channel
->name
);
1146 ret
= lttng_ustconsumer_take_snapshot(stream
);
1148 ERR("Taking UST snapshot");
1152 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1154 ERR("Produced UST snapshot position");
1158 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1160 ERR("Consumerd UST snapshot position");
1165 * The original value is sent back if max stream size is larger than
1166 * the possible size of the snapshot. Also, we assume that the session
1167 * daemon should never send a maximum stream size that is lower than
1170 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1171 produced_pos
, nb_packets_per_stream
,
1172 stream
->max_sb_size
);
1174 while ((long) (consumed_pos
- produced_pos
) < 0) {
1176 unsigned long len
, padded_len
;
1177 const char *subbuf_addr
;
1178 struct lttng_buffer_view subbuf_view
;
1180 health_code_update();
1182 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1184 ret
= lttng_ust_ctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1186 if (ret
!= -EAGAIN
) {
1187 PERROR("lttng_ust_ctl_get_subbuf snapshot");
1188 goto error_close_stream
;
1190 DBG("UST consumer get subbuf failed. Skipping it.");
1191 consumed_pos
+= stream
->max_sb_size
;
1192 stream
->chan
->lost_packets
++;
1196 ret
= lttng_ust_ctl_get_subbuf_size(stream
->ustream
, &len
);
1198 ERR("Snapshot lttng_ust_ctl_get_subbuf_size");
1199 goto error_put_subbuf
;
1202 ret
= lttng_ust_ctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1204 ERR("Snapshot lttng_ust_ctl_get_padded_subbuf_size");
1205 goto error_put_subbuf
;
1208 ret
= get_current_subbuf_addr(stream
, &subbuf_addr
);
1210 goto error_put_subbuf
;
1213 subbuf_view
= lttng_buffer_view_init(
1214 subbuf_addr
, 0, padded_len
);
1215 read_len
= lttng_consumer_on_read_subbuffer_mmap(
1216 stream
, &subbuf_view
, padded_len
- len
);
1218 if (read_len
!= len
) {
1220 goto error_put_subbuf
;
1223 if (read_len
!= padded_len
) {
1225 goto error_put_subbuf
;
1229 ret
= lttng_ust_ctl_put_subbuf(stream
->ustream
);
1231 ERR("Snapshot lttng_ust_ctl_put_subbuf");
1232 goto error_close_stream
;
1234 consumed_pos
+= stream
->max_sb_size
;
1237 /* Simply close the stream so we can use it on the next snapshot. */
1238 consumer_stream_close(stream
);
1239 pthread_mutex_unlock(&stream
->lock
);
1246 if (lttng_ust_ctl_put_subbuf(stream
->ustream
) < 0) {
1247 ERR("Snapshot lttng_ust_ctl_put_subbuf");
1250 consumer_stream_close(stream
);
1252 pthread_mutex_unlock(&stream
->lock
);
1258 void metadata_stream_reset_cache_consumed_position(
1259 struct lttng_consumer_stream
*stream
)
1261 ASSERT_LOCKED(stream
->lock
);
1263 DBG("Reset metadata cache of session %" PRIu64
,
1264 stream
->chan
->session_id
);
1265 stream
->ust_metadata_pushed
= 0;
1269 * Receive the metadata updates from the sessiond. Supports receiving
1270 * overlapping metadata, but is needs to always belong to a contiguous
1271 * range starting from 0.
1272 * Be careful about the locks held when calling this function: it needs
1273 * the metadata cache flush to concurrently progress in order to
1276 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1277 uint64_t len
, uint64_t version
,
1278 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1280 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1282 enum consumer_metadata_cache_write_status cache_write_status
;
1284 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1286 metadata_str
= zmalloc(len
* sizeof(char));
1287 if (!metadata_str
) {
1288 PERROR("zmalloc metadata string");
1289 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1293 health_code_update();
1295 /* Receive metadata string. */
1296 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1298 /* Session daemon is dead so return gracefully. */
1303 health_code_update();
1305 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1306 cache_write_status
= consumer_metadata_cache_write(
1307 channel
->metadata_cache
, offset
, len
, version
,
1309 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1310 switch (cache_write_status
) {
1311 case CONSUMER_METADATA_CACHE_WRITE_STATUS_NO_CHANGE
:
1313 * The write entirely overlapped with existing contents of the
1314 * same metadata version (same content); there is nothing to do.
1317 case CONSUMER_METADATA_CACHE_WRITE_STATUS_INVALIDATED
:
1319 * The metadata cache was invalidated (previously pushed
1320 * content has been overwritten). Reset the stream's consumed
1321 * metadata position to ensure the metadata poll thread consumes
1326 * channel::metadata_stream can be null when the metadata
1327 * channel is under a snapshot session type. No need to update
1328 * the stream position in that scenario.
1330 if (channel
->metadata_stream
!= NULL
) {
1331 pthread_mutex_lock(&channel
->metadata_stream
->lock
);
1332 metadata_stream_reset_cache_consumed_position(
1333 channel
->metadata_stream
);
1334 pthread_mutex_unlock(&channel
->metadata_stream
->lock
);
1336 /* Validate we are in snapshot mode. */
1337 assert(!channel
->monitor
);
1340 case CONSUMER_METADATA_CACHE_WRITE_STATUS_APPENDED_CONTENT
:
1342 * In both cases, the metadata poll thread has new data to
1345 ret
= consumer_metadata_wakeup_pipe(channel
);
1347 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1351 case CONSUMER_METADATA_CACHE_WRITE_STATUS_ERROR
:
1352 /* Unable to handle metadata. Notify session daemon. */
1353 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1355 * Skip metadata flush on write error since the offset and len might
1356 * not have been updated which could create an infinite loop below when
1357 * waiting for the metadata cache to be flushed.
1367 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1368 DBG("Waiting for metadata to be flushed");
1370 health_code_update();
1372 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1382 * Receive command from session daemon and process it.
1384 * Return 1 on success else a negative value or 0.
1386 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1387 int sock
, struct pollfd
*consumer_sockpoll
)
1390 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1391 struct lttcomm_consumer_msg msg
;
1392 struct lttng_consumer_channel
*channel
= NULL
;
1394 health_code_update();
1399 ret_recv
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1400 if (ret_recv
!= sizeof(msg
)) {
1401 DBG("Consumer received unexpected message size %zd (expects %zu)",
1402 ret_recv
, sizeof(msg
));
1404 * The ret value might 0 meaning an orderly shutdown but this is ok
1405 * since the caller handles this.
1408 lttng_consumer_send_error(ctx
,
1409 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1416 health_code_update();
1419 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1421 health_code_update();
1423 /* relayd needs RCU read-side lock */
1426 switch (msg
.cmd_type
) {
1427 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1429 uint32_t major
= msg
.u
.relayd_sock
.major
;
1430 uint32_t minor
= msg
.u
.relayd_sock
.minor
;
1431 enum lttcomm_sock_proto protocol
=
1432 (enum lttcomm_sock_proto
) msg
.u
.relayd_sock
1433 .relayd_socket_protocol
;
1435 /* Session daemon status message are handled in the following call. */
1436 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1437 msg
.u
.relayd_sock
.type
, ctx
, sock
,
1438 consumer_sockpoll
, msg
.u
.relayd_sock
.session_id
,
1439 msg
.u
.relayd_sock
.relayd_session_id
, major
,
1443 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1445 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1446 struct consumer_relayd_sock_pair
*relayd
;
1448 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1450 /* Get relayd reference if exists. */
1451 relayd
= consumer_find_relayd(index
);
1452 if (relayd
== NULL
) {
1453 DBG("Unable to find relayd %" PRIu64
, index
);
1454 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1458 * Each relayd socket pair has a refcount of stream attached to it
1459 * which tells if the relayd is still active or not depending on the
1462 * This will set the destroy flag of the relayd object and destroy it
1463 * if the refcount reaches zero when called.
1465 * The destroy can happen either here or when a stream fd hangs up.
1468 consumer_flag_relayd_for_destroy(relayd
);
1471 goto end_msg_sessiond
;
1473 case LTTNG_CONSUMER_UPDATE_STREAM
:
1478 case LTTNG_CONSUMER_DATA_PENDING
:
1480 int is_data_pending
;
1482 uint64_t id
= msg
.u
.data_pending
.session_id
;
1484 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1486 is_data_pending
= consumer_data_pending(id
);
1488 /* Send back returned value to session daemon */
1489 ret_send
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1490 sizeof(is_data_pending
));
1492 DBG("Error when sending the data pending ret code: %zd",
1498 * No need to send back a status message since the data pending
1499 * returned value is the response.
1503 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1505 int ret_ask_channel
, ret_add_channel
, ret_send
;
1506 struct lttng_ust_ctl_consumer_channel_attr attr
;
1507 const uint64_t chunk_id
= msg
.u
.ask_channel
.chunk_id
.value
;
1508 const struct lttng_credentials buffer_credentials
= {
1509 .uid
= LTTNG_OPTIONAL_INIT_VALUE(msg
.u
.ask_channel
.buffer_credentials
.uid
),
1510 .gid
= LTTNG_OPTIONAL_INIT_VALUE(msg
.u
.ask_channel
.buffer_credentials
.gid
),
1513 /* Create a plain object and reserve a channel key. */
1514 channel
= consumer_allocate_channel(
1515 msg
.u
.ask_channel
.key
,
1516 msg
.u
.ask_channel
.session_id
,
1517 msg
.u
.ask_channel
.chunk_id
.is_set
?
1519 msg
.u
.ask_channel
.pathname
,
1520 msg
.u
.ask_channel
.name
,
1521 msg
.u
.ask_channel
.relayd_id
,
1522 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1523 msg
.u
.ask_channel
.tracefile_size
,
1524 msg
.u
.ask_channel
.tracefile_count
,
1525 msg
.u
.ask_channel
.session_id_per_pid
,
1526 msg
.u
.ask_channel
.monitor
,
1527 msg
.u
.ask_channel
.live_timer_interval
,
1528 msg
.u
.ask_channel
.is_live
,
1529 msg
.u
.ask_channel
.root_shm_path
,
1530 msg
.u
.ask_channel
.shm_path
);
1532 goto end_channel_error
;
1535 LTTNG_OPTIONAL_SET(&channel
->buffer_credentials
,
1536 buffer_credentials
);
1539 * Assign UST application UID to the channel. This value is ignored for
1540 * per PID buffers. This is specific to UST thus setting this after the
1543 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1545 /* Build channel attributes from received message. */
1546 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1547 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1548 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1549 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1550 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1551 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1552 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1553 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1555 /* Match channel buffer type to the UST abi. */
1556 switch (msg
.u
.ask_channel
.output
) {
1557 case LTTNG_EVENT_MMAP
:
1559 attr
.output
= LTTNG_UST_ABI_MMAP
;
1563 /* Translate and save channel type. */
1564 switch (msg
.u
.ask_channel
.type
) {
1565 case LTTNG_UST_ABI_CHAN_PER_CPU
:
1566 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1567 attr
.type
= LTTNG_UST_ABI_CHAN_PER_CPU
;
1569 * Set refcount to 1 for owner. Below, we will
1570 * pass ownership to the
1571 * consumer_thread_channel_poll() thread.
1573 channel
->refcount
= 1;
1575 case LTTNG_UST_ABI_CHAN_METADATA
:
1576 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1577 attr
.type
= LTTNG_UST_ABI_CHAN_METADATA
;
1584 health_code_update();
1586 ret_ask_channel
= ask_channel(ctx
, channel
, &attr
);
1587 if (ret_ask_channel
< 0) {
1588 goto end_channel_error
;
1591 if (msg
.u
.ask_channel
.type
== LTTNG_UST_ABI_CHAN_METADATA
) {
1594 ret_allocate
= consumer_metadata_cache_allocate(
1596 if (ret_allocate
< 0) {
1597 ERR("Allocating metadata cache");
1598 goto end_channel_error
;
1600 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1601 attr
.switch_timer_interval
= 0;
1603 int monitor_start_ret
;
1605 consumer_timer_live_start(channel
,
1606 msg
.u
.ask_channel
.live_timer_interval
);
1607 monitor_start_ret
= consumer_timer_monitor_start(
1609 msg
.u
.ask_channel
.monitor_timer_interval
);
1610 if (monitor_start_ret
< 0) {
1611 ERR("Starting channel monitoring timer failed");
1612 goto end_channel_error
;
1616 health_code_update();
1619 * Add the channel to the internal state AFTER all streams were created
1620 * and successfully sent to session daemon. This way, all streams must
1621 * be ready before this channel is visible to the threads.
1622 * If add_channel succeeds, ownership of the channel is
1623 * passed to consumer_thread_channel_poll().
1625 ret_add_channel
= add_channel(channel
, ctx
);
1626 if (ret_add_channel
< 0) {
1627 if (msg
.u
.ask_channel
.type
== LTTNG_UST_ABI_CHAN_METADATA
) {
1628 if (channel
->switch_timer_enabled
== 1) {
1629 consumer_timer_switch_stop(channel
);
1631 consumer_metadata_cache_destroy(channel
);
1633 if (channel
->live_timer_enabled
== 1) {
1634 consumer_timer_live_stop(channel
);
1636 if (channel
->monitor_timer_enabled
== 1) {
1637 consumer_timer_monitor_stop(channel
);
1639 goto end_channel_error
;
1642 health_code_update();
1645 * Channel and streams are now created. Inform the session daemon that
1646 * everything went well and should wait to receive the channel and
1647 * streams with ustctl API.
1649 ret_send
= consumer_send_status_channel(sock
, channel
);
1652 * There is probably a problem on the socket.
1659 case LTTNG_CONSUMER_GET_CHANNEL
:
1661 int ret
, relayd_err
= 0;
1662 uint64_t key
= msg
.u
.get_channel
.key
;
1663 struct lttng_consumer_channel
*found_channel
;
1665 found_channel
= consumer_find_channel(key
);
1666 if (!found_channel
) {
1667 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1668 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1669 goto end_get_channel
;
1672 health_code_update();
1674 /* Send the channel to sessiond (and relayd, if applicable). */
1675 ret
= send_channel_to_sessiond_and_relayd(
1676 sock
, found_channel
, ctx
, &relayd_err
);
1680 * We were unable to send to the relayd the stream so avoid
1681 * sending back a fatal error to the thread since this is OK
1682 * and the consumer can continue its work. The above call
1683 * has sent the error status message to the sessiond.
1685 goto end_get_channel_nosignal
;
1688 * The communicaton was broken hence there is a bad state between
1689 * the consumer and sessiond so stop everything.
1691 goto error_get_channel_fatal
;
1694 health_code_update();
1697 * In no monitor mode, the streams ownership is kept inside the channel
1698 * so don't send them to the data thread.
1700 if (!found_channel
->monitor
) {
1701 goto end_get_channel
;
1704 ret
= send_streams_to_thread(found_channel
, ctx
);
1707 * If we are unable to send the stream to the thread, there is
1708 * a big problem so just stop everything.
1710 goto error_get_channel_fatal
;
1712 /* List MUST be empty after or else it could be reused. */
1713 assert(cds_list_empty(&found_channel
->streams
.head
));
1715 goto end_msg_sessiond
;
1716 error_get_channel_fatal
:
1718 end_get_channel_nosignal
:
1721 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1723 uint64_t key
= msg
.u
.destroy_channel
.key
;
1726 * Only called if streams have not been sent to stream
1727 * manager thread. However, channel has been sent to
1728 * channel manager thread.
1730 notify_thread_del_channel(ctx
, key
);
1731 goto end_msg_sessiond
;
1733 case LTTNG_CONSUMER_CLOSE_METADATA
:
1737 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1742 goto end_msg_sessiond
;
1744 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1748 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1753 goto end_msg_sessiond
;
1755 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1759 ret
= clear_quiescent_channel(
1760 msg
.u
.clear_quiescent_channel
.key
);
1765 goto end_msg_sessiond
;
1767 case LTTNG_CONSUMER_PUSH_METADATA
:
1770 uint64_t len
= msg
.u
.push_metadata
.len
;
1771 uint64_t key
= msg
.u
.push_metadata
.key
;
1772 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1773 uint64_t version
= msg
.u
.push_metadata
.version
;
1774 struct lttng_consumer_channel
*found_channel
;
1776 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1779 found_channel
= consumer_find_channel(key
);
1780 if (!found_channel
) {
1782 * This is possible if the metadata creation on the consumer side
1783 * is in flight vis-a-vis a concurrent push metadata from the
1784 * session daemon. Simply return that the channel failed and the
1785 * session daemon will handle that message correctly considering
1786 * that this race is acceptable thus the DBG() statement here.
1788 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1789 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1790 goto end_push_metadata_msg_sessiond
;
1793 health_code_update();
1797 * There is nothing to receive. We have simply
1798 * checked whether the channel can be found.
1800 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1801 goto end_push_metadata_msg_sessiond
;
1804 /* Tell session daemon we are ready to receive the metadata. */
1805 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1807 /* Somehow, the session daemon is not responding anymore. */
1808 goto error_push_metadata_fatal
;
1811 health_code_update();
1813 /* Wait for more data. */
1814 health_poll_entry();
1815 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1818 goto error_push_metadata_fatal
;
1821 health_code_update();
1823 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
, len
,
1824 version
, found_channel
, 0, 1);
1826 /* error receiving from sessiond */
1827 goto error_push_metadata_fatal
;
1830 goto end_push_metadata_msg_sessiond
;
1832 end_push_metadata_msg_sessiond
:
1833 goto end_msg_sessiond
;
1834 error_push_metadata_fatal
:
1837 case LTTNG_CONSUMER_SETUP_METADATA
:
1841 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1845 goto end_msg_sessiond
;
1847 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1849 struct lttng_consumer_channel
*found_channel
;
1850 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1853 found_channel
= consumer_find_channel(key
);
1854 if (!found_channel
) {
1855 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1856 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1858 if (msg
.u
.snapshot_channel
.metadata
) {
1861 ret_snapshot
= snapshot_metadata(found_channel
,
1863 msg
.u
.snapshot_channel
.pathname
,
1864 msg
.u
.snapshot_channel
.relayd_id
,
1866 if (ret_snapshot
< 0) {
1867 ERR("Snapshot metadata failed");
1868 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1873 ret_snapshot
= snapshot_channel(found_channel
,
1875 msg
.u
.snapshot_channel
.pathname
,
1876 msg
.u
.snapshot_channel
.relayd_id
,
1877 msg
.u
.snapshot_channel
1878 .nb_packets_per_stream
,
1880 if (ret_snapshot
< 0) {
1881 ERR("Snapshot channel failed");
1882 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1886 health_code_update();
1887 ret_send
= consumer_send_status_msg(sock
, ret_code
);
1889 /* Somehow, the session daemon is not responding anymore. */
1892 health_code_update();
1895 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1898 uint64_t discarded_events
;
1899 struct lttng_ht_iter iter
;
1900 struct lttng_ht
*ht
;
1901 struct lttng_consumer_stream
*stream
;
1902 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1903 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1905 DBG("UST consumer discarded events command for session id %"
1908 pthread_mutex_lock(&the_consumer_data
.lock
);
1910 ht
= the_consumer_data
.stream_list_ht
;
1913 * We only need a reference to the channel, but they are not
1914 * directly indexed, so we just use the first matching stream
1915 * to extract the information we need, we default to 0 if not
1916 * found (no events are dropped if the channel is not yet in
1919 discarded_events
= 0;
1920 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1921 ht
->hash_fct(&id
, lttng_ht_seed
),
1923 &iter
.iter
, stream
, node_session_id
.node
) {
1924 if (stream
->chan
->key
== key
) {
1925 discarded_events
= stream
->chan
->discarded_events
;
1929 pthread_mutex_unlock(&the_consumer_data
.lock
);
1932 DBG("UST consumer discarded events command for session id %"
1933 PRIu64
", channel key %" PRIu64
, id
, key
);
1935 health_code_update();
1937 /* Send back returned value to session daemon */
1938 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1940 PERROR("send discarded events");
1946 case LTTNG_CONSUMER_LOST_PACKETS
:
1949 uint64_t lost_packets
;
1950 struct lttng_ht_iter iter
;
1951 struct lttng_ht
*ht
;
1952 struct lttng_consumer_stream
*stream
;
1953 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1954 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1956 DBG("UST consumer lost packets command for session id %"
1959 pthread_mutex_lock(&the_consumer_data
.lock
);
1961 ht
= the_consumer_data
.stream_list_ht
;
1964 * We only need a reference to the channel, but they are not
1965 * directly indexed, so we just use the first matching stream
1966 * to extract the information we need, we default to 0 if not
1967 * found (no packets lost if the channel is not yet in use).
1970 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1971 ht
->hash_fct(&id
, lttng_ht_seed
),
1973 &iter
.iter
, stream
, node_session_id
.node
) {
1974 if (stream
->chan
->key
== key
) {
1975 lost_packets
= stream
->chan
->lost_packets
;
1979 pthread_mutex_unlock(&the_consumer_data
.lock
);
1982 DBG("UST consumer lost packets command for session id %"
1983 PRIu64
", channel key %" PRIu64
, id
, key
);
1985 health_code_update();
1987 /* Send back returned value to session daemon */
1988 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1989 sizeof(lost_packets
));
1991 PERROR("send lost packets");
1997 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1999 int channel_monitor_pipe
, ret_send
,
2000 ret_set_channel_monitor_pipe
;
2003 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2004 /* Successfully received the command's type. */
2005 ret_send
= consumer_send_status_msg(sock
, ret_code
);
2010 ret_recv
= lttcomm_recv_fds_unix_sock(
2011 sock
, &channel_monitor_pipe
, 1);
2012 if (ret_recv
!= sizeof(channel_monitor_pipe
)) {
2013 ERR("Failed to receive channel monitor pipe");
2017 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
2018 ret_set_channel_monitor_pipe
=
2019 consumer_timer_thread_set_channel_monitor_pipe(
2020 channel_monitor_pipe
);
2021 if (!ret_set_channel_monitor_pipe
) {
2025 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2026 /* Set the pipe as non-blocking. */
2027 ret_fcntl
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
2028 if (ret_fcntl
== -1) {
2029 PERROR("fcntl get flags of the channel monitoring pipe");
2034 ret_fcntl
= fcntl(channel_monitor_pipe
, F_SETFL
,
2035 flags
| O_NONBLOCK
);
2036 if (ret_fcntl
== -1) {
2037 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
2040 DBG("Channel monitor pipe set as non-blocking");
2042 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
2044 goto end_msg_sessiond
;
2046 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
2048 struct lttng_consumer_channel
*found_channel
;
2049 uint64_t key
= msg
.u
.rotate_channel
.key
;
2050 int ret_send_status
;
2052 found_channel
= consumer_find_channel(key
);
2053 if (!found_channel
) {
2054 DBG("Channel %" PRIu64
" not found", key
);
2055 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2060 * Sample the rotate position of all the streams in
2063 rotate_channel
= lttng_consumer_rotate_channel(
2065 msg
.u
.rotate_channel
.relayd_id
,
2066 msg
.u
.rotate_channel
.metadata
, ctx
);
2067 if (rotate_channel
< 0) {
2068 ERR("Rotate channel failed");
2069 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
2072 health_code_update();
2075 ret_send_status
= consumer_send_status_msg(sock
, ret_code
);
2076 if (ret_send_status
< 0) {
2077 /* Somehow, the session daemon is not responding anymore. */
2078 goto end_rotate_channel_nosignal
;
2082 * Rotate the streams that are ready right now.
2083 * FIXME: this is a second consecutive iteration over the
2084 * streams in a channel, there is probably a better way to
2085 * handle this, but it needs to be after the
2086 * consumer_send_status_msg() call.
2088 if (found_channel
) {
2089 int ret_rotate_read_streams
;
2091 ret_rotate_read_streams
=
2092 lttng_consumer_rotate_ready_streams(
2095 if (ret_rotate_read_streams
< 0) {
2096 ERR("Rotate channel failed");
2100 end_rotate_channel_nosignal
:
2103 case LTTNG_CONSUMER_CLEAR_CHANNEL
:
2105 struct lttng_consumer_channel
*found_channel
;
2106 uint64_t key
= msg
.u
.clear_channel
.key
;
2107 int ret_send_status
;
2109 found_channel
= consumer_find_channel(key
);
2110 if (!found_channel
) {
2111 DBG("Channel %" PRIu64
" not found", key
);
2112 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2114 int ret_clear_channel
;
2116 ret_clear_channel
= lttng_consumer_clear_channel(
2118 if (ret_clear_channel
) {
2119 ERR("Clear channel failed key %" PRIu64
, key
);
2120 ret_code
= ret_clear_channel
;
2123 health_code_update();
2125 ret_send_status
= consumer_send_status_msg(sock
, ret_code
);
2126 if (ret_send_status
< 0) {
2127 /* Somehow, the session daemon is not responding anymore. */
2132 case LTTNG_CONSUMER_INIT
:
2134 int ret_send_status
;
2136 ret_code
= lttng_consumer_init_command(ctx
,
2137 msg
.u
.init
.sessiond_uuid
);
2138 health_code_update();
2139 ret_send_status
= consumer_send_status_msg(sock
, ret_code
);
2140 if (ret_send_status
< 0) {
2141 /* Somehow, the session daemon is not responding anymore. */
2146 case LTTNG_CONSUMER_CREATE_TRACE_CHUNK
:
2148 const struct lttng_credentials credentials
= {
2149 .uid
= LTTNG_OPTIONAL_INIT_VALUE(msg
.u
.create_trace_chunk
.credentials
.value
.uid
),
2150 .gid
= LTTNG_OPTIONAL_INIT_VALUE(msg
.u
.create_trace_chunk
.credentials
.value
.gid
),
2152 const bool is_local_trace
=
2153 !msg
.u
.create_trace_chunk
.relayd_id
.is_set
;
2154 const uint64_t relayd_id
=
2155 msg
.u
.create_trace_chunk
.relayd_id
.value
;
2156 const char *chunk_override_name
=
2157 *msg
.u
.create_trace_chunk
.override_name
?
2158 msg
.u
.create_trace_chunk
.override_name
:
2160 struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
2163 * The session daemon will only provide a chunk directory file
2164 * descriptor for local traces.
2166 if (is_local_trace
) {
2168 int ret_send_status
;
2171 /* Acnowledge the reception of the command. */
2172 ret_send_status
= consumer_send_status_msg(
2173 sock
, LTTCOMM_CONSUMERD_SUCCESS
);
2174 if (ret_send_status
< 0) {
2175 /* Somehow, the session daemon is not responding anymore. */
2180 * Receive trace chunk domain dirfd.
2182 ret_recv
= lttcomm_recv_fds_unix_sock(
2183 sock
, &chunk_dirfd
, 1);
2184 if (ret_recv
!= sizeof(chunk_dirfd
)) {
2185 ERR("Failed to receive trace chunk domain directory file descriptor");
2189 DBG("Received trace chunk domain directory fd (%d)",
2191 chunk_directory_handle
= lttng_directory_handle_create_from_dirfd(
2193 if (!chunk_directory_handle
) {
2194 ERR("Failed to initialize chunk domain directory handle from directory file descriptor");
2195 if (close(chunk_dirfd
)) {
2196 PERROR("Failed to close chunk directory file descriptor");
2202 ret_code
= lttng_consumer_create_trace_chunk(
2203 !is_local_trace
? &relayd_id
: NULL
,
2204 msg
.u
.create_trace_chunk
.session_id
,
2205 msg
.u
.create_trace_chunk
.chunk_id
,
2206 (time_t) msg
.u
.create_trace_chunk
2207 .creation_timestamp
,
2208 chunk_override_name
,
2209 msg
.u
.create_trace_chunk
.credentials
.is_set
?
2212 chunk_directory_handle
);
2213 lttng_directory_handle_put(chunk_directory_handle
);
2214 goto end_msg_sessiond
;
2216 case LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
:
2218 enum lttng_trace_chunk_command_type close_command
=
2219 msg
.u
.close_trace_chunk
.close_command
.value
;
2220 const uint64_t relayd_id
=
2221 msg
.u
.close_trace_chunk
.relayd_id
.value
;
2222 struct lttcomm_consumer_close_trace_chunk_reply reply
;
2223 char closed_trace_chunk_path
[LTTNG_PATH_MAX
] = {};
2226 ret_code
= lttng_consumer_close_trace_chunk(
2227 msg
.u
.close_trace_chunk
.relayd_id
.is_set
?
2230 msg
.u
.close_trace_chunk
.session_id
,
2231 msg
.u
.close_trace_chunk
.chunk_id
,
2232 (time_t) msg
.u
.close_trace_chunk
.close_timestamp
,
2233 msg
.u
.close_trace_chunk
.close_command
.is_set
?
2235 NULL
, closed_trace_chunk_path
);
2236 reply
.ret_code
= ret_code
;
2237 reply
.path_length
= strlen(closed_trace_chunk_path
) + 1;
2238 ret
= lttcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2239 if (ret
!= sizeof(reply
)) {
2242 ret
= lttcomm_send_unix_sock(sock
, closed_trace_chunk_path
,
2244 if (ret
!= reply
.path_length
) {
2249 case LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
:
2251 const uint64_t relayd_id
=
2252 msg
.u
.trace_chunk_exists
.relayd_id
.value
;
2254 ret_code
= lttng_consumer_trace_chunk_exists(
2255 msg
.u
.trace_chunk_exists
.relayd_id
.is_set
?
2257 msg
.u
.trace_chunk_exists
.session_id
,
2258 msg
.u
.trace_chunk_exists
.chunk_id
);
2259 goto end_msg_sessiond
;
2261 case LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS
:
2263 const uint64_t key
= msg
.u
.open_channel_packets
.key
;
2264 struct lttng_consumer_channel
*found_channel
=
2265 consumer_find_channel(key
);
2267 if (found_channel
) {
2268 pthread_mutex_lock(&found_channel
->lock
);
2269 ret_code
= lttng_consumer_open_channel_packets(
2271 pthread_mutex_unlock(&found_channel
->lock
);
2274 * The channel could have disappeared in per-pid
2277 DBG("Channel %" PRIu64
" not found", key
);
2278 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2281 health_code_update();
2282 goto end_msg_sessiond
;
2290 * Return 1 to indicate success since the 0 value can be a socket
2291 * shutdown during the recv() or send() call.
2298 * The returned value here is not useful since either way we'll return 1 to
2299 * the caller because the session daemon socket management is done
2300 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
2303 int ret_send_status
;
2305 ret_send_status
= consumer_send_status_msg(sock
, ret_code
);
2306 if (ret_send_status
< 0) {
2317 * Free channel here since no one has a reference to it. We don't
2318 * free after that because a stream can store this pointer.
2320 destroy_channel(channel
);
2322 /* We have to send a status channel message indicating an error. */
2324 int ret_send_status
;
2326 ret_send_status
= consumer_send_status_channel(sock
, NULL
);
2327 if (ret_send_status
< 0) {
2328 /* Stop everything if session daemon can not be notified. */
2337 /* This will issue a consumer stop. */
2343 health_code_update();
2347 int lttng_ust_flush_buffer(struct lttng_consumer_stream
*stream
,
2348 int producer_active
)
2351 assert(stream
->ustream
);
2353 return lttng_ust_ctl_flush_buffer(stream
->ustream
, producer_active
);
2357 * Take a snapshot for a specific stream.
2359 * Returns 0 on success, < 0 on error
2361 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2364 assert(stream
->ustream
);
2366 return lttng_ust_ctl_snapshot(stream
->ustream
);
2370 * Sample consumed and produced positions for a specific stream.
2372 * Returns 0 on success, < 0 on error.
2374 int lttng_ustconsumer_sample_snapshot_positions(
2375 struct lttng_consumer_stream
*stream
)
2378 assert(stream
->ustream
);
2380 return lttng_ust_ctl_snapshot_sample_positions(stream
->ustream
);
2384 * Get the produced position
2386 * Returns 0 on success, < 0 on error
2388 int lttng_ustconsumer_get_produced_snapshot(
2389 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2392 assert(stream
->ustream
);
2395 return lttng_ust_ctl_snapshot_get_produced(stream
->ustream
, pos
);
2399 * Get the consumed position
2401 * Returns 0 on success, < 0 on error
2403 int lttng_ustconsumer_get_consumed_snapshot(
2404 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2407 assert(stream
->ustream
);
2410 return lttng_ust_ctl_snapshot_get_consumed(stream
->ustream
, pos
);
2413 int lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2417 assert(stream
->ustream
);
2419 return lttng_ust_ctl_flush_buffer(stream
->ustream
, producer
);
2422 int lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream
*stream
)
2425 assert(stream
->ustream
);
2427 return lttng_ust_ctl_clear_buffer(stream
->ustream
);
2430 int lttng_ustconsumer_get_current_timestamp(
2431 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2434 assert(stream
->ustream
);
2437 return lttng_ust_ctl_get_current_timestamp(stream
->ustream
, ts
);
2440 int lttng_ustconsumer_get_sequence_number(
2441 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2444 assert(stream
->ustream
);
2447 return lttng_ust_ctl_get_sequence_number(stream
->ustream
, seq
);
2451 * Called when the stream signals the consumer that it has hung up.
2453 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2456 assert(stream
->ustream
);
2458 pthread_mutex_lock(&stream
->lock
);
2459 if (!stream
->quiescent
) {
2460 if (lttng_ust_ctl_flush_buffer(stream
->ustream
, 0) < 0) {
2461 ERR("Failed to flush buffer on stream hang-up");
2463 stream
->quiescent
= true;
2466 pthread_mutex_unlock(&stream
->lock
);
2467 stream
->hangup_flush_done
= 1;
2470 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2475 assert(chan
->uchan
);
2476 assert(chan
->buffer_credentials
.is_set
);
2478 if (chan
->switch_timer_enabled
== 1) {
2479 consumer_timer_switch_stop(chan
);
2481 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2484 ret
= close(chan
->stream_fds
[i
]);
2488 if (chan
->shm_path
[0]) {
2489 char shm_path
[PATH_MAX
];
2491 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2493 ERR("Cannot get stream shm path");
2495 ret
= run_as_unlink(shm_path
,
2496 lttng_credentials_get_uid(LTTNG_OPTIONAL_GET_PTR(
2497 chan
->buffer_credentials
)),
2498 lttng_credentials_get_gid(LTTNG_OPTIONAL_GET_PTR(
2499 chan
->buffer_credentials
)));
2501 PERROR("unlink %s", shm_path
);
2507 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2510 assert(chan
->uchan
);
2511 assert(chan
->buffer_credentials
.is_set
);
2513 consumer_metadata_cache_destroy(chan
);
2514 lttng_ust_ctl_destroy_channel(chan
->uchan
);
2515 /* Try to rmdir all directories under shm_path root. */
2516 if (chan
->root_shm_path
[0]) {
2517 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2518 lttng_credentials_get_uid(LTTNG_OPTIONAL_GET_PTR(
2519 chan
->buffer_credentials
)),
2520 lttng_credentials_get_gid(LTTNG_OPTIONAL_GET_PTR(
2521 chan
->buffer_credentials
)),
2522 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
2524 free(chan
->stream_fds
);
2527 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2530 assert(stream
->ustream
);
2532 if (stream
->chan
->switch_timer_enabled
== 1) {
2533 consumer_timer_switch_stop(stream
->chan
);
2535 lttng_ust_ctl_destroy_stream(stream
->ustream
);
2538 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2541 assert(stream
->ustream
);
2543 return lttng_ust_ctl_stream_get_wakeup_fd(stream
->ustream
);
2546 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2549 assert(stream
->ustream
);
2551 return lttng_ust_ctl_stream_close_wakeup_fd(stream
->ustream
);
2555 * Write up to one packet from the metadata cache to the channel.
2557 * Returns the number of bytes pushed from the cache into the ring buffer, or a
2558 * negative value on error.
2561 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2566 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2567 if (stream
->chan
->metadata_cache
->contents
.size
==
2568 stream
->ust_metadata_pushed
) {
2570 * In the context of a user space metadata channel, a
2571 * change in version can be detected in two ways:
2572 * 1) During the pre-consume of the `read_subbuffer` loop,
2573 * 2) When populating the metadata ring buffer (i.e. here).
2575 * This function is invoked when there is no metadata
2576 * available in the ring-buffer. If all data was consumed
2577 * up to the size of the metadata cache, there is no metadata
2578 * to insert in the ring-buffer.
2580 * However, the metadata version could still have changed (a
2581 * regeneration without any new data will yield the same cache
2584 * The cache's version is checked for a version change and the
2585 * consumed position is reset if one occurred.
2587 * This check is only necessary for the user space domain as
2588 * it has to manage the cache explicitly. If this reset was not
2589 * performed, no metadata would be consumed (and no reset would
2590 * occur as part of the pre-consume) until the metadata size
2591 * exceeded the cache size.
2593 if (stream
->metadata_version
!=
2594 stream
->chan
->metadata_cache
->version
) {
2595 metadata_stream_reset_cache_consumed_position(stream
);
2596 consumer_stream_metadata_set_version(stream
,
2597 stream
->chan
->metadata_cache
->version
);
2604 write_len
= lttng_ust_ctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2605 &stream
->chan
->metadata_cache
->contents
.data
[stream
->ust_metadata_pushed
],
2606 stream
->chan
->metadata_cache
->contents
.size
-
2607 stream
->ust_metadata_pushed
);
2608 assert(write_len
!= 0);
2609 if (write_len
< 0) {
2610 ERR("Writing one metadata packet");
2614 stream
->ust_metadata_pushed
+= write_len
;
2616 assert(stream
->chan
->metadata_cache
->contents
.size
>=
2617 stream
->ust_metadata_pushed
);
2621 * Switch packet (but don't open the next one) on every commit of
2622 * a metadata packet. Since the subbuffer is fully filled (with padding,
2623 * if needed), the stream is "quiescent" after this commit.
2625 if (lttng_ust_ctl_flush_buffer(stream
->ustream
, 1)) {
2626 ERR("Failed to flush buffer while commiting one metadata packet");
2629 stream
->quiescent
= true;
2632 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2638 * Sync metadata meaning request them to the session daemon and snapshot to the
2639 * metadata thread can consumer them.
2641 * Metadata stream lock is held here, but we need to release it when
2642 * interacting with sessiond, else we cause a deadlock with live
2643 * awaiting on metadata to be pushed out.
2645 * The RCU read side lock must be held by the caller.
2647 enum sync_metadata_status
lttng_ustconsumer_sync_metadata(
2648 struct lttng_consumer_local_data
*ctx
,
2649 struct lttng_consumer_stream
*metadata_stream
)
2652 enum sync_metadata_status status
;
2653 struct lttng_consumer_channel
*metadata_channel
;
2656 assert(metadata_stream
);
2658 metadata_channel
= metadata_stream
->chan
;
2659 pthread_mutex_unlock(&metadata_stream
->lock
);
2661 * Request metadata from the sessiond, but don't wait for the flush
2662 * because we locked the metadata thread.
2664 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 0);
2665 pthread_mutex_lock(&metadata_stream
->lock
);
2667 status
= SYNC_METADATA_STATUS_ERROR
;
2672 * The metadata stream and channel can be deleted while the
2673 * metadata stream lock was released. The streamed is checked
2674 * for deletion before we use it further.
2676 * Note that it is safe to access a logically-deleted stream since its
2677 * existence is still guaranteed by the RCU read side lock. However,
2678 * it should no longer be used. The close/deletion of the metadata
2679 * channel and stream already guarantees that all metadata has been
2680 * consumed. Therefore, there is nothing left to do in this function.
2682 if (consumer_stream_is_deleted(metadata_stream
)) {
2683 DBG("Metadata stream %" PRIu64
" was deleted during the metadata synchronization",
2684 metadata_stream
->key
);
2685 status
= SYNC_METADATA_STATUS_NO_DATA
;
2689 ret
= commit_one_metadata_packet(metadata_stream
);
2691 status
= SYNC_METADATA_STATUS_ERROR
;
2693 } else if (ret
> 0) {
2694 status
= SYNC_METADATA_STATUS_NEW_DATA
;
2695 } else /* ret == 0 */ {
2696 status
= SYNC_METADATA_STATUS_NO_DATA
;
2700 ret
= lttng_ust_ctl_snapshot(metadata_stream
->ustream
);
2702 ERR("Failed to take a snapshot of the metadata ring-buffer positions, ret = %d", ret
);
2703 status
= SYNC_METADATA_STATUS_ERROR
;
2712 * Return 0 on success else a negative value.
2714 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2715 struct lttng_consumer_local_data
*ctx
)
2718 struct lttng_ust_ctl_consumer_stream
*ustream
;
2723 ustream
= stream
->ustream
;
2726 * First, we are going to check if there is a new subbuffer available
2727 * before reading the stream wait_fd.
2729 /* Get the next subbuffer */
2730 ret
= lttng_ust_ctl_get_next_subbuf(ustream
);
2732 /* No more data found, flag the stream. */
2733 stream
->has_data
= 0;
2738 ret
= lttng_ust_ctl_put_subbuf(ustream
);
2741 /* This stream still has data. Flag it and wake up the data thread. */
2742 stream
->has_data
= 1;
2744 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2747 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2748 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2753 /* The wake up pipe has been notified. */
2754 ctx
->has_wakeup
= 1;
2762 static int consumer_stream_ust_on_wake_up(struct lttng_consumer_stream
*stream
)
2767 * We can consume the 1 byte written into the wait_fd by
2768 * UST. Don't trigger error if we cannot read this one byte
2769 * (read returns 0), or if the error is EAGAIN or EWOULDBLOCK.
2771 * This is only done when the stream is monitored by a thread,
2772 * before the flush is done after a hangup and if the stream
2773 * is not flagged with data since there might be nothing to
2774 * consume in the wait fd but still have data available
2775 * flagged by the consumer wake up pipe.
2777 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2781 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2782 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2790 static int extract_common_subbuffer_info(struct lttng_consumer_stream
*stream
,
2791 struct stream_subbuffer
*subbuf
)
2795 ret
= lttng_ust_ctl_get_subbuf_size(
2796 stream
->ustream
, &subbuf
->info
.data
.subbuf_size
);
2801 ret
= lttng_ust_ctl_get_padded_subbuf_size(
2802 stream
->ustream
, &subbuf
->info
.data
.padded_subbuf_size
);
2811 static int extract_metadata_subbuffer_info(struct lttng_consumer_stream
*stream
,
2812 struct stream_subbuffer
*subbuf
)
2816 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2821 subbuf
->info
.metadata
.version
= stream
->metadata_version
;
2827 static int extract_data_subbuffer_info(struct lttng_consumer_stream
*stream
,
2828 struct stream_subbuffer
*subbuf
)
2832 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2837 ret
= lttng_ust_ctl_get_packet_size(
2838 stream
->ustream
, &subbuf
->info
.data
.packet_size
);
2840 PERROR("Failed to get sub-buffer packet size");
2844 ret
= lttng_ust_ctl_get_content_size(
2845 stream
->ustream
, &subbuf
->info
.data
.content_size
);
2847 PERROR("Failed to get sub-buffer content size");
2851 ret
= lttng_ust_ctl_get_timestamp_begin(
2852 stream
->ustream
, &subbuf
->info
.data
.timestamp_begin
);
2854 PERROR("Failed to get sub-buffer begin timestamp");
2858 ret
= lttng_ust_ctl_get_timestamp_end(
2859 stream
->ustream
, &subbuf
->info
.data
.timestamp_end
);
2861 PERROR("Failed to get sub-buffer end timestamp");
2865 ret
= lttng_ust_ctl_get_events_discarded(
2866 stream
->ustream
, &subbuf
->info
.data
.events_discarded
);
2868 PERROR("Failed to get sub-buffer events discarded count");
2872 ret
= lttng_ust_ctl_get_sequence_number(stream
->ustream
,
2873 &subbuf
->info
.data
.sequence_number
.value
);
2875 /* May not be supported by older LTTng-modules. */
2876 if (ret
!= -ENOTTY
) {
2877 PERROR("Failed to get sub-buffer sequence number");
2881 subbuf
->info
.data
.sequence_number
.is_set
= true;
2884 ret
= lttng_ust_ctl_get_stream_id(
2885 stream
->ustream
, &subbuf
->info
.data
.stream_id
);
2887 PERROR("Failed to get stream id");
2891 ret
= lttng_ust_ctl_get_instance_id(stream
->ustream
,
2892 &subbuf
->info
.data
.stream_instance_id
.value
);
2894 /* May not be supported by older LTTng-modules. */
2895 if (ret
!= -ENOTTY
) {
2896 PERROR("Failed to get stream instance id");
2900 subbuf
->info
.data
.stream_instance_id
.is_set
= true;
2906 static int get_next_subbuffer_common(struct lttng_consumer_stream
*stream
,
2907 struct stream_subbuffer
*subbuffer
)
2912 ret
= stream
->read_subbuffer_ops
.extract_subbuffer_info(
2918 ret
= get_current_subbuf_addr(stream
, &addr
);
2923 subbuffer
->buffer
.buffer
= lttng_buffer_view_init(
2924 addr
, 0, subbuffer
->info
.data
.padded_subbuf_size
);
2925 assert(subbuffer
->buffer
.buffer
.data
!= NULL
);
2930 static enum get_next_subbuffer_status
get_next_subbuffer(
2931 struct lttng_consumer_stream
*stream
,
2932 struct stream_subbuffer
*subbuffer
)
2935 enum get_next_subbuffer_status status
;
2937 ret
= lttng_ust_ctl_get_next_subbuf(stream
->ustream
);
2940 status
= GET_NEXT_SUBBUFFER_STATUS_OK
;
2945 * The caller only expects -ENODATA when there is no data to
2946 * read, but the kernel tracer returns -EAGAIN when there is
2947 * currently no data for a non-finalized stream, and -ENODATA
2948 * when there is no data for a finalized stream. Those can be
2949 * combined into a -ENODATA return value.
2951 status
= GET_NEXT_SUBBUFFER_STATUS_NO_DATA
;
2954 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
2958 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2960 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
2967 static enum get_next_subbuffer_status
get_next_subbuffer_metadata(
2968 struct lttng_consumer_stream
*stream
,
2969 struct stream_subbuffer
*subbuffer
)
2976 unsigned long consumed_pos
, produced_pos
;
2977 enum get_next_subbuffer_status status
;
2980 ret
= lttng_ust_ctl_get_next_subbuf(stream
->ustream
);
2982 got_subbuffer
= true;
2984 got_subbuffer
= false;
2985 if (ret
!= -EAGAIN
) {
2987 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
2993 * Determine if the cache is empty and ensure that a sub-buffer
2994 * is made available if the cache is not empty.
2996 if (!got_subbuffer
) {
2997 ret
= commit_one_metadata_packet(stream
);
2998 if (ret
< 0 && ret
!= -ENOBUFS
) {
2999 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
3001 } else if (ret
== 0) {
3002 /* Not an error, the cache is empty. */
3004 status
= GET_NEXT_SUBBUFFER_STATUS_NO_DATA
;
3007 cache_empty
= false;
3010 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
3011 cache_empty
= stream
->chan
->metadata_cache
->contents
.size
==
3012 stream
->ust_metadata_pushed
;
3013 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
3015 } while (!got_subbuffer
);
3017 /* Populate sub-buffer infos and view. */
3018 ret
= get_next_subbuffer_common(stream
, subbuffer
);
3020 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
3024 ret
= lttng_ustconsumer_sample_snapshot_positions(stream
);
3027 * -EAGAIN is not expected since we got a sub-buffer and haven't
3028 * pushed the consumption position yet (on put_next).
3030 PERROR("Failed to take a snapshot of metadata buffer positions");
3031 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
3035 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
3037 PERROR("Failed to get metadata consumed position");
3038 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
3042 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
3044 PERROR("Failed to get metadata produced position");
3045 status
= GET_NEXT_SUBBUFFER_STATUS_ERROR
;
3049 /* Last sub-buffer of the ring buffer ? */
3050 buffer_empty
= (consumed_pos
+ stream
->max_sb_size
) == produced_pos
;
3053 * The sessiond registry lock ensures that coherent units of metadata
3054 * are pushed to the consumer daemon at once. Hence, if a sub-buffer is
3055 * acquired, the cache is empty, and it is the only available sub-buffer
3056 * available, it is safe to assume that it is "coherent".
3058 coherent
= got_subbuffer
&& cache_empty
&& buffer_empty
;
3060 LTTNG_OPTIONAL_SET(&subbuffer
->info
.metadata
.coherent
, coherent
);
3061 status
= GET_NEXT_SUBBUFFER_STATUS_OK
;
3066 static int put_next_subbuffer(struct lttng_consumer_stream
*stream
,
3067 struct stream_subbuffer
*subbuffer
)
3069 const int ret
= lttng_ust_ctl_put_next_subbuf(stream
->ustream
);
3075 static int signal_metadata(struct lttng_consumer_stream
*stream
,
3076 struct lttng_consumer_local_data
*ctx
)
3078 ASSERT_LOCKED(stream
->metadata_rdv_lock
);
3079 return pthread_cond_broadcast(&stream
->metadata_rdv
) ? -errno
: 0;
3082 static int lttng_ustconsumer_set_stream_ops(
3083 struct lttng_consumer_stream
*stream
)
3087 stream
->read_subbuffer_ops
.on_wake_up
= consumer_stream_ust_on_wake_up
;
3088 if (stream
->metadata_flag
) {
3089 stream
->read_subbuffer_ops
.get_next_subbuffer
=
3090 get_next_subbuffer_metadata
;
3091 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
3092 extract_metadata_subbuffer_info
;
3093 stream
->read_subbuffer_ops
.reset_metadata
=
3094 metadata_stream_reset_cache_consumed_position
;
3095 if (stream
->chan
->is_live
) {
3096 stream
->read_subbuffer_ops
.on_sleep
= signal_metadata
;
3097 ret
= consumer_stream_enable_metadata_bucketization(
3104 stream
->read_subbuffer_ops
.get_next_subbuffer
=
3106 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
3107 extract_data_subbuffer_info
;
3108 stream
->read_subbuffer_ops
.on_sleep
= notify_if_more_data
;
3109 if (stream
->chan
->is_live
) {
3110 stream
->read_subbuffer_ops
.send_live_beacon
=
3111 consumer_flush_ust_index
;
3115 stream
->read_subbuffer_ops
.put_next_subbuffer
= put_next_subbuffer
;
3121 * Called when a stream is created.
3123 * Return 0 on success or else a negative value.
3125 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3132 * Don't create anything if this is set for streaming or if there is
3133 * no current trace chunk on the parent channel.
3135 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
&&
3136 stream
->chan
->trace_chunk
) {
3137 ret
= consumer_stream_create_output_files(stream
, true);
3143 lttng_ustconsumer_set_stream_ops(stream
);
3151 * Check if data is still being extracted from the buffers for a specific
3152 * stream. Consumer data lock MUST be acquired before calling this function
3153 * and the stream lock.
3155 * Return 1 if the traced data are still getting read else 0 meaning that the
3156 * data is available for trace viewer reading.
3158 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
3163 assert(stream
->ustream
);
3164 ASSERT_LOCKED(stream
->lock
);
3166 DBG("UST consumer checking data pending");
3168 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
3173 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
3174 uint64_t contiguous
, pushed
;
3176 /* Ease our life a bit. */
3177 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
3178 contiguous
= stream
->chan
->metadata_cache
->contents
.size
;
3179 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
3180 pushed
= stream
->ust_metadata_pushed
;
3183 * We can simply check whether all contiguously available data
3184 * has been pushed to the ring buffer, since the push operation
3185 * is performed within get_next_subbuf(), and because both
3186 * get_next_subbuf() and put_next_subbuf() are issued atomically
3187 * thanks to the stream lock within
3188 * lttng_ustconsumer_read_subbuffer(). This basically means that
3189 * whetnever ust_metadata_pushed is incremented, the associated
3190 * metadata has been consumed from the metadata stream.
3192 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
3193 contiguous
, pushed
);
3194 assert(((int64_t) (contiguous
- pushed
)) >= 0);
3195 if ((contiguous
!= pushed
) ||
3196 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
3197 ret
= 1; /* Data is pending */
3201 ret
= lttng_ust_ctl_get_next_subbuf(stream
->ustream
);
3204 * There is still data so let's put back this
3207 ret
= lttng_ust_ctl_put_subbuf(stream
->ustream
);
3209 ret
= 1; /* Data is pending */
3214 /* Data is NOT pending so ready to be read. */
3222 * Stop a given metadata channel timer if enabled and close the wait fd which
3223 * is the poll pipe of the metadata stream.
3225 * This MUST be called with the metadata channel lock acquired.
3227 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
3232 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
3234 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
3236 if (metadata
->switch_timer_enabled
== 1) {
3237 consumer_timer_switch_stop(metadata
);
3240 if (!metadata
->metadata_stream
) {
3245 * Closing write side so the thread monitoring the stream wakes up if any
3246 * and clean the metadata stream.
3248 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
3249 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
3251 PERROR("closing metadata pipe write side");
3253 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3261 * Close every metadata stream wait fd of the metadata hash table. This
3262 * function MUST be used very carefully so not to run into a race between the
3263 * metadata thread handling streams and this function closing their wait fd.
3265 * For UST, this is used when the session daemon hangs up. Its the metadata
3266 * producer so calling this is safe because we are assured that no state change
3267 * can occur in the metadata thread for the streams in the hash table.
3269 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3271 struct lttng_ht_iter iter
;
3272 struct lttng_consumer_stream
*stream
;
3274 assert(metadata_ht
);
3275 assert(metadata_ht
->ht
);
3277 DBG("UST consumer closing all metadata streams");
3280 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3283 health_code_update();
3285 pthread_mutex_lock(&stream
->chan
->lock
);
3286 lttng_ustconsumer_close_metadata(stream
->chan
);
3287 pthread_mutex_unlock(&stream
->chan
->lock
);
3293 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3297 ret
= lttng_ust_ctl_stream_close_wakeup_fd(stream
->ustream
);
3299 ERR("Unable to close wakeup fd");
3304 * Please refer to consumer-timer.c before adding any lock within this
3305 * function or any of its callees. Timers have a very strict locking
3306 * semantic with respect to teardown. Failure to respect this semantic
3307 * introduces deadlocks.
3309 * DON'T hold the metadata lock when calling this function, else this
3310 * can cause deadlock involving consumer awaiting for metadata to be
3311 * pushed out due to concurrent interaction with the session daemon.
3313 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3314 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3316 struct lttcomm_metadata_request_msg request
;
3317 struct lttcomm_consumer_msg msg
;
3318 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3319 uint64_t len
, key
, offset
, version
;
3323 assert(channel
->metadata_cache
);
3325 memset(&request
, 0, sizeof(request
));
3327 /* send the metadata request to sessiond */
3328 switch (the_consumer_data
.type
) {
3329 case LTTNG_CONSUMER64_UST
:
3330 request
.bits_per_long
= 64;
3332 case LTTNG_CONSUMER32_UST
:
3333 request
.bits_per_long
= 32;
3336 request
.bits_per_long
= 0;
3340 request
.session_id
= channel
->session_id
;
3341 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3343 * Request the application UID here so the metadata of that application can
3344 * be sent back. The channel UID corresponds to the user UID of the session
3345 * used for the rights on the stream file(s).
3347 request
.uid
= channel
->ust_app_uid
;
3348 request
.key
= channel
->key
;
3350 DBG("Sending metadata request to sessiond, session id %" PRIu64
3351 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3352 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3355 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3357 health_code_update();
3359 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3362 ERR("Asking metadata to sessiond");
3366 health_code_update();
3368 /* Receive the metadata from sessiond */
3369 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3371 if (ret
!= sizeof(msg
)) {
3372 DBG("Consumer received unexpected message size %d (expects %zu)",
3374 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3376 * The ret value might 0 meaning an orderly shutdown but this is ok
3377 * since the caller handles this.
3382 health_code_update();
3384 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3385 /* No registry found */
3386 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3390 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3391 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3396 len
= msg
.u
.push_metadata
.len
;
3397 key
= msg
.u
.push_metadata
.key
;
3398 offset
= msg
.u
.push_metadata
.target_offset
;
3399 version
= msg
.u
.push_metadata
.version
;
3401 assert(key
== channel
->key
);
3403 DBG("No new metadata to receive for key %" PRIu64
, key
);
3406 health_code_update();
3408 /* Tell session daemon we are ready to receive the metadata. */
3409 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3410 LTTCOMM_CONSUMERD_SUCCESS
);
3411 if (ret
< 0 || len
== 0) {
3413 * Somehow, the session daemon is not responding anymore or there is
3414 * nothing to receive.
3419 health_code_update();
3421 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3422 key
, offset
, len
, version
, channel
, timer
, wait
);
3425 * Only send the status msg if the sessiond is alive meaning a positive
3428 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3433 health_code_update();
3435 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3440 * Return the ustctl call for the get stream id.
3442 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3443 uint64_t *stream_id
)
3448 return lttng_ust_ctl_get_stream_id(stream
->ustream
, stream_id
);
3451 void lttng_ustconsumer_sigbus_handle(void *addr
)
3453 lttng_ust_ctl_sigbus_handle(addr
);