2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <lttng/ust-ctl.h>
27 #include <sys/socket.h>
29 #include <sys/types.h>
32 #include <urcu/list.h>
35 #include <bin/lttng-consumerd/health-consumerd.h>
36 #include <common/common.h>
37 #include <common/sessiond-comm/sessiond-comm.h>
38 #include <common/relayd/relayd.h>
39 #include <common/compat/fcntl.h>
40 #include <common/compat/endian.h>
41 #include <common/consumer/consumer-metadata-cache.h>
42 #include <common/consumer/consumer-stream.h>
43 #include <common/consumer/consumer-timer.h>
44 #include <common/utils.h>
45 #include <common/index/index.h>
47 #include "ust-consumer.h"
49 #define INT_MAX_STR_LEN 12 /* includes \0 */
51 extern struct lttng_consumer_global_data consumer_data
;
52 extern int consumer_poll_timeout
;
53 extern volatile int consumer_quit
;
56 * Free channel object and all streams associated with it. This MUST be used
57 * only and only if the channel has _NEVER_ been added to the global channel
60 static void destroy_channel(struct lttng_consumer_channel
*channel
)
62 struct lttng_consumer_stream
*stream
, *stmp
;
66 DBG("UST consumer cleaning stream list");
68 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
73 cds_list_del(&stream
->send_node
);
74 ustctl_destroy_stream(stream
->ustream
);
79 * If a channel is available meaning that was created before the streams
83 lttng_ustconsumer_del_channel(channel
);
84 lttng_ustconsumer_free_channel(channel
);
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 channel object.
124 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
125 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
126 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
127 uint64_t tracefile_size
, uint64_t tracefile_count
,
128 uint64_t session_id_per_pid
, unsigned int monitor
,
129 unsigned int live_timer_interval
,
130 const char *root_shm_path
, const char *shm_path
)
135 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
136 gid
, relayd_id
, output
, tracefile_size
,
137 tracefile_count
, session_id_per_pid
, monitor
,
138 live_timer_interval
, root_shm_path
, shm_path
);
142 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
143 * error value if applicable is set in it else it is kept untouched.
145 * Return NULL on error else the newly allocated stream object.
147 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
148 struct lttng_consumer_channel
*channel
,
149 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
152 struct lttng_consumer_stream
*stream
= NULL
;
157 stream
= consumer_allocate_stream(channel
->key
,
159 LTTNG_CONSUMER_ACTIVE_STREAM
,
169 if (stream
== NULL
) {
173 * We could not find the channel. Can happen if cpu hotplug
174 * happens while tearing down.
176 DBG3("Could not find channel");
181 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
187 stream
->chan
= channel
;
191 *_alloc_ret
= alloc_ret
;
197 * Send the given stream pointer to the corresponding thread.
199 * Returns 0 on success else a negative value.
201 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
202 struct lttng_consumer_local_data
*ctx
)
205 struct lttng_pipe
*stream_pipe
;
207 /* Get the right pipe where the stream will be sent. */
208 if (stream
->metadata_flag
) {
209 ret
= consumer_add_metadata_stream(stream
);
211 ERR("Consumer add metadata stream %" PRIu64
" failed.",
215 stream_pipe
= ctx
->consumer_metadata_pipe
;
217 ret
= consumer_add_data_stream(stream
);
219 ERR("Consumer add stream %" PRIu64
" failed.",
223 stream_pipe
= ctx
->consumer_data_pipe
;
227 * From this point on, the stream's ownership has been moved away from
228 * the channel and becomes globally visible.
230 stream
->globally_visible
= 1;
232 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
234 ERR("Consumer write %s stream to pipe %d",
235 stream
->metadata_flag
? "metadata" : "data",
236 lttng_pipe_get_writefd(stream_pipe
));
237 if (stream
->metadata_flag
) {
238 consumer_del_stream_for_metadata(stream
);
240 consumer_del_stream_for_data(stream
);
248 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
250 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
253 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
254 stream_shm_path
[PATH_MAX
- 1] = '\0';
255 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
260 strncat(stream_shm_path
, cpu_nr
,
261 PATH_MAX
- strlen(stream_shm_path
) - 1);
268 * Create streams for the given channel using liblttng-ust-ctl.
270 * Return 0 on success else a negative value.
272 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
273 struct lttng_consumer_local_data
*ctx
)
276 struct ustctl_consumer_stream
*ustream
;
277 struct lttng_consumer_stream
*stream
;
283 * While a stream is available from ustctl. When NULL is returned, we've
284 * reached the end of the possible stream for the channel.
286 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
288 int ust_metadata_pipe
[2];
290 health_code_update();
292 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
293 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
295 ERR("Create ust metadata poll pipe");
298 wait_fd
= ust_metadata_pipe
[0];
300 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
303 /* Allocate consumer stream object. */
304 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
308 stream
->ustream
= ustream
;
310 * Store it so we can save multiple function calls afterwards since
311 * this value is used heavily in the stream threads. This is UST
312 * specific so this is why it's done after allocation.
314 stream
->wait_fd
= wait_fd
;
317 * Increment channel refcount since the channel reference has now been
318 * assigned in the allocation process above.
320 if (stream
->chan
->monitor
) {
321 uatomic_inc(&stream
->chan
->refcount
);
325 * Order is important this is why a list is used. On error, the caller
326 * should clean this list.
328 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
330 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
331 &stream
->max_sb_size
);
333 ERR("ustctl_get_max_subbuf_size failed for stream %s",
338 /* Do actions once stream has been received. */
339 if (ctx
->on_recv_stream
) {
340 ret
= ctx
->on_recv_stream(stream
);
346 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
347 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
349 /* Set next CPU stream. */
350 channel
->streams
.count
= ++cpu
;
352 /* Keep stream reference when creating metadata. */
353 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
354 channel
->metadata_stream
= stream
;
355 if (channel
->monitor
) {
356 /* Set metadata poll pipe if we created one */
357 memcpy(stream
->ust_metadata_poll_pipe
,
359 sizeof(ust_metadata_pipe
));
372 * create_posix_shm is never called concurrently within a process.
375 int create_posix_shm(void)
377 char tmp_name
[NAME_MAX
];
380 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
386 * Allocate shm, and immediately unlink its shm oject, keeping
387 * only the file descriptor as a reference to the object.
388 * We specifically do _not_ use the / at the beginning of the
389 * pathname so that some OS implementations can keep it local to
390 * the process (POSIX leaves this implementation-defined).
392 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
397 ret
= shm_unlink(tmp_name
);
398 if (ret
< 0 && errno
!= ENOENT
) {
399 PERROR("shm_unlink");
400 goto error_shm_release
;
413 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
,
414 struct ustctl_consumer_channel_attr
*attr
,
417 char shm_path
[PATH_MAX
];
420 if (!channel
->shm_path
[0]) {
421 return create_posix_shm();
423 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
427 return run_as_open(shm_path
,
428 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
429 channel
->uid
, channel
->gid
);
436 * Create an UST channel with the given attributes and send it to the session
437 * daemon using the ust ctl API.
439 * Return 0 on success or else a negative value.
441 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
442 struct ustctl_consumer_channel_attr
*attr
,
443 struct ustctl_consumer_channel
**ust_chanp
)
445 int ret
, nr_stream_fds
, i
, j
;
447 struct ustctl_consumer_channel
*ust_channel
;
453 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
454 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
455 "switch_timer_interval: %u, read_timer_interval: %u, "
456 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
457 attr
->num_subbuf
, attr
->switch_timer_interval
,
458 attr
->read_timer_interval
, attr
->output
, attr
->type
);
460 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
463 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
464 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
469 for (i
= 0; i
< nr_stream_fds
; i
++) {
470 stream_fds
[i
] = open_ust_stream_fd(channel
, attr
, i
);
471 if (stream_fds
[i
] < 0) {
476 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
481 channel
->nr_stream_fds
= nr_stream_fds
;
482 channel
->stream_fds
= stream_fds
;
483 *ust_chanp
= ust_channel
;
489 for (j
= i
- 1; j
>= 0; j
--) {
492 closeret
= close(stream_fds
[j
]);
496 if (channel
->shm_path
[0]) {
497 char shm_path
[PATH_MAX
];
499 closeret
= get_stream_shm_path(shm_path
,
500 channel
->shm_path
, j
);
502 ERR("Cannot get stream shm path");
504 closeret
= run_as_unlink(shm_path
,
505 channel
->uid
, channel
->gid
);
507 PERROR("unlink %s", shm_path
);
511 /* Try to rmdir all directories under shm_path root. */
512 if (channel
->root_shm_path
[0]) {
513 (void) run_as_recursive_rmdir(channel
->root_shm_path
,
514 channel
->uid
, channel
->gid
);
522 * Send a single given stream to the session daemon using the sock.
524 * Return 0 on success else a negative value.
526 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
533 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
535 /* Send stream to session daemon. */
536 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
546 * Send channel to sessiond.
548 * Return 0 on success or else a negative value.
550 static int send_sessiond_channel(int sock
,
551 struct lttng_consumer_channel
*channel
,
552 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
554 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
555 struct lttng_consumer_stream
*stream
;
556 uint64_t net_seq_idx
= -1ULL;
562 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
564 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
565 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
567 health_code_update();
569 /* Try to send the stream to the relayd if one is available. */
570 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
573 * Flag that the relayd was the problem here probably due to a
574 * communicaton error on the socket.
579 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
581 if (net_seq_idx
== -1ULL) {
582 net_seq_idx
= stream
->net_seq_idx
;
587 /* Inform sessiond that we are about to send channel and streams. */
588 ret
= consumer_send_status_msg(sock
, ret_code
);
589 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
591 * Either the session daemon is not responding or the relayd died so we
597 /* Send channel to sessiond. */
598 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
603 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
608 /* The channel was sent successfully to the sessiond at this point. */
609 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
611 health_code_update();
613 /* Send stream to session daemon. */
614 ret
= send_sessiond_stream(sock
, stream
);
620 /* Tell sessiond there is no more stream. */
621 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
626 DBG("UST consumer NULL stream sent to sessiond");
631 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
638 * Creates a channel and streams and add the channel it to the channel internal
639 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
642 * Return 0 on success or else, a negative value is returned and the channel
643 * MUST be destroyed by consumer_del_channel().
645 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
646 struct lttng_consumer_channel
*channel
,
647 struct ustctl_consumer_channel_attr
*attr
)
656 * This value is still used by the kernel consumer since for the kernel,
657 * the stream ownership is not IN the consumer so we need to have the
658 * number of left stream that needs to be initialized so we can know when
659 * to delete the channel (see consumer.c).
661 * As for the user space tracer now, the consumer creates and sends the
662 * stream to the session daemon which only sends them to the application
663 * once every stream of a channel is received making this value useless
664 * because we they will be added to the poll thread before the application
665 * receives them. This ensures that a stream can not hang up during
666 * initilization of a channel.
668 channel
->nb_init_stream_left
= 0;
670 /* The reply msg status is handled in the following call. */
671 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
676 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
679 * For the snapshots (no monitor), we create the metadata streams
680 * on demand, not during the channel creation.
682 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
687 /* Open all streams for this channel. */
688 ret
= create_ust_streams(channel
, ctx
);
698 * Send all stream of a channel to the right thread handling it.
700 * On error, return a negative value else 0 on success.
702 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
703 struct lttng_consumer_local_data
*ctx
)
706 struct lttng_consumer_stream
*stream
, *stmp
;
711 /* Send streams to the corresponding thread. */
712 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
715 health_code_update();
717 /* Sending the stream to the thread. */
718 ret
= send_stream_to_thread(stream
, ctx
);
721 * If we are unable to send the stream to the thread, there is
722 * a big problem so just stop everything.
724 /* Remove node from the channel stream list. */
725 cds_list_del(&stream
->send_node
);
729 /* Remove node from the channel stream list. */
730 cds_list_del(&stream
->send_node
);
739 * Flush channel's streams using the given key to retrieve the channel.
741 * Return 0 on success else an LTTng error code.
743 static int flush_channel(uint64_t chan_key
)
746 struct lttng_consumer_channel
*channel
;
747 struct lttng_consumer_stream
*stream
;
749 struct lttng_ht_iter iter
;
751 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
754 channel
= consumer_find_channel(chan_key
);
756 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
757 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
761 ht
= consumer_data
.stream_per_chan_id_ht
;
763 /* For each stream of the channel id, flush it. */
764 cds_lfht_for_each_entry_duplicate(ht
->ht
,
765 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
766 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
768 health_code_update();
770 ustctl_flush_buffer(stream
->ustream
, 1);
778 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
779 * RCU read side lock MUST be acquired before calling this function.
781 * Return 0 on success else an LTTng error code.
783 static int close_metadata(uint64_t chan_key
)
786 struct lttng_consumer_channel
*channel
;
788 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
790 channel
= consumer_find_channel(chan_key
);
793 * This is possible if the metadata thread has issue a delete because
794 * the endpoint point of the stream hung up. There is no way the
795 * session daemon can know about it thus use a DBG instead of an actual
798 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
799 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
803 pthread_mutex_lock(&consumer_data
.lock
);
804 pthread_mutex_lock(&channel
->lock
);
806 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
810 lttng_ustconsumer_close_metadata(channel
);
813 pthread_mutex_unlock(&channel
->lock
);
814 pthread_mutex_unlock(&consumer_data
.lock
);
820 * RCU read side lock MUST be acquired before calling this function.
822 * Return 0 on success else an LTTng error code.
824 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
827 struct lttng_consumer_channel
*metadata
;
829 DBG("UST consumer setup metadata key %" PRIu64
, key
);
831 metadata
= consumer_find_channel(key
);
833 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
834 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
839 * In no monitor mode, the metadata channel has no stream(s) so skip the
840 * ownership transfer to the metadata thread.
842 if (!metadata
->monitor
) {
843 DBG("Metadata channel in no monitor");
849 * Send metadata stream to relayd if one available. Availability is
850 * known if the stream is still in the list of the channel.
852 if (cds_list_empty(&metadata
->streams
.head
)) {
853 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
854 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
855 goto error_no_stream
;
858 /* Send metadata stream to relayd if needed. */
859 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
860 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
863 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
866 ret
= consumer_send_relayd_streams_sent(
867 metadata
->metadata_stream
->net_seq_idx
);
869 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
874 ret
= send_streams_to_thread(metadata
, ctx
);
877 * If we are unable to send the stream to the thread, there is
878 * a big problem so just stop everything.
880 ret
= LTTCOMM_CONSUMERD_FATAL
;
883 /* List MUST be empty after or else it could be reused. */
884 assert(cds_list_empty(&metadata
->streams
.head
));
891 * Delete metadata channel on error. At this point, the metadata stream can
892 * NOT be monitored by the metadata thread thus having the guarantee that
893 * the stream is still in the local stream list of the channel. This call
894 * will make sure to clean that list.
896 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
897 cds_list_del(&metadata
->metadata_stream
->send_node
);
898 metadata
->metadata_stream
= NULL
;
905 * Snapshot the whole metadata.
907 * Returns 0 on success, < 0 on error
909 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
910 struct lttng_consumer_local_data
*ctx
)
913 struct lttng_consumer_channel
*metadata_channel
;
914 struct lttng_consumer_stream
*metadata_stream
;
919 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
924 metadata_channel
= consumer_find_channel(key
);
925 if (!metadata_channel
) {
926 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
931 assert(!metadata_channel
->monitor
);
933 health_code_update();
936 * Ask the sessiond if we have new metadata waiting and update the
937 * consumer metadata cache.
939 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
944 health_code_update();
947 * The metadata stream is NOT created in no monitor mode when the channel
948 * is created on a sessiond ask channel command.
950 ret
= create_ust_streams(metadata_channel
, ctx
);
955 metadata_stream
= metadata_channel
->metadata_stream
;
956 assert(metadata_stream
);
958 if (relayd_id
!= (uint64_t) -1ULL) {
959 metadata_stream
->net_seq_idx
= relayd_id
;
960 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
965 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
966 metadata_stream
->chan
->tracefile_size
,
967 metadata_stream
->tracefile_count_current
,
968 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
972 metadata_stream
->out_fd
= ret
;
973 metadata_stream
->tracefile_size_current
= 0;
977 health_code_update();
979 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
987 * Clean up the stream completly because the next snapshot will use a new
990 consumer_stream_destroy(metadata_stream
, NULL
);
991 cds_list_del(&metadata_stream
->send_node
);
992 metadata_channel
->metadata_stream
= NULL
;
1000 * Take a snapshot of all the stream of a channel.
1002 * Returns 0 on success, < 0 on error
1004 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
1005 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
1008 unsigned use_relayd
= 0;
1009 unsigned long consumed_pos
, produced_pos
;
1010 struct lttng_consumer_channel
*channel
;
1011 struct lttng_consumer_stream
*stream
;
1018 if (relayd_id
!= (uint64_t) -1ULL) {
1022 channel
= consumer_find_channel(key
);
1024 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
1028 assert(!channel
->monitor
);
1029 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1031 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1032 /* Are we at a position _before_ the first available packet ? */
1033 bool before_first_packet
= true;
1035 health_code_update();
1037 /* Lock stream because we are about to change its state. */
1038 pthread_mutex_lock(&stream
->lock
);
1039 stream
->net_seq_idx
= relayd_id
;
1042 ret
= consumer_send_relayd_stream(stream
, path
);
1047 ret
= utils_create_stream_file(path
, stream
->name
,
1048 stream
->chan
->tracefile_size
,
1049 stream
->tracefile_count_current
,
1050 stream
->uid
, stream
->gid
, NULL
);
1054 stream
->out_fd
= ret
;
1055 stream
->tracefile_size_current
= 0;
1057 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
1058 stream
->name
, stream
->key
);
1060 if (relayd_id
!= -1ULL) {
1061 ret
= consumer_send_relayd_streams_sent(relayd_id
);
1067 ustctl_flush_buffer(stream
->ustream
, 1);
1069 ret
= lttng_ustconsumer_take_snapshot(stream
);
1071 ERR("Taking UST snapshot");
1075 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1077 ERR("Produced UST snapshot position");
1081 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1083 ERR("Consumerd UST snapshot position");
1088 * The original value is sent back if max stream size is larger than
1089 * the possible size of the snapshot. Also, we assume that the session
1090 * daemon should never send a maximum stream size that is lower than
1093 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1094 produced_pos
, nb_packets_per_stream
,
1095 stream
->max_sb_size
);
1097 while (consumed_pos
< produced_pos
) {
1099 unsigned long len
, padded_len
;
1100 int lost_packet
= 0;
1102 health_code_update();
1104 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1106 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1108 if (ret
!= -EAGAIN
) {
1109 PERROR("ustctl_get_subbuf snapshot");
1110 goto error_close_stream
;
1112 DBG("UST consumer get subbuf failed. Skipping it.");
1113 consumed_pos
+= stream
->max_sb_size
;
1116 * Start accounting lost packets only when we
1117 * already have extracted packets (to match the
1118 * content of the final snapshot).
1120 if (!before_first_packet
) {
1126 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1128 ERR("Snapshot ustctl_get_subbuf_size");
1129 goto error_put_subbuf
;
1132 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1134 ERR("Snapshot ustctl_get_padded_subbuf_size");
1135 goto error_put_subbuf
;
1138 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1139 padded_len
- len
, NULL
);
1141 if (read_len
!= len
) {
1143 goto error_put_subbuf
;
1146 if (read_len
!= padded_len
) {
1148 goto error_put_subbuf
;
1152 ret
= ustctl_put_subbuf(stream
->ustream
);
1154 ERR("Snapshot ustctl_put_subbuf");
1155 goto error_close_stream
;
1157 consumed_pos
+= stream
->max_sb_size
;
1160 * Only account lost packets located between
1161 * succesfully extracted packets (do not account before
1162 * and after since they are not visible in the
1163 * resulting snapshot).
1165 stream
->chan
->lost_packets
+= lost_packet
;
1167 before_first_packet
= false;
1170 /* Simply close the stream so we can use it on the next snapshot. */
1171 consumer_stream_close(stream
);
1172 pthread_mutex_unlock(&stream
->lock
);
1179 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1180 ERR("Snapshot ustctl_put_subbuf");
1183 consumer_stream_close(stream
);
1185 pthread_mutex_unlock(&stream
->lock
);
1192 * Receive the metadata updates from the sessiond. Supports receiving
1193 * overlapping metadata, but is needs to always belong to a contiguous
1194 * range starting from 0.
1195 * Be careful about the locks held when calling this function: it needs
1196 * the metadata cache flush to concurrently progress in order to
1199 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1200 uint64_t len
, struct lttng_consumer_channel
*channel
,
1201 int timer
, int wait
)
1203 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1206 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1208 metadata_str
= zmalloc(len
* sizeof(char));
1209 if (!metadata_str
) {
1210 PERROR("zmalloc metadata string");
1211 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1215 health_code_update();
1217 /* Receive metadata string. */
1218 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1220 /* Session daemon is dead so return gracefully. */
1225 health_code_update();
1227 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1228 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1230 /* Unable to handle metadata. Notify session daemon. */
1231 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1233 * Skip metadata flush on write error since the offset and len might
1234 * not have been updated which could create an infinite loop below when
1235 * waiting for the metadata cache to be flushed.
1237 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1240 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1245 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1246 DBG("Waiting for metadata to be flushed");
1248 health_code_update();
1250 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1260 * Receive command from session daemon and process it.
1262 * Return 1 on success else a negative value or 0.
1264 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1265 int sock
, struct pollfd
*consumer_sockpoll
)
1268 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1269 struct lttcomm_consumer_msg msg
;
1270 struct lttng_consumer_channel
*channel
= NULL
;
1272 health_code_update();
1274 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1275 if (ret
!= sizeof(msg
)) {
1276 DBG("Consumer received unexpected message size %zd (expects %zu)",
1279 * The ret value might 0 meaning an orderly shutdown but this is ok
1280 * since the caller handles this.
1283 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1289 health_code_update();
1292 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1294 health_code_update();
1296 /* relayd needs RCU read-side lock */
1299 switch (msg
.cmd_type
) {
1300 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1302 /* Session daemon status message are handled in the following call. */
1303 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1304 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1305 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1306 msg
.u
.relayd_sock
.relayd_session_id
);
1309 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1311 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1312 struct consumer_relayd_sock_pair
*relayd
;
1314 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1316 /* Get relayd reference if exists. */
1317 relayd
= consumer_find_relayd(index
);
1318 if (relayd
== NULL
) {
1319 DBG("Unable to find relayd %" PRIu64
, index
);
1320 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1324 * Each relayd socket pair has a refcount of stream attached to it
1325 * which tells if the relayd is still active or not depending on the
1328 * This will set the destroy flag of the relayd object and destroy it
1329 * if the refcount reaches zero when called.
1331 * The destroy can happen either here or when a stream fd hangs up.
1334 consumer_flag_relayd_for_destroy(relayd
);
1337 goto end_msg_sessiond
;
1339 case LTTNG_CONSUMER_UPDATE_STREAM
:
1344 case LTTNG_CONSUMER_DATA_PENDING
:
1346 int ret
, is_data_pending
;
1347 uint64_t id
= msg
.u
.data_pending
.session_id
;
1349 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1351 is_data_pending
= consumer_data_pending(id
);
1353 /* Send back returned value to session daemon */
1354 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1355 sizeof(is_data_pending
));
1357 DBG("Error when sending the data pending ret code: %d", ret
);
1362 * No need to send back a status message since the data pending
1363 * returned value is the response.
1367 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1370 struct ustctl_consumer_channel_attr attr
;
1372 /* Create a plain object and reserve a channel key. */
1373 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1374 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1375 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1376 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1377 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1378 msg
.u
.ask_channel
.tracefile_size
,
1379 msg
.u
.ask_channel
.tracefile_count
,
1380 msg
.u
.ask_channel
.session_id_per_pid
,
1381 msg
.u
.ask_channel
.monitor
,
1382 msg
.u
.ask_channel
.live_timer_interval
,
1383 msg
.u
.ask_channel
.root_shm_path
,
1384 msg
.u
.ask_channel
.shm_path
);
1386 goto end_channel_error
;
1390 * Assign UST application UID to the channel. This value is ignored for
1391 * per PID buffers. This is specific to UST thus setting this after the
1394 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1396 /* Build channel attributes from received message. */
1397 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1398 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1399 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1400 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1401 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1402 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1403 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1405 /* Match channel buffer type to the UST abi. */
1406 switch (msg
.u
.ask_channel
.output
) {
1407 case LTTNG_EVENT_MMAP
:
1409 attr
.output
= LTTNG_UST_MMAP
;
1413 /* Translate and save channel type. */
1414 switch (msg
.u
.ask_channel
.type
) {
1415 case LTTNG_UST_CHAN_PER_CPU
:
1416 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1417 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1419 * Set refcount to 1 for owner. Below, we will
1420 * pass ownership to the
1421 * consumer_thread_channel_poll() thread.
1423 channel
->refcount
= 1;
1425 case LTTNG_UST_CHAN_METADATA
:
1426 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1427 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1434 health_code_update();
1436 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1438 goto end_channel_error
;
1441 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1442 ret
= consumer_metadata_cache_allocate(channel
);
1444 ERR("Allocating metadata cache");
1445 goto end_channel_error
;
1447 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1448 attr
.switch_timer_interval
= 0;
1450 consumer_timer_live_start(channel
,
1451 msg
.u
.ask_channel
.live_timer_interval
);
1454 health_code_update();
1457 * Add the channel to the internal state AFTER all streams were created
1458 * and successfully sent to session daemon. This way, all streams must
1459 * be ready before this channel is visible to the threads.
1460 * If add_channel succeeds, ownership of the channel is
1461 * passed to consumer_thread_channel_poll().
1463 ret
= add_channel(channel
, ctx
);
1465 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1466 if (channel
->switch_timer_enabled
== 1) {
1467 consumer_timer_switch_stop(channel
);
1469 consumer_metadata_cache_destroy(channel
);
1471 if (channel
->live_timer_enabled
== 1) {
1472 consumer_timer_live_stop(channel
);
1474 goto end_channel_error
;
1477 health_code_update();
1480 * Channel and streams are now created. Inform the session daemon that
1481 * everything went well and should wait to receive the channel and
1482 * streams with ustctl API.
1484 ret
= consumer_send_status_channel(sock
, channel
);
1487 * There is probably a problem on the socket.
1494 case LTTNG_CONSUMER_GET_CHANNEL
:
1496 int ret
, relayd_err
= 0;
1497 uint64_t key
= msg
.u
.get_channel
.key
;
1498 struct lttng_consumer_channel
*channel
;
1500 channel
= consumer_find_channel(key
);
1502 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1503 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1504 goto end_msg_sessiond
;
1507 health_code_update();
1509 /* Send everything to sessiond. */
1510 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1514 * We were unable to send to the relayd the stream so avoid
1515 * sending back a fatal error to the thread since this is OK
1516 * and the consumer can continue its work. The above call
1517 * has sent the error status message to the sessiond.
1522 * The communicaton was broken hence there is a bad state between
1523 * the consumer and sessiond so stop everything.
1528 health_code_update();
1531 * In no monitor mode, the streams ownership is kept inside the channel
1532 * so don't send them to the data thread.
1534 if (!channel
->monitor
) {
1535 goto end_msg_sessiond
;
1538 ret
= send_streams_to_thread(channel
, ctx
);
1541 * If we are unable to send the stream to the thread, there is
1542 * a big problem so just stop everything.
1546 /* List MUST be empty after or else it could be reused. */
1547 assert(cds_list_empty(&channel
->streams
.head
));
1548 goto end_msg_sessiond
;
1550 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1552 uint64_t key
= msg
.u
.destroy_channel
.key
;
1555 * Only called if streams have not been sent to stream
1556 * manager thread. However, channel has been sent to
1557 * channel manager thread.
1559 notify_thread_del_channel(ctx
, key
);
1560 goto end_msg_sessiond
;
1562 case LTTNG_CONSUMER_CLOSE_METADATA
:
1566 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1571 goto end_msg_sessiond
;
1573 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1577 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1582 goto end_msg_sessiond
;
1584 case LTTNG_CONSUMER_PUSH_METADATA
:
1587 uint64_t len
= msg
.u
.push_metadata
.len
;
1588 uint64_t key
= msg
.u
.push_metadata
.key
;
1589 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1590 struct lttng_consumer_channel
*channel
;
1592 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1595 channel
= consumer_find_channel(key
);
1598 * This is possible if the metadata creation on the consumer side
1599 * is in flight vis-a-vis a concurrent push metadata from the
1600 * session daemon. Simply return that the channel failed and the
1601 * session daemon will handle that message correctly considering
1602 * that this race is acceptable thus the DBG() statement here.
1604 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1605 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1606 goto end_msg_sessiond
;
1609 health_code_update();
1613 * There is nothing to receive. We have simply
1614 * checked whether the channel can be found.
1616 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1617 goto end_msg_sessiond
;
1620 /* Tell session daemon we are ready to receive the metadata. */
1621 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1623 /* Somehow, the session daemon is not responding anymore. */
1627 health_code_update();
1629 /* Wait for more data. */
1630 health_poll_entry();
1631 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1637 health_code_update();
1639 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1640 len
, channel
, 0, 1);
1642 /* error receiving from sessiond */
1646 goto end_msg_sessiond
;
1649 case LTTNG_CONSUMER_SETUP_METADATA
:
1653 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1657 goto end_msg_sessiond
;
1659 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1661 if (msg
.u
.snapshot_channel
.metadata
) {
1662 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1663 msg
.u
.snapshot_channel
.pathname
,
1664 msg
.u
.snapshot_channel
.relayd_id
,
1667 ERR("Snapshot metadata failed");
1668 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1671 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1672 msg
.u
.snapshot_channel
.pathname
,
1673 msg
.u
.snapshot_channel
.relayd_id
,
1674 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1677 ERR("Snapshot channel failed");
1678 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1682 health_code_update();
1683 ret
= consumer_send_status_msg(sock
, ret_code
);
1685 /* Somehow, the session daemon is not responding anymore. */
1688 health_code_update();
1691 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1694 struct lttng_ht_iter iter
;
1695 struct lttng_ht
*ht
;
1696 struct lttng_consumer_stream
*stream
;
1697 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1698 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1700 DBG("UST consumer discarded events command for session id %"
1703 pthread_mutex_lock(&consumer_data
.lock
);
1705 ht
= consumer_data
.stream_list_ht
;
1708 * We only need a reference to the channel, but they are not
1709 * directly indexed, so we just use the first matching stream
1710 * to extract the information we need, we default to 0 if not
1711 * found (no events are dropped if the channel is not yet in
1715 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1716 ht
->hash_fct(&id
, lttng_ht_seed
),
1718 &iter
.iter
, stream
, node_session_id
.node
) {
1719 if (stream
->chan
->key
== key
) {
1720 ret
= stream
->chan
->discarded_events
;
1724 pthread_mutex_unlock(&consumer_data
.lock
);
1727 DBG("UST consumer discarded events command for session id %"
1728 PRIu64
", channel key %" PRIu64
, id
, key
);
1730 health_code_update();
1732 /* Send back returned value to session daemon */
1733 ret
= lttcomm_send_unix_sock(sock
, &ret
, sizeof(ret
));
1735 PERROR("send discarded events");
1741 case LTTNG_CONSUMER_LOST_PACKETS
:
1744 uint64_t lost_packets
;
1745 struct lttng_ht_iter iter
;
1746 struct lttng_ht
*ht
;
1747 struct lttng_consumer_stream
*stream
;
1748 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1749 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1751 DBG("UST consumer lost packets command for session id %"
1754 pthread_mutex_lock(&consumer_data
.lock
);
1756 ht
= consumer_data
.stream_list_ht
;
1759 * We only need a reference to the channel, but they are not
1760 * directly indexed, so we just use the first matching stream
1761 * to extract the information we need, we default to 0 if not
1762 * found (no packets lost if the channel is not yet in use).
1765 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1766 ht
->hash_fct(&id
, lttng_ht_seed
),
1768 &iter
.iter
, stream
, node_session_id
.node
) {
1769 if (stream
->chan
->key
== key
) {
1770 lost_packets
= stream
->chan
->lost_packets
;
1774 pthread_mutex_unlock(&consumer_data
.lock
);
1777 DBG("UST consumer lost packets command for session id %"
1778 PRIu64
", channel key %" PRIu64
, id
, key
);
1780 health_code_update();
1782 /* Send back returned value to session daemon */
1783 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1784 sizeof(lost_packets
));
1786 PERROR("send lost packets");
1799 health_code_update();
1802 * Return 1 to indicate success since the 0 value can be a socket
1803 * shutdown during the recv() or send() call.
1809 * The returned value here is not useful since either way we'll return 1 to
1810 * the caller because the session daemon socket management is done
1811 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1813 ret
= consumer_send_status_msg(sock
, ret_code
);
1819 health_code_update();
1825 * Free channel here since no one has a reference to it. We don't
1826 * free after that because a stream can store this pointer.
1828 destroy_channel(channel
);
1830 /* We have to send a status channel message indicating an error. */
1831 ret
= consumer_send_status_channel(sock
, NULL
);
1833 /* Stop everything if session daemon can not be notified. */
1838 health_code_update();
1843 /* This will issue a consumer stop. */
1848 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1849 * compiled out, we isolate it in this library.
1851 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1855 assert(stream
->ustream
);
1857 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1861 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1862 * compiled out, we isolate it in this library.
1864 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1867 assert(stream
->ustream
);
1869 return ustctl_get_mmap_base(stream
->ustream
);
1873 * Take a snapshot for a specific fd
1875 * Returns 0 on success, < 0 on error
1877 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1880 assert(stream
->ustream
);
1882 return ustctl_snapshot(stream
->ustream
);
1886 * Get the produced position
1888 * Returns 0 on success, < 0 on error
1890 int lttng_ustconsumer_get_produced_snapshot(
1891 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1894 assert(stream
->ustream
);
1897 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1901 * Get the consumed position
1903 * Returns 0 on success, < 0 on error
1905 int lttng_ustconsumer_get_consumed_snapshot(
1906 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1909 assert(stream
->ustream
);
1912 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1915 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1919 assert(stream
->ustream
);
1921 ustctl_flush_buffer(stream
->ustream
, producer
);
1924 int lttng_ustconsumer_get_current_timestamp(
1925 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1928 assert(stream
->ustream
);
1931 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1934 int lttng_ustconsumer_get_sequence_number(
1935 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
1938 assert(stream
->ustream
);
1941 return ustctl_get_sequence_number(stream
->ustream
, seq
);
1945 * Called when the stream signal the consumer that it has hang up.
1947 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1950 assert(stream
->ustream
);
1952 ustctl_flush_buffer(stream
->ustream
, 0);
1953 stream
->hangup_flush_done
= 1;
1956 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1961 assert(chan
->uchan
);
1963 if (chan
->switch_timer_enabled
== 1) {
1964 consumer_timer_switch_stop(chan
);
1966 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
1969 ret
= close(chan
->stream_fds
[i
]);
1973 if (chan
->shm_path
[0]) {
1974 char shm_path
[PATH_MAX
];
1976 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
1978 ERR("Cannot get stream shm path");
1980 ret
= run_as_unlink(shm_path
, chan
->uid
, chan
->gid
);
1982 PERROR("unlink %s", shm_path
);
1986 /* Try to rmdir all directories under shm_path root. */
1987 if (chan
->root_shm_path
[0]) {
1988 (void) run_as_recursive_rmdir(chan
->root_shm_path
,
1989 chan
->uid
, chan
->gid
);
1993 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
1996 assert(chan
->uchan
);
1998 consumer_metadata_cache_destroy(chan
);
1999 ustctl_destroy_channel(chan
->uchan
);
2000 free(chan
->stream_fds
);
2003 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2006 assert(stream
->ustream
);
2008 if (stream
->chan
->switch_timer_enabled
== 1) {
2009 consumer_timer_switch_stop(stream
->chan
);
2011 ustctl_destroy_stream(stream
->ustream
);
2014 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2017 assert(stream
->ustream
);
2019 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2022 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2025 assert(stream
->ustream
);
2027 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2031 * Populate index values of a UST stream. Values are set in big endian order.
2033 * Return 0 on success or else a negative value.
2035 static int get_index_values(struct ctf_packet_index
*index
,
2036 struct ustctl_consumer_stream
*ustream
)
2040 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2042 PERROR("ustctl_get_timestamp_begin");
2045 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2047 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2049 PERROR("ustctl_get_timestamp_end");
2052 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2054 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2056 PERROR("ustctl_get_events_discarded");
2059 index
->events_discarded
= htobe64(index
->events_discarded
);
2061 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2063 PERROR("ustctl_get_content_size");
2066 index
->content_size
= htobe64(index
->content_size
);
2068 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2070 PERROR("ustctl_get_packet_size");
2073 index
->packet_size
= htobe64(index
->packet_size
);
2075 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2077 PERROR("ustctl_get_stream_id");
2080 index
->stream_id
= htobe64(index
->stream_id
);
2082 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2084 PERROR("ustctl_get_instance_id");
2087 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2089 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2091 PERROR("ustctl_get_sequence_number");
2094 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2101 * Write up to one packet from the metadata cache to the channel.
2103 * Returns the number of bytes pushed in the cache, or a negative value
2107 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2112 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2113 if (stream
->chan
->metadata_cache
->max_offset
2114 == stream
->ust_metadata_pushed
) {
2119 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2120 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2121 stream
->chan
->metadata_cache
->max_offset
2122 - stream
->ust_metadata_pushed
);
2123 assert(write_len
!= 0);
2124 if (write_len
< 0) {
2125 ERR("Writing one metadata packet");
2129 stream
->ust_metadata_pushed
+= write_len
;
2131 assert(stream
->chan
->metadata_cache
->max_offset
>=
2132 stream
->ust_metadata_pushed
);
2136 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2142 * Sync metadata meaning request them to the session daemon and snapshot to the
2143 * metadata thread can consumer them.
2145 * Metadata stream lock is held here, but we need to release it when
2146 * interacting with sessiond, else we cause a deadlock with live
2147 * awaiting on metadata to be pushed out.
2149 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2150 * is empty or a negative value on error.
2152 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2153 struct lttng_consumer_stream
*metadata
)
2161 pthread_mutex_unlock(&metadata
->lock
);
2163 * Request metadata from the sessiond, but don't wait for the flush
2164 * because we locked the metadata thread.
2166 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2170 pthread_mutex_lock(&metadata
->lock
);
2172 ret
= commit_one_metadata_packet(metadata
);
2175 } else if (ret
> 0) {
2179 ustctl_flush_buffer(metadata
->ustream
, 1);
2180 ret
= ustctl_snapshot(metadata
->ustream
);
2182 if (errno
!= EAGAIN
) {
2183 ERR("Sync metadata, taking UST snapshot");
2186 DBG("No new metadata when syncing them.");
2187 /* No new metadata, exit. */
2193 * After this flush, we still need to extract metadata.
2204 * Return 0 on success else a negative value.
2206 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2207 struct lttng_consumer_local_data
*ctx
)
2210 struct ustctl_consumer_stream
*ustream
;
2215 ustream
= stream
->ustream
;
2218 * First, we are going to check if there is a new subbuffer available
2219 * before reading the stream wait_fd.
2221 /* Get the next subbuffer */
2222 ret
= ustctl_get_next_subbuf(ustream
);
2224 /* No more data found, flag the stream. */
2225 stream
->has_data
= 0;
2230 ret
= ustctl_put_subbuf(ustream
);
2233 /* This stream still has data. Flag it and wake up the data thread. */
2234 stream
->has_data
= 1;
2236 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2239 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2240 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2245 /* The wake up pipe has been notified. */
2246 ctx
->has_wakeup
= 1;
2255 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2258 uint64_t seq
, discarded
;
2260 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2262 PERROR("ustctl_get_sequence_number");
2266 * Start the sequence when we extract the first packet in case we don't
2267 * start at 0 (for example if a consumer is not connected to the
2268 * session immediately after the beginning).
2270 if (stream
->last_sequence_number
== -1ULL) {
2271 stream
->last_sequence_number
= seq
;
2272 } else if (seq
> stream
->last_sequence_number
) {
2273 stream
->chan
->lost_packets
+= seq
-
2274 stream
->last_sequence_number
- 1;
2276 /* seq <= last_sequence_number */
2277 ERR("Sequence number inconsistent : prev = %" PRIu64
2278 ", current = %" PRIu64
,
2279 stream
->last_sequence_number
, seq
);
2283 stream
->last_sequence_number
= seq
;
2285 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2287 PERROR("kernctl_get_events_discarded");
2290 if (discarded
< stream
->last_discarded_events
) {
2292 * Overflow has occured. We assume only one wrap-around
2295 stream
->chan
->discarded_events
+=
2296 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2297 stream
->last_discarded_events
+ discarded
;
2299 stream
->chan
->discarded_events
+= discarded
-
2300 stream
->last_discarded_events
;
2302 stream
->last_discarded_events
= discarded
;
2310 * Read subbuffer from the given stream.
2312 * Stream lock MUST be acquired.
2314 * Return 0 on success else a negative value.
2316 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2317 struct lttng_consumer_local_data
*ctx
)
2319 unsigned long len
, subbuf_size
, padding
;
2320 int err
, write_index
= 1;
2322 struct ustctl_consumer_stream
*ustream
;
2323 struct ctf_packet_index index
;
2326 assert(stream
->ustream
);
2329 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2332 /* Ease our life for what's next. */
2333 ustream
= stream
->ustream
;
2336 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2337 * error if we cannot read this one byte (read returns 0), or if the error
2338 * is EAGAIN or EWOULDBLOCK.
2340 * This is only done when the stream is monitored by a thread, before the
2341 * flush is done after a hangup and if the stream is not flagged with data
2342 * since there might be nothing to consume in the wait fd but still have
2343 * data available flagged by the consumer wake up pipe.
2345 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2349 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2350 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2357 /* Get the next subbuffer */
2358 err
= ustctl_get_next_subbuf(ustream
);
2361 * Populate metadata info if the existing info has
2362 * already been read.
2364 if (stream
->metadata_flag
) {
2365 ret
= commit_one_metadata_packet(stream
);
2369 ustctl_flush_buffer(stream
->ustream
, 1);
2373 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2375 * This is a debug message even for single-threaded consumer,
2376 * because poll() have more relaxed criterions than get subbuf,
2377 * so get_subbuf may fail for short race windows where poll()
2378 * would issue wakeups.
2380 DBG("Reserving sub buffer failed (everything is normal, "
2381 "it is due to concurrency) [ret: %d]", err
);
2384 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2386 if (!stream
->metadata_flag
) {
2387 index
.offset
= htobe64(stream
->out_fd_offset
);
2388 ret
= get_index_values(&index
, ustream
);
2393 /* Update the stream's sequence and discarded events count. */
2394 ret
= update_stream_stats(stream
);
2396 PERROR("kernctl_get_events_discarded");
2403 /* Get the full padded subbuffer size */
2404 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2407 /* Get subbuffer data size (without padding) */
2408 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2411 /* Make sure we don't get a subbuffer size bigger than the padded */
2412 assert(len
>= subbuf_size
);
2414 padding
= len
- subbuf_size
;
2415 /* write the subbuffer to the tracefile */
2416 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2418 * The mmap operation should write subbuf_size amount of data when network
2419 * streaming or the full padding (len) size when we are _not_ streaming.
2421 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2422 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2424 * Display the error but continue processing to try to release the
2425 * subbuffer. This is a DBG statement since any unexpected kill or
2426 * signal, the application gets unregistered, relayd gets closed or
2427 * anything that affects the buffer lifetime will trigger this error.
2428 * So, for the sake of the user, don't print this error since it can
2429 * happen and it is OK with the code flow.
2431 DBG("Error writing to tracefile "
2432 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2433 ret
, len
, subbuf_size
);
2436 err
= ustctl_put_next_subbuf(ustream
);
2440 * This will consumer the byte on the wait_fd if and only if there is not
2441 * next subbuffer to be acquired.
2443 if (!stream
->metadata_flag
) {
2444 ret
= notify_if_more_data(stream
, ctx
);
2450 /* Write index if needed. */
2455 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2457 * In live, block until all the metadata is sent.
2459 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2460 assert(!stream
->missed_metadata_flush
);
2461 stream
->waiting_on_metadata
= true;
2462 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2464 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2466 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2467 stream
->waiting_on_metadata
= false;
2468 if (stream
->missed_metadata_flush
) {
2469 stream
->missed_metadata_flush
= false;
2470 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2471 (void) consumer_flush_ust_index(stream
);
2473 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2481 assert(!stream
->metadata_flag
);
2482 err
= consumer_stream_write_index(stream
, &index
);
2492 * Called when a stream is created.
2494 * Return 0 on success or else a negative value.
2496 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2502 /* Don't create anything if this is set for streaming. */
2503 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2504 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2505 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2506 stream
->uid
, stream
->gid
, NULL
);
2510 stream
->out_fd
= ret
;
2511 stream
->tracefile_size_current
= 0;
2513 if (!stream
->metadata_flag
) {
2514 ret
= index_create_file(stream
->chan
->pathname
,
2515 stream
->name
, stream
->uid
, stream
->gid
,
2516 stream
->chan
->tracefile_size
,
2517 stream
->tracefile_count_current
);
2521 stream
->index_fd
= ret
;
2531 * Check if data is still being extracted from the buffers for a specific
2532 * stream. Consumer data lock MUST be acquired before calling this function
2533 * and the stream lock.
2535 * Return 1 if the traced data are still getting read else 0 meaning that the
2536 * data is available for trace viewer reading.
2538 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2543 assert(stream
->ustream
);
2545 DBG("UST consumer checking data pending");
2547 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2552 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2553 uint64_t contiguous
, pushed
;
2555 /* Ease our life a bit. */
2556 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2557 pushed
= stream
->ust_metadata_pushed
;
2560 * We can simply check whether all contiguously available data
2561 * has been pushed to the ring buffer, since the push operation
2562 * is performed within get_next_subbuf(), and because both
2563 * get_next_subbuf() and put_next_subbuf() are issued atomically
2564 * thanks to the stream lock within
2565 * lttng_ustconsumer_read_subbuffer(). This basically means that
2566 * whetnever ust_metadata_pushed is incremented, the associated
2567 * metadata has been consumed from the metadata stream.
2569 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2570 contiguous
, pushed
);
2571 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2572 if ((contiguous
!= pushed
) ||
2573 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2574 ret
= 1; /* Data is pending */
2578 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2581 * There is still data so let's put back this
2584 ret
= ustctl_put_subbuf(stream
->ustream
);
2586 ret
= 1; /* Data is pending */
2591 /* Data is NOT pending so ready to be read. */
2599 * Stop a given metadata channel timer if enabled and close the wait fd which
2600 * is the poll pipe of the metadata stream.
2602 * This MUST be called with the metadata channel acquired.
2604 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2609 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2611 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2613 if (metadata
->switch_timer_enabled
== 1) {
2614 consumer_timer_switch_stop(metadata
);
2617 if (!metadata
->metadata_stream
) {
2622 * Closing write side so the thread monitoring the stream wakes up if any
2623 * and clean the metadata stream.
2625 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2626 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2628 PERROR("closing metadata pipe write side");
2630 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2638 * Close every metadata stream wait fd of the metadata hash table. This
2639 * function MUST be used very carefully so not to run into a race between the
2640 * metadata thread handling streams and this function closing their wait fd.
2642 * For UST, this is used when the session daemon hangs up. Its the metadata
2643 * producer so calling this is safe because we are assured that no state change
2644 * can occur in the metadata thread for the streams in the hash table.
2646 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2648 struct lttng_ht_iter iter
;
2649 struct lttng_consumer_stream
*stream
;
2651 assert(metadata_ht
);
2652 assert(metadata_ht
->ht
);
2654 DBG("UST consumer closing all metadata streams");
2657 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2660 health_code_update();
2662 pthread_mutex_lock(&stream
->chan
->lock
);
2663 lttng_ustconsumer_close_metadata(stream
->chan
);
2664 pthread_mutex_unlock(&stream
->chan
->lock
);
2670 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2674 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2676 ERR("Unable to close wakeup fd");
2681 * Please refer to consumer-timer.c before adding any lock within this
2682 * function or any of its callees. Timers have a very strict locking
2683 * semantic with respect to teardown. Failure to respect this semantic
2684 * introduces deadlocks.
2686 * DON'T hold the metadata lock when calling this function, else this
2687 * can cause deadlock involving consumer awaiting for metadata to be
2688 * pushed out due to concurrent interaction with the session daemon.
2690 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2691 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2693 struct lttcomm_metadata_request_msg request
;
2694 struct lttcomm_consumer_msg msg
;
2695 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2696 uint64_t len
, key
, offset
;
2700 assert(channel
->metadata_cache
);
2702 memset(&request
, 0, sizeof(request
));
2704 /* send the metadata request to sessiond */
2705 switch (consumer_data
.type
) {
2706 case LTTNG_CONSUMER64_UST
:
2707 request
.bits_per_long
= 64;
2709 case LTTNG_CONSUMER32_UST
:
2710 request
.bits_per_long
= 32;
2713 request
.bits_per_long
= 0;
2717 request
.session_id
= channel
->session_id
;
2718 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2720 * Request the application UID here so the metadata of that application can
2721 * be sent back. The channel UID corresponds to the user UID of the session
2722 * used for the rights on the stream file(s).
2724 request
.uid
= channel
->ust_app_uid
;
2725 request
.key
= channel
->key
;
2727 DBG("Sending metadata request to sessiond, session id %" PRIu64
2728 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2729 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2732 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2734 health_code_update();
2736 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2739 ERR("Asking metadata to sessiond");
2743 health_code_update();
2745 /* Receive the metadata from sessiond */
2746 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2748 if (ret
!= sizeof(msg
)) {
2749 DBG("Consumer received unexpected message size %d (expects %zu)",
2751 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2753 * The ret value might 0 meaning an orderly shutdown but this is ok
2754 * since the caller handles this.
2759 health_code_update();
2761 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2762 /* No registry found */
2763 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2767 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2768 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2773 len
= msg
.u
.push_metadata
.len
;
2774 key
= msg
.u
.push_metadata
.key
;
2775 offset
= msg
.u
.push_metadata
.target_offset
;
2777 assert(key
== channel
->key
);
2779 DBG("No new metadata to receive for key %" PRIu64
, key
);
2782 health_code_update();
2784 /* Tell session daemon we are ready to receive the metadata. */
2785 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2786 LTTCOMM_CONSUMERD_SUCCESS
);
2787 if (ret
< 0 || len
== 0) {
2789 * Somehow, the session daemon is not responding anymore or there is
2790 * nothing to receive.
2795 health_code_update();
2797 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2798 key
, offset
, len
, channel
, timer
, wait
);
2801 * Only send the status msg if the sessiond is alive meaning a positive
2804 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2809 health_code_update();
2811 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2816 * Return the ustctl call for the get stream id.
2818 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2819 uint64_t *stream_id
)
2824 return ustctl_get_stream_id(stream
->ustream
, stream_id
);