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>
42 #include "ust-consumer.h"
44 extern struct lttng_consumer_global_data consumer_data
;
45 extern int consumer_poll_timeout
;
46 extern volatile int consumer_quit
;
49 * Free channel object and all streams associated with it. This MUST be used
50 * only and only if the channel has _NEVER_ been added to the global channel
53 static void destroy_channel(struct lttng_consumer_channel
*channel
)
55 struct lttng_consumer_stream
*stream
, *stmp
;
59 DBG("UST consumer cleaning stream list");
61 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
63 cds_list_del(&stream
->send_node
);
64 ustctl_destroy_stream(stream
->ustream
);
69 * If a channel is available meaning that was created before the streams
73 lttng_ustconsumer_del_channel(channel
);
79 * Add channel to internal consumer state.
81 * Returns 0 on success or else a negative value.
83 static int add_channel(struct lttng_consumer_channel
*channel
,
84 struct lttng_consumer_local_data
*ctx
)
91 if (ctx
->on_recv_channel
!= NULL
) {
92 ret
= ctx
->on_recv_channel(channel
);
94 ret
= consumer_add_channel(channel
, ctx
);
96 /* Most likely an ENOMEM. */
97 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
101 ret
= consumer_add_channel(channel
, ctx
);
104 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
111 * Allocate and return a consumer channel object.
113 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
114 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
115 int relayd_id
, uint64_t key
, enum lttng_event_output output
,
116 uint64_t tracefile_size
, uint64_t tracefile_count
)
121 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
, gid
,
122 relayd_id
, output
, tracefile_size
, tracefile_count
);
126 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
127 * error value if applicable is set in it else it is kept untouched.
129 * Return NULL on error else the newly allocated stream object.
131 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
132 struct lttng_consumer_channel
*channel
,
133 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
136 struct lttng_consumer_stream
*stream
= NULL
;
141 stream
= consumer_allocate_stream(channel
->key
,
143 LTTNG_CONSUMER_ACTIVE_STREAM
,
152 if (stream
== NULL
) {
156 * We could not find the channel. Can happen if cpu hotplug
157 * happens while tearing down.
159 DBG3("Could not find channel");
164 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
170 stream
->chan
= channel
;
174 *_alloc_ret
= alloc_ret
;
180 * Send the given stream pointer to the corresponding thread.
182 * Returns 0 on success else a negative value.
184 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
185 struct lttng_consumer_local_data
*ctx
)
187 int ret
, stream_pipe
;
189 /* Get the right pipe where the stream will be sent. */
190 if (stream
->metadata_flag
) {
191 stream_pipe
= ctx
->consumer_metadata_pipe
[1];
193 stream_pipe
= ctx
->consumer_data_pipe
[1];
197 ret
= write(stream_pipe
, &stream
, sizeof(stream
));
198 } while (ret
< 0 && errno
== EINTR
);
200 PERROR("Consumer write %s stream to pipe %d",
201 stream
->metadata_flag
? "metadata" : "data", stream_pipe
);
208 * Search for a relayd object related to the stream. If found, send the stream
211 * On success, returns 0 else a negative value.
213 static int send_stream_to_relayd(struct lttng_consumer_stream
*stream
)
216 struct consumer_relayd_sock_pair
*relayd
;
220 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
221 if (relayd
!= NULL
) {
222 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
223 /* Add stream on the relayd */
224 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
225 stream
->chan
->pathname
, &stream
->relayd_stream_id
);
226 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
230 } else if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
231 ERR("Network sequence index %" PRIu64
" unknown. Not adding stream.",
232 stream
->net_seq_idx
);
242 * Create streams for the given channel using liblttng-ust-ctl.
244 * Return 0 on success else a negative value.
246 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
247 struct lttng_consumer_local_data
*ctx
)
250 struct ustctl_consumer_stream
*ustream
;
251 struct lttng_consumer_stream
*stream
;
257 * While a stream is available from ustctl. When NULL is returned, we've
258 * reached the end of the possible stream for the channel.
260 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
263 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
265 /* Allocate consumer stream object. */
266 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
270 stream
->ustream
= ustream
;
272 * Store it so we can save multiple function calls afterwards since
273 * this value is used heavily in the stream threads. This is UST
274 * specific so this is why it's done after allocation.
276 stream
->wait_fd
= wait_fd
;
279 * Order is important this is why a list is used. On error, the caller
280 * should clean this list.
282 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
284 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
285 &stream
->max_sb_size
);
287 ERR("ustctl_get_max_subbuf_size failed for stream %s",
292 /* Do actions once stream has been received. */
293 if (ctx
->on_recv_stream
) {
294 ret
= ctx
->on_recv_stream(stream
);
300 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
301 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
303 /* Set next CPU stream. */
304 channel
->streams
.count
= ++cpu
;
306 /* Keep stream reference when creating metadata. */
307 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
308 channel
->metadata_stream
= stream
;
320 * Create an UST channel with the given attributes and send it to the session
321 * daemon using the ust ctl API.
323 * Return 0 on success or else a negative value.
325 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
326 struct ustctl_consumer_channel
**chanp
)
329 struct ustctl_consumer_channel
*channel
;
334 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
335 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
336 "switch_timer_interval: %u, read_timer_interval: %u, "
337 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
338 attr
->num_subbuf
, attr
->switch_timer_interval
,
339 attr
->read_timer_interval
, attr
->output
, attr
->type
);
341 channel
= ustctl_create_channel(attr
);
356 * Send a single given stream to the session daemon using the sock.
358 * Return 0 on success else a negative value.
360 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
367 DBG2("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
369 /* Send stream to session daemon. */
370 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
380 * Send channel to sessiond.
382 * Return 0 on success or else a negative value.
384 static int send_sessiond_channel(int sock
,
385 struct lttng_consumer_channel
*channel
,
386 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
389 struct lttng_consumer_stream
*stream
;
395 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
397 /* Send channel to sessiond. */
398 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
403 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
408 /* The channel was sent successfully to the sessiond at this point. */
409 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
410 /* Try to send the stream to the relayd if one is available. */
411 ret
= send_stream_to_relayd(stream
);
414 * Flag that the relayd was the problem here probably due to a
415 * communicaton error on the socket.
423 /* Send stream to session daemon. */
424 ret
= send_sessiond_stream(sock
, stream
);
430 /* Tell sessiond there is no more stream. */
431 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
436 DBG("UST consumer NULL stream sent to sessiond");
445 * Creates a channel and streams and add the channel it to the channel internal
446 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
449 * Return 0 on success or else, a negative value is returned and the channel
450 * MUST be destroyed by consumer_del_channel().
452 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
453 struct lttng_consumer_channel
*channel
,
454 struct ustctl_consumer_channel_attr
*attr
)
463 * This value is still used by the kernel consumer since for the kernel,
464 * the stream ownership is not IN the consumer so we need to have the
465 * number of left stream that needs to be initialized so we can know when
466 * to delete the channel (see consumer.c).
468 * As for the user space tracer now, the consumer creates and sends the
469 * stream to the session daemon which only sends them to the application
470 * once every stream of a channel is received making this value useless
471 * because we they will be added to the poll thread before the application
472 * receives them. This ensures that a stream can not hang up during
473 * initilization of a channel.
475 channel
->nb_init_stream_left
= 0;
477 /* The reply msg status is handled in the following call. */
478 ret
= create_ust_channel(attr
, &channel
->uchan
);
483 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
489 /* Open all streams for this channel. */
490 ret
= create_ust_streams(channel
, ctx
);
500 * Send all stream of a channel to the right thread handling it.
502 * On error, return a negative value else 0 on success.
504 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
505 struct lttng_consumer_local_data
*ctx
)
508 struct lttng_consumer_stream
*stream
, *stmp
;
513 /* Send streams to the corresponding thread. */
514 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
516 /* Sending the stream to the thread. */
517 ret
= send_stream_to_thread(stream
, ctx
);
520 * If we are unable to send the stream to the thread, there is
521 * a big problem so just stop everything.
526 /* Remove node from the channel stream list. */
527 cds_list_del(&stream
->send_node
);
535 * Write metadata to the given channel using ustctl to convert the string to
537 * Called only from consumer_metadata_cache_write.
538 * The metadata cache lock MUST be acquired to write in the cache.
540 * Return 0 on success else a negative value.
542 int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel
*metadata
,
543 const char *metadata_str
, uint64_t target_offset
, uint64_t len
)
548 assert(metadata_str
);
550 DBG("UST consumer writing metadata to channel %s", metadata
->name
);
552 assert(target_offset
<= metadata
->metadata_cache
->max_offset
);
553 ret
= ustctl_write_metadata_to_channel(metadata
->uchan
,
554 metadata_str
+ target_offset
, len
);
556 ERR("ustctl write metadata fail with ret %d, len %ld", ret
, len
);
560 ustctl_flush_buffer(metadata
->metadata_stream
->ustream
, 1);
567 * Flush channel's streams using the given key to retrieve the channel.
569 * Return 0 on success else an LTTng error code.
571 static int flush_channel(uint64_t chan_key
)
574 struct lttng_consumer_channel
*channel
;
575 struct lttng_consumer_stream
*stream
;
577 struct lttng_ht_iter iter
;
579 DBG("UST consumer flush channel key %lu", chan_key
);
581 channel
= consumer_find_channel(chan_key
);
583 ERR("UST consumer flush channel %lu not found", chan_key
);
584 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
588 ht
= consumer_data
.stream_per_chan_id_ht
;
590 /* For each stream of the channel id, flush it. */
592 cds_lfht_for_each_entry_duplicate(ht
->ht
,
593 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
594 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
595 ustctl_flush_buffer(stream
->ustream
, 1);
604 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
606 * Return 0 on success else an LTTng error code.
608 static int close_metadata(uint64_t chan_key
)
611 struct lttng_consumer_channel
*channel
;
613 DBG("UST consumer close metadata key %lu", chan_key
);
615 channel
= consumer_find_channel(chan_key
);
617 ERR("UST consumer close metadata %lu not found", chan_key
);
618 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
622 ret
= ustctl_stream_close_wakeup_fd(channel
->metadata_stream
->ustream
);
624 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret
);
625 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
628 if (channel
->switch_timer_enabled
== 1) {
629 DBG("Deleting timer on metadata channel");
630 consumer_timer_switch_stop(channel
);
632 consumer_metadata_cache_destroy(channel
);
639 * RCU read side lock MUST be acquired before calling this function.
641 * Return 0 on success else an LTTng error code.
643 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
646 struct lttng_consumer_channel
*metadata
;
648 DBG("UST consumer setup metadata key %lu", key
);
650 metadata
= consumer_find_channel(key
);
652 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
653 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
658 * Send metadata stream to relayd if one available. Availability is
659 * known if the stream is still in the list of the channel.
661 if (cds_list_empty(&metadata
->streams
.head
)) {
662 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
663 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
667 /* Send metadata stream to relayd if needed. */
668 ret
= send_stream_to_relayd(metadata
->metadata_stream
);
670 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
674 ret
= send_streams_to_thread(metadata
, ctx
);
677 * If we are unable to send the stream to the thread, there is
678 * a big problem so just stop everything.
680 ret
= LTTCOMM_CONSUMERD_FATAL
;
683 /* List MUST be empty after or else it could be reused. */
684 assert(cds_list_empty(&metadata
->streams
.head
));
693 * Receive the metadata updates from the sessiond.
695 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
696 uint64_t len
, struct lttng_consumer_channel
*channel
)
698 int ret
, ret_code
= LTTNG_OK
;
701 DBG("UST consumer push metadata key %lu of len %lu", key
, len
);
703 metadata_str
= zmalloc(len
* sizeof(char));
705 PERROR("zmalloc metadata string");
706 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
710 /* Receive metadata string. */
711 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
713 /* Session daemon is dead so return gracefully. */
718 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
719 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
721 /* Unable to handle metadata. Notify session daemon. */
722 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
724 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
726 while (consumer_metadata_cache_flushed(channel
, offset
+ len
)) {
727 DBG("Waiting for metadata to be flushed");
728 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
738 * Receive command from session daemon and process it.
740 * Return 1 on success else a negative value or 0.
742 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
743 int sock
, struct pollfd
*consumer_sockpoll
)
746 enum lttng_error_code ret_code
= LTTNG_OK
;
747 struct lttcomm_consumer_msg msg
;
748 struct lttng_consumer_channel
*channel
= NULL
;
750 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
751 if (ret
!= sizeof(msg
)) {
752 DBG("Consumer received unexpected message size %zd (expects %zu)",
754 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
756 * The ret value might 0 meaning an orderly shutdown but this is ok
757 * since the caller handles this.
761 if (msg
.cmd_type
== LTTNG_CONSUMER_STOP
) {
763 * Notify the session daemon that the command is completed.
765 * On transport layer error, the function call will print an error
766 * message so handling the returned code is a bit useless since we
767 * return an error code anyway.
769 (void) consumer_send_status_msg(sock
, ret_code
);
773 /* relayd needs RCU read-side lock */
776 switch (msg
.cmd_type
) {
777 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
779 /* Session daemon status message are handled in the following call. */
780 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
781 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
782 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
);
785 case LTTNG_CONSUMER_DESTROY_RELAYD
:
787 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
788 struct consumer_relayd_sock_pair
*relayd
;
790 DBG("UST consumer destroying relayd %" PRIu64
, index
);
792 /* Get relayd reference if exists. */
793 relayd
= consumer_find_relayd(index
);
794 if (relayd
== NULL
) {
795 DBG("Unable to find relayd %" PRIu64
, index
);
796 ret_code
= LTTNG_ERR_NO_CONSUMER
;
800 * Each relayd socket pair has a refcount of stream attached to it
801 * which tells if the relayd is still active or not depending on the
804 * This will set the destroy flag of the relayd object and destroy it
805 * if the refcount reaches zero when called.
807 * The destroy can happen either here or when a stream fd hangs up.
810 consumer_flag_relayd_for_destroy(relayd
);
813 goto end_msg_sessiond
;
815 case LTTNG_CONSUMER_UPDATE_STREAM
:
820 case LTTNG_CONSUMER_DATA_PENDING
:
822 int ret
, is_data_pending
;
823 uint64_t id
= msg
.u
.data_pending
.session_id
;
825 DBG("UST consumer data pending command for id %" PRIu64
, id
);
827 is_data_pending
= consumer_data_pending(id
);
829 /* Send back returned value to session daemon */
830 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
831 sizeof(is_data_pending
));
833 DBG("Error when sending the data pending ret code: %d", ret
);
837 * No need to send back a status message since the data pending
838 * returned value is the response.
842 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
845 struct ustctl_consumer_channel_attr attr
;
847 /* Create a plain object and reserve a channel key. */
848 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
849 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
850 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
851 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
852 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
853 msg
.u
.ask_channel
.tracefile_size
,
854 msg
.u
.ask_channel
.tracefile_count
);
856 goto end_channel_error
;
859 /* Build channel attributes from received message. */
860 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
861 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
862 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
863 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
864 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
865 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
866 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
868 /* Translate the event output type to UST. */
869 switch (channel
->output
) {
870 case LTTNG_EVENT_SPLICE
:
871 /* Splice not supported so fallback on mmap(). */
872 case LTTNG_EVENT_MMAP
:
874 attr
.output
= CONSUMER_CHANNEL_MMAP
;
878 /* Translate and save channel type. */
879 switch (msg
.u
.ask_channel
.type
) {
880 case LTTNG_UST_CHAN_PER_CPU
:
881 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
882 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
884 case LTTNG_UST_CHAN_METADATA
:
885 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
886 attr
.type
= LTTNG_UST_CHAN_METADATA
;
893 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
895 goto end_channel_error
;
899 * Add the channel to the internal state AFTER all streams were created
900 * and successfully sent to session daemon. This way, all streams must
901 * be ready before this channel is visible to the threads.
903 ret
= add_channel(channel
, ctx
);
905 goto end_channel_error
;
910 * Channel and streams are now created. Inform the session daemon that
911 * everything went well and should wait to receive the channel and
912 * streams with ustctl API.
914 ret
= consumer_send_status_channel(sock
, channel
);
917 * There is probably a problem on the socket so the poll will get
918 * it and clean everything up.
923 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
924 ret
= consumer_metadata_cache_allocate(channel
);
926 ERR("Allocating metadata cache");
927 goto end_channel_error
;
929 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
930 attr
.switch_timer_interval
= 0;
935 case LTTNG_CONSUMER_GET_CHANNEL
:
937 int ret
, relayd_err
= 0;
938 uint64_t key
= msg
.u
.get_channel
.key
;
939 struct lttng_consumer_channel
*channel
;
941 channel
= consumer_find_channel(key
);
943 ERR("UST consumer get channel key %lu not found", key
);
944 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
945 goto end_msg_sessiond
;
948 /* Inform sessiond that we are about to send channel and streams. */
949 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
951 /* Somehow, the session daemon is not responding anymore. */
955 /* Send everything to sessiond. */
956 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
960 * We were unable to send to the relayd the stream so avoid
961 * sending back a fatal error to the thread since this is OK
962 * and the consumer can continue its work.
964 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
965 goto end_msg_sessiond
;
968 * The communicaton was broken hence there is a bad state between
969 * the consumer and sessiond so stop everything.
974 ret
= send_streams_to_thread(channel
, ctx
);
977 * If we are unable to send the stream to the thread, there is
978 * a big problem so just stop everything.
982 /* List MUST be empty after or else it could be reused. */
983 assert(cds_list_empty(&channel
->streams
.head
));
985 goto end_msg_sessiond
;
987 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
989 uint64_t key
= msg
.u
.destroy_channel
.key
;
990 struct lttng_consumer_channel
*channel
;
992 channel
= consumer_find_channel(key
);
994 ERR("UST consumer get channel key %lu not found", key
);
995 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
996 goto end_msg_sessiond
;
999 destroy_channel(channel
);
1001 goto end_msg_sessiond
;
1003 case LTTNG_CONSUMER_CLOSE_METADATA
:
1007 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1012 goto end_msg_sessiond
;
1014 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1018 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1023 goto end_msg_sessiond
;
1025 case LTTNG_CONSUMER_PUSH_METADATA
:
1028 uint64_t len
= msg
.u
.push_metadata
.len
;
1029 uint64_t key
= msg
.u
.push_metadata
.key
;
1030 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1031 struct lttng_consumer_channel
*channel
;
1033 DBG("UST consumer push metadata key %lu of len %lu", key
, len
);
1035 channel
= consumer_find_channel(key
);
1037 ERR("UST consumer push metadata %lu not found", key
);
1038 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1041 /* Tell session daemon we are ready to receive the metadata. */
1042 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
1044 /* Somehow, the session daemon is not responding anymore. */
1048 /* Wait for more data. */
1049 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
1053 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1056 /* error receiving from sessiond */
1060 goto end_msg_sessiond
;
1063 case LTTNG_CONSUMER_SETUP_METADATA
:
1067 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1071 goto end_msg_sessiond
;
1081 * Return 1 to indicate success since the 0 value can be a socket
1082 * shutdown during the recv() or send() call.
1088 * The returned value here is not useful since either way we'll return 1 to
1089 * the caller because the session daemon socket management is done
1090 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1092 (void) consumer_send_status_msg(sock
, ret_code
);
1098 * Free channel here since no one has a reference to it. We don't
1099 * free after that because a stream can store this pointer.
1101 destroy_channel(channel
);
1103 /* We have to send a status channel message indicating an error. */
1104 ret
= consumer_send_status_channel(sock
, NULL
);
1106 /* Stop everything if session daemon can not be notified. */
1113 /* This will issue a consumer stop. */
1118 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1119 * compiled out, we isolate it in this library.
1121 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1125 assert(stream
->ustream
);
1127 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1131 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1132 * compiled out, we isolate it in this library.
1134 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1137 assert(stream
->ustream
);
1139 return ustctl_get_mmap_base(stream
->ustream
);
1143 * Take a snapshot for a specific fd
1145 * Returns 0 on success, < 0 on error
1147 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1150 assert(stream
->ustream
);
1152 return ustctl_snapshot(stream
->ustream
);
1156 * Get the produced position
1158 * Returns 0 on success, < 0 on error
1160 int lttng_ustconsumer_get_produced_snapshot(
1161 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1164 assert(stream
->ustream
);
1167 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1171 * Called when the stream signal the consumer that it has hang up.
1173 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1176 assert(stream
->ustream
);
1178 ustctl_flush_buffer(stream
->ustream
, 0);
1179 stream
->hangup_flush_done
= 1;
1182 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1185 assert(chan
->uchan
);
1187 ustctl_destroy_channel(chan
->uchan
);
1190 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1193 assert(stream
->ustream
);
1195 ustctl_destroy_stream(stream
->ustream
);
1198 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1199 struct lttng_consumer_local_data
*ctx
)
1201 unsigned long len
, subbuf_size
, padding
;
1205 struct ustctl_consumer_stream
*ustream
;
1208 assert(stream
->ustream
);
1211 DBG2("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1214 /* Ease our life for what's next. */
1215 ustream
= stream
->ustream
;
1217 /* We can consume the 1 byte written into the wait_fd by UST */
1218 if (!stream
->hangup_flush_done
) {
1222 readlen
= read(stream
->wait_fd
, &dummy
, 1);
1223 } while (readlen
== -1 && errno
== EINTR
);
1224 if (readlen
== -1) {
1230 /* Get the next subbuffer */
1231 err
= ustctl_get_next_subbuf(ustream
);
1233 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1235 * This is a debug message even for single-threaded consumer,
1236 * because poll() have more relaxed criterions than get subbuf,
1237 * so get_subbuf may fail for short race windows where poll()
1238 * would issue wakeups.
1240 DBG("Reserving sub buffer failed (everything is normal, "
1241 "it is due to concurrency) [ret: %d]", err
);
1244 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1245 /* Get the full padded subbuffer size */
1246 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1249 /* Get subbuffer data size (without padding) */
1250 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
1253 /* Make sure we don't get a subbuffer size bigger than the padded */
1254 assert(len
>= subbuf_size
);
1256 padding
= len
- subbuf_size
;
1257 /* write the subbuffer to the tracefile */
1258 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
);
1260 * The mmap operation should write subbuf_size amount of data when network
1261 * streaming or the full padding (len) size when we are _not_ streaming.
1263 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1264 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1266 * Display the error but continue processing to try to release the
1267 * subbuffer. This is a DBG statement since any unexpected kill or
1268 * signal, the application gets unregistered, relayd gets closed or
1269 * anything that affects the buffer lifetime will trigger this error.
1270 * So, for the sake of the user, don't print this error since it can
1271 * happen and it is OK with the code flow.
1273 DBG("Error writing to tracefile "
1274 "(ret: %zd != len: %lu != subbuf_size: %lu)",
1275 ret
, len
, subbuf_size
);
1277 err
= ustctl_put_next_subbuf(ustream
);
1285 * Called when a stream is created.
1287 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
1289 return lttng_create_output_file(stream
);
1293 * Check if data is still being extracted from the buffers for a specific
1294 * stream. Consumer data lock MUST be acquired before calling this function
1295 * and the stream lock.
1297 * Return 1 if the traced data are still getting read else 0 meaning that the
1298 * data is available for trace viewer reading.
1300 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
1305 assert(stream
->ustream
);
1307 DBG("UST consumer checking data pending");
1309 ret
= ustctl_get_next_subbuf(stream
->ustream
);
1311 /* There is still data so let's put back this subbuffer. */
1312 ret
= ustctl_put_subbuf(stream
->ustream
);
1314 ret
= 1; /* Data is pending */
1318 /* Data is NOT pending so ready to be read. */
1326 * Close every metadata stream wait fd of the metadata hash table. This
1327 * function MUST be used very carefully so not to run into a race between the
1328 * metadata thread handling streams and this function closing their wait fd.
1330 * For UST, this is used when the session daemon hangs up. Its the metadata
1331 * producer so calling this is safe because we are assured that no state change
1332 * can occur in the metadata thread for the streams in the hash table.
1334 void lttng_ustconsumer_close_metadata(struct lttng_ht
*metadata_ht
)
1337 struct lttng_ht_iter iter
;
1338 struct lttng_consumer_stream
*stream
;
1340 assert(metadata_ht
);
1341 assert(metadata_ht
->ht
);
1343 DBG("UST consumer closing all metadata streams");
1346 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
1348 int fd
= stream
->wait_fd
;
1351 * Whatever happens here we have to continue to try to close every
1352 * streams. Let's report at least the error on failure.
1354 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1356 ERR("Unable to close metadata stream fd %d ret %d", fd
, ret
);
1358 DBG("Metadata wait fd %d closed", fd
);
1363 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
1367 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1369 ERR("Unable to close wakeup fd");
1373 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
1374 struct lttng_consumer_channel
*channel
)
1376 struct lttcomm_metadata_request_msg request
;
1377 struct lttcomm_consumer_msg msg
;
1378 enum lttng_error_code ret_code
= LTTNG_OK
;
1379 uint64_t len
, key
, offset
;
1383 assert(channel
->metadata_cache
);
1385 /* send the metadata request to sessiond */
1386 switch (consumer_data
.type
) {
1387 case LTTNG_CONSUMER64_UST
:
1388 request
.bits_per_long
= 64;
1390 case LTTNG_CONSUMER32_UST
:
1391 request
.bits_per_long
= 32;
1394 request
.bits_per_long
= 0;
1398 request
.session_id
= channel
->session_id
;
1399 request
.uid
= channel
->uid
;
1400 request
.key
= channel
->key
;
1401 DBG("Sending metadata request to sessiond, session %" PRIu64
,
1402 channel
->session_id
);
1404 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
1407 ERR("Asking metadata to sessiond");
1411 /* Receive the metadata from sessiond */
1412 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
1414 if (ret
!= sizeof(msg
)) {
1415 DBG("Consumer received unexpected message size %d (expects %lu)",
1417 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1419 * The ret value might 0 meaning an orderly shutdown but this is ok
1420 * since the caller handles this.
1425 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
1426 /* No registry found */
1427 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1431 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
1432 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
1437 len
= msg
.u
.push_metadata
.len
;
1438 key
= msg
.u
.push_metadata
.key
;
1439 offset
= msg
.u
.push_metadata
.target_offset
;
1441 assert(key
== channel
->key
);
1443 DBG("No new metadata to receive for key %" PRIu64
, key
);
1446 /* Tell session daemon we are ready to receive the metadata. */
1447 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1449 if (ret
< 0 || len
== 0) {
1451 * Somehow, the session daemon is not responding anymore or there is
1452 * nothing to receive.
1457 ret_code
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
1458 key
, offset
, len
, channel
);
1459 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret_code
);