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 <bin/lttng-consumerd/health-consumerd.h>
34 #include <common/common.h>
35 #include <common/utils.h>
36 #include <common/compat/poll.h>
37 #include <common/compat/endian.h>
38 #include <common/index/index.h>
39 #include <common/kernel-ctl/kernel-ctl.h>
40 #include <common/sessiond-comm/relayd.h>
41 #include <common/sessiond-comm/sessiond-comm.h>
42 #include <common/kernel-consumer/kernel-consumer.h>
43 #include <common/relayd/relayd.h>
44 #include <common/ust-consumer/ust-consumer.h>
45 #include <common/consumer/consumer-timer.h>
46 #include <common/consumer/consumer.h>
47 #include <common/consumer/consumer-stream.h>
48 #include <common/consumer/consumer-testpoint.h>
49 #include <common/align.h>
51 struct lttng_consumer_global_data consumer_data
= {
54 .type
= LTTNG_CONSUMER_UNKNOWN
,
57 enum consumer_channel_action
{
60 CONSUMER_CHANNEL_QUIT
,
63 struct consumer_channel_msg
{
64 enum consumer_channel_action action
;
65 struct lttng_consumer_channel
*chan
; /* add */
66 uint64_t key
; /* del */
70 * Flag to inform the polling thread to quit when all fd hung up. Updated by
71 * the consumer_thread_receive_fds when it notices that all fds has hung up.
72 * Also updated by the signal handler (consumer_should_exit()). Read by the
75 volatile int consumer_quit
;
78 * Global hash table containing respectively metadata and data streams. The
79 * stream element in this ht should only be updated by the metadata poll thread
80 * for the metadata and the data poll thread for the data.
82 static struct lttng_ht
*metadata_ht
;
83 static struct lttng_ht
*data_ht
;
86 * Notify a thread lttng pipe to poll back again. This usually means that some
87 * global state has changed so we just send back the thread in a poll wait
90 static void notify_thread_lttng_pipe(struct lttng_pipe
*pipe
)
92 struct lttng_consumer_stream
*null_stream
= NULL
;
96 (void) lttng_pipe_write(pipe
, &null_stream
, sizeof(null_stream
));
99 static void notify_health_quit_pipe(int *pipe
)
103 ret
= lttng_write(pipe
[1], "4", 1);
105 PERROR("write consumer health quit");
109 static void notify_channel_pipe(struct lttng_consumer_local_data
*ctx
,
110 struct lttng_consumer_channel
*chan
,
112 enum consumer_channel_action action
)
114 struct consumer_channel_msg msg
;
117 memset(&msg
, 0, sizeof(msg
));
122 ret
= lttng_write(ctx
->consumer_channel_pipe
[1], &msg
, sizeof(msg
));
123 if (ret
< sizeof(msg
)) {
124 PERROR("notify_channel_pipe write error");
128 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
131 notify_channel_pipe(ctx
, NULL
, key
, CONSUMER_CHANNEL_DEL
);
134 static int read_channel_pipe(struct lttng_consumer_local_data
*ctx
,
135 struct lttng_consumer_channel
**chan
,
137 enum consumer_channel_action
*action
)
139 struct consumer_channel_msg msg
;
142 ret
= lttng_read(ctx
->consumer_channel_pipe
[0], &msg
, sizeof(msg
));
143 if (ret
< sizeof(msg
)) {
147 *action
= msg
.action
;
155 * Cleanup the stream list of a channel. Those streams are not yet globally
158 static void clean_channel_stream_list(struct lttng_consumer_channel
*channel
)
160 struct lttng_consumer_stream
*stream
, *stmp
;
164 /* Delete streams that might have been left in the stream list. */
165 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
167 cds_list_del(&stream
->send_node
);
169 * Once a stream is added to this list, the buffers were created so we
170 * have a guarantee that this call will succeed. Setting the monitor
171 * mode to 0 so we don't lock nor try to delete the stream from the
175 consumer_stream_destroy(stream
, NULL
);
180 * Find a stream. The consumer_data.lock must be locked during this
183 static struct lttng_consumer_stream
*find_stream(uint64_t key
,
186 struct lttng_ht_iter iter
;
187 struct lttng_ht_node_u64
*node
;
188 struct lttng_consumer_stream
*stream
= NULL
;
192 /* -1ULL keys are lookup failures */
193 if (key
== (uint64_t) -1ULL) {
199 lttng_ht_lookup(ht
, &key
, &iter
);
200 node
= lttng_ht_iter_get_node_u64(&iter
);
202 stream
= caa_container_of(node
, struct lttng_consumer_stream
, node
);
210 static void steal_stream_key(uint64_t key
, struct lttng_ht
*ht
)
212 struct lttng_consumer_stream
*stream
;
215 stream
= find_stream(key
, ht
);
217 stream
->key
= (uint64_t) -1ULL;
219 * We don't want the lookup to match, but we still need
220 * to iterate on this stream when iterating over the hash table. Just
221 * change the node key.
223 stream
->node
.key
= (uint64_t) -1ULL;
229 * Return a channel object for the given key.
231 * RCU read side lock MUST be acquired before calling this function and
232 * protects the channel ptr.
234 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
)
236 struct lttng_ht_iter iter
;
237 struct lttng_ht_node_u64
*node
;
238 struct lttng_consumer_channel
*channel
= NULL
;
240 /* -1ULL keys are lookup failures */
241 if (key
== (uint64_t) -1ULL) {
245 lttng_ht_lookup(consumer_data
.channel_ht
, &key
, &iter
);
246 node
= lttng_ht_iter_get_node_u64(&iter
);
248 channel
= caa_container_of(node
, struct lttng_consumer_channel
, node
);
255 * There is a possibility that the consumer does not have enough time between
256 * the close of the channel on the session daemon and the cleanup in here thus
257 * once we have a channel add with an existing key, we know for sure that this
258 * channel will eventually get cleaned up by all streams being closed.
260 * This function just nullifies the already existing channel key.
262 static void steal_channel_key(uint64_t key
)
264 struct lttng_consumer_channel
*channel
;
267 channel
= consumer_find_channel(key
);
269 channel
->key
= (uint64_t) -1ULL;
271 * We don't want the lookup to match, but we still need to iterate on
272 * this channel when iterating over the hash table. Just change the
275 channel
->node
.key
= (uint64_t) -1ULL;
280 static void free_channel_rcu(struct rcu_head
*head
)
282 struct lttng_ht_node_u64
*node
=
283 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
284 struct lttng_consumer_channel
*channel
=
285 caa_container_of(node
, struct lttng_consumer_channel
, node
);
287 switch (consumer_data
.type
) {
288 case LTTNG_CONSUMER_KERNEL
:
290 case LTTNG_CONSUMER32_UST
:
291 case LTTNG_CONSUMER64_UST
:
292 lttng_ustconsumer_free_channel(channel
);
295 ERR("Unknown consumer_data type");
302 * RCU protected relayd socket pair free.
304 static void free_relayd_rcu(struct rcu_head
*head
)
306 struct lttng_ht_node_u64
*node
=
307 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
308 struct consumer_relayd_sock_pair
*relayd
=
309 caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
312 * Close all sockets. This is done in the call RCU since we don't want the
313 * socket fds to be reassigned thus potentially creating bad state of the
316 * We do not have to lock the control socket mutex here since at this stage
317 * there is no one referencing to this relayd object.
319 (void) relayd_close(&relayd
->control_sock
);
320 (void) relayd_close(&relayd
->data_sock
);
326 * Destroy and free relayd socket pair object.
328 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
)
331 struct lttng_ht_iter iter
;
333 if (relayd
== NULL
) {
337 DBG("Consumer destroy and close relayd socket pair");
339 iter
.iter
.node
= &relayd
->node
.node
;
340 ret
= lttng_ht_del(consumer_data
.relayd_ht
, &iter
);
342 /* We assume the relayd is being or is destroyed */
346 /* RCU free() call */
347 call_rcu(&relayd
->node
.head
, free_relayd_rcu
);
351 * Remove a channel from the global list protected by a mutex. This function is
352 * also responsible for freeing its data structures.
354 void consumer_del_channel(struct lttng_consumer_channel
*channel
)
357 struct lttng_ht_iter iter
;
359 DBG("Consumer delete channel key %" PRIu64
, channel
->key
);
361 pthread_mutex_lock(&consumer_data
.lock
);
362 pthread_mutex_lock(&channel
->lock
);
364 /* Destroy streams that might have been left in the stream list. */
365 clean_channel_stream_list(channel
);
367 if (channel
->live_timer_enabled
== 1) {
368 consumer_timer_live_stop(channel
);
371 switch (consumer_data
.type
) {
372 case LTTNG_CONSUMER_KERNEL
:
374 case LTTNG_CONSUMER32_UST
:
375 case LTTNG_CONSUMER64_UST
:
376 lttng_ustconsumer_del_channel(channel
);
379 ERR("Unknown consumer_data type");
385 iter
.iter
.node
= &channel
->node
.node
;
386 ret
= lttng_ht_del(consumer_data
.channel_ht
, &iter
);
390 call_rcu(&channel
->node
.head
, free_channel_rcu
);
392 pthread_mutex_unlock(&channel
->lock
);
393 pthread_mutex_unlock(&consumer_data
.lock
);
397 * Iterate over the relayd hash table and destroy each element. Finally,
398 * destroy the whole hash table.
400 static void cleanup_relayd_ht(void)
402 struct lttng_ht_iter iter
;
403 struct consumer_relayd_sock_pair
*relayd
;
407 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
409 consumer_destroy_relayd(relayd
);
414 lttng_ht_destroy(consumer_data
.relayd_ht
);
418 * Update the end point status of all streams having the given network sequence
419 * index (relayd index).
421 * It's atomically set without having the stream mutex locked which is fine
422 * because we handle the write/read race with a pipe wakeup for each thread.
424 static void update_endpoint_status_by_netidx(uint64_t net_seq_idx
,
425 enum consumer_endpoint_status status
)
427 struct lttng_ht_iter iter
;
428 struct lttng_consumer_stream
*stream
;
430 DBG("Consumer set delete flag on stream by idx %" PRIu64
, net_seq_idx
);
434 /* Let's begin with metadata */
435 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
436 if (stream
->net_seq_idx
== net_seq_idx
) {
437 uatomic_set(&stream
->endpoint_status
, status
);
438 DBG("Delete flag set to metadata stream %d", stream
->wait_fd
);
442 /* Follow up by the data streams */
443 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
444 if (stream
->net_seq_idx
== net_seq_idx
) {
445 uatomic_set(&stream
->endpoint_status
, status
);
446 DBG("Delete flag set to data stream %d", stream
->wait_fd
);
453 * Cleanup a relayd object by flagging every associated streams for deletion,
454 * destroying the object meaning removing it from the relayd hash table,
455 * closing the sockets and freeing the memory in a RCU call.
457 * If a local data context is available, notify the threads that the streams'
458 * state have changed.
460 static void cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
,
461 struct lttng_consumer_local_data
*ctx
)
467 DBG("Cleaning up relayd sockets");
469 /* Save the net sequence index before destroying the object */
470 netidx
= relayd
->net_seq_idx
;
473 * Delete the relayd from the relayd hash table, close the sockets and free
474 * the object in a RCU call.
476 consumer_destroy_relayd(relayd
);
478 /* Set inactive endpoint to all streams */
479 update_endpoint_status_by_netidx(netidx
, CONSUMER_ENDPOINT_INACTIVE
);
482 * With a local data context, notify the threads that the streams' state
483 * have changed. The write() action on the pipe acts as an "implicit"
484 * memory barrier ordering the updates of the end point status from the
485 * read of this status which happens AFTER receiving this notify.
488 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
489 notify_thread_lttng_pipe(ctx
->consumer_metadata_pipe
);
494 * Flag a relayd socket pair for destruction. Destroy it if the refcount
497 * RCU read side lock MUST be aquired before calling this function.
499 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair
*relayd
)
503 /* Set destroy flag for this object */
504 uatomic_set(&relayd
->destroy_flag
, 1);
506 /* Destroy the relayd if refcount is 0 */
507 if (uatomic_read(&relayd
->refcount
) == 0) {
508 consumer_destroy_relayd(relayd
);
513 * Completly destroy stream from every visiable data structure and the given
516 * One this call returns, the stream object is not longer usable nor visible.
518 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
521 consumer_stream_destroy(stream
, ht
);
525 * XXX naming of del vs destroy is all mixed up.
527 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
)
529 consumer_stream_destroy(stream
, data_ht
);
532 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
)
534 consumer_stream_destroy(stream
, metadata_ht
);
537 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
539 enum lttng_consumer_stream_state state
,
540 const char *channel_name
,
547 enum consumer_channel_type type
,
548 unsigned int monitor
)
551 struct lttng_consumer_stream
*stream
;
553 stream
= zmalloc(sizeof(*stream
));
554 if (stream
== NULL
) {
555 PERROR("malloc struct lttng_consumer_stream");
562 stream
->key
= stream_key
;
564 stream
->out_fd_offset
= 0;
565 stream
->output_written
= 0;
566 stream
->state
= state
;
569 stream
->net_seq_idx
= relayd_id
;
570 stream
->session_id
= session_id
;
571 stream
->monitor
= monitor
;
572 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
573 stream
->index_fd
= -1;
574 stream
->last_sequence_number
= -1ULL;
575 pthread_mutex_init(&stream
->lock
, NULL
);
576 pthread_mutex_init(&stream
->metadata_timer_lock
, NULL
);
578 /* If channel is the metadata, flag this stream as metadata. */
579 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
580 stream
->metadata_flag
= 1;
581 /* Metadata is flat out. */
582 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
583 /* Live rendez-vous point. */
584 pthread_cond_init(&stream
->metadata_rdv
, NULL
);
585 pthread_mutex_init(&stream
->metadata_rdv_lock
, NULL
);
587 /* Format stream name to <channel_name>_<cpu_number> */
588 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
591 PERROR("snprintf stream name");
596 /* Key is always the wait_fd for streams. */
597 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
599 /* Init node per channel id key */
600 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
602 /* Init session id node with the stream session id */
603 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
605 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
606 " relayd_id %" PRIu64
", session_id %" PRIu64
,
607 stream
->name
, stream
->key
, channel_key
,
608 stream
->net_seq_idx
, stream
->session_id
);
624 * Add a stream to the global list protected by a mutex.
626 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
)
628 struct lttng_ht
*ht
= data_ht
;
634 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
636 pthread_mutex_lock(&consumer_data
.lock
);
637 pthread_mutex_lock(&stream
->chan
->lock
);
638 pthread_mutex_lock(&stream
->chan
->timer_lock
);
639 pthread_mutex_lock(&stream
->lock
);
642 /* Steal stream identifier to avoid having streams with the same key */
643 steal_stream_key(stream
->key
, ht
);
645 lttng_ht_add_unique_u64(ht
, &stream
->node
);
647 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
648 &stream
->node_channel_id
);
651 * Add stream to the stream_list_ht of the consumer data. No need to steal
652 * the key since the HT does not use it and we allow to add redundant keys
655 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
658 * When nb_init_stream_left reaches 0, we don't need to trigger any action
659 * in terms of destroying the associated channel, because the action that
660 * causes the count to become 0 also causes a stream to be added. The
661 * channel deletion will thus be triggered by the following removal of this
664 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
665 /* Increment refcount before decrementing nb_init_stream_left */
667 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
670 /* Update consumer data once the node is inserted. */
671 consumer_data
.stream_count
++;
672 consumer_data
.need_update
= 1;
675 pthread_mutex_unlock(&stream
->lock
);
676 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
677 pthread_mutex_unlock(&stream
->chan
->lock
);
678 pthread_mutex_unlock(&consumer_data
.lock
);
683 void consumer_del_data_stream(struct lttng_consumer_stream
*stream
)
685 consumer_del_stream(stream
, data_ht
);
689 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
690 * be acquired before calling this.
692 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
695 struct lttng_ht_node_u64
*node
;
696 struct lttng_ht_iter iter
;
700 lttng_ht_lookup(consumer_data
.relayd_ht
,
701 &relayd
->net_seq_idx
, &iter
);
702 node
= lttng_ht_iter_get_node_u64(&iter
);
706 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
713 * Allocate and return a consumer relayd socket.
715 static struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
716 uint64_t net_seq_idx
)
718 struct consumer_relayd_sock_pair
*obj
= NULL
;
720 /* net sequence index of -1 is a failure */
721 if (net_seq_idx
== (uint64_t) -1ULL) {
725 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
727 PERROR("zmalloc relayd sock");
731 obj
->net_seq_idx
= net_seq_idx
;
733 obj
->destroy_flag
= 0;
734 obj
->control_sock
.sock
.fd
= -1;
735 obj
->data_sock
.sock
.fd
= -1;
736 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
737 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
744 * Find a relayd socket pair in the global consumer data.
746 * Return the object if found else NULL.
747 * RCU read-side lock must be held across this call and while using the
750 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
752 struct lttng_ht_iter iter
;
753 struct lttng_ht_node_u64
*node
;
754 struct consumer_relayd_sock_pair
*relayd
= NULL
;
756 /* Negative keys are lookup failures */
757 if (key
== (uint64_t) -1ULL) {
761 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
763 node
= lttng_ht_iter_get_node_u64(&iter
);
765 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
773 * Find a relayd and send the stream
775 * Returns 0 on success, < 0 on error
777 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
,
781 struct consumer_relayd_sock_pair
*relayd
;
784 assert(stream
->net_seq_idx
!= -1ULL);
787 /* The stream is not metadata. Get relayd reference if exists. */
789 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
790 if (relayd
!= NULL
) {
791 /* Add stream on the relayd */
792 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
793 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
794 path
, &stream
->relayd_stream_id
,
795 stream
->chan
->tracefile_size
, stream
->chan
->tracefile_count
);
796 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
801 uatomic_inc(&relayd
->refcount
);
802 stream
->sent_to_relayd
= 1;
804 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't send it.",
805 stream
->key
, stream
->net_seq_idx
);
810 DBG("Stream %s with key %" PRIu64
" sent to relayd id %" PRIu64
,
811 stream
->name
, stream
->key
, stream
->net_seq_idx
);
819 * Find a relayd and send the streams sent message
821 * Returns 0 on success, < 0 on error
823 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
)
826 struct consumer_relayd_sock_pair
*relayd
;
828 assert(net_seq_idx
!= -1ULL);
830 /* The stream is not metadata. Get relayd reference if exists. */
832 relayd
= consumer_find_relayd(net_seq_idx
);
833 if (relayd
!= NULL
) {
834 /* Add stream on the relayd */
835 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
836 ret
= relayd_streams_sent(&relayd
->control_sock
);
837 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
842 ERR("Relayd ID %" PRIu64
" unknown. Can't send streams_sent.",
849 DBG("All streams sent relayd id %" PRIu64
, net_seq_idx
);
857 * Find a relayd and close the stream
859 void close_relayd_stream(struct lttng_consumer_stream
*stream
)
861 struct consumer_relayd_sock_pair
*relayd
;
863 /* The stream is not metadata. Get relayd reference if exists. */
865 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
867 consumer_stream_relayd_close(stream
, relayd
);
873 * Handle stream for relayd transmission if the stream applies for network
874 * streaming where the net sequence index is set.
876 * Return destination file descriptor or negative value on error.
878 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
879 size_t data_size
, unsigned long padding
,
880 struct consumer_relayd_sock_pair
*relayd
)
883 struct lttcomm_relayd_data_hdr data_hdr
;
889 /* Reset data header */
890 memset(&data_hdr
, 0, sizeof(data_hdr
));
892 if (stream
->metadata_flag
) {
893 /* Caller MUST acquire the relayd control socket lock */
894 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
899 /* Metadata are always sent on the control socket. */
900 outfd
= relayd
->control_sock
.sock
.fd
;
902 /* Set header with stream information */
903 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
904 data_hdr
.data_size
= htobe32(data_size
);
905 data_hdr
.padding_size
= htobe32(padding
);
907 * Note that net_seq_num below is assigned with the *current* value of
908 * next_net_seq_num and only after that the next_net_seq_num will be
909 * increment. This is why when issuing a command on the relayd using
910 * this next value, 1 should always be substracted in order to compare
911 * the last seen sequence number on the relayd side to the last sent.
913 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
914 /* Other fields are zeroed previously */
916 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
922 ++stream
->next_net_seq_num
;
924 /* Set to go on data socket */
925 outfd
= relayd
->data_sock
.sock
.fd
;
933 * Allocate and return a new lttng_consumer_channel object using the given key
934 * to initialize the hash table node.
936 * On error, return NULL.
938 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
940 const char *pathname
,
945 enum lttng_event_output output
,
946 uint64_t tracefile_size
,
947 uint64_t tracefile_count
,
948 uint64_t session_id_per_pid
,
949 unsigned int monitor
,
950 unsigned int live_timer_interval
,
951 const char *root_shm_path
,
952 const char *shm_path
)
954 struct lttng_consumer_channel
*channel
;
956 channel
= zmalloc(sizeof(*channel
));
957 if (channel
== NULL
) {
958 PERROR("malloc struct lttng_consumer_channel");
963 channel
->refcount
= 0;
964 channel
->session_id
= session_id
;
965 channel
->session_id_per_pid
= session_id_per_pid
;
968 channel
->relayd_id
= relayd_id
;
969 channel
->tracefile_size
= tracefile_size
;
970 channel
->tracefile_count
= tracefile_count
;
971 channel
->monitor
= monitor
;
972 channel
->live_timer_interval
= live_timer_interval
;
973 pthread_mutex_init(&channel
->lock
, NULL
);
974 pthread_mutex_init(&channel
->timer_lock
, NULL
);
977 case LTTNG_EVENT_SPLICE
:
978 channel
->output
= CONSUMER_CHANNEL_SPLICE
;
980 case LTTNG_EVENT_MMAP
:
981 channel
->output
= CONSUMER_CHANNEL_MMAP
;
991 * In monitor mode, the streams associated with the channel will be put in
992 * a special list ONLY owned by this channel. So, the refcount is set to 1
993 * here meaning that the channel itself has streams that are referenced.
995 * On a channel deletion, once the channel is no longer visible, the
996 * refcount is decremented and checked for a zero value to delete it. With
997 * streams in no monitor mode, it will now be safe to destroy the channel.
999 if (!channel
->monitor
) {
1000 channel
->refcount
= 1;
1003 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
1004 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
1006 strncpy(channel
->name
, name
, sizeof(channel
->name
));
1007 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
1009 if (root_shm_path
) {
1010 strncpy(channel
->root_shm_path
, root_shm_path
, sizeof(channel
->root_shm_path
));
1011 channel
->root_shm_path
[sizeof(channel
->root_shm_path
) - 1] = '\0';
1014 strncpy(channel
->shm_path
, shm_path
, sizeof(channel
->shm_path
));
1015 channel
->shm_path
[sizeof(channel
->shm_path
) - 1] = '\0';
1018 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
1020 channel
->wait_fd
= -1;
1022 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
1024 DBG("Allocated channel (key %" PRIu64
")", channel
->key
);
1031 * Add a channel to the global list protected by a mutex.
1033 * Always return 0 indicating success.
1035 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
1036 struct lttng_consumer_local_data
*ctx
)
1038 pthread_mutex_lock(&consumer_data
.lock
);
1039 pthread_mutex_lock(&channel
->lock
);
1040 pthread_mutex_lock(&channel
->timer_lock
);
1043 * This gives us a guarantee that the channel we are about to add to the
1044 * channel hash table will be unique. See this function comment on the why
1045 * we need to steel the channel key at this stage.
1047 steal_channel_key(channel
->key
);
1050 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
1053 pthread_mutex_unlock(&channel
->timer_lock
);
1054 pthread_mutex_unlock(&channel
->lock
);
1055 pthread_mutex_unlock(&consumer_data
.lock
);
1057 if (channel
->wait_fd
!= -1 && channel
->type
== CONSUMER_CHANNEL_TYPE_DATA
) {
1058 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
1065 * Allocate the pollfd structure and the local view of the out fds to avoid
1066 * doing a lookup in the linked list and concurrency issues when writing is
1067 * needed. Called with consumer_data.lock held.
1069 * Returns the number of fds in the structures.
1071 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
1072 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
1073 struct lttng_ht
*ht
)
1076 struct lttng_ht_iter iter
;
1077 struct lttng_consumer_stream
*stream
;
1082 assert(local_stream
);
1084 DBG("Updating poll fd array");
1086 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1088 * Only active streams with an active end point can be added to the
1089 * poll set and local stream storage of the thread.
1091 * There is a potential race here for endpoint_status to be updated
1092 * just after the check. However, this is OK since the stream(s) will
1093 * be deleted once the thread is notified that the end point state has
1094 * changed where this function will be called back again.
1096 if (stream
->state
!= LTTNG_CONSUMER_ACTIVE_STREAM
||
1097 stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
1101 * This clobbers way too much the debug output. Uncomment that if you
1102 * need it for debugging purposes.
1104 * DBG("Active FD %d", stream->wait_fd);
1106 (*pollfd
)[i
].fd
= stream
->wait_fd
;
1107 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1108 local_stream
[i
] = stream
;
1114 * Insert the consumer_data_pipe at the end of the array and don't
1115 * increment i so nb_fd is the number of real FD.
1117 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
1118 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1120 (*pollfd
)[i
+ 1].fd
= lttng_pipe_get_readfd(ctx
->consumer_wakeup_pipe
);
1121 (*pollfd
)[i
+ 1].events
= POLLIN
| POLLPRI
;
1126 * Poll on the should_quit pipe and the command socket return -1 on
1127 * error, 1 if should exit, 0 if data is available on the command socket
1129 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
1134 num_rdy
= poll(consumer_sockpoll
, 2, -1);
1135 if (num_rdy
== -1) {
1137 * Restart interrupted system call.
1139 if (errno
== EINTR
) {
1142 PERROR("Poll error");
1145 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
1146 DBG("consumer_should_quit wake up");
1153 * Set the error socket.
1155 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1158 ctx
->consumer_error_socket
= sock
;
1162 * Set the command socket path.
1164 void lttng_consumer_set_command_sock_path(
1165 struct lttng_consumer_local_data
*ctx
, char *sock
)
1167 ctx
->consumer_command_sock_path
= sock
;
1171 * Send return code to the session daemon.
1172 * If the socket is not defined, we return 0, it is not a fatal error
1174 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1176 if (ctx
->consumer_error_socket
> 0) {
1177 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1178 sizeof(enum lttcomm_sessiond_command
));
1185 * Close all the tracefiles and stream fds and MUST be called when all
1186 * instances are destroyed i.e. when all threads were joined and are ended.
1188 void lttng_consumer_cleanup(void)
1190 struct lttng_ht_iter iter
;
1191 struct lttng_consumer_channel
*channel
;
1195 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1197 consumer_del_channel(channel
);
1202 lttng_ht_destroy(consumer_data
.channel_ht
);
1204 cleanup_relayd_ht();
1206 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1209 * This HT contains streams that are freed by either the metadata thread or
1210 * the data thread so we do *nothing* on the hash table and simply destroy
1213 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1217 * Called from signal handler.
1219 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1224 ret
= lttng_write(ctx
->consumer_should_quit
[1], "4", 1);
1226 PERROR("write consumer quit");
1229 DBG("Consumer flag that it should quit");
1232 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1236 int outfd
= stream
->out_fd
;
1239 * This does a blocking write-and-wait on any page that belongs to the
1240 * subbuffer prior to the one we just wrote.
1241 * Don't care about error values, as these are just hints and ways to
1242 * limit the amount of page cache used.
1244 if (orig_offset
< stream
->max_sb_size
) {
1247 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1248 stream
->max_sb_size
,
1249 SYNC_FILE_RANGE_WAIT_BEFORE
1250 | SYNC_FILE_RANGE_WRITE
1251 | SYNC_FILE_RANGE_WAIT_AFTER
);
1253 * Give hints to the kernel about how we access the file:
1254 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1257 * We need to call fadvise again after the file grows because the
1258 * kernel does not seem to apply fadvise to non-existing parts of the
1261 * Call fadvise _after_ having waited for the page writeback to
1262 * complete because the dirty page writeback semantic is not well
1263 * defined. So it can be expected to lead to lower throughput in
1266 ret
= posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1267 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1268 if (ret
&& ret
!= -ENOSYS
) {
1270 PERROR("posix_fadvise");
1275 * Initialise the necessary environnement :
1276 * - create a new context
1277 * - create the poll_pipe
1278 * - create the should_quit pipe (for signal handler)
1279 * - create the thread pipe (for splice)
1281 * Takes a function pointer as argument, this function is called when data is
1282 * available on a buffer. This function is responsible to do the
1283 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1284 * buffer configuration and then kernctl_put_next_subbuf at the end.
1286 * Returns a pointer to the new context or NULL on error.
1288 struct lttng_consumer_local_data
*lttng_consumer_create(
1289 enum lttng_consumer_type type
,
1290 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1291 struct lttng_consumer_local_data
*ctx
),
1292 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1293 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1294 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1297 struct lttng_consumer_local_data
*ctx
;
1299 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1300 consumer_data
.type
== type
);
1301 consumer_data
.type
= type
;
1303 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1305 PERROR("allocating context");
1309 ctx
->consumer_error_socket
= -1;
1310 ctx
->consumer_metadata_socket
= -1;
1311 pthread_mutex_init(&ctx
->metadata_socket_lock
, NULL
);
1312 /* assign the callbacks */
1313 ctx
->on_buffer_ready
= buffer_ready
;
1314 ctx
->on_recv_channel
= recv_channel
;
1315 ctx
->on_recv_stream
= recv_stream
;
1316 ctx
->on_update_stream
= update_stream
;
1318 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1319 if (!ctx
->consumer_data_pipe
) {
1320 goto error_poll_pipe
;
1323 ctx
->consumer_wakeup_pipe
= lttng_pipe_open(0);
1324 if (!ctx
->consumer_wakeup_pipe
) {
1325 goto error_wakeup_pipe
;
1328 ret
= pipe(ctx
->consumer_should_quit
);
1330 PERROR("Error creating recv pipe");
1331 goto error_quit_pipe
;
1334 ret
= pipe(ctx
->consumer_channel_pipe
);
1336 PERROR("Error creating channel pipe");
1337 goto error_channel_pipe
;
1340 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1341 if (!ctx
->consumer_metadata_pipe
) {
1342 goto error_metadata_pipe
;
1347 error_metadata_pipe
:
1348 utils_close_pipe(ctx
->consumer_channel_pipe
);
1350 utils_close_pipe(ctx
->consumer_should_quit
);
1352 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1354 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1362 * Iterate over all streams of the hashtable and free them properly.
1364 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1366 struct lttng_ht_iter iter
;
1367 struct lttng_consumer_stream
*stream
;
1374 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1376 * Ignore return value since we are currently cleaning up so any error
1379 (void) consumer_del_stream(stream
, ht
);
1383 lttng_ht_destroy(ht
);
1387 * Iterate over all streams of the metadata hashtable and free them
1390 static void destroy_metadata_stream_ht(struct lttng_ht
*ht
)
1392 struct lttng_ht_iter iter
;
1393 struct lttng_consumer_stream
*stream
;
1400 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1402 * Ignore return value since we are currently cleaning up so any error
1405 (void) consumer_del_metadata_stream(stream
, ht
);
1409 lttng_ht_destroy(ht
);
1413 * Close all fds associated with the instance and free the context.
1415 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1419 DBG("Consumer destroying it. Closing everything.");
1425 destroy_data_stream_ht(data_ht
);
1426 destroy_metadata_stream_ht(metadata_ht
);
1428 ret
= close(ctx
->consumer_error_socket
);
1432 ret
= close(ctx
->consumer_metadata_socket
);
1436 utils_close_pipe(ctx
->consumer_channel_pipe
);
1437 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1438 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1439 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1440 utils_close_pipe(ctx
->consumer_should_quit
);
1442 unlink(ctx
->consumer_command_sock_path
);
1447 * Write the metadata stream id on the specified file descriptor.
1449 static int write_relayd_metadata_id(int fd
,
1450 struct lttng_consumer_stream
*stream
,
1451 struct consumer_relayd_sock_pair
*relayd
, unsigned long padding
)
1454 struct lttcomm_relayd_metadata_payload hdr
;
1456 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1457 hdr
.padding_size
= htobe32(padding
);
1458 ret
= lttng_write(fd
, (void *) &hdr
, sizeof(hdr
));
1459 if (ret
< sizeof(hdr
)) {
1461 * This error means that the fd's end is closed so ignore the PERROR
1462 * not to clubber the error output since this can happen in a normal
1465 if (errno
!= EPIPE
) {
1466 PERROR("write metadata stream id");
1468 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1470 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1471 * handle writting the missing part so report that as an error and
1472 * don't lie to the caller.
1477 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1478 stream
->relayd_stream_id
, padding
);
1485 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1486 * core function for writing trace buffers to either the local filesystem or
1489 * It must be called with the stream lock held.
1491 * Careful review MUST be put if any changes occur!
1493 * Returns the number of bytes written
1495 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1496 struct lttng_consumer_local_data
*ctx
,
1497 struct lttng_consumer_stream
*stream
, unsigned long len
,
1498 unsigned long padding
,
1499 struct ctf_packet_index
*index
)
1501 unsigned long mmap_offset
;
1504 off_t orig_offset
= stream
->out_fd_offset
;
1505 /* Default is on the disk */
1506 int outfd
= stream
->out_fd
;
1507 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1508 unsigned int relayd_hang_up
= 0;
1510 /* RCU lock for the relayd pointer */
1513 /* Flag that the current stream if set for network streaming. */
1514 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1515 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1516 if (relayd
== NULL
) {
1522 /* get the offset inside the fd to mmap */
1523 switch (consumer_data
.type
) {
1524 case LTTNG_CONSUMER_KERNEL
:
1525 mmap_base
= stream
->mmap_base
;
1526 ret
= kernctl_get_mmap_read_offset(stream
->wait_fd
, &mmap_offset
);
1529 PERROR("tracer ctl get_mmap_read_offset");
1533 case LTTNG_CONSUMER32_UST
:
1534 case LTTNG_CONSUMER64_UST
:
1535 mmap_base
= lttng_ustctl_get_mmap_base(stream
);
1537 ERR("read mmap get mmap base for stream %s", stream
->name
);
1541 ret
= lttng_ustctl_get_mmap_read_offset(stream
, &mmap_offset
);
1543 PERROR("tracer ctl get_mmap_read_offset");
1549 ERR("Unknown consumer_data type");
1553 /* Handle stream on the relayd if the output is on the network */
1555 unsigned long netlen
= len
;
1558 * Lock the control socket for the complete duration of the function
1559 * since from this point on we will use the socket.
1561 if (stream
->metadata_flag
) {
1562 /* Metadata requires the control socket. */
1563 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1564 if (stream
->reset_metadata_flag
) {
1565 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1566 stream
->relayd_stream_id
,
1567 stream
->metadata_version
);
1572 stream
->reset_metadata_flag
= 0;
1574 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1577 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1582 /* Use the returned socket. */
1585 /* Write metadata stream id before payload */
1586 if (stream
->metadata_flag
) {
1587 ret
= write_relayd_metadata_id(outfd
, stream
, relayd
, padding
);
1594 /* No streaming, we have to set the len with the full padding */
1597 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1598 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1600 ERR("Reset metadata file");
1603 stream
->reset_metadata_flag
= 0;
1607 * Check if we need to change the tracefile before writing the packet.
1609 if (stream
->chan
->tracefile_size
> 0 &&
1610 (stream
->tracefile_size_current
+ len
) >
1611 stream
->chan
->tracefile_size
) {
1612 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1613 stream
->name
, stream
->chan
->tracefile_size
,
1614 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1615 stream
->out_fd
, &(stream
->tracefile_count_current
),
1618 ERR("Rotating output file");
1621 outfd
= stream
->out_fd
;
1623 if (stream
->index_fd
>= 0) {
1624 ret
= close(stream
->index_fd
);
1626 PERROR("Closing index");
1629 stream
->index_fd
= -1;
1630 ret
= index_create_file(stream
->chan
->pathname
,
1631 stream
->name
, stream
->uid
, stream
->gid
,
1632 stream
->chan
->tracefile_size
,
1633 stream
->tracefile_count_current
);
1637 stream
->index_fd
= ret
;
1640 /* Reset current size because we just perform a rotation. */
1641 stream
->tracefile_size_current
= 0;
1642 stream
->out_fd_offset
= 0;
1645 stream
->tracefile_size_current
+= len
;
1647 index
->offset
= htobe64(stream
->out_fd_offset
);
1652 * This call guarantee that len or less is returned. It's impossible to
1653 * receive a ret value that is bigger than len.
1655 ret
= lttng_write(outfd
, mmap_base
+ mmap_offset
, len
);
1656 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, len
);
1657 if (ret
< 0 || ((size_t) ret
!= len
)) {
1659 * Report error to caller if nothing was written else at least send the
1667 /* Socket operation failed. We consider the relayd dead */
1668 if (errno
== EPIPE
|| errno
== EINVAL
|| errno
== EBADF
) {
1670 * This is possible if the fd is closed on the other side
1671 * (outfd) or any write problem. It can be verbose a bit for a
1672 * normal execution if for instance the relayd is stopped
1673 * abruptly. This can happen so set this to a DBG statement.
1675 DBG("Consumer mmap write detected relayd hang up");
1677 /* Unhandled error, print it and stop function right now. */
1678 PERROR("Error in write mmap (ret %zd != len %lu)", ret
, len
);
1682 stream
->output_written
+= ret
;
1684 /* This call is useless on a socket so better save a syscall. */
1686 /* This won't block, but will start writeout asynchronously */
1687 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, len
,
1688 SYNC_FILE_RANGE_WRITE
);
1689 stream
->out_fd_offset
+= len
;
1691 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1695 * This is a special case that the relayd has closed its socket. Let's
1696 * cleanup the relayd object and all associated streams.
1698 if (relayd
&& relayd_hang_up
) {
1699 cleanup_relayd(relayd
, ctx
);
1703 /* Unlock only if ctrl socket used */
1704 if (relayd
&& stream
->metadata_flag
) {
1705 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1713 * Splice the data from the ring buffer to the tracefile.
1715 * It must be called with the stream lock held.
1717 * Returns the number of bytes spliced.
1719 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1720 struct lttng_consumer_local_data
*ctx
,
1721 struct lttng_consumer_stream
*stream
, unsigned long len
,
1722 unsigned long padding
,
1723 struct ctf_packet_index
*index
)
1725 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1727 off_t orig_offset
= stream
->out_fd_offset
;
1728 int fd
= stream
->wait_fd
;
1729 /* Default is on the disk */
1730 int outfd
= stream
->out_fd
;
1731 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1733 unsigned int relayd_hang_up
= 0;
1735 switch (consumer_data
.type
) {
1736 case LTTNG_CONSUMER_KERNEL
:
1738 case LTTNG_CONSUMER32_UST
:
1739 case LTTNG_CONSUMER64_UST
:
1740 /* Not supported for user space tracing */
1743 ERR("Unknown consumer_data type");
1747 /* RCU lock for the relayd pointer */
1750 /* Flag that the current stream if set for network streaming. */
1751 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1752 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1753 if (relayd
== NULL
) {
1758 splice_pipe
= stream
->splice_pipe
;
1760 /* Write metadata stream id before payload */
1762 unsigned long total_len
= len
;
1764 if (stream
->metadata_flag
) {
1766 * Lock the control socket for the complete duration of the function
1767 * since from this point on we will use the socket.
1769 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1771 if (stream
->reset_metadata_flag
) {
1772 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1773 stream
->relayd_stream_id
,
1774 stream
->metadata_version
);
1779 stream
->reset_metadata_flag
= 0;
1781 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
, relayd
,
1789 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1792 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1798 /* Use the returned socket. */
1801 /* No streaming, we have to set the len with the full padding */
1804 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1805 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1807 ERR("Reset metadata file");
1810 stream
->reset_metadata_flag
= 0;
1813 * Check if we need to change the tracefile before writing the packet.
1815 if (stream
->chan
->tracefile_size
> 0 &&
1816 (stream
->tracefile_size_current
+ len
) >
1817 stream
->chan
->tracefile_size
) {
1818 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1819 stream
->name
, stream
->chan
->tracefile_size
,
1820 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1821 stream
->out_fd
, &(stream
->tracefile_count_current
),
1825 ERR("Rotating output file");
1828 outfd
= stream
->out_fd
;
1830 if (stream
->index_fd
>= 0) {
1831 ret
= close(stream
->index_fd
);
1833 PERROR("Closing index");
1836 stream
->index_fd
= -1;
1837 ret
= index_create_file(stream
->chan
->pathname
,
1838 stream
->name
, stream
->uid
, stream
->gid
,
1839 stream
->chan
->tracefile_size
,
1840 stream
->tracefile_count_current
);
1845 stream
->index_fd
= ret
;
1848 /* Reset current size because we just perform a rotation. */
1849 stream
->tracefile_size_current
= 0;
1850 stream
->out_fd_offset
= 0;
1853 stream
->tracefile_size_current
+= len
;
1854 index
->offset
= htobe64(stream
->out_fd_offset
);
1858 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1859 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1860 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1861 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1862 DBG("splice chan to pipe, ret %zd", ret_splice
);
1863 if (ret_splice
< 0) {
1866 PERROR("Error in relay splice");
1870 /* Handle stream on the relayd if the output is on the network */
1871 if (relayd
&& stream
->metadata_flag
) {
1872 size_t metadata_payload_size
=
1873 sizeof(struct lttcomm_relayd_metadata_payload
);
1875 /* Update counter to fit the spliced data */
1876 ret_splice
+= metadata_payload_size
;
1877 len
+= metadata_payload_size
;
1879 * We do this so the return value can match the len passed as
1880 * argument to this function.
1882 written
-= metadata_payload_size
;
1885 /* Splice data out */
1886 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1887 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1888 DBG("Consumer splice pipe to file (out_fd: %d), ret %zd",
1890 if (ret_splice
< 0) {
1895 } else if (ret_splice
> len
) {
1897 * We don't expect this code path to be executed but you never know
1898 * so this is an extra protection agains a buggy splice().
1901 written
+= ret_splice
;
1902 PERROR("Wrote more data than requested %zd (len: %lu)", ret_splice
,
1906 /* All good, update current len and continue. */
1910 /* This call is useless on a socket so better save a syscall. */
1912 /* This won't block, but will start writeout asynchronously */
1913 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
1914 SYNC_FILE_RANGE_WRITE
);
1915 stream
->out_fd_offset
+= ret_splice
;
1917 stream
->output_written
+= ret_splice
;
1918 written
+= ret_splice
;
1920 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1925 * This is a special case that the relayd has closed its socket. Let's
1926 * cleanup the relayd object and all associated streams.
1928 if (relayd
&& relayd_hang_up
) {
1929 cleanup_relayd(relayd
, ctx
);
1930 /* Skip splice error so the consumer does not fail */
1935 /* send the appropriate error description to sessiond */
1938 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
1941 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
1944 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
1949 if (relayd
&& stream
->metadata_flag
) {
1950 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1958 * Take a snapshot for a specific fd
1960 * Returns 0 on success, < 0 on error
1962 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1964 switch (consumer_data
.type
) {
1965 case LTTNG_CONSUMER_KERNEL
:
1966 return lttng_kconsumer_take_snapshot(stream
);
1967 case LTTNG_CONSUMER32_UST
:
1968 case LTTNG_CONSUMER64_UST
:
1969 return lttng_ustconsumer_take_snapshot(stream
);
1971 ERR("Unknown consumer_data type");
1978 * Get the produced position
1980 * Returns 0 on success, < 0 on error
1982 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
1985 switch (consumer_data
.type
) {
1986 case LTTNG_CONSUMER_KERNEL
:
1987 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
1988 case LTTNG_CONSUMER32_UST
:
1989 case LTTNG_CONSUMER64_UST
:
1990 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
1992 ERR("Unknown consumer_data type");
1998 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1999 int sock
, struct pollfd
*consumer_sockpoll
)
2001 switch (consumer_data
.type
) {
2002 case LTTNG_CONSUMER_KERNEL
:
2003 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2004 case LTTNG_CONSUMER32_UST
:
2005 case LTTNG_CONSUMER64_UST
:
2006 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2008 ERR("Unknown consumer_data type");
2014 void lttng_consumer_close_all_metadata(void)
2016 switch (consumer_data
.type
) {
2017 case LTTNG_CONSUMER_KERNEL
:
2019 * The Kernel consumer has a different metadata scheme so we don't
2020 * close anything because the stream will be closed by the session
2024 case LTTNG_CONSUMER32_UST
:
2025 case LTTNG_CONSUMER64_UST
:
2027 * Close all metadata streams. The metadata hash table is passed and
2028 * this call iterates over it by closing all wakeup fd. This is safe
2029 * because at this point we are sure that the metadata producer is
2030 * either dead or blocked.
2032 lttng_ustconsumer_close_all_metadata(metadata_ht
);
2035 ERR("Unknown consumer_data type");
2041 * Clean up a metadata stream and free its memory.
2043 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
2044 struct lttng_ht
*ht
)
2046 struct lttng_consumer_channel
*free_chan
= NULL
;
2050 * This call should NEVER receive regular stream. It must always be
2051 * metadata stream and this is crucial for data structure synchronization.
2053 assert(stream
->metadata_flag
);
2055 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
2057 pthread_mutex_lock(&consumer_data
.lock
);
2058 pthread_mutex_lock(&stream
->chan
->lock
);
2059 pthread_mutex_lock(&stream
->lock
);
2061 /* Remove any reference to that stream. */
2062 consumer_stream_delete(stream
, ht
);
2064 /* Close down everything including the relayd if one. */
2065 consumer_stream_close(stream
);
2066 /* Destroy tracer buffers of the stream. */
2067 consumer_stream_destroy_buffers(stream
);
2069 /* Atomically decrement channel refcount since other threads can use it. */
2070 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1)
2071 && !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
2072 /* Go for channel deletion! */
2073 free_chan
= stream
->chan
;
2077 * Nullify the stream reference so it is not used after deletion. The
2078 * channel lock MUST be acquired before being able to check for a NULL
2081 stream
->chan
->metadata_stream
= NULL
;
2083 pthread_mutex_unlock(&stream
->lock
);
2084 pthread_mutex_unlock(&stream
->chan
->lock
);
2085 pthread_mutex_unlock(&consumer_data
.lock
);
2088 consumer_del_channel(free_chan
);
2091 consumer_stream_free(stream
);
2095 * Action done with the metadata stream when adding it to the consumer internal
2096 * data structures to handle it.
2098 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
)
2100 struct lttng_ht
*ht
= metadata_ht
;
2102 struct lttng_ht_iter iter
;
2103 struct lttng_ht_node_u64
*node
;
2108 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
2110 pthread_mutex_lock(&consumer_data
.lock
);
2111 pthread_mutex_lock(&stream
->chan
->lock
);
2112 pthread_mutex_lock(&stream
->chan
->timer_lock
);
2113 pthread_mutex_lock(&stream
->lock
);
2116 * From here, refcounts are updated so be _careful_ when returning an error
2123 * Lookup the stream just to make sure it does not exist in our internal
2124 * state. This should NEVER happen.
2126 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
2127 node
= lttng_ht_iter_get_node_u64(&iter
);
2131 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2132 * in terms of destroying the associated channel, because the action that
2133 * causes the count to become 0 also causes a stream to be added. The
2134 * channel deletion will thus be triggered by the following removal of this
2137 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2138 /* Increment refcount before decrementing nb_init_stream_left */
2140 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2143 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2145 lttng_ht_add_unique_u64(consumer_data
.stream_per_chan_id_ht
,
2146 &stream
->node_channel_id
);
2149 * Add stream to the stream_list_ht of the consumer data. No need to steal
2150 * the key since the HT does not use it and we allow to add redundant keys
2153 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2157 pthread_mutex_unlock(&stream
->lock
);
2158 pthread_mutex_unlock(&stream
->chan
->lock
);
2159 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
2160 pthread_mutex_unlock(&consumer_data
.lock
);
2165 * Delete data stream that are flagged for deletion (endpoint_status).
2167 static void validate_endpoint_status_data_stream(void)
2169 struct lttng_ht_iter iter
;
2170 struct lttng_consumer_stream
*stream
;
2172 DBG("Consumer delete flagged data stream");
2175 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2176 /* Validate delete flag of the stream */
2177 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2180 /* Delete it right now */
2181 consumer_del_stream(stream
, data_ht
);
2187 * Delete metadata stream that are flagged for deletion (endpoint_status).
2189 static void validate_endpoint_status_metadata_stream(
2190 struct lttng_poll_event
*pollset
)
2192 struct lttng_ht_iter iter
;
2193 struct lttng_consumer_stream
*stream
;
2195 DBG("Consumer delete flagged metadata stream");
2200 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2201 /* Validate delete flag of the stream */
2202 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2206 * Remove from pollset so the metadata thread can continue without
2207 * blocking on a deleted stream.
2209 lttng_poll_del(pollset
, stream
->wait_fd
);
2211 /* Delete it right now */
2212 consumer_del_metadata_stream(stream
, metadata_ht
);
2218 * Thread polls on metadata file descriptor and write them on disk or on the
2221 void *consumer_thread_metadata_poll(void *data
)
2223 int ret
, i
, pollfd
, err
= -1;
2224 uint32_t revents
, nb_fd
;
2225 struct lttng_consumer_stream
*stream
= NULL
;
2226 struct lttng_ht_iter iter
;
2227 struct lttng_ht_node_u64
*node
;
2228 struct lttng_poll_event events
;
2229 struct lttng_consumer_local_data
*ctx
= data
;
2232 rcu_register_thread();
2234 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_METADATA
);
2236 if (testpoint(consumerd_thread_metadata
)) {
2237 goto error_testpoint
;
2240 health_code_update();
2242 DBG("Thread metadata poll started");
2244 /* Size is set to 1 for the consumer_metadata pipe */
2245 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2247 ERR("Poll set creation failed");
2251 ret
= lttng_poll_add(&events
,
2252 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2258 DBG("Metadata main loop started");
2262 health_code_update();
2263 health_poll_entry();
2264 DBG("Metadata poll wait");
2265 ret
= lttng_poll_wait(&events
, -1);
2266 DBG("Metadata poll return from wait with %d fd(s)",
2267 LTTNG_POLL_GETNB(&events
));
2269 DBG("Metadata event caught in thread");
2271 if (errno
== EINTR
) {
2272 ERR("Poll EINTR caught");
2275 if (LTTNG_POLL_GETNB(&events
) == 0) {
2276 err
= 0; /* All is OK */
2283 /* From here, the event is a metadata wait fd */
2284 for (i
= 0; i
< nb_fd
; i
++) {
2285 health_code_update();
2287 revents
= LTTNG_POLL_GETEV(&events
, i
);
2288 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2291 /* No activity for this FD (poll implementation). */
2295 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2296 if (revents
& LPOLLIN
) {
2299 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2300 &stream
, sizeof(stream
));
2301 if (pipe_len
< sizeof(stream
)) {
2303 PERROR("read metadata stream");
2306 * Remove the pipe from the poll set and continue the loop
2307 * since their might be data to consume.
2309 lttng_poll_del(&events
,
2310 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2311 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2315 /* A NULL stream means that the state has changed. */
2316 if (stream
== NULL
) {
2317 /* Check for deleted streams. */
2318 validate_endpoint_status_metadata_stream(&events
);
2322 DBG("Adding metadata stream %d to poll set",
2325 /* Add metadata stream to the global poll events list */
2326 lttng_poll_add(&events
, stream
->wait_fd
,
2327 LPOLLIN
| LPOLLPRI
| LPOLLHUP
);
2328 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2329 DBG("Metadata thread pipe hung up");
2331 * Remove the pipe from the poll set and continue the loop
2332 * since their might be data to consume.
2334 lttng_poll_del(&events
,
2335 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2336 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2339 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2343 /* Handle other stream */
2349 uint64_t tmp_id
= (uint64_t) pollfd
;
2351 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2353 node
= lttng_ht_iter_get_node_u64(&iter
);
2356 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2359 if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2360 /* Get the data out of the metadata file descriptor */
2361 DBG("Metadata available on fd %d", pollfd
);
2362 assert(stream
->wait_fd
== pollfd
);
2365 health_code_update();
2367 len
= ctx
->on_buffer_ready(stream
, ctx
);
2369 * We don't check the return value here since if we get
2370 * a negative len, it means an error occured thus we
2371 * simply remove it from the poll set and free the
2376 /* It's ok to have an unavailable sub-buffer */
2377 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2378 /* Clean up stream from consumer and free it. */
2379 lttng_poll_del(&events
, stream
->wait_fd
);
2380 consumer_del_metadata_stream(stream
, metadata_ht
);
2382 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2383 DBG("Metadata fd %d is hup|err.", pollfd
);
2384 if (!stream
->hangup_flush_done
2385 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2386 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2387 DBG("Attempting to flush and consume the UST buffers");
2388 lttng_ustconsumer_on_stream_hangup(stream
);
2390 /* We just flushed the stream now read it. */
2392 health_code_update();
2394 len
= ctx
->on_buffer_ready(stream
, ctx
);
2396 * We don't check the return value here since if we get
2397 * a negative len, it means an error occured thus we
2398 * simply remove it from the poll set and free the
2404 lttng_poll_del(&events
, stream
->wait_fd
);
2406 * This call update the channel states, closes file descriptors
2407 * and securely free the stream.
2409 consumer_del_metadata_stream(stream
, metadata_ht
);
2411 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2415 /* Release RCU lock for the stream looked up */
2423 DBG("Metadata poll thread exiting");
2425 lttng_poll_clean(&events
);
2430 ERR("Health error occurred in %s", __func__
);
2432 health_unregister(health_consumerd
);
2433 rcu_unregister_thread();
2438 * This thread polls the fds in the set to consume the data and write
2439 * it to tracefile if necessary.
2441 void *consumer_thread_data_poll(void *data
)
2443 int num_rdy
, num_hup
, high_prio
, ret
, i
, err
= -1;
2444 struct pollfd
*pollfd
= NULL
;
2445 /* local view of the streams */
2446 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2447 /* local view of consumer_data.fds_count */
2449 struct lttng_consumer_local_data
*ctx
= data
;
2452 rcu_register_thread();
2454 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_DATA
);
2456 if (testpoint(consumerd_thread_data
)) {
2457 goto error_testpoint
;
2460 health_code_update();
2462 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
*));
2463 if (local_stream
== NULL
) {
2464 PERROR("local_stream malloc");
2469 health_code_update();
2475 * the fds set has been updated, we need to update our
2476 * local array as well
2478 pthread_mutex_lock(&consumer_data
.lock
);
2479 if (consumer_data
.need_update
) {
2484 local_stream
= NULL
;
2487 * Allocate for all fds +1 for the consumer_data_pipe and +1 for
2490 pollfd
= zmalloc((consumer_data
.stream_count
+ 2) * sizeof(struct pollfd
));
2491 if (pollfd
== NULL
) {
2492 PERROR("pollfd malloc");
2493 pthread_mutex_unlock(&consumer_data
.lock
);
2497 local_stream
= zmalloc((consumer_data
.stream_count
+ 2) *
2498 sizeof(struct lttng_consumer_stream
*));
2499 if (local_stream
== NULL
) {
2500 PERROR("local_stream malloc");
2501 pthread_mutex_unlock(&consumer_data
.lock
);
2504 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2507 ERR("Error in allocating pollfd or local_outfds");
2508 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2509 pthread_mutex_unlock(&consumer_data
.lock
);
2513 consumer_data
.need_update
= 0;
2515 pthread_mutex_unlock(&consumer_data
.lock
);
2517 /* No FDs and consumer_quit, consumer_cleanup the thread */
2518 if (nb_fd
== 0 && consumer_quit
== 1) {
2519 err
= 0; /* All is OK */
2522 /* poll on the array of fds */
2524 DBG("polling on %d fd", nb_fd
+ 2);
2525 health_poll_entry();
2526 num_rdy
= poll(pollfd
, nb_fd
+ 2, -1);
2528 DBG("poll num_rdy : %d", num_rdy
);
2529 if (num_rdy
== -1) {
2531 * Restart interrupted system call.
2533 if (errno
== EINTR
) {
2536 PERROR("Poll error");
2537 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2539 } else if (num_rdy
== 0) {
2540 DBG("Polling thread timed out");
2545 * If the consumer_data_pipe triggered poll go directly to the
2546 * beginning of the loop to update the array. We want to prioritize
2547 * array update over low-priority reads.
2549 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2550 ssize_t pipe_readlen
;
2552 DBG("consumer_data_pipe wake up");
2553 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2554 &new_stream
, sizeof(new_stream
));
2555 if (pipe_readlen
< sizeof(new_stream
)) {
2556 PERROR("Consumer data pipe");
2557 /* Continue so we can at least handle the current stream(s). */
2562 * If the stream is NULL, just ignore it. It's also possible that
2563 * the sessiond poll thread changed the consumer_quit state and is
2564 * waking us up to test it.
2566 if (new_stream
== NULL
) {
2567 validate_endpoint_status_data_stream();
2571 /* Continue to update the local streams and handle prio ones */
2575 /* Handle wakeup pipe. */
2576 if (pollfd
[nb_fd
+ 1].revents
& (POLLIN
| POLLPRI
)) {
2578 ssize_t pipe_readlen
;
2580 pipe_readlen
= lttng_pipe_read(ctx
->consumer_wakeup_pipe
, &dummy
,
2582 if (pipe_readlen
< 0) {
2583 PERROR("Consumer data wakeup pipe");
2585 /* We've been awakened to handle stream(s). */
2586 ctx
->has_wakeup
= 0;
2589 /* Take care of high priority channels first. */
2590 for (i
= 0; i
< nb_fd
; i
++) {
2591 health_code_update();
2593 if (local_stream
[i
] == NULL
) {
2596 if (pollfd
[i
].revents
& POLLPRI
) {
2597 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2599 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2600 /* it's ok to have an unavailable sub-buffer */
2601 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2602 /* Clean the stream and free it. */
2603 consumer_del_stream(local_stream
[i
], data_ht
);
2604 local_stream
[i
] = NULL
;
2605 } else if (len
> 0) {
2606 local_stream
[i
]->data_read
= 1;
2612 * If we read high prio channel in this loop, try again
2613 * for more high prio data.
2619 /* Take care of low priority channels. */
2620 for (i
= 0; i
< nb_fd
; i
++) {
2621 health_code_update();
2623 if (local_stream
[i
] == NULL
) {
2626 if ((pollfd
[i
].revents
& POLLIN
) ||
2627 local_stream
[i
]->hangup_flush_done
||
2628 local_stream
[i
]->has_data
) {
2629 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2630 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2631 /* it's ok to have an unavailable sub-buffer */
2632 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2633 /* Clean the stream and free it. */
2634 consumer_del_stream(local_stream
[i
], data_ht
);
2635 local_stream
[i
] = NULL
;
2636 } else if (len
> 0) {
2637 local_stream
[i
]->data_read
= 1;
2642 /* Handle hangup and errors */
2643 for (i
= 0; i
< nb_fd
; i
++) {
2644 health_code_update();
2646 if (local_stream
[i
] == NULL
) {
2649 if (!local_stream
[i
]->hangup_flush_done
2650 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2651 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2652 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2653 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2655 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2656 /* Attempt read again, for the data we just flushed. */
2657 local_stream
[i
]->data_read
= 1;
2660 * If the poll flag is HUP/ERR/NVAL and we have
2661 * read no data in this pass, we can remove the
2662 * stream from its hash table.
2664 if ((pollfd
[i
].revents
& POLLHUP
)) {
2665 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2666 if (!local_stream
[i
]->data_read
) {
2667 consumer_del_stream(local_stream
[i
], data_ht
);
2668 local_stream
[i
] = NULL
;
2671 } else if (pollfd
[i
].revents
& POLLERR
) {
2672 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2673 if (!local_stream
[i
]->data_read
) {
2674 consumer_del_stream(local_stream
[i
], data_ht
);
2675 local_stream
[i
] = NULL
;
2678 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2679 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2680 if (!local_stream
[i
]->data_read
) {
2681 consumer_del_stream(local_stream
[i
], data_ht
);
2682 local_stream
[i
] = NULL
;
2686 if (local_stream
[i
] != NULL
) {
2687 local_stream
[i
]->data_read
= 0;
2694 DBG("polling thread exiting");
2699 * Close the write side of the pipe so epoll_wait() in
2700 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2701 * read side of the pipe. If we close them both, epoll_wait strangely does
2702 * not return and could create a endless wait period if the pipe is the
2703 * only tracked fd in the poll set. The thread will take care of closing
2706 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2711 ERR("Health error occurred in %s", __func__
);
2713 health_unregister(health_consumerd
);
2715 rcu_unregister_thread();
2720 * Close wake-up end of each stream belonging to the channel. This will
2721 * allow the poll() on the stream read-side to detect when the
2722 * write-side (application) finally closes them.
2725 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2727 struct lttng_ht
*ht
;
2728 struct lttng_consumer_stream
*stream
;
2729 struct lttng_ht_iter iter
;
2731 ht
= consumer_data
.stream_per_chan_id_ht
;
2734 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2735 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2736 ht
->match_fct
, &channel
->key
,
2737 &iter
.iter
, stream
, node_channel_id
.node
) {
2739 * Protect against teardown with mutex.
2741 pthread_mutex_lock(&stream
->lock
);
2742 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2745 switch (consumer_data
.type
) {
2746 case LTTNG_CONSUMER_KERNEL
:
2748 case LTTNG_CONSUMER32_UST
:
2749 case LTTNG_CONSUMER64_UST
:
2750 if (stream
->metadata_flag
) {
2751 /* Safe and protected by the stream lock. */
2752 lttng_ustconsumer_close_metadata(stream
->chan
);
2755 * Note: a mutex is taken internally within
2756 * liblttng-ust-ctl to protect timer wakeup_fd
2757 * use from concurrent close.
2759 lttng_ustconsumer_close_stream_wakeup(stream
);
2763 ERR("Unknown consumer_data type");
2767 pthread_mutex_unlock(&stream
->lock
);
2772 static void destroy_channel_ht(struct lttng_ht
*ht
)
2774 struct lttng_ht_iter iter
;
2775 struct lttng_consumer_channel
*channel
;
2783 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2784 ret
= lttng_ht_del(ht
, &iter
);
2789 lttng_ht_destroy(ht
);
2793 * This thread polls the channel fds to detect when they are being
2794 * closed. It closes all related streams if the channel is detected as
2795 * closed. It is currently only used as a shim layer for UST because the
2796 * consumerd needs to keep the per-stream wakeup end of pipes open for
2799 void *consumer_thread_channel_poll(void *data
)
2801 int ret
, i
, pollfd
, err
= -1;
2802 uint32_t revents
, nb_fd
;
2803 struct lttng_consumer_channel
*chan
= NULL
;
2804 struct lttng_ht_iter iter
;
2805 struct lttng_ht_node_u64
*node
;
2806 struct lttng_poll_event events
;
2807 struct lttng_consumer_local_data
*ctx
= data
;
2808 struct lttng_ht
*channel_ht
;
2810 rcu_register_thread();
2812 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_CHANNEL
);
2814 if (testpoint(consumerd_thread_channel
)) {
2815 goto error_testpoint
;
2818 health_code_update();
2820 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2822 /* ENOMEM at this point. Better to bail out. */
2826 DBG("Thread channel poll started");
2828 /* Size is set to 1 for the consumer_channel pipe */
2829 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2831 ERR("Poll set creation failed");
2835 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
2841 DBG("Channel main loop started");
2845 health_code_update();
2846 DBG("Channel poll wait");
2847 health_poll_entry();
2848 ret
= lttng_poll_wait(&events
, -1);
2849 DBG("Channel poll return from wait with %d fd(s)",
2850 LTTNG_POLL_GETNB(&events
));
2852 DBG("Channel event caught in thread");
2854 if (errno
== EINTR
) {
2855 ERR("Poll EINTR caught");
2858 if (LTTNG_POLL_GETNB(&events
) == 0) {
2859 err
= 0; /* All is OK */
2866 /* From here, the event is a channel wait fd */
2867 for (i
= 0; i
< nb_fd
; i
++) {
2868 health_code_update();
2870 revents
= LTTNG_POLL_GETEV(&events
, i
);
2871 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2874 /* No activity for this FD (poll implementation). */
2878 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
2879 if (revents
& LPOLLIN
) {
2880 enum consumer_channel_action action
;
2883 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
2886 ERR("Error reading channel pipe");
2888 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2893 case CONSUMER_CHANNEL_ADD
:
2894 DBG("Adding channel %d to poll set",
2897 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
2900 lttng_ht_add_unique_u64(channel_ht
,
2901 &chan
->wait_fd_node
);
2903 /* Add channel to the global poll events list */
2904 lttng_poll_add(&events
, chan
->wait_fd
,
2905 LPOLLERR
| LPOLLHUP
);
2907 case CONSUMER_CHANNEL_DEL
:
2910 * This command should never be called if the channel
2911 * has streams monitored by either the data or metadata
2912 * thread. The consumer only notify this thread with a
2913 * channel del. command if it receives a destroy
2914 * channel command from the session daemon that send it
2915 * if a command prior to the GET_CHANNEL failed.
2919 chan
= consumer_find_channel(key
);
2922 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
2925 lttng_poll_del(&events
, chan
->wait_fd
);
2926 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
2927 ret
= lttng_ht_del(channel_ht
, &iter
);
2930 switch (consumer_data
.type
) {
2931 case LTTNG_CONSUMER_KERNEL
:
2933 case LTTNG_CONSUMER32_UST
:
2934 case LTTNG_CONSUMER64_UST
:
2935 health_code_update();
2936 /* Destroy streams that might have been left in the stream list. */
2937 clean_channel_stream_list(chan
);
2940 ERR("Unknown consumer_data type");
2945 * Release our own refcount. Force channel deletion even if
2946 * streams were not initialized.
2948 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
2949 consumer_del_channel(chan
);
2954 case CONSUMER_CHANNEL_QUIT
:
2956 * Remove the pipe from the poll set and continue the loop
2957 * since their might be data to consume.
2959 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2962 ERR("Unknown action");
2965 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2966 DBG("Channel thread pipe hung up");
2968 * Remove the pipe from the poll set and continue the loop
2969 * since their might be data to consume.
2971 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2974 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2978 /* Handle other stream */
2984 uint64_t tmp_id
= (uint64_t) pollfd
;
2986 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
2988 node
= lttng_ht_iter_get_node_u64(&iter
);
2991 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
2994 /* Check for error event */
2995 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2996 DBG("Channel fd %d is hup|err.", pollfd
);
2998 lttng_poll_del(&events
, chan
->wait_fd
);
2999 ret
= lttng_ht_del(channel_ht
, &iter
);
3003 * This will close the wait fd for each stream associated to
3004 * this channel AND monitored by the data/metadata thread thus
3005 * will be clean by the right thread.
3007 consumer_close_channel_streams(chan
);
3009 /* Release our own refcount */
3010 if (!uatomic_sub_return(&chan
->refcount
, 1)
3011 && !uatomic_read(&chan
->nb_init_stream_left
)) {
3012 consumer_del_channel(chan
);
3015 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3020 /* Release RCU lock for the channel looked up */
3028 lttng_poll_clean(&events
);
3030 destroy_channel_ht(channel_ht
);
3033 DBG("Channel poll thread exiting");
3036 ERR("Health error occurred in %s", __func__
);
3038 health_unregister(health_consumerd
);
3039 rcu_unregister_thread();
3043 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
3044 struct pollfd
*sockpoll
, int client_socket
)
3051 ret
= lttng_consumer_poll_socket(sockpoll
);
3055 DBG("Metadata connection on client_socket");
3057 /* Blocking call, waiting for transmission */
3058 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
3059 if (ctx
->consumer_metadata_socket
< 0) {
3060 WARN("On accept metadata");
3071 * This thread listens on the consumerd socket and receives the file
3072 * descriptors from the session daemon.
3074 void *consumer_thread_sessiond_poll(void *data
)
3076 int sock
= -1, client_socket
, ret
, err
= -1;
3078 * structure to poll for incoming data on communication socket avoids
3079 * making blocking sockets.
3081 struct pollfd consumer_sockpoll
[2];
3082 struct lttng_consumer_local_data
*ctx
= data
;
3084 rcu_register_thread();
3086 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_SESSIOND
);
3088 if (testpoint(consumerd_thread_sessiond
)) {
3089 goto error_testpoint
;
3092 health_code_update();
3094 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
3095 unlink(ctx
->consumer_command_sock_path
);
3096 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
3097 if (client_socket
< 0) {
3098 ERR("Cannot create command socket");
3102 ret
= lttcomm_listen_unix_sock(client_socket
);
3107 DBG("Sending ready command to lttng-sessiond");
3108 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
3109 /* return < 0 on error, but == 0 is not fatal */
3111 ERR("Error sending ready command to lttng-sessiond");
3115 /* prepare the FDs to poll : to client socket and the should_quit pipe */
3116 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
3117 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
3118 consumer_sockpoll
[1].fd
= client_socket
;
3119 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3121 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3129 DBG("Connection on client_socket");
3131 /* Blocking call, waiting for transmission */
3132 sock
= lttcomm_accept_unix_sock(client_socket
);
3139 * Setup metadata socket which is the second socket connection on the
3140 * command unix socket.
3142 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
3151 /* This socket is not useful anymore. */
3152 ret
= close(client_socket
);
3154 PERROR("close client_socket");
3158 /* update the polling structure to poll on the established socket */
3159 consumer_sockpoll
[1].fd
= sock
;
3160 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3163 health_code_update();
3165 health_poll_entry();
3166 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3175 DBG("Incoming command on sock");
3176 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
3179 * This could simply be a session daemon quitting. Don't output
3182 DBG("Communication interrupted on command socket");
3186 if (consumer_quit
) {
3187 DBG("consumer_thread_receive_fds received quit from signal");
3188 err
= 0; /* All is OK */
3191 DBG("received command on sock");
3197 DBG("Consumer thread sessiond poll exiting");
3200 * Close metadata streams since the producer is the session daemon which
3203 * NOTE: for now, this only applies to the UST tracer.
3205 lttng_consumer_close_all_metadata();
3208 * when all fds have hung up, the polling thread
3214 * Notify the data poll thread to poll back again and test the
3215 * consumer_quit state that we just set so to quit gracefully.
3217 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
3219 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
3221 notify_health_quit_pipe(health_quit_pipe
);
3223 /* Cleaning up possibly open sockets. */
3227 PERROR("close sock sessiond poll");
3230 if (client_socket
>= 0) {
3231 ret
= close(client_socket
);
3233 PERROR("close client_socket sessiond poll");
3240 ERR("Health error occurred in %s", __func__
);
3242 health_unregister(health_consumerd
);
3244 rcu_unregister_thread();
3248 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
3249 struct lttng_consumer_local_data
*ctx
)
3253 pthread_mutex_lock(&stream
->lock
);
3254 if (stream
->metadata_flag
) {
3255 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
3258 switch (consumer_data
.type
) {
3259 case LTTNG_CONSUMER_KERNEL
:
3260 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
3262 case LTTNG_CONSUMER32_UST
:
3263 case LTTNG_CONSUMER64_UST
:
3264 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3267 ERR("Unknown consumer_data type");
3273 if (stream
->metadata_flag
) {
3274 pthread_cond_broadcast(&stream
->metadata_rdv
);
3275 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
3277 pthread_mutex_unlock(&stream
->lock
);
3281 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3283 switch (consumer_data
.type
) {
3284 case LTTNG_CONSUMER_KERNEL
:
3285 return lttng_kconsumer_on_recv_stream(stream
);
3286 case LTTNG_CONSUMER32_UST
:
3287 case LTTNG_CONSUMER64_UST
:
3288 return lttng_ustconsumer_on_recv_stream(stream
);
3290 ERR("Unknown consumer_data type");
3297 * Allocate and set consumer data hash tables.
3299 int lttng_consumer_init(void)
3301 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3302 if (!consumer_data
.channel_ht
) {
3306 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3307 if (!consumer_data
.relayd_ht
) {
3311 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3312 if (!consumer_data
.stream_list_ht
) {
3316 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3317 if (!consumer_data
.stream_per_chan_id_ht
) {
3321 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3326 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3338 * Process the ADD_RELAYD command receive by a consumer.
3340 * This will create a relayd socket pair and add it to the relayd hash table.
3341 * The caller MUST acquire a RCU read side lock before calling it.
3343 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3344 struct lttng_consumer_local_data
*ctx
, int sock
,
3345 struct pollfd
*consumer_sockpoll
,
3346 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
,
3347 uint64_t relayd_session_id
)
3349 int fd
= -1, ret
= -1, relayd_created
= 0;
3350 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3351 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3354 assert(relayd_sock
);
3356 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3358 /* Get relayd reference if exists. */
3359 relayd
= consumer_find_relayd(net_seq_idx
);
3360 if (relayd
== NULL
) {
3361 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3362 /* Not found. Allocate one. */
3363 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3364 if (relayd
== NULL
) {
3366 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3369 relayd
->sessiond_session_id
= sessiond_id
;
3374 * This code path MUST continue to the consumer send status message to
3375 * we can notify the session daemon and continue our work without
3376 * killing everything.
3380 * relayd key should never be found for control socket.
3382 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3385 /* First send a status message before receiving the fds. */
3386 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
3388 /* Somehow, the session daemon is not responding anymore. */
3389 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3390 goto error_nosignal
;
3393 /* Poll on consumer socket. */
3394 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3396 /* Needing to exit in the middle of a command: error. */
3397 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3399 goto error_nosignal
;
3402 /* Get relayd socket from session daemon */
3403 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3404 if (ret
!= sizeof(fd
)) {
3406 fd
= -1; /* Just in case it gets set with an invalid value. */
3409 * Failing to receive FDs might indicate a major problem such as
3410 * reaching a fd limit during the receive where the kernel returns a
3411 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3412 * don't take any chances and stop everything.
3414 * XXX: Feature request #558 will fix that and avoid this possible
3415 * issue when reaching the fd limit.
3417 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3418 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3422 /* Copy socket information and received FD */
3423 switch (sock_type
) {
3424 case LTTNG_STREAM_CONTROL
:
3425 /* Copy received lttcomm socket */
3426 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3427 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3428 /* Handle create_sock error. */
3430 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3434 * Close the socket created internally by
3435 * lttcomm_create_sock, so we can replace it by the one
3436 * received from sessiond.
3438 if (close(relayd
->control_sock
.sock
.fd
)) {
3442 /* Assign new file descriptor */
3443 relayd
->control_sock
.sock
.fd
= fd
;
3444 fd
= -1; /* For error path */
3445 /* Assign version values. */
3446 relayd
->control_sock
.major
= relayd_sock
->major
;
3447 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3449 relayd
->relayd_session_id
= relayd_session_id
;
3452 case LTTNG_STREAM_DATA
:
3453 /* Copy received lttcomm socket */
3454 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3455 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3456 /* Handle create_sock error. */
3458 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3462 * Close the socket created internally by
3463 * lttcomm_create_sock, so we can replace it by the one
3464 * received from sessiond.
3466 if (close(relayd
->data_sock
.sock
.fd
)) {
3470 /* Assign new file descriptor */
3471 relayd
->data_sock
.sock
.fd
= fd
;
3472 fd
= -1; /* for eventual error paths */
3473 /* Assign version values. */
3474 relayd
->data_sock
.major
= relayd_sock
->major
;
3475 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3478 ERR("Unknown relayd socket type (%d)", sock_type
);
3480 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3484 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3485 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3486 relayd
->net_seq_idx
, fd
);
3488 /* We successfully added the socket. Send status back. */
3489 ret
= consumer_send_status_msg(sock
, ret_code
);
3491 /* Somehow, the session daemon is not responding anymore. */
3492 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3493 goto error_nosignal
;
3497 * Add relayd socket pair to consumer data hashtable. If object already
3498 * exists or on error, the function gracefully returns.
3506 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3507 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3511 /* Close received socket if valid. */
3514 PERROR("close received socket");
3518 if (relayd_created
) {
3526 * Try to lock the stream mutex.
3528 * On success, 1 is returned else 0 indicating that the mutex is NOT lock.
3530 static int stream_try_lock(struct lttng_consumer_stream
*stream
)
3537 * Try to lock the stream mutex. On failure, we know that the stream is
3538 * being used else where hence there is data still being extracted.
3540 ret
= pthread_mutex_trylock(&stream
->lock
);
3542 /* For both EBUSY and EINVAL error, the mutex is NOT locked. */
3554 * Search for a relayd associated to the session id and return the reference.
3556 * A rcu read side lock MUST be acquire before calling this function and locked
3557 * until the relayd object is no longer necessary.
3559 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3561 struct lttng_ht_iter iter
;
3562 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3564 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3565 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3568 * Check by sessiond id which is unique here where the relayd session
3569 * id might not be when having multiple relayd.
3571 if (relayd
->sessiond_session_id
== id
) {
3572 /* Found the relayd. There can be only one per id. */
3584 * Check if for a given session id there is still data needed to be extract
3587 * Return 1 if data is pending or else 0 meaning ready to be read.
3589 int consumer_data_pending(uint64_t id
)
3592 struct lttng_ht_iter iter
;
3593 struct lttng_ht
*ht
;
3594 struct lttng_consumer_stream
*stream
;
3595 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3596 int (*data_pending
)(struct lttng_consumer_stream
*);
3598 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3601 pthread_mutex_lock(&consumer_data
.lock
);
3603 switch (consumer_data
.type
) {
3604 case LTTNG_CONSUMER_KERNEL
:
3605 data_pending
= lttng_kconsumer_data_pending
;
3607 case LTTNG_CONSUMER32_UST
:
3608 case LTTNG_CONSUMER64_UST
:
3609 data_pending
= lttng_ustconsumer_data_pending
;
3612 ERR("Unknown consumer data type");
3616 /* Ease our life a bit */
3617 ht
= consumer_data
.stream_list_ht
;
3619 relayd
= find_relayd_by_session_id(id
);
3621 /* Send init command for data pending. */
3622 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3623 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3624 relayd
->relayd_session_id
);
3625 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3627 /* Communication error thus the relayd so no data pending. */
3628 goto data_not_pending
;
3632 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3633 ht
->hash_fct(&id
, lttng_ht_seed
),
3635 &iter
.iter
, stream
, node_session_id
.node
) {
3636 /* If this call fails, the stream is being used hence data pending. */
3637 ret
= stream_try_lock(stream
);
3643 * A removed node from the hash table indicates that the stream has
3644 * been deleted thus having a guarantee that the buffers are closed
3645 * on the consumer side. However, data can still be transmitted
3646 * over the network so don't skip the relayd check.
3648 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3650 /* Check the stream if there is data in the buffers. */
3651 ret
= data_pending(stream
);
3653 pthread_mutex_unlock(&stream
->lock
);
3660 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3661 if (stream
->metadata_flag
) {
3662 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3663 stream
->relayd_stream_id
);
3665 ret
= relayd_data_pending(&relayd
->control_sock
,
3666 stream
->relayd_stream_id
,
3667 stream
->next_net_seq_num
- 1);
3669 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3671 pthread_mutex_unlock(&stream
->lock
);
3675 pthread_mutex_unlock(&stream
->lock
);
3679 unsigned int is_data_inflight
= 0;
3681 /* Send init command for data pending. */
3682 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3683 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3684 relayd
->relayd_session_id
, &is_data_inflight
);
3685 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3687 goto data_not_pending
;
3689 if (is_data_inflight
) {
3695 * Finding _no_ node in the hash table and no inflight data means that the
3696 * stream(s) have been removed thus data is guaranteed to be available for
3697 * analysis from the trace files.
3701 /* Data is available to be read by a viewer. */
3702 pthread_mutex_unlock(&consumer_data
.lock
);
3707 /* Data is still being extracted from buffers. */
3708 pthread_mutex_unlock(&consumer_data
.lock
);
3714 * Send a ret code status message to the sessiond daemon.
3716 * Return the sendmsg() return value.
3718 int consumer_send_status_msg(int sock
, int ret_code
)
3720 struct lttcomm_consumer_status_msg msg
;
3722 memset(&msg
, 0, sizeof(msg
));
3723 msg
.ret_code
= ret_code
;
3725 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3729 * Send a channel status message to the sessiond daemon.
3731 * Return the sendmsg() return value.
3733 int consumer_send_status_channel(int sock
,
3734 struct lttng_consumer_channel
*channel
)
3736 struct lttcomm_consumer_status_channel msg
;
3740 memset(&msg
, 0, sizeof(msg
));
3742 msg
.ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
3744 msg
.ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3745 msg
.key
= channel
->key
;
3746 msg
.stream_count
= channel
->streams
.count
;
3749 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3752 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
3753 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
3754 uint64_t max_sb_size
)
3756 unsigned long start_pos
;
3758 if (!nb_packets_per_stream
) {
3759 return consumed_pos
; /* Grab everything */
3761 start_pos
= produced_pos
- offset_align_floor(produced_pos
, max_sb_size
);
3762 start_pos
-= max_sb_size
* nb_packets_per_stream
;
3763 if ((long) (start_pos
- consumed_pos
) < 0) {
3764 return consumed_pos
; /* Grab everything */