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
;
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_rmdir_recursive(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 pthread_mutex_lock(&stream
->lock
);
771 if (!stream
->quiescent
) {
772 ustctl_flush_buffer(stream
->ustream
, 0);
773 stream
->quiescent
= true;
775 pthread_mutex_unlock(&stream
->lock
);
783 * Clear quiescent state from channel's streams using the given key to
784 * retrieve the channel.
786 * Return 0 on success else an LTTng error code.
788 static int clear_quiescent_channel(uint64_t chan_key
)
791 struct lttng_consumer_channel
*channel
;
792 struct lttng_consumer_stream
*stream
;
794 struct lttng_ht_iter iter
;
796 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
799 channel
= consumer_find_channel(chan_key
);
801 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
802 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
806 ht
= consumer_data
.stream_per_chan_id_ht
;
808 /* For each stream of the channel id, clear quiescent state. */
809 cds_lfht_for_each_entry_duplicate(ht
->ht
,
810 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
811 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
813 health_code_update();
815 pthread_mutex_lock(&stream
->lock
);
816 stream
->quiescent
= false;
817 pthread_mutex_unlock(&stream
->lock
);
825 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
826 * RCU read side lock MUST be acquired before calling this function.
828 * Return 0 on success else an LTTng error code.
830 static int close_metadata(uint64_t chan_key
)
833 struct lttng_consumer_channel
*channel
;
835 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
837 channel
= consumer_find_channel(chan_key
);
840 * This is possible if the metadata thread has issue a delete because
841 * the endpoint point of the stream hung up. There is no way the
842 * session daemon can know about it thus use a DBG instead of an actual
845 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
846 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
850 pthread_mutex_lock(&consumer_data
.lock
);
851 pthread_mutex_lock(&channel
->lock
);
853 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
857 lttng_ustconsumer_close_metadata(channel
);
860 pthread_mutex_unlock(&channel
->lock
);
861 pthread_mutex_unlock(&consumer_data
.lock
);
867 * RCU read side lock MUST be acquired before calling this function.
869 * Return 0 on success else an LTTng error code.
871 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
874 struct lttng_consumer_channel
*metadata
;
876 DBG("UST consumer setup metadata key %" PRIu64
, key
);
878 metadata
= consumer_find_channel(key
);
880 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
881 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
886 * In no monitor mode, the metadata channel has no stream(s) so skip the
887 * ownership transfer to the metadata thread.
889 if (!metadata
->monitor
) {
890 DBG("Metadata channel in no monitor");
896 * Send metadata stream to relayd if one available. Availability is
897 * known if the stream is still in the list of the channel.
899 if (cds_list_empty(&metadata
->streams
.head
)) {
900 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
901 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
902 goto error_no_stream
;
905 /* Send metadata stream to relayd if needed. */
906 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
907 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
910 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
913 ret
= consumer_send_relayd_streams_sent(
914 metadata
->metadata_stream
->net_seq_idx
);
916 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
921 ret
= send_streams_to_thread(metadata
, ctx
);
924 * If we are unable to send the stream to the thread, there is
925 * a big problem so just stop everything.
927 ret
= LTTCOMM_CONSUMERD_FATAL
;
930 /* List MUST be empty after or else it could be reused. */
931 assert(cds_list_empty(&metadata
->streams
.head
));
938 * Delete metadata channel on error. At this point, the metadata stream can
939 * NOT be monitored by the metadata thread thus having the guarantee that
940 * the stream is still in the local stream list of the channel. This call
941 * will make sure to clean that list.
943 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
944 cds_list_del(&metadata
->metadata_stream
->send_node
);
945 metadata
->metadata_stream
= NULL
;
952 * Snapshot the whole metadata.
954 * Returns 0 on success, < 0 on error
956 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
957 struct lttng_consumer_local_data
*ctx
)
960 struct lttng_consumer_channel
*metadata_channel
;
961 struct lttng_consumer_stream
*metadata_stream
;
966 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
971 metadata_channel
= consumer_find_channel(key
);
972 if (!metadata_channel
) {
973 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
978 assert(!metadata_channel
->monitor
);
980 health_code_update();
983 * Ask the sessiond if we have new metadata waiting and update the
984 * consumer metadata cache.
986 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
991 health_code_update();
994 * The metadata stream is NOT created in no monitor mode when the channel
995 * is created on a sessiond ask channel command.
997 ret
= create_ust_streams(metadata_channel
, ctx
);
1002 metadata_stream
= metadata_channel
->metadata_stream
;
1003 assert(metadata_stream
);
1005 if (relayd_id
!= (uint64_t) -1ULL) {
1006 metadata_stream
->net_seq_idx
= relayd_id
;
1007 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1012 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
1013 metadata_stream
->chan
->tracefile_size
,
1014 metadata_stream
->tracefile_count_current
,
1015 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
1019 metadata_stream
->out_fd
= ret
;
1020 metadata_stream
->tracefile_size_current
= 0;
1024 health_code_update();
1026 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
1034 * Clean up the stream completly because the next snapshot will use a new
1037 consumer_stream_destroy(metadata_stream
, NULL
);
1038 cds_list_del(&metadata_stream
->send_node
);
1039 metadata_channel
->metadata_stream
= NULL
;
1047 * Take a snapshot of all the stream of a channel.
1049 * Returns 0 on success, < 0 on error
1051 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
1052 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
1055 unsigned use_relayd
= 0;
1056 unsigned long consumed_pos
, produced_pos
;
1057 struct lttng_consumer_channel
*channel
;
1058 struct lttng_consumer_stream
*stream
;
1065 if (relayd_id
!= (uint64_t) -1ULL) {
1069 channel
= consumer_find_channel(key
);
1071 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
1075 assert(!channel
->monitor
);
1076 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1078 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1079 health_code_update();
1081 /* Lock stream because we are about to change its state. */
1082 pthread_mutex_lock(&stream
->lock
);
1083 stream
->net_seq_idx
= relayd_id
;
1086 ret
= consumer_send_relayd_stream(stream
, path
);
1091 ret
= utils_create_stream_file(path
, stream
->name
,
1092 stream
->chan
->tracefile_size
,
1093 stream
->tracefile_count_current
,
1094 stream
->uid
, stream
->gid
, NULL
);
1098 stream
->out_fd
= ret
;
1099 stream
->tracefile_size_current
= 0;
1101 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
1102 stream
->name
, stream
->key
);
1106 * If tracing is active, we want to perform a "full" buffer flush.
1107 * Else, if quiescent, it has already been done by the prior stop.
1109 if (!stream
->quiescent
) {
1110 ustctl_flush_buffer(stream
->ustream
, 0);
1113 ret
= lttng_ustconsumer_take_snapshot(stream
);
1115 ERR("Taking UST snapshot");
1119 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1121 ERR("Produced UST snapshot position");
1125 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1127 ERR("Consumerd UST snapshot position");
1132 * The original value is sent back if max stream size is larger than
1133 * the possible size of the snapshot. Also, we assume that the session
1134 * daemon should never send a maximum stream size that is lower than
1137 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1138 produced_pos
, nb_packets_per_stream
,
1139 stream
->max_sb_size
);
1141 while (consumed_pos
< produced_pos
) {
1143 unsigned long len
, padded_len
;
1145 health_code_update();
1147 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1149 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1151 if (ret
!= -EAGAIN
) {
1152 PERROR("ustctl_get_subbuf snapshot");
1153 goto error_close_stream
;
1155 DBG("UST consumer get subbuf failed. Skipping it.");
1156 consumed_pos
+= stream
->max_sb_size
;
1157 stream
->chan
->lost_packets
++;
1161 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1163 ERR("Snapshot ustctl_get_subbuf_size");
1164 goto error_put_subbuf
;
1167 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1169 ERR("Snapshot ustctl_get_padded_subbuf_size");
1170 goto error_put_subbuf
;
1173 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1174 padded_len
- len
, NULL
);
1176 if (read_len
!= len
) {
1178 goto error_put_subbuf
;
1181 if (read_len
!= padded_len
) {
1183 goto error_put_subbuf
;
1187 ret
= ustctl_put_subbuf(stream
->ustream
);
1189 ERR("Snapshot ustctl_put_subbuf");
1190 goto error_close_stream
;
1192 consumed_pos
+= stream
->max_sb_size
;
1195 /* Simply close the stream so we can use it on the next snapshot. */
1196 consumer_stream_close(stream
);
1197 pthread_mutex_unlock(&stream
->lock
);
1204 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1205 ERR("Snapshot ustctl_put_subbuf");
1208 consumer_stream_close(stream
);
1210 pthread_mutex_unlock(&stream
->lock
);
1217 * Receive the metadata updates from the sessiond. Supports receiving
1218 * overlapping metadata, but is needs to always belong to a contiguous
1219 * range starting from 0.
1220 * Be careful about the locks held when calling this function: it needs
1221 * the metadata cache flush to concurrently progress in order to
1224 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1225 uint64_t len
, uint64_t version
,
1226 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1228 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1231 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1233 metadata_str
= zmalloc(len
* sizeof(char));
1234 if (!metadata_str
) {
1235 PERROR("zmalloc metadata string");
1236 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1240 health_code_update();
1242 /* Receive metadata string. */
1243 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1245 /* Session daemon is dead so return gracefully. */
1250 health_code_update();
1252 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1253 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1256 /* Unable to handle metadata. Notify session daemon. */
1257 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1259 * Skip metadata flush on write error since the offset and len might
1260 * not have been updated which could create an infinite loop below when
1261 * waiting for the metadata cache to be flushed.
1263 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1266 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1271 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1272 DBG("Waiting for metadata to be flushed");
1274 health_code_update();
1276 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1286 * Receive command from session daemon and process it.
1288 * Return 1 on success else a negative value or 0.
1290 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1291 int sock
, struct pollfd
*consumer_sockpoll
)
1294 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1295 struct lttcomm_consumer_msg msg
;
1296 struct lttng_consumer_channel
*channel
= NULL
;
1298 health_code_update();
1300 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1301 if (ret
!= sizeof(msg
)) {
1302 DBG("Consumer received unexpected message size %zd (expects %zu)",
1305 * The ret value might 0 meaning an orderly shutdown but this is ok
1306 * since the caller handles this.
1309 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1315 health_code_update();
1318 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1320 health_code_update();
1322 /* relayd needs RCU read-side lock */
1325 switch (msg
.cmd_type
) {
1326 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1328 /* Session daemon status message are handled in the following call. */
1329 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1330 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1331 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1332 msg
.u
.relayd_sock
.relayd_session_id
);
1335 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1337 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1338 struct consumer_relayd_sock_pair
*relayd
;
1340 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1342 /* Get relayd reference if exists. */
1343 relayd
= consumer_find_relayd(index
);
1344 if (relayd
== NULL
) {
1345 DBG("Unable to find relayd %" PRIu64
, index
);
1346 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1350 * Each relayd socket pair has a refcount of stream attached to it
1351 * which tells if the relayd is still active or not depending on the
1354 * This will set the destroy flag of the relayd object and destroy it
1355 * if the refcount reaches zero when called.
1357 * The destroy can happen either here or when a stream fd hangs up.
1360 consumer_flag_relayd_for_destroy(relayd
);
1363 goto end_msg_sessiond
;
1365 case LTTNG_CONSUMER_UPDATE_STREAM
:
1370 case LTTNG_CONSUMER_DATA_PENDING
:
1372 int ret
, is_data_pending
;
1373 uint64_t id
= msg
.u
.data_pending
.session_id
;
1375 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1377 is_data_pending
= consumer_data_pending(id
);
1379 /* Send back returned value to session daemon */
1380 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1381 sizeof(is_data_pending
));
1383 DBG("Error when sending the data pending ret code: %d", ret
);
1388 * No need to send back a status message since the data pending
1389 * returned value is the response.
1393 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1396 struct ustctl_consumer_channel_attr attr
;
1398 /* Create a plain object and reserve a channel key. */
1399 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1400 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1401 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1402 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1403 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1404 msg
.u
.ask_channel
.tracefile_size
,
1405 msg
.u
.ask_channel
.tracefile_count
,
1406 msg
.u
.ask_channel
.session_id_per_pid
,
1407 msg
.u
.ask_channel
.monitor
,
1408 msg
.u
.ask_channel
.live_timer_interval
,
1409 msg
.u
.ask_channel
.root_shm_path
,
1410 msg
.u
.ask_channel
.shm_path
);
1412 goto end_channel_error
;
1416 * Assign UST application UID to the channel. This value is ignored for
1417 * per PID buffers. This is specific to UST thus setting this after the
1420 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1422 /* Build channel attributes from received message. */
1423 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1424 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1425 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1426 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1427 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1428 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1429 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1430 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1432 /* Match channel buffer type to the UST abi. */
1433 switch (msg
.u
.ask_channel
.output
) {
1434 case LTTNG_EVENT_MMAP
:
1436 attr
.output
= LTTNG_UST_MMAP
;
1440 /* Translate and save channel type. */
1441 switch (msg
.u
.ask_channel
.type
) {
1442 case LTTNG_UST_CHAN_PER_CPU
:
1443 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1444 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1446 * Set refcount to 1 for owner. Below, we will
1447 * pass ownership to the
1448 * consumer_thread_channel_poll() thread.
1450 channel
->refcount
= 1;
1452 case LTTNG_UST_CHAN_METADATA
:
1453 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1454 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1461 health_code_update();
1463 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1465 goto end_channel_error
;
1468 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1469 ret
= consumer_metadata_cache_allocate(channel
);
1471 ERR("Allocating metadata cache");
1472 goto end_channel_error
;
1474 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1475 attr
.switch_timer_interval
= 0;
1477 int monitor_start_ret
;
1479 consumer_timer_live_start(channel
,
1480 msg
.u
.ask_channel
.live_timer_interval
);
1481 monitor_start_ret
= consumer_timer_monitor_start(
1483 msg
.u
.ask_channel
.monitor_timer_interval
);
1484 if (monitor_start_ret
< 0) {
1485 ERR("Starting channel monitoring timer failed");
1486 goto end_channel_error
;
1490 health_code_update();
1493 * Add the channel to the internal state AFTER all streams were created
1494 * and successfully sent to session daemon. This way, all streams must
1495 * be ready before this channel is visible to the threads.
1496 * If add_channel succeeds, ownership of the channel is
1497 * passed to consumer_thread_channel_poll().
1499 ret
= add_channel(channel
, ctx
);
1501 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1502 if (channel
->switch_timer_enabled
== 1) {
1503 consumer_timer_switch_stop(channel
);
1505 consumer_metadata_cache_destroy(channel
);
1507 if (channel
->live_timer_enabled
== 1) {
1508 consumer_timer_live_stop(channel
);
1510 if (channel
->monitor_timer_enabled
== 1) {
1511 consumer_timer_monitor_stop(channel
);
1513 goto end_channel_error
;
1516 health_code_update();
1519 * Channel and streams are now created. Inform the session daemon that
1520 * everything went well and should wait to receive the channel and
1521 * streams with ustctl API.
1523 ret
= consumer_send_status_channel(sock
, channel
);
1526 * There is probably a problem on the socket.
1533 case LTTNG_CONSUMER_GET_CHANNEL
:
1535 int ret
, relayd_err
= 0;
1536 uint64_t key
= msg
.u
.get_channel
.key
;
1537 struct lttng_consumer_channel
*channel
;
1539 channel
= consumer_find_channel(key
);
1541 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1542 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1543 goto end_msg_sessiond
;
1546 health_code_update();
1548 /* Send everything to sessiond. */
1549 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1553 * We were unable to send to the relayd the stream so avoid
1554 * sending back a fatal error to the thread since this is OK
1555 * and the consumer can continue its work. The above call
1556 * has sent the error status message to the sessiond.
1561 * The communicaton was broken hence there is a bad state between
1562 * the consumer and sessiond so stop everything.
1567 health_code_update();
1570 * In no monitor mode, the streams ownership is kept inside the channel
1571 * so don't send them to the data thread.
1573 if (!channel
->monitor
) {
1574 goto end_msg_sessiond
;
1577 ret
= send_streams_to_thread(channel
, ctx
);
1580 * If we are unable to send the stream to the thread, there is
1581 * a big problem so just stop everything.
1585 /* List MUST be empty after or else it could be reused. */
1586 assert(cds_list_empty(&channel
->streams
.head
));
1587 goto end_msg_sessiond
;
1589 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1591 uint64_t key
= msg
.u
.destroy_channel
.key
;
1594 * Only called if streams have not been sent to stream
1595 * manager thread. However, channel has been sent to
1596 * channel manager thread.
1598 notify_thread_del_channel(ctx
, key
);
1599 goto end_msg_sessiond
;
1601 case LTTNG_CONSUMER_CLOSE_METADATA
:
1605 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1610 goto end_msg_sessiond
;
1612 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1616 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1621 goto end_msg_sessiond
;
1623 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1627 ret
= clear_quiescent_channel(
1628 msg
.u
.clear_quiescent_channel
.key
);
1633 goto end_msg_sessiond
;
1635 case LTTNG_CONSUMER_PUSH_METADATA
:
1638 uint64_t len
= msg
.u
.push_metadata
.len
;
1639 uint64_t key
= msg
.u
.push_metadata
.key
;
1640 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1641 uint64_t version
= msg
.u
.push_metadata
.version
;
1642 struct lttng_consumer_channel
*channel
;
1644 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1647 channel
= consumer_find_channel(key
);
1650 * This is possible if the metadata creation on the consumer side
1651 * is in flight vis-a-vis a concurrent push metadata from the
1652 * session daemon. Simply return that the channel failed and the
1653 * session daemon will handle that message correctly considering
1654 * that this race is acceptable thus the DBG() statement here.
1656 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1657 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1658 goto end_msg_sessiond
;
1661 health_code_update();
1665 * There is nothing to receive. We have simply
1666 * checked whether the channel can be found.
1668 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1669 goto end_msg_sessiond
;
1672 /* Tell session daemon we are ready to receive the metadata. */
1673 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1675 /* Somehow, the session daemon is not responding anymore. */
1679 health_code_update();
1681 /* Wait for more data. */
1682 health_poll_entry();
1683 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1689 health_code_update();
1691 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1692 len
, version
, channel
, 0, 1);
1694 /* error receiving from sessiond */
1698 goto end_msg_sessiond
;
1701 case LTTNG_CONSUMER_SETUP_METADATA
:
1705 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1709 goto end_msg_sessiond
;
1711 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1713 if (msg
.u
.snapshot_channel
.metadata
) {
1714 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1715 msg
.u
.snapshot_channel
.pathname
,
1716 msg
.u
.snapshot_channel
.relayd_id
,
1719 ERR("Snapshot metadata failed");
1720 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1723 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1724 msg
.u
.snapshot_channel
.pathname
,
1725 msg
.u
.snapshot_channel
.relayd_id
,
1726 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1729 ERR("Snapshot channel failed");
1730 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1734 health_code_update();
1735 ret
= consumer_send_status_msg(sock
, ret_code
);
1737 /* Somehow, the session daemon is not responding anymore. */
1740 health_code_update();
1743 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1746 uint64_t discarded_events
;
1747 struct lttng_ht_iter iter
;
1748 struct lttng_ht
*ht
;
1749 struct lttng_consumer_stream
*stream
;
1750 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1751 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1753 DBG("UST consumer discarded events command for session id %"
1756 pthread_mutex_lock(&consumer_data
.lock
);
1758 ht
= consumer_data
.stream_list_ht
;
1761 * We only need a reference to the channel, but they are not
1762 * directly indexed, so we just use the first matching stream
1763 * to extract the information we need, we default to 0 if not
1764 * found (no events are dropped if the channel is not yet in
1767 discarded_events
= 0;
1768 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1769 ht
->hash_fct(&id
, lttng_ht_seed
),
1771 &iter
.iter
, stream
, node_session_id
.node
) {
1772 if (stream
->chan
->key
== key
) {
1773 discarded_events
= stream
->chan
->discarded_events
;
1777 pthread_mutex_unlock(&consumer_data
.lock
);
1780 DBG("UST consumer discarded events command for session id %"
1781 PRIu64
", channel key %" PRIu64
, id
, key
);
1783 health_code_update();
1785 /* Send back returned value to session daemon */
1786 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1788 PERROR("send discarded events");
1794 case LTTNG_CONSUMER_LOST_PACKETS
:
1797 uint64_t lost_packets
;
1798 struct lttng_ht_iter iter
;
1799 struct lttng_ht
*ht
;
1800 struct lttng_consumer_stream
*stream
;
1801 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1802 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1804 DBG("UST consumer lost packets command for session id %"
1807 pthread_mutex_lock(&consumer_data
.lock
);
1809 ht
= consumer_data
.stream_list_ht
;
1812 * We only need a reference to the channel, but they are not
1813 * directly indexed, so we just use the first matching stream
1814 * to extract the information we need, we default to 0 if not
1815 * found (no packets lost if the channel is not yet in use).
1818 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1819 ht
->hash_fct(&id
, lttng_ht_seed
),
1821 &iter
.iter
, stream
, node_session_id
.node
) {
1822 if (stream
->chan
->key
== key
) {
1823 lost_packets
= stream
->chan
->lost_packets
;
1827 pthread_mutex_unlock(&consumer_data
.lock
);
1830 DBG("UST consumer lost packets command for session id %"
1831 PRIu64
", channel key %" PRIu64
, id
, key
);
1833 health_code_update();
1835 /* Send back returned value to session daemon */
1836 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1837 sizeof(lost_packets
));
1839 PERROR("send lost packets");
1845 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1847 int channel_monitor_pipe
;
1849 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1850 /* Successfully received the command's type. */
1851 ret
= consumer_send_status_msg(sock
, ret_code
);
1856 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1858 if (ret
!= sizeof(channel_monitor_pipe
)) {
1859 ERR("Failed to receive channel monitor pipe");
1863 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1864 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1865 channel_monitor_pipe
);
1869 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1870 /* Set the pipe as non-blocking. */
1871 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1873 PERROR("fcntl get flags of the channel monitoring pipe");
1878 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1879 flags
| O_NONBLOCK
);
1881 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1884 DBG("Channel monitor pipe set as non-blocking");
1886 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1888 goto end_msg_sessiond
;
1897 health_code_update();
1900 * Return 1 to indicate success since the 0 value can be a socket
1901 * shutdown during the recv() or send() call.
1907 * The returned value here is not useful since either way we'll return 1 to
1908 * the caller because the session daemon socket management is done
1909 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1911 ret
= consumer_send_status_msg(sock
, ret_code
);
1917 health_code_update();
1923 * Free channel here since no one has a reference to it. We don't
1924 * free after that because a stream can store this pointer.
1926 destroy_channel(channel
);
1928 /* We have to send a status channel message indicating an error. */
1929 ret
= consumer_send_status_channel(sock
, NULL
);
1931 /* Stop everything if session daemon can not be notified. */
1936 health_code_update();
1941 /* This will issue a consumer stop. */
1946 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1947 * compiled out, we isolate it in this library.
1949 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1953 assert(stream
->ustream
);
1955 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1959 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1960 * compiled out, we isolate it in this library.
1962 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1965 assert(stream
->ustream
);
1967 return ustctl_get_mmap_base(stream
->ustream
);
1971 * Take a snapshot for a specific stream.
1973 * Returns 0 on success, < 0 on error
1975 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1978 assert(stream
->ustream
);
1980 return ustctl_snapshot(stream
->ustream
);
1984 * Sample consumed and produced positions for a specific stream.
1986 * Returns 0 on success, < 0 on error.
1988 int lttng_ustconsumer_sample_snapshot_positions(
1989 struct lttng_consumer_stream
*stream
)
1992 assert(stream
->ustream
);
1994 return ustctl_snapshot_sample_positions(stream
->ustream
);
1998 * Get the produced position
2000 * Returns 0 on success, < 0 on error
2002 int lttng_ustconsumer_get_produced_snapshot(
2003 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2006 assert(stream
->ustream
);
2009 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2013 * Get the consumed position
2015 * Returns 0 on success, < 0 on error
2017 int lttng_ustconsumer_get_consumed_snapshot(
2018 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2021 assert(stream
->ustream
);
2024 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2027 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2031 assert(stream
->ustream
);
2033 ustctl_flush_buffer(stream
->ustream
, producer
);
2036 int lttng_ustconsumer_get_current_timestamp(
2037 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2040 assert(stream
->ustream
);
2043 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2046 int lttng_ustconsumer_get_sequence_number(
2047 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2050 assert(stream
->ustream
);
2053 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2057 * Called when the stream signals the consumer that it has hung up.
2059 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2062 assert(stream
->ustream
);
2064 pthread_mutex_lock(&stream
->lock
);
2065 if (!stream
->quiescent
) {
2066 ustctl_flush_buffer(stream
->ustream
, 0);
2067 stream
->quiescent
= true;
2069 pthread_mutex_unlock(&stream
->lock
);
2070 stream
->hangup_flush_done
= 1;
2073 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2078 assert(chan
->uchan
);
2080 if (chan
->switch_timer_enabled
== 1) {
2081 consumer_timer_switch_stop(chan
);
2083 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2086 ret
= close(chan
->stream_fds
[i
]);
2090 if (chan
->shm_path
[0]) {
2091 char shm_path
[PATH_MAX
];
2093 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2095 ERR("Cannot get stream shm path");
2097 ret
= run_as_unlink(shm_path
, chan
->uid
, chan
->gid
);
2099 PERROR("unlink %s", shm_path
);
2105 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2108 assert(chan
->uchan
);
2110 consumer_metadata_cache_destroy(chan
);
2111 ustctl_destroy_channel(chan
->uchan
);
2112 /* Try to rmdir all directories under shm_path root. */
2113 if (chan
->root_shm_path
[0]) {
2114 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2115 chan
->uid
, chan
->gid
);
2117 free(chan
->stream_fds
);
2120 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2123 assert(stream
->ustream
);
2125 if (stream
->chan
->switch_timer_enabled
== 1) {
2126 consumer_timer_switch_stop(stream
->chan
);
2128 ustctl_destroy_stream(stream
->ustream
);
2131 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2134 assert(stream
->ustream
);
2136 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2139 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2142 assert(stream
->ustream
);
2144 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2148 * Populate index values of a UST stream. Values are set in big endian order.
2150 * Return 0 on success or else a negative value.
2152 static int get_index_values(struct ctf_packet_index
*index
,
2153 struct ustctl_consumer_stream
*ustream
)
2157 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2159 PERROR("ustctl_get_timestamp_begin");
2162 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2164 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2166 PERROR("ustctl_get_timestamp_end");
2169 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2171 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2173 PERROR("ustctl_get_events_discarded");
2176 index
->events_discarded
= htobe64(index
->events_discarded
);
2178 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2180 PERROR("ustctl_get_content_size");
2183 index
->content_size
= htobe64(index
->content_size
);
2185 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2187 PERROR("ustctl_get_packet_size");
2190 index
->packet_size
= htobe64(index
->packet_size
);
2192 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2194 PERROR("ustctl_get_stream_id");
2197 index
->stream_id
= htobe64(index
->stream_id
);
2199 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2201 PERROR("ustctl_get_instance_id");
2204 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2206 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2208 PERROR("ustctl_get_sequence_number");
2211 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2218 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
,
2219 struct consumer_metadata_cache
*cache
)
2221 DBG("Metadata stream update to version %" PRIu64
,
2223 stream
->ust_metadata_pushed
= 0;
2224 stream
->metadata_version
= cache
->version
;
2225 stream
->reset_metadata_flag
= 1;
2229 * Check if the version of the metadata stream and metadata cache match.
2230 * If the cache got updated, reset the metadata stream.
2231 * The stream lock and metadata cache lock MUST be held.
2232 * Return 0 on success, a negative value on error.
2235 int metadata_stream_check_version(struct lttng_consumer_stream
*stream
)
2238 struct consumer_metadata_cache
*cache
= stream
->chan
->metadata_cache
;
2240 if (cache
->version
== stream
->metadata_version
) {
2243 metadata_stream_reset_cache(stream
, cache
);
2250 * Write up to one packet from the metadata cache to the channel.
2252 * Returns the number of bytes pushed in the cache, or a negative value
2256 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2261 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2262 ret
= metadata_stream_check_version(stream
);
2266 if (stream
->chan
->metadata_cache
->max_offset
2267 == stream
->ust_metadata_pushed
) {
2272 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2273 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2274 stream
->chan
->metadata_cache
->max_offset
2275 - stream
->ust_metadata_pushed
);
2276 assert(write_len
!= 0);
2277 if (write_len
< 0) {
2278 ERR("Writing one metadata packet");
2282 stream
->ust_metadata_pushed
+= write_len
;
2284 assert(stream
->chan
->metadata_cache
->max_offset
>=
2285 stream
->ust_metadata_pushed
);
2289 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2295 * Sync metadata meaning request them to the session daemon and snapshot to the
2296 * metadata thread can consumer them.
2298 * Metadata stream lock is held here, but we need to release it when
2299 * interacting with sessiond, else we cause a deadlock with live
2300 * awaiting on metadata to be pushed out.
2302 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2303 * is empty or a negative value on error.
2305 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2306 struct lttng_consumer_stream
*metadata
)
2314 pthread_mutex_unlock(&metadata
->lock
);
2316 * Request metadata from the sessiond, but don't wait for the flush
2317 * because we locked the metadata thread.
2319 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2320 pthread_mutex_lock(&metadata
->lock
);
2325 ret
= commit_one_metadata_packet(metadata
);
2328 } else if (ret
> 0) {
2332 ustctl_flush_buffer(metadata
->ustream
, 1);
2333 ret
= ustctl_snapshot(metadata
->ustream
);
2335 if (errno
!= EAGAIN
) {
2336 ERR("Sync metadata, taking UST snapshot");
2339 DBG("No new metadata when syncing them.");
2340 /* No new metadata, exit. */
2346 * After this flush, we still need to extract metadata.
2357 * Return 0 on success else a negative value.
2359 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2360 struct lttng_consumer_local_data
*ctx
)
2363 struct ustctl_consumer_stream
*ustream
;
2368 ustream
= stream
->ustream
;
2371 * First, we are going to check if there is a new subbuffer available
2372 * before reading the stream wait_fd.
2374 /* Get the next subbuffer */
2375 ret
= ustctl_get_next_subbuf(ustream
);
2377 /* No more data found, flag the stream. */
2378 stream
->has_data
= 0;
2383 ret
= ustctl_put_subbuf(ustream
);
2386 /* This stream still has data. Flag it and wake up the data thread. */
2387 stream
->has_data
= 1;
2389 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2392 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2393 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2398 /* The wake up pipe has been notified. */
2399 ctx
->has_wakeup
= 1;
2408 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2411 uint64_t seq
, discarded
;
2413 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2415 PERROR("ustctl_get_sequence_number");
2419 * Start the sequence when we extract the first packet in case we don't
2420 * start at 0 (for example if a consumer is not connected to the
2421 * session immediately after the beginning).
2423 if (stream
->last_sequence_number
== -1ULL) {
2424 stream
->last_sequence_number
= seq
;
2425 } else if (seq
> stream
->last_sequence_number
) {
2426 stream
->chan
->lost_packets
+= seq
-
2427 stream
->last_sequence_number
- 1;
2429 /* seq <= last_sequence_number */
2430 ERR("Sequence number inconsistent : prev = %" PRIu64
2431 ", current = %" PRIu64
,
2432 stream
->last_sequence_number
, seq
);
2436 stream
->last_sequence_number
= seq
;
2438 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2440 PERROR("kernctl_get_events_discarded");
2443 if (discarded
< stream
->last_discarded_events
) {
2445 * Overflow has occurred. We assume only one wrap-around
2448 stream
->chan
->discarded_events
+=
2449 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2450 stream
->last_discarded_events
+ discarded
;
2452 stream
->chan
->discarded_events
+= discarded
-
2453 stream
->last_discarded_events
;
2455 stream
->last_discarded_events
= discarded
;
2463 * Read subbuffer from the given stream.
2465 * Stream lock MUST be acquired.
2467 * Return 0 on success else a negative value.
2469 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2470 struct lttng_consumer_local_data
*ctx
)
2472 unsigned long len
, subbuf_size
, padding
;
2473 int err
, write_index
= 1;
2475 struct ustctl_consumer_stream
*ustream
;
2476 struct ctf_packet_index index
;
2479 assert(stream
->ustream
);
2482 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2485 /* Ease our life for what's next. */
2486 ustream
= stream
->ustream
;
2489 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2490 * error if we cannot read this one byte (read returns 0), or if the error
2491 * is EAGAIN or EWOULDBLOCK.
2493 * This is only done when the stream is monitored by a thread, before the
2494 * flush is done after a hangup and if the stream is not flagged with data
2495 * since there might be nothing to consume in the wait fd but still have
2496 * data available flagged by the consumer wake up pipe.
2498 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2502 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2503 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2510 /* Get the next subbuffer */
2511 err
= ustctl_get_next_subbuf(ustream
);
2514 * Populate metadata info if the existing info has
2515 * already been read.
2517 if (stream
->metadata_flag
) {
2518 ret
= commit_one_metadata_packet(stream
);
2522 ustctl_flush_buffer(stream
->ustream
, 1);
2526 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2528 * This is a debug message even for single-threaded consumer,
2529 * because poll() have more relaxed criterions than get subbuf,
2530 * so get_subbuf may fail for short race windows where poll()
2531 * would issue wakeups.
2533 DBG("Reserving sub buffer failed (everything is normal, "
2534 "it is due to concurrency) [ret: %d]", err
);
2537 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2539 if (!stream
->metadata_flag
) {
2540 index
.offset
= htobe64(stream
->out_fd_offset
);
2541 ret
= get_index_values(&index
, ustream
);
2543 err
= ustctl_put_subbuf(ustream
);
2548 /* Update the stream's sequence and discarded events count. */
2549 ret
= update_stream_stats(stream
);
2551 PERROR("kernctl_get_events_discarded");
2552 err
= ustctl_put_subbuf(ustream
);
2560 /* Get the full padded subbuffer size */
2561 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2564 /* Get subbuffer data size (without padding) */
2565 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2568 /* Make sure we don't get a subbuffer size bigger than the padded */
2569 assert(len
>= subbuf_size
);
2571 padding
= len
- subbuf_size
;
2572 /* write the subbuffer to the tracefile */
2573 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2575 * The mmap operation should write subbuf_size amount of data when network
2576 * streaming or the full padding (len) size when we are _not_ streaming.
2578 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2579 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2581 * Display the error but continue processing to try to release the
2582 * subbuffer. This is a DBG statement since any unexpected kill or
2583 * signal, the application gets unregistered, relayd gets closed or
2584 * anything that affects the buffer lifetime will trigger this error.
2585 * So, for the sake of the user, don't print this error since it can
2586 * happen and it is OK with the code flow.
2588 DBG("Error writing to tracefile "
2589 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2590 ret
, len
, subbuf_size
);
2593 err
= ustctl_put_next_subbuf(ustream
);
2597 * This will consumer the byte on the wait_fd if and only if there is not
2598 * next subbuffer to be acquired.
2600 if (!stream
->metadata_flag
) {
2601 ret
= notify_if_more_data(stream
, ctx
);
2607 /* Write index if needed. */
2612 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2614 * In live, block until all the metadata is sent.
2616 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2617 assert(!stream
->missed_metadata_flush
);
2618 stream
->waiting_on_metadata
= true;
2619 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2621 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2623 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2624 stream
->waiting_on_metadata
= false;
2625 if (stream
->missed_metadata_flush
) {
2626 stream
->missed_metadata_flush
= false;
2627 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2628 (void) consumer_flush_ust_index(stream
);
2630 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2638 assert(!stream
->metadata_flag
);
2639 err
= consumer_stream_write_index(stream
, &index
);
2649 * Called when a stream is created.
2651 * Return 0 on success or else a negative value.
2653 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2659 /* Don't create anything if this is set for streaming. */
2660 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2661 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2662 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2663 stream
->uid
, stream
->gid
, NULL
);
2667 stream
->out_fd
= ret
;
2668 stream
->tracefile_size_current
= 0;
2670 if (!stream
->metadata_flag
) {
2671 struct lttng_index_file
*index_file
;
2673 index_file
= lttng_index_file_create(stream
->chan
->pathname
,
2674 stream
->name
, stream
->uid
, stream
->gid
,
2675 stream
->chan
->tracefile_size
,
2676 stream
->tracefile_count_current
,
2677 CTF_INDEX_MAJOR
, CTF_INDEX_MINOR
);
2681 assert(!stream
->index_file
);
2682 stream
->index_file
= index_file
;
2692 * Check if data is still being extracted from the buffers for a specific
2693 * stream. Consumer data lock MUST be acquired before calling this function
2694 * and the stream lock.
2696 * Return 1 if the traced data are still getting read else 0 meaning that the
2697 * data is available for trace viewer reading.
2699 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2704 assert(stream
->ustream
);
2706 DBG("UST consumer checking data pending");
2708 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2713 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2714 uint64_t contiguous
, pushed
;
2716 /* Ease our life a bit. */
2717 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2718 pushed
= stream
->ust_metadata_pushed
;
2721 * We can simply check whether all contiguously available data
2722 * has been pushed to the ring buffer, since the push operation
2723 * is performed within get_next_subbuf(), and because both
2724 * get_next_subbuf() and put_next_subbuf() are issued atomically
2725 * thanks to the stream lock within
2726 * lttng_ustconsumer_read_subbuffer(). This basically means that
2727 * whetnever ust_metadata_pushed is incremented, the associated
2728 * metadata has been consumed from the metadata stream.
2730 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2731 contiguous
, pushed
);
2732 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2733 if ((contiguous
!= pushed
) ||
2734 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2735 ret
= 1; /* Data is pending */
2739 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2742 * There is still data so let's put back this
2745 ret
= ustctl_put_subbuf(stream
->ustream
);
2747 ret
= 1; /* Data is pending */
2752 /* Data is NOT pending so ready to be read. */
2760 * Stop a given metadata channel timer if enabled and close the wait fd which
2761 * is the poll pipe of the metadata stream.
2763 * This MUST be called with the metadata channel acquired.
2765 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2770 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2772 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2774 if (metadata
->switch_timer_enabled
== 1) {
2775 consumer_timer_switch_stop(metadata
);
2778 if (!metadata
->metadata_stream
) {
2783 * Closing write side so the thread monitoring the stream wakes up if any
2784 * and clean the metadata stream.
2786 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2787 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2789 PERROR("closing metadata pipe write side");
2791 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2799 * Close every metadata stream wait fd of the metadata hash table. This
2800 * function MUST be used very carefully so not to run into a race between the
2801 * metadata thread handling streams and this function closing their wait fd.
2803 * For UST, this is used when the session daemon hangs up. Its the metadata
2804 * producer so calling this is safe because we are assured that no state change
2805 * can occur in the metadata thread for the streams in the hash table.
2807 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2809 struct lttng_ht_iter iter
;
2810 struct lttng_consumer_stream
*stream
;
2812 assert(metadata_ht
);
2813 assert(metadata_ht
->ht
);
2815 DBG("UST consumer closing all metadata streams");
2818 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2821 health_code_update();
2823 pthread_mutex_lock(&stream
->chan
->lock
);
2824 lttng_ustconsumer_close_metadata(stream
->chan
);
2825 pthread_mutex_unlock(&stream
->chan
->lock
);
2831 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2835 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2837 ERR("Unable to close wakeup fd");
2842 * Please refer to consumer-timer.c before adding any lock within this
2843 * function or any of its callees. Timers have a very strict locking
2844 * semantic with respect to teardown. Failure to respect this semantic
2845 * introduces deadlocks.
2847 * DON'T hold the metadata lock when calling this function, else this
2848 * can cause deadlock involving consumer awaiting for metadata to be
2849 * pushed out due to concurrent interaction with the session daemon.
2851 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2852 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2854 struct lttcomm_metadata_request_msg request
;
2855 struct lttcomm_consumer_msg msg
;
2856 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2857 uint64_t len
, key
, offset
, version
;
2861 assert(channel
->metadata_cache
);
2863 memset(&request
, 0, sizeof(request
));
2865 /* send the metadata request to sessiond */
2866 switch (consumer_data
.type
) {
2867 case LTTNG_CONSUMER64_UST
:
2868 request
.bits_per_long
= 64;
2870 case LTTNG_CONSUMER32_UST
:
2871 request
.bits_per_long
= 32;
2874 request
.bits_per_long
= 0;
2878 request
.session_id
= channel
->session_id
;
2879 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2881 * Request the application UID here so the metadata of that application can
2882 * be sent back. The channel UID corresponds to the user UID of the session
2883 * used for the rights on the stream file(s).
2885 request
.uid
= channel
->ust_app_uid
;
2886 request
.key
= channel
->key
;
2888 DBG("Sending metadata request to sessiond, session id %" PRIu64
2889 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2890 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2893 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2895 health_code_update();
2897 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2900 ERR("Asking metadata to sessiond");
2904 health_code_update();
2906 /* Receive the metadata from sessiond */
2907 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2909 if (ret
!= sizeof(msg
)) {
2910 DBG("Consumer received unexpected message size %d (expects %zu)",
2912 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2914 * The ret value might 0 meaning an orderly shutdown but this is ok
2915 * since the caller handles this.
2920 health_code_update();
2922 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2923 /* No registry found */
2924 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2928 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2929 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2934 len
= msg
.u
.push_metadata
.len
;
2935 key
= msg
.u
.push_metadata
.key
;
2936 offset
= msg
.u
.push_metadata
.target_offset
;
2937 version
= msg
.u
.push_metadata
.version
;
2939 assert(key
== channel
->key
);
2941 DBG("No new metadata to receive for key %" PRIu64
, key
);
2944 health_code_update();
2946 /* Tell session daemon we are ready to receive the metadata. */
2947 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2948 LTTCOMM_CONSUMERD_SUCCESS
);
2949 if (ret
< 0 || len
== 0) {
2951 * Somehow, the session daemon is not responding anymore or there is
2952 * nothing to receive.
2957 health_code_update();
2959 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2960 key
, offset
, len
, version
, channel
, timer
, wait
);
2963 * Only send the status msg if the sessiond is alive meaning a positive
2966 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2971 health_code_update();
2973 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2978 * Return the ustctl call for the get stream id.
2980 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2981 uint64_t *stream_id
)
2986 return ustctl_get_stream_id(stream
->ustream
, stream_id
);