2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <lttng/ust-ctl.h>
28 #include <sys/socket.h>
30 #include <sys/types.h>
33 #include <urcu/list.h>
36 #include <bin/lttng-consumerd/health-consumerd.h>
37 #include <common/common.h>
38 #include <common/sessiond-comm/sessiond-comm.h>
39 #include <common/relayd/relayd.h>
40 #include <common/compat/fcntl.h>
41 #include <common/compat/endian.h>
42 #include <common/consumer/consumer-metadata-cache.h>
43 #include <common/consumer/consumer-stream.h>
44 #include <common/consumer/consumer-timer.h>
45 #include <common/utils.h>
46 #include <common/index/index.h>
48 #include "ust-consumer.h"
50 #define INT_MAX_STR_LEN 12 /* includes \0 */
52 extern struct lttng_consumer_global_data consumer_data
;
53 extern int consumer_poll_timeout
;
54 extern volatile int consumer_quit
;
57 * Free channel object and all streams associated with it. This MUST be used
58 * only and only if the channel has _NEVER_ been added to the global channel
61 static void destroy_channel(struct lttng_consumer_channel
*channel
)
63 struct lttng_consumer_stream
*stream
, *stmp
;
67 DBG("UST consumer cleaning stream list");
69 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
74 cds_list_del(&stream
->send_node
);
75 ustctl_destroy_stream(stream
->ustream
);
80 * If a channel is available meaning that was created before the streams
84 lttng_ustconsumer_del_channel(channel
);
85 lttng_ustconsumer_free_channel(channel
);
91 * Add channel to internal consumer state.
93 * Returns 0 on success or else a negative value.
95 static int add_channel(struct lttng_consumer_channel
*channel
,
96 struct lttng_consumer_local_data
*ctx
)
103 if (ctx
->on_recv_channel
!= NULL
) {
104 ret
= ctx
->on_recv_channel(channel
);
106 ret
= consumer_add_channel(channel
, ctx
);
107 } else if (ret
< 0) {
108 /* Most likely an ENOMEM. */
109 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
113 ret
= consumer_add_channel(channel
, ctx
);
116 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
123 * Allocate and return a consumer channel object.
125 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
126 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
127 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
128 uint64_t tracefile_size
, uint64_t tracefile_count
,
129 uint64_t session_id_per_pid
, unsigned int monitor
,
130 unsigned int live_timer_interval
,
131 const char *root_shm_path
, const char *shm_path
)
136 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
137 gid
, relayd_id
, output
, tracefile_size
,
138 tracefile_count
, session_id_per_pid
, monitor
,
139 live_timer_interval
, root_shm_path
, shm_path
);
143 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
144 * error value if applicable is set in it else it is kept untouched.
146 * Return NULL on error else the newly allocated stream object.
148 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
149 struct lttng_consumer_channel
*channel
,
150 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
153 struct lttng_consumer_stream
*stream
= NULL
;
158 stream
= consumer_allocate_stream(channel
->key
,
160 LTTNG_CONSUMER_ACTIVE_STREAM
,
170 if (stream
== NULL
) {
174 * We could not find the channel. Can happen if cpu hotplug
175 * happens while tearing down.
177 DBG3("Could not find channel");
182 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
188 stream
->chan
= channel
;
192 *_alloc_ret
= alloc_ret
;
198 * Send the given stream pointer to the corresponding thread.
200 * Returns 0 on success else a negative value.
202 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
203 struct lttng_consumer_local_data
*ctx
)
206 struct lttng_pipe
*stream_pipe
;
208 /* Get the right pipe where the stream will be sent. */
209 if (stream
->metadata_flag
) {
210 ret
= consumer_add_metadata_stream(stream
);
212 ERR("Consumer add metadata stream %" PRIu64
" failed.",
216 stream_pipe
= ctx
->consumer_metadata_pipe
;
218 ret
= consumer_add_data_stream(stream
);
220 ERR("Consumer add stream %" PRIu64
" failed.",
224 stream_pipe
= ctx
->consumer_data_pipe
;
228 * From this point on, the stream's ownership has been moved away from
229 * the channel and becomes globally visible.
231 stream
->globally_visible
= 1;
233 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
235 ERR("Consumer write %s stream to pipe %d",
236 stream
->metadata_flag
? "metadata" : "data",
237 lttng_pipe_get_writefd(stream_pipe
));
238 if (stream
->metadata_flag
) {
239 consumer_del_stream_for_metadata(stream
);
241 consumer_del_stream_for_data(stream
);
249 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
251 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
254 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
255 stream_shm_path
[PATH_MAX
- 1] = '\0';
256 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
261 strncat(stream_shm_path
, cpu_nr
,
262 PATH_MAX
- strlen(stream_shm_path
) - 1);
269 * Create streams for the given channel using liblttng-ust-ctl.
271 * Return 0 on success else a negative value.
273 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
274 struct lttng_consumer_local_data
*ctx
)
277 struct ustctl_consumer_stream
*ustream
;
278 struct lttng_consumer_stream
*stream
;
284 * While a stream is available from ustctl. When NULL is returned, we've
285 * reached the end of the possible stream for the channel.
287 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
289 int ust_metadata_pipe
[2];
291 health_code_update();
293 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
294 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
296 ERR("Create ust metadata poll pipe");
299 wait_fd
= ust_metadata_pipe
[0];
301 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
304 /* Allocate consumer stream object. */
305 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
309 stream
->ustream
= ustream
;
311 * Store it so we can save multiple function calls afterwards since
312 * this value is used heavily in the stream threads. This is UST
313 * specific so this is why it's done after allocation.
315 stream
->wait_fd
= wait_fd
;
318 * Increment channel refcount since the channel reference has now been
319 * assigned in the allocation process above.
321 if (stream
->chan
->monitor
) {
322 uatomic_inc(&stream
->chan
->refcount
);
326 * Order is important this is why a list is used. On error, the caller
327 * should clean this list.
329 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
331 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
332 &stream
->max_sb_size
);
334 ERR("ustctl_get_max_subbuf_size failed for stream %s",
339 /* Do actions once stream has been received. */
340 if (ctx
->on_recv_stream
) {
341 ret
= ctx
->on_recv_stream(stream
);
347 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
348 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
350 /* Set next CPU stream. */
351 channel
->streams
.count
= ++cpu
;
353 /* Keep stream reference when creating metadata. */
354 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
355 channel
->metadata_stream
= stream
;
356 if (channel
->monitor
) {
357 /* Set metadata poll pipe if we created one */
358 memcpy(stream
->ust_metadata_poll_pipe
,
360 sizeof(ust_metadata_pipe
));
373 * create_posix_shm is never called concurrently within a process.
376 int create_posix_shm(void)
378 char tmp_name
[NAME_MAX
];
381 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
387 * Allocate shm, and immediately unlink its shm oject, keeping
388 * only the file descriptor as a reference to the object.
389 * We specifically do _not_ use the / at the beginning of the
390 * pathname so that some OS implementations can keep it local to
391 * the process (POSIX leaves this implementation-defined).
393 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
398 ret
= shm_unlink(tmp_name
);
399 if (ret
< 0 && errno
!= ENOENT
) {
400 PERROR("shm_unlink");
401 goto error_shm_release
;
414 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
,
415 struct ustctl_consumer_channel_attr
*attr
,
418 char shm_path
[PATH_MAX
];
421 if (!channel
->shm_path
[0]) {
422 return create_posix_shm();
424 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
428 return run_as_open(shm_path
,
429 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
430 channel
->uid
, channel
->gid
);
437 * Create an UST channel with the given attributes and send it to the session
438 * daemon using the ust ctl API.
440 * Return 0 on success or else a negative value.
442 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
443 struct ustctl_consumer_channel_attr
*attr
,
444 struct ustctl_consumer_channel
**ust_chanp
)
446 int ret
, nr_stream_fds
, i
, j
;
448 struct ustctl_consumer_channel
*ust_channel
;
454 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
455 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
456 "switch_timer_interval: %u, read_timer_interval: %u, "
457 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
458 attr
->num_subbuf
, attr
->switch_timer_interval
,
459 attr
->read_timer_interval
, attr
->output
, attr
->type
);
461 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
464 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
465 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
470 for (i
= 0; i
< nr_stream_fds
; i
++) {
471 stream_fds
[i
] = open_ust_stream_fd(channel
, attr
, i
);
472 if (stream_fds
[i
] < 0) {
477 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
482 channel
->nr_stream_fds
= nr_stream_fds
;
483 channel
->stream_fds
= stream_fds
;
484 *ust_chanp
= ust_channel
;
490 for (j
= i
- 1; j
>= 0; j
--) {
493 closeret
= close(stream_fds
[j
]);
497 if (channel
->shm_path
[0]) {
498 char shm_path
[PATH_MAX
];
500 closeret
= get_stream_shm_path(shm_path
,
501 channel
->shm_path
, j
);
503 ERR("Cannot get stream shm path");
505 closeret
= run_as_unlink(shm_path
,
506 channel
->uid
, channel
->gid
);
508 PERROR("unlink %s", shm_path
);
512 /* Try to rmdir all directories under shm_path root. */
513 if (channel
->root_shm_path
[0]) {
514 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
515 channel
->uid
, channel
->gid
);
523 * Send a single given stream to the session daemon using the sock.
525 * Return 0 on success else a negative value.
527 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
534 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
536 /* Send stream to session daemon. */
537 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
547 * Send channel to sessiond.
549 * Return 0 on success or else a negative value.
551 static int send_sessiond_channel(int sock
,
552 struct lttng_consumer_channel
*channel
,
553 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
555 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
556 struct lttng_consumer_stream
*stream
;
557 uint64_t net_seq_idx
= -1ULL;
563 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
565 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
566 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
568 health_code_update();
570 /* Try to send the stream to the relayd if one is available. */
571 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
574 * Flag that the relayd was the problem here probably due to a
575 * communicaton error on the socket.
580 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
582 if (net_seq_idx
== -1ULL) {
583 net_seq_idx
= stream
->net_seq_idx
;
588 /* Inform sessiond that we are about to send channel and streams. */
589 ret
= consumer_send_status_msg(sock
, ret_code
);
590 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
592 * Either the session daemon is not responding or the relayd died so we
598 /* Send channel to sessiond. */
599 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
604 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
609 /* The channel was sent successfully to the sessiond at this point. */
610 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
612 health_code_update();
614 /* Send stream to session daemon. */
615 ret
= send_sessiond_stream(sock
, stream
);
621 /* Tell sessiond there is no more stream. */
622 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
627 DBG("UST consumer NULL stream sent to sessiond");
632 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
639 * Creates a channel and streams and add the channel it to the channel internal
640 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
643 * Return 0 on success or else, a negative value is returned and the channel
644 * MUST be destroyed by consumer_del_channel().
646 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
647 struct lttng_consumer_channel
*channel
,
648 struct ustctl_consumer_channel_attr
*attr
)
657 * This value is still used by the kernel consumer since for the kernel,
658 * the stream ownership is not IN the consumer so we need to have the
659 * number of left stream that needs to be initialized so we can know when
660 * to delete the channel (see consumer.c).
662 * As for the user space tracer now, the consumer creates and sends the
663 * stream to the session daemon which only sends them to the application
664 * once every stream of a channel is received making this value useless
665 * because we they will be added to the poll thread before the application
666 * receives them. This ensures that a stream can not hang up during
667 * initilization of a channel.
669 channel
->nb_init_stream_left
= 0;
671 /* The reply msg status is handled in the following call. */
672 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
677 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
680 * For the snapshots (no monitor), we create the metadata streams
681 * on demand, not during the channel creation.
683 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
688 /* Open all streams for this channel. */
689 ret
= create_ust_streams(channel
, ctx
);
699 * Send all stream of a channel to the right thread handling it.
701 * On error, return a negative value else 0 on success.
703 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
704 struct lttng_consumer_local_data
*ctx
)
707 struct lttng_consumer_stream
*stream
, *stmp
;
712 /* Send streams to the corresponding thread. */
713 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
716 health_code_update();
718 /* Sending the stream to the thread. */
719 ret
= send_stream_to_thread(stream
, ctx
);
722 * If we are unable to send the stream to the thread, there is
723 * a big problem so just stop everything.
725 /* Remove node from the channel stream list. */
726 cds_list_del(&stream
->send_node
);
730 /* Remove node from the channel stream list. */
731 cds_list_del(&stream
->send_node
);
740 * Flush channel's streams using the given key to retrieve the channel.
742 * Return 0 on success else an LTTng error code.
744 static int flush_channel(uint64_t chan_key
)
747 struct lttng_consumer_channel
*channel
;
748 struct lttng_consumer_stream
*stream
;
750 struct lttng_ht_iter iter
;
752 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
755 channel
= consumer_find_channel(chan_key
);
757 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
758 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
762 ht
= consumer_data
.stream_per_chan_id_ht
;
764 /* For each stream of the channel id, flush it. */
765 cds_lfht_for_each_entry_duplicate(ht
->ht
,
766 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
767 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
769 health_code_update();
771 pthread_mutex_lock(&stream
->lock
);
772 if (!stream
->quiescent
) {
773 ustctl_flush_buffer(stream
->ustream
, 0);
774 stream
->quiescent
= true;
776 pthread_mutex_unlock(&stream
->lock
);
784 * Clear quiescent state from channel's streams using the given key to
785 * retrieve the channel.
787 * Return 0 on success else an LTTng error code.
789 static int clear_quiescent_channel(uint64_t chan_key
)
792 struct lttng_consumer_channel
*channel
;
793 struct lttng_consumer_stream
*stream
;
795 struct lttng_ht_iter iter
;
797 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
800 channel
= consumer_find_channel(chan_key
);
802 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
803 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
807 ht
= consumer_data
.stream_per_chan_id_ht
;
809 /* For each stream of the channel id, clear quiescent state. */
810 cds_lfht_for_each_entry_duplicate(ht
->ht
,
811 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
812 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
814 health_code_update();
816 pthread_mutex_lock(&stream
->lock
);
817 stream
->quiescent
= false;
818 pthread_mutex_unlock(&stream
->lock
);
826 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
827 * RCU read side lock MUST be acquired before calling this function.
829 * Return 0 on success else an LTTng error code.
831 static int close_metadata(uint64_t chan_key
)
834 struct lttng_consumer_channel
*channel
;
836 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
838 channel
= consumer_find_channel(chan_key
);
841 * This is possible if the metadata thread has issue a delete because
842 * the endpoint point of the stream hung up. There is no way the
843 * session daemon can know about it thus use a DBG instead of an actual
846 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
847 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
851 pthread_mutex_lock(&consumer_data
.lock
);
852 pthread_mutex_lock(&channel
->lock
);
854 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
858 lttng_ustconsumer_close_metadata(channel
);
861 pthread_mutex_unlock(&channel
->lock
);
862 pthread_mutex_unlock(&consumer_data
.lock
);
868 * RCU read side lock MUST be acquired before calling this function.
870 * Return 0 on success else an LTTng error code.
872 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
875 struct lttng_consumer_channel
*metadata
;
877 DBG("UST consumer setup metadata key %" PRIu64
, key
);
879 metadata
= consumer_find_channel(key
);
881 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
882 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
887 * In no monitor mode, the metadata channel has no stream(s) so skip the
888 * ownership transfer to the metadata thread.
890 if (!metadata
->monitor
) {
891 DBG("Metadata channel in no monitor");
897 * Send metadata stream to relayd if one available. Availability is
898 * known if the stream is still in the list of the channel.
900 if (cds_list_empty(&metadata
->streams
.head
)) {
901 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
902 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
903 goto error_no_stream
;
906 /* Send metadata stream to relayd if needed. */
907 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
908 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
911 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
914 ret
= consumer_send_relayd_streams_sent(
915 metadata
->metadata_stream
->net_seq_idx
);
917 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
922 ret
= send_streams_to_thread(metadata
, ctx
);
925 * If we are unable to send the stream to the thread, there is
926 * a big problem so just stop everything.
928 ret
= LTTCOMM_CONSUMERD_FATAL
;
931 /* List MUST be empty after or else it could be reused. */
932 assert(cds_list_empty(&metadata
->streams
.head
));
939 * Delete metadata channel on error. At this point, the metadata stream can
940 * NOT be monitored by the metadata thread thus having the guarantee that
941 * the stream is still in the local stream list of the channel. This call
942 * will make sure to clean that list.
944 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
945 cds_list_del(&metadata
->metadata_stream
->send_node
);
946 metadata
->metadata_stream
= NULL
;
953 * Snapshot the whole metadata.
955 * Returns 0 on success, < 0 on error
957 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
958 struct lttng_consumer_local_data
*ctx
)
961 struct lttng_consumer_channel
*metadata_channel
;
962 struct lttng_consumer_stream
*metadata_stream
;
967 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
972 metadata_channel
= consumer_find_channel(key
);
973 if (!metadata_channel
) {
974 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
979 assert(!metadata_channel
->monitor
);
981 health_code_update();
984 * Ask the sessiond if we have new metadata waiting and update the
985 * consumer metadata cache.
987 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
992 health_code_update();
995 * The metadata stream is NOT created in no monitor mode when the channel
996 * is created on a sessiond ask channel command.
998 ret
= create_ust_streams(metadata_channel
, ctx
);
1003 metadata_stream
= metadata_channel
->metadata_stream
;
1004 assert(metadata_stream
);
1006 if (relayd_id
!= (uint64_t) -1ULL) {
1007 metadata_stream
->net_seq_idx
= relayd_id
;
1008 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1013 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
1014 metadata_stream
->chan
->tracefile_size
,
1015 metadata_stream
->tracefile_count_current
,
1016 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
1020 metadata_stream
->out_fd
= ret
;
1021 metadata_stream
->tracefile_size_current
= 0;
1025 health_code_update();
1027 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
1035 * Clean up the stream completly because the next snapshot will use a new
1038 consumer_stream_destroy(metadata_stream
, NULL
);
1039 cds_list_del(&metadata_stream
->send_node
);
1040 metadata_channel
->metadata_stream
= NULL
;
1048 * Take a snapshot of all the stream of a channel.
1050 * Returns 0 on success, < 0 on error
1052 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
1053 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
1056 unsigned use_relayd
= 0;
1057 unsigned long consumed_pos
, produced_pos
;
1058 struct lttng_consumer_channel
*channel
;
1059 struct lttng_consumer_stream
*stream
;
1066 if (relayd_id
!= (uint64_t) -1ULL) {
1070 channel
= consumer_find_channel(key
);
1072 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
1076 assert(!channel
->monitor
);
1077 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1079 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1080 /* Are we at a position _before_ the first available packet ? */
1081 bool before_first_packet
= true;
1083 health_code_update();
1085 /* Lock stream because we are about to change its state. */
1086 pthread_mutex_lock(&stream
->lock
);
1087 stream
->net_seq_idx
= relayd_id
;
1090 ret
= consumer_send_relayd_stream(stream
, path
);
1095 ret
= utils_create_stream_file(path
, stream
->name
,
1096 stream
->chan
->tracefile_size
,
1097 stream
->tracefile_count_current
,
1098 stream
->uid
, stream
->gid
, NULL
);
1102 stream
->out_fd
= ret
;
1103 stream
->tracefile_size_current
= 0;
1105 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
1106 stream
->name
, stream
->key
);
1108 if (relayd_id
!= -1ULL) {
1109 ret
= consumer_send_relayd_streams_sent(relayd_id
);
1116 * If tracing is active, we want to perform a "full" buffer flush.
1117 * Else, if quiescent, it has already been done by the prior stop.
1119 if (!stream
->quiescent
) {
1120 ustctl_flush_buffer(stream
->ustream
, 0);
1123 ret
= lttng_ustconsumer_take_snapshot(stream
);
1125 ERR("Taking UST snapshot");
1129 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1131 ERR("Produced UST snapshot position");
1135 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1137 ERR("Consumerd UST snapshot position");
1142 * The original value is sent back if max stream size is larger than
1143 * the possible size of the snapshot. Also, we assume that the session
1144 * daemon should never send a maximum stream size that is lower than
1147 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1148 produced_pos
, nb_packets_per_stream
,
1149 stream
->max_sb_size
);
1151 while (consumed_pos
< produced_pos
) {
1153 unsigned long len
, padded_len
;
1154 int lost_packet
= 0;
1156 health_code_update();
1158 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1160 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1162 if (ret
!= -EAGAIN
) {
1163 PERROR("ustctl_get_subbuf snapshot");
1164 goto error_close_stream
;
1166 DBG("UST consumer get subbuf failed. Skipping it.");
1167 consumed_pos
+= stream
->max_sb_size
;
1170 * Start accounting lost packets only when we
1171 * already have extracted packets (to match the
1172 * content of the final snapshot).
1174 if (!before_first_packet
) {
1180 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1182 ERR("Snapshot ustctl_get_subbuf_size");
1183 goto error_put_subbuf
;
1186 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1188 ERR("Snapshot ustctl_get_padded_subbuf_size");
1189 goto error_put_subbuf
;
1192 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1193 padded_len
- len
, NULL
);
1195 if (read_len
!= len
) {
1197 goto error_put_subbuf
;
1200 if (read_len
!= padded_len
) {
1202 goto error_put_subbuf
;
1206 ret
= ustctl_put_subbuf(stream
->ustream
);
1208 ERR("Snapshot ustctl_put_subbuf");
1209 goto error_close_stream
;
1211 consumed_pos
+= stream
->max_sb_size
;
1214 * Only account lost packets located between
1215 * succesfully extracted packets (do not account before
1216 * and after since they are not visible in the
1217 * resulting snapshot).
1219 stream
->chan
->lost_packets
+= lost_packet
;
1221 before_first_packet
= false;
1224 /* Simply close the stream so we can use it on the next snapshot. */
1225 consumer_stream_close(stream
);
1226 pthread_mutex_unlock(&stream
->lock
);
1233 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1234 ERR("Snapshot ustctl_put_subbuf");
1237 consumer_stream_close(stream
);
1239 pthread_mutex_unlock(&stream
->lock
);
1246 * Receive the metadata updates from the sessiond. Supports receiving
1247 * overlapping metadata, but is needs to always belong to a contiguous
1248 * range starting from 0.
1249 * Be careful about the locks held when calling this function: it needs
1250 * the metadata cache flush to concurrently progress in order to
1253 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1254 uint64_t len
, uint64_t version
,
1255 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1257 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1260 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1262 metadata_str
= zmalloc(len
* sizeof(char));
1263 if (!metadata_str
) {
1264 PERROR("zmalloc metadata string");
1265 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1269 health_code_update();
1271 /* Receive metadata string. */
1272 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1274 /* Session daemon is dead so return gracefully. */
1279 health_code_update();
1281 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1282 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1285 /* Unable to handle metadata. Notify session daemon. */
1286 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1288 * Skip metadata flush on write error since the offset and len might
1289 * not have been updated which could create an infinite loop below when
1290 * waiting for the metadata cache to be flushed.
1292 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1295 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1300 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1301 DBG("Waiting for metadata to be flushed");
1303 health_code_update();
1305 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1315 * Receive command from session daemon and process it.
1317 * Return 1 on success else a negative value or 0.
1319 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1320 int sock
, struct pollfd
*consumer_sockpoll
)
1323 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1324 struct lttcomm_consumer_msg msg
;
1325 struct lttng_consumer_channel
*channel
= NULL
;
1327 health_code_update();
1329 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1330 if (ret
!= sizeof(msg
)) {
1331 DBG("Consumer received unexpected message size %zd (expects %zu)",
1334 * The ret value might 0 meaning an orderly shutdown but this is ok
1335 * since the caller handles this.
1338 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1344 health_code_update();
1347 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1349 health_code_update();
1351 /* relayd needs RCU read-side lock */
1354 switch (msg
.cmd_type
) {
1355 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1357 /* Session daemon status message are handled in the following call. */
1358 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1359 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1360 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1361 msg
.u
.relayd_sock
.relayd_session_id
);
1364 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1366 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1367 struct consumer_relayd_sock_pair
*relayd
;
1369 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1371 /* Get relayd reference if exists. */
1372 relayd
= consumer_find_relayd(index
);
1373 if (relayd
== NULL
) {
1374 DBG("Unable to find relayd %" PRIu64
, index
);
1375 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1379 * Each relayd socket pair has a refcount of stream attached to it
1380 * which tells if the relayd is still active or not depending on the
1383 * This will set the destroy flag of the relayd object and destroy it
1384 * if the refcount reaches zero when called.
1386 * The destroy can happen either here or when a stream fd hangs up.
1389 consumer_flag_relayd_for_destroy(relayd
);
1392 goto end_msg_sessiond
;
1394 case LTTNG_CONSUMER_UPDATE_STREAM
:
1399 case LTTNG_CONSUMER_DATA_PENDING
:
1401 int ret
, is_data_pending
;
1402 uint64_t id
= msg
.u
.data_pending
.session_id
;
1404 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1406 is_data_pending
= consumer_data_pending(id
);
1408 /* Send back returned value to session daemon */
1409 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1410 sizeof(is_data_pending
));
1412 DBG("Error when sending the data pending ret code: %d", ret
);
1417 * No need to send back a status message since the data pending
1418 * returned value is the response.
1422 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1425 struct ustctl_consumer_channel_attr attr
;
1427 /* Create a plain object and reserve a channel key. */
1428 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1429 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1430 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1431 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1432 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1433 msg
.u
.ask_channel
.tracefile_size
,
1434 msg
.u
.ask_channel
.tracefile_count
,
1435 msg
.u
.ask_channel
.session_id_per_pid
,
1436 msg
.u
.ask_channel
.monitor
,
1437 msg
.u
.ask_channel
.live_timer_interval
,
1438 msg
.u
.ask_channel
.root_shm_path
,
1439 msg
.u
.ask_channel
.shm_path
);
1441 goto end_channel_error
;
1445 * Assign UST application UID to the channel. This value is ignored for
1446 * per PID buffers. This is specific to UST thus setting this after the
1449 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1451 /* Build channel attributes from received message. */
1452 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1453 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1454 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1455 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1456 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1457 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1458 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1459 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1461 /* Match channel buffer type to the UST abi. */
1462 switch (msg
.u
.ask_channel
.output
) {
1463 case LTTNG_EVENT_MMAP
:
1465 attr
.output
= LTTNG_UST_MMAP
;
1469 /* Translate and save channel type. */
1470 switch (msg
.u
.ask_channel
.type
) {
1471 case LTTNG_UST_CHAN_PER_CPU
:
1472 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1473 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1475 * Set refcount to 1 for owner. Below, we will
1476 * pass ownership to the
1477 * consumer_thread_channel_poll() thread.
1479 channel
->refcount
= 1;
1481 case LTTNG_UST_CHAN_METADATA
:
1482 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1483 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1490 health_code_update();
1492 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1494 goto end_channel_error
;
1497 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1498 ret
= consumer_metadata_cache_allocate(channel
);
1500 ERR("Allocating metadata cache");
1501 goto end_channel_error
;
1503 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1504 attr
.switch_timer_interval
= 0;
1506 int monitor_start_ret
;
1508 consumer_timer_live_start(channel
,
1509 msg
.u
.ask_channel
.live_timer_interval
);
1510 monitor_start_ret
= consumer_timer_monitor_start(
1512 msg
.u
.ask_channel
.monitor_timer_interval
);
1513 if (monitor_start_ret
< 0) {
1514 ERR("Starting channel monitoring timer failed");
1515 goto end_channel_error
;
1519 health_code_update();
1522 * Add the channel to the internal state AFTER all streams were created
1523 * and successfully sent to session daemon. This way, all streams must
1524 * be ready before this channel is visible to the threads.
1525 * If add_channel succeeds, ownership of the channel is
1526 * passed to consumer_thread_channel_poll().
1528 ret
= add_channel(channel
, ctx
);
1530 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1531 if (channel
->switch_timer_enabled
== 1) {
1532 consumer_timer_switch_stop(channel
);
1534 consumer_metadata_cache_destroy(channel
);
1536 if (channel
->live_timer_enabled
== 1) {
1537 consumer_timer_live_stop(channel
);
1539 if (channel
->monitor_timer_enabled
== 1) {
1540 consumer_timer_monitor_stop(channel
);
1542 goto end_channel_error
;
1545 health_code_update();
1548 * Channel and streams are now created. Inform the session daemon that
1549 * everything went well and should wait to receive the channel and
1550 * streams with ustctl API.
1552 ret
= consumer_send_status_channel(sock
, channel
);
1555 * There is probably a problem on the socket.
1562 case LTTNG_CONSUMER_GET_CHANNEL
:
1564 int ret
, relayd_err
= 0;
1565 uint64_t key
= msg
.u
.get_channel
.key
;
1566 struct lttng_consumer_channel
*channel
;
1568 channel
= consumer_find_channel(key
);
1570 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1571 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1572 goto end_msg_sessiond
;
1575 health_code_update();
1577 /* Send everything to sessiond. */
1578 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1582 * We were unable to send to the relayd the stream so avoid
1583 * sending back a fatal error to the thread since this is OK
1584 * and the consumer can continue its work. The above call
1585 * has sent the error status message to the sessiond.
1590 * The communicaton was broken hence there is a bad state between
1591 * the consumer and sessiond so stop everything.
1596 health_code_update();
1599 * In no monitor mode, the streams ownership is kept inside the channel
1600 * so don't send them to the data thread.
1602 if (!channel
->monitor
) {
1603 goto end_msg_sessiond
;
1606 ret
= send_streams_to_thread(channel
, ctx
);
1609 * If we are unable to send the stream to the thread, there is
1610 * a big problem so just stop everything.
1614 /* List MUST be empty after or else it could be reused. */
1615 assert(cds_list_empty(&channel
->streams
.head
));
1616 goto end_msg_sessiond
;
1618 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1620 uint64_t key
= msg
.u
.destroy_channel
.key
;
1623 * Only called if streams have not been sent to stream
1624 * manager thread. However, channel has been sent to
1625 * channel manager thread.
1627 notify_thread_del_channel(ctx
, key
);
1628 goto end_msg_sessiond
;
1630 case LTTNG_CONSUMER_CLOSE_METADATA
:
1634 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1639 goto end_msg_sessiond
;
1641 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1645 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1650 goto end_msg_sessiond
;
1652 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1656 ret
= clear_quiescent_channel(
1657 msg
.u
.clear_quiescent_channel
.key
);
1662 goto end_msg_sessiond
;
1664 case LTTNG_CONSUMER_PUSH_METADATA
:
1667 uint64_t len
= msg
.u
.push_metadata
.len
;
1668 uint64_t key
= msg
.u
.push_metadata
.key
;
1669 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1670 uint64_t version
= msg
.u
.push_metadata
.version
;
1671 struct lttng_consumer_channel
*channel
;
1673 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1676 channel
= consumer_find_channel(key
);
1679 * This is possible if the metadata creation on the consumer side
1680 * is in flight vis-a-vis a concurrent push metadata from the
1681 * session daemon. Simply return that the channel failed and the
1682 * session daemon will handle that message correctly considering
1683 * that this race is acceptable thus the DBG() statement here.
1685 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1686 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1687 goto end_msg_sessiond
;
1690 health_code_update();
1694 * There is nothing to receive. We have simply
1695 * checked whether the channel can be found.
1697 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1698 goto end_msg_sessiond
;
1701 /* Tell session daemon we are ready to receive the metadata. */
1702 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1704 /* Somehow, the session daemon is not responding anymore. */
1708 health_code_update();
1710 /* Wait for more data. */
1711 health_poll_entry();
1712 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1718 health_code_update();
1720 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1721 len
, version
, channel
, 0, 1);
1723 /* error receiving from sessiond */
1727 goto end_msg_sessiond
;
1730 case LTTNG_CONSUMER_SETUP_METADATA
:
1734 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1738 goto end_msg_sessiond
;
1740 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1742 if (msg
.u
.snapshot_channel
.metadata
) {
1743 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1744 msg
.u
.snapshot_channel
.pathname
,
1745 msg
.u
.snapshot_channel
.relayd_id
,
1748 ERR("Snapshot metadata failed");
1749 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1752 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1753 msg
.u
.snapshot_channel
.pathname
,
1754 msg
.u
.snapshot_channel
.relayd_id
,
1755 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1758 ERR("Snapshot channel failed");
1759 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1763 health_code_update();
1764 ret
= consumer_send_status_msg(sock
, ret_code
);
1766 /* Somehow, the session daemon is not responding anymore. */
1769 health_code_update();
1772 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1775 uint64_t discarded_events
;
1776 struct lttng_ht_iter iter
;
1777 struct lttng_ht
*ht
;
1778 struct lttng_consumer_stream
*stream
;
1779 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1780 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1782 DBG("UST consumer discarded events command for session id %"
1785 pthread_mutex_lock(&consumer_data
.lock
);
1787 ht
= consumer_data
.stream_list_ht
;
1790 * We only need a reference to the channel, but they are not
1791 * directly indexed, so we just use the first matching stream
1792 * to extract the information we need, we default to 0 if not
1793 * found (no events are dropped if the channel is not yet in
1796 discarded_events
= 0;
1797 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1798 ht
->hash_fct(&id
, lttng_ht_seed
),
1800 &iter
.iter
, stream
, node_session_id
.node
) {
1801 if (stream
->chan
->key
== key
) {
1802 discarded_events
= stream
->chan
->discarded_events
;
1806 pthread_mutex_unlock(&consumer_data
.lock
);
1809 DBG("UST consumer discarded events command for session id %"
1810 PRIu64
", channel key %" PRIu64
, id
, key
);
1812 health_code_update();
1814 /* Send back returned value to session daemon */
1815 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1817 PERROR("send discarded events");
1823 case LTTNG_CONSUMER_LOST_PACKETS
:
1826 uint64_t lost_packets
;
1827 struct lttng_ht_iter iter
;
1828 struct lttng_ht
*ht
;
1829 struct lttng_consumer_stream
*stream
;
1830 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1831 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1833 DBG("UST consumer lost packets command for session id %"
1836 pthread_mutex_lock(&consumer_data
.lock
);
1838 ht
= consumer_data
.stream_list_ht
;
1841 * We only need a reference to the channel, but they are not
1842 * directly indexed, so we just use the first matching stream
1843 * to extract the information we need, we default to 0 if not
1844 * found (no packets lost if the channel is not yet in use).
1847 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1848 ht
->hash_fct(&id
, lttng_ht_seed
),
1850 &iter
.iter
, stream
, node_session_id
.node
) {
1851 if (stream
->chan
->key
== key
) {
1852 lost_packets
= stream
->chan
->lost_packets
;
1856 pthread_mutex_unlock(&consumer_data
.lock
);
1859 DBG("UST consumer lost packets command for session id %"
1860 PRIu64
", channel key %" PRIu64
, id
, key
);
1862 health_code_update();
1864 /* Send back returned value to session daemon */
1865 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1866 sizeof(lost_packets
));
1868 PERROR("send lost packets");
1874 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1876 int channel_monitor_pipe
;
1878 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1879 /* Successfully received the command's type. */
1880 ret
= consumer_send_status_msg(sock
, ret_code
);
1885 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1887 if (ret
!= sizeof(channel_monitor_pipe
)) {
1888 ERR("Failed to receive channel monitor pipe");
1892 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1893 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1894 channel_monitor_pipe
);
1898 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1899 /* Set the pipe as non-blocking. */
1900 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1902 PERROR("fcntl get flags of the channel monitoring pipe");
1907 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1908 flags
| O_NONBLOCK
);
1910 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1913 DBG("Channel monitor pipe set as non-blocking");
1915 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1917 goto end_msg_sessiond
;
1926 health_code_update();
1929 * Return 1 to indicate success since the 0 value can be a socket
1930 * shutdown during the recv() or send() call.
1936 * The returned value here is not useful since either way we'll return 1 to
1937 * the caller because the session daemon socket management is done
1938 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1940 ret
= consumer_send_status_msg(sock
, ret_code
);
1946 health_code_update();
1952 * Free channel here since no one has a reference to it. We don't
1953 * free after that because a stream can store this pointer.
1955 destroy_channel(channel
);
1957 /* We have to send a status channel message indicating an error. */
1958 ret
= consumer_send_status_channel(sock
, NULL
);
1960 /* Stop everything if session daemon can not be notified. */
1965 health_code_update();
1970 /* This will issue a consumer stop. */
1975 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1976 * compiled out, we isolate it in this library.
1978 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1982 assert(stream
->ustream
);
1984 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1988 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1989 * compiled out, we isolate it in this library.
1991 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1994 assert(stream
->ustream
);
1996 return ustctl_get_mmap_base(stream
->ustream
);
2000 * Take a snapshot for a specific stream.
2002 * Returns 0 on success, < 0 on error
2004 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2007 assert(stream
->ustream
);
2009 return ustctl_snapshot(stream
->ustream
);
2013 * Sample consumed and produced positions for a specific stream.
2015 * Returns 0 on success, < 0 on error.
2017 int lttng_ustconsumer_sample_snapshot_positions(
2018 struct lttng_consumer_stream
*stream
)
2021 assert(stream
->ustream
);
2023 return ustctl_snapshot_sample_positions(stream
->ustream
);
2027 * Get the produced position
2029 * Returns 0 on success, < 0 on error
2031 int lttng_ustconsumer_get_produced_snapshot(
2032 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2035 assert(stream
->ustream
);
2038 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2042 * Get the consumed position
2044 * Returns 0 on success, < 0 on error
2046 int lttng_ustconsumer_get_consumed_snapshot(
2047 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2050 assert(stream
->ustream
);
2053 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2056 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2060 assert(stream
->ustream
);
2062 ustctl_flush_buffer(stream
->ustream
, producer
);
2065 int lttng_ustconsumer_get_current_timestamp(
2066 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2069 assert(stream
->ustream
);
2072 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2075 int lttng_ustconsumer_get_sequence_number(
2076 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2079 assert(stream
->ustream
);
2082 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2086 * Called when the stream signals the consumer that it has hung up.
2088 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2091 assert(stream
->ustream
);
2093 pthread_mutex_lock(&stream
->lock
);
2094 if (!stream
->quiescent
) {
2095 ustctl_flush_buffer(stream
->ustream
, 0);
2096 stream
->quiescent
= true;
2098 pthread_mutex_unlock(&stream
->lock
);
2099 stream
->hangup_flush_done
= 1;
2102 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2107 assert(chan
->uchan
);
2109 if (chan
->switch_timer_enabled
== 1) {
2110 consumer_timer_switch_stop(chan
);
2112 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2115 ret
= close(chan
->stream_fds
[i
]);
2119 if (chan
->shm_path
[0]) {
2120 char shm_path
[PATH_MAX
];
2122 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2124 ERR("Cannot get stream shm path");
2126 ret
= run_as_unlink(shm_path
, chan
->uid
, chan
->gid
);
2128 PERROR("unlink %s", shm_path
);
2134 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2137 assert(chan
->uchan
);
2139 consumer_metadata_cache_destroy(chan
);
2140 ustctl_destroy_channel(chan
->uchan
);
2141 /* Try to rmdir all directories under shm_path root. */
2142 if (chan
->root_shm_path
[0]) {
2143 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2144 chan
->uid
, chan
->gid
);
2146 free(chan
->stream_fds
);
2149 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2152 assert(stream
->ustream
);
2154 if (stream
->chan
->switch_timer_enabled
== 1) {
2155 consumer_timer_switch_stop(stream
->chan
);
2157 ustctl_destroy_stream(stream
->ustream
);
2160 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2163 assert(stream
->ustream
);
2165 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2168 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2171 assert(stream
->ustream
);
2173 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2177 * Populate index values of a UST stream. Values are set in big endian order.
2179 * Return 0 on success or else a negative value.
2181 static int get_index_values(struct ctf_packet_index
*index
,
2182 struct ustctl_consumer_stream
*ustream
)
2186 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2188 PERROR("ustctl_get_timestamp_begin");
2191 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2193 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2195 PERROR("ustctl_get_timestamp_end");
2198 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2200 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2202 PERROR("ustctl_get_events_discarded");
2205 index
->events_discarded
= htobe64(index
->events_discarded
);
2207 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2209 PERROR("ustctl_get_content_size");
2212 index
->content_size
= htobe64(index
->content_size
);
2214 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2216 PERROR("ustctl_get_packet_size");
2219 index
->packet_size
= htobe64(index
->packet_size
);
2221 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2223 PERROR("ustctl_get_stream_id");
2226 index
->stream_id
= htobe64(index
->stream_id
);
2228 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2230 PERROR("ustctl_get_instance_id");
2233 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2235 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2237 PERROR("ustctl_get_sequence_number");
2240 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2247 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
,
2248 struct consumer_metadata_cache
*cache
)
2250 DBG("Metadata stream update to version %" PRIu64
,
2252 stream
->ust_metadata_pushed
= 0;
2253 stream
->metadata_version
= cache
->version
;
2254 stream
->reset_metadata_flag
= 1;
2258 * Check if the version of the metadata stream and metadata cache match.
2259 * If the cache got updated, reset the metadata stream.
2260 * The stream lock and metadata cache lock MUST be held.
2261 * Return 0 on success, a negative value on error.
2264 int metadata_stream_check_version(struct lttng_consumer_stream
*stream
)
2267 struct consumer_metadata_cache
*cache
= stream
->chan
->metadata_cache
;
2269 if (cache
->version
== stream
->metadata_version
) {
2272 metadata_stream_reset_cache(stream
, cache
);
2279 * Write up to one packet from the metadata cache to the channel.
2281 * Returns the number of bytes pushed in the cache, or a negative value
2285 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2290 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2291 ret
= metadata_stream_check_version(stream
);
2295 if (stream
->chan
->metadata_cache
->max_offset
2296 == stream
->ust_metadata_pushed
) {
2301 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2302 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2303 stream
->chan
->metadata_cache
->max_offset
2304 - stream
->ust_metadata_pushed
);
2305 assert(write_len
!= 0);
2306 if (write_len
< 0) {
2307 ERR("Writing one metadata packet");
2311 stream
->ust_metadata_pushed
+= write_len
;
2313 assert(stream
->chan
->metadata_cache
->max_offset
>=
2314 stream
->ust_metadata_pushed
);
2318 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2324 * Sync metadata meaning request them to the session daemon and snapshot to the
2325 * metadata thread can consumer them.
2327 * Metadata stream lock is held here, but we need to release it when
2328 * interacting with sessiond, else we cause a deadlock with live
2329 * awaiting on metadata to be pushed out.
2331 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2332 * is empty or a negative value on error.
2334 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2335 struct lttng_consumer_stream
*metadata
)
2343 pthread_mutex_unlock(&metadata
->lock
);
2345 * Request metadata from the sessiond, but don't wait for the flush
2346 * because we locked the metadata thread.
2348 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2349 pthread_mutex_lock(&metadata
->lock
);
2354 ret
= commit_one_metadata_packet(metadata
);
2357 } else if (ret
> 0) {
2361 ustctl_flush_buffer(metadata
->ustream
, 1);
2362 ret
= ustctl_snapshot(metadata
->ustream
);
2364 if (errno
!= EAGAIN
) {
2365 ERR("Sync metadata, taking UST snapshot");
2368 DBG("No new metadata when syncing them.");
2369 /* No new metadata, exit. */
2375 * After this flush, we still need to extract metadata.
2386 * Return 0 on success else a negative value.
2388 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2389 struct lttng_consumer_local_data
*ctx
)
2392 struct ustctl_consumer_stream
*ustream
;
2397 ustream
= stream
->ustream
;
2400 * First, we are going to check if there is a new subbuffer available
2401 * before reading the stream wait_fd.
2403 /* Get the next subbuffer */
2404 ret
= ustctl_get_next_subbuf(ustream
);
2406 /* No more data found, flag the stream. */
2407 stream
->has_data
= 0;
2412 ret
= ustctl_put_subbuf(ustream
);
2415 /* This stream still has data. Flag it and wake up the data thread. */
2416 stream
->has_data
= 1;
2418 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2421 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2422 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2427 /* The wake up pipe has been notified. */
2428 ctx
->has_wakeup
= 1;
2437 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2440 uint64_t seq
, discarded
;
2442 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2444 PERROR("ustctl_get_sequence_number");
2448 * Start the sequence when we extract the first packet in case we don't
2449 * start at 0 (for example if a consumer is not connected to the
2450 * session immediately after the beginning).
2452 if (stream
->last_sequence_number
== -1ULL) {
2453 stream
->last_sequence_number
= seq
;
2454 } else if (seq
> stream
->last_sequence_number
) {
2455 stream
->chan
->lost_packets
+= seq
-
2456 stream
->last_sequence_number
- 1;
2458 /* seq <= last_sequence_number */
2459 ERR("Sequence number inconsistent : prev = %" PRIu64
2460 ", current = %" PRIu64
,
2461 stream
->last_sequence_number
, seq
);
2465 stream
->last_sequence_number
= seq
;
2467 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2469 PERROR("kernctl_get_events_discarded");
2472 if (discarded
< stream
->last_discarded_events
) {
2474 * Overflow has occurred. We assume only one wrap-around
2477 stream
->chan
->discarded_events
+=
2478 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2479 stream
->last_discarded_events
+ discarded
;
2481 stream
->chan
->discarded_events
+= discarded
-
2482 stream
->last_discarded_events
;
2484 stream
->last_discarded_events
= discarded
;
2492 * Read subbuffer from the given stream.
2494 * Stream lock MUST be acquired.
2496 * Return 0 on success else a negative value.
2498 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2499 struct lttng_consumer_local_data
*ctx
)
2501 unsigned long len
, subbuf_size
, padding
;
2502 int err
, write_index
= 1;
2504 struct ustctl_consumer_stream
*ustream
;
2505 struct ctf_packet_index index
;
2508 assert(stream
->ustream
);
2511 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2514 /* Ease our life for what's next. */
2515 ustream
= stream
->ustream
;
2518 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2519 * error if we cannot read this one byte (read returns 0), or if the error
2520 * is EAGAIN or EWOULDBLOCK.
2522 * This is only done when the stream is monitored by a thread, before the
2523 * flush is done after a hangup and if the stream is not flagged with data
2524 * since there might be nothing to consume in the wait fd but still have
2525 * data available flagged by the consumer wake up pipe.
2527 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2531 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2532 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2539 /* Get the next subbuffer */
2540 err
= ustctl_get_next_subbuf(ustream
);
2543 * Populate metadata info if the existing info has
2544 * already been read.
2546 if (stream
->metadata_flag
) {
2547 ret
= commit_one_metadata_packet(stream
);
2551 ustctl_flush_buffer(stream
->ustream
, 1);
2555 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2557 * This is a debug message even for single-threaded consumer,
2558 * because poll() have more relaxed criterions than get subbuf,
2559 * so get_subbuf may fail for short race windows where poll()
2560 * would issue wakeups.
2562 DBG("Reserving sub buffer failed (everything is normal, "
2563 "it is due to concurrency) [ret: %d]", err
);
2566 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2568 if (!stream
->metadata_flag
) {
2569 index
.offset
= htobe64(stream
->out_fd_offset
);
2570 ret
= get_index_values(&index
, ustream
);
2572 err
= ustctl_put_subbuf(ustream
);
2577 /* Update the stream's sequence and discarded events count. */
2578 ret
= update_stream_stats(stream
);
2580 PERROR("kernctl_get_events_discarded");
2581 err
= ustctl_put_subbuf(ustream
);
2589 /* Get the full padded subbuffer size */
2590 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2593 /* Get subbuffer data size (without padding) */
2594 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2597 /* Make sure we don't get a subbuffer size bigger than the padded */
2598 assert(len
>= subbuf_size
);
2600 padding
= len
- subbuf_size
;
2601 /* write the subbuffer to the tracefile */
2602 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2604 * The mmap operation should write subbuf_size amount of data when network
2605 * streaming or the full padding (len) size when we are _not_ streaming.
2607 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2608 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2610 * Display the error but continue processing to try to release the
2611 * subbuffer. This is a DBG statement since any unexpected kill or
2612 * signal, the application gets unregistered, relayd gets closed or
2613 * anything that affects the buffer lifetime will trigger this error.
2614 * So, for the sake of the user, don't print this error since it can
2615 * happen and it is OK with the code flow.
2617 DBG("Error writing to tracefile "
2618 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2619 ret
, len
, subbuf_size
);
2622 err
= ustctl_put_next_subbuf(ustream
);
2626 * This will consumer the byte on the wait_fd if and only if there is not
2627 * next subbuffer to be acquired.
2629 if (!stream
->metadata_flag
) {
2630 ret
= notify_if_more_data(stream
, ctx
);
2636 /* Write index if needed. */
2641 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2643 * In live, block until all the metadata is sent.
2645 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2646 assert(!stream
->missed_metadata_flush
);
2647 stream
->waiting_on_metadata
= true;
2648 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2650 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2652 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2653 stream
->waiting_on_metadata
= false;
2654 if (stream
->missed_metadata_flush
) {
2655 stream
->missed_metadata_flush
= false;
2656 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2657 (void) consumer_flush_ust_index(stream
);
2659 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2667 assert(!stream
->metadata_flag
);
2668 err
= consumer_stream_write_index(stream
, &index
);
2678 * Called when a stream is created.
2680 * Return 0 on success or else a negative value.
2682 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2688 /* Don't create anything if this is set for streaming. */
2689 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2690 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2691 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2692 stream
->uid
, stream
->gid
, NULL
);
2696 stream
->out_fd
= ret
;
2697 stream
->tracefile_size_current
= 0;
2699 if (!stream
->metadata_flag
) {
2700 struct lttng_index_file
*index_file
;
2702 index_file
= lttng_index_file_create(stream
->chan
->pathname
,
2703 stream
->name
, stream
->uid
, stream
->gid
,
2704 stream
->chan
->tracefile_size
,
2705 stream
->tracefile_count_current
,
2706 CTF_INDEX_MAJOR
, CTF_INDEX_MINOR
);
2710 assert(!stream
->index_file
);
2711 stream
->index_file
= index_file
;
2721 * Check if data is still being extracted from the buffers for a specific
2722 * stream. Consumer data lock MUST be acquired before calling this function
2723 * and the stream lock.
2725 * Return 1 if the traced data are still getting read else 0 meaning that the
2726 * data is available for trace viewer reading.
2728 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2733 assert(stream
->ustream
);
2735 DBG("UST consumer checking data pending");
2737 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2742 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2743 uint64_t contiguous
, pushed
;
2745 /* Ease our life a bit. */
2746 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2747 pushed
= stream
->ust_metadata_pushed
;
2750 * We can simply check whether all contiguously available data
2751 * has been pushed to the ring buffer, since the push operation
2752 * is performed within get_next_subbuf(), and because both
2753 * get_next_subbuf() and put_next_subbuf() are issued atomically
2754 * thanks to the stream lock within
2755 * lttng_ustconsumer_read_subbuffer(). This basically means that
2756 * whetnever ust_metadata_pushed is incremented, the associated
2757 * metadata has been consumed from the metadata stream.
2759 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2760 contiguous
, pushed
);
2761 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2762 if ((contiguous
!= pushed
) ||
2763 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2764 ret
= 1; /* Data is pending */
2768 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2771 * There is still data so let's put back this
2774 ret
= ustctl_put_subbuf(stream
->ustream
);
2776 ret
= 1; /* Data is pending */
2781 /* Data is NOT pending so ready to be read. */
2789 * Stop a given metadata channel timer if enabled and close the wait fd which
2790 * is the poll pipe of the metadata stream.
2792 * This MUST be called with the metadata channel acquired.
2794 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2799 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2801 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2803 if (metadata
->switch_timer_enabled
== 1) {
2804 consumer_timer_switch_stop(metadata
);
2807 if (!metadata
->metadata_stream
) {
2812 * Closing write side so the thread monitoring the stream wakes up if any
2813 * and clean the metadata stream.
2815 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2816 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2818 PERROR("closing metadata pipe write side");
2820 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2828 * Close every metadata stream wait fd of the metadata hash table. This
2829 * function MUST be used very carefully so not to run into a race between the
2830 * metadata thread handling streams and this function closing their wait fd.
2832 * For UST, this is used when the session daemon hangs up. Its the metadata
2833 * producer so calling this is safe because we are assured that no state change
2834 * can occur in the metadata thread for the streams in the hash table.
2836 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2838 struct lttng_ht_iter iter
;
2839 struct lttng_consumer_stream
*stream
;
2841 assert(metadata_ht
);
2842 assert(metadata_ht
->ht
);
2844 DBG("UST consumer closing all metadata streams");
2847 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2850 health_code_update();
2852 pthread_mutex_lock(&stream
->chan
->lock
);
2853 lttng_ustconsumer_close_metadata(stream
->chan
);
2854 pthread_mutex_unlock(&stream
->chan
->lock
);
2860 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2864 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2866 ERR("Unable to close wakeup fd");
2871 * Please refer to consumer-timer.c before adding any lock within this
2872 * function or any of its callees. Timers have a very strict locking
2873 * semantic with respect to teardown. Failure to respect this semantic
2874 * introduces deadlocks.
2876 * DON'T hold the metadata lock when calling this function, else this
2877 * can cause deadlock involving consumer awaiting for metadata to be
2878 * pushed out due to concurrent interaction with the session daemon.
2880 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2881 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2883 struct lttcomm_metadata_request_msg request
;
2884 struct lttcomm_consumer_msg msg
;
2885 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2886 uint64_t len
, key
, offset
, version
;
2890 assert(channel
->metadata_cache
);
2892 memset(&request
, 0, sizeof(request
));
2894 /* send the metadata request to sessiond */
2895 switch (consumer_data
.type
) {
2896 case LTTNG_CONSUMER64_UST
:
2897 request
.bits_per_long
= 64;
2899 case LTTNG_CONSUMER32_UST
:
2900 request
.bits_per_long
= 32;
2903 request
.bits_per_long
= 0;
2907 request
.session_id
= channel
->session_id
;
2908 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2910 * Request the application UID here so the metadata of that application can
2911 * be sent back. The channel UID corresponds to the user UID of the session
2912 * used for the rights on the stream file(s).
2914 request
.uid
= channel
->ust_app_uid
;
2915 request
.key
= channel
->key
;
2917 DBG("Sending metadata request to sessiond, session id %" PRIu64
2918 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2919 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2922 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2924 health_code_update();
2926 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2929 ERR("Asking metadata to sessiond");
2933 health_code_update();
2935 /* Receive the metadata from sessiond */
2936 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2938 if (ret
!= sizeof(msg
)) {
2939 DBG("Consumer received unexpected message size %d (expects %zu)",
2941 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2943 * The ret value might 0 meaning an orderly shutdown but this is ok
2944 * since the caller handles this.
2949 health_code_update();
2951 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2952 /* No registry found */
2953 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2957 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2958 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2963 len
= msg
.u
.push_metadata
.len
;
2964 key
= msg
.u
.push_metadata
.key
;
2965 offset
= msg
.u
.push_metadata
.target_offset
;
2966 version
= msg
.u
.push_metadata
.version
;
2968 assert(key
== channel
->key
);
2970 DBG("No new metadata to receive for key %" PRIu64
, key
);
2973 health_code_update();
2975 /* Tell session daemon we are ready to receive the metadata. */
2976 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2977 LTTCOMM_CONSUMERD_SUCCESS
);
2978 if (ret
< 0 || len
== 0) {
2980 * Somehow, the session daemon is not responding anymore or there is
2981 * nothing to receive.
2986 health_code_update();
2988 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2989 key
, offset
, len
, version
, channel
, timer
, wait
);
2992 * Only send the status msg if the sessiond is alive meaning a positive
2995 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3000 health_code_update();
3002 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3007 * Return the ustctl call for the get stream id.
3009 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3010 uint64_t *stream_id
)
3015 return ustctl_get_stream_id(stream
->ustream
, stream_id
);