2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <lttng/ust-ctl.h>
27 #include <sys/socket.h>
29 #include <sys/types.h>
32 #include <urcu/list.h>
35 #include <common/common.h>
36 #include <common/sessiond-comm/sessiond-comm.h>
37 #include <common/relayd/relayd.h>
38 #include <common/compat/fcntl.h>
39 #include <common/consumer-metadata-cache.h>
40 #include <common/consumer-timer.h>
41 #include <common/utils.h>
43 #include "ust-consumer.h"
45 extern struct lttng_consumer_global_data consumer_data
;
46 extern int consumer_poll_timeout
;
47 extern volatile int consumer_quit
;
50 * Free channel object and all streams associated with it. This MUST be used
51 * only and only if the channel has _NEVER_ been added to the global channel
54 static void destroy_channel(struct lttng_consumer_channel
*channel
)
56 struct lttng_consumer_stream
*stream
, *stmp
;
60 DBG("UST consumer cleaning stream list");
62 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
64 cds_list_del(&stream
->send_node
);
65 ustctl_destroy_stream(stream
->ustream
);
70 * If a channel is available meaning that was created before the streams
74 lttng_ustconsumer_del_channel(channel
);
80 * Add channel to internal consumer state.
82 * Returns 0 on success or else a negative value.
84 static int add_channel(struct lttng_consumer_channel
*channel
,
85 struct lttng_consumer_local_data
*ctx
)
92 if (ctx
->on_recv_channel
!= NULL
) {
93 ret
= ctx
->on_recv_channel(channel
);
95 ret
= consumer_add_channel(channel
, ctx
);
97 /* Most likely an ENOMEM. */
98 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
102 ret
= consumer_add_channel(channel
, ctx
);
105 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
112 * Allocate and return a consumer channel object.
114 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
115 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
116 int relayd_id
, uint64_t key
, enum lttng_event_output output
,
117 uint64_t tracefile_size
, uint64_t tracefile_count
)
122 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
, gid
,
123 relayd_id
, output
, tracefile_size
, tracefile_count
);
127 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
128 * error value if applicable is set in it else it is kept untouched.
130 * Return NULL on error else the newly allocated stream object.
132 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
133 struct lttng_consumer_channel
*channel
,
134 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
137 struct lttng_consumer_stream
*stream
= NULL
;
142 stream
= consumer_allocate_stream(channel
->key
,
144 LTTNG_CONSUMER_ACTIVE_STREAM
,
153 if (stream
== NULL
) {
157 * We could not find the channel. Can happen if cpu hotplug
158 * happens while tearing down.
160 DBG3("Could not find channel");
165 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
171 stream
->chan
= channel
;
175 *_alloc_ret
= alloc_ret
;
181 * Send the given stream pointer to the corresponding thread.
183 * Returns 0 on success else a negative value.
185 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
186 struct lttng_consumer_local_data
*ctx
)
188 int ret
, stream_pipe
;
190 /* Get the right pipe where the stream will be sent. */
191 if (stream
->metadata_flag
) {
192 stream_pipe
= ctx
->consumer_metadata_pipe
[1];
194 stream_pipe
= ctx
->consumer_data_pipe
[1];
198 ret
= write(stream_pipe
, &stream
, sizeof(stream
));
199 } while (ret
< 0 && errno
== EINTR
);
201 PERROR("Consumer write %s stream to pipe %d",
202 stream
->metadata_flag
? "metadata" : "data", stream_pipe
);
209 * Search for a relayd object related to the stream. If found, send the stream
212 * On success, returns 0 else a negative value.
214 static int send_stream_to_relayd(struct lttng_consumer_stream
*stream
)
217 struct consumer_relayd_sock_pair
*relayd
;
221 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
222 if (relayd
!= NULL
) {
223 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
224 /* Add stream on the relayd */
225 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
226 stream
->chan
->pathname
, &stream
->relayd_stream_id
,
227 stream
->chan
->tracefile_size
,
228 stream
->chan
->tracefile_count
);
229 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
233 } else if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
234 ERR("Network sequence index %" PRIu64
" unknown. Not adding stream.",
235 stream
->net_seq_idx
);
245 * Create streams for the given channel using liblttng-ust-ctl.
247 * Return 0 on success else a negative value.
249 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
250 struct lttng_consumer_local_data
*ctx
)
253 struct ustctl_consumer_stream
*ustream
;
254 struct lttng_consumer_stream
*stream
;
260 * While a stream is available from ustctl. When NULL is returned, we've
261 * reached the end of the possible stream for the channel.
263 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
266 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
268 /* Allocate consumer stream object. */
269 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
273 stream
->ustream
= ustream
;
275 * Store it so we can save multiple function calls afterwards since
276 * this value is used heavily in the stream threads. This is UST
277 * specific so this is why it's done after allocation.
279 stream
->wait_fd
= wait_fd
;
282 * Increment channel refcount since the channel reference has now been
283 * assigned in the allocation process above.
285 uatomic_inc(&stream
->chan
->refcount
);
288 * Order is important this is why a list is used. On error, the caller
289 * should clean this list.
291 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
293 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
294 &stream
->max_sb_size
);
296 ERR("ustctl_get_max_subbuf_size failed for stream %s",
301 /* Do actions once stream has been received. */
302 if (ctx
->on_recv_stream
) {
303 ret
= ctx
->on_recv_stream(stream
);
309 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
310 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
312 /* Set next CPU stream. */
313 channel
->streams
.count
= ++cpu
;
315 /* Keep stream reference when creating metadata. */
316 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
317 channel
->metadata_stream
= stream
;
329 * Create an UST channel with the given attributes and send it to the session
330 * daemon using the ust ctl API.
332 * Return 0 on success or else a negative value.
334 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
335 struct ustctl_consumer_channel
**chanp
)
338 struct ustctl_consumer_channel
*channel
;
343 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
344 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
345 "switch_timer_interval: %u, read_timer_interval: %u, "
346 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
347 attr
->num_subbuf
, attr
->switch_timer_interval
,
348 attr
->read_timer_interval
, attr
->output
, attr
->type
);
350 channel
= ustctl_create_channel(attr
);
365 * Send a single given stream to the session daemon using the sock.
367 * Return 0 on success else a negative value.
369 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
376 DBG2("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
378 /* Send stream to session daemon. */
379 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
389 * Send channel to sessiond.
391 * Return 0 on success or else a negative value.
393 static int send_sessiond_channel(int sock
,
394 struct lttng_consumer_channel
*channel
,
395 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
398 struct lttng_consumer_stream
*stream
;
404 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
406 /* Send channel to sessiond. */
407 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
412 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
417 /* The channel was sent successfully to the sessiond at this point. */
418 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
419 /* Try to send the stream to the relayd if one is available. */
420 ret
= send_stream_to_relayd(stream
);
423 * Flag that the relayd was the problem here probably due to a
424 * communicaton error on the socket.
432 /* Send stream to session daemon. */
433 ret
= send_sessiond_stream(sock
, stream
);
439 /* Tell sessiond there is no more stream. */
440 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
445 DBG("UST consumer NULL stream sent to sessiond");
454 * Creates a channel and streams and add the channel it to the channel internal
455 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
458 * Return 0 on success or else, a negative value is returned and the channel
459 * MUST be destroyed by consumer_del_channel().
461 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
462 struct lttng_consumer_channel
*channel
,
463 struct ustctl_consumer_channel_attr
*attr
)
472 * This value is still used by the kernel consumer since for the kernel,
473 * the stream ownership is not IN the consumer so we need to have the
474 * number of left stream that needs to be initialized so we can know when
475 * to delete the channel (see consumer.c).
477 * As for the user space tracer now, the consumer creates and sends the
478 * stream to the session daemon which only sends them to the application
479 * once every stream of a channel is received making this value useless
480 * because we they will be added to the poll thread before the application
481 * receives them. This ensures that a stream can not hang up during
482 * initilization of a channel.
484 channel
->nb_init_stream_left
= 0;
486 /* The reply msg status is handled in the following call. */
487 ret
= create_ust_channel(attr
, &channel
->uchan
);
492 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
498 /* Open all streams for this channel. */
499 ret
= create_ust_streams(channel
, ctx
);
509 * Send all stream of a channel to the right thread handling it.
511 * On error, return a negative value else 0 on success.
513 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
514 struct lttng_consumer_local_data
*ctx
)
517 struct lttng_consumer_stream
*stream
, *stmp
;
522 /* Send streams to the corresponding thread. */
523 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
525 /* Sending the stream to the thread. */
526 ret
= send_stream_to_thread(stream
, ctx
);
529 * If we are unable to send the stream to the thread, there is
530 * a big problem so just stop everything.
535 /* Remove node from the channel stream list. */
536 cds_list_del(&stream
->send_node
);
544 * Write metadata to the given channel using ustctl to convert the string to
546 * Called only from consumer_metadata_cache_write.
547 * The metadata cache lock MUST be acquired to write in the cache.
549 * Return 0 on success else a negative value.
551 int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel
*metadata
,
552 const char *metadata_str
, uint64_t target_offset
, uint64_t len
)
557 assert(metadata_str
);
559 DBG("UST consumer writing metadata to channel %s", metadata
->name
);
561 assert(target_offset
<= metadata
->metadata_cache
->max_offset
);
562 ret
= ustctl_write_metadata_to_channel(metadata
->uchan
,
563 metadata_str
+ target_offset
, len
);
565 ERR("ustctl write metadata fail with ret %d, len %" PRIu64
, ret
, len
);
569 ustctl_flush_buffer(metadata
->metadata_stream
->ustream
, 1);
576 * Flush channel's streams using the given key to retrieve the channel.
578 * Return 0 on success else an LTTng error code.
580 static int flush_channel(uint64_t chan_key
)
583 struct lttng_consumer_channel
*channel
;
584 struct lttng_consumer_stream
*stream
;
586 struct lttng_ht_iter iter
;
588 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
591 channel
= consumer_find_channel(chan_key
);
593 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
594 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
598 ht
= consumer_data
.stream_per_chan_id_ht
;
600 /* For each stream of the channel id, flush it. */
601 cds_lfht_for_each_entry_duplicate(ht
->ht
,
602 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
603 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
604 ustctl_flush_buffer(stream
->ustream
, 1);
612 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
613 * RCU read side lock MUST be acquired before calling this function.
615 * Return 0 on success else an LTTng error code.
617 static int close_metadata(uint64_t chan_key
)
620 struct lttng_consumer_channel
*channel
;
622 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
624 channel
= consumer_find_channel(chan_key
);
626 ERR("UST consumer close metadata %" PRIu64
" not found", chan_key
);
627 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
631 pthread_mutex_lock(&consumer_data
.lock
);
632 if (!cds_lfht_is_node_deleted(&channel
->node
.node
)) {
633 if (channel
->switch_timer_enabled
== 1) {
634 DBG("Deleting timer on metadata channel");
635 consumer_timer_switch_stop(channel
);
637 ret
= ustctl_stream_close_wakeup_fd(channel
->metadata_stream
->ustream
);
639 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret
);
640 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
646 pthread_mutex_unlock(&consumer_data
.lock
);
652 * RCU read side lock MUST be acquired before calling this function.
654 * Return 0 on success else an LTTng error code.
656 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
659 struct lttng_consumer_channel
*metadata
;
661 DBG("UST consumer setup metadata key %" PRIu64
, key
);
663 metadata
= consumer_find_channel(key
);
665 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
666 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
671 * Send metadata stream to relayd if one available. Availability is
672 * known if the stream is still in the list of the channel.
674 if (cds_list_empty(&metadata
->streams
.head
)) {
675 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
676 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
680 /* Send metadata stream to relayd if needed. */
681 ret
= send_stream_to_relayd(metadata
->metadata_stream
);
683 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
687 ret
= send_streams_to_thread(metadata
, ctx
);
690 * If we are unable to send the stream to the thread, there is
691 * a big problem so just stop everything.
693 ret
= LTTCOMM_CONSUMERD_FATAL
;
696 /* List MUST be empty after or else it could be reused. */
697 assert(cds_list_empty(&metadata
->streams
.head
));
706 * Receive the metadata updates from the sessiond.
708 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
709 uint64_t len
, struct lttng_consumer_channel
*channel
)
711 int ret
, ret_code
= LTTNG_OK
;
714 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
716 metadata_str
= zmalloc(len
* sizeof(char));
718 PERROR("zmalloc metadata string");
719 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
723 /* Receive metadata string. */
724 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
726 /* Session daemon is dead so return gracefully. */
731 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
732 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
734 /* Unable to handle metadata. Notify session daemon. */
735 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
737 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
739 while (consumer_metadata_cache_flushed(channel
, offset
+ len
)) {
740 DBG("Waiting for metadata to be flushed");
741 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
751 * Receive command from session daemon and process it.
753 * Return 1 on success else a negative value or 0.
755 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
756 int sock
, struct pollfd
*consumer_sockpoll
)
759 enum lttng_error_code ret_code
= LTTNG_OK
;
760 struct lttcomm_consumer_msg msg
;
761 struct lttng_consumer_channel
*channel
= NULL
;
763 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
764 if (ret
!= sizeof(msg
)) {
765 DBG("Consumer received unexpected message size %zd (expects %zu)",
767 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
769 * The ret value might 0 meaning an orderly shutdown but this is ok
770 * since the caller handles this.
774 if (msg
.cmd_type
== LTTNG_CONSUMER_STOP
) {
776 * Notify the session daemon that the command is completed.
778 * On transport layer error, the function call will print an error
779 * message so handling the returned code is a bit useless since we
780 * return an error code anyway.
782 (void) consumer_send_status_msg(sock
, ret_code
);
786 /* relayd needs RCU read-side lock */
789 switch (msg
.cmd_type
) {
790 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
792 /* Session daemon status message are handled in the following call. */
793 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
794 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
795 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
);
798 case LTTNG_CONSUMER_DESTROY_RELAYD
:
800 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
801 struct consumer_relayd_sock_pair
*relayd
;
803 DBG("UST consumer destroying relayd %" PRIu64
, index
);
805 /* Get relayd reference if exists. */
806 relayd
= consumer_find_relayd(index
);
807 if (relayd
== NULL
) {
808 DBG("Unable to find relayd %" PRIu64
, index
);
809 ret_code
= LTTNG_ERR_NO_CONSUMER
;
813 * Each relayd socket pair has a refcount of stream attached to it
814 * which tells if the relayd is still active or not depending on the
817 * This will set the destroy flag of the relayd object and destroy it
818 * if the refcount reaches zero when called.
820 * The destroy can happen either here or when a stream fd hangs up.
823 consumer_flag_relayd_for_destroy(relayd
);
826 goto end_msg_sessiond
;
828 case LTTNG_CONSUMER_UPDATE_STREAM
:
833 case LTTNG_CONSUMER_DATA_PENDING
:
835 int ret
, is_data_pending
;
836 uint64_t id
= msg
.u
.data_pending
.session_id
;
838 DBG("UST consumer data pending command for id %" PRIu64
, id
);
840 is_data_pending
= consumer_data_pending(id
);
842 /* Send back returned value to session daemon */
843 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
844 sizeof(is_data_pending
));
846 DBG("Error when sending the data pending ret code: %d", ret
);
850 * No need to send back a status message since the data pending
851 * returned value is the response.
855 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
858 struct ustctl_consumer_channel_attr attr
;
860 /* Create a plain object and reserve a channel key. */
861 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
862 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
863 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
864 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
865 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
866 msg
.u
.ask_channel
.tracefile_size
,
867 msg
.u
.ask_channel
.tracefile_count
);
869 goto end_channel_error
;
872 /* Build channel attributes from received message. */
873 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
874 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
875 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
876 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
877 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
878 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
879 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
881 /* Translate the event output type to UST. */
882 switch (channel
->output
) {
883 case LTTNG_EVENT_SPLICE
:
884 /* Splice not supported so fallback on mmap(). */
885 case LTTNG_EVENT_MMAP
:
887 attr
.output
= CONSUMER_CHANNEL_MMAP
;
891 /* Translate and save channel type. */
892 switch (msg
.u
.ask_channel
.type
) {
893 case LTTNG_UST_CHAN_PER_CPU
:
894 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
895 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
897 * Set refcount to 1 for owner. Below, we will
898 * pass ownership to the
899 * consumer_thread_channel_poll() thread.
901 channel
->refcount
= 1;
903 case LTTNG_UST_CHAN_METADATA
:
904 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
905 attr
.type
= LTTNG_UST_CHAN_METADATA
;
912 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
914 goto end_channel_error
;
917 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
918 ret
= consumer_metadata_cache_allocate(channel
);
920 ERR("Allocating metadata cache");
921 goto end_channel_error
;
923 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
924 attr
.switch_timer_interval
= 0;
928 * Add the channel to the internal state AFTER all streams were created
929 * and successfully sent to session daemon. This way, all streams must
930 * be ready before this channel is visible to the threads.
931 * If add_channel succeeds, ownership of the channel is
932 * passed to consumer_thread_channel_poll().
934 ret
= add_channel(channel
, ctx
);
936 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
937 if (channel
->switch_timer_enabled
== 1) {
938 consumer_timer_switch_stop(channel
);
940 consumer_metadata_cache_destroy(channel
);
942 goto end_channel_error
;
946 * Channel and streams are now created. Inform the session daemon that
947 * everything went well and should wait to receive the channel and
948 * streams with ustctl API.
950 ret
= consumer_send_status_channel(sock
, channel
);
953 * There is probably a problem on the socket so the poll will get
954 * it and clean everything up.
961 case LTTNG_CONSUMER_GET_CHANNEL
:
963 int ret
, relayd_err
= 0;
964 uint64_t key
= msg
.u
.get_channel
.key
;
965 struct lttng_consumer_channel
*channel
;
967 channel
= consumer_find_channel(key
);
969 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
970 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
971 goto end_msg_sessiond
;
974 /* Inform sessiond that we are about to send channel and streams. */
975 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
977 /* Somehow, the session daemon is not responding anymore. */
981 /* Send everything to sessiond. */
982 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
986 * We were unable to send to the relayd the stream so avoid
987 * sending back a fatal error to the thread since this is OK
988 * and the consumer can continue its work.
990 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
991 goto end_msg_sessiond
;
994 * The communicaton was broken hence there is a bad state between
995 * the consumer and sessiond so stop everything.
1000 ret
= send_streams_to_thread(channel
, ctx
);
1003 * If we are unable to send the stream to the thread, there is
1004 * a big problem so just stop everything.
1008 /* List MUST be empty after or else it could be reused. */
1009 assert(cds_list_empty(&channel
->streams
.head
));
1011 goto end_msg_sessiond
;
1013 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1015 uint64_t key
= msg
.u
.destroy_channel
.key
;
1018 * Only called if streams have not been sent to stream
1019 * manager thread. However, channel has been sent to
1020 * channel manager thread.
1022 notify_thread_del_channel(ctx
, key
);
1023 goto end_msg_sessiond
;
1025 case LTTNG_CONSUMER_CLOSE_METADATA
:
1029 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1034 goto end_msg_sessiond
;
1036 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1040 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1045 goto end_msg_sessiond
;
1047 case LTTNG_CONSUMER_PUSH_METADATA
:
1050 uint64_t len
= msg
.u
.push_metadata
.len
;
1051 uint64_t key
= msg
.u
.push_metadata
.key
;
1052 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1053 struct lttng_consumer_channel
*channel
;
1055 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1058 channel
= consumer_find_channel(key
);
1060 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
1061 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1062 goto end_msg_sessiond
;
1065 /* Tell session daemon we are ready to receive the metadata. */
1066 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
1068 /* Somehow, the session daemon is not responding anymore. */
1072 /* Wait for more data. */
1073 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
1077 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1080 /* error receiving from sessiond */
1084 goto end_msg_sessiond
;
1087 case LTTNG_CONSUMER_SETUP_METADATA
:
1091 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1095 goto end_msg_sessiond
;
1105 * Return 1 to indicate success since the 0 value can be a socket
1106 * shutdown during the recv() or send() call.
1112 * The returned value here is not useful since either way we'll return 1 to
1113 * the caller because the session daemon socket management is done
1114 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1116 (void) consumer_send_status_msg(sock
, ret_code
);
1122 * Free channel here since no one has a reference to it. We don't
1123 * free after that because a stream can store this pointer.
1125 destroy_channel(channel
);
1127 /* We have to send a status channel message indicating an error. */
1128 ret
= consumer_send_status_channel(sock
, NULL
);
1130 /* Stop everything if session daemon can not be notified. */
1137 /* This will issue a consumer stop. */
1142 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1143 * compiled out, we isolate it in this library.
1145 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1149 assert(stream
->ustream
);
1151 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1155 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1156 * compiled out, we isolate it in this library.
1158 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1161 assert(stream
->ustream
);
1163 return ustctl_get_mmap_base(stream
->ustream
);
1167 * Take a snapshot for a specific fd
1169 * Returns 0 on success, < 0 on error
1171 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1174 assert(stream
->ustream
);
1176 return ustctl_snapshot(stream
->ustream
);
1180 * Get the produced position
1182 * Returns 0 on success, < 0 on error
1184 int lttng_ustconsumer_get_produced_snapshot(
1185 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1188 assert(stream
->ustream
);
1191 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1195 * Called when the stream signal the consumer that it has hang up.
1197 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1200 assert(stream
->ustream
);
1202 ustctl_flush_buffer(stream
->ustream
, 0);
1203 stream
->hangup_flush_done
= 1;
1206 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1209 assert(chan
->uchan
);
1211 if (chan
->switch_timer_enabled
== 1) {
1212 consumer_timer_switch_stop(chan
);
1214 consumer_metadata_cache_destroy(chan
);
1215 ustctl_destroy_channel(chan
->uchan
);
1218 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1221 assert(stream
->ustream
);
1223 if (stream
->chan
->switch_timer_enabled
== 1) {
1224 consumer_timer_switch_stop(stream
->chan
);
1226 ustctl_destroy_stream(stream
->ustream
);
1229 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1230 struct lttng_consumer_local_data
*ctx
)
1232 unsigned long len
, subbuf_size
, padding
;
1236 struct ustctl_consumer_stream
*ustream
;
1239 assert(stream
->ustream
);
1242 DBG2("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1245 /* Ease our life for what's next. */
1246 ustream
= stream
->ustream
;
1248 /* We can consume the 1 byte written into the wait_fd by UST */
1249 if (!stream
->hangup_flush_done
) {
1253 readlen
= read(stream
->wait_fd
, &dummy
, 1);
1254 } while (readlen
== -1 && errno
== EINTR
);
1255 if (readlen
== -1) {
1261 /* Get the next subbuffer */
1262 err
= ustctl_get_next_subbuf(ustream
);
1264 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1266 * This is a debug message even for single-threaded consumer,
1267 * because poll() have more relaxed criterions than get subbuf,
1268 * so get_subbuf may fail for short race windows where poll()
1269 * would issue wakeups.
1271 DBG("Reserving sub buffer failed (everything is normal, "
1272 "it is due to concurrency) [ret: %d]", err
);
1275 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1276 /* Get the full padded subbuffer size */
1277 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1280 /* Get subbuffer data size (without padding) */
1281 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
1284 /* Make sure we don't get a subbuffer size bigger than the padded */
1285 assert(len
>= subbuf_size
);
1287 padding
= len
- subbuf_size
;
1288 /* write the subbuffer to the tracefile */
1289 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
);
1291 * The mmap operation should write subbuf_size amount of data when network
1292 * streaming or the full padding (len) size when we are _not_ streaming.
1294 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1295 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1297 * Display the error but continue processing to try to release the
1298 * subbuffer. This is a DBG statement since any unexpected kill or
1299 * signal, the application gets unregistered, relayd gets closed or
1300 * anything that affects the buffer lifetime will trigger this error.
1301 * So, for the sake of the user, don't print this error since it can
1302 * happen and it is OK with the code flow.
1304 DBG("Error writing to tracefile "
1305 "(ret: %ld != len: %lu != subbuf_size: %lu)",
1306 ret
, len
, subbuf_size
);
1308 err
= ustctl_put_next_subbuf(ustream
);
1316 * Called when a stream is created.
1318 * Return 0 on success or else a negative value.
1320 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
1324 /* Don't create anything if this is set for streaming. */
1325 if (stream
->net_seq_idx
== (uint64_t) -1ULL) {
1326 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
1327 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
1328 stream
->uid
, stream
->gid
);
1332 stream
->out_fd
= ret
;
1333 stream
->tracefile_size_current
= 0;
1342 * Check if data is still being extracted from the buffers for a specific
1343 * stream. Consumer data lock MUST be acquired before calling this function
1344 * and the stream lock.
1346 * Return 1 if the traced data are still getting read else 0 meaning that the
1347 * data is available for trace viewer reading.
1349 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
1354 assert(stream
->ustream
);
1356 DBG("UST consumer checking data pending");
1358 ret
= ustctl_get_next_subbuf(stream
->ustream
);
1360 /* There is still data so let's put back this subbuffer. */
1361 ret
= ustctl_put_subbuf(stream
->ustream
);
1363 ret
= 1; /* Data is pending */
1367 /* Data is NOT pending so ready to be read. */
1375 * Close every metadata stream wait fd of the metadata hash table. This
1376 * function MUST be used very carefully so not to run into a race between the
1377 * metadata thread handling streams and this function closing their wait fd.
1379 * For UST, this is used when the session daemon hangs up. Its the metadata
1380 * producer so calling this is safe because we are assured that no state change
1381 * can occur in the metadata thread for the streams in the hash table.
1383 void lttng_ustconsumer_close_metadata(struct lttng_ht
*metadata_ht
)
1386 struct lttng_ht_iter iter
;
1387 struct lttng_consumer_stream
*stream
;
1389 assert(metadata_ht
);
1390 assert(metadata_ht
->ht
);
1392 DBG("UST consumer closing all metadata streams");
1395 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
1397 int fd
= stream
->wait_fd
;
1400 * Whatever happens here we have to continue to try to close every
1401 * streams. Let's report at least the error on failure.
1403 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1405 ERR("Unable to close metadata stream fd %d ret %d", fd
, ret
);
1407 DBG("Metadata wait fd %d closed", fd
);
1412 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
1416 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1418 ERR("Unable to close wakeup fd");
1422 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
1423 struct lttng_consumer_channel
*channel
)
1425 struct lttcomm_metadata_request_msg request
;
1426 struct lttcomm_consumer_msg msg
;
1427 enum lttng_error_code ret_code
= LTTNG_OK
;
1428 uint64_t len
, key
, offset
;
1432 assert(channel
->metadata_cache
);
1434 /* send the metadata request to sessiond */
1435 switch (consumer_data
.type
) {
1436 case LTTNG_CONSUMER64_UST
:
1437 request
.bits_per_long
= 64;
1439 case LTTNG_CONSUMER32_UST
:
1440 request
.bits_per_long
= 32;
1443 request
.bits_per_long
= 0;
1447 request
.session_id
= channel
->session_id
;
1448 request
.uid
= channel
->uid
;
1449 request
.key
= channel
->key
;
1450 DBG("Sending metadata request to sessiond, session %" PRIu64
,
1451 channel
->session_id
);
1453 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
1456 ERR("Asking metadata to sessiond");
1460 /* Receive the metadata from sessiond */
1461 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
1463 if (ret
!= sizeof(msg
)) {
1464 DBG("Consumer received unexpected message size %d (expects %zu)",
1466 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1468 * The ret value might 0 meaning an orderly shutdown but this is ok
1469 * since the caller handles this.
1474 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
1475 /* No registry found */
1476 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1480 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
1481 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
1486 len
= msg
.u
.push_metadata
.len
;
1487 key
= msg
.u
.push_metadata
.key
;
1488 offset
= msg
.u
.push_metadata
.target_offset
;
1490 assert(key
== channel
->key
);
1492 DBG("No new metadata to receive for key %" PRIu64
, key
);
1495 /* Tell session daemon we are ready to receive the metadata. */
1496 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1498 if (ret
< 0 || len
== 0) {
1500 * Somehow, the session daemon is not responding anymore or there is
1501 * nothing to receive.
1506 ret_code
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
1507 key
, offset
, len
, channel
);
1508 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret_code
);