2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@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, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
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.
27 #include <sys/socket.h>
28 #include <sys/types.h>
33 #include <common/common.h>
34 #include <common/utils.h>
35 #include <common/compat/poll.h>
36 #include <common/kernel-ctl/kernel-ctl.h>
37 #include <common/sessiond-comm/relayd.h>
38 #include <common/sessiond-comm/sessiond-comm.h>
39 #include <common/kernel-consumer/kernel-consumer.h>
40 #include <common/relayd/relayd.h>
41 #include <common/ust-consumer/ust-consumer.h>
45 struct lttng_consumer_global_data consumer_data
= {
48 .type
= LTTNG_CONSUMER_UNKNOWN
,
51 enum consumer_channel_action
{
54 CONSUMER_CHANNEL_QUIT
,
57 struct consumer_channel_msg
{
58 enum consumer_channel_action action
;
59 struct lttng_consumer_channel
*chan
; /* add */
60 uint64_t key
; /* del */
64 * Flag to inform the polling thread to quit when all fd hung up. Updated by
65 * the consumer_thread_receive_fds when it notices that all fds has hung up.
66 * Also updated by the signal handler (consumer_should_exit()). Read by the
69 volatile int consumer_quit
;
72 * Global hash table containing respectively metadata and data streams. The
73 * stream element in this ht should only be updated by the metadata poll thread
74 * for the metadata and the data poll thread for the data.
76 static struct lttng_ht
*metadata_ht
;
77 static struct lttng_ht
*data_ht
;
80 * Notify a thread lttng pipe to poll back again. This usually means that some
81 * global state has changed so we just send back the thread in a poll wait
84 static void notify_thread_lttng_pipe(struct lttng_pipe
*pipe
)
86 struct lttng_consumer_stream
*null_stream
= NULL
;
90 (void) lttng_pipe_write(pipe
, &null_stream
, sizeof(null_stream
));
93 static void notify_channel_pipe(struct lttng_consumer_local_data
*ctx
,
94 struct lttng_consumer_channel
*chan
,
96 enum consumer_channel_action action
)
98 struct consumer_channel_msg msg
;
101 memset(&msg
, 0, sizeof(msg
));
107 ret
= write(ctx
->consumer_channel_pipe
[1], &msg
, sizeof(msg
));
108 } while (ret
< 0 && errno
== EINTR
);
111 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
114 notify_channel_pipe(ctx
, NULL
, key
, CONSUMER_CHANNEL_DEL
);
117 static int read_channel_pipe(struct lttng_consumer_local_data
*ctx
,
118 struct lttng_consumer_channel
**chan
,
120 enum consumer_channel_action
*action
)
122 struct consumer_channel_msg msg
;
126 ret
= read(ctx
->consumer_channel_pipe
[0], &msg
, sizeof(msg
));
127 } while (ret
< 0 && errno
== EINTR
);
129 *action
= msg
.action
;
137 * Find a stream. The consumer_data.lock must be locked during this
140 static struct lttng_consumer_stream
*find_stream(uint64_t key
,
143 struct lttng_ht_iter iter
;
144 struct lttng_ht_node_u64
*node
;
145 struct lttng_consumer_stream
*stream
= NULL
;
149 /* -1ULL keys are lookup failures */
150 if (key
== (uint64_t) -1ULL) {
156 lttng_ht_lookup(ht
, &key
, &iter
);
157 node
= lttng_ht_iter_get_node_u64(&iter
);
159 stream
= caa_container_of(node
, struct lttng_consumer_stream
, node
);
167 static void steal_stream_key(uint64_t key
, struct lttng_ht
*ht
)
169 struct lttng_consumer_stream
*stream
;
172 stream
= find_stream(key
, ht
);
174 stream
->key
= (uint64_t) -1ULL;
176 * We don't want the lookup to match, but we still need
177 * to iterate on this stream when iterating over the hash table. Just
178 * change the node key.
180 stream
->node
.key
= (uint64_t) -1ULL;
186 * Return a channel object for the given key.
188 * RCU read side lock MUST be acquired before calling this function and
189 * protects the channel ptr.
191 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
)
193 struct lttng_ht_iter iter
;
194 struct lttng_ht_node_u64
*node
;
195 struct lttng_consumer_channel
*channel
= NULL
;
197 /* -1ULL keys are lookup failures */
198 if (key
== (uint64_t) -1ULL) {
202 lttng_ht_lookup(consumer_data
.channel_ht
, &key
, &iter
);
203 node
= lttng_ht_iter_get_node_u64(&iter
);
205 channel
= caa_container_of(node
, struct lttng_consumer_channel
, node
);
211 static void free_stream_rcu(struct rcu_head
*head
)
213 struct lttng_ht_node_u64
*node
=
214 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
215 struct lttng_consumer_stream
*stream
=
216 caa_container_of(node
, struct lttng_consumer_stream
, node
);
221 static void free_channel_rcu(struct rcu_head
*head
)
223 struct lttng_ht_node_u64
*node
=
224 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
225 struct lttng_consumer_channel
*channel
=
226 caa_container_of(node
, struct lttng_consumer_channel
, node
);
232 * RCU protected relayd socket pair free.
234 static void free_relayd_rcu(struct rcu_head
*head
)
236 struct lttng_ht_node_u64
*node
=
237 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
238 struct consumer_relayd_sock_pair
*relayd
=
239 caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
242 * Close all sockets. This is done in the call RCU since we don't want the
243 * socket fds to be reassigned thus potentially creating bad state of the
246 * We do not have to lock the control socket mutex here since at this stage
247 * there is no one referencing to this relayd object.
249 (void) relayd_close(&relayd
->control_sock
);
250 (void) relayd_close(&relayd
->data_sock
);
256 * Destroy and free relayd socket pair object.
258 * This function MUST be called with the consumer_data lock acquired.
260 static void destroy_relayd(struct consumer_relayd_sock_pair
*relayd
)
263 struct lttng_ht_iter iter
;
265 if (relayd
== NULL
) {
269 DBG("Consumer destroy and close relayd socket pair");
271 iter
.iter
.node
= &relayd
->node
.node
;
272 ret
= lttng_ht_del(consumer_data
.relayd_ht
, &iter
);
274 /* We assume the relayd is being or is destroyed */
278 /* RCU free() call */
279 call_rcu(&relayd
->node
.head
, free_relayd_rcu
);
283 * Remove a channel from the global list protected by a mutex. This function is
284 * also responsible for freeing its data structures.
286 void consumer_del_channel(struct lttng_consumer_channel
*channel
)
289 struct lttng_ht_iter iter
;
290 struct lttng_consumer_stream
*stream
, *stmp
;
292 DBG("Consumer delete channel key %" PRIu64
, channel
->key
);
294 pthread_mutex_lock(&consumer_data
.lock
);
295 pthread_mutex_lock(&channel
->lock
);
297 switch (consumer_data
.type
) {
298 case LTTNG_CONSUMER_KERNEL
:
300 case LTTNG_CONSUMER32_UST
:
301 case LTTNG_CONSUMER64_UST
:
302 /* Delete streams that might have been left in the stream list. */
303 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
305 cds_list_del(&stream
->send_node
);
306 lttng_ustconsumer_del_stream(stream
);
309 lttng_ustconsumer_del_channel(channel
);
312 ERR("Unknown consumer_data type");
318 iter
.iter
.node
= &channel
->node
.node
;
319 ret
= lttng_ht_del(consumer_data
.channel_ht
, &iter
);
323 call_rcu(&channel
->node
.head
, free_channel_rcu
);
325 pthread_mutex_unlock(&channel
->lock
);
326 pthread_mutex_unlock(&consumer_data
.lock
);
330 * Iterate over the relayd hash table and destroy each element. Finally,
331 * destroy the whole hash table.
333 static void cleanup_relayd_ht(void)
335 struct lttng_ht_iter iter
;
336 struct consumer_relayd_sock_pair
*relayd
;
340 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
342 destroy_relayd(relayd
);
347 lttng_ht_destroy(consumer_data
.relayd_ht
);
351 * Update the end point status of all streams having the given network sequence
352 * index (relayd index).
354 * It's atomically set without having the stream mutex locked which is fine
355 * because we handle the write/read race with a pipe wakeup for each thread.
357 static void update_endpoint_status_by_netidx(uint64_t net_seq_idx
,
358 enum consumer_endpoint_status status
)
360 struct lttng_ht_iter iter
;
361 struct lttng_consumer_stream
*stream
;
363 DBG("Consumer set delete flag on stream by idx %" PRIu64
, net_seq_idx
);
367 /* Let's begin with metadata */
368 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
369 if (stream
->net_seq_idx
== net_seq_idx
) {
370 uatomic_set(&stream
->endpoint_status
, status
);
371 DBG("Delete flag set to metadata stream %d", stream
->wait_fd
);
375 /* Follow up by the data streams */
376 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
377 if (stream
->net_seq_idx
== net_seq_idx
) {
378 uatomic_set(&stream
->endpoint_status
, status
);
379 DBG("Delete flag set to data stream %d", stream
->wait_fd
);
386 * Cleanup a relayd object by flagging every associated streams for deletion,
387 * destroying the object meaning removing it from the relayd hash table,
388 * closing the sockets and freeing the memory in a RCU call.
390 * If a local data context is available, notify the threads that the streams'
391 * state have changed.
393 static void cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
,
394 struct lttng_consumer_local_data
*ctx
)
400 DBG("Cleaning up relayd sockets");
402 /* Save the net sequence index before destroying the object */
403 netidx
= relayd
->net_seq_idx
;
406 * Delete the relayd from the relayd hash table, close the sockets and free
407 * the object in a RCU call.
409 destroy_relayd(relayd
);
411 /* Set inactive endpoint to all streams */
412 update_endpoint_status_by_netidx(netidx
, CONSUMER_ENDPOINT_INACTIVE
);
415 * With a local data context, notify the threads that the streams' state
416 * have changed. The write() action on the pipe acts as an "implicit"
417 * memory barrier ordering the updates of the end point status from the
418 * read of this status which happens AFTER receiving this notify.
421 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
422 notify_thread_lttng_pipe(ctx
->consumer_metadata_pipe
);
427 * Flag a relayd socket pair for destruction. Destroy it if the refcount
430 * RCU read side lock MUST be aquired before calling this function.
432 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair
*relayd
)
436 /* Set destroy flag for this object */
437 uatomic_set(&relayd
->destroy_flag
, 1);
439 /* Destroy the relayd if refcount is 0 */
440 if (uatomic_read(&relayd
->refcount
) == 0) {
441 destroy_relayd(relayd
);
446 * Remove a stream from the global list protected by a mutex. This
447 * function is also responsible for freeing its data structures.
449 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
453 struct lttng_ht_iter iter
;
454 struct lttng_consumer_channel
*free_chan
= NULL
;
455 struct consumer_relayd_sock_pair
*relayd
;
459 DBG("Consumer del stream %d", stream
->wait_fd
);
462 /* Means the stream was allocated but not successfully added */
463 goto free_stream_rcu
;
466 pthread_mutex_lock(&consumer_data
.lock
);
467 pthread_mutex_lock(&stream
->lock
);
469 switch (consumer_data
.type
) {
470 case LTTNG_CONSUMER_KERNEL
:
471 if (stream
->mmap_base
!= NULL
) {
472 ret
= munmap(stream
->mmap_base
, stream
->mmap_len
);
478 if (stream
->wait_fd
>= 0) {
479 ret
= close(stream
->wait_fd
);
485 case LTTNG_CONSUMER32_UST
:
486 case LTTNG_CONSUMER64_UST
:
487 lttng_ustconsumer_del_stream(stream
);
490 ERR("Unknown consumer_data type");
496 iter
.iter
.node
= &stream
->node
.node
;
497 ret
= lttng_ht_del(ht
, &iter
);
500 iter
.iter
.node
= &stream
->node_channel_id
.node
;
501 ret
= lttng_ht_del(consumer_data
.stream_per_chan_id_ht
, &iter
);
504 iter
.iter
.node
= &stream
->node_session_id
.node
;
505 ret
= lttng_ht_del(consumer_data
.stream_list_ht
, &iter
);
509 assert(consumer_data
.stream_count
> 0);
510 consumer_data
.stream_count
--;
512 if (stream
->out_fd
>= 0) {
513 ret
= close(stream
->out_fd
);
519 /* Check and cleanup relayd */
521 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
522 if (relayd
!= NULL
) {
523 uatomic_dec(&relayd
->refcount
);
524 assert(uatomic_read(&relayd
->refcount
) >= 0);
526 /* Closing streams requires to lock the control socket. */
527 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
528 ret
= relayd_send_close_stream(&relayd
->control_sock
,
529 stream
->relayd_stream_id
,
530 stream
->next_net_seq_num
- 1);
531 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
533 DBG("Unable to close stream on the relayd. Continuing");
535 * Continue here. There is nothing we can do for the relayd.
536 * Chances are that the relayd has closed the socket so we just
537 * continue cleaning up.
541 /* Both conditions are met, we destroy the relayd. */
542 if (uatomic_read(&relayd
->refcount
) == 0 &&
543 uatomic_read(&relayd
->destroy_flag
)) {
544 destroy_relayd(relayd
);
549 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1)
550 && !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
551 free_chan
= stream
->chan
;
555 consumer_data
.need_update
= 1;
556 pthread_mutex_unlock(&stream
->lock
);
557 pthread_mutex_unlock(&consumer_data
.lock
);
560 consumer_del_channel(free_chan
);
564 call_rcu(&stream
->node
.head
, free_stream_rcu
);
567 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
569 enum lttng_consumer_stream_state state
,
570 const char *channel_name
,
577 enum consumer_channel_type type
)
580 struct lttng_consumer_stream
*stream
;
582 stream
= zmalloc(sizeof(*stream
));
583 if (stream
== NULL
) {
584 PERROR("malloc struct lttng_consumer_stream");
591 stream
->key
= stream_key
;
593 stream
->out_fd_offset
= 0;
594 stream
->state
= state
;
597 stream
->net_seq_idx
= relayd_id
;
598 stream
->session_id
= session_id
;
599 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
600 pthread_mutex_init(&stream
->lock
, NULL
);
602 /* If channel is the metadata, flag this stream as metadata. */
603 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
604 stream
->metadata_flag
= 1;
605 /* Metadata is flat out. */
606 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
608 /* Format stream name to <channel_name>_<cpu_number> */
609 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
612 PERROR("snprintf stream name");
617 /* Key is always the wait_fd for streams. */
618 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
620 /* Init node per channel id key */
621 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
623 /* Init session id node with the stream session id */
624 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
626 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
" relayd_id %" PRIu64
", session_id %" PRIu64
,
627 stream
->name
, stream
->key
, channel_key
, stream
->net_seq_idx
, stream
->session_id
);
643 * Add a stream to the global list protected by a mutex.
645 static int add_stream(struct lttng_consumer_stream
*stream
,
649 struct consumer_relayd_sock_pair
*relayd
;
654 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
656 pthread_mutex_lock(&consumer_data
.lock
);
657 pthread_mutex_lock(&stream
->chan
->lock
);
658 pthread_mutex_lock(&stream
->lock
);
661 /* Steal stream identifier to avoid having streams with the same key */
662 steal_stream_key(stream
->key
, ht
);
664 lttng_ht_add_unique_u64(ht
, &stream
->node
);
666 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
667 &stream
->node_channel_id
);
670 * Add stream to the stream_list_ht of the consumer data. No need to steal
671 * the key since the HT does not use it and we allow to add redundant keys
674 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
676 /* Check and cleanup relayd */
677 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
678 if (relayd
!= NULL
) {
679 uatomic_inc(&relayd
->refcount
);
683 * When nb_init_stream_left reaches 0, we don't need to trigger any action
684 * in terms of destroying the associated channel, because the action that
685 * causes the count to become 0 also causes a stream to be added. The
686 * channel deletion will thus be triggered by the following removal of this
689 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
690 /* Increment refcount before decrementing nb_init_stream_left */
692 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
695 /* Update consumer data once the node is inserted. */
696 consumer_data
.stream_count
++;
697 consumer_data
.need_update
= 1;
700 pthread_mutex_unlock(&stream
->lock
);
701 pthread_mutex_unlock(&stream
->chan
->lock
);
702 pthread_mutex_unlock(&consumer_data
.lock
);
708 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
709 * be acquired before calling this.
711 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
714 struct lttng_ht_node_u64
*node
;
715 struct lttng_ht_iter iter
;
719 lttng_ht_lookup(consumer_data
.relayd_ht
,
720 &relayd
->net_seq_idx
, &iter
);
721 node
= lttng_ht_iter_get_node_u64(&iter
);
725 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
732 * Allocate and return a consumer relayd socket.
734 struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
735 uint64_t net_seq_idx
)
737 struct consumer_relayd_sock_pair
*obj
= NULL
;
739 /* net sequence index of -1 is a failure */
740 if (net_seq_idx
== (uint64_t) -1ULL) {
744 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
746 PERROR("zmalloc relayd sock");
750 obj
->net_seq_idx
= net_seq_idx
;
752 obj
->destroy_flag
= 0;
753 obj
->control_sock
.sock
.fd
= -1;
754 obj
->data_sock
.sock
.fd
= -1;
755 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
756 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
763 * Find a relayd socket pair in the global consumer data.
765 * Return the object if found else NULL.
766 * RCU read-side lock must be held across this call and while using the
769 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
771 struct lttng_ht_iter iter
;
772 struct lttng_ht_node_u64
*node
;
773 struct consumer_relayd_sock_pair
*relayd
= NULL
;
775 /* Negative keys are lookup failures */
776 if (key
== (uint64_t) -1ULL) {
780 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
782 node
= lttng_ht_iter_get_node_u64(&iter
);
784 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
792 * Handle stream for relayd transmission if the stream applies for network
793 * streaming where the net sequence index is set.
795 * Return destination file descriptor or negative value on error.
797 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
798 size_t data_size
, unsigned long padding
,
799 struct consumer_relayd_sock_pair
*relayd
)
802 struct lttcomm_relayd_data_hdr data_hdr
;
808 /* Reset data header */
809 memset(&data_hdr
, 0, sizeof(data_hdr
));
811 if (stream
->metadata_flag
) {
812 /* Caller MUST acquire the relayd control socket lock */
813 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
818 /* Metadata are always sent on the control socket. */
819 outfd
= relayd
->control_sock
.sock
.fd
;
821 /* Set header with stream information */
822 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
823 data_hdr
.data_size
= htobe32(data_size
);
824 data_hdr
.padding_size
= htobe32(padding
);
826 * Note that net_seq_num below is assigned with the *current* value of
827 * next_net_seq_num and only after that the next_net_seq_num will be
828 * increment. This is why when issuing a command on the relayd using
829 * this next value, 1 should always be substracted in order to compare
830 * the last seen sequence number on the relayd side to the last sent.
832 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
833 /* Other fields are zeroed previously */
835 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
841 ++stream
->next_net_seq_num
;
843 /* Set to go on data socket */
844 outfd
= relayd
->data_sock
.sock
.fd
;
852 * Allocate and return a new lttng_consumer_channel object using the given key
853 * to initialize the hash table node.
855 * On error, return NULL.
857 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
859 const char *pathname
,
864 enum lttng_event_output output
,
865 uint64_t tracefile_size
,
866 uint64_t tracefile_count
,
867 uint64_t session_id_per_pid
)
869 struct lttng_consumer_channel
*channel
;
871 channel
= zmalloc(sizeof(*channel
));
872 if (channel
== NULL
) {
873 PERROR("malloc struct lttng_consumer_channel");
878 channel
->refcount
= 0;
879 channel
->session_id
= session_id
;
880 channel
->session_id_per_pid
= session_id_per_pid
;
883 channel
->relayd_id
= relayd_id
;
884 channel
->output
= output
;
885 channel
->tracefile_size
= tracefile_size
;
886 channel
->tracefile_count
= tracefile_count
;
887 pthread_mutex_init(&channel
->lock
, NULL
);
889 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
890 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
892 strncpy(channel
->name
, name
, sizeof(channel
->name
));
893 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
895 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
897 channel
->wait_fd
= -1;
899 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
901 DBG("Allocated channel (key %" PRIu64
")", channel
->key
)
908 * Add a channel to the global list protected by a mutex.
910 * On success 0 is returned else a negative value.
912 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
913 struct lttng_consumer_local_data
*ctx
)
916 struct lttng_ht_node_u64
*node
;
917 struct lttng_ht_iter iter
;
919 pthread_mutex_lock(&consumer_data
.lock
);
920 pthread_mutex_lock(&channel
->lock
);
923 lttng_ht_lookup(consumer_data
.channel_ht
, &channel
->key
, &iter
);
924 node
= lttng_ht_iter_get_node_u64(&iter
);
926 /* Channel already exist. Ignore the insertion */
927 ERR("Consumer add channel key %" PRIu64
" already exists!",
933 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
937 pthread_mutex_unlock(&channel
->lock
);
938 pthread_mutex_unlock(&consumer_data
.lock
);
940 if (!ret
&& channel
->wait_fd
!= -1 &&
941 channel
->metadata_stream
== NULL
) {
942 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
948 * Allocate the pollfd structure and the local view of the out fds to avoid
949 * doing a lookup in the linked list and concurrency issues when writing is
950 * needed. Called with consumer_data.lock held.
952 * Returns the number of fds in the structures.
954 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
955 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
959 struct lttng_ht_iter iter
;
960 struct lttng_consumer_stream
*stream
;
965 assert(local_stream
);
967 DBG("Updating poll fd array");
969 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
971 * Only active streams with an active end point can be added to the
972 * poll set and local stream storage of the thread.
974 * There is a potential race here for endpoint_status to be updated
975 * just after the check. However, this is OK since the stream(s) will
976 * be deleted once the thread is notified that the end point state has
977 * changed where this function will be called back again.
979 if (stream
->state
!= LTTNG_CONSUMER_ACTIVE_STREAM
||
980 stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
984 * This clobbers way too much the debug output. Uncomment that if you
985 * need it for debugging purposes.
987 * DBG("Active FD %d", stream->wait_fd);
989 (*pollfd
)[i
].fd
= stream
->wait_fd
;
990 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
991 local_stream
[i
] = stream
;
997 * Insert the consumer_data_pipe at the end of the array and don't
998 * increment i so nb_fd is the number of real FD.
1000 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
1001 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1006 * Poll on the should_quit pipe and the command socket return -1 on error and
1007 * should exit, 0 if data is available on the command socket
1009 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
1014 num_rdy
= poll(consumer_sockpoll
, 2, -1);
1015 if (num_rdy
== -1) {
1017 * Restart interrupted system call.
1019 if (errno
== EINTR
) {
1022 PERROR("Poll error");
1025 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
1026 DBG("consumer_should_quit wake up");
1036 * Set the error socket.
1038 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1041 ctx
->consumer_error_socket
= sock
;
1045 * Set the command socket path.
1047 void lttng_consumer_set_command_sock_path(
1048 struct lttng_consumer_local_data
*ctx
, char *sock
)
1050 ctx
->consumer_command_sock_path
= sock
;
1054 * Send return code to the session daemon.
1055 * If the socket is not defined, we return 0, it is not a fatal error
1057 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1059 if (ctx
->consumer_error_socket
> 0) {
1060 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1061 sizeof(enum lttcomm_sessiond_command
));
1068 * Close all the tracefiles and stream fds and MUST be called when all
1069 * instances are destroyed i.e. when all threads were joined and are ended.
1071 void lttng_consumer_cleanup(void)
1073 struct lttng_ht_iter iter
;
1074 struct lttng_consumer_channel
*channel
;
1078 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1080 consumer_del_channel(channel
);
1085 lttng_ht_destroy(consumer_data
.channel_ht
);
1087 cleanup_relayd_ht();
1089 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1092 * This HT contains streams that are freed by either the metadata thread or
1093 * the data thread so we do *nothing* on the hash table and simply destroy
1096 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1100 * Called from signal handler.
1102 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1107 ret
= write(ctx
->consumer_should_quit
[1], "4", 1);
1108 } while (ret
< 0 && errno
== EINTR
);
1109 if (ret
< 0 || ret
!= 1) {
1110 PERROR("write consumer quit");
1113 DBG("Consumer flag that it should quit");
1116 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1119 int outfd
= stream
->out_fd
;
1122 * This does a blocking write-and-wait on any page that belongs to the
1123 * subbuffer prior to the one we just wrote.
1124 * Don't care about error values, as these are just hints and ways to
1125 * limit the amount of page cache used.
1127 if (orig_offset
< stream
->max_sb_size
) {
1130 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1131 stream
->max_sb_size
,
1132 SYNC_FILE_RANGE_WAIT_BEFORE
1133 | SYNC_FILE_RANGE_WRITE
1134 | SYNC_FILE_RANGE_WAIT_AFTER
);
1136 * Give hints to the kernel about how we access the file:
1137 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1140 * We need to call fadvise again after the file grows because the
1141 * kernel does not seem to apply fadvise to non-existing parts of the
1144 * Call fadvise _after_ having waited for the page writeback to
1145 * complete because the dirty page writeback semantic is not well
1146 * defined. So it can be expected to lead to lower throughput in
1149 posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1150 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1154 * Initialise the necessary environnement :
1155 * - create a new context
1156 * - create the poll_pipe
1157 * - create the should_quit pipe (for signal handler)
1158 * - create the thread pipe (for splice)
1160 * Takes a function pointer as argument, this function is called when data is
1161 * available on a buffer. This function is responsible to do the
1162 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1163 * buffer configuration and then kernctl_put_next_subbuf at the end.
1165 * Returns a pointer to the new context or NULL on error.
1167 struct lttng_consumer_local_data
*lttng_consumer_create(
1168 enum lttng_consumer_type type
,
1169 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1170 struct lttng_consumer_local_data
*ctx
),
1171 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1172 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1173 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1176 struct lttng_consumer_local_data
*ctx
;
1178 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1179 consumer_data
.type
== type
);
1180 consumer_data
.type
= type
;
1182 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1184 PERROR("allocating context");
1188 ctx
->consumer_error_socket
= -1;
1189 ctx
->consumer_metadata_socket
= -1;
1190 /* assign the callbacks */
1191 ctx
->on_buffer_ready
= buffer_ready
;
1192 ctx
->on_recv_channel
= recv_channel
;
1193 ctx
->on_recv_stream
= recv_stream
;
1194 ctx
->on_update_stream
= update_stream
;
1196 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1197 if (!ctx
->consumer_data_pipe
) {
1198 goto error_poll_pipe
;
1201 ret
= pipe(ctx
->consumer_should_quit
);
1203 PERROR("Error creating recv pipe");
1204 goto error_quit_pipe
;
1207 ret
= pipe(ctx
->consumer_thread_pipe
);
1209 PERROR("Error creating thread pipe");
1210 goto error_thread_pipe
;
1213 ret
= pipe(ctx
->consumer_channel_pipe
);
1215 PERROR("Error creating channel pipe");
1216 goto error_channel_pipe
;
1219 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1220 if (!ctx
->consumer_metadata_pipe
) {
1221 goto error_metadata_pipe
;
1224 ret
= utils_create_pipe(ctx
->consumer_splice_metadata_pipe
);
1226 goto error_splice_pipe
;
1232 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1233 error_metadata_pipe
:
1234 utils_close_pipe(ctx
->consumer_channel_pipe
);
1236 utils_close_pipe(ctx
->consumer_thread_pipe
);
1238 utils_close_pipe(ctx
->consumer_should_quit
);
1240 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1248 * Close all fds associated with the instance and free the context.
1250 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1254 DBG("Consumer destroying it. Closing everything.");
1256 ret
= close(ctx
->consumer_error_socket
);
1260 ret
= close(ctx
->consumer_metadata_socket
);
1264 utils_close_pipe(ctx
->consumer_thread_pipe
);
1265 utils_close_pipe(ctx
->consumer_channel_pipe
);
1266 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1267 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1268 utils_close_pipe(ctx
->consumer_should_quit
);
1269 utils_close_pipe(ctx
->consumer_splice_metadata_pipe
);
1271 unlink(ctx
->consumer_command_sock_path
);
1276 * Write the metadata stream id on the specified file descriptor.
1278 static int write_relayd_metadata_id(int fd
,
1279 struct lttng_consumer_stream
*stream
,
1280 struct consumer_relayd_sock_pair
*relayd
, unsigned long padding
)
1283 struct lttcomm_relayd_metadata_payload hdr
;
1285 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1286 hdr
.padding_size
= htobe32(padding
);
1288 ret
= write(fd
, (void *) &hdr
, sizeof(hdr
));
1289 } while (ret
< 0 && errno
== EINTR
);
1290 if (ret
< 0 || ret
!= sizeof(hdr
)) {
1292 * This error means that the fd's end is closed so ignore the perror
1293 * not to clubber the error output since this can happen in a normal
1296 if (errno
!= EPIPE
) {
1297 PERROR("write metadata stream id");
1299 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1301 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1302 * handle writting the missing part so report that as an error and
1303 * don't lie to the caller.
1308 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1309 stream
->relayd_stream_id
, padding
);
1316 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1317 * core function for writing trace buffers to either the local filesystem or
1320 * It must be called with the stream lock held.
1322 * Careful review MUST be put if any changes occur!
1324 * Returns the number of bytes written
1326 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1327 struct lttng_consumer_local_data
*ctx
,
1328 struct lttng_consumer_stream
*stream
, unsigned long len
,
1329 unsigned long padding
)
1331 unsigned long mmap_offset
;
1333 ssize_t ret
= 0, written
= 0;
1334 off_t orig_offset
= stream
->out_fd_offset
;
1335 /* Default is on the disk */
1336 int outfd
= stream
->out_fd
;
1337 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1338 unsigned int relayd_hang_up
= 0;
1340 /* RCU lock for the relayd pointer */
1343 /* Flag that the current stream if set for network streaming. */
1344 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1345 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1346 if (relayd
== NULL
) {
1351 /* get the offset inside the fd to mmap */
1352 switch (consumer_data
.type
) {
1353 case LTTNG_CONSUMER_KERNEL
:
1354 mmap_base
= stream
->mmap_base
;
1355 ret
= kernctl_get_mmap_read_offset(stream
->wait_fd
, &mmap_offset
);
1357 case LTTNG_CONSUMER32_UST
:
1358 case LTTNG_CONSUMER64_UST
:
1359 mmap_base
= lttng_ustctl_get_mmap_base(stream
);
1361 ERR("read mmap get mmap base for stream %s", stream
->name
);
1365 ret
= lttng_ustctl_get_mmap_read_offset(stream
, &mmap_offset
);
1369 ERR("Unknown consumer_data type");
1374 PERROR("tracer ctl get_mmap_read_offset");
1379 /* Handle stream on the relayd if the output is on the network */
1381 unsigned long netlen
= len
;
1384 * Lock the control socket for the complete duration of the function
1385 * since from this point on we will use the socket.
1387 if (stream
->metadata_flag
) {
1388 /* Metadata requires the control socket. */
1389 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1390 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1393 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1395 /* Use the returned socket. */
1398 /* Write metadata stream id before payload */
1399 if (stream
->metadata_flag
) {
1400 ret
= write_relayd_metadata_id(outfd
, stream
, relayd
, padding
);
1403 /* Socket operation failed. We consider the relayd dead */
1404 if (ret
== -EPIPE
|| ret
== -EINVAL
) {
1412 /* Socket operation failed. We consider the relayd dead */
1413 if (ret
== -EPIPE
|| ret
== -EINVAL
) {
1417 /* Else, use the default set before which is the filesystem. */
1420 /* No streaming, we have to set the len with the full padding */
1424 * Check if we need to change the tracefile before writing the packet.
1426 if (stream
->chan
->tracefile_size
> 0 &&
1427 (stream
->tracefile_size_current
+ len
) >
1428 stream
->chan
->tracefile_size
) {
1429 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1430 stream
->name
, stream
->chan
->tracefile_size
,
1431 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1432 stream
->out_fd
, &(stream
->tracefile_count_current
));
1434 ERR("Rotating output file");
1437 outfd
= stream
->out_fd
= ret
;
1438 /* Reset current size because we just perform a rotation. */
1439 stream
->tracefile_size_current
= 0;
1441 stream
->tracefile_size_current
+= len
;
1446 ret
= write(outfd
, mmap_base
+ mmap_offset
, len
);
1447 } while (ret
< 0 && errno
== EINTR
);
1448 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, len
);
1451 * This is possible if the fd is closed on the other side (outfd)
1452 * or any write problem. It can be verbose a bit for a normal
1453 * execution if for instance the relayd is stopped abruptly. This
1454 * can happen so set this to a DBG statement.
1456 DBG("Error in file write mmap");
1460 /* Socket operation failed. We consider the relayd dead */
1461 if (errno
== EPIPE
|| errno
== EINVAL
) {
1466 } else if (ret
> len
) {
1467 PERROR("Error in file write (ret %zd > len %lu)", ret
, len
);
1475 /* This call is useless on a socket so better save a syscall. */
1477 /* This won't block, but will start writeout asynchronously */
1478 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret
,
1479 SYNC_FILE_RANGE_WRITE
);
1480 stream
->out_fd_offset
+= ret
;
1484 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1488 * This is a special case that the relayd has closed its socket. Let's
1489 * cleanup the relayd object and all associated streams.
1491 if (relayd
&& relayd_hang_up
) {
1492 cleanup_relayd(relayd
, ctx
);
1496 /* Unlock only if ctrl socket used */
1497 if (relayd
&& stream
->metadata_flag
) {
1498 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1506 * Splice the data from the ring buffer to the tracefile.
1508 * It must be called with the stream lock held.
1510 * Returns the number of bytes spliced.
1512 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1513 struct lttng_consumer_local_data
*ctx
,
1514 struct lttng_consumer_stream
*stream
, unsigned long len
,
1515 unsigned long padding
)
1517 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1519 off_t orig_offset
= stream
->out_fd_offset
;
1520 int fd
= stream
->wait_fd
;
1521 /* Default is on the disk */
1522 int outfd
= stream
->out_fd
;
1523 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1525 unsigned int relayd_hang_up
= 0;
1527 switch (consumer_data
.type
) {
1528 case LTTNG_CONSUMER_KERNEL
:
1530 case LTTNG_CONSUMER32_UST
:
1531 case LTTNG_CONSUMER64_UST
:
1532 /* Not supported for user space tracing */
1535 ERR("Unknown consumer_data type");
1539 /* RCU lock for the relayd pointer */
1542 /* Flag that the current stream if set for network streaming. */
1543 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1544 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1545 if (relayd
== NULL
) {
1551 * Choose right pipe for splice. Metadata and trace data are handled by
1552 * different threads hence the use of two pipes in order not to race or
1553 * corrupt the written data.
1555 if (stream
->metadata_flag
) {
1556 splice_pipe
= ctx
->consumer_splice_metadata_pipe
;
1558 splice_pipe
= ctx
->consumer_thread_pipe
;
1561 /* Write metadata stream id before payload */
1563 int total_len
= len
;
1565 if (stream
->metadata_flag
) {
1567 * Lock the control socket for the complete duration of the function
1568 * since from this point on we will use the socket.
1570 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1572 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
, relayd
,
1576 /* Socket operation failed. We consider the relayd dead */
1577 if (ret
== -EBADF
) {
1578 WARN("Remote relayd disconnected. Stopping");
1585 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1588 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1590 /* Use the returned socket. */
1593 /* Socket operation failed. We consider the relayd dead */
1594 if (ret
== -EBADF
) {
1595 WARN("Remote relayd disconnected. Stopping");
1602 /* No streaming, we have to set the len with the full padding */
1606 * Check if we need to change the tracefile before writing the packet.
1608 if (stream
->chan
->tracefile_size
> 0 &&
1609 (stream
->tracefile_size_current
+ len
) >
1610 stream
->chan
->tracefile_size
) {
1611 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1612 stream
->name
, stream
->chan
->tracefile_size
,
1613 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1614 stream
->out_fd
, &(stream
->tracefile_count_current
));
1616 ERR("Rotating output file");
1619 outfd
= stream
->out_fd
= ret
;
1620 /* Reset current size because we just perform a rotation. */
1621 stream
->tracefile_size_current
= 0;
1623 stream
->tracefile_size_current
+= len
;
1627 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1628 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1629 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1630 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1631 DBG("splice chan to pipe, ret %zd", ret_splice
);
1632 if (ret_splice
< 0) {
1633 PERROR("Error in relay splice");
1635 written
= ret_splice
;
1641 /* Handle stream on the relayd if the output is on the network */
1643 if (stream
->metadata_flag
) {
1644 size_t metadata_payload_size
=
1645 sizeof(struct lttcomm_relayd_metadata_payload
);
1647 /* Update counter to fit the spliced data */
1648 ret_splice
+= metadata_payload_size
;
1649 len
+= metadata_payload_size
;
1651 * We do this so the return value can match the len passed as
1652 * argument to this function.
1654 written
-= metadata_payload_size
;
1658 /* Splice data out */
1659 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1660 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1661 DBG("Consumer splice pipe to file, ret %zd", ret_splice
);
1662 if (ret_splice
< 0) {
1663 PERROR("Error in file splice");
1665 written
= ret_splice
;
1667 /* Socket operation failed. We consider the relayd dead */
1668 if (errno
== EBADF
|| errno
== EPIPE
) {
1669 WARN("Remote relayd disconnected. Stopping");
1675 } else if (ret_splice
> len
) {
1677 PERROR("Wrote more data than requested %zd (len: %lu)",
1679 written
+= ret_splice
;
1685 /* This call is useless on a socket so better save a syscall. */
1687 /* This won't block, but will start writeout asynchronously */
1688 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
1689 SYNC_FILE_RANGE_WRITE
);
1690 stream
->out_fd_offset
+= ret_splice
;
1692 written
+= ret_splice
;
1694 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1702 * This is a special case that the relayd has closed its socket. Let's
1703 * cleanup the relayd object and all associated streams.
1705 if (relayd
&& relayd_hang_up
) {
1706 cleanup_relayd(relayd
, ctx
);
1707 /* Skip splice error so the consumer does not fail */
1712 /* send the appropriate error description to sessiond */
1715 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
1718 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
1721 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
1726 if (relayd
&& stream
->metadata_flag
) {
1727 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1735 * Take a snapshot for a specific fd
1737 * Returns 0 on success, < 0 on error
1739 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1741 switch (consumer_data
.type
) {
1742 case LTTNG_CONSUMER_KERNEL
:
1743 return lttng_kconsumer_take_snapshot(stream
);
1744 case LTTNG_CONSUMER32_UST
:
1745 case LTTNG_CONSUMER64_UST
:
1746 return lttng_ustconsumer_take_snapshot(stream
);
1748 ERR("Unknown consumer_data type");
1755 * Get the produced position
1757 * Returns 0 on success, < 0 on error
1759 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
1762 switch (consumer_data
.type
) {
1763 case LTTNG_CONSUMER_KERNEL
:
1764 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
1765 case LTTNG_CONSUMER32_UST
:
1766 case LTTNG_CONSUMER64_UST
:
1767 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
1769 ERR("Unknown consumer_data type");
1775 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1776 int sock
, struct pollfd
*consumer_sockpoll
)
1778 switch (consumer_data
.type
) {
1779 case LTTNG_CONSUMER_KERNEL
:
1780 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1781 case LTTNG_CONSUMER32_UST
:
1782 case LTTNG_CONSUMER64_UST
:
1783 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1785 ERR("Unknown consumer_data type");
1792 * Iterate over all streams of the hashtable and free them properly.
1794 * WARNING: *MUST* be used with data stream only.
1796 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1798 struct lttng_ht_iter iter
;
1799 struct lttng_consumer_stream
*stream
;
1806 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1808 * Ignore return value since we are currently cleaning up so any error
1811 (void) consumer_del_stream(stream
, ht
);
1815 lttng_ht_destroy(ht
);
1819 * Iterate over all streams of the hashtable and free them properly.
1821 * XXX: Should not be only for metadata stream or else use an other name.
1823 static void destroy_stream_ht(struct lttng_ht
*ht
)
1825 struct lttng_ht_iter iter
;
1826 struct lttng_consumer_stream
*stream
;
1833 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1835 * Ignore return value since we are currently cleaning up so any error
1838 (void) consumer_del_metadata_stream(stream
, ht
);
1842 lttng_ht_destroy(ht
);
1845 void lttng_consumer_close_metadata(void)
1847 switch (consumer_data
.type
) {
1848 case LTTNG_CONSUMER_KERNEL
:
1850 * The Kernel consumer has a different metadata scheme so we don't
1851 * close anything because the stream will be closed by the session
1855 case LTTNG_CONSUMER32_UST
:
1856 case LTTNG_CONSUMER64_UST
:
1858 * Close all metadata streams. The metadata hash table is passed and
1859 * this call iterates over it by closing all wakeup fd. This is safe
1860 * because at this point we are sure that the metadata producer is
1861 * either dead or blocked.
1863 lttng_ustconsumer_close_metadata(metadata_ht
);
1866 ERR("Unknown consumer_data type");
1872 * Clean up a metadata stream and free its memory.
1874 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
1875 struct lttng_ht
*ht
)
1878 struct lttng_ht_iter iter
;
1879 struct lttng_consumer_channel
*free_chan
= NULL
;
1880 struct consumer_relayd_sock_pair
*relayd
;
1884 * This call should NEVER receive regular stream. It must always be
1885 * metadata stream and this is crucial for data structure synchronization.
1887 assert(stream
->metadata_flag
);
1889 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
1892 /* Means the stream was allocated but not successfully added */
1893 goto free_stream_rcu
;
1896 pthread_mutex_lock(&consumer_data
.lock
);
1897 pthread_mutex_lock(&stream
->chan
->lock
);
1898 pthread_mutex_lock(&stream
->lock
);
1900 switch (consumer_data
.type
) {
1901 case LTTNG_CONSUMER_KERNEL
:
1902 if (stream
->mmap_base
!= NULL
) {
1903 ret
= munmap(stream
->mmap_base
, stream
->mmap_len
);
1905 PERROR("munmap metadata stream");
1909 if (stream
->wait_fd
>= 0) {
1910 ret
= close(stream
->wait_fd
);
1912 PERROR("close kernel metadata wait_fd");
1916 case LTTNG_CONSUMER32_UST
:
1917 case LTTNG_CONSUMER64_UST
:
1918 lttng_ustconsumer_del_stream(stream
);
1921 ERR("Unknown consumer_data type");
1927 iter
.iter
.node
= &stream
->node
.node
;
1928 ret
= lttng_ht_del(ht
, &iter
);
1931 iter
.iter
.node
= &stream
->node_channel_id
.node
;
1932 ret
= lttng_ht_del(consumer_data
.stream_per_chan_id_ht
, &iter
);
1935 iter
.iter
.node
= &stream
->node_session_id
.node
;
1936 ret
= lttng_ht_del(consumer_data
.stream_list_ht
, &iter
);
1940 if (stream
->out_fd
>= 0) {
1941 ret
= close(stream
->out_fd
);
1947 /* Check and cleanup relayd */
1949 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1950 if (relayd
!= NULL
) {
1951 uatomic_dec(&relayd
->refcount
);
1952 assert(uatomic_read(&relayd
->refcount
) >= 0);
1954 /* Closing streams requires to lock the control socket. */
1955 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1956 ret
= relayd_send_close_stream(&relayd
->control_sock
,
1957 stream
->relayd_stream_id
, stream
->next_net_seq_num
- 1);
1958 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1960 DBG("Unable to close stream on the relayd. Continuing");
1962 * Continue here. There is nothing we can do for the relayd.
1963 * Chances are that the relayd has closed the socket so we just
1964 * continue cleaning up.
1968 /* Both conditions are met, we destroy the relayd. */
1969 if (uatomic_read(&relayd
->refcount
) == 0 &&
1970 uatomic_read(&relayd
->destroy_flag
)) {
1971 destroy_relayd(relayd
);
1976 /* Atomically decrement channel refcount since other threads can use it. */
1977 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1)
1978 && !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
1979 /* Go for channel deletion! */
1980 free_chan
= stream
->chan
;
1985 * Nullify the stream reference so it is not used after deletion. The
1986 * consumer data lock MUST be acquired before being able to check for a
1987 * NULL pointer value.
1989 stream
->chan
->metadata_stream
= NULL
;
1991 pthread_mutex_unlock(&stream
->lock
);
1992 pthread_mutex_unlock(&stream
->chan
->lock
);
1993 pthread_mutex_unlock(&consumer_data
.lock
);
1996 consumer_del_channel(free_chan
);
2000 call_rcu(&stream
->node
.head
, free_stream_rcu
);
2004 * Action done with the metadata stream when adding it to the consumer internal
2005 * data structures to handle it.
2007 static int add_metadata_stream(struct lttng_consumer_stream
*stream
,
2008 struct lttng_ht
*ht
)
2011 struct consumer_relayd_sock_pair
*relayd
;
2012 struct lttng_ht_iter iter
;
2013 struct lttng_ht_node_u64
*node
;
2018 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
2020 pthread_mutex_lock(&consumer_data
.lock
);
2021 pthread_mutex_lock(&stream
->chan
->lock
);
2022 pthread_mutex_lock(&stream
->lock
);
2025 * From here, refcounts are updated so be _careful_ when returning an error
2032 * Lookup the stream just to make sure it does not exist in our internal
2033 * state. This should NEVER happen.
2035 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
2036 node
= lttng_ht_iter_get_node_u64(&iter
);
2039 /* Find relayd and, if one is found, increment refcount. */
2040 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
2041 if (relayd
!= NULL
) {
2042 uatomic_inc(&relayd
->refcount
);
2046 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2047 * in terms of destroying the associated channel, because the action that
2048 * causes the count to become 0 also causes a stream to be added. The
2049 * channel deletion will thus be triggered by the following removal of this
2052 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2053 /* Increment refcount before decrementing nb_init_stream_left */
2055 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2058 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2060 lttng_ht_add_unique_u64(consumer_data
.stream_per_chan_id_ht
,
2061 &stream
->node_channel_id
);
2064 * Add stream to the stream_list_ht of the consumer data. No need to steal
2065 * the key since the HT does not use it and we allow to add redundant keys
2068 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2072 pthread_mutex_unlock(&stream
->lock
);
2073 pthread_mutex_unlock(&stream
->chan
->lock
);
2074 pthread_mutex_unlock(&consumer_data
.lock
);
2079 * Delete data stream that are flagged for deletion (endpoint_status).
2081 static void validate_endpoint_status_data_stream(void)
2083 struct lttng_ht_iter iter
;
2084 struct lttng_consumer_stream
*stream
;
2086 DBG("Consumer delete flagged data stream");
2089 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2090 /* Validate delete flag of the stream */
2091 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2094 /* Delete it right now */
2095 consumer_del_stream(stream
, data_ht
);
2101 * Delete metadata stream that are flagged for deletion (endpoint_status).
2103 static void validate_endpoint_status_metadata_stream(
2104 struct lttng_poll_event
*pollset
)
2106 struct lttng_ht_iter iter
;
2107 struct lttng_consumer_stream
*stream
;
2109 DBG("Consumer delete flagged metadata stream");
2114 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2115 /* Validate delete flag of the stream */
2116 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2120 * Remove from pollset so the metadata thread can continue without
2121 * blocking on a deleted stream.
2123 lttng_poll_del(pollset
, stream
->wait_fd
);
2125 /* Delete it right now */
2126 consumer_del_metadata_stream(stream
, metadata_ht
);
2132 * Thread polls on metadata file descriptor and write them on disk or on the
2135 void *consumer_thread_metadata_poll(void *data
)
2138 uint32_t revents
, nb_fd
;
2139 struct lttng_consumer_stream
*stream
= NULL
;
2140 struct lttng_ht_iter iter
;
2141 struct lttng_ht_node_u64
*node
;
2142 struct lttng_poll_event events
;
2143 struct lttng_consumer_local_data
*ctx
= data
;
2146 rcu_register_thread();
2148 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2150 /* ENOMEM at this point. Better to bail out. */
2154 DBG("Thread metadata poll started");
2156 /* Size is set to 1 for the consumer_metadata pipe */
2157 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2159 ERR("Poll set creation failed");
2163 ret
= lttng_poll_add(&events
,
2164 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2170 DBG("Metadata main loop started");
2173 /* Only the metadata pipe is set */
2174 if (LTTNG_POLL_GETNB(&events
) == 0 && consumer_quit
== 1) {
2179 DBG("Metadata poll wait with %d fd(s)", LTTNG_POLL_GETNB(&events
));
2180 ret
= lttng_poll_wait(&events
, -1);
2181 DBG("Metadata event catched in thread");
2183 if (errno
== EINTR
) {
2184 ERR("Poll EINTR catched");
2192 /* From here, the event is a metadata wait fd */
2193 for (i
= 0; i
< nb_fd
; i
++) {
2194 revents
= LTTNG_POLL_GETEV(&events
, i
);
2195 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2197 /* Just don't waste time if no returned events for the fd */
2202 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2203 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2204 DBG("Metadata thread pipe hung up");
2206 * Remove the pipe from the poll set and continue the loop
2207 * since their might be data to consume.
2209 lttng_poll_del(&events
,
2210 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2211 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2213 } else if (revents
& LPOLLIN
) {
2216 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2217 &stream
, sizeof(stream
));
2219 ERR("read metadata stream, ret: %ld", pipe_len
);
2221 * Continue here to handle the rest of the streams.
2226 /* A NULL stream means that the state has changed. */
2227 if (stream
== NULL
) {
2228 /* Check for deleted streams. */
2229 validate_endpoint_status_metadata_stream(&events
);
2233 DBG("Adding metadata stream %d to poll set",
2236 ret
= add_metadata_stream(stream
, metadata_ht
);
2238 ERR("Unable to add metadata stream");
2239 /* Stream was not setup properly. Continuing. */
2240 consumer_del_metadata_stream(stream
, NULL
);
2244 /* Add metadata stream to the global poll events list */
2245 lttng_poll_add(&events
, stream
->wait_fd
,
2246 LPOLLIN
| LPOLLPRI
);
2249 /* Handle other stream */
2255 uint64_t tmp_id
= (uint64_t) pollfd
;
2257 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2259 node
= lttng_ht_iter_get_node_u64(&iter
);
2262 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2265 /* Check for error event */
2266 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2267 DBG("Metadata fd %d is hup|err.", pollfd
);
2268 if (!stream
->hangup_flush_done
2269 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2270 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2271 DBG("Attempting to flush and consume the UST buffers");
2272 lttng_ustconsumer_on_stream_hangup(stream
);
2274 /* We just flushed the stream now read it. */
2276 len
= ctx
->on_buffer_ready(stream
, ctx
);
2278 * We don't check the return value here since if we get
2279 * a negative len, it means an error occured thus we
2280 * simply remove it from the poll set and free the
2286 lttng_poll_del(&events
, stream
->wait_fd
);
2288 * This call update the channel states, closes file descriptors
2289 * and securely free the stream.
2291 consumer_del_metadata_stream(stream
, metadata_ht
);
2292 } else if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2293 /* Get the data out of the metadata file descriptor */
2294 DBG("Metadata available on fd %d", pollfd
);
2295 assert(stream
->wait_fd
== pollfd
);
2297 len
= ctx
->on_buffer_ready(stream
, ctx
);
2298 /* It's ok to have an unavailable sub-buffer */
2299 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2300 /* Clean up stream from consumer and free it. */
2301 lttng_poll_del(&events
, stream
->wait_fd
);
2302 consumer_del_metadata_stream(stream
, metadata_ht
);
2303 } else if (len
> 0) {
2304 stream
->data_read
= 1;
2308 /* Release RCU lock for the stream looked up */
2315 DBG("Metadata poll thread exiting");
2317 lttng_poll_clean(&events
);
2319 destroy_stream_ht(metadata_ht
);
2321 rcu_unregister_thread();
2326 * This thread polls the fds in the set to consume the data and write
2327 * it to tracefile if necessary.
2329 void *consumer_thread_data_poll(void *data
)
2331 int num_rdy
, num_hup
, high_prio
, ret
, i
;
2332 struct pollfd
*pollfd
= NULL
;
2333 /* local view of the streams */
2334 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2335 /* local view of consumer_data.fds_count */
2337 struct lttng_consumer_local_data
*ctx
= data
;
2340 rcu_register_thread();
2342 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2343 if (data_ht
== NULL
) {
2344 /* ENOMEM at this point. Better to bail out. */
2348 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
));
2355 * the fds set has been updated, we need to update our
2356 * local array as well
2358 pthread_mutex_lock(&consumer_data
.lock
);
2359 if (consumer_data
.need_update
) {
2364 local_stream
= NULL
;
2366 /* allocate for all fds + 1 for the consumer_data_pipe */
2367 pollfd
= zmalloc((consumer_data
.stream_count
+ 1) * sizeof(struct pollfd
));
2368 if (pollfd
== NULL
) {
2369 PERROR("pollfd malloc");
2370 pthread_mutex_unlock(&consumer_data
.lock
);
2374 /* allocate for all fds + 1 for the consumer_data_pipe */
2375 local_stream
= zmalloc((consumer_data
.stream_count
+ 1) *
2376 sizeof(struct lttng_consumer_stream
*));
2377 if (local_stream
== NULL
) {
2378 PERROR("local_stream malloc");
2379 pthread_mutex_unlock(&consumer_data
.lock
);
2382 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2385 ERR("Error in allocating pollfd or local_outfds");
2386 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2387 pthread_mutex_unlock(&consumer_data
.lock
);
2391 consumer_data
.need_update
= 0;
2393 pthread_mutex_unlock(&consumer_data
.lock
);
2395 /* No FDs and consumer_quit, consumer_cleanup the thread */
2396 if (nb_fd
== 0 && consumer_quit
== 1) {
2399 /* poll on the array of fds */
2401 DBG("polling on %d fd", nb_fd
+ 1);
2402 num_rdy
= poll(pollfd
, nb_fd
+ 1, -1);
2403 DBG("poll num_rdy : %d", num_rdy
);
2404 if (num_rdy
== -1) {
2406 * Restart interrupted system call.
2408 if (errno
== EINTR
) {
2411 PERROR("Poll error");
2412 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2414 } else if (num_rdy
== 0) {
2415 DBG("Polling thread timed out");
2420 * If the consumer_data_pipe triggered poll go directly to the
2421 * beginning of the loop to update the array. We want to prioritize
2422 * array update over low-priority reads.
2424 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2425 ssize_t pipe_readlen
;
2427 DBG("consumer_data_pipe wake up");
2428 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2429 &new_stream
, sizeof(new_stream
));
2430 if (pipe_readlen
< 0) {
2431 ERR("Consumer data pipe ret %ld", pipe_readlen
);
2432 /* Continue so we can at least handle the current stream(s). */
2437 * If the stream is NULL, just ignore it. It's also possible that
2438 * the sessiond poll thread changed the consumer_quit state and is
2439 * waking us up to test it.
2441 if (new_stream
== NULL
) {
2442 validate_endpoint_status_data_stream();
2446 ret
= add_stream(new_stream
, data_ht
);
2448 ERR("Consumer add stream %" PRIu64
" failed. Continuing",
2451 * At this point, if the add_stream fails, it is not in the
2452 * hash table thus passing the NULL value here.
2454 consumer_del_stream(new_stream
, NULL
);
2457 /* Continue to update the local streams and handle prio ones */
2461 /* Take care of high priority channels first. */
2462 for (i
= 0; i
< nb_fd
; i
++) {
2463 if (local_stream
[i
] == NULL
) {
2466 if (pollfd
[i
].revents
& POLLPRI
) {
2467 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2469 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2470 /* it's ok to have an unavailable sub-buffer */
2471 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2472 /* Clean the stream and free it. */
2473 consumer_del_stream(local_stream
[i
], data_ht
);
2474 local_stream
[i
] = NULL
;
2475 } else if (len
> 0) {
2476 local_stream
[i
]->data_read
= 1;
2482 * If we read high prio channel in this loop, try again
2483 * for more high prio data.
2489 /* Take care of low priority channels. */
2490 for (i
= 0; i
< nb_fd
; i
++) {
2491 if (local_stream
[i
] == NULL
) {
2494 if ((pollfd
[i
].revents
& POLLIN
) ||
2495 local_stream
[i
]->hangup_flush_done
) {
2496 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2497 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2498 /* it's ok to have an unavailable sub-buffer */
2499 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2500 /* Clean the stream and free it. */
2501 consumer_del_stream(local_stream
[i
], data_ht
);
2502 local_stream
[i
] = NULL
;
2503 } else if (len
> 0) {
2504 local_stream
[i
]->data_read
= 1;
2509 /* Handle hangup and errors */
2510 for (i
= 0; i
< nb_fd
; i
++) {
2511 if (local_stream
[i
] == NULL
) {
2514 if (!local_stream
[i
]->hangup_flush_done
2515 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2516 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2517 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2518 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2520 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2521 /* Attempt read again, for the data we just flushed. */
2522 local_stream
[i
]->data_read
= 1;
2525 * If the poll flag is HUP/ERR/NVAL and we have
2526 * read no data in this pass, we can remove the
2527 * stream from its hash table.
2529 if ((pollfd
[i
].revents
& POLLHUP
)) {
2530 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2531 if (!local_stream
[i
]->data_read
) {
2532 consumer_del_stream(local_stream
[i
], data_ht
);
2533 local_stream
[i
] = NULL
;
2536 } else if (pollfd
[i
].revents
& POLLERR
) {
2537 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2538 if (!local_stream
[i
]->data_read
) {
2539 consumer_del_stream(local_stream
[i
], data_ht
);
2540 local_stream
[i
] = NULL
;
2543 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2544 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2545 if (!local_stream
[i
]->data_read
) {
2546 consumer_del_stream(local_stream
[i
], data_ht
);
2547 local_stream
[i
] = NULL
;
2551 if (local_stream
[i
] != NULL
) {
2552 local_stream
[i
]->data_read
= 0;
2557 DBG("polling thread exiting");
2562 * Close the write side of the pipe so epoll_wait() in
2563 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2564 * read side of the pipe. If we close them both, epoll_wait strangely does
2565 * not return and could create a endless wait period if the pipe is the
2566 * only tracked fd in the poll set. The thread will take care of closing
2569 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2571 destroy_data_stream_ht(data_ht
);
2573 rcu_unregister_thread();
2578 * Close wake-up end of each stream belonging to the channel. This will
2579 * allow the poll() on the stream read-side to detect when the
2580 * write-side (application) finally closes them.
2583 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2585 struct lttng_ht
*ht
;
2586 struct lttng_consumer_stream
*stream
;
2587 struct lttng_ht_iter iter
;
2589 ht
= consumer_data
.stream_per_chan_id_ht
;
2592 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2593 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2594 ht
->match_fct
, &channel
->key
,
2595 &iter
.iter
, stream
, node_channel_id
.node
) {
2597 * Protect against teardown with mutex.
2599 pthread_mutex_lock(&stream
->lock
);
2600 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2603 switch (consumer_data
.type
) {
2604 case LTTNG_CONSUMER_KERNEL
:
2606 case LTTNG_CONSUMER32_UST
:
2607 case LTTNG_CONSUMER64_UST
:
2609 * Note: a mutex is taken internally within
2610 * liblttng-ust-ctl to protect timer wakeup_fd
2611 * use from concurrent close.
2613 lttng_ustconsumer_close_stream_wakeup(stream
);
2616 ERR("Unknown consumer_data type");
2620 pthread_mutex_unlock(&stream
->lock
);
2625 static void destroy_channel_ht(struct lttng_ht
*ht
)
2627 struct lttng_ht_iter iter
;
2628 struct lttng_consumer_channel
*channel
;
2636 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2637 ret
= lttng_ht_del(ht
, &iter
);
2642 lttng_ht_destroy(ht
);
2646 * This thread polls the channel fds to detect when they are being
2647 * closed. It closes all related streams if the channel is detected as
2648 * closed. It is currently only used as a shim layer for UST because the
2649 * consumerd needs to keep the per-stream wakeup end of pipes open for
2652 void *consumer_thread_channel_poll(void *data
)
2655 uint32_t revents
, nb_fd
;
2656 struct lttng_consumer_channel
*chan
= NULL
;
2657 struct lttng_ht_iter iter
;
2658 struct lttng_ht_node_u64
*node
;
2659 struct lttng_poll_event events
;
2660 struct lttng_consumer_local_data
*ctx
= data
;
2661 struct lttng_ht
*channel_ht
;
2663 rcu_register_thread();
2665 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2667 /* ENOMEM at this point. Better to bail out. */
2671 DBG("Thread channel poll started");
2673 /* Size is set to 1 for the consumer_channel pipe */
2674 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2676 ERR("Poll set creation failed");
2680 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
2686 DBG("Channel main loop started");
2689 /* Only the channel pipe is set */
2690 if (LTTNG_POLL_GETNB(&events
) == 0 && consumer_quit
== 1) {
2695 DBG("Channel poll wait with %d fd(s)", LTTNG_POLL_GETNB(&events
));
2696 ret
= lttng_poll_wait(&events
, -1);
2697 DBG("Channel event catched in thread");
2699 if (errno
== EINTR
) {
2700 ERR("Poll EINTR catched");
2708 /* From here, the event is a channel wait fd */
2709 for (i
= 0; i
< nb_fd
; i
++) {
2710 revents
= LTTNG_POLL_GETEV(&events
, i
);
2711 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2713 /* Just don't waste time if no returned events for the fd */
2717 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
2718 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2719 DBG("Channel thread pipe hung up");
2721 * Remove the pipe from the poll set and continue the loop
2722 * since their might be data to consume.
2724 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2726 } else if (revents
& LPOLLIN
) {
2727 enum consumer_channel_action action
;
2730 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
2732 ERR("Error reading channel pipe");
2737 case CONSUMER_CHANNEL_ADD
:
2738 DBG("Adding channel %d to poll set",
2741 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
2744 lttng_ht_add_unique_u64(channel_ht
,
2745 &chan
->wait_fd_node
);
2747 /* Add channel to the global poll events list */
2748 lttng_poll_add(&events
, chan
->wait_fd
,
2749 LPOLLIN
| LPOLLPRI
);
2751 case CONSUMER_CHANNEL_DEL
:
2753 struct lttng_consumer_stream
*stream
, *stmp
;
2756 chan
= consumer_find_channel(key
);
2759 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
2762 lttng_poll_del(&events
, chan
->wait_fd
);
2763 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
2764 ret
= lttng_ht_del(channel_ht
, &iter
);
2766 consumer_close_channel_streams(chan
);
2768 switch (consumer_data
.type
) {
2769 case LTTNG_CONSUMER_KERNEL
:
2771 case LTTNG_CONSUMER32_UST
:
2772 case LTTNG_CONSUMER64_UST
:
2773 /* Delete streams that might have been left in the stream list. */
2774 cds_list_for_each_entry_safe(stream
, stmp
, &chan
->streams
.head
,
2776 cds_list_del(&stream
->send_node
);
2777 lttng_ustconsumer_del_stream(stream
);
2778 uatomic_sub(&stream
->chan
->refcount
, 1);
2779 assert(&chan
->refcount
);
2784 ERR("Unknown consumer_data type");
2789 * Release our own refcount. Force channel deletion even if
2790 * streams were not initialized.
2792 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
2793 consumer_del_channel(chan
);
2798 case CONSUMER_CHANNEL_QUIT
:
2800 * Remove the pipe from the poll set and continue the loop
2801 * since their might be data to consume.
2803 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2806 ERR("Unknown action");
2811 /* Handle other stream */
2817 uint64_t tmp_id
= (uint64_t) pollfd
;
2819 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
2821 node
= lttng_ht_iter_get_node_u64(&iter
);
2824 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
2827 /* Check for error event */
2828 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2829 DBG("Channel fd %d is hup|err.", pollfd
);
2831 lttng_poll_del(&events
, chan
->wait_fd
);
2832 ret
= lttng_ht_del(channel_ht
, &iter
);
2834 assert(cds_list_empty(&chan
->streams
.head
));
2835 consumer_close_channel_streams(chan
);
2837 /* Release our own refcount */
2838 if (!uatomic_sub_return(&chan
->refcount
, 1)
2839 && !uatomic_read(&chan
->nb_init_stream_left
)) {
2840 consumer_del_channel(chan
);
2844 /* Release RCU lock for the channel looked up */
2850 lttng_poll_clean(&events
);
2852 destroy_channel_ht(channel_ht
);
2854 DBG("Channel poll thread exiting");
2855 rcu_unregister_thread();
2859 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
2860 struct pollfd
*sockpoll
, int client_socket
)
2867 if (lttng_consumer_poll_socket(sockpoll
) < 0) {
2871 DBG("Metadata connection on client_socket");
2873 /* Blocking call, waiting for transmission */
2874 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
2875 if (ctx
->consumer_metadata_socket
< 0) {
2876 WARN("On accept metadata");
2887 * This thread listens on the consumerd socket and receives the file
2888 * descriptors from the session daemon.
2890 void *consumer_thread_sessiond_poll(void *data
)
2892 int sock
= -1, client_socket
, ret
;
2894 * structure to poll for incoming data on communication socket avoids
2895 * making blocking sockets.
2897 struct pollfd consumer_sockpoll
[2];
2898 struct lttng_consumer_local_data
*ctx
= data
;
2900 rcu_register_thread();
2902 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
2903 unlink(ctx
->consumer_command_sock_path
);
2904 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
2905 if (client_socket
< 0) {
2906 ERR("Cannot create command socket");
2910 ret
= lttcomm_listen_unix_sock(client_socket
);
2915 DBG("Sending ready command to lttng-sessiond");
2916 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
2917 /* return < 0 on error, but == 0 is not fatal */
2919 ERR("Error sending ready command to lttng-sessiond");
2923 /* prepare the FDs to poll : to client socket and the should_quit pipe */
2924 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
2925 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
2926 consumer_sockpoll
[1].fd
= client_socket
;
2927 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
2929 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
2932 DBG("Connection on client_socket");
2934 /* Blocking call, waiting for transmission */
2935 sock
= lttcomm_accept_unix_sock(client_socket
);
2942 * Setup metadata socket which is the second socket connection on the
2943 * command unix socket.
2945 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
2950 /* This socket is not useful anymore. */
2951 ret
= close(client_socket
);
2953 PERROR("close client_socket");
2957 /* update the polling structure to poll on the established socket */
2958 consumer_sockpoll
[1].fd
= sock
;
2959 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
2962 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
2965 DBG("Incoming command on sock");
2966 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2967 if (ret
== -ENOENT
) {
2968 DBG("Received STOP command");
2973 * This could simply be a session daemon quitting. Don't output
2976 DBG("Communication interrupted on command socket");
2979 if (consumer_quit
) {
2980 DBG("consumer_thread_receive_fds received quit from signal");
2983 DBG("received command on sock");
2986 DBG("Consumer thread sessiond poll exiting");
2989 * Close metadata streams since the producer is the session daemon which
2992 * NOTE: for now, this only applies to the UST tracer.
2994 lttng_consumer_close_metadata();
2997 * when all fds have hung up, the polling thread
3003 * Notify the data poll thread to poll back again and test the
3004 * consumer_quit state that we just set so to quit gracefully.
3006 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
3008 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
3010 /* Cleaning up possibly open sockets. */
3014 PERROR("close sock sessiond poll");
3017 if (client_socket
>= 0) {
3018 ret
= close(client_socket
);
3020 PERROR("close client_socket sessiond poll");
3024 rcu_unregister_thread();
3028 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
3029 struct lttng_consumer_local_data
*ctx
)
3033 pthread_mutex_lock(&stream
->lock
);
3035 switch (consumer_data
.type
) {
3036 case LTTNG_CONSUMER_KERNEL
:
3037 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
3039 case LTTNG_CONSUMER32_UST
:
3040 case LTTNG_CONSUMER64_UST
:
3041 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3044 ERR("Unknown consumer_data type");
3050 pthread_mutex_unlock(&stream
->lock
);
3054 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3056 switch (consumer_data
.type
) {
3057 case LTTNG_CONSUMER_KERNEL
:
3058 return lttng_kconsumer_on_recv_stream(stream
);
3059 case LTTNG_CONSUMER32_UST
:
3060 case LTTNG_CONSUMER64_UST
:
3061 return lttng_ustconsumer_on_recv_stream(stream
);
3063 ERR("Unknown consumer_data type");
3070 * Allocate and set consumer data hash tables.
3072 void lttng_consumer_init(void)
3074 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3075 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3076 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3077 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3081 * Process the ADD_RELAYD command receive by a consumer.
3083 * This will create a relayd socket pair and add it to the relayd hash table.
3084 * The caller MUST acquire a RCU read side lock before calling it.
3086 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3087 struct lttng_consumer_local_data
*ctx
, int sock
,
3088 struct pollfd
*consumer_sockpoll
,
3089 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
)
3091 int fd
= -1, ret
= -1, relayd_created
= 0;
3092 enum lttng_error_code ret_code
= LTTNG_OK
;
3093 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3096 assert(relayd_sock
);
3098 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3100 /* Get relayd reference if exists. */
3101 relayd
= consumer_find_relayd(net_seq_idx
);
3102 if (relayd
== NULL
) {
3103 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3104 /* Not found. Allocate one. */
3105 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3106 if (relayd
== NULL
) {
3108 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3111 relayd
->sessiond_session_id
= sessiond_id
;
3116 * This code path MUST continue to the consumer send status message to
3117 * we can notify the session daemon and continue our work without
3118 * killing everything.
3122 * relayd key should never be found for control socket.
3124 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3127 /* First send a status message before receiving the fds. */
3128 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
3130 /* Somehow, the session daemon is not responding anymore. */
3131 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3132 goto error_nosignal
;
3135 /* Poll on consumer socket. */
3136 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
3137 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3139 goto error_nosignal
;
3142 /* Get relayd socket from session daemon */
3143 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3144 if (ret
!= sizeof(fd
)) {
3146 fd
= -1; /* Just in case it gets set with an invalid value. */
3149 * Failing to receive FDs might indicate a major problem such as
3150 * reaching a fd limit during the receive where the kernel returns a
3151 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3152 * don't take any chances and stop everything.
3154 * XXX: Feature request #558 will fix that and avoid this possible
3155 * issue when reaching the fd limit.
3157 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3158 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3162 /* Copy socket information and received FD */
3163 switch (sock_type
) {
3164 case LTTNG_STREAM_CONTROL
:
3165 /* Copy received lttcomm socket */
3166 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3167 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3168 /* Handle create_sock error. */
3170 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3174 * Close the socket created internally by
3175 * lttcomm_create_sock, so we can replace it by the one
3176 * received from sessiond.
3178 if (close(relayd
->control_sock
.sock
.fd
)) {
3182 /* Assign new file descriptor */
3183 relayd
->control_sock
.sock
.fd
= fd
;
3184 fd
= -1; /* For error path */
3185 /* Assign version values. */
3186 relayd
->control_sock
.major
= relayd_sock
->major
;
3187 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3190 * Create a session on the relayd and store the returned id. Lock the
3191 * control socket mutex if the relayd was NOT created before.
3193 if (!relayd_created
) {
3194 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3196 ret
= relayd_create_session(&relayd
->control_sock
,
3197 &relayd
->relayd_session_id
);
3198 if (!relayd_created
) {
3199 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3203 * Close all sockets of a relayd object. It will be freed if it was
3204 * created at the error code path or else it will be garbage
3207 (void) relayd_close(&relayd
->control_sock
);
3208 (void) relayd_close(&relayd
->data_sock
);
3209 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
3214 case LTTNG_STREAM_DATA
:
3215 /* Copy received lttcomm socket */
3216 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3217 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3218 /* Handle create_sock error. */
3220 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3224 * Close the socket created internally by
3225 * lttcomm_create_sock, so we can replace it by the one
3226 * received from sessiond.
3228 if (close(relayd
->data_sock
.sock
.fd
)) {
3232 /* Assign new file descriptor */
3233 relayd
->data_sock
.sock
.fd
= fd
;
3234 fd
= -1; /* for eventual error paths */
3235 /* Assign version values. */
3236 relayd
->data_sock
.major
= relayd_sock
->major
;
3237 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3240 ERR("Unknown relayd socket type (%d)", sock_type
);
3242 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3246 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3247 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3248 relayd
->net_seq_idx
, fd
);
3250 /* We successfully added the socket. Send status back. */
3251 ret
= consumer_send_status_msg(sock
, ret_code
);
3253 /* Somehow, the session daemon is not responding anymore. */
3254 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3255 goto error_nosignal
;
3259 * Add relayd socket pair to consumer data hashtable. If object already
3260 * exists or on error, the function gracefully returns.
3268 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3269 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3273 /* Close received socket if valid. */
3276 PERROR("close received socket");
3280 if (relayd_created
) {
3288 * Try to lock the stream mutex.
3290 * On success, 1 is returned else 0 indicating that the mutex is NOT lock.
3292 static int stream_try_lock(struct lttng_consumer_stream
*stream
)
3299 * Try to lock the stream mutex. On failure, we know that the stream is
3300 * being used else where hence there is data still being extracted.
3302 ret
= pthread_mutex_trylock(&stream
->lock
);
3304 /* For both EBUSY and EINVAL error, the mutex is NOT locked. */
3316 * Search for a relayd associated to the session id and return the reference.
3318 * A rcu read side lock MUST be acquire before calling this function and locked
3319 * until the relayd object is no longer necessary.
3321 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3323 struct lttng_ht_iter iter
;
3324 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3326 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3327 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3330 * Check by sessiond id which is unique here where the relayd session
3331 * id might not be when having multiple relayd.
3333 if (relayd
->sessiond_session_id
== id
) {
3334 /* Found the relayd. There can be only one per id. */
3346 * Check if for a given session id there is still data needed to be extract
3349 * Return 1 if data is pending or else 0 meaning ready to be read.
3351 int consumer_data_pending(uint64_t id
)
3354 struct lttng_ht_iter iter
;
3355 struct lttng_ht
*ht
;
3356 struct lttng_consumer_stream
*stream
;
3357 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3358 int (*data_pending
)(struct lttng_consumer_stream
*);
3360 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3363 pthread_mutex_lock(&consumer_data
.lock
);
3365 switch (consumer_data
.type
) {
3366 case LTTNG_CONSUMER_KERNEL
:
3367 data_pending
= lttng_kconsumer_data_pending
;
3369 case LTTNG_CONSUMER32_UST
:
3370 case LTTNG_CONSUMER64_UST
:
3371 data_pending
= lttng_ustconsumer_data_pending
;
3374 ERR("Unknown consumer data type");
3378 /* Ease our life a bit */
3379 ht
= consumer_data
.stream_list_ht
;
3381 relayd
= find_relayd_by_session_id(id
);
3383 /* Send init command for data pending. */
3384 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3385 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3386 relayd
->relayd_session_id
);
3387 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3389 /* Communication error thus the relayd so no data pending. */
3390 goto data_not_pending
;
3394 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3395 ht
->hash_fct(&id
, lttng_ht_seed
),
3397 &iter
.iter
, stream
, node_session_id
.node
) {
3398 /* If this call fails, the stream is being used hence data pending. */
3399 ret
= stream_try_lock(stream
);
3405 * A removed node from the hash table indicates that the stream has
3406 * been deleted thus having a guarantee that the buffers are closed
3407 * on the consumer side. However, data can still be transmitted
3408 * over the network so don't skip the relayd check.
3410 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3412 /* Check the stream if there is data in the buffers. */
3413 ret
= data_pending(stream
);
3415 pthread_mutex_unlock(&stream
->lock
);
3422 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3423 if (stream
->metadata_flag
) {
3424 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3425 stream
->relayd_stream_id
);
3427 ret
= relayd_data_pending(&relayd
->control_sock
,
3428 stream
->relayd_stream_id
,
3429 stream
->next_net_seq_num
- 1);
3431 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3433 pthread_mutex_unlock(&stream
->lock
);
3437 pthread_mutex_unlock(&stream
->lock
);
3441 unsigned int is_data_inflight
= 0;
3443 /* Send init command for data pending. */
3444 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3445 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3446 relayd
->relayd_session_id
, &is_data_inflight
);
3447 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3449 goto data_not_pending
;
3451 if (is_data_inflight
) {
3457 * Finding _no_ node in the hash table and no inflight data means that the
3458 * stream(s) have been removed thus data is guaranteed to be available for
3459 * analysis from the trace files.
3463 /* Data is available to be read by a viewer. */
3464 pthread_mutex_unlock(&consumer_data
.lock
);
3469 /* Data is still being extracted from buffers. */
3470 pthread_mutex_unlock(&consumer_data
.lock
);
3476 * Send a ret code status message to the sessiond daemon.
3478 * Return the sendmsg() return value.
3480 int consumer_send_status_msg(int sock
, int ret_code
)
3482 struct lttcomm_consumer_status_msg msg
;
3484 msg
.ret_code
= ret_code
;
3486 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3490 * Send a channel status message to the sessiond daemon.
3492 * Return the sendmsg() return value.
3494 int consumer_send_status_channel(int sock
,
3495 struct lttng_consumer_channel
*channel
)
3497 struct lttcomm_consumer_status_channel msg
;
3502 msg
.ret_code
= -LTTNG_ERR_UST_CHAN_FAIL
;
3504 msg
.ret_code
= LTTNG_OK
;
3505 msg
.key
= channel
->key
;
3506 msg
.stream_count
= channel
->streams
.count
;
3509 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));