2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
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>
18 #include <sys/socket.h>
20 #include <sys/types.h>
23 #include <urcu/list.h>
28 #include <bin/lttng-consumerd/health-consumerd.h>
29 #include <common/common.h>
30 #include <common/sessiond-comm/sessiond-comm.h>
31 #include <common/relayd/relayd.h>
32 #include <common/compat/fcntl.h>
33 #include <common/compat/endian.h>
34 #include <common/consumer/consumer-metadata-cache.h>
35 #include <common/consumer/consumer-stream.h>
36 #include <common/consumer/consumer-timer.h>
37 #include <common/utils.h>
38 #include <common/index/index.h>
39 #include <common/consumer/consumer.h>
40 #include <common/optional.h>
42 #include "ust-consumer.h"
44 #define INT_MAX_STR_LEN 12 /* includes \0 */
46 extern struct lttng_consumer_global_data consumer_data
;
47 extern int consumer_poll_timeout
;
50 * Free channel object and all streams associated with it. This MUST be used
51 * only and only if the channel has _NEVER_ been added to the global channel
54 static void destroy_channel(struct lttng_consumer_channel
*channel
)
56 struct lttng_consumer_stream
*stream
, *stmp
;
60 DBG("UST consumer cleaning stream list");
62 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
67 cds_list_del(&stream
->send_node
);
68 ustctl_destroy_stream(stream
->ustream
);
69 lttng_trace_chunk_put(stream
->trace_chunk
);
74 * If a channel is available meaning that was created before the streams
78 lttng_ustconsumer_del_channel(channel
);
79 lttng_ustconsumer_free_channel(channel
);
82 if (channel
->trace_chunk
) {
83 lttng_trace_chunk_put(channel
->trace_chunk
);
90 * Add channel to internal consumer state.
92 * Returns 0 on success or else a negative value.
94 static int add_channel(struct lttng_consumer_channel
*channel
,
95 struct lttng_consumer_local_data
*ctx
)
102 if (ctx
->on_recv_channel
!= NULL
) {
103 ret
= ctx
->on_recv_channel(channel
);
105 ret
= consumer_add_channel(channel
, ctx
);
106 } else if (ret
< 0) {
107 /* Most likely an ENOMEM. */
108 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
112 ret
= consumer_add_channel(channel
, ctx
);
115 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
122 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
123 * error value if applicable is set in it else it is kept untouched.
125 * Return NULL on error else the newly allocated stream object.
127 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
128 struct lttng_consumer_channel
*channel
,
129 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
132 struct lttng_consumer_stream
*stream
= NULL
;
137 stream
= consumer_stream_create(
144 channel
->trace_chunk
,
149 if (stream
== NULL
) {
153 * We could not find the channel. Can happen if cpu hotplug
154 * happens while tearing down.
156 DBG3("Could not find channel");
161 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
167 consumer_stream_update_channel_attributes(stream
, channel
);
171 *_alloc_ret
= alloc_ret
;
177 * Send the given stream pointer to the corresponding thread.
179 * Returns 0 on success else a negative value.
181 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
182 struct lttng_consumer_local_data
*ctx
)
185 struct lttng_pipe
*stream_pipe
;
187 /* Get the right pipe where the stream will be sent. */
188 if (stream
->metadata_flag
) {
189 consumer_add_metadata_stream(stream
);
190 stream_pipe
= ctx
->consumer_metadata_pipe
;
192 consumer_add_data_stream(stream
);
193 stream_pipe
= ctx
->consumer_data_pipe
;
197 * From this point on, the stream's ownership has been moved away from
198 * the channel and it becomes globally visible. Hence, remove it from
199 * the local stream list to prevent the stream from being both local and
202 stream
->globally_visible
= 1;
203 cds_list_del(&stream
->send_node
);
205 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
207 ERR("Consumer write %s stream to pipe %d",
208 stream
->metadata_flag
? "metadata" : "data",
209 lttng_pipe_get_writefd(stream_pipe
));
210 if (stream
->metadata_flag
) {
211 consumer_del_stream_for_metadata(stream
);
213 consumer_del_stream_for_data(stream
);
223 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
225 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
228 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
229 stream_shm_path
[PATH_MAX
- 1] = '\0';
230 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
235 strncat(stream_shm_path
, cpu_nr
,
236 PATH_MAX
- strlen(stream_shm_path
) - 1);
243 * Create streams for the given channel using liblttng-ust-ctl.
244 * The channel lock must be acquired by the caller.
246 * Return 0 on success else a negative value.
248 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
249 struct lttng_consumer_local_data
*ctx
)
252 struct ustctl_consumer_stream
*ustream
;
253 struct lttng_consumer_stream
*stream
;
254 pthread_mutex_t
*current_stream_lock
= NULL
;
260 * While a stream is available from ustctl. When NULL is returned, we've
261 * reached the end of the possible stream for the channel.
263 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
265 int ust_metadata_pipe
[2];
267 health_code_update();
269 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
270 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
272 ERR("Create ust metadata poll pipe");
275 wait_fd
= ust_metadata_pipe
[0];
277 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
280 /* Allocate consumer stream object. */
281 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
285 stream
->ustream
= ustream
;
287 * Store it so we can save multiple function calls afterwards since
288 * this value is used heavily in the stream threads. This is UST
289 * specific so this is why it's done after allocation.
291 stream
->wait_fd
= wait_fd
;
294 * Increment channel refcount since the channel reference has now been
295 * assigned in the allocation process above.
297 if (stream
->chan
->monitor
) {
298 uatomic_inc(&stream
->chan
->refcount
);
301 pthread_mutex_lock(&stream
->lock
);
302 current_stream_lock
= &stream
->lock
;
304 * Order is important this is why a list is used. On error, the caller
305 * should clean this list.
307 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
309 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
310 &stream
->max_sb_size
);
312 ERR("ustctl_get_max_subbuf_size failed for stream %s",
317 /* Do actions once stream has been received. */
318 if (ctx
->on_recv_stream
) {
319 ret
= ctx
->on_recv_stream(stream
);
325 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
326 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
328 /* Set next CPU stream. */
329 channel
->streams
.count
= ++cpu
;
331 /* Keep stream reference when creating metadata. */
332 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
333 channel
->metadata_stream
= stream
;
334 if (channel
->monitor
) {
335 /* Set metadata poll pipe if we created one */
336 memcpy(stream
->ust_metadata_poll_pipe
,
338 sizeof(ust_metadata_pipe
));
341 pthread_mutex_unlock(&stream
->lock
);
342 current_stream_lock
= NULL
;
349 if (current_stream_lock
) {
350 pthread_mutex_unlock(current_stream_lock
);
356 * create_posix_shm is never called concurrently within a process.
359 int create_posix_shm(void)
361 char tmp_name
[NAME_MAX
];
364 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
370 * Allocate shm, and immediately unlink its shm oject, keeping
371 * only the file descriptor as a reference to the object.
372 * We specifically do _not_ use the / at the beginning of the
373 * pathname so that some OS implementations can keep it local to
374 * the process (POSIX leaves this implementation-defined).
376 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
381 ret
= shm_unlink(tmp_name
);
382 if (ret
< 0 && errno
!= ENOENT
) {
383 PERROR("shm_unlink");
384 goto error_shm_release
;
397 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
,
398 const struct lttng_credentials
*session_credentials
)
400 char shm_path
[PATH_MAX
];
403 if (!channel
->shm_path
[0]) {
404 return create_posix_shm();
406 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
410 return run_as_open(shm_path
,
411 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
412 session_credentials
->uid
, session_credentials
->gid
);
419 * Create an UST channel with the given attributes and send it to the session
420 * daemon using the ust ctl API.
422 * Return 0 on success or else a negative value.
424 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
425 struct ustctl_consumer_channel_attr
*attr
,
426 struct ustctl_consumer_channel
**ust_chanp
)
428 int ret
, nr_stream_fds
, i
, j
;
430 struct ustctl_consumer_channel
*ust_channel
;
435 assert(channel
->buffer_credentials
.is_set
);
437 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
438 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
439 "switch_timer_interval: %u, read_timer_interval: %u, "
440 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
441 attr
->num_subbuf
, attr
->switch_timer_interval
,
442 attr
->read_timer_interval
, attr
->output
, attr
->type
);
444 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
447 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
448 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
453 for (i
= 0; i
< nr_stream_fds
; i
++) {
454 stream_fds
[i
] = open_ust_stream_fd(channel
, i
,
455 &channel
->buffer_credentials
.value
);
456 if (stream_fds
[i
] < 0) {
461 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
466 channel
->nr_stream_fds
= nr_stream_fds
;
467 channel
->stream_fds
= stream_fds
;
468 *ust_chanp
= ust_channel
;
474 for (j
= i
- 1; j
>= 0; j
--) {
477 closeret
= close(stream_fds
[j
]);
481 if (channel
->shm_path
[0]) {
482 char shm_path
[PATH_MAX
];
484 closeret
= get_stream_shm_path(shm_path
,
485 channel
->shm_path
, j
);
487 ERR("Cannot get stream shm path");
489 closeret
= run_as_unlink(shm_path
,
490 channel
->buffer_credentials
.value
.uid
,
491 channel
->buffer_credentials
.value
.gid
);
493 PERROR("unlink %s", shm_path
);
497 /* Try to rmdir all directories under shm_path root. */
498 if (channel
->root_shm_path
[0]) {
499 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
500 channel
->buffer_credentials
.value
.uid
,
501 channel
->buffer_credentials
.value
.gid
,
502 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
510 * Send a single given stream to the session daemon using the sock.
512 * Return 0 on success else a negative value.
514 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
521 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
523 /* Send stream to session daemon. */
524 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
534 * Send channel to sessiond and relayd if applicable.
536 * Return 0 on success or else a negative value.
538 static int send_channel_to_sessiond_and_relayd(int sock
,
539 struct lttng_consumer_channel
*channel
,
540 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
542 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
543 struct lttng_consumer_stream
*stream
;
544 uint64_t net_seq_idx
= -1ULL;
550 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
552 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
553 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
555 health_code_update();
557 /* Try to send the stream to the relayd if one is available. */
558 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
559 stream
->key
, channel
->name
);
560 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
563 * Flag that the relayd was the problem here probably due to a
564 * communicaton error on the socket.
569 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
571 if (net_seq_idx
== -1ULL) {
572 net_seq_idx
= stream
->net_seq_idx
;
577 /* Inform sessiond that we are about to send channel and streams. */
578 ret
= consumer_send_status_msg(sock
, ret_code
);
579 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
581 * Either the session daemon is not responding or the relayd died so we
587 /* Send channel to sessiond. */
588 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
593 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
598 /* The channel was sent successfully to the sessiond at this point. */
599 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
601 health_code_update();
603 /* Send stream to session daemon. */
604 ret
= send_sessiond_stream(sock
, stream
);
610 /* Tell sessiond there is no more stream. */
611 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
616 DBG("UST consumer NULL stream sent to sessiond");
621 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
628 * Creates a channel and streams and add the channel it to the channel internal
629 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
632 * Return 0 on success or else, a negative value is returned and the channel
633 * MUST be destroyed by consumer_del_channel().
635 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
636 struct lttng_consumer_channel
*channel
,
637 struct ustctl_consumer_channel_attr
*attr
)
646 * This value is still used by the kernel consumer since for the kernel,
647 * the stream ownership is not IN the consumer so we need to have the
648 * number of left stream that needs to be initialized so we can know when
649 * to delete the channel (see consumer.c).
651 * As for the user space tracer now, the consumer creates and sends the
652 * stream to the session daemon which only sends them to the application
653 * once every stream of a channel is received making this value useless
654 * because we they will be added to the poll thread before the application
655 * receives them. This ensures that a stream can not hang up during
656 * initilization of a channel.
658 channel
->nb_init_stream_left
= 0;
660 /* The reply msg status is handled in the following call. */
661 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
666 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
669 * For the snapshots (no monitor), we create the metadata streams
670 * on demand, not during the channel creation.
672 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
677 /* Open all streams for this channel. */
678 pthread_mutex_lock(&channel
->lock
);
679 ret
= create_ust_streams(channel
, ctx
);
680 pthread_mutex_unlock(&channel
->lock
);
690 * Send all stream of a channel to the right thread handling it.
692 * On error, return a negative value else 0 on success.
694 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
695 struct lttng_consumer_local_data
*ctx
)
698 struct lttng_consumer_stream
*stream
, *stmp
;
703 /* Send streams to the corresponding thread. */
704 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
707 health_code_update();
709 /* Sending the stream to the thread. */
710 ret
= send_stream_to_thread(stream
, ctx
);
713 * If we are unable to send the stream to the thread, there is
714 * a big problem so just stop everything.
725 * Flush channel's streams using the given key to retrieve the channel.
727 * Return 0 on success else an LTTng error code.
729 static int flush_channel(uint64_t chan_key
)
732 struct lttng_consumer_channel
*channel
;
733 struct lttng_consumer_stream
*stream
;
735 struct lttng_ht_iter iter
;
737 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
740 channel
= consumer_find_channel(chan_key
);
742 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
743 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
747 ht
= consumer_data
.stream_per_chan_id_ht
;
749 /* For each stream of the channel id, flush it. */
750 cds_lfht_for_each_entry_duplicate(ht
->ht
,
751 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
752 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
754 health_code_update();
756 pthread_mutex_lock(&stream
->lock
);
759 * Protect against concurrent teardown of a stream.
761 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
765 if (!stream
->quiescent
) {
766 ustctl_flush_buffer(stream
->ustream
, 0);
767 stream
->quiescent
= true;
770 pthread_mutex_unlock(&stream
->lock
);
778 * Clear quiescent state from channel's streams using the given key to
779 * retrieve the channel.
781 * Return 0 on success else an LTTng error code.
783 static int clear_quiescent_channel(uint64_t chan_key
)
786 struct lttng_consumer_channel
*channel
;
787 struct lttng_consumer_stream
*stream
;
789 struct lttng_ht_iter iter
;
791 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
794 channel
= consumer_find_channel(chan_key
);
796 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
797 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
801 ht
= consumer_data
.stream_per_chan_id_ht
;
803 /* For each stream of the channel id, clear quiescent state. */
804 cds_lfht_for_each_entry_duplicate(ht
->ht
,
805 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
806 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
808 health_code_update();
810 pthread_mutex_lock(&stream
->lock
);
811 stream
->quiescent
= false;
812 pthread_mutex_unlock(&stream
->lock
);
820 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
822 * Return 0 on success else an LTTng error code.
824 static int close_metadata(uint64_t chan_key
)
827 struct lttng_consumer_channel
*channel
;
828 unsigned int channel_monitor
;
830 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
832 channel
= consumer_find_channel(chan_key
);
835 * This is possible if the metadata thread has issue a delete because
836 * the endpoint point of the stream hung up. There is no way the
837 * session daemon can know about it thus use a DBG instead of an actual
840 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
841 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
845 pthread_mutex_lock(&consumer_data
.lock
);
846 pthread_mutex_lock(&channel
->lock
);
847 channel_monitor
= channel
->monitor
;
848 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
852 lttng_ustconsumer_close_metadata(channel
);
853 pthread_mutex_unlock(&channel
->lock
);
854 pthread_mutex_unlock(&consumer_data
.lock
);
857 * The ownership of a metadata channel depends on the type of
858 * session to which it belongs. In effect, the monitor flag is checked
859 * to determine if this metadata channel is in "snapshot" mode or not.
861 * In the non-snapshot case, the metadata channel is created along with
862 * a single stream which will remain present until the metadata channel
863 * is destroyed (on the destruction of its session). In this case, the
864 * metadata stream in "monitored" by the metadata poll thread and holds
865 * the ownership of its channel.
867 * Closing the metadata will cause the metadata stream's "metadata poll
868 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
869 * thread which will teardown the metadata stream which, in return,
870 * deletes the metadata channel.
872 * In the snapshot case, the metadata stream is created and destroyed
873 * on every snapshot record. Since the channel doesn't have an owner
874 * other than the session daemon, it is safe to destroy it immediately
875 * on reception of the CLOSE_METADATA command.
877 if (!channel_monitor
) {
879 * The channel and consumer_data locks must be
880 * released before this call since consumer_del_channel
881 * re-acquires the channel and consumer_data locks to teardown
882 * the channel and queue its reclamation by the "call_rcu"
885 consumer_del_channel(channel
);
890 pthread_mutex_unlock(&channel
->lock
);
891 pthread_mutex_unlock(&consumer_data
.lock
);
897 * RCU read side lock MUST be acquired before calling this function.
899 * Return 0 on success else an LTTng error code.
901 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
904 struct lttng_consumer_channel
*metadata
;
906 DBG("UST consumer setup metadata key %" PRIu64
, key
);
908 metadata
= consumer_find_channel(key
);
910 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
911 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
916 * In no monitor mode, the metadata channel has no stream(s) so skip the
917 * ownership transfer to the metadata thread.
919 if (!metadata
->monitor
) {
920 DBG("Metadata channel in no monitor");
926 * Send metadata stream to relayd if one available. Availability is
927 * known if the stream is still in the list of the channel.
929 if (cds_list_empty(&metadata
->streams
.head
)) {
930 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
931 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
932 goto error_no_stream
;
935 /* Send metadata stream to relayd if needed. */
936 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
937 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
940 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
943 ret
= consumer_send_relayd_streams_sent(
944 metadata
->metadata_stream
->net_seq_idx
);
946 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
952 * Ownership of metadata stream is passed along. Freeing is handled by
955 ret
= send_streams_to_thread(metadata
, ctx
);
958 * If we are unable to send the stream to the thread, there is
959 * a big problem so just stop everything.
961 ret
= LTTCOMM_CONSUMERD_FATAL
;
962 goto send_streams_error
;
964 /* List MUST be empty after or else it could be reused. */
965 assert(cds_list_empty(&metadata
->streams
.head
));
972 * Delete metadata channel on error. At this point, the metadata stream can
973 * NOT be monitored by the metadata thread thus having the guarantee that
974 * the stream is still in the local stream list of the channel. This call
975 * will make sure to clean that list.
977 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
978 cds_list_del(&metadata
->metadata_stream
->send_node
);
979 metadata
->metadata_stream
= NULL
;
987 * Snapshot the whole metadata.
988 * RCU read-side lock must be held by the caller.
990 * Returns 0 on success, < 0 on error
992 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
993 uint64_t key
, char *path
, uint64_t relayd_id
,
994 struct lttng_consumer_local_data
*ctx
)
997 struct lttng_consumer_stream
*metadata_stream
;
1002 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
1007 assert(!metadata_channel
->monitor
);
1009 health_code_update();
1012 * Ask the sessiond if we have new metadata waiting and update the
1013 * consumer metadata cache.
1015 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
1020 health_code_update();
1023 * The metadata stream is NOT created in no monitor mode when the channel
1024 * is created on a sessiond ask channel command.
1026 ret
= create_ust_streams(metadata_channel
, ctx
);
1031 metadata_stream
= metadata_channel
->metadata_stream
;
1032 assert(metadata_stream
);
1034 pthread_mutex_lock(&metadata_stream
->lock
);
1035 if (relayd_id
!= (uint64_t) -1ULL) {
1036 metadata_stream
->net_seq_idx
= relayd_id
;
1037 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1039 ret
= consumer_stream_create_output_files(metadata_stream
,
1042 pthread_mutex_unlock(&metadata_stream
->lock
);
1048 health_code_update();
1050 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
, true);
1058 * Clean up the stream completly because the next snapshot will use a new
1061 consumer_stream_destroy(metadata_stream
, NULL
);
1062 cds_list_del(&metadata_stream
->send_node
);
1063 metadata_channel
->metadata_stream
= NULL
;
1071 int get_current_subbuf_addr(struct lttng_consumer_stream
*stream
,
1075 unsigned long mmap_offset
;
1076 const char *mmap_base
;
1078 mmap_base
= ustctl_get_mmap_base(stream
->ustream
);
1080 ERR("Failed to get mmap base for stream `%s`",
1086 ret
= ustctl_get_mmap_read_offset(stream
->ustream
, &mmap_offset
);
1088 ERR("Failed to get mmap offset for stream `%s`", stream
->name
);
1093 *addr
= mmap_base
+ mmap_offset
;
1100 * Take a snapshot of all the stream of a channel.
1101 * RCU read-side lock and the channel lock must be held by the caller.
1103 * Returns 0 on success, < 0 on error
1105 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1106 uint64_t key
, char *path
, uint64_t relayd_id
,
1107 uint64_t nb_packets_per_stream
,
1108 struct lttng_consumer_local_data
*ctx
)
1111 unsigned use_relayd
= 0;
1112 unsigned long consumed_pos
, produced_pos
;
1113 struct lttng_consumer_stream
*stream
;
1120 if (relayd_id
!= (uint64_t) -1ULL) {
1124 assert(!channel
->monitor
);
1125 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1127 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1128 health_code_update();
1130 /* Lock stream because we are about to change its state. */
1131 pthread_mutex_lock(&stream
->lock
);
1132 assert(channel
->trace_chunk
);
1133 if (!lttng_trace_chunk_get(channel
->trace_chunk
)) {
1135 * Can't happen barring an internal error as the channel
1136 * holds a reference to the trace chunk.
1138 ERR("Failed to acquire reference to channel's trace chunk");
1142 assert(!stream
->trace_chunk
);
1143 stream
->trace_chunk
= channel
->trace_chunk
;
1145 stream
->net_seq_idx
= relayd_id
;
1148 ret
= consumer_send_relayd_stream(stream
, path
);
1153 ret
= consumer_stream_create_output_files(stream
,
1158 DBG("UST consumer snapshot stream (%" PRIu64
")",
1163 * If tracing is active, we want to perform a "full" buffer flush.
1164 * Else, if quiescent, it has already been done by the prior stop.
1166 if (!stream
->quiescent
) {
1167 ustctl_flush_buffer(stream
->ustream
, 0);
1170 ret
= lttng_ustconsumer_take_snapshot(stream
);
1172 ERR("Taking UST snapshot");
1176 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1178 ERR("Produced UST snapshot position");
1182 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1184 ERR("Consumerd UST snapshot position");
1189 * The original value is sent back if max stream size is larger than
1190 * the possible size of the snapshot. Also, we assume that the session
1191 * daemon should never send a maximum stream size that is lower than
1194 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1195 produced_pos
, nb_packets_per_stream
,
1196 stream
->max_sb_size
);
1198 while ((long) (consumed_pos
- produced_pos
) < 0) {
1200 unsigned long len
, padded_len
;
1201 const char *subbuf_addr
;
1202 struct lttng_buffer_view subbuf_view
;
1204 health_code_update();
1206 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1208 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1210 if (ret
!= -EAGAIN
) {
1211 PERROR("ustctl_get_subbuf snapshot");
1212 goto error_close_stream
;
1214 DBG("UST consumer get subbuf failed. Skipping it.");
1215 consumed_pos
+= stream
->max_sb_size
;
1216 stream
->chan
->lost_packets
++;
1220 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1222 ERR("Snapshot ustctl_get_subbuf_size");
1223 goto error_put_subbuf
;
1226 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1228 ERR("Snapshot ustctl_get_padded_subbuf_size");
1229 goto error_put_subbuf
;
1232 ret
= get_current_subbuf_addr(stream
, &subbuf_addr
);
1234 goto error_put_subbuf
;
1237 subbuf_view
= lttng_buffer_view_init(
1238 subbuf_addr
, 0, padded_len
);
1239 read_len
= lttng_consumer_on_read_subbuffer_mmap(
1240 stream
, &subbuf_view
, padded_len
- len
);
1242 if (read_len
!= len
) {
1244 goto error_put_subbuf
;
1247 if (read_len
!= padded_len
) {
1249 goto error_put_subbuf
;
1253 ret
= ustctl_put_subbuf(stream
->ustream
);
1255 ERR("Snapshot ustctl_put_subbuf");
1256 goto error_close_stream
;
1258 consumed_pos
+= stream
->max_sb_size
;
1261 /* Simply close the stream so we can use it on the next snapshot. */
1262 consumer_stream_close(stream
);
1263 pthread_mutex_unlock(&stream
->lock
);
1270 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1271 ERR("Snapshot ustctl_put_subbuf");
1274 consumer_stream_close(stream
);
1276 pthread_mutex_unlock(&stream
->lock
);
1282 void metadata_stream_reset_cache_consumed_position(
1283 struct lttng_consumer_stream
*stream
)
1285 ASSERT_LOCKED(stream
->lock
);
1287 DBG("Reset metadata cache of session %" PRIu64
,
1288 stream
->chan
->session_id
);
1289 stream
->ust_metadata_pushed
= 0;
1293 * Receive the metadata updates from the sessiond. Supports receiving
1294 * overlapping metadata, but is needs to always belong to a contiguous
1295 * range starting from 0.
1296 * Be careful about the locks held when calling this function: it needs
1297 * the metadata cache flush to concurrently progress in order to
1300 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1301 uint64_t len
, uint64_t version
,
1302 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1304 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1306 enum consumer_metadata_cache_write_status cache_write_status
;
1308 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1310 metadata_str
= zmalloc(len
* sizeof(char));
1311 if (!metadata_str
) {
1312 PERROR("zmalloc metadata string");
1313 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1317 health_code_update();
1319 /* Receive metadata string. */
1320 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1322 /* Session daemon is dead so return gracefully. */
1327 health_code_update();
1329 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1330 cache_write_status
= consumer_metadata_cache_write(
1331 channel
, offset
, len
, version
, metadata_str
);
1332 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1333 switch (cache_write_status
) {
1334 case CONSUMER_METADATA_CACHE_WRITE_STATUS_NO_CHANGE
:
1336 * The write entirely overlapped with existing contents of the
1337 * same metadata version (same content); there is nothing to do.
1340 case CONSUMER_METADATA_CACHE_WRITE_STATUS_INVALIDATED
:
1342 * The metadata cache was invalidated (previously pushed
1343 * content has been overwritten). Reset the stream's consumed
1344 * metadata position to ensure the metadata poll thread consumes
1347 pthread_mutex_lock(&channel
->metadata_stream
->lock
);
1348 metadata_stream_reset_cache_consumed_position(
1349 channel
->metadata_stream
);
1350 pthread_mutex_unlock(&channel
->metadata_stream
->lock
);
1352 case CONSUMER_METADATA_CACHE_WRITE_STATUS_APPENDED_CONTENT
:
1354 * In both cases, the metadata poll thread has new data to
1357 ret
= consumer_metadata_wakeup_pipe(channel
);
1359 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1363 case CONSUMER_METADATA_CACHE_WRITE_STATUS_ERROR
:
1364 /* Unable to handle metadata. Notify session daemon. */
1365 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1367 * Skip metadata flush on write error since the offset and len might
1368 * not have been updated which could create an infinite loop below when
1369 * waiting for the metadata cache to be flushed.
1379 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1380 DBG("Waiting for metadata to be flushed");
1382 health_code_update();
1384 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1394 * Receive command from session daemon and process it.
1396 * Return 1 on success else a negative value or 0.
1398 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1399 int sock
, struct pollfd
*consumer_sockpoll
)
1402 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1403 struct lttcomm_consumer_msg msg
;
1404 struct lttng_consumer_channel
*channel
= NULL
;
1406 health_code_update();
1408 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1409 if (ret
!= sizeof(msg
)) {
1410 DBG("Consumer received unexpected message size %zd (expects %zu)",
1413 * The ret value might 0 meaning an orderly shutdown but this is ok
1414 * since the caller handles this.
1417 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1423 health_code_update();
1426 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1428 health_code_update();
1430 /* relayd needs RCU read-side lock */
1433 switch (msg
.cmd_type
) {
1434 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1436 /* Session daemon status message are handled in the following call. */
1437 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1438 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1439 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1440 msg
.u
.relayd_sock
.relayd_session_id
);
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 ret
, is_data_pending
;
1481 uint64_t id
= msg
.u
.data_pending
.session_id
;
1483 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1485 is_data_pending
= consumer_data_pending(id
);
1487 /* Send back returned value to session daemon */
1488 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1489 sizeof(is_data_pending
));
1491 DBG("Error when sending the data pending ret code: %d", ret
);
1496 * No need to send back a status message since the data pending
1497 * returned value is the response.
1501 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1504 struct ustctl_consumer_channel_attr attr
;
1505 const uint64_t chunk_id
= msg
.u
.ask_channel
.chunk_id
.value
;
1506 const struct lttng_credentials buffer_credentials
= {
1507 .uid
= msg
.u
.ask_channel
.buffer_credentials
.uid
,
1508 .gid
= msg
.u
.ask_channel
.buffer_credentials
.gid
,
1511 /* Create a plain object and reserve a channel key. */
1512 channel
= consumer_allocate_channel(
1513 msg
.u
.ask_channel
.key
,
1514 msg
.u
.ask_channel
.session_id
,
1515 msg
.u
.ask_channel
.chunk_id
.is_set
?
1517 msg
.u
.ask_channel
.pathname
,
1518 msg
.u
.ask_channel
.name
,
1519 msg
.u
.ask_channel
.relayd_id
,
1520 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1521 msg
.u
.ask_channel
.tracefile_size
,
1522 msg
.u
.ask_channel
.tracefile_count
,
1523 msg
.u
.ask_channel
.session_id_per_pid
,
1524 msg
.u
.ask_channel
.monitor
,
1525 msg
.u
.ask_channel
.live_timer_interval
,
1526 msg
.u
.ask_channel
.is_live
,
1527 msg
.u
.ask_channel
.root_shm_path
,
1528 msg
.u
.ask_channel
.shm_path
);
1530 goto end_channel_error
;
1533 LTTNG_OPTIONAL_SET(&channel
->buffer_credentials
,
1534 buffer_credentials
);
1537 * Assign UST application UID to the channel. This value is ignored for
1538 * per PID buffers. This is specific to UST thus setting this after the
1541 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1543 /* Build channel attributes from received message. */
1544 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1545 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1546 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1547 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1548 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1549 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1550 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1551 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1553 /* Match channel buffer type to the UST abi. */
1554 switch (msg
.u
.ask_channel
.output
) {
1555 case LTTNG_EVENT_MMAP
:
1557 attr
.output
= LTTNG_UST_MMAP
;
1561 /* Translate and save channel type. */
1562 switch (msg
.u
.ask_channel
.type
) {
1563 case LTTNG_UST_CHAN_PER_CPU
:
1564 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1565 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1567 * Set refcount to 1 for owner. Below, we will
1568 * pass ownership to the
1569 * consumer_thread_channel_poll() thread.
1571 channel
->refcount
= 1;
1573 case LTTNG_UST_CHAN_METADATA
:
1574 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1575 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1582 health_code_update();
1584 ret
= ask_channel(ctx
, channel
, &attr
);
1586 goto end_channel_error
;
1589 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1590 ret
= consumer_metadata_cache_allocate(channel
);
1592 ERR("Allocating metadata cache");
1593 goto end_channel_error
;
1595 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1596 attr
.switch_timer_interval
= 0;
1598 int monitor_start_ret
;
1600 consumer_timer_live_start(channel
,
1601 msg
.u
.ask_channel
.live_timer_interval
);
1602 monitor_start_ret
= consumer_timer_monitor_start(
1604 msg
.u
.ask_channel
.monitor_timer_interval
);
1605 if (monitor_start_ret
< 0) {
1606 ERR("Starting channel monitoring timer failed");
1607 goto end_channel_error
;
1611 health_code_update();
1614 * Add the channel to the internal state AFTER all streams were created
1615 * and successfully sent to session daemon. This way, all streams must
1616 * be ready before this channel is visible to the threads.
1617 * If add_channel succeeds, ownership of the channel is
1618 * passed to consumer_thread_channel_poll().
1620 ret
= add_channel(channel
, ctx
);
1622 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1623 if (channel
->switch_timer_enabled
== 1) {
1624 consumer_timer_switch_stop(channel
);
1626 consumer_metadata_cache_destroy(channel
);
1628 if (channel
->live_timer_enabled
== 1) {
1629 consumer_timer_live_stop(channel
);
1631 if (channel
->monitor_timer_enabled
== 1) {
1632 consumer_timer_monitor_stop(channel
);
1634 goto end_channel_error
;
1637 health_code_update();
1640 * Channel and streams are now created. Inform the session daemon that
1641 * everything went well and should wait to receive the channel and
1642 * streams with ustctl API.
1644 ret
= consumer_send_status_channel(sock
, channel
);
1647 * There is probably a problem on the socket.
1654 case LTTNG_CONSUMER_GET_CHANNEL
:
1656 int ret
, relayd_err
= 0;
1657 uint64_t key
= msg
.u
.get_channel
.key
;
1658 struct lttng_consumer_channel
*channel
;
1660 channel
= consumer_find_channel(key
);
1662 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1663 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1664 goto end_get_channel
;
1667 health_code_update();
1669 /* Send the channel to sessiond (and relayd, if applicable). */
1670 ret
= send_channel_to_sessiond_and_relayd(sock
, channel
, ctx
,
1675 * We were unable to send to the relayd the stream so avoid
1676 * sending back a fatal error to the thread since this is OK
1677 * and the consumer can continue its work. The above call
1678 * has sent the error status message to the sessiond.
1680 goto end_get_channel_nosignal
;
1683 * The communicaton was broken hence there is a bad state between
1684 * the consumer and sessiond so stop everything.
1686 goto error_get_channel_fatal
;
1689 health_code_update();
1692 * In no monitor mode, the streams ownership is kept inside the channel
1693 * so don't send them to the data thread.
1695 if (!channel
->monitor
) {
1696 goto end_get_channel
;
1699 ret
= send_streams_to_thread(channel
, ctx
);
1702 * If we are unable to send the stream to the thread, there is
1703 * a big problem so just stop everything.
1705 goto error_get_channel_fatal
;
1707 /* List MUST be empty after or else it could be reused. */
1708 assert(cds_list_empty(&channel
->streams
.head
));
1710 goto end_msg_sessiond
;
1711 error_get_channel_fatal
:
1713 end_get_channel_nosignal
:
1716 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1718 uint64_t key
= msg
.u
.destroy_channel
.key
;
1721 * Only called if streams have not been sent to stream
1722 * manager thread. However, channel has been sent to
1723 * channel manager thread.
1725 notify_thread_del_channel(ctx
, key
);
1726 goto end_msg_sessiond
;
1728 case LTTNG_CONSUMER_CLOSE_METADATA
:
1732 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1737 goto end_msg_sessiond
;
1739 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1743 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1748 goto end_msg_sessiond
;
1750 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1754 ret
= clear_quiescent_channel(
1755 msg
.u
.clear_quiescent_channel
.key
);
1760 goto end_msg_sessiond
;
1762 case LTTNG_CONSUMER_PUSH_METADATA
:
1765 uint64_t len
= msg
.u
.push_metadata
.len
;
1766 uint64_t key
= msg
.u
.push_metadata
.key
;
1767 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1768 uint64_t version
= msg
.u
.push_metadata
.version
;
1769 struct lttng_consumer_channel
*channel
;
1771 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1774 channel
= consumer_find_channel(key
);
1777 * This is possible if the metadata creation on the consumer side
1778 * is in flight vis-a-vis a concurrent push metadata from the
1779 * session daemon. Simply return that the channel failed and the
1780 * session daemon will handle that message correctly considering
1781 * that this race is acceptable thus the DBG() statement here.
1783 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1784 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1785 goto end_push_metadata_msg_sessiond
;
1788 health_code_update();
1792 * There is nothing to receive. We have simply
1793 * checked whether the channel can be found.
1795 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1796 goto end_push_metadata_msg_sessiond
;
1799 /* Tell session daemon we are ready to receive the metadata. */
1800 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1802 /* Somehow, the session daemon is not responding anymore. */
1803 goto error_push_metadata_fatal
;
1806 health_code_update();
1808 /* Wait for more data. */
1809 health_poll_entry();
1810 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1813 goto error_push_metadata_fatal
;
1816 health_code_update();
1818 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1819 len
, version
, channel
, 0, 1);
1821 /* error receiving from sessiond */
1822 goto error_push_metadata_fatal
;
1825 goto end_push_metadata_msg_sessiond
;
1827 end_push_metadata_msg_sessiond
:
1828 goto end_msg_sessiond
;
1829 error_push_metadata_fatal
:
1832 case LTTNG_CONSUMER_SETUP_METADATA
:
1836 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1840 goto end_msg_sessiond
;
1842 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1844 struct lttng_consumer_channel
*channel
;
1845 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1847 channel
= consumer_find_channel(key
);
1849 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1850 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1852 if (msg
.u
.snapshot_channel
.metadata
) {
1853 ret
= snapshot_metadata(channel
, key
,
1854 msg
.u
.snapshot_channel
.pathname
,
1855 msg
.u
.snapshot_channel
.relayd_id
,
1858 ERR("Snapshot metadata failed");
1859 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1862 ret
= snapshot_channel(channel
, key
,
1863 msg
.u
.snapshot_channel
.pathname
,
1864 msg
.u
.snapshot_channel
.relayd_id
,
1865 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1868 ERR("Snapshot channel failed");
1869 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1873 health_code_update();
1874 ret
= consumer_send_status_msg(sock
, ret_code
);
1876 /* Somehow, the session daemon is not responding anymore. */
1879 health_code_update();
1882 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1885 uint64_t discarded_events
;
1886 struct lttng_ht_iter iter
;
1887 struct lttng_ht
*ht
;
1888 struct lttng_consumer_stream
*stream
;
1889 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1890 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1892 DBG("UST consumer discarded events command for session id %"
1895 pthread_mutex_lock(&consumer_data
.lock
);
1897 ht
= consumer_data
.stream_list_ht
;
1900 * We only need a reference to the channel, but they are not
1901 * directly indexed, so we just use the first matching stream
1902 * to extract the information we need, we default to 0 if not
1903 * found (no events are dropped if the channel is not yet in
1906 discarded_events
= 0;
1907 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1908 ht
->hash_fct(&id
, lttng_ht_seed
),
1910 &iter
.iter
, stream
, node_session_id
.node
) {
1911 if (stream
->chan
->key
== key
) {
1912 discarded_events
= stream
->chan
->discarded_events
;
1916 pthread_mutex_unlock(&consumer_data
.lock
);
1919 DBG("UST consumer discarded events command for session id %"
1920 PRIu64
", channel key %" PRIu64
, id
, key
);
1922 health_code_update();
1924 /* Send back returned value to session daemon */
1925 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1927 PERROR("send discarded events");
1933 case LTTNG_CONSUMER_LOST_PACKETS
:
1936 uint64_t lost_packets
;
1937 struct lttng_ht_iter iter
;
1938 struct lttng_ht
*ht
;
1939 struct lttng_consumer_stream
*stream
;
1940 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1941 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1943 DBG("UST consumer lost packets command for session id %"
1946 pthread_mutex_lock(&consumer_data
.lock
);
1948 ht
= consumer_data
.stream_list_ht
;
1951 * We only need a reference to the channel, but they are not
1952 * directly indexed, so we just use the first matching stream
1953 * to extract the information we need, we default to 0 if not
1954 * found (no packets lost if the channel is not yet in use).
1957 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1958 ht
->hash_fct(&id
, lttng_ht_seed
),
1960 &iter
.iter
, stream
, node_session_id
.node
) {
1961 if (stream
->chan
->key
== key
) {
1962 lost_packets
= stream
->chan
->lost_packets
;
1966 pthread_mutex_unlock(&consumer_data
.lock
);
1969 DBG("UST consumer lost packets command for session id %"
1970 PRIu64
", channel key %" PRIu64
, id
, key
);
1972 health_code_update();
1974 /* Send back returned value to session daemon */
1975 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1976 sizeof(lost_packets
));
1978 PERROR("send lost packets");
1984 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1986 int channel_monitor_pipe
;
1988 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1989 /* Successfully received the command's type. */
1990 ret
= consumer_send_status_msg(sock
, ret_code
);
1995 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1997 if (ret
!= sizeof(channel_monitor_pipe
)) {
1998 ERR("Failed to receive channel monitor pipe");
2002 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
2003 ret
= consumer_timer_thread_set_channel_monitor_pipe(
2004 channel_monitor_pipe
);
2008 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2009 /* Set the pipe as non-blocking. */
2010 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
2012 PERROR("fcntl get flags of the channel monitoring pipe");
2017 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
2018 flags
| O_NONBLOCK
);
2020 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
2023 DBG("Channel monitor pipe set as non-blocking");
2025 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
2027 goto end_msg_sessiond
;
2029 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
2031 struct lttng_consumer_channel
*channel
;
2032 uint64_t key
= msg
.u
.rotate_channel
.key
;
2034 channel
= consumer_find_channel(key
);
2036 DBG("Channel %" PRIu64
" not found", key
);
2037 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2040 * Sample the rotate position of all the streams in
2043 ret
= lttng_consumer_rotate_channel(channel
, key
,
2044 msg
.u
.rotate_channel
.relayd_id
,
2045 msg
.u
.rotate_channel
.metadata
,
2048 ERR("Rotate channel failed");
2049 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
2052 health_code_update();
2054 ret
= consumer_send_status_msg(sock
, ret_code
);
2056 /* Somehow, the session daemon is not responding anymore. */
2057 goto end_rotate_channel_nosignal
;
2061 * Rotate the streams that are ready right now.
2062 * FIXME: this is a second consecutive iteration over the
2063 * streams in a channel, there is probably a better way to
2064 * handle this, but it needs to be after the
2065 * consumer_send_status_msg() call.
2068 ret
= lttng_consumer_rotate_ready_streams(
2071 ERR("Rotate channel failed");
2075 end_rotate_channel_nosignal
:
2078 case LTTNG_CONSUMER_CLEAR_CHANNEL
:
2080 struct lttng_consumer_channel
*channel
;
2081 uint64_t key
= msg
.u
.clear_channel
.key
;
2083 channel
= consumer_find_channel(key
);
2085 DBG("Channel %" PRIu64
" not found", key
);
2086 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2088 ret
= lttng_consumer_clear_channel(channel
);
2090 ERR("Clear channel failed key %" PRIu64
, key
);
2094 health_code_update();
2096 ret
= consumer_send_status_msg(sock
, ret_code
);
2098 /* Somehow, the session daemon is not responding anymore. */
2103 case LTTNG_CONSUMER_INIT
:
2105 ret_code
= lttng_consumer_init_command(ctx
,
2106 msg
.u
.init
.sessiond_uuid
);
2107 health_code_update();
2108 ret
= consumer_send_status_msg(sock
, ret_code
);
2110 /* Somehow, the session daemon is not responding anymore. */
2115 case LTTNG_CONSUMER_CREATE_TRACE_CHUNK
:
2117 const struct lttng_credentials credentials
= {
2118 .uid
= msg
.u
.create_trace_chunk
.credentials
.value
.uid
,
2119 .gid
= msg
.u
.create_trace_chunk
.credentials
.value
.gid
,
2121 const bool is_local_trace
=
2122 !msg
.u
.create_trace_chunk
.relayd_id
.is_set
;
2123 const uint64_t relayd_id
=
2124 msg
.u
.create_trace_chunk
.relayd_id
.value
;
2125 const char *chunk_override_name
=
2126 *msg
.u
.create_trace_chunk
.override_name
?
2127 msg
.u
.create_trace_chunk
.override_name
:
2129 struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
2132 * The session daemon will only provide a chunk directory file
2133 * descriptor for local traces.
2135 if (is_local_trace
) {
2138 /* Acnowledge the reception of the command. */
2139 ret
= consumer_send_status_msg(sock
,
2140 LTTCOMM_CONSUMERD_SUCCESS
);
2142 /* Somehow, the session daemon is not responding anymore. */
2147 * Receive trace chunk domain dirfd.
2149 ret
= lttcomm_recv_fds_unix_sock(sock
, &chunk_dirfd
, 1);
2150 if (ret
!= sizeof(chunk_dirfd
)) {
2151 ERR("Failed to receive trace chunk domain directory file descriptor");
2155 DBG("Received trace chunk domain directory fd (%d)",
2157 chunk_directory_handle
= lttng_directory_handle_create_from_dirfd(
2159 if (!chunk_directory_handle
) {
2160 ERR("Failed to initialize chunk domain directory handle from directory file descriptor");
2161 if (close(chunk_dirfd
)) {
2162 PERROR("Failed to close chunk directory file descriptor");
2168 ret_code
= lttng_consumer_create_trace_chunk(
2169 !is_local_trace
? &relayd_id
: NULL
,
2170 msg
.u
.create_trace_chunk
.session_id
,
2171 msg
.u
.create_trace_chunk
.chunk_id
,
2172 (time_t) msg
.u
.create_trace_chunk
2173 .creation_timestamp
,
2174 chunk_override_name
,
2175 msg
.u
.create_trace_chunk
.credentials
.is_set
?
2178 chunk_directory_handle
);
2179 lttng_directory_handle_put(chunk_directory_handle
);
2180 goto end_msg_sessiond
;
2182 case LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
:
2184 enum lttng_trace_chunk_command_type close_command
=
2185 msg
.u
.close_trace_chunk
.close_command
.value
;
2186 const uint64_t relayd_id
=
2187 msg
.u
.close_trace_chunk
.relayd_id
.value
;
2188 struct lttcomm_consumer_close_trace_chunk_reply reply
;
2189 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2192 ret_code
= lttng_consumer_close_trace_chunk(
2193 msg
.u
.close_trace_chunk
.relayd_id
.is_set
?
2196 msg
.u
.close_trace_chunk
.session_id
,
2197 msg
.u
.close_trace_chunk
.chunk_id
,
2198 (time_t) msg
.u
.close_trace_chunk
.close_timestamp
,
2199 msg
.u
.close_trace_chunk
.close_command
.is_set
?
2201 NULL
, closed_trace_chunk_path
);
2202 reply
.ret_code
= ret_code
;
2203 reply
.path_length
= strlen(closed_trace_chunk_path
) + 1;
2204 ret
= lttcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2205 if (ret
!= sizeof(reply
)) {
2208 ret
= lttcomm_send_unix_sock(sock
, closed_trace_chunk_path
,
2210 if (ret
!= reply
.path_length
) {
2215 case LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
:
2217 const uint64_t relayd_id
=
2218 msg
.u
.trace_chunk_exists
.relayd_id
.value
;
2220 ret_code
= lttng_consumer_trace_chunk_exists(
2221 msg
.u
.trace_chunk_exists
.relayd_id
.is_set
?
2223 msg
.u
.trace_chunk_exists
.session_id
,
2224 msg
.u
.trace_chunk_exists
.chunk_id
);
2225 goto end_msg_sessiond
;
2227 case LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS
:
2229 const uint64_t key
= msg
.u
.open_channel_packets
.key
;
2230 struct lttng_consumer_channel
*channel
=
2231 consumer_find_channel(key
);
2234 pthread_mutex_lock(&channel
->lock
);
2235 ret_code
= lttng_consumer_open_channel_packets(channel
);
2236 pthread_mutex_unlock(&channel
->lock
);
2239 * The channel could have disappeared in per-pid
2242 DBG("Channel %" PRIu64
" not found", key
);
2243 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2246 health_code_update();
2247 goto end_msg_sessiond
;
2255 * Return 1 to indicate success since the 0 value can be a socket
2256 * shutdown during the recv() or send() call.
2263 * The returned value here is not useful since either way we'll return 1 to
2264 * the caller because the session daemon socket management is done
2265 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
2267 ret
= consumer_send_status_msg(sock
, ret_code
);
2277 * Free channel here since no one has a reference to it. We don't
2278 * free after that because a stream can store this pointer.
2280 destroy_channel(channel
);
2282 /* We have to send a status channel message indicating an error. */
2283 ret
= consumer_send_status_channel(sock
, NULL
);
2285 /* Stop everything if session daemon can not be notified. */
2292 /* This will issue a consumer stop. */
2298 health_code_update();
2302 void lttng_ustctl_flush_buffer(struct lttng_consumer_stream
*stream
,
2303 int producer_active
)
2306 assert(stream
->ustream
);
2308 ustctl_flush_buffer(stream
->ustream
, producer_active
);
2312 * Take a snapshot for a specific stream.
2314 * Returns 0 on success, < 0 on error
2316 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2319 assert(stream
->ustream
);
2321 return ustctl_snapshot(stream
->ustream
);
2325 * Sample consumed and produced positions for a specific stream.
2327 * Returns 0 on success, < 0 on error.
2329 int lttng_ustconsumer_sample_snapshot_positions(
2330 struct lttng_consumer_stream
*stream
)
2333 assert(stream
->ustream
);
2335 return ustctl_snapshot_sample_positions(stream
->ustream
);
2339 * Get the produced position
2341 * Returns 0 on success, < 0 on error
2343 int lttng_ustconsumer_get_produced_snapshot(
2344 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2347 assert(stream
->ustream
);
2350 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2354 * Get the consumed position
2356 * Returns 0 on success, < 0 on error
2358 int lttng_ustconsumer_get_consumed_snapshot(
2359 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2362 assert(stream
->ustream
);
2365 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2368 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2372 assert(stream
->ustream
);
2374 ustctl_flush_buffer(stream
->ustream
, producer
);
2377 void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream
*stream
)
2380 assert(stream
->ustream
);
2382 ustctl_clear_buffer(stream
->ustream
);
2385 int lttng_ustconsumer_get_current_timestamp(
2386 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2389 assert(stream
->ustream
);
2392 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2395 int lttng_ustconsumer_get_sequence_number(
2396 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2399 assert(stream
->ustream
);
2402 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2406 * Called when the stream signals the consumer that it has hung up.
2408 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2411 assert(stream
->ustream
);
2413 pthread_mutex_lock(&stream
->lock
);
2414 if (!stream
->quiescent
) {
2415 ustctl_flush_buffer(stream
->ustream
, 0);
2416 stream
->quiescent
= true;
2418 pthread_mutex_unlock(&stream
->lock
);
2419 stream
->hangup_flush_done
= 1;
2422 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2427 assert(chan
->uchan
);
2428 assert(chan
->buffer_credentials
.is_set
);
2430 if (chan
->switch_timer_enabled
== 1) {
2431 consumer_timer_switch_stop(chan
);
2433 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2436 ret
= close(chan
->stream_fds
[i
]);
2440 if (chan
->shm_path
[0]) {
2441 char shm_path
[PATH_MAX
];
2443 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2445 ERR("Cannot get stream shm path");
2447 ret
= run_as_unlink(shm_path
,
2448 chan
->buffer_credentials
.value
.uid
,
2449 chan
->buffer_credentials
.value
.gid
);
2451 PERROR("unlink %s", shm_path
);
2457 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2460 assert(chan
->uchan
);
2461 assert(chan
->buffer_credentials
.is_set
);
2463 consumer_metadata_cache_destroy(chan
);
2464 ustctl_destroy_channel(chan
->uchan
);
2465 /* Try to rmdir all directories under shm_path root. */
2466 if (chan
->root_shm_path
[0]) {
2467 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2468 chan
->buffer_credentials
.value
.uid
,
2469 chan
->buffer_credentials
.value
.gid
,
2470 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
2472 free(chan
->stream_fds
);
2475 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2478 assert(stream
->ustream
);
2480 if (stream
->chan
->switch_timer_enabled
== 1) {
2481 consumer_timer_switch_stop(stream
->chan
);
2483 ustctl_destroy_stream(stream
->ustream
);
2486 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2489 assert(stream
->ustream
);
2491 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2494 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2497 assert(stream
->ustream
);
2499 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2503 * Write up to one packet from the metadata cache to the channel.
2505 * Returns the number of bytes pushed from the cache into the ring buffer, or a
2506 * negative value on error.
2509 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2514 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2515 if (stream
->chan
->metadata_cache
->max_offset
==
2516 stream
->ust_metadata_pushed
) {
2518 * In the context of a user space metadata channel, a
2519 * change in version can be detected in two ways:
2520 * 1) During the pre-consume of the `read_subbuffer` loop,
2521 * 2) When populating the metadata ring buffer (i.e. here).
2523 * This function is invoked when there is no metadata
2524 * available in the ring-buffer. If all data was consumed
2525 * up to the size of the metadata cache, there is no metadata
2526 * to insert in the ring-buffer.
2528 * However, the metadata version could still have changed (a
2529 * regeneration without any new data will yield the same cache
2532 * The cache's version is checked for a version change and the
2533 * consumed position is reset if one occurred.
2535 * This check is only necessary for the user space domain as
2536 * it has to manage the cache explicitly. If this reset was not
2537 * performed, no metadata would be consumed (and no reset would
2538 * occur as part of the pre-consume) until the metadata size
2539 * exceeded the cache size.
2541 if (stream
->metadata_version
!=
2542 stream
->chan
->metadata_cache
->version
) {
2543 metadata_stream_reset_cache_consumed_position(stream
);
2544 consumer_stream_metadata_set_version(stream
,
2545 stream
->chan
->metadata_cache
->version
);
2552 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2553 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2554 stream
->chan
->metadata_cache
->max_offset
2555 - stream
->ust_metadata_pushed
);
2556 assert(write_len
!= 0);
2557 if (write_len
< 0) {
2558 ERR("Writing one metadata packet");
2562 stream
->ust_metadata_pushed
+= write_len
;
2564 assert(stream
->chan
->metadata_cache
->max_offset
>=
2565 stream
->ust_metadata_pushed
);
2569 * Switch packet (but don't open the next one) on every commit of
2570 * a metadata packet. Since the subbuffer is fully filled (with padding,
2571 * if needed), the stream is "quiescent" after this commit.
2573 ustctl_flush_buffer(stream
->ustream
, 1);
2574 stream
->quiescent
= true;
2576 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2582 * Sync metadata meaning request them to the session daemon and snapshot to the
2583 * metadata thread can consumer them.
2585 * Metadata stream lock is held here, but we need to release it when
2586 * interacting with sessiond, else we cause a deadlock with live
2587 * awaiting on metadata to be pushed out.
2589 * The RCU read side lock must be held by the caller.
2591 enum sync_metadata_status
lttng_ustconsumer_sync_metadata(
2592 struct lttng_consumer_local_data
*ctx
,
2593 struct lttng_consumer_stream
*metadata_stream
)
2596 enum sync_metadata_status status
;
2597 struct lttng_consumer_channel
*metadata_channel
;
2600 assert(metadata_stream
);
2602 metadata_channel
= metadata_stream
->chan
;
2603 pthread_mutex_unlock(&metadata_stream
->lock
);
2605 * Request metadata from the sessiond, but don't wait for the flush
2606 * because we locked the metadata thread.
2608 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 0);
2609 pthread_mutex_lock(&metadata_stream
->lock
);
2611 status
= SYNC_METADATA_STATUS_ERROR
;
2616 * The metadata stream and channel can be deleted while the
2617 * metadata stream lock was released. The streamed is checked
2618 * for deletion before we use it further.
2620 * Note that it is safe to access a logically-deleted stream since its
2621 * existence is still guaranteed by the RCU read side lock. However,
2622 * it should no longer be used. The close/deletion of the metadata
2623 * channel and stream already guarantees that all metadata has been
2624 * consumed. Therefore, there is nothing left to do in this function.
2626 if (consumer_stream_is_deleted(metadata_stream
)) {
2627 DBG("Metadata stream %" PRIu64
" was deleted during the metadata synchronization",
2628 metadata_stream
->key
);
2629 status
= SYNC_METADATA_STATUS_NO_DATA
;
2633 ret
= commit_one_metadata_packet(metadata_stream
);
2635 status
= SYNC_METADATA_STATUS_ERROR
;
2637 } else if (ret
> 0) {
2638 status
= SYNC_METADATA_STATUS_NEW_DATA
;
2639 } else /* ret == 0 */ {
2640 status
= SYNC_METADATA_STATUS_NO_DATA
;
2644 ret
= ustctl_snapshot(metadata_stream
->ustream
);
2646 ERR("Failed to take a snapshot of the metadata ring-buffer positions, ret = %d", ret
);
2647 status
= SYNC_METADATA_STATUS_ERROR
;
2656 * Return 0 on success else a negative value.
2658 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2659 struct lttng_consumer_local_data
*ctx
)
2662 struct ustctl_consumer_stream
*ustream
;
2667 ustream
= stream
->ustream
;
2670 * First, we are going to check if there is a new subbuffer available
2671 * before reading the stream wait_fd.
2673 /* Get the next subbuffer */
2674 ret
= ustctl_get_next_subbuf(ustream
);
2676 /* No more data found, flag the stream. */
2677 stream
->has_data
= 0;
2682 ret
= ustctl_put_subbuf(ustream
);
2685 /* This stream still has data. Flag it and wake up the data thread. */
2686 stream
->has_data
= 1;
2688 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2691 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2692 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2697 /* The wake up pipe has been notified. */
2698 ctx
->has_wakeup
= 1;
2706 static int consumer_stream_ust_on_wake_up(struct lttng_consumer_stream
*stream
)
2711 * We can consume the 1 byte written into the wait_fd by
2712 * UST. Don't trigger error if we cannot read this one byte
2713 * (read returns 0), or if the error is EAGAIN or EWOULDBLOCK.
2715 * This is only done when the stream is monitored by a thread,
2716 * before the flush is done after a hangup and if the stream
2717 * is not flagged with data since there might be nothing to
2718 * consume in the wait fd but still have data available
2719 * flagged by the consumer wake up pipe.
2721 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2725 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2726 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2734 static int extract_common_subbuffer_info(struct lttng_consumer_stream
*stream
,
2735 struct stream_subbuffer
*subbuf
)
2739 ret
= ustctl_get_subbuf_size(
2740 stream
->ustream
, &subbuf
->info
.data
.subbuf_size
);
2745 ret
= ustctl_get_padded_subbuf_size(
2746 stream
->ustream
, &subbuf
->info
.data
.padded_subbuf_size
);
2755 static int extract_metadata_subbuffer_info(struct lttng_consumer_stream
*stream
,
2756 struct stream_subbuffer
*subbuf
)
2760 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2765 subbuf
->info
.metadata
.version
= stream
->metadata_version
;
2771 static int extract_data_subbuffer_info(struct lttng_consumer_stream
*stream
,
2772 struct stream_subbuffer
*subbuf
)
2776 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2781 ret
= ustctl_get_packet_size(
2782 stream
->ustream
, &subbuf
->info
.data
.packet_size
);
2784 PERROR("Failed to get sub-buffer packet size");
2788 ret
= ustctl_get_content_size(
2789 stream
->ustream
, &subbuf
->info
.data
.content_size
);
2791 PERROR("Failed to get sub-buffer content size");
2795 ret
= ustctl_get_timestamp_begin(
2796 stream
->ustream
, &subbuf
->info
.data
.timestamp_begin
);
2798 PERROR("Failed to get sub-buffer begin timestamp");
2802 ret
= ustctl_get_timestamp_end(
2803 stream
->ustream
, &subbuf
->info
.data
.timestamp_end
);
2805 PERROR("Failed to get sub-buffer end timestamp");
2809 ret
= ustctl_get_events_discarded(
2810 stream
->ustream
, &subbuf
->info
.data
.events_discarded
);
2812 PERROR("Failed to get sub-buffer events discarded count");
2816 ret
= ustctl_get_sequence_number(stream
->ustream
,
2817 &subbuf
->info
.data
.sequence_number
.value
);
2819 /* May not be supported by older LTTng-modules. */
2820 if (ret
!= -ENOTTY
) {
2821 PERROR("Failed to get sub-buffer sequence number");
2825 subbuf
->info
.data
.sequence_number
.is_set
= true;
2828 ret
= ustctl_get_stream_id(
2829 stream
->ustream
, &subbuf
->info
.data
.stream_id
);
2831 PERROR("Failed to get stream id");
2835 ret
= ustctl_get_instance_id(stream
->ustream
,
2836 &subbuf
->info
.data
.stream_instance_id
.value
);
2838 /* May not be supported by older LTTng-modules. */
2839 if (ret
!= -ENOTTY
) {
2840 PERROR("Failed to get stream instance id");
2844 subbuf
->info
.data
.stream_instance_id
.is_set
= true;
2850 static int get_next_subbuffer_common(struct lttng_consumer_stream
*stream
,
2851 struct stream_subbuffer
*subbuffer
)
2856 ret
= stream
->read_subbuffer_ops
.extract_subbuffer_info(
2862 ret
= get_current_subbuf_addr(stream
, &addr
);
2867 subbuffer
->buffer
.buffer
= lttng_buffer_view_init(
2868 addr
, 0, subbuffer
->info
.data
.padded_subbuf_size
);
2869 assert(subbuffer
->buffer
.buffer
.data
!= NULL
);
2874 static int get_next_subbuffer(struct lttng_consumer_stream
*stream
,
2875 struct stream_subbuffer
*subbuffer
)
2879 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2884 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2892 static int get_next_subbuffer_metadata(struct lttng_consumer_stream
*stream
,
2893 struct stream_subbuffer
*subbuffer
)
2900 unsigned long consumed_pos
, produced_pos
;
2903 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2905 got_subbuffer
= true;
2907 got_subbuffer
= false;
2908 if (ret
!= -EAGAIN
) {
2915 * Determine if the cache is empty and ensure that a sub-buffer
2916 * is made available if the cache is not empty.
2918 if (!got_subbuffer
) {
2919 ret
= commit_one_metadata_packet(stream
);
2920 if (ret
< 0 && ret
!= -ENOBUFS
) {
2922 } else if (ret
== 0) {
2923 /* Not an error, the cache is empty. */
2928 cache_empty
= false;
2931 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2932 cache_empty
= stream
->chan
->metadata_cache
->max_offset
==
2933 stream
->ust_metadata_pushed
;
2934 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2936 } while (!got_subbuffer
);
2938 /* Populate sub-buffer infos and view. */
2939 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2944 ret
= lttng_ustconsumer_sample_snapshot_positions(stream
);
2947 * -EAGAIN is not expected since we got a sub-buffer and haven't
2948 * pushed the consumption position yet (on put_next).
2950 PERROR("Failed to take a snapshot of metadata buffer positions");
2954 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
2956 PERROR("Failed to get metadata consumed position");
2960 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
2962 PERROR("Failed to get metadata produced position");
2966 /* Last sub-buffer of the ring buffer ? */
2967 buffer_empty
= (consumed_pos
+ stream
->max_sb_size
) == produced_pos
;
2970 * The sessiond registry lock ensures that coherent units of metadata
2971 * are pushed to the consumer daemon at once. Hence, if a sub-buffer is
2972 * acquired, the cache is empty, and it is the only available sub-buffer
2973 * available, it is safe to assume that it is "coherent".
2975 coherent
= got_subbuffer
&& cache_empty
&& buffer_empty
;
2977 LTTNG_OPTIONAL_SET(&subbuffer
->info
.metadata
.coherent
, coherent
);
2982 static int put_next_subbuffer(struct lttng_consumer_stream
*stream
,
2983 struct stream_subbuffer
*subbuffer
)
2985 const int ret
= ustctl_put_next_subbuf(stream
->ustream
);
2991 static int signal_metadata(struct lttng_consumer_stream
*stream
,
2992 struct lttng_consumer_local_data
*ctx
)
2994 return pthread_cond_broadcast(&stream
->metadata_rdv
) ? -errno
: 0;
2997 static int lttng_ustconsumer_set_stream_ops(
2998 struct lttng_consumer_stream
*stream
)
3002 stream
->read_subbuffer_ops
.on_wake_up
= consumer_stream_ust_on_wake_up
;
3003 if (stream
->metadata_flag
) {
3004 stream
->read_subbuffer_ops
.get_next_subbuffer
=
3005 get_next_subbuffer_metadata
;
3006 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
3007 extract_metadata_subbuffer_info
;
3008 stream
->read_subbuffer_ops
.reset_metadata
=
3009 metadata_stream_reset_cache_consumed_position
;
3010 if (stream
->chan
->is_live
) {
3011 stream
->read_subbuffer_ops
.on_sleep
= signal_metadata
;
3012 ret
= consumer_stream_enable_metadata_bucketization(
3019 stream
->read_subbuffer_ops
.get_next_subbuffer
=
3021 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
3022 extract_data_subbuffer_info
;
3023 stream
->read_subbuffer_ops
.on_sleep
= notify_if_more_data
;
3024 if (stream
->chan
->is_live
) {
3025 stream
->read_subbuffer_ops
.send_live_beacon
=
3026 consumer_flush_ust_index
;
3030 stream
->read_subbuffer_ops
.put_next_subbuffer
= put_next_subbuffer
;
3036 * Called when a stream is created.
3038 * Return 0 on success or else a negative value.
3040 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3047 * Don't create anything if this is set for streaming or if there is
3048 * no current trace chunk on the parent channel.
3050 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
&&
3051 stream
->chan
->trace_chunk
) {
3052 ret
= consumer_stream_create_output_files(stream
, true);
3058 lttng_ustconsumer_set_stream_ops(stream
);
3066 * Check if data is still being extracted from the buffers for a specific
3067 * stream. Consumer data lock MUST be acquired before calling this function
3068 * and the stream lock.
3070 * Return 1 if the traced data are still getting read else 0 meaning that the
3071 * data is available for trace viewer reading.
3073 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
3078 assert(stream
->ustream
);
3079 ASSERT_LOCKED(stream
->lock
);
3081 DBG("UST consumer checking data pending");
3083 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
3088 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
3089 uint64_t contiguous
, pushed
;
3091 /* Ease our life a bit. */
3092 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
3093 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
3094 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
3095 pushed
= stream
->ust_metadata_pushed
;
3098 * We can simply check whether all contiguously available data
3099 * has been pushed to the ring buffer, since the push operation
3100 * is performed within get_next_subbuf(), and because both
3101 * get_next_subbuf() and put_next_subbuf() are issued atomically
3102 * thanks to the stream lock within
3103 * lttng_ustconsumer_read_subbuffer(). This basically means that
3104 * whetnever ust_metadata_pushed is incremented, the associated
3105 * metadata has been consumed from the metadata stream.
3107 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
3108 contiguous
, pushed
);
3109 assert(((int64_t) (contiguous
- pushed
)) >= 0);
3110 if ((contiguous
!= pushed
) ||
3111 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
3112 ret
= 1; /* Data is pending */
3116 ret
= ustctl_get_next_subbuf(stream
->ustream
);
3119 * There is still data so let's put back this
3122 ret
= ustctl_put_subbuf(stream
->ustream
);
3124 ret
= 1; /* Data is pending */
3129 /* Data is NOT pending so ready to be read. */
3137 * Stop a given metadata channel timer if enabled and close the wait fd which
3138 * is the poll pipe of the metadata stream.
3140 * This MUST be called with the metadata channel lock acquired.
3142 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
3147 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
3149 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
3151 if (metadata
->switch_timer_enabled
== 1) {
3152 consumer_timer_switch_stop(metadata
);
3155 if (!metadata
->metadata_stream
) {
3160 * Closing write side so the thread monitoring the stream wakes up if any
3161 * and clean the metadata stream.
3163 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
3164 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
3166 PERROR("closing metadata pipe write side");
3168 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3176 * Close every metadata stream wait fd of the metadata hash table. This
3177 * function MUST be used very carefully so not to run into a race between the
3178 * metadata thread handling streams and this function closing their wait fd.
3180 * For UST, this is used when the session daemon hangs up. Its the metadata
3181 * producer so calling this is safe because we are assured that no state change
3182 * can occur in the metadata thread for the streams in the hash table.
3184 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3186 struct lttng_ht_iter iter
;
3187 struct lttng_consumer_stream
*stream
;
3189 assert(metadata_ht
);
3190 assert(metadata_ht
->ht
);
3192 DBG("UST consumer closing all metadata streams");
3195 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3198 health_code_update();
3200 pthread_mutex_lock(&stream
->chan
->lock
);
3201 lttng_ustconsumer_close_metadata(stream
->chan
);
3202 pthread_mutex_unlock(&stream
->chan
->lock
);
3208 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3212 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
3214 ERR("Unable to close wakeup fd");
3219 * Please refer to consumer-timer.c before adding any lock within this
3220 * function or any of its callees. Timers have a very strict locking
3221 * semantic with respect to teardown. Failure to respect this semantic
3222 * introduces deadlocks.
3224 * DON'T hold the metadata lock when calling this function, else this
3225 * can cause deadlock involving consumer awaiting for metadata to be
3226 * pushed out due to concurrent interaction with the session daemon.
3228 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3229 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3231 struct lttcomm_metadata_request_msg request
;
3232 struct lttcomm_consumer_msg msg
;
3233 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3234 uint64_t len
, key
, offset
, version
;
3238 assert(channel
->metadata_cache
);
3240 memset(&request
, 0, sizeof(request
));
3242 /* send the metadata request to sessiond */
3243 switch (consumer_data
.type
) {
3244 case LTTNG_CONSUMER64_UST
:
3245 request
.bits_per_long
= 64;
3247 case LTTNG_CONSUMER32_UST
:
3248 request
.bits_per_long
= 32;
3251 request
.bits_per_long
= 0;
3255 request
.session_id
= channel
->session_id
;
3256 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3258 * Request the application UID here so the metadata of that application can
3259 * be sent back. The channel UID corresponds to the user UID of the session
3260 * used for the rights on the stream file(s).
3262 request
.uid
= channel
->ust_app_uid
;
3263 request
.key
= channel
->key
;
3265 DBG("Sending metadata request to sessiond, session id %" PRIu64
3266 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3267 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3270 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3272 health_code_update();
3274 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3277 ERR("Asking metadata to sessiond");
3281 health_code_update();
3283 /* Receive the metadata from sessiond */
3284 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3286 if (ret
!= sizeof(msg
)) {
3287 DBG("Consumer received unexpected message size %d (expects %zu)",
3289 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3291 * The ret value might 0 meaning an orderly shutdown but this is ok
3292 * since the caller handles this.
3297 health_code_update();
3299 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3300 /* No registry found */
3301 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3305 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3306 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3311 len
= msg
.u
.push_metadata
.len
;
3312 key
= msg
.u
.push_metadata
.key
;
3313 offset
= msg
.u
.push_metadata
.target_offset
;
3314 version
= msg
.u
.push_metadata
.version
;
3316 assert(key
== channel
->key
);
3318 DBG("No new metadata to receive for key %" PRIu64
, key
);
3321 health_code_update();
3323 /* Tell session daemon we are ready to receive the metadata. */
3324 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3325 LTTCOMM_CONSUMERD_SUCCESS
);
3326 if (ret
< 0 || len
== 0) {
3328 * Somehow, the session daemon is not responding anymore or there is
3329 * nothing to receive.
3334 health_code_update();
3336 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3337 key
, offset
, len
, version
, channel
, timer
, wait
);
3340 * Only send the status msg if the sessiond is alive meaning a positive
3343 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3348 health_code_update();
3350 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3355 * Return the ustctl call for the get stream id.
3357 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3358 uint64_t *stream_id
)
3363 return ustctl_get_stream_id(stream
->ustream
, stream_id
);