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>
41 #include "ust-consumer.h"
43 #define INT_MAX_STR_LEN 12 /* includes \0 */
45 extern struct lttng_consumer_global_data consumer_data
;
46 extern int consumer_poll_timeout
;
49 * Free channel object and all streams associated with it. This MUST be used
50 * only and only if the channel has _NEVER_ been added to the global channel
53 static void destroy_channel(struct lttng_consumer_channel
*channel
)
55 struct lttng_consumer_stream
*stream
, *stmp
;
59 DBG("UST consumer cleaning stream list");
61 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
66 cds_list_del(&stream
->send_node
);
67 ustctl_destroy_stream(stream
->ustream
);
68 lttng_trace_chunk_put(stream
->trace_chunk
);
73 * If a channel is available meaning that was created before the streams
77 lttng_ustconsumer_del_channel(channel
);
78 lttng_ustconsumer_free_channel(channel
);
84 * Add channel to internal consumer state.
86 * Returns 0 on success or else a negative value.
88 static int add_channel(struct lttng_consumer_channel
*channel
,
89 struct lttng_consumer_local_data
*ctx
)
96 if (ctx
->on_recv_channel
!= NULL
) {
97 ret
= ctx
->on_recv_channel(channel
);
99 ret
= consumer_add_channel(channel
, ctx
);
100 } else if (ret
< 0) {
101 /* Most likely an ENOMEM. */
102 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
106 ret
= consumer_add_channel(channel
, ctx
);
109 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
116 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
117 * error value if applicable is set in it else it is kept untouched.
119 * Return NULL on error else the newly allocated stream object.
121 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
122 struct lttng_consumer_channel
*channel
,
123 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
126 struct lttng_consumer_stream
*stream
= NULL
;
131 stream
= consumer_stream_create(
138 channel
->trace_chunk
,
143 if (stream
== NULL
) {
147 * We could not find the channel. Can happen if cpu hotplug
148 * happens while tearing down.
150 DBG3("Could not find channel");
155 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
161 consumer_stream_update_channel_attributes(stream
, channel
);
165 *_alloc_ret
= alloc_ret
;
171 * Send the given stream pointer to the corresponding thread.
173 * Returns 0 on success else a negative value.
175 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
176 struct lttng_consumer_local_data
*ctx
)
179 struct lttng_pipe
*stream_pipe
;
181 /* Get the right pipe where the stream will be sent. */
182 if (stream
->metadata_flag
) {
183 consumer_add_metadata_stream(stream
);
184 stream_pipe
= ctx
->consumer_metadata_pipe
;
186 consumer_add_data_stream(stream
);
187 stream_pipe
= ctx
->consumer_data_pipe
;
191 * From this point on, the stream's ownership has been moved away from
192 * the channel and it becomes globally visible. Hence, remove it from
193 * the local stream list to prevent the stream from being both local and
196 stream
->globally_visible
= 1;
197 cds_list_del(&stream
->send_node
);
199 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
201 ERR("Consumer write %s stream to pipe %d",
202 stream
->metadata_flag
? "metadata" : "data",
203 lttng_pipe_get_writefd(stream_pipe
));
204 if (stream
->metadata_flag
) {
205 consumer_del_stream_for_metadata(stream
);
207 consumer_del_stream_for_data(stream
);
217 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
219 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
222 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
223 stream_shm_path
[PATH_MAX
- 1] = '\0';
224 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
229 strncat(stream_shm_path
, cpu_nr
,
230 PATH_MAX
- strlen(stream_shm_path
) - 1);
237 * Create streams for the given channel using liblttng-ust-ctl.
238 * The channel lock must be acquired by the caller.
240 * Return 0 on success else a negative value.
242 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
243 struct lttng_consumer_local_data
*ctx
)
246 struct ustctl_consumer_stream
*ustream
;
247 struct lttng_consumer_stream
*stream
;
248 pthread_mutex_t
*current_stream_lock
= NULL
;
254 * While a stream is available from ustctl. When NULL is returned, we've
255 * reached the end of the possible stream for the channel.
257 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
259 int ust_metadata_pipe
[2];
261 health_code_update();
263 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
264 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
266 ERR("Create ust metadata poll pipe");
269 wait_fd
= ust_metadata_pipe
[0];
271 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
274 /* Allocate consumer stream object. */
275 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
279 stream
->ustream
= ustream
;
281 * Store it so we can save multiple function calls afterwards since
282 * this value is used heavily in the stream threads. This is UST
283 * specific so this is why it's done after allocation.
285 stream
->wait_fd
= wait_fd
;
288 * Increment channel refcount since the channel reference has now been
289 * assigned in the allocation process above.
291 if (stream
->chan
->monitor
) {
292 uatomic_inc(&stream
->chan
->refcount
);
295 pthread_mutex_lock(&stream
->lock
);
296 current_stream_lock
= &stream
->lock
;
298 * Order is important this is why a list is used. On error, the caller
299 * should clean this list.
301 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
303 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
304 &stream
->max_sb_size
);
306 ERR("ustctl_get_max_subbuf_size failed for stream %s",
311 /* Do actions once stream has been received. */
312 if (ctx
->on_recv_stream
) {
313 ret
= ctx
->on_recv_stream(stream
);
319 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
320 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
322 /* Set next CPU stream. */
323 channel
->streams
.count
= ++cpu
;
325 /* Keep stream reference when creating metadata. */
326 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
327 channel
->metadata_stream
= stream
;
328 if (channel
->monitor
) {
329 /* Set metadata poll pipe if we created one */
330 memcpy(stream
->ust_metadata_poll_pipe
,
332 sizeof(ust_metadata_pipe
));
335 pthread_mutex_unlock(&stream
->lock
);
336 current_stream_lock
= NULL
;
343 if (current_stream_lock
) {
344 pthread_mutex_unlock(current_stream_lock
);
350 * create_posix_shm is never called concurrently within a process.
353 int create_posix_shm(void)
355 char tmp_name
[NAME_MAX
];
358 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
364 * Allocate shm, and immediately unlink its shm oject, keeping
365 * only the file descriptor as a reference to the object.
366 * We specifically do _not_ use the / at the beginning of the
367 * pathname so that some OS implementations can keep it local to
368 * the process (POSIX leaves this implementation-defined).
370 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
375 ret
= shm_unlink(tmp_name
);
376 if (ret
< 0 && errno
!= ENOENT
) {
377 PERROR("shm_unlink");
378 goto error_shm_release
;
391 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
,
392 const struct lttng_credentials
*session_credentials
)
394 char shm_path
[PATH_MAX
];
397 if (!channel
->shm_path
[0]) {
398 return create_posix_shm();
400 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
404 return run_as_open(shm_path
,
405 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
406 session_credentials
->uid
, session_credentials
->gid
);
413 * Create an UST channel with the given attributes and send it to the session
414 * daemon using the ust ctl API.
416 * Return 0 on success or else a negative value.
418 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
419 struct ustctl_consumer_channel_attr
*attr
,
420 struct ustctl_consumer_channel
**ust_chanp
)
422 int ret
, nr_stream_fds
, i
, j
;
424 struct ustctl_consumer_channel
*ust_channel
;
429 assert(channel
->buffer_credentials
.is_set
);
431 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
432 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
433 "switch_timer_interval: %u, read_timer_interval: %u, "
434 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
435 attr
->num_subbuf
, attr
->switch_timer_interval
,
436 attr
->read_timer_interval
, attr
->output
, attr
->type
);
438 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
441 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
442 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
447 for (i
= 0; i
< nr_stream_fds
; i
++) {
448 stream_fds
[i
] = open_ust_stream_fd(channel
, i
,
449 &channel
->buffer_credentials
.value
);
450 if (stream_fds
[i
] < 0) {
455 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
460 channel
->nr_stream_fds
= nr_stream_fds
;
461 channel
->stream_fds
= stream_fds
;
462 *ust_chanp
= ust_channel
;
468 for (j
= i
- 1; j
>= 0; j
--) {
471 closeret
= close(stream_fds
[j
]);
475 if (channel
->shm_path
[0]) {
476 char shm_path
[PATH_MAX
];
478 closeret
= get_stream_shm_path(shm_path
,
479 channel
->shm_path
, j
);
481 ERR("Cannot get stream shm path");
483 closeret
= run_as_unlink(shm_path
,
484 channel
->buffer_credentials
.value
.uid
,
485 channel
->buffer_credentials
.value
.gid
);
487 PERROR("unlink %s", shm_path
);
491 /* Try to rmdir all directories under shm_path root. */
492 if (channel
->root_shm_path
[0]) {
493 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
494 channel
->buffer_credentials
.value
.uid
,
495 channel
->buffer_credentials
.value
.gid
,
496 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
504 * Send a single given stream to the session daemon using the sock.
506 * Return 0 on success else a negative value.
508 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
515 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
517 /* Send stream to session daemon. */
518 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
528 * Send channel to sessiond and relayd if applicable.
530 * Return 0 on success or else a negative value.
532 static int send_channel_to_sessiond_and_relayd(int sock
,
533 struct lttng_consumer_channel
*channel
,
534 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
536 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
537 struct lttng_consumer_stream
*stream
;
538 uint64_t net_seq_idx
= -1ULL;
544 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
546 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
547 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
549 health_code_update();
551 /* Try to send the stream to the relayd if one is available. */
552 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
553 stream
->key
, channel
->name
);
554 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
557 * Flag that the relayd was the problem here probably due to a
558 * communicaton error on the socket.
563 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
565 if (net_seq_idx
== -1ULL) {
566 net_seq_idx
= stream
->net_seq_idx
;
571 /* Inform sessiond that we are about to send channel and streams. */
572 ret
= consumer_send_status_msg(sock
, ret_code
);
573 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
575 * Either the session daemon is not responding or the relayd died so we
581 /* Send channel to sessiond. */
582 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
587 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
592 /* The channel was sent successfully to the sessiond at this point. */
593 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
595 health_code_update();
597 /* Send stream to session daemon. */
598 ret
= send_sessiond_stream(sock
, stream
);
604 /* Tell sessiond there is no more stream. */
605 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
610 DBG("UST consumer NULL stream sent to sessiond");
615 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
622 * Creates a channel and streams and add the channel it to the channel internal
623 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
626 * Return 0 on success or else, a negative value is returned and the channel
627 * MUST be destroyed by consumer_del_channel().
629 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
630 struct lttng_consumer_channel
*channel
,
631 struct ustctl_consumer_channel_attr
*attr
)
640 * This value is still used by the kernel consumer since for the kernel,
641 * the stream ownership is not IN the consumer so we need to have the
642 * number of left stream that needs to be initialized so we can know when
643 * to delete the channel (see consumer.c).
645 * As for the user space tracer now, the consumer creates and sends the
646 * stream to the session daemon which only sends them to the application
647 * once every stream of a channel is received making this value useless
648 * because we they will be added to the poll thread before the application
649 * receives them. This ensures that a stream can not hang up during
650 * initilization of a channel.
652 channel
->nb_init_stream_left
= 0;
654 /* The reply msg status is handled in the following call. */
655 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
660 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
663 * For the snapshots (no monitor), we create the metadata streams
664 * on demand, not during the channel creation.
666 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
671 /* Open all streams for this channel. */
672 pthread_mutex_lock(&channel
->lock
);
673 ret
= create_ust_streams(channel
, ctx
);
674 pthread_mutex_unlock(&channel
->lock
);
684 * Send all stream of a channel to the right thread handling it.
686 * On error, return a negative value else 0 on success.
688 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
689 struct lttng_consumer_local_data
*ctx
)
692 struct lttng_consumer_stream
*stream
, *stmp
;
697 /* Send streams to the corresponding thread. */
698 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
701 health_code_update();
703 /* Sending the stream to the thread. */
704 ret
= send_stream_to_thread(stream
, ctx
);
707 * If we are unable to send the stream to the thread, there is
708 * a big problem so just stop everything.
719 * Flush channel's streams using the given key to retrieve the channel.
721 * Return 0 on success else an LTTng error code.
723 static int flush_channel(uint64_t chan_key
)
726 struct lttng_consumer_channel
*channel
;
727 struct lttng_consumer_stream
*stream
;
729 struct lttng_ht_iter iter
;
731 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
734 channel
= consumer_find_channel(chan_key
);
736 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
737 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
741 ht
= consumer_data
.stream_per_chan_id_ht
;
743 /* For each stream of the channel id, flush it. */
744 cds_lfht_for_each_entry_duplicate(ht
->ht
,
745 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
746 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
748 health_code_update();
750 pthread_mutex_lock(&stream
->lock
);
753 * Protect against concurrent teardown of a stream.
755 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
759 if (!stream
->quiescent
) {
760 ustctl_flush_buffer(stream
->ustream
, 0);
761 stream
->quiescent
= true;
764 pthread_mutex_unlock(&stream
->lock
);
772 * Clear quiescent state from channel's streams using the given key to
773 * retrieve the channel.
775 * Return 0 on success else an LTTng error code.
777 static int clear_quiescent_channel(uint64_t chan_key
)
780 struct lttng_consumer_channel
*channel
;
781 struct lttng_consumer_stream
*stream
;
783 struct lttng_ht_iter iter
;
785 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
788 channel
= consumer_find_channel(chan_key
);
790 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
791 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
795 ht
= consumer_data
.stream_per_chan_id_ht
;
797 /* For each stream of the channel id, clear quiescent state. */
798 cds_lfht_for_each_entry_duplicate(ht
->ht
,
799 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
800 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
802 health_code_update();
804 pthread_mutex_lock(&stream
->lock
);
805 stream
->quiescent
= false;
806 pthread_mutex_unlock(&stream
->lock
);
814 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
816 * Return 0 on success else an LTTng error code.
818 static int close_metadata(uint64_t chan_key
)
821 struct lttng_consumer_channel
*channel
;
822 unsigned int channel_monitor
;
824 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
826 channel
= consumer_find_channel(chan_key
);
829 * This is possible if the metadata thread has issue a delete because
830 * the endpoint point of the stream hung up. There is no way the
831 * session daemon can know about it thus use a DBG instead of an actual
834 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
835 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
839 pthread_mutex_lock(&consumer_data
.lock
);
840 pthread_mutex_lock(&channel
->lock
);
841 channel_monitor
= channel
->monitor
;
842 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
846 lttng_ustconsumer_close_metadata(channel
);
847 pthread_mutex_unlock(&channel
->lock
);
848 pthread_mutex_unlock(&consumer_data
.lock
);
851 * The ownership of a metadata channel depends on the type of
852 * session to which it belongs. In effect, the monitor flag is checked
853 * to determine if this metadata channel is in "snapshot" mode or not.
855 * In the non-snapshot case, the metadata channel is created along with
856 * a single stream which will remain present until the metadata channel
857 * is destroyed (on the destruction of its session). In this case, the
858 * metadata stream in "monitored" by the metadata poll thread and holds
859 * the ownership of its channel.
861 * Closing the metadata will cause the metadata stream's "metadata poll
862 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
863 * thread which will teardown the metadata stream which, in return,
864 * deletes the metadata channel.
866 * In the snapshot case, the metadata stream is created and destroyed
867 * on every snapshot record. Since the channel doesn't have an owner
868 * other than the session daemon, it is safe to destroy it immediately
869 * on reception of the CLOSE_METADATA command.
871 if (!channel_monitor
) {
873 * The channel and consumer_data locks must be
874 * released before this call since consumer_del_channel
875 * re-acquires the channel and consumer_data locks to teardown
876 * the channel and queue its reclamation by the "call_rcu"
879 consumer_del_channel(channel
);
884 pthread_mutex_unlock(&channel
->lock
);
885 pthread_mutex_unlock(&consumer_data
.lock
);
891 * RCU read side lock MUST be acquired before calling this function.
893 * Return 0 on success else an LTTng error code.
895 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
898 struct lttng_consumer_channel
*metadata
;
900 DBG("UST consumer setup metadata key %" PRIu64
, key
);
902 metadata
= consumer_find_channel(key
);
904 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
905 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
910 * In no monitor mode, the metadata channel has no stream(s) so skip the
911 * ownership transfer to the metadata thread.
913 if (!metadata
->monitor
) {
914 DBG("Metadata channel in no monitor");
920 * Send metadata stream to relayd if one available. Availability is
921 * known if the stream is still in the list of the channel.
923 if (cds_list_empty(&metadata
->streams
.head
)) {
924 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
925 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
926 goto error_no_stream
;
929 /* Send metadata stream to relayd if needed. */
930 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
931 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
934 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
937 ret
= consumer_send_relayd_streams_sent(
938 metadata
->metadata_stream
->net_seq_idx
);
940 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
946 * Ownership of metadata stream is passed along. Freeing is handled by
949 ret
= send_streams_to_thread(metadata
, ctx
);
952 * If we are unable to send the stream to the thread, there is
953 * a big problem so just stop everything.
955 ret
= LTTCOMM_CONSUMERD_FATAL
;
956 goto send_streams_error
;
958 /* List MUST be empty after or else it could be reused. */
959 assert(cds_list_empty(&metadata
->streams
.head
));
966 * Delete metadata channel on error. At this point, the metadata stream can
967 * NOT be monitored by the metadata thread thus having the guarantee that
968 * the stream is still in the local stream list of the channel. This call
969 * will make sure to clean that list.
971 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
972 cds_list_del(&metadata
->metadata_stream
->send_node
);
973 metadata
->metadata_stream
= NULL
;
981 * Snapshot the whole metadata.
982 * RCU read-side lock must be held by the caller.
984 * Returns 0 on success, < 0 on error
986 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
987 uint64_t key
, char *path
, uint64_t relayd_id
,
988 struct lttng_consumer_local_data
*ctx
)
991 struct lttng_consumer_stream
*metadata_stream
;
996 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
1001 assert(!metadata_channel
->monitor
);
1003 health_code_update();
1006 * Ask the sessiond if we have new metadata waiting and update the
1007 * consumer metadata cache.
1009 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
1014 health_code_update();
1017 * The metadata stream is NOT created in no monitor mode when the channel
1018 * is created on a sessiond ask channel command.
1020 ret
= create_ust_streams(metadata_channel
, ctx
);
1025 metadata_stream
= metadata_channel
->metadata_stream
;
1026 assert(metadata_stream
);
1028 pthread_mutex_lock(&metadata_stream
->lock
);
1029 if (relayd_id
!= (uint64_t) -1ULL) {
1030 metadata_stream
->net_seq_idx
= relayd_id
;
1031 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1033 ret
= consumer_stream_create_output_files(metadata_stream
,
1036 pthread_mutex_unlock(&metadata_stream
->lock
);
1042 health_code_update();
1044 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
, true);
1052 * Clean up the stream completly because the next snapshot will use a new
1055 consumer_stream_destroy(metadata_stream
, NULL
);
1056 cds_list_del(&metadata_stream
->send_node
);
1057 metadata_channel
->metadata_stream
= NULL
;
1065 int get_current_subbuf_addr(struct lttng_consumer_stream
*stream
,
1069 unsigned long mmap_offset
;
1070 const char *mmap_base
;
1072 mmap_base
= ustctl_get_mmap_base(stream
->ustream
);
1074 ERR("Failed to get mmap base for stream `%s`",
1080 ret
= ustctl_get_mmap_read_offset(stream
->ustream
, &mmap_offset
);
1082 ERR("Failed to get mmap offset for stream `%s`", stream
->name
);
1087 *addr
= mmap_base
+ mmap_offset
;
1094 * Take a snapshot of all the stream of a channel.
1095 * RCU read-side lock and the channel lock must be held by the caller.
1097 * Returns 0 on success, < 0 on error
1099 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1100 uint64_t key
, char *path
, uint64_t relayd_id
,
1101 uint64_t nb_packets_per_stream
,
1102 struct lttng_consumer_local_data
*ctx
)
1105 unsigned use_relayd
= 0;
1106 unsigned long consumed_pos
, produced_pos
;
1107 struct lttng_consumer_stream
*stream
;
1114 if (relayd_id
!= (uint64_t) -1ULL) {
1118 assert(!channel
->monitor
);
1119 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1121 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1122 health_code_update();
1124 /* Lock stream because we are about to change its state. */
1125 pthread_mutex_lock(&stream
->lock
);
1126 assert(channel
->trace_chunk
);
1127 if (!lttng_trace_chunk_get(channel
->trace_chunk
)) {
1129 * Can't happen barring an internal error as the channel
1130 * holds a reference to the trace chunk.
1132 ERR("Failed to acquire reference to channel's trace chunk");
1136 assert(!stream
->trace_chunk
);
1137 stream
->trace_chunk
= channel
->trace_chunk
;
1139 stream
->net_seq_idx
= relayd_id
;
1142 ret
= consumer_send_relayd_stream(stream
, path
);
1147 ret
= consumer_stream_create_output_files(stream
,
1152 DBG("UST consumer snapshot stream (%" PRIu64
")",
1157 * If tracing is active, we want to perform a "full" buffer flush.
1158 * Else, if quiescent, it has already been done by the prior stop.
1160 if (!stream
->quiescent
) {
1161 ustctl_flush_buffer(stream
->ustream
, 0);
1164 ret
= lttng_ustconsumer_take_snapshot(stream
);
1166 ERR("Taking UST snapshot");
1170 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1172 ERR("Produced UST snapshot position");
1176 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1178 ERR("Consumerd UST snapshot position");
1183 * The original value is sent back if max stream size is larger than
1184 * the possible size of the snapshot. Also, we assume that the session
1185 * daemon should never send a maximum stream size that is lower than
1188 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1189 produced_pos
, nb_packets_per_stream
,
1190 stream
->max_sb_size
);
1192 while ((long) (consumed_pos
- produced_pos
) < 0) {
1194 unsigned long len
, padded_len
;
1195 const char *subbuf_addr
;
1196 struct lttng_buffer_view subbuf_view
;
1198 health_code_update();
1200 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1202 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1204 if (ret
!= -EAGAIN
) {
1205 PERROR("ustctl_get_subbuf snapshot");
1206 goto error_close_stream
;
1208 DBG("UST consumer get subbuf failed. Skipping it.");
1209 consumed_pos
+= stream
->max_sb_size
;
1210 stream
->chan
->lost_packets
++;
1214 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1216 ERR("Snapshot ustctl_get_subbuf_size");
1217 goto error_put_subbuf
;
1220 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1222 ERR("Snapshot ustctl_get_padded_subbuf_size");
1223 goto error_put_subbuf
;
1226 ret
= get_current_subbuf_addr(stream
, &subbuf_addr
);
1228 goto error_put_subbuf
;
1231 subbuf_view
= lttng_buffer_view_init(
1232 subbuf_addr
, 0, padded_len
);
1233 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
,
1234 stream
, &subbuf_view
, padded_len
- len
);
1236 if (read_len
!= len
) {
1238 goto error_put_subbuf
;
1241 if (read_len
!= padded_len
) {
1243 goto error_put_subbuf
;
1247 ret
= ustctl_put_subbuf(stream
->ustream
);
1249 ERR("Snapshot ustctl_put_subbuf");
1250 goto error_close_stream
;
1252 consumed_pos
+= stream
->max_sb_size
;
1255 /* Simply close the stream so we can use it on the next snapshot. */
1256 consumer_stream_close(stream
);
1257 pthread_mutex_unlock(&stream
->lock
);
1264 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1265 ERR("Snapshot ustctl_put_subbuf");
1268 consumer_stream_close(stream
);
1270 pthread_mutex_unlock(&stream
->lock
);
1276 * Receive the metadata updates from the sessiond. Supports receiving
1277 * overlapping metadata, but is needs to always belong to a contiguous
1278 * range starting from 0.
1279 * Be careful about the locks held when calling this function: it needs
1280 * the metadata cache flush to concurrently progress in order to
1283 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1284 uint64_t len
, uint64_t version
,
1285 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1287 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1290 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1292 metadata_str
= zmalloc(len
* sizeof(char));
1293 if (!metadata_str
) {
1294 PERROR("zmalloc metadata string");
1295 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1299 health_code_update();
1301 /* Receive metadata string. */
1302 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1304 /* Session daemon is dead so return gracefully. */
1309 health_code_update();
1311 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1312 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1315 /* Unable to handle metadata. Notify session daemon. */
1316 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1318 * Skip metadata flush on write error since the offset and len might
1319 * not have been updated which could create an infinite loop below when
1320 * waiting for the metadata cache to be flushed.
1322 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1325 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1330 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1331 DBG("Waiting for metadata to be flushed");
1333 health_code_update();
1335 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1345 * Receive command from session daemon and process it.
1347 * Return 1 on success else a negative value or 0.
1349 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1350 int sock
, struct pollfd
*consumer_sockpoll
)
1353 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1354 struct lttcomm_consumer_msg msg
;
1355 struct lttng_consumer_channel
*channel
= NULL
;
1357 health_code_update();
1359 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1360 if (ret
!= sizeof(msg
)) {
1361 DBG("Consumer received unexpected message size %zd (expects %zu)",
1364 * The ret value might 0 meaning an orderly shutdown but this is ok
1365 * since the caller handles this.
1368 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1374 health_code_update();
1377 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1379 health_code_update();
1381 /* relayd needs RCU read-side lock */
1384 switch (msg
.cmd_type
) {
1385 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1387 /* Session daemon status message are handled in the following call. */
1388 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1389 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1390 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1391 msg
.u
.relayd_sock
.relayd_session_id
);
1394 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1396 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1397 struct consumer_relayd_sock_pair
*relayd
;
1399 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1401 /* Get relayd reference if exists. */
1402 relayd
= consumer_find_relayd(index
);
1403 if (relayd
== NULL
) {
1404 DBG("Unable to find relayd %" PRIu64
, index
);
1405 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1409 * Each relayd socket pair has a refcount of stream attached to it
1410 * which tells if the relayd is still active or not depending on the
1413 * This will set the destroy flag of the relayd object and destroy it
1414 * if the refcount reaches zero when called.
1416 * The destroy can happen either here or when a stream fd hangs up.
1419 consumer_flag_relayd_for_destroy(relayd
);
1422 goto end_msg_sessiond
;
1424 case LTTNG_CONSUMER_UPDATE_STREAM
:
1429 case LTTNG_CONSUMER_DATA_PENDING
:
1431 int ret
, is_data_pending
;
1432 uint64_t id
= msg
.u
.data_pending
.session_id
;
1434 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1436 is_data_pending
= consumer_data_pending(id
);
1438 /* Send back returned value to session daemon */
1439 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1440 sizeof(is_data_pending
));
1442 DBG("Error when sending the data pending ret code: %d", ret
);
1447 * No need to send back a status message since the data pending
1448 * returned value is the response.
1452 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1455 struct ustctl_consumer_channel_attr attr
;
1456 const uint64_t chunk_id
= msg
.u
.ask_channel
.chunk_id
.value
;
1457 const struct lttng_credentials buffer_credentials
= {
1458 .uid
= msg
.u
.ask_channel
.buffer_credentials
.uid
,
1459 .gid
= msg
.u
.ask_channel
.buffer_credentials
.gid
,
1462 /* Create a plain object and reserve a channel key. */
1463 channel
= consumer_allocate_channel(
1464 msg
.u
.ask_channel
.key
,
1465 msg
.u
.ask_channel
.session_id
,
1466 msg
.u
.ask_channel
.chunk_id
.is_set
?
1468 msg
.u
.ask_channel
.pathname
,
1469 msg
.u
.ask_channel
.name
,
1470 msg
.u
.ask_channel
.relayd_id
,
1471 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1472 msg
.u
.ask_channel
.tracefile_size
,
1473 msg
.u
.ask_channel
.tracefile_count
,
1474 msg
.u
.ask_channel
.session_id_per_pid
,
1475 msg
.u
.ask_channel
.monitor
,
1476 msg
.u
.ask_channel
.live_timer_interval
,
1477 msg
.u
.ask_channel
.is_live
,
1478 msg
.u
.ask_channel
.root_shm_path
,
1479 msg
.u
.ask_channel
.shm_path
);
1481 goto end_channel_error
;
1484 LTTNG_OPTIONAL_SET(&channel
->buffer_credentials
,
1485 buffer_credentials
);
1488 * Assign UST application UID to the channel. This value is ignored for
1489 * per PID buffers. This is specific to UST thus setting this after the
1492 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1494 /* Build channel attributes from received message. */
1495 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1496 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1497 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1498 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1499 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1500 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1501 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1502 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1504 /* Match channel buffer type to the UST abi. */
1505 switch (msg
.u
.ask_channel
.output
) {
1506 case LTTNG_EVENT_MMAP
:
1508 attr
.output
= LTTNG_UST_MMAP
;
1512 /* Translate and save channel type. */
1513 switch (msg
.u
.ask_channel
.type
) {
1514 case LTTNG_UST_CHAN_PER_CPU
:
1515 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1516 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1518 * Set refcount to 1 for owner. Below, we will
1519 * pass ownership to the
1520 * consumer_thread_channel_poll() thread.
1522 channel
->refcount
= 1;
1524 case LTTNG_UST_CHAN_METADATA
:
1525 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1526 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1533 health_code_update();
1535 ret
= ask_channel(ctx
, channel
, &attr
);
1537 goto end_channel_error
;
1540 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1541 ret
= consumer_metadata_cache_allocate(channel
);
1543 ERR("Allocating metadata cache");
1544 goto end_channel_error
;
1546 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1547 attr
.switch_timer_interval
= 0;
1549 int monitor_start_ret
;
1551 consumer_timer_live_start(channel
,
1552 msg
.u
.ask_channel
.live_timer_interval
);
1553 monitor_start_ret
= consumer_timer_monitor_start(
1555 msg
.u
.ask_channel
.monitor_timer_interval
);
1556 if (monitor_start_ret
< 0) {
1557 ERR("Starting channel monitoring timer failed");
1558 goto end_channel_error
;
1562 health_code_update();
1565 * Add the channel to the internal state AFTER all streams were created
1566 * and successfully sent to session daemon. This way, all streams must
1567 * be ready before this channel is visible to the threads.
1568 * If add_channel succeeds, ownership of the channel is
1569 * passed to consumer_thread_channel_poll().
1571 ret
= add_channel(channel
, ctx
);
1573 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1574 if (channel
->switch_timer_enabled
== 1) {
1575 consumer_timer_switch_stop(channel
);
1577 consumer_metadata_cache_destroy(channel
);
1579 if (channel
->live_timer_enabled
== 1) {
1580 consumer_timer_live_stop(channel
);
1582 if (channel
->monitor_timer_enabled
== 1) {
1583 consumer_timer_monitor_stop(channel
);
1585 goto end_channel_error
;
1588 health_code_update();
1591 * Channel and streams are now created. Inform the session daemon that
1592 * everything went well and should wait to receive the channel and
1593 * streams with ustctl API.
1595 ret
= consumer_send_status_channel(sock
, channel
);
1598 * There is probably a problem on the socket.
1605 case LTTNG_CONSUMER_GET_CHANNEL
:
1607 int ret
, relayd_err
= 0;
1608 uint64_t key
= msg
.u
.get_channel
.key
;
1609 struct lttng_consumer_channel
*channel
;
1611 channel
= consumer_find_channel(key
);
1613 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1614 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1615 goto end_get_channel
;
1618 health_code_update();
1620 /* Send the channel to sessiond (and relayd, if applicable). */
1621 ret
= send_channel_to_sessiond_and_relayd(sock
, channel
, ctx
,
1626 * We were unable to send to the relayd the stream so avoid
1627 * sending back a fatal error to the thread since this is OK
1628 * and the consumer can continue its work. The above call
1629 * has sent the error status message to the sessiond.
1631 goto end_get_channel_nosignal
;
1634 * The communicaton was broken hence there is a bad state between
1635 * the consumer and sessiond so stop everything.
1637 goto error_get_channel_fatal
;
1640 health_code_update();
1643 * In no monitor mode, the streams ownership is kept inside the channel
1644 * so don't send them to the data thread.
1646 if (!channel
->monitor
) {
1647 goto end_get_channel
;
1650 ret
= send_streams_to_thread(channel
, ctx
);
1653 * If we are unable to send the stream to the thread, there is
1654 * a big problem so just stop everything.
1656 goto error_get_channel_fatal
;
1658 /* List MUST be empty after or else it could be reused. */
1659 assert(cds_list_empty(&channel
->streams
.head
));
1661 goto end_msg_sessiond
;
1662 error_get_channel_fatal
:
1664 end_get_channel_nosignal
:
1667 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1669 uint64_t key
= msg
.u
.destroy_channel
.key
;
1672 * Only called if streams have not been sent to stream
1673 * manager thread. However, channel has been sent to
1674 * channel manager thread.
1676 notify_thread_del_channel(ctx
, key
);
1677 goto end_msg_sessiond
;
1679 case LTTNG_CONSUMER_CLOSE_METADATA
:
1683 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1688 goto end_msg_sessiond
;
1690 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1694 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1699 goto end_msg_sessiond
;
1701 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1705 ret
= clear_quiescent_channel(
1706 msg
.u
.clear_quiescent_channel
.key
);
1711 goto end_msg_sessiond
;
1713 case LTTNG_CONSUMER_PUSH_METADATA
:
1716 uint64_t len
= msg
.u
.push_metadata
.len
;
1717 uint64_t key
= msg
.u
.push_metadata
.key
;
1718 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1719 uint64_t version
= msg
.u
.push_metadata
.version
;
1720 struct lttng_consumer_channel
*channel
;
1722 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1725 channel
= consumer_find_channel(key
);
1728 * This is possible if the metadata creation on the consumer side
1729 * is in flight vis-a-vis a concurrent push metadata from the
1730 * session daemon. Simply return that the channel failed and the
1731 * session daemon will handle that message correctly considering
1732 * that this race is acceptable thus the DBG() statement here.
1734 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1735 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1736 goto end_push_metadata_msg_sessiond
;
1739 health_code_update();
1743 * There is nothing to receive. We have simply
1744 * checked whether the channel can be found.
1746 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1747 goto end_push_metadata_msg_sessiond
;
1750 /* Tell session daemon we are ready to receive the metadata. */
1751 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1753 /* Somehow, the session daemon is not responding anymore. */
1754 goto error_push_metadata_fatal
;
1757 health_code_update();
1759 /* Wait for more data. */
1760 health_poll_entry();
1761 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1764 goto error_push_metadata_fatal
;
1767 health_code_update();
1769 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1770 len
, version
, channel
, 0, 1);
1772 /* error receiving from sessiond */
1773 goto error_push_metadata_fatal
;
1776 goto end_push_metadata_msg_sessiond
;
1778 end_push_metadata_msg_sessiond
:
1779 goto end_msg_sessiond
;
1780 error_push_metadata_fatal
:
1783 case LTTNG_CONSUMER_SETUP_METADATA
:
1787 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1791 goto end_msg_sessiond
;
1793 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1795 struct lttng_consumer_channel
*channel
;
1796 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1798 channel
= consumer_find_channel(key
);
1800 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1801 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1803 if (msg
.u
.snapshot_channel
.metadata
) {
1804 ret
= snapshot_metadata(channel
, key
,
1805 msg
.u
.snapshot_channel
.pathname
,
1806 msg
.u
.snapshot_channel
.relayd_id
,
1809 ERR("Snapshot metadata failed");
1810 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1813 ret
= snapshot_channel(channel
, key
,
1814 msg
.u
.snapshot_channel
.pathname
,
1815 msg
.u
.snapshot_channel
.relayd_id
,
1816 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1819 ERR("Snapshot channel failed");
1820 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1824 health_code_update();
1825 ret
= consumer_send_status_msg(sock
, ret_code
);
1827 /* Somehow, the session daemon is not responding anymore. */
1830 health_code_update();
1833 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1836 uint64_t discarded_events
;
1837 struct lttng_ht_iter iter
;
1838 struct lttng_ht
*ht
;
1839 struct lttng_consumer_stream
*stream
;
1840 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1841 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1843 DBG("UST consumer discarded events command for session id %"
1846 pthread_mutex_lock(&consumer_data
.lock
);
1848 ht
= consumer_data
.stream_list_ht
;
1851 * We only need a reference to the channel, but they are not
1852 * directly indexed, so we just use the first matching stream
1853 * to extract the information we need, we default to 0 if not
1854 * found (no events are dropped if the channel is not yet in
1857 discarded_events
= 0;
1858 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1859 ht
->hash_fct(&id
, lttng_ht_seed
),
1861 &iter
.iter
, stream
, node_session_id
.node
) {
1862 if (stream
->chan
->key
== key
) {
1863 discarded_events
= stream
->chan
->discarded_events
;
1867 pthread_mutex_unlock(&consumer_data
.lock
);
1870 DBG("UST consumer discarded events command for session id %"
1871 PRIu64
", channel key %" PRIu64
, id
, key
);
1873 health_code_update();
1875 /* Send back returned value to session daemon */
1876 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1878 PERROR("send discarded events");
1884 case LTTNG_CONSUMER_LOST_PACKETS
:
1887 uint64_t lost_packets
;
1888 struct lttng_ht_iter iter
;
1889 struct lttng_ht
*ht
;
1890 struct lttng_consumer_stream
*stream
;
1891 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1892 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1894 DBG("UST consumer lost packets command for session id %"
1897 pthread_mutex_lock(&consumer_data
.lock
);
1899 ht
= consumer_data
.stream_list_ht
;
1902 * We only need a reference to the channel, but they are not
1903 * directly indexed, so we just use the first matching stream
1904 * to extract the information we need, we default to 0 if not
1905 * found (no packets lost if the channel is not yet in use).
1908 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1909 ht
->hash_fct(&id
, lttng_ht_seed
),
1911 &iter
.iter
, stream
, node_session_id
.node
) {
1912 if (stream
->chan
->key
== key
) {
1913 lost_packets
= stream
->chan
->lost_packets
;
1917 pthread_mutex_unlock(&consumer_data
.lock
);
1920 DBG("UST consumer lost packets command for session id %"
1921 PRIu64
", channel key %" PRIu64
, id
, key
);
1923 health_code_update();
1925 /* Send back returned value to session daemon */
1926 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1927 sizeof(lost_packets
));
1929 PERROR("send lost packets");
1935 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1937 int channel_monitor_pipe
;
1939 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1940 /* Successfully received the command's type. */
1941 ret
= consumer_send_status_msg(sock
, ret_code
);
1946 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1948 if (ret
!= sizeof(channel_monitor_pipe
)) {
1949 ERR("Failed to receive channel monitor pipe");
1953 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1954 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1955 channel_monitor_pipe
);
1959 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1960 /* Set the pipe as non-blocking. */
1961 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1963 PERROR("fcntl get flags of the channel monitoring pipe");
1968 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1969 flags
| O_NONBLOCK
);
1971 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1974 DBG("Channel monitor pipe set as non-blocking");
1976 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1978 goto end_msg_sessiond
;
1980 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
1982 struct lttng_consumer_channel
*channel
;
1983 uint64_t key
= msg
.u
.rotate_channel
.key
;
1985 channel
= consumer_find_channel(key
);
1987 DBG("Channel %" PRIu64
" not found", key
);
1988 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1991 * Sample the rotate position of all the streams in
1994 ret
= lttng_consumer_rotate_channel(channel
, key
,
1995 msg
.u
.rotate_channel
.relayd_id
,
1996 msg
.u
.rotate_channel
.metadata
,
1999 ERR("Rotate channel failed");
2000 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
2003 health_code_update();
2005 ret
= consumer_send_status_msg(sock
, ret_code
);
2007 /* Somehow, the session daemon is not responding anymore. */
2008 goto end_rotate_channel_nosignal
;
2012 * Rotate the streams that are ready right now.
2013 * FIXME: this is a second consecutive iteration over the
2014 * streams in a channel, there is probably a better way to
2015 * handle this, but it needs to be after the
2016 * consumer_send_status_msg() call.
2019 ret
= lttng_consumer_rotate_ready_streams(
2022 ERR("Rotate channel failed");
2026 end_rotate_channel_nosignal
:
2029 case LTTNG_CONSUMER_CLEAR_CHANNEL
:
2031 struct lttng_consumer_channel
*channel
;
2032 uint64_t key
= msg
.u
.clear_channel
.key
;
2034 channel
= consumer_find_channel(key
);
2036 DBG("Channel %" PRIu64
" not found", key
);
2037 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
2039 ret
= lttng_consumer_clear_channel(channel
);
2041 ERR("Clear channel failed key %" PRIu64
, key
);
2045 health_code_update();
2047 ret
= consumer_send_status_msg(sock
, ret_code
);
2049 /* Somehow, the session daemon is not responding anymore. */
2054 case LTTNG_CONSUMER_INIT
:
2056 ret_code
= lttng_consumer_init_command(ctx
,
2057 msg
.u
.init
.sessiond_uuid
);
2058 health_code_update();
2059 ret
= consumer_send_status_msg(sock
, ret_code
);
2061 /* Somehow, the session daemon is not responding anymore. */
2066 case LTTNG_CONSUMER_CREATE_TRACE_CHUNK
:
2068 const struct lttng_credentials credentials
= {
2069 .uid
= msg
.u
.create_trace_chunk
.credentials
.value
.uid
,
2070 .gid
= msg
.u
.create_trace_chunk
.credentials
.value
.gid
,
2072 const bool is_local_trace
=
2073 !msg
.u
.create_trace_chunk
.relayd_id
.is_set
;
2074 const uint64_t relayd_id
=
2075 msg
.u
.create_trace_chunk
.relayd_id
.value
;
2076 const char *chunk_override_name
=
2077 *msg
.u
.create_trace_chunk
.override_name
?
2078 msg
.u
.create_trace_chunk
.override_name
:
2080 struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
2083 * The session daemon will only provide a chunk directory file
2084 * descriptor for local traces.
2086 if (is_local_trace
) {
2089 /* Acnowledge the reception of the command. */
2090 ret
= consumer_send_status_msg(sock
,
2091 LTTCOMM_CONSUMERD_SUCCESS
);
2093 /* Somehow, the session daemon is not responding anymore. */
2098 * Receive trace chunk domain dirfd.
2100 ret
= lttcomm_recv_fds_unix_sock(sock
, &chunk_dirfd
, 1);
2101 if (ret
!= sizeof(chunk_dirfd
)) {
2102 ERR("Failed to receive trace chunk domain directory file descriptor");
2106 DBG("Received trace chunk domain directory fd (%d)",
2108 chunk_directory_handle
= lttng_directory_handle_create_from_dirfd(
2110 if (!chunk_directory_handle
) {
2111 ERR("Failed to initialize chunk domain directory handle from directory file descriptor");
2112 if (close(chunk_dirfd
)) {
2113 PERROR("Failed to close chunk directory file descriptor");
2119 ret_code
= lttng_consumer_create_trace_chunk(
2120 !is_local_trace
? &relayd_id
: NULL
,
2121 msg
.u
.create_trace_chunk
.session_id
,
2122 msg
.u
.create_trace_chunk
.chunk_id
,
2123 (time_t) msg
.u
.create_trace_chunk
2124 .creation_timestamp
,
2125 chunk_override_name
,
2126 msg
.u
.create_trace_chunk
.credentials
.is_set
?
2129 chunk_directory_handle
);
2130 lttng_directory_handle_put(chunk_directory_handle
);
2131 goto end_msg_sessiond
;
2133 case LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
:
2135 enum lttng_trace_chunk_command_type close_command
=
2136 msg
.u
.close_trace_chunk
.close_command
.value
;
2137 const uint64_t relayd_id
=
2138 msg
.u
.close_trace_chunk
.relayd_id
.value
;
2139 struct lttcomm_consumer_close_trace_chunk_reply reply
;
2140 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2143 ret_code
= lttng_consumer_close_trace_chunk(
2144 msg
.u
.close_trace_chunk
.relayd_id
.is_set
?
2147 msg
.u
.close_trace_chunk
.session_id
,
2148 msg
.u
.close_trace_chunk
.chunk_id
,
2149 (time_t) msg
.u
.close_trace_chunk
.close_timestamp
,
2150 msg
.u
.close_trace_chunk
.close_command
.is_set
?
2152 NULL
, closed_trace_chunk_path
);
2153 reply
.ret_code
= ret_code
;
2154 reply
.path_length
= strlen(closed_trace_chunk_path
) + 1;
2155 ret
= lttcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2156 if (ret
!= sizeof(reply
)) {
2159 ret
= lttcomm_send_unix_sock(sock
, closed_trace_chunk_path
,
2161 if (ret
!= reply
.path_length
) {
2166 case LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
:
2168 const uint64_t relayd_id
=
2169 msg
.u
.trace_chunk_exists
.relayd_id
.value
;
2171 ret_code
= lttng_consumer_trace_chunk_exists(
2172 msg
.u
.trace_chunk_exists
.relayd_id
.is_set
?
2174 msg
.u
.trace_chunk_exists
.session_id
,
2175 msg
.u
.trace_chunk_exists
.chunk_id
);
2176 goto end_msg_sessiond
;
2184 * Return 1 to indicate success since the 0 value can be a socket
2185 * shutdown during the recv() or send() call.
2192 * The returned value here is not useful since either way we'll return 1 to
2193 * the caller because the session daemon socket management is done
2194 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
2196 ret
= consumer_send_status_msg(sock
, ret_code
);
2206 * Free channel here since no one has a reference to it. We don't
2207 * free after that because a stream can store this pointer.
2209 destroy_channel(channel
);
2211 /* We have to send a status channel message indicating an error. */
2212 ret
= consumer_send_status_channel(sock
, NULL
);
2214 /* Stop everything if session daemon can not be notified. */
2221 /* This will issue a consumer stop. */
2227 health_code_update();
2231 void lttng_ustctl_flush_buffer(struct lttng_consumer_stream
*stream
,
2232 int producer_active
)
2235 assert(stream
->ustream
);
2237 ustctl_flush_buffer(stream
->ustream
, producer_active
);
2241 * Take a snapshot for a specific stream.
2243 * Returns 0 on success, < 0 on error
2245 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2248 assert(stream
->ustream
);
2250 return ustctl_snapshot(stream
->ustream
);
2254 * Sample consumed and produced positions for a specific stream.
2256 * Returns 0 on success, < 0 on error.
2258 int lttng_ustconsumer_sample_snapshot_positions(
2259 struct lttng_consumer_stream
*stream
)
2262 assert(stream
->ustream
);
2264 return ustctl_snapshot_sample_positions(stream
->ustream
);
2268 * Get the produced position
2270 * Returns 0 on success, < 0 on error
2272 int lttng_ustconsumer_get_produced_snapshot(
2273 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2276 assert(stream
->ustream
);
2279 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2283 * Get the consumed position
2285 * Returns 0 on success, < 0 on error
2287 int lttng_ustconsumer_get_consumed_snapshot(
2288 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2291 assert(stream
->ustream
);
2294 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2297 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2301 assert(stream
->ustream
);
2303 ustctl_flush_buffer(stream
->ustream
, producer
);
2306 void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream
*stream
)
2309 assert(stream
->ustream
);
2311 ustctl_clear_buffer(stream
->ustream
);
2314 int lttng_ustconsumer_get_current_timestamp(
2315 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2318 assert(stream
->ustream
);
2321 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2324 int lttng_ustconsumer_get_sequence_number(
2325 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2328 assert(stream
->ustream
);
2331 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2335 * Called when the stream signals the consumer that it has hung up.
2337 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2340 assert(stream
->ustream
);
2342 pthread_mutex_lock(&stream
->lock
);
2343 if (!stream
->quiescent
) {
2344 ustctl_flush_buffer(stream
->ustream
, 0);
2345 stream
->quiescent
= true;
2347 pthread_mutex_unlock(&stream
->lock
);
2348 stream
->hangup_flush_done
= 1;
2351 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2356 assert(chan
->uchan
);
2357 assert(chan
->buffer_credentials
.is_set
);
2359 if (chan
->switch_timer_enabled
== 1) {
2360 consumer_timer_switch_stop(chan
);
2362 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2365 ret
= close(chan
->stream_fds
[i
]);
2369 if (chan
->shm_path
[0]) {
2370 char shm_path
[PATH_MAX
];
2372 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2374 ERR("Cannot get stream shm path");
2376 ret
= run_as_unlink(shm_path
,
2377 chan
->buffer_credentials
.value
.uid
,
2378 chan
->buffer_credentials
.value
.gid
);
2380 PERROR("unlink %s", shm_path
);
2386 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2389 assert(chan
->uchan
);
2390 assert(chan
->buffer_credentials
.is_set
);
2392 consumer_metadata_cache_destroy(chan
);
2393 ustctl_destroy_channel(chan
->uchan
);
2394 /* Try to rmdir all directories under shm_path root. */
2395 if (chan
->root_shm_path
[0]) {
2396 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2397 chan
->buffer_credentials
.value
.uid
,
2398 chan
->buffer_credentials
.value
.gid
,
2399 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG
);
2401 free(chan
->stream_fds
);
2404 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2407 assert(stream
->ustream
);
2409 if (stream
->chan
->switch_timer_enabled
== 1) {
2410 consumer_timer_switch_stop(stream
->chan
);
2412 ustctl_destroy_stream(stream
->ustream
);
2415 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2418 assert(stream
->ustream
);
2420 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2423 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2426 assert(stream
->ustream
);
2428 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2432 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
)
2434 DBG("Reset metadata cache of session %" PRIu64
,
2435 stream
->chan
->session_id
);
2436 stream
->ust_metadata_pushed
= 0;
2437 stream
->metadata_version
= stream
->chan
->metadata_cache
->version
;
2438 stream
->reset_metadata_flag
= 1;
2442 * Write up to one packet from the metadata cache to the channel.
2444 * Returns the number of bytes pushed in the cache, or a negative value
2448 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2453 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2454 if (stream
->chan
->metadata_cache
->max_offset
2455 == stream
->ust_metadata_pushed
) {
2460 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2461 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2462 stream
->chan
->metadata_cache
->max_offset
2463 - stream
->ust_metadata_pushed
);
2464 assert(write_len
!= 0);
2465 if (write_len
< 0) {
2466 ERR("Writing one metadata packet");
2470 stream
->ust_metadata_pushed
+= write_len
;
2472 assert(stream
->chan
->metadata_cache
->max_offset
>=
2473 stream
->ust_metadata_pushed
);
2477 * Switch packet (but don't open the next one) on every commit of
2478 * a metadata packet. Since the subbuffer is fully filled (with padding,
2479 * if needed), the stream is "quiescent" after this commit.
2481 ustctl_flush_buffer(stream
->ustream
, 1);
2482 stream
->quiescent
= true;
2484 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2490 * Sync metadata meaning request them to the session daemon and snapshot to the
2491 * metadata thread can consumer them.
2493 * Metadata stream lock is held here, but we need to release it when
2494 * interacting with sessiond, else we cause a deadlock with live
2495 * awaiting on metadata to be pushed out.
2497 * The RCU read side lock must be held by the caller.
2499 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2500 * is empty or a negative value on error.
2502 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2503 struct lttng_consumer_stream
*metadata_stream
)
2507 struct lttng_consumer_channel
*metadata_channel
;
2510 assert(metadata_stream
);
2512 metadata_channel
= metadata_stream
->chan
;
2513 pthread_mutex_unlock(&metadata_stream
->lock
);
2515 * Request metadata from the sessiond, but don't wait for the flush
2516 * because we locked the metadata thread.
2518 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 0);
2519 pthread_mutex_lock(&metadata_stream
->lock
);
2525 * The metadata stream and channel can be deleted while the
2526 * metadata stream lock was released. The streamed is checked
2527 * for deletion before we use it further.
2529 * Note that it is safe to access a logically-deleted stream since its
2530 * existence is still guaranteed by the RCU read side lock. However,
2531 * it should no longer be used. The close/deletion of the metadata
2532 * channel and stream already guarantees that all metadata has been
2533 * consumed. Therefore, there is nothing left to do in this function.
2535 if (consumer_stream_is_deleted(metadata_stream
)) {
2536 DBG("Metadata stream %" PRIu64
" was deleted during the metadata synchronization",
2537 metadata_stream
->key
);
2542 ret
= commit_one_metadata_packet(metadata_stream
);
2545 } else if (ret
> 0) {
2549 ret
= ustctl_snapshot(metadata_stream
->ustream
);
2551 if (errno
!= EAGAIN
) {
2552 ERR("Sync metadata, taking UST snapshot");
2555 DBG("No new metadata when syncing them.");
2556 /* No new metadata, exit. */
2562 * After this flush, we still need to extract metadata.
2573 * Return 0 on success else a negative value.
2575 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2576 struct lttng_consumer_local_data
*ctx
)
2579 struct ustctl_consumer_stream
*ustream
;
2584 ustream
= stream
->ustream
;
2587 * First, we are going to check if there is a new subbuffer available
2588 * before reading the stream wait_fd.
2590 /* Get the next subbuffer */
2591 ret
= ustctl_get_next_subbuf(ustream
);
2593 /* No more data found, flag the stream. */
2594 stream
->has_data
= 0;
2599 ret
= ustctl_put_subbuf(ustream
);
2602 /* This stream still has data. Flag it and wake up the data thread. */
2603 stream
->has_data
= 1;
2605 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2608 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2609 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2614 /* The wake up pipe has been notified. */
2615 ctx
->has_wakeup
= 1;
2623 static int consumer_stream_ust_on_wake_up(struct lttng_consumer_stream
*stream
)
2628 * We can consume the 1 byte written into the wait_fd by
2629 * UST. Don't trigger error if we cannot read this one byte
2630 * (read returns 0), or if the error is EAGAIN or EWOULDBLOCK.
2632 * This is only done when the stream is monitored by a thread,
2633 * before the flush is done after a hangup and if the stream
2634 * is not flagged with data since there might be nothing to
2635 * consume in the wait fd but still have data available
2636 * flagged by the consumer wake up pipe.
2638 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2642 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2643 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2651 static int extract_common_subbuffer_info(struct lttng_consumer_stream
*stream
,
2652 struct stream_subbuffer
*subbuf
)
2656 ret
= ustctl_get_subbuf_size(
2657 stream
->ustream
, &subbuf
->info
.data
.subbuf_size
);
2662 ret
= ustctl_get_padded_subbuf_size(
2663 stream
->ustream
, &subbuf
->info
.data
.padded_subbuf_size
);
2672 static int extract_metadata_subbuffer_info(struct lttng_consumer_stream
*stream
,
2673 struct stream_subbuffer
*subbuf
)
2677 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2682 subbuf
->info
.metadata
.version
= stream
->chan
->metadata_cache
->version
;
2688 static int extract_data_subbuffer_info(struct lttng_consumer_stream
*stream
,
2689 struct stream_subbuffer
*subbuf
)
2693 ret
= extract_common_subbuffer_info(stream
, subbuf
);
2698 ret
= ustctl_get_packet_size(
2699 stream
->ustream
, &subbuf
->info
.data
.packet_size
);
2701 PERROR("Failed to get sub-buffer packet size");
2705 ret
= ustctl_get_content_size(
2706 stream
->ustream
, &subbuf
->info
.data
.content_size
);
2708 PERROR("Failed to get sub-buffer content size");
2712 ret
= ustctl_get_timestamp_begin(
2713 stream
->ustream
, &subbuf
->info
.data
.timestamp_begin
);
2715 PERROR("Failed to get sub-buffer begin timestamp");
2719 ret
= ustctl_get_timestamp_end(
2720 stream
->ustream
, &subbuf
->info
.data
.timestamp_end
);
2722 PERROR("Failed to get sub-buffer end timestamp");
2726 ret
= ustctl_get_events_discarded(
2727 stream
->ustream
, &subbuf
->info
.data
.events_discarded
);
2729 PERROR("Failed to get sub-buffer events discarded count");
2733 ret
= ustctl_get_sequence_number(stream
->ustream
,
2734 &subbuf
->info
.data
.sequence_number
.value
);
2736 /* May not be supported by older LTTng-modules. */
2737 if (ret
!= -ENOTTY
) {
2738 PERROR("Failed to get sub-buffer sequence number");
2742 subbuf
->info
.data
.sequence_number
.is_set
= true;
2745 ret
= ustctl_get_stream_id(
2746 stream
->ustream
, &subbuf
->info
.data
.stream_id
);
2748 PERROR("Failed to get stream id");
2752 ret
= ustctl_get_instance_id(stream
->ustream
,
2753 &subbuf
->info
.data
.stream_instance_id
.value
);
2755 /* May not be supported by older LTTng-modules. */
2756 if (ret
!= -ENOTTY
) {
2757 PERROR("Failed to get stream instance id");
2761 subbuf
->info
.data
.stream_instance_id
.is_set
= true;
2767 static int get_next_subbuffer_common(struct lttng_consumer_stream
*stream
,
2768 struct stream_subbuffer
*subbuffer
)
2773 ret
= stream
->read_subbuffer_ops
.extract_subbuffer_info(
2779 ret
= get_current_subbuf_addr(stream
, &addr
);
2784 subbuffer
->buffer
.buffer
= lttng_buffer_view_init(
2785 addr
, 0, subbuffer
->info
.data
.padded_subbuf_size
);
2786 assert(subbuffer
->buffer
.buffer
.data
!= NULL
);
2791 static int get_next_subbuffer(struct lttng_consumer_stream
*stream
,
2792 struct stream_subbuffer
*subbuffer
)
2796 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2801 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2809 static int get_next_subbuffer_metadata(struct lttng_consumer_stream
*stream
,
2810 struct stream_subbuffer
*subbuffer
)
2814 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2816 ret
= commit_one_metadata_packet(stream
);
2819 } else if (ret
== 0) {
2820 /* Not an error, the cache is empty. */
2825 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2831 ret
= get_next_subbuffer_common(stream
, subbuffer
);
2839 static int put_next_subbuffer(struct lttng_consumer_stream
*stream
,
2840 struct stream_subbuffer
*subbuffer
)
2842 const int ret
= ustctl_put_next_subbuf(stream
->ustream
);
2848 static int signal_metadata(struct lttng_consumer_stream
*stream
,
2849 struct lttng_consumer_local_data
*ctx
)
2851 return pthread_cond_broadcast(&stream
->metadata_rdv
) ? -errno
: 0;
2854 static void lttng_ustconsumer_set_stream_ops(
2855 struct lttng_consumer_stream
*stream
)
2857 stream
->read_subbuffer_ops
.on_wake_up
= consumer_stream_ust_on_wake_up
;
2858 if (stream
->metadata_flag
) {
2859 stream
->read_subbuffer_ops
.get_next_subbuffer
=
2860 get_next_subbuffer_metadata
;
2861 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
2862 extract_metadata_subbuffer_info
;
2863 stream
->read_subbuffer_ops
.reset_metadata
=
2864 metadata_stream_reset_cache
;
2865 stream
->read_subbuffer_ops
.on_sleep
= signal_metadata
;
2867 stream
->read_subbuffer_ops
.get_next_subbuffer
=
2869 stream
->read_subbuffer_ops
.extract_subbuffer_info
=
2870 extract_data_subbuffer_info
;
2871 stream
->read_subbuffer_ops
.on_sleep
= notify_if_more_data
;
2872 if (stream
->chan
->is_live
) {
2873 stream
->read_subbuffer_ops
.send_live_beacon
=
2874 consumer_flush_ust_index
;
2878 stream
->read_subbuffer_ops
.put_next_subbuffer
= put_next_subbuffer
;
2882 * Called when a stream is created.
2884 * Return 0 on success or else a negative value.
2886 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2893 * Don't create anything if this is set for streaming or if there is
2894 * no current trace chunk on the parent channel.
2896 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
&&
2897 stream
->chan
->trace_chunk
) {
2898 ret
= consumer_stream_create_output_files(stream
, true);
2904 lttng_ustconsumer_set_stream_ops(stream
);
2912 * Check if data is still being extracted from the buffers for a specific
2913 * stream. Consumer data lock MUST be acquired before calling this function
2914 * and the stream lock.
2916 * Return 1 if the traced data are still getting read else 0 meaning that the
2917 * data is available for trace viewer reading.
2919 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2924 assert(stream
->ustream
);
2926 DBG("UST consumer checking data pending");
2928 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2933 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2934 uint64_t contiguous
, pushed
;
2936 /* Ease our life a bit. */
2937 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2938 pushed
= stream
->ust_metadata_pushed
;
2941 * We can simply check whether all contiguously available data
2942 * has been pushed to the ring buffer, since the push operation
2943 * is performed within get_next_subbuf(), and because both
2944 * get_next_subbuf() and put_next_subbuf() are issued atomically
2945 * thanks to the stream lock within
2946 * lttng_ustconsumer_read_subbuffer(). This basically means that
2947 * whetnever ust_metadata_pushed is incremented, the associated
2948 * metadata has been consumed from the metadata stream.
2950 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2951 contiguous
, pushed
);
2952 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2953 if ((contiguous
!= pushed
) ||
2954 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2955 ret
= 1; /* Data is pending */
2959 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2962 * There is still data so let's put back this
2965 ret
= ustctl_put_subbuf(stream
->ustream
);
2967 ret
= 1; /* Data is pending */
2972 /* Data is NOT pending so ready to be read. */
2980 * Stop a given metadata channel timer if enabled and close the wait fd which
2981 * is the poll pipe of the metadata stream.
2983 * This MUST be called with the metadata channel lock acquired.
2985 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2990 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2992 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2994 if (metadata
->switch_timer_enabled
== 1) {
2995 consumer_timer_switch_stop(metadata
);
2998 if (!metadata
->metadata_stream
) {
3003 * Closing write side so the thread monitoring the stream wakes up if any
3004 * and clean the metadata stream.
3006 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
3007 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
3009 PERROR("closing metadata pipe write side");
3011 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3019 * Close every metadata stream wait fd of the metadata hash table. This
3020 * function MUST be used very carefully so not to run into a race between the
3021 * metadata thread handling streams and this function closing their wait fd.
3023 * For UST, this is used when the session daemon hangs up. Its the metadata
3024 * producer so calling this is safe because we are assured that no state change
3025 * can occur in the metadata thread for the streams in the hash table.
3027 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3029 struct lttng_ht_iter iter
;
3030 struct lttng_consumer_stream
*stream
;
3032 assert(metadata_ht
);
3033 assert(metadata_ht
->ht
);
3035 DBG("UST consumer closing all metadata streams");
3038 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3041 health_code_update();
3043 pthread_mutex_lock(&stream
->chan
->lock
);
3044 lttng_ustconsumer_close_metadata(stream
->chan
);
3045 pthread_mutex_unlock(&stream
->chan
->lock
);
3051 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3055 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
3057 ERR("Unable to close wakeup fd");
3062 * Please refer to consumer-timer.c before adding any lock within this
3063 * function or any of its callees. Timers have a very strict locking
3064 * semantic with respect to teardown. Failure to respect this semantic
3065 * introduces deadlocks.
3067 * DON'T hold the metadata lock when calling this function, else this
3068 * can cause deadlock involving consumer awaiting for metadata to be
3069 * pushed out due to concurrent interaction with the session daemon.
3071 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3072 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3074 struct lttcomm_metadata_request_msg request
;
3075 struct lttcomm_consumer_msg msg
;
3076 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3077 uint64_t len
, key
, offset
, version
;
3081 assert(channel
->metadata_cache
);
3083 memset(&request
, 0, sizeof(request
));
3085 /* send the metadata request to sessiond */
3086 switch (consumer_data
.type
) {
3087 case LTTNG_CONSUMER64_UST
:
3088 request
.bits_per_long
= 64;
3090 case LTTNG_CONSUMER32_UST
:
3091 request
.bits_per_long
= 32;
3094 request
.bits_per_long
= 0;
3098 request
.session_id
= channel
->session_id
;
3099 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3101 * Request the application UID here so the metadata of that application can
3102 * be sent back. The channel UID corresponds to the user UID of the session
3103 * used for the rights on the stream file(s).
3105 request
.uid
= channel
->ust_app_uid
;
3106 request
.key
= channel
->key
;
3108 DBG("Sending metadata request to sessiond, session id %" PRIu64
3109 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3110 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3113 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3115 health_code_update();
3117 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3120 ERR("Asking metadata to sessiond");
3124 health_code_update();
3126 /* Receive the metadata from sessiond */
3127 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3129 if (ret
!= sizeof(msg
)) {
3130 DBG("Consumer received unexpected message size %d (expects %zu)",
3132 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3134 * The ret value might 0 meaning an orderly shutdown but this is ok
3135 * since the caller handles this.
3140 health_code_update();
3142 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3143 /* No registry found */
3144 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3148 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3149 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3154 len
= msg
.u
.push_metadata
.len
;
3155 key
= msg
.u
.push_metadata
.key
;
3156 offset
= msg
.u
.push_metadata
.target_offset
;
3157 version
= msg
.u
.push_metadata
.version
;
3159 assert(key
== channel
->key
);
3161 DBG("No new metadata to receive for key %" PRIu64
, key
);
3164 health_code_update();
3166 /* Tell session daemon we are ready to receive the metadata. */
3167 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3168 LTTCOMM_CONSUMERD_SUCCESS
);
3169 if (ret
< 0 || len
== 0) {
3171 * Somehow, the session daemon is not responding anymore or there is
3172 * nothing to receive.
3177 health_code_update();
3179 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3180 key
, offset
, len
, version
, channel
, timer
, wait
);
3183 * Only send the status msg if the sessiond is alive meaning a positive
3186 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3191 health_code_update();
3193 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3198 * Return the ustctl call for the get stream id.
3200 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3201 uint64_t *stream_id
)
3206 return ustctl_get_stream_id(stream
->ustream
, stream_id
);