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>
44 #include "consumer-stream.h"
46 struct lttng_consumer_global_data consumer_data
= {
49 .type
= LTTNG_CONSUMER_UNKNOWN
,
52 enum consumer_channel_action
{
55 CONSUMER_CHANNEL_QUIT
,
58 struct consumer_channel_msg
{
59 enum consumer_channel_action action
;
60 struct lttng_consumer_channel
*chan
; /* add */
61 uint64_t key
; /* del */
65 * Flag to inform the polling thread to quit when all fd hung up. Updated by
66 * the consumer_thread_receive_fds when it notices that all fds has hung up.
67 * Also updated by the signal handler (consumer_should_exit()). Read by the
70 volatile int consumer_quit
;
73 * Global hash table containing respectively metadata and data streams. The
74 * stream element in this ht should only be updated by the metadata poll thread
75 * for the metadata and the data poll thread for the data.
77 static struct lttng_ht
*metadata_ht
;
78 static struct lttng_ht
*data_ht
;
81 * Notify a thread lttng pipe to poll back again. This usually means that some
82 * global state has changed so we just send back the thread in a poll wait
85 static void notify_thread_lttng_pipe(struct lttng_pipe
*pipe
)
87 struct lttng_consumer_stream
*null_stream
= NULL
;
91 (void) lttng_pipe_write(pipe
, &null_stream
, sizeof(null_stream
));
94 static void notify_channel_pipe(struct lttng_consumer_local_data
*ctx
,
95 struct lttng_consumer_channel
*chan
,
97 enum consumer_channel_action action
)
99 struct consumer_channel_msg msg
;
102 memset(&msg
, 0, sizeof(msg
));
108 ret
= write(ctx
->consumer_channel_pipe
[1], &msg
, sizeof(msg
));
109 } while (ret
< 0 && errno
== EINTR
);
112 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
115 notify_channel_pipe(ctx
, NULL
, key
, CONSUMER_CHANNEL_DEL
);
118 static int read_channel_pipe(struct lttng_consumer_local_data
*ctx
,
119 struct lttng_consumer_channel
**chan
,
121 enum consumer_channel_action
*action
)
123 struct consumer_channel_msg msg
;
127 ret
= read(ctx
->consumer_channel_pipe
[0], &msg
, sizeof(msg
));
128 } while (ret
< 0 && errno
== EINTR
);
130 *action
= msg
.action
;
138 * Find a stream. The consumer_data.lock must be locked during this
141 static struct lttng_consumer_stream
*find_stream(uint64_t key
,
144 struct lttng_ht_iter iter
;
145 struct lttng_ht_node_u64
*node
;
146 struct lttng_consumer_stream
*stream
= NULL
;
150 /* -1ULL keys are lookup failures */
151 if (key
== (uint64_t) -1ULL) {
157 lttng_ht_lookup(ht
, &key
, &iter
);
158 node
= lttng_ht_iter_get_node_u64(&iter
);
160 stream
= caa_container_of(node
, struct lttng_consumer_stream
, node
);
168 static void steal_stream_key(uint64_t key
, struct lttng_ht
*ht
)
170 struct lttng_consumer_stream
*stream
;
173 stream
= find_stream(key
, ht
);
175 stream
->key
= (uint64_t) -1ULL;
177 * We don't want the lookup to match, but we still need
178 * to iterate on this stream when iterating over the hash table. Just
179 * change the node key.
181 stream
->node
.key
= (uint64_t) -1ULL;
187 * Return a channel object for the given key.
189 * RCU read side lock MUST be acquired before calling this function and
190 * protects the channel ptr.
192 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
)
194 struct lttng_ht_iter iter
;
195 struct lttng_ht_node_u64
*node
;
196 struct lttng_consumer_channel
*channel
= NULL
;
198 /* -1ULL keys are lookup failures */
199 if (key
== (uint64_t) -1ULL) {
203 lttng_ht_lookup(consumer_data
.channel_ht
, &key
, &iter
);
204 node
= lttng_ht_iter_get_node_u64(&iter
);
206 channel
= caa_container_of(node
, struct lttng_consumer_channel
, node
);
212 static void free_stream_rcu(struct rcu_head
*head
)
214 struct lttng_ht_node_u64
*node
=
215 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
216 struct lttng_consumer_stream
*stream
=
217 caa_container_of(node
, struct lttng_consumer_stream
, node
);
222 static void free_channel_rcu(struct rcu_head
*head
)
224 struct lttng_ht_node_u64
*node
=
225 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
226 struct lttng_consumer_channel
*channel
=
227 caa_container_of(node
, struct lttng_consumer_channel
, node
);
233 * RCU protected relayd socket pair free.
235 static void free_relayd_rcu(struct rcu_head
*head
)
237 struct lttng_ht_node_u64
*node
=
238 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
239 struct consumer_relayd_sock_pair
*relayd
=
240 caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
243 * Close all sockets. This is done in the call RCU since we don't want the
244 * socket fds to be reassigned thus potentially creating bad state of the
247 * We do not have to lock the control socket mutex here since at this stage
248 * there is no one referencing to this relayd object.
250 (void) relayd_close(&relayd
->control_sock
);
251 (void) relayd_close(&relayd
->data_sock
);
257 * Destroy and free relayd socket pair object.
259 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
)
262 struct lttng_ht_iter iter
;
264 if (relayd
== NULL
) {
268 DBG("Consumer destroy and close relayd socket pair");
270 iter
.iter
.node
= &relayd
->node
.node
;
271 ret
= lttng_ht_del(consumer_data
.relayd_ht
, &iter
);
273 /* We assume the relayd is being or is destroyed */
277 /* RCU free() call */
278 call_rcu(&relayd
->node
.head
, free_relayd_rcu
);
282 * Remove a channel from the global list protected by a mutex. This function is
283 * also responsible for freeing its data structures.
285 void consumer_del_channel(struct lttng_consumer_channel
*channel
)
288 struct lttng_ht_iter iter
;
289 struct lttng_consumer_stream
*stream
, *stmp
;
291 DBG("Consumer delete channel key %" PRIu64
, channel
->key
);
293 pthread_mutex_lock(&consumer_data
.lock
);
294 pthread_mutex_lock(&channel
->lock
);
296 /* Delete streams that might have been left in the stream list. */
297 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
299 cds_list_del(&stream
->send_node
);
301 * Once a stream is added to this list, the buffers were created so
302 * we have a guarantee that this call will succeed.
304 consumer_stream_destroy(stream
, NULL
);
307 switch (consumer_data
.type
) {
308 case LTTNG_CONSUMER_KERNEL
:
310 case LTTNG_CONSUMER32_UST
:
311 case LTTNG_CONSUMER64_UST
:
312 lttng_ustconsumer_del_channel(channel
);
315 ERR("Unknown consumer_data type");
321 iter
.iter
.node
= &channel
->node
.node
;
322 ret
= lttng_ht_del(consumer_data
.channel_ht
, &iter
);
326 call_rcu(&channel
->node
.head
, free_channel_rcu
);
328 pthread_mutex_unlock(&channel
->lock
);
329 pthread_mutex_unlock(&consumer_data
.lock
);
333 * Iterate over the relayd hash table and destroy each element. Finally,
334 * destroy the whole hash table.
336 static void cleanup_relayd_ht(void)
338 struct lttng_ht_iter iter
;
339 struct consumer_relayd_sock_pair
*relayd
;
343 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
345 consumer_destroy_relayd(relayd
);
350 lttng_ht_destroy(consumer_data
.relayd_ht
);
354 * Update the end point status of all streams having the given network sequence
355 * index (relayd index).
357 * It's atomically set without having the stream mutex locked which is fine
358 * because we handle the write/read race with a pipe wakeup for each thread.
360 static void update_endpoint_status_by_netidx(uint64_t net_seq_idx
,
361 enum consumer_endpoint_status status
)
363 struct lttng_ht_iter iter
;
364 struct lttng_consumer_stream
*stream
;
366 DBG("Consumer set delete flag on stream by idx %" PRIu64
, net_seq_idx
);
370 /* Let's begin with metadata */
371 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
372 if (stream
->net_seq_idx
== net_seq_idx
) {
373 uatomic_set(&stream
->endpoint_status
, status
);
374 DBG("Delete flag set to metadata stream %d", stream
->wait_fd
);
378 /* Follow up by the data streams */
379 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
380 if (stream
->net_seq_idx
== net_seq_idx
) {
381 uatomic_set(&stream
->endpoint_status
, status
);
382 DBG("Delete flag set to data stream %d", stream
->wait_fd
);
389 * Cleanup a relayd object by flagging every associated streams for deletion,
390 * destroying the object meaning removing it from the relayd hash table,
391 * closing the sockets and freeing the memory in a RCU call.
393 * If a local data context is available, notify the threads that the streams'
394 * state have changed.
396 static void cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
,
397 struct lttng_consumer_local_data
*ctx
)
403 DBG("Cleaning up relayd sockets");
405 /* Save the net sequence index before destroying the object */
406 netidx
= relayd
->net_seq_idx
;
409 * Delete the relayd from the relayd hash table, close the sockets and free
410 * the object in a RCU call.
412 consumer_destroy_relayd(relayd
);
414 /* Set inactive endpoint to all streams */
415 update_endpoint_status_by_netidx(netidx
, CONSUMER_ENDPOINT_INACTIVE
);
418 * With a local data context, notify the threads that the streams' state
419 * have changed. The write() action on the pipe acts as an "implicit"
420 * memory barrier ordering the updates of the end point status from the
421 * read of this status which happens AFTER receiving this notify.
424 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
425 notify_thread_lttng_pipe(ctx
->consumer_metadata_pipe
);
430 * Flag a relayd socket pair for destruction. Destroy it if the refcount
433 * RCU read side lock MUST be aquired before calling this function.
435 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair
*relayd
)
439 /* Set destroy flag for this object */
440 uatomic_set(&relayd
->destroy_flag
, 1);
442 /* Destroy the relayd if refcount is 0 */
443 if (uatomic_read(&relayd
->refcount
) == 0) {
444 consumer_destroy_relayd(relayd
);
449 * Completly destroy stream from every visiable data structure and the given
452 * One this call returns, the stream object is not longer usable nor visible.
454 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
457 consumer_stream_destroy(stream
, ht
);
460 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
462 enum lttng_consumer_stream_state state
,
463 const char *channel_name
,
470 enum consumer_channel_type type
,
471 unsigned int monitor
)
474 struct lttng_consumer_stream
*stream
;
476 stream
= zmalloc(sizeof(*stream
));
477 if (stream
== NULL
) {
478 PERROR("malloc struct lttng_consumer_stream");
485 stream
->key
= stream_key
;
487 stream
->out_fd_offset
= 0;
488 stream
->state
= state
;
491 stream
->net_seq_idx
= relayd_id
;
492 stream
->session_id
= session_id
;
493 stream
->monitor
= monitor
;
494 pthread_mutex_init(&stream
->lock
, NULL
);
496 /* If channel is the metadata, flag this stream as metadata. */
497 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
498 stream
->metadata_flag
= 1;
499 /* Metadata is flat out. */
500 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
502 /* Format stream name to <channel_name>_<cpu_number> */
503 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
506 PERROR("snprintf stream name");
511 /* Key is always the wait_fd for streams. */
512 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
514 /* Init node per channel id key */
515 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
517 /* Init session id node with the stream session id */
518 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
520 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
521 " relayd_id %" PRIu64
", session_id %" PRIu64
,
522 stream
->name
, stream
->key
, channel_key
,
523 stream
->net_seq_idx
, stream
->session_id
);
539 * Add a stream to the global list protected by a mutex.
541 static int add_stream(struct lttng_consumer_stream
*stream
,
549 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
551 pthread_mutex_lock(&consumer_data
.lock
);
552 pthread_mutex_lock(&stream
->chan
->lock
);
553 pthread_mutex_lock(&stream
->lock
);
556 /* Steal stream identifier to avoid having streams with the same key */
557 steal_stream_key(stream
->key
, ht
);
559 lttng_ht_add_unique_u64(ht
, &stream
->node
);
561 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
562 &stream
->node_channel_id
);
565 * Add stream to the stream_list_ht of the consumer data. No need to steal
566 * the key since the HT does not use it and we allow to add redundant keys
569 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
572 * When nb_init_stream_left reaches 0, we don't need to trigger any action
573 * in terms of destroying the associated channel, because the action that
574 * causes the count to become 0 also causes a stream to be added. The
575 * channel deletion will thus be triggered by the following removal of this
578 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
579 /* Increment refcount before decrementing nb_init_stream_left */
581 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
584 /* Update consumer data once the node is inserted. */
585 consumer_data
.stream_count
++;
586 consumer_data
.need_update
= 1;
589 pthread_mutex_unlock(&stream
->lock
);
590 pthread_mutex_unlock(&stream
->chan
->lock
);
591 pthread_mutex_unlock(&consumer_data
.lock
);
597 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
598 * be acquired before calling this.
600 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
603 struct lttng_ht_node_u64
*node
;
604 struct lttng_ht_iter iter
;
608 lttng_ht_lookup(consumer_data
.relayd_ht
,
609 &relayd
->net_seq_idx
, &iter
);
610 node
= lttng_ht_iter_get_node_u64(&iter
);
614 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
621 * Allocate and return a consumer relayd socket.
623 struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
624 uint64_t net_seq_idx
)
626 struct consumer_relayd_sock_pair
*obj
= NULL
;
628 /* net sequence index of -1 is a failure */
629 if (net_seq_idx
== (uint64_t) -1ULL) {
633 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
635 PERROR("zmalloc relayd sock");
639 obj
->net_seq_idx
= net_seq_idx
;
641 obj
->destroy_flag
= 0;
642 obj
->control_sock
.sock
.fd
= -1;
643 obj
->data_sock
.sock
.fd
= -1;
644 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
645 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
652 * Find a relayd socket pair in the global consumer data.
654 * Return the object if found else NULL.
655 * RCU read-side lock must be held across this call and while using the
658 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
660 struct lttng_ht_iter iter
;
661 struct lttng_ht_node_u64
*node
;
662 struct consumer_relayd_sock_pair
*relayd
= NULL
;
664 /* Negative keys are lookup failures */
665 if (key
== (uint64_t) -1ULL) {
669 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
671 node
= lttng_ht_iter_get_node_u64(&iter
);
673 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
681 * Find a relayd and send the stream
683 * Returns 0 on success, < 0 on error
685 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
,
689 struct consumer_relayd_sock_pair
*relayd
;
692 assert(stream
->net_seq_idx
!= -1ULL);
695 /* The stream is not metadata. Get relayd reference if exists. */
697 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
698 if (relayd
!= NULL
) {
699 /* Add stream on the relayd */
700 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
701 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
702 path
, &stream
->relayd_stream_id
,
703 stream
->chan
->tracefile_size
, stream
->chan
->tracefile_count
);
704 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
708 uatomic_inc(&relayd
->refcount
);
709 stream
->sent_to_relayd
= 1;
711 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't send it.",
712 stream
->key
, stream
->net_seq_idx
);
717 DBG("Stream %s with key %" PRIu64
" sent to relayd id %" PRIu64
,
718 stream
->name
, stream
->key
, stream
->net_seq_idx
);
726 * Find a relayd and close the stream
728 void close_relayd_stream(struct lttng_consumer_stream
*stream
)
730 struct consumer_relayd_sock_pair
*relayd
;
732 /* The stream is not metadata. Get relayd reference if exists. */
734 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
736 consumer_stream_relayd_close(stream
, relayd
);
742 * Handle stream for relayd transmission if the stream applies for network
743 * streaming where the net sequence index is set.
745 * Return destination file descriptor or negative value on error.
747 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
748 size_t data_size
, unsigned long padding
,
749 struct consumer_relayd_sock_pair
*relayd
)
752 struct lttcomm_relayd_data_hdr data_hdr
;
758 /* Reset data header */
759 memset(&data_hdr
, 0, sizeof(data_hdr
));
761 if (stream
->metadata_flag
) {
762 /* Caller MUST acquire the relayd control socket lock */
763 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
768 /* Metadata are always sent on the control socket. */
769 outfd
= relayd
->control_sock
.sock
.fd
;
771 /* Set header with stream information */
772 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
773 data_hdr
.data_size
= htobe32(data_size
);
774 data_hdr
.padding_size
= htobe32(padding
);
776 * Note that net_seq_num below is assigned with the *current* value of
777 * next_net_seq_num and only after that the next_net_seq_num will be
778 * increment. This is why when issuing a command on the relayd using
779 * this next value, 1 should always be substracted in order to compare
780 * the last seen sequence number on the relayd side to the last sent.
782 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
783 /* Other fields are zeroed previously */
785 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
791 ++stream
->next_net_seq_num
;
793 /* Set to go on data socket */
794 outfd
= relayd
->data_sock
.sock
.fd
;
802 * Allocate and return a new lttng_consumer_channel object using the given key
803 * to initialize the hash table node.
805 * On error, return NULL.
807 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
809 const char *pathname
,
814 enum lttng_event_output output
,
815 uint64_t tracefile_size
,
816 uint64_t tracefile_count
,
817 uint64_t session_id_per_pid
,
818 unsigned int monitor
)
820 struct lttng_consumer_channel
*channel
;
822 channel
= zmalloc(sizeof(*channel
));
823 if (channel
== NULL
) {
824 PERROR("malloc struct lttng_consumer_channel");
829 channel
->refcount
= 0;
830 channel
->session_id
= session_id
;
831 channel
->session_id_per_pid
= session_id_per_pid
;
834 channel
->relayd_id
= relayd_id
;
835 channel
->output
= output
;
836 channel
->tracefile_size
= tracefile_size
;
837 channel
->tracefile_count
= tracefile_count
;
838 channel
->monitor
= monitor
;
839 pthread_mutex_init(&channel
->lock
, NULL
);
842 * In monitor mode, the streams associated with the channel will be put in
843 * a special list ONLY owned by this channel. So, the refcount is set to 1
844 * here meaning that the channel itself has streams that are referenced.
846 * On a channel deletion, once the channel is no longer visible, the
847 * refcount is decremented and checked for a zero value to delete it. With
848 * streams in no monitor mode, it will now be safe to destroy the channel.
850 if (!channel
->monitor
) {
851 channel
->refcount
= 1;
854 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
855 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
857 strncpy(channel
->name
, name
, sizeof(channel
->name
));
858 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
860 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
862 channel
->wait_fd
= -1;
864 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
866 DBG("Allocated channel (key %" PRIu64
")", channel
->key
)
873 * Add a channel to the global list protected by a mutex.
875 * On success 0 is returned else a negative value.
877 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
878 struct lttng_consumer_local_data
*ctx
)
881 struct lttng_ht_node_u64
*node
;
882 struct lttng_ht_iter iter
;
884 pthread_mutex_lock(&consumer_data
.lock
);
885 pthread_mutex_lock(&channel
->lock
);
888 lttng_ht_lookup(consumer_data
.channel_ht
, &channel
->key
, &iter
);
889 node
= lttng_ht_iter_get_node_u64(&iter
);
891 /* Channel already exist. Ignore the insertion */
892 ERR("Consumer add channel key %" PRIu64
" already exists!",
898 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
902 pthread_mutex_unlock(&channel
->lock
);
903 pthread_mutex_unlock(&consumer_data
.lock
);
905 if (!ret
&& channel
->wait_fd
!= -1 &&
906 channel
->type
== CONSUMER_CHANNEL_TYPE_DATA
) {
907 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
913 * Allocate the pollfd structure and the local view of the out fds to avoid
914 * doing a lookup in the linked list and concurrency issues when writing is
915 * needed. Called with consumer_data.lock held.
917 * Returns the number of fds in the structures.
919 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
920 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
924 struct lttng_ht_iter iter
;
925 struct lttng_consumer_stream
*stream
;
930 assert(local_stream
);
932 DBG("Updating poll fd array");
934 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
936 * Only active streams with an active end point can be added to the
937 * poll set and local stream storage of the thread.
939 * There is a potential race here for endpoint_status to be updated
940 * just after the check. However, this is OK since the stream(s) will
941 * be deleted once the thread is notified that the end point state has
942 * changed where this function will be called back again.
944 if (stream
->state
!= LTTNG_CONSUMER_ACTIVE_STREAM
||
945 stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
949 * This clobbers way too much the debug output. Uncomment that if you
950 * need it for debugging purposes.
952 * DBG("Active FD %d", stream->wait_fd);
954 (*pollfd
)[i
].fd
= stream
->wait_fd
;
955 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
956 local_stream
[i
] = stream
;
962 * Insert the consumer_data_pipe at the end of the array and don't
963 * increment i so nb_fd is the number of real FD.
965 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
966 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
971 * Poll on the should_quit pipe and the command socket return -1 on error and
972 * should exit, 0 if data is available on the command socket
974 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
979 num_rdy
= poll(consumer_sockpoll
, 2, -1);
982 * Restart interrupted system call.
984 if (errno
== EINTR
) {
987 PERROR("Poll error");
990 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
991 DBG("consumer_should_quit wake up");
1001 * Set the error socket.
1003 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1006 ctx
->consumer_error_socket
= sock
;
1010 * Set the command socket path.
1012 void lttng_consumer_set_command_sock_path(
1013 struct lttng_consumer_local_data
*ctx
, char *sock
)
1015 ctx
->consumer_command_sock_path
= sock
;
1019 * Send return code to the session daemon.
1020 * If the socket is not defined, we return 0, it is not a fatal error
1022 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1024 if (ctx
->consumer_error_socket
> 0) {
1025 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1026 sizeof(enum lttcomm_sessiond_command
));
1033 * Close all the tracefiles and stream fds and MUST be called when all
1034 * instances are destroyed i.e. when all threads were joined and are ended.
1036 void lttng_consumer_cleanup(void)
1038 struct lttng_ht_iter iter
;
1039 struct lttng_consumer_channel
*channel
;
1043 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1045 consumer_del_channel(channel
);
1050 lttng_ht_destroy(consumer_data
.channel_ht
);
1052 cleanup_relayd_ht();
1054 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1057 * This HT contains streams that are freed by either the metadata thread or
1058 * the data thread so we do *nothing* on the hash table and simply destroy
1061 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1065 * Called from signal handler.
1067 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1072 ret
= write(ctx
->consumer_should_quit
[1], "4", 1);
1073 } while (ret
< 0 && errno
== EINTR
);
1074 if (ret
< 0 || ret
!= 1) {
1075 PERROR("write consumer quit");
1078 DBG("Consumer flag that it should quit");
1081 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1084 int outfd
= stream
->out_fd
;
1087 * This does a blocking write-and-wait on any page that belongs to the
1088 * subbuffer prior to the one we just wrote.
1089 * Don't care about error values, as these are just hints and ways to
1090 * limit the amount of page cache used.
1092 if (orig_offset
< stream
->max_sb_size
) {
1095 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1096 stream
->max_sb_size
,
1097 SYNC_FILE_RANGE_WAIT_BEFORE
1098 | SYNC_FILE_RANGE_WRITE
1099 | SYNC_FILE_RANGE_WAIT_AFTER
);
1101 * Give hints to the kernel about how we access the file:
1102 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1105 * We need to call fadvise again after the file grows because the
1106 * kernel does not seem to apply fadvise to non-existing parts of the
1109 * Call fadvise _after_ having waited for the page writeback to
1110 * complete because the dirty page writeback semantic is not well
1111 * defined. So it can be expected to lead to lower throughput in
1114 posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1115 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1119 * Initialise the necessary environnement :
1120 * - create a new context
1121 * - create the poll_pipe
1122 * - create the should_quit pipe (for signal handler)
1123 * - create the thread pipe (for splice)
1125 * Takes a function pointer as argument, this function is called when data is
1126 * available on a buffer. This function is responsible to do the
1127 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1128 * buffer configuration and then kernctl_put_next_subbuf at the end.
1130 * Returns a pointer to the new context or NULL on error.
1132 struct lttng_consumer_local_data
*lttng_consumer_create(
1133 enum lttng_consumer_type type
,
1134 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1135 struct lttng_consumer_local_data
*ctx
),
1136 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1137 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1138 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1141 struct lttng_consumer_local_data
*ctx
;
1143 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1144 consumer_data
.type
== type
);
1145 consumer_data
.type
= type
;
1147 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1149 PERROR("allocating context");
1153 ctx
->consumer_error_socket
= -1;
1154 ctx
->consumer_metadata_socket
= -1;
1155 /* assign the callbacks */
1156 ctx
->on_buffer_ready
= buffer_ready
;
1157 ctx
->on_recv_channel
= recv_channel
;
1158 ctx
->on_recv_stream
= recv_stream
;
1159 ctx
->on_update_stream
= update_stream
;
1161 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1162 if (!ctx
->consumer_data_pipe
) {
1163 goto error_poll_pipe
;
1166 ret
= pipe(ctx
->consumer_should_quit
);
1168 PERROR("Error creating recv pipe");
1169 goto error_quit_pipe
;
1172 ret
= pipe(ctx
->consumer_thread_pipe
);
1174 PERROR("Error creating thread pipe");
1175 goto error_thread_pipe
;
1178 ret
= pipe(ctx
->consumer_channel_pipe
);
1180 PERROR("Error creating channel pipe");
1181 goto error_channel_pipe
;
1184 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1185 if (!ctx
->consumer_metadata_pipe
) {
1186 goto error_metadata_pipe
;
1189 ret
= utils_create_pipe(ctx
->consumer_splice_metadata_pipe
);
1191 goto error_splice_pipe
;
1197 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1198 error_metadata_pipe
:
1199 utils_close_pipe(ctx
->consumer_channel_pipe
);
1201 utils_close_pipe(ctx
->consumer_thread_pipe
);
1203 utils_close_pipe(ctx
->consumer_should_quit
);
1205 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1213 * Close all fds associated with the instance and free the context.
1215 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1219 DBG("Consumer destroying it. Closing everything.");
1221 ret
= close(ctx
->consumer_error_socket
);
1225 ret
= close(ctx
->consumer_metadata_socket
);
1229 utils_close_pipe(ctx
->consumer_thread_pipe
);
1230 utils_close_pipe(ctx
->consumer_channel_pipe
);
1231 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1232 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1233 utils_close_pipe(ctx
->consumer_should_quit
);
1234 utils_close_pipe(ctx
->consumer_splice_metadata_pipe
);
1236 unlink(ctx
->consumer_command_sock_path
);
1241 * Write the metadata stream id on the specified file descriptor.
1243 static int write_relayd_metadata_id(int fd
,
1244 struct lttng_consumer_stream
*stream
,
1245 struct consumer_relayd_sock_pair
*relayd
, unsigned long padding
)
1248 struct lttcomm_relayd_metadata_payload hdr
;
1250 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1251 hdr
.padding_size
= htobe32(padding
);
1253 ret
= write(fd
, (void *) &hdr
, sizeof(hdr
));
1254 } while (ret
< 0 && errno
== EINTR
);
1255 if (ret
< 0 || ret
!= sizeof(hdr
)) {
1257 * This error means that the fd's end is closed so ignore the perror
1258 * not to clubber the error output since this can happen in a normal
1261 if (errno
!= EPIPE
) {
1262 PERROR("write metadata stream id");
1264 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1266 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1267 * handle writting the missing part so report that as an error and
1268 * don't lie to the caller.
1273 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1274 stream
->relayd_stream_id
, padding
);
1281 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1282 * core function for writing trace buffers to either the local filesystem or
1285 * It must be called with the stream lock held.
1287 * Careful review MUST be put if any changes occur!
1289 * Returns the number of bytes written
1291 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1292 struct lttng_consumer_local_data
*ctx
,
1293 struct lttng_consumer_stream
*stream
, unsigned long len
,
1294 unsigned long padding
)
1296 unsigned long mmap_offset
;
1298 ssize_t ret
= 0, written
= 0;
1299 off_t orig_offset
= stream
->out_fd_offset
;
1300 /* Default is on the disk */
1301 int outfd
= stream
->out_fd
;
1302 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1303 unsigned int relayd_hang_up
= 0;
1305 /* RCU lock for the relayd pointer */
1308 /* Flag that the current stream if set for network streaming. */
1309 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1310 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1311 if (relayd
== NULL
) {
1316 /* get the offset inside the fd to mmap */
1317 switch (consumer_data
.type
) {
1318 case LTTNG_CONSUMER_KERNEL
:
1319 mmap_base
= stream
->mmap_base
;
1320 ret
= kernctl_get_mmap_read_offset(stream
->wait_fd
, &mmap_offset
);
1322 case LTTNG_CONSUMER32_UST
:
1323 case LTTNG_CONSUMER64_UST
:
1324 mmap_base
= lttng_ustctl_get_mmap_base(stream
);
1326 ERR("read mmap get mmap base for stream %s", stream
->name
);
1330 ret
= lttng_ustctl_get_mmap_read_offset(stream
, &mmap_offset
);
1334 ERR("Unknown consumer_data type");
1339 PERROR("tracer ctl get_mmap_read_offset");
1344 /* Handle stream on the relayd if the output is on the network */
1346 unsigned long netlen
= len
;
1349 * Lock the control socket for the complete duration of the function
1350 * since from this point on we will use the socket.
1352 if (stream
->metadata_flag
) {
1353 /* Metadata requires the control socket. */
1354 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1355 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1358 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1360 /* Use the returned socket. */
1363 /* Write metadata stream id before payload */
1364 if (stream
->metadata_flag
) {
1365 ret
= write_relayd_metadata_id(outfd
, stream
, relayd
, padding
);
1368 /* Socket operation failed. We consider the relayd dead */
1369 if (ret
== -EPIPE
|| ret
== -EINVAL
) {
1377 /* Socket operation failed. We consider the relayd dead */
1378 if (ret
== -EPIPE
|| ret
== -EINVAL
) {
1382 /* Else, use the default set before which is the filesystem. */
1385 /* No streaming, we have to set the len with the full padding */
1389 * Check if we need to change the tracefile before writing the packet.
1391 if (stream
->chan
->tracefile_size
> 0 &&
1392 (stream
->tracefile_size_current
+ len
) >
1393 stream
->chan
->tracefile_size
) {
1394 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1395 stream
->name
, stream
->chan
->tracefile_size
,
1396 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1397 stream
->out_fd
, &(stream
->tracefile_count_current
));
1399 ERR("Rotating output file");
1402 outfd
= stream
->out_fd
= ret
;
1403 /* Reset current size because we just perform a rotation. */
1404 stream
->tracefile_size_current
= 0;
1406 stream
->tracefile_size_current
+= len
;
1411 ret
= write(outfd
, mmap_base
+ mmap_offset
, len
);
1412 } while (ret
< 0 && errno
== EINTR
);
1413 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, len
);
1416 * This is possible if the fd is closed on the other side (outfd)
1417 * or any write problem. It can be verbose a bit for a normal
1418 * execution if for instance the relayd is stopped abruptly. This
1419 * can happen so set this to a DBG statement.
1421 DBG("Error in file write mmap");
1425 /* Socket operation failed. We consider the relayd dead */
1426 if (errno
== EPIPE
|| errno
== EINVAL
) {
1431 } else if (ret
> len
) {
1432 PERROR("Error in file write (ret %zd > len %lu)", ret
, len
);
1440 /* This call is useless on a socket so better save a syscall. */
1442 /* This won't block, but will start writeout asynchronously */
1443 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret
,
1444 SYNC_FILE_RANGE_WRITE
);
1445 stream
->out_fd_offset
+= ret
;
1449 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1453 * This is a special case that the relayd has closed its socket. Let's
1454 * cleanup the relayd object and all associated streams.
1456 if (relayd
&& relayd_hang_up
) {
1457 cleanup_relayd(relayd
, ctx
);
1461 /* Unlock only if ctrl socket used */
1462 if (relayd
&& stream
->metadata_flag
) {
1463 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1471 * Splice the data from the ring buffer to the tracefile.
1473 * It must be called with the stream lock held.
1475 * Returns the number of bytes spliced.
1477 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1478 struct lttng_consumer_local_data
*ctx
,
1479 struct lttng_consumer_stream
*stream
, unsigned long len
,
1480 unsigned long padding
)
1482 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1484 off_t orig_offset
= stream
->out_fd_offset
;
1485 int fd
= stream
->wait_fd
;
1486 /* Default is on the disk */
1487 int outfd
= stream
->out_fd
;
1488 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1490 unsigned int relayd_hang_up
= 0;
1492 switch (consumer_data
.type
) {
1493 case LTTNG_CONSUMER_KERNEL
:
1495 case LTTNG_CONSUMER32_UST
:
1496 case LTTNG_CONSUMER64_UST
:
1497 /* Not supported for user space tracing */
1500 ERR("Unknown consumer_data type");
1504 /* RCU lock for the relayd pointer */
1507 /* Flag that the current stream if set for network streaming. */
1508 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1509 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1510 if (relayd
== NULL
) {
1516 * Choose right pipe for splice. Metadata and trace data are handled by
1517 * different threads hence the use of two pipes in order not to race or
1518 * corrupt the written data.
1520 if (stream
->metadata_flag
) {
1521 splice_pipe
= ctx
->consumer_splice_metadata_pipe
;
1523 splice_pipe
= ctx
->consumer_thread_pipe
;
1526 /* Write metadata stream id before payload */
1528 int total_len
= len
;
1530 if (stream
->metadata_flag
) {
1532 * Lock the control socket for the complete duration of the function
1533 * since from this point on we will use the socket.
1535 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1537 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
, relayd
,
1541 /* Socket operation failed. We consider the relayd dead */
1542 if (ret
== -EBADF
) {
1543 WARN("Remote relayd disconnected. Stopping");
1550 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1553 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1555 /* Use the returned socket. */
1558 /* Socket operation failed. We consider the relayd dead */
1559 if (ret
== -EBADF
) {
1560 WARN("Remote relayd disconnected. Stopping");
1567 /* No streaming, we have to set the len with the full padding */
1571 * Check if we need to change the tracefile before writing the packet.
1573 if (stream
->chan
->tracefile_size
> 0 &&
1574 (stream
->tracefile_size_current
+ len
) >
1575 stream
->chan
->tracefile_size
) {
1576 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1577 stream
->name
, stream
->chan
->tracefile_size
,
1578 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1579 stream
->out_fd
, &(stream
->tracefile_count_current
));
1581 ERR("Rotating output file");
1584 outfd
= stream
->out_fd
= ret
;
1585 /* Reset current size because we just perform a rotation. */
1586 stream
->tracefile_size_current
= 0;
1588 stream
->tracefile_size_current
+= len
;
1592 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1593 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1594 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1595 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1596 DBG("splice chan to pipe, ret %zd", ret_splice
);
1597 if (ret_splice
< 0) {
1598 PERROR("Error in relay splice");
1600 written
= ret_splice
;
1606 /* Handle stream on the relayd if the output is on the network */
1608 if (stream
->metadata_flag
) {
1609 size_t metadata_payload_size
=
1610 sizeof(struct lttcomm_relayd_metadata_payload
);
1612 /* Update counter to fit the spliced data */
1613 ret_splice
+= metadata_payload_size
;
1614 len
+= metadata_payload_size
;
1616 * We do this so the return value can match the len passed as
1617 * argument to this function.
1619 written
-= metadata_payload_size
;
1623 /* Splice data out */
1624 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1625 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1626 DBG("Consumer splice pipe to file, ret %zd", ret_splice
);
1627 if (ret_splice
< 0) {
1628 PERROR("Error in file splice");
1630 written
= ret_splice
;
1632 /* Socket operation failed. We consider the relayd dead */
1633 if (errno
== EBADF
|| errno
== EPIPE
) {
1634 WARN("Remote relayd disconnected. Stopping");
1640 } else if (ret_splice
> len
) {
1642 PERROR("Wrote more data than requested %zd (len: %lu)",
1644 written
+= ret_splice
;
1650 /* This call is useless on a socket so better save a syscall. */
1652 /* This won't block, but will start writeout asynchronously */
1653 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
1654 SYNC_FILE_RANGE_WRITE
);
1655 stream
->out_fd_offset
+= ret_splice
;
1657 written
+= ret_splice
;
1659 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1667 * This is a special case that the relayd has closed its socket. Let's
1668 * cleanup the relayd object and all associated streams.
1670 if (relayd
&& relayd_hang_up
) {
1671 cleanup_relayd(relayd
, ctx
);
1672 /* Skip splice error so the consumer does not fail */
1677 /* send the appropriate error description to sessiond */
1680 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
1683 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
1686 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
1691 if (relayd
&& stream
->metadata_flag
) {
1692 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1700 * Take a snapshot for a specific fd
1702 * Returns 0 on success, < 0 on error
1704 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1706 switch (consumer_data
.type
) {
1707 case LTTNG_CONSUMER_KERNEL
:
1708 return lttng_kconsumer_take_snapshot(stream
);
1709 case LTTNG_CONSUMER32_UST
:
1710 case LTTNG_CONSUMER64_UST
:
1711 return lttng_ustconsumer_take_snapshot(stream
);
1713 ERR("Unknown consumer_data type");
1720 * Get the produced position
1722 * Returns 0 on success, < 0 on error
1724 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
1727 switch (consumer_data
.type
) {
1728 case LTTNG_CONSUMER_KERNEL
:
1729 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
1730 case LTTNG_CONSUMER32_UST
:
1731 case LTTNG_CONSUMER64_UST
:
1732 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
1734 ERR("Unknown consumer_data type");
1740 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1741 int sock
, struct pollfd
*consumer_sockpoll
)
1743 switch (consumer_data
.type
) {
1744 case LTTNG_CONSUMER_KERNEL
:
1745 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1746 case LTTNG_CONSUMER32_UST
:
1747 case LTTNG_CONSUMER64_UST
:
1748 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1750 ERR("Unknown consumer_data type");
1757 * Iterate over all streams of the hashtable and free them properly.
1759 * WARNING: *MUST* be used with data stream only.
1761 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1763 struct lttng_ht_iter iter
;
1764 struct lttng_consumer_stream
*stream
;
1771 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1773 * Ignore return value since we are currently cleaning up so any error
1776 (void) consumer_del_stream(stream
, ht
);
1780 lttng_ht_destroy(ht
);
1784 * Iterate over all streams of the hashtable and free them properly.
1786 * XXX: Should not be only for metadata stream or else use an other name.
1788 static void destroy_stream_ht(struct lttng_ht
*ht
)
1790 struct lttng_ht_iter iter
;
1791 struct lttng_consumer_stream
*stream
;
1798 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1800 * Ignore return value since we are currently cleaning up so any error
1803 (void) consumer_del_metadata_stream(stream
, ht
);
1807 lttng_ht_destroy(ht
);
1810 void lttng_consumer_close_metadata(void)
1812 switch (consumer_data
.type
) {
1813 case LTTNG_CONSUMER_KERNEL
:
1815 * The Kernel consumer has a different metadata scheme so we don't
1816 * close anything because the stream will be closed by the session
1820 case LTTNG_CONSUMER32_UST
:
1821 case LTTNG_CONSUMER64_UST
:
1823 * Close all metadata streams. The metadata hash table is passed and
1824 * this call iterates over it by closing all wakeup fd. This is safe
1825 * because at this point we are sure that the metadata producer is
1826 * either dead or blocked.
1828 lttng_ustconsumer_close_metadata(metadata_ht
);
1831 ERR("Unknown consumer_data type");
1837 * Clean up a metadata stream and free its memory.
1839 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
1840 struct lttng_ht
*ht
)
1843 struct lttng_ht_iter iter
;
1844 struct lttng_consumer_channel
*free_chan
= NULL
;
1845 struct consumer_relayd_sock_pair
*relayd
;
1849 * This call should NEVER receive regular stream. It must always be
1850 * metadata stream and this is crucial for data structure synchronization.
1852 assert(stream
->metadata_flag
);
1854 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
1857 /* Means the stream was allocated but not successfully added */
1858 goto free_stream_rcu
;
1861 pthread_mutex_lock(&consumer_data
.lock
);
1862 pthread_mutex_lock(&stream
->chan
->lock
);
1863 pthread_mutex_lock(&stream
->lock
);
1865 switch (consumer_data
.type
) {
1866 case LTTNG_CONSUMER_KERNEL
:
1867 if (stream
->mmap_base
!= NULL
) {
1868 ret
= munmap(stream
->mmap_base
, stream
->mmap_len
);
1870 PERROR("munmap metadata stream");
1873 if (stream
->wait_fd
>= 0) {
1874 ret
= close(stream
->wait_fd
);
1876 PERROR("close kernel metadata wait_fd");
1880 case LTTNG_CONSUMER32_UST
:
1881 case LTTNG_CONSUMER64_UST
:
1882 lttng_ustconsumer_del_stream(stream
);
1885 ERR("Unknown consumer_data type");
1891 iter
.iter
.node
= &stream
->node
.node
;
1892 ret
= lttng_ht_del(ht
, &iter
);
1895 iter
.iter
.node
= &stream
->node_channel_id
.node
;
1896 ret
= lttng_ht_del(consumer_data
.stream_per_chan_id_ht
, &iter
);
1899 iter
.iter
.node
= &stream
->node_session_id
.node
;
1900 ret
= lttng_ht_del(consumer_data
.stream_list_ht
, &iter
);
1904 if (stream
->out_fd
>= 0) {
1905 ret
= close(stream
->out_fd
);
1911 /* Check and cleanup relayd */
1913 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1914 if (relayd
!= NULL
) {
1915 uatomic_dec(&relayd
->refcount
);
1916 assert(uatomic_read(&relayd
->refcount
) >= 0);
1918 /* Closing streams requires to lock the control socket. */
1919 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1920 ret
= relayd_send_close_stream(&relayd
->control_sock
,
1921 stream
->relayd_stream_id
, stream
->next_net_seq_num
- 1);
1922 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1924 DBG("Unable to close stream on the relayd. Continuing");
1926 * Continue here. There is nothing we can do for the relayd.
1927 * Chances are that the relayd has closed the socket so we just
1928 * continue cleaning up.
1932 /* Both conditions are met, we destroy the relayd. */
1933 if (uatomic_read(&relayd
->refcount
) == 0 &&
1934 uatomic_read(&relayd
->destroy_flag
)) {
1935 consumer_destroy_relayd(relayd
);
1940 /* Atomically decrement channel refcount since other threads can use it. */
1941 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1)
1942 && !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
1943 /* Go for channel deletion! */
1944 free_chan
= stream
->chan
;
1949 * Nullify the stream reference so it is not used after deletion. The
1950 * consumer data lock MUST be acquired before being able to check for a
1951 * NULL pointer value.
1953 stream
->chan
->metadata_stream
= NULL
;
1955 pthread_mutex_unlock(&stream
->lock
);
1956 pthread_mutex_unlock(&stream
->chan
->lock
);
1957 pthread_mutex_unlock(&consumer_data
.lock
);
1960 consumer_del_channel(free_chan
);
1964 call_rcu(&stream
->node
.head
, free_stream_rcu
);
1968 * Action done with the metadata stream when adding it to the consumer internal
1969 * data structures to handle it.
1971 static int add_metadata_stream(struct lttng_consumer_stream
*stream
,
1972 struct lttng_ht
*ht
)
1975 struct lttng_ht_iter iter
;
1976 struct lttng_ht_node_u64
*node
;
1981 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
1983 pthread_mutex_lock(&consumer_data
.lock
);
1984 pthread_mutex_lock(&stream
->chan
->lock
);
1985 pthread_mutex_lock(&stream
->lock
);
1988 * From here, refcounts are updated so be _careful_ when returning an error
1995 * Lookup the stream just to make sure it does not exist in our internal
1996 * state. This should NEVER happen.
1998 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
1999 node
= lttng_ht_iter_get_node_u64(&iter
);
2003 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2004 * in terms of destroying the associated channel, because the action that
2005 * causes the count to become 0 also causes a stream to be added. The
2006 * channel deletion will thus be triggered by the following removal of this
2009 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2010 /* Increment refcount before decrementing nb_init_stream_left */
2012 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2015 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2017 lttng_ht_add_unique_u64(consumer_data
.stream_per_chan_id_ht
,
2018 &stream
->node_channel_id
);
2021 * Add stream to the stream_list_ht of the consumer data. No need to steal
2022 * the key since the HT does not use it and we allow to add redundant keys
2025 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2029 pthread_mutex_unlock(&stream
->lock
);
2030 pthread_mutex_unlock(&stream
->chan
->lock
);
2031 pthread_mutex_unlock(&consumer_data
.lock
);
2036 * Delete data stream that are flagged for deletion (endpoint_status).
2038 static void validate_endpoint_status_data_stream(void)
2040 struct lttng_ht_iter iter
;
2041 struct lttng_consumer_stream
*stream
;
2043 DBG("Consumer delete flagged data stream");
2046 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2047 /* Validate delete flag of the stream */
2048 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2051 /* Delete it right now */
2052 consumer_del_stream(stream
, data_ht
);
2058 * Delete metadata stream that are flagged for deletion (endpoint_status).
2060 static void validate_endpoint_status_metadata_stream(
2061 struct lttng_poll_event
*pollset
)
2063 struct lttng_ht_iter iter
;
2064 struct lttng_consumer_stream
*stream
;
2066 DBG("Consumer delete flagged metadata stream");
2071 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2072 /* Validate delete flag of the stream */
2073 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2077 * Remove from pollset so the metadata thread can continue without
2078 * blocking on a deleted stream.
2080 lttng_poll_del(pollset
, stream
->wait_fd
);
2082 /* Delete it right now */
2083 consumer_del_metadata_stream(stream
, metadata_ht
);
2089 * Thread polls on metadata file descriptor and write them on disk or on the
2092 void *consumer_thread_metadata_poll(void *data
)
2095 uint32_t revents
, nb_fd
;
2096 struct lttng_consumer_stream
*stream
= NULL
;
2097 struct lttng_ht_iter iter
;
2098 struct lttng_ht_node_u64
*node
;
2099 struct lttng_poll_event events
;
2100 struct lttng_consumer_local_data
*ctx
= data
;
2103 rcu_register_thread();
2105 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2107 /* ENOMEM at this point. Better to bail out. */
2111 DBG("Thread metadata poll started");
2113 /* Size is set to 1 for the consumer_metadata pipe */
2114 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2116 ERR("Poll set creation failed");
2120 ret
= lttng_poll_add(&events
,
2121 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2127 DBG("Metadata main loop started");
2130 /* Only the metadata pipe is set */
2131 if (LTTNG_POLL_GETNB(&events
) == 0 && consumer_quit
== 1) {
2136 DBG("Metadata poll wait with %d fd(s)", LTTNG_POLL_GETNB(&events
));
2137 ret
= lttng_poll_wait(&events
, -1);
2138 DBG("Metadata event catched in thread");
2140 if (errno
== EINTR
) {
2141 ERR("Poll EINTR catched");
2149 /* From here, the event is a metadata wait fd */
2150 for (i
= 0; i
< nb_fd
; i
++) {
2151 revents
= LTTNG_POLL_GETEV(&events
, i
);
2152 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2154 /* Just don't waste time if no returned events for the fd */
2159 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2160 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2161 DBG("Metadata thread pipe hung up");
2163 * Remove the pipe from the poll set and continue the loop
2164 * since their might be data to consume.
2166 lttng_poll_del(&events
,
2167 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2168 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2170 } else if (revents
& LPOLLIN
) {
2173 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2174 &stream
, sizeof(stream
));
2176 ERR("read metadata stream, ret: %ld", pipe_len
);
2178 * Continue here to handle the rest of the streams.
2183 /* A NULL stream means that the state has changed. */
2184 if (stream
== NULL
) {
2185 /* Check for deleted streams. */
2186 validate_endpoint_status_metadata_stream(&events
);
2190 DBG("Adding metadata stream %d to poll set",
2193 ret
= add_metadata_stream(stream
, metadata_ht
);
2195 ERR("Unable to add metadata stream");
2196 /* Stream was not setup properly. Continuing. */
2197 consumer_del_metadata_stream(stream
, NULL
);
2201 /* Add metadata stream to the global poll events list */
2202 lttng_poll_add(&events
, stream
->wait_fd
,
2203 LPOLLIN
| LPOLLPRI
);
2206 /* Handle other stream */
2212 uint64_t tmp_id
= (uint64_t) pollfd
;
2214 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2216 node
= lttng_ht_iter_get_node_u64(&iter
);
2219 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2222 /* Check for error event */
2223 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2224 DBG("Metadata fd %d is hup|err.", pollfd
);
2225 if (!stream
->hangup_flush_done
2226 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2227 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2228 DBG("Attempting to flush and consume the UST buffers");
2229 lttng_ustconsumer_on_stream_hangup(stream
);
2231 /* We just flushed the stream now read it. */
2233 len
= ctx
->on_buffer_ready(stream
, ctx
);
2235 * We don't check the return value here since if we get
2236 * a negative len, it means an error occured thus we
2237 * simply remove it from the poll set and free the
2243 lttng_poll_del(&events
, stream
->wait_fd
);
2245 * This call update the channel states, closes file descriptors
2246 * and securely free the stream.
2248 consumer_del_metadata_stream(stream
, metadata_ht
);
2249 } else if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2250 /* Get the data out of the metadata file descriptor */
2251 DBG("Metadata available on fd %d", pollfd
);
2252 assert(stream
->wait_fd
== pollfd
);
2254 len
= ctx
->on_buffer_ready(stream
, ctx
);
2255 /* It's ok to have an unavailable sub-buffer */
2256 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2257 /* Clean up stream from consumer and free it. */
2258 lttng_poll_del(&events
, stream
->wait_fd
);
2259 consumer_del_metadata_stream(stream
, metadata_ht
);
2260 } else if (len
> 0) {
2261 stream
->data_read
= 1;
2265 /* Release RCU lock for the stream looked up */
2272 DBG("Metadata poll thread exiting");
2274 lttng_poll_clean(&events
);
2276 destroy_stream_ht(metadata_ht
);
2278 rcu_unregister_thread();
2283 * This thread polls the fds in the set to consume the data and write
2284 * it to tracefile if necessary.
2286 void *consumer_thread_data_poll(void *data
)
2288 int num_rdy
, num_hup
, high_prio
, ret
, i
;
2289 struct pollfd
*pollfd
= NULL
;
2290 /* local view of the streams */
2291 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2292 /* local view of consumer_data.fds_count */
2294 struct lttng_consumer_local_data
*ctx
= data
;
2297 rcu_register_thread();
2299 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2300 if (data_ht
== NULL
) {
2301 /* ENOMEM at this point. Better to bail out. */
2305 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
*));
2306 if (local_stream
== NULL
) {
2307 PERROR("local_stream malloc");
2316 * the fds set has been updated, we need to update our
2317 * local array as well
2319 pthread_mutex_lock(&consumer_data
.lock
);
2320 if (consumer_data
.need_update
) {
2325 local_stream
= NULL
;
2327 /* allocate for all fds + 1 for the consumer_data_pipe */
2328 pollfd
= zmalloc((consumer_data
.stream_count
+ 1) * sizeof(struct pollfd
));
2329 if (pollfd
== NULL
) {
2330 PERROR("pollfd malloc");
2331 pthread_mutex_unlock(&consumer_data
.lock
);
2335 /* allocate for all fds + 1 for the consumer_data_pipe */
2336 local_stream
= zmalloc((consumer_data
.stream_count
+ 1) *
2337 sizeof(struct lttng_consumer_stream
*));
2338 if (local_stream
== NULL
) {
2339 PERROR("local_stream malloc");
2340 pthread_mutex_unlock(&consumer_data
.lock
);
2343 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2346 ERR("Error in allocating pollfd or local_outfds");
2347 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2348 pthread_mutex_unlock(&consumer_data
.lock
);
2352 consumer_data
.need_update
= 0;
2354 pthread_mutex_unlock(&consumer_data
.lock
);
2356 /* No FDs and consumer_quit, consumer_cleanup the thread */
2357 if (nb_fd
== 0 && consumer_quit
== 1) {
2360 /* poll on the array of fds */
2362 DBG("polling on %d fd", nb_fd
+ 1);
2363 num_rdy
= poll(pollfd
, nb_fd
+ 1, -1);
2364 DBG("poll num_rdy : %d", num_rdy
);
2365 if (num_rdy
== -1) {
2367 * Restart interrupted system call.
2369 if (errno
== EINTR
) {
2372 PERROR("Poll error");
2373 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2375 } else if (num_rdy
== 0) {
2376 DBG("Polling thread timed out");
2381 * If the consumer_data_pipe triggered poll go directly to the
2382 * beginning of the loop to update the array. We want to prioritize
2383 * array update over low-priority reads.
2385 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2386 ssize_t pipe_readlen
;
2388 DBG("consumer_data_pipe wake up");
2389 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2390 &new_stream
, sizeof(new_stream
));
2391 if (pipe_readlen
< 0) {
2392 ERR("Consumer data pipe ret %ld", pipe_readlen
);
2393 /* Continue so we can at least handle the current stream(s). */
2398 * If the stream is NULL, just ignore it. It's also possible that
2399 * the sessiond poll thread changed the consumer_quit state and is
2400 * waking us up to test it.
2402 if (new_stream
== NULL
) {
2403 validate_endpoint_status_data_stream();
2407 ret
= add_stream(new_stream
, data_ht
);
2409 ERR("Consumer add stream %" PRIu64
" failed. Continuing",
2412 * At this point, if the add_stream fails, it is not in the
2413 * hash table thus passing the NULL value here.
2415 consumer_del_stream(new_stream
, NULL
);
2418 /* Continue to update the local streams and handle prio ones */
2422 /* Take care of high priority channels first. */
2423 for (i
= 0; i
< nb_fd
; i
++) {
2424 if (local_stream
[i
] == NULL
) {
2427 if (pollfd
[i
].revents
& POLLPRI
) {
2428 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2430 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2431 /* it's ok to have an unavailable sub-buffer */
2432 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2433 /* Clean the stream and free it. */
2434 consumer_del_stream(local_stream
[i
], data_ht
);
2435 local_stream
[i
] = NULL
;
2436 } else if (len
> 0) {
2437 local_stream
[i
]->data_read
= 1;
2443 * If we read high prio channel in this loop, try again
2444 * for more high prio data.
2450 /* Take care of low priority channels. */
2451 for (i
= 0; i
< nb_fd
; i
++) {
2452 if (local_stream
[i
] == NULL
) {
2455 if ((pollfd
[i
].revents
& POLLIN
) ||
2456 local_stream
[i
]->hangup_flush_done
) {
2457 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2458 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2459 /* it's ok to have an unavailable sub-buffer */
2460 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2461 /* Clean the stream and free it. */
2462 consumer_del_stream(local_stream
[i
], data_ht
);
2463 local_stream
[i
] = NULL
;
2464 } else if (len
> 0) {
2465 local_stream
[i
]->data_read
= 1;
2470 /* Handle hangup and errors */
2471 for (i
= 0; i
< nb_fd
; i
++) {
2472 if (local_stream
[i
] == NULL
) {
2475 if (!local_stream
[i
]->hangup_flush_done
2476 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2477 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2478 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2479 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2481 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2482 /* Attempt read again, for the data we just flushed. */
2483 local_stream
[i
]->data_read
= 1;
2486 * If the poll flag is HUP/ERR/NVAL and we have
2487 * read no data in this pass, we can remove the
2488 * stream from its hash table.
2490 if ((pollfd
[i
].revents
& POLLHUP
)) {
2491 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2492 if (!local_stream
[i
]->data_read
) {
2493 consumer_del_stream(local_stream
[i
], data_ht
);
2494 local_stream
[i
] = NULL
;
2497 } else if (pollfd
[i
].revents
& POLLERR
) {
2498 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2499 if (!local_stream
[i
]->data_read
) {
2500 consumer_del_stream(local_stream
[i
], data_ht
);
2501 local_stream
[i
] = NULL
;
2504 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2505 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2506 if (!local_stream
[i
]->data_read
) {
2507 consumer_del_stream(local_stream
[i
], data_ht
);
2508 local_stream
[i
] = NULL
;
2512 if (local_stream
[i
] != NULL
) {
2513 local_stream
[i
]->data_read
= 0;
2518 DBG("polling thread exiting");
2523 * Close the write side of the pipe so epoll_wait() in
2524 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2525 * read side of the pipe. If we close them both, epoll_wait strangely does
2526 * not return and could create a endless wait period if the pipe is the
2527 * only tracked fd in the poll set. The thread will take care of closing
2530 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2532 destroy_data_stream_ht(data_ht
);
2534 rcu_unregister_thread();
2539 * Close wake-up end of each stream belonging to the channel. This will
2540 * allow the poll() on the stream read-side to detect when the
2541 * write-side (application) finally closes them.
2544 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2546 struct lttng_ht
*ht
;
2547 struct lttng_consumer_stream
*stream
;
2548 struct lttng_ht_iter iter
;
2550 ht
= consumer_data
.stream_per_chan_id_ht
;
2553 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2554 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2555 ht
->match_fct
, &channel
->key
,
2556 &iter
.iter
, stream
, node_channel_id
.node
) {
2558 * Protect against teardown with mutex.
2560 pthread_mutex_lock(&stream
->lock
);
2561 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2564 switch (consumer_data
.type
) {
2565 case LTTNG_CONSUMER_KERNEL
:
2567 case LTTNG_CONSUMER32_UST
:
2568 case LTTNG_CONSUMER64_UST
:
2570 * Note: a mutex is taken internally within
2571 * liblttng-ust-ctl to protect timer wakeup_fd
2572 * use from concurrent close.
2574 lttng_ustconsumer_close_stream_wakeup(stream
);
2577 ERR("Unknown consumer_data type");
2581 pthread_mutex_unlock(&stream
->lock
);
2586 static void destroy_channel_ht(struct lttng_ht
*ht
)
2588 struct lttng_ht_iter iter
;
2589 struct lttng_consumer_channel
*channel
;
2597 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2598 ret
= lttng_ht_del(ht
, &iter
);
2603 lttng_ht_destroy(ht
);
2607 * This thread polls the channel fds to detect when they are being
2608 * closed. It closes all related streams if the channel is detected as
2609 * closed. It is currently only used as a shim layer for UST because the
2610 * consumerd needs to keep the per-stream wakeup end of pipes open for
2613 void *consumer_thread_channel_poll(void *data
)
2616 uint32_t revents
, nb_fd
;
2617 struct lttng_consumer_channel
*chan
= NULL
;
2618 struct lttng_ht_iter iter
;
2619 struct lttng_ht_node_u64
*node
;
2620 struct lttng_poll_event events
;
2621 struct lttng_consumer_local_data
*ctx
= data
;
2622 struct lttng_ht
*channel_ht
;
2624 rcu_register_thread();
2626 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2628 /* ENOMEM at this point. Better to bail out. */
2632 DBG("Thread channel poll started");
2634 /* Size is set to 1 for the consumer_channel pipe */
2635 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2637 ERR("Poll set creation failed");
2641 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
2647 DBG("Channel main loop started");
2650 /* Only the channel pipe is set */
2651 if (LTTNG_POLL_GETNB(&events
) == 0 && consumer_quit
== 1) {
2656 DBG("Channel poll wait with %d fd(s)", LTTNG_POLL_GETNB(&events
));
2657 ret
= lttng_poll_wait(&events
, -1);
2658 DBG("Channel event catched in thread");
2660 if (errno
== EINTR
) {
2661 ERR("Poll EINTR catched");
2669 /* From here, the event is a channel wait fd */
2670 for (i
= 0; i
< nb_fd
; i
++) {
2671 revents
= LTTNG_POLL_GETEV(&events
, i
);
2672 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2674 /* Just don't waste time if no returned events for the fd */
2678 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
2679 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2680 DBG("Channel thread pipe hung up");
2682 * Remove the pipe from the poll set and continue the loop
2683 * since their might be data to consume.
2685 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2687 } else if (revents
& LPOLLIN
) {
2688 enum consumer_channel_action action
;
2691 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
2693 ERR("Error reading channel pipe");
2698 case CONSUMER_CHANNEL_ADD
:
2699 DBG("Adding channel %d to poll set",
2702 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
2705 lttng_ht_add_unique_u64(channel_ht
,
2706 &chan
->wait_fd_node
);
2708 /* Add channel to the global poll events list */
2709 lttng_poll_add(&events
, chan
->wait_fd
,
2710 LPOLLIN
| LPOLLPRI
);
2712 case CONSUMER_CHANNEL_DEL
:
2714 struct lttng_consumer_stream
*stream
, *stmp
;
2717 chan
= consumer_find_channel(key
);
2720 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
2723 lttng_poll_del(&events
, chan
->wait_fd
);
2724 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
2725 ret
= lttng_ht_del(channel_ht
, &iter
);
2727 consumer_close_channel_streams(chan
);
2729 switch (consumer_data
.type
) {
2730 case LTTNG_CONSUMER_KERNEL
:
2732 case LTTNG_CONSUMER32_UST
:
2733 case LTTNG_CONSUMER64_UST
:
2734 /* Delete streams that might have been left in the stream list. */
2735 cds_list_for_each_entry_safe(stream
, stmp
, &chan
->streams
.head
,
2737 cds_list_del(&stream
->send_node
);
2738 lttng_ustconsumer_del_stream(stream
);
2739 uatomic_sub(&stream
->chan
->refcount
, 1);
2740 assert(&chan
->refcount
);
2745 ERR("Unknown consumer_data type");
2750 * Release our own refcount. Force channel deletion even if
2751 * streams were not initialized.
2753 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
2754 consumer_del_channel(chan
);
2759 case CONSUMER_CHANNEL_QUIT
:
2761 * Remove the pipe from the poll set and continue the loop
2762 * since their might be data to consume.
2764 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2767 ERR("Unknown action");
2772 /* Handle other stream */
2778 uint64_t tmp_id
= (uint64_t) pollfd
;
2780 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
2782 node
= lttng_ht_iter_get_node_u64(&iter
);
2785 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
2788 /* Check for error event */
2789 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2790 DBG("Channel fd %d is hup|err.", pollfd
);
2792 lttng_poll_del(&events
, chan
->wait_fd
);
2793 ret
= lttng_ht_del(channel_ht
, &iter
);
2795 consumer_close_channel_streams(chan
);
2797 /* Release our own refcount */
2798 if (!uatomic_sub_return(&chan
->refcount
, 1)
2799 && !uatomic_read(&chan
->nb_init_stream_left
)) {
2800 consumer_del_channel(chan
);
2804 /* Release RCU lock for the channel looked up */
2810 lttng_poll_clean(&events
);
2812 destroy_channel_ht(channel_ht
);
2814 DBG("Channel poll thread exiting");
2815 rcu_unregister_thread();
2819 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
2820 struct pollfd
*sockpoll
, int client_socket
)
2827 if (lttng_consumer_poll_socket(sockpoll
) < 0) {
2831 DBG("Metadata connection on client_socket");
2833 /* Blocking call, waiting for transmission */
2834 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
2835 if (ctx
->consumer_metadata_socket
< 0) {
2836 WARN("On accept metadata");
2847 * This thread listens on the consumerd socket and receives the file
2848 * descriptors from the session daemon.
2850 void *consumer_thread_sessiond_poll(void *data
)
2852 int sock
= -1, client_socket
, ret
;
2854 * structure to poll for incoming data on communication socket avoids
2855 * making blocking sockets.
2857 struct pollfd consumer_sockpoll
[2];
2858 struct lttng_consumer_local_data
*ctx
= data
;
2860 rcu_register_thread();
2862 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
2863 unlink(ctx
->consumer_command_sock_path
);
2864 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
2865 if (client_socket
< 0) {
2866 ERR("Cannot create command socket");
2870 ret
= lttcomm_listen_unix_sock(client_socket
);
2875 DBG("Sending ready command to lttng-sessiond");
2876 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
2877 /* return < 0 on error, but == 0 is not fatal */
2879 ERR("Error sending ready command to lttng-sessiond");
2883 /* prepare the FDs to poll : to client socket and the should_quit pipe */
2884 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
2885 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
2886 consumer_sockpoll
[1].fd
= client_socket
;
2887 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
2889 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
2892 DBG("Connection on client_socket");
2894 /* Blocking call, waiting for transmission */
2895 sock
= lttcomm_accept_unix_sock(client_socket
);
2902 * Setup metadata socket which is the second socket connection on the
2903 * command unix socket.
2905 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
2910 /* This socket is not useful anymore. */
2911 ret
= close(client_socket
);
2913 PERROR("close client_socket");
2917 /* update the polling structure to poll on the established socket */
2918 consumer_sockpoll
[1].fd
= sock
;
2919 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
2922 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
2925 DBG("Incoming command on sock");
2926 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2927 if (ret
== -ENOENT
) {
2928 DBG("Received STOP command");
2933 * This could simply be a session daemon quitting. Don't output
2936 DBG("Communication interrupted on command socket");
2939 if (consumer_quit
) {
2940 DBG("consumer_thread_receive_fds received quit from signal");
2943 DBG("received command on sock");
2946 DBG("Consumer thread sessiond poll exiting");
2949 * Close metadata streams since the producer is the session daemon which
2952 * NOTE: for now, this only applies to the UST tracer.
2954 lttng_consumer_close_metadata();
2957 * when all fds have hung up, the polling thread
2963 * Notify the data poll thread to poll back again and test the
2964 * consumer_quit state that we just set so to quit gracefully.
2966 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
2968 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
2970 /* Cleaning up possibly open sockets. */
2974 PERROR("close sock sessiond poll");
2977 if (client_socket
>= 0) {
2978 ret
= close(client_socket
);
2980 PERROR("close client_socket sessiond poll");
2984 rcu_unregister_thread();
2988 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2989 struct lttng_consumer_local_data
*ctx
)
2993 pthread_mutex_lock(&stream
->lock
);
2995 switch (consumer_data
.type
) {
2996 case LTTNG_CONSUMER_KERNEL
:
2997 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
2999 case LTTNG_CONSUMER32_UST
:
3000 case LTTNG_CONSUMER64_UST
:
3001 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3004 ERR("Unknown consumer_data type");
3010 pthread_mutex_unlock(&stream
->lock
);
3014 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3016 switch (consumer_data
.type
) {
3017 case LTTNG_CONSUMER_KERNEL
:
3018 return lttng_kconsumer_on_recv_stream(stream
);
3019 case LTTNG_CONSUMER32_UST
:
3020 case LTTNG_CONSUMER64_UST
:
3021 return lttng_ustconsumer_on_recv_stream(stream
);
3023 ERR("Unknown consumer_data type");
3030 * Allocate and set consumer data hash tables.
3032 void lttng_consumer_init(void)
3034 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3035 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3036 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3037 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3041 * Process the ADD_RELAYD command receive by a consumer.
3043 * This will create a relayd socket pair and add it to the relayd hash table.
3044 * The caller MUST acquire a RCU read side lock before calling it.
3046 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3047 struct lttng_consumer_local_data
*ctx
, int sock
,
3048 struct pollfd
*consumer_sockpoll
,
3049 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
)
3051 int fd
= -1, ret
= -1, relayd_created
= 0;
3052 enum lttng_error_code ret_code
= LTTNG_OK
;
3053 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3056 assert(relayd_sock
);
3058 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3060 /* Get relayd reference if exists. */
3061 relayd
= consumer_find_relayd(net_seq_idx
);
3062 if (relayd
== NULL
) {
3063 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3064 /* Not found. Allocate one. */
3065 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3066 if (relayd
== NULL
) {
3068 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3071 relayd
->sessiond_session_id
= sessiond_id
;
3076 * This code path MUST continue to the consumer send status message to
3077 * we can notify the session daemon and continue our work without
3078 * killing everything.
3082 * relayd key should never be found for control socket.
3084 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3087 /* First send a status message before receiving the fds. */
3088 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
3090 /* Somehow, the session daemon is not responding anymore. */
3091 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3092 goto error_nosignal
;
3095 /* Poll on consumer socket. */
3096 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
3097 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3099 goto error_nosignal
;
3102 /* Get relayd socket from session daemon */
3103 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3104 if (ret
!= sizeof(fd
)) {
3106 fd
= -1; /* Just in case it gets set with an invalid value. */
3109 * Failing to receive FDs might indicate a major problem such as
3110 * reaching a fd limit during the receive where the kernel returns a
3111 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3112 * don't take any chances and stop everything.
3114 * XXX: Feature request #558 will fix that and avoid this possible
3115 * issue when reaching the fd limit.
3117 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3118 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3122 /* Copy socket information and received FD */
3123 switch (sock_type
) {
3124 case LTTNG_STREAM_CONTROL
:
3125 /* Copy received lttcomm socket */
3126 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3127 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3128 /* Handle create_sock error. */
3130 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3134 * Close the socket created internally by
3135 * lttcomm_create_sock, so we can replace it by the one
3136 * received from sessiond.
3138 if (close(relayd
->control_sock
.sock
.fd
)) {
3142 /* Assign new file descriptor */
3143 relayd
->control_sock
.sock
.fd
= fd
;
3144 fd
= -1; /* For error path */
3145 /* Assign version values. */
3146 relayd
->control_sock
.major
= relayd_sock
->major
;
3147 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3150 * Create a session on the relayd and store the returned id. Lock the
3151 * control socket mutex if the relayd was NOT created before.
3153 if (!relayd_created
) {
3154 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3156 ret
= relayd_create_session(&relayd
->control_sock
,
3157 &relayd
->relayd_session_id
);
3158 if (!relayd_created
) {
3159 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3163 * Close all sockets of a relayd object. It will be freed if it was
3164 * created at the error code path or else it will be garbage
3167 (void) relayd_close(&relayd
->control_sock
);
3168 (void) relayd_close(&relayd
->data_sock
);
3169 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
3174 case LTTNG_STREAM_DATA
:
3175 /* Copy received lttcomm socket */
3176 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3177 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3178 /* Handle create_sock error. */
3180 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3184 * Close the socket created internally by
3185 * lttcomm_create_sock, so we can replace it by the one
3186 * received from sessiond.
3188 if (close(relayd
->data_sock
.sock
.fd
)) {
3192 /* Assign new file descriptor */
3193 relayd
->data_sock
.sock
.fd
= fd
;
3194 fd
= -1; /* for eventual error paths */
3195 /* Assign version values. */
3196 relayd
->data_sock
.major
= relayd_sock
->major
;
3197 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3200 ERR("Unknown relayd socket type (%d)", sock_type
);
3202 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3206 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3207 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3208 relayd
->net_seq_idx
, fd
);
3210 /* We successfully added the socket. Send status back. */
3211 ret
= consumer_send_status_msg(sock
, ret_code
);
3213 /* Somehow, the session daemon is not responding anymore. */
3214 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3215 goto error_nosignal
;
3219 * Add relayd socket pair to consumer data hashtable. If object already
3220 * exists or on error, the function gracefully returns.
3228 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3229 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3233 /* Close received socket if valid. */
3236 PERROR("close received socket");
3240 if (relayd_created
) {
3248 * Try to lock the stream mutex.
3250 * On success, 1 is returned else 0 indicating that the mutex is NOT lock.
3252 static int stream_try_lock(struct lttng_consumer_stream
*stream
)
3259 * Try to lock the stream mutex. On failure, we know that the stream is
3260 * being used else where hence there is data still being extracted.
3262 ret
= pthread_mutex_trylock(&stream
->lock
);
3264 /* For both EBUSY and EINVAL error, the mutex is NOT locked. */
3276 * Search for a relayd associated to the session id and return the reference.
3278 * A rcu read side lock MUST be acquire before calling this function and locked
3279 * until the relayd object is no longer necessary.
3281 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3283 struct lttng_ht_iter iter
;
3284 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3286 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3287 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3290 * Check by sessiond id which is unique here where the relayd session
3291 * id might not be when having multiple relayd.
3293 if (relayd
->sessiond_session_id
== id
) {
3294 /* Found the relayd. There can be only one per id. */
3306 * Check if for a given session id there is still data needed to be extract
3309 * Return 1 if data is pending or else 0 meaning ready to be read.
3311 int consumer_data_pending(uint64_t id
)
3314 struct lttng_ht_iter iter
;
3315 struct lttng_ht
*ht
;
3316 struct lttng_consumer_stream
*stream
;
3317 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3318 int (*data_pending
)(struct lttng_consumer_stream
*);
3320 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3323 pthread_mutex_lock(&consumer_data
.lock
);
3325 switch (consumer_data
.type
) {
3326 case LTTNG_CONSUMER_KERNEL
:
3327 data_pending
= lttng_kconsumer_data_pending
;
3329 case LTTNG_CONSUMER32_UST
:
3330 case LTTNG_CONSUMER64_UST
:
3331 data_pending
= lttng_ustconsumer_data_pending
;
3334 ERR("Unknown consumer data type");
3338 /* Ease our life a bit */
3339 ht
= consumer_data
.stream_list_ht
;
3341 relayd
= find_relayd_by_session_id(id
);
3343 /* Send init command for data pending. */
3344 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3345 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3346 relayd
->relayd_session_id
);
3347 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3349 /* Communication error thus the relayd so no data pending. */
3350 goto data_not_pending
;
3354 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3355 ht
->hash_fct(&id
, lttng_ht_seed
),
3357 &iter
.iter
, stream
, node_session_id
.node
) {
3358 /* If this call fails, the stream is being used hence data pending. */
3359 ret
= stream_try_lock(stream
);
3365 * A removed node from the hash table indicates that the stream has
3366 * been deleted thus having a guarantee that the buffers are closed
3367 * on the consumer side. However, data can still be transmitted
3368 * over the network so don't skip the relayd check.
3370 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3372 /* Check the stream if there is data in the buffers. */
3373 ret
= data_pending(stream
);
3375 pthread_mutex_unlock(&stream
->lock
);
3382 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3383 if (stream
->metadata_flag
) {
3384 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3385 stream
->relayd_stream_id
);
3387 ret
= relayd_data_pending(&relayd
->control_sock
,
3388 stream
->relayd_stream_id
,
3389 stream
->next_net_seq_num
- 1);
3391 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3393 pthread_mutex_unlock(&stream
->lock
);
3397 pthread_mutex_unlock(&stream
->lock
);
3401 unsigned int is_data_inflight
= 0;
3403 /* Send init command for data pending. */
3404 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3405 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3406 relayd
->relayd_session_id
, &is_data_inflight
);
3407 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3409 goto data_not_pending
;
3411 if (is_data_inflight
) {
3417 * Finding _no_ node in the hash table and no inflight data means that the
3418 * stream(s) have been removed thus data is guaranteed to be available for
3419 * analysis from the trace files.
3423 /* Data is available to be read by a viewer. */
3424 pthread_mutex_unlock(&consumer_data
.lock
);
3429 /* Data is still being extracted from buffers. */
3430 pthread_mutex_unlock(&consumer_data
.lock
);
3436 * Send a ret code status message to the sessiond daemon.
3438 * Return the sendmsg() return value.
3440 int consumer_send_status_msg(int sock
, int ret_code
)
3442 struct lttcomm_consumer_status_msg msg
;
3444 msg
.ret_code
= ret_code
;
3446 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3450 * Send a channel status message to the sessiond daemon.
3452 * Return the sendmsg() return value.
3454 int consumer_send_status_channel(int sock
,
3455 struct lttng_consumer_channel
*channel
)
3457 struct lttcomm_consumer_status_channel msg
;
3462 msg
.ret_code
= -LTTNG_ERR_UST_CHAN_FAIL
;
3464 msg
.ret_code
= LTTNG_OK
;
3465 msg
.key
= channel
->key
;
3466 msg
.stream_count
= channel
->streams
.count
;
3469 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3473 * Using a maximum stream size with the produced and consumed position of a
3474 * stream, computes the new consumed position to be as close as possible to the
3475 * maximum possible stream size.
3477 * If maximum stream size is lower than the possible buffer size (produced -
3478 * consumed), the consumed_pos given is returned untouched else the new value
3481 unsigned long consumer_get_consumed_maxsize(unsigned long consumed_pos
,
3482 unsigned long produced_pos
, uint64_t max_stream_size
)
3484 if (max_stream_size
&& max_stream_size
< (produced_pos
- consumed_pos
)) {
3485 /* Offset from the produced position to get the latest buffers. */
3486 return produced_pos
- max_stream_size
;
3489 return consumed_pos
;