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 <bin/lttng-consumerd/health-consumerd.h>
36 #include <common/common.h>
37 #include <common/sessiond-comm/sessiond-comm.h>
38 #include <common/relayd/relayd.h>
39 #include <common/compat/fcntl.h>
40 #include <common/compat/endian.h>
41 #include <common/consumer-metadata-cache.h>
42 #include <common/consumer-stream.h>
43 #include <common/consumer-timer.h>
44 #include <common/utils.h>
45 #include <common/index/index.h>
47 #include "ust-consumer.h"
49 extern struct lttng_consumer_global_data consumer_data
;
50 extern int consumer_poll_timeout
;
51 extern volatile int consumer_quit
;
54 * Free channel object and all streams associated with it. This MUST be used
55 * only and only if the channel has _NEVER_ been added to the global channel
58 static void destroy_channel(struct lttng_consumer_channel
*channel
)
60 struct lttng_consumer_stream
*stream
, *stmp
;
64 DBG("UST consumer cleaning stream list");
66 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
71 cds_list_del(&stream
->send_node
);
72 ustctl_destroy_stream(stream
->ustream
);
77 * If a channel is available meaning that was created before the streams
81 lttng_ustconsumer_del_channel(channel
);
87 * Add channel to internal consumer state.
89 * Returns 0 on success or else a negative value.
91 static int add_channel(struct lttng_consumer_channel
*channel
,
92 struct lttng_consumer_local_data
*ctx
)
99 if (ctx
->on_recv_channel
!= NULL
) {
100 ret
= ctx
->on_recv_channel(channel
);
102 ret
= consumer_add_channel(channel
, ctx
);
103 } else if (ret
< 0) {
104 /* Most likely an ENOMEM. */
105 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
109 ret
= consumer_add_channel(channel
, ctx
);
112 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
119 * Allocate and return a consumer channel object.
121 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
122 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
123 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
124 uint64_t tracefile_size
, uint64_t tracefile_count
,
125 uint64_t session_id_per_pid
, unsigned int monitor
,
126 unsigned int live_timer_interval
)
131 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
132 gid
, relayd_id
, output
, tracefile_size
,
133 tracefile_count
, session_id_per_pid
, monitor
, live_timer_interval
);
137 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
138 * error value if applicable is set in it else it is kept untouched.
140 * Return NULL on error else the newly allocated stream object.
142 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
143 struct lttng_consumer_channel
*channel
,
144 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
147 struct lttng_consumer_stream
*stream
= NULL
;
152 stream
= consumer_allocate_stream(channel
->key
,
154 LTTNG_CONSUMER_ACTIVE_STREAM
,
164 if (stream
== NULL
) {
168 * We could not find the channel. Can happen if cpu hotplug
169 * happens while tearing down.
171 DBG3("Could not find channel");
176 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
182 stream
->chan
= channel
;
186 *_alloc_ret
= alloc_ret
;
192 * Send the given stream pointer to the corresponding thread.
194 * Returns 0 on success else a negative value.
196 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
197 struct lttng_consumer_local_data
*ctx
)
200 struct lttng_pipe
*stream_pipe
;
202 /* Get the right pipe where the stream will be sent. */
203 if (stream
->metadata_flag
) {
204 ret
= consumer_add_metadata_stream(stream
);
206 ERR("Consumer add metadata stream %" PRIu64
" failed.",
210 stream_pipe
= ctx
->consumer_metadata_pipe
;
212 ret
= consumer_add_data_stream(stream
);
214 ERR("Consumer add stream %" PRIu64
" failed.",
218 stream_pipe
= ctx
->consumer_data_pipe
;
222 * From this point on, the stream's ownership has been moved away from
223 * the channel and becomes globally visible.
225 stream
->globally_visible
= 1;
227 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
229 ERR("Consumer write %s stream to pipe %d",
230 stream
->metadata_flag
? "metadata" : "data",
231 lttng_pipe_get_writefd(stream_pipe
));
232 if (stream
->metadata_flag
) {
233 consumer_del_stream_for_metadata(stream
);
235 consumer_del_stream_for_data(stream
);
243 * Create streams for the given channel using liblttng-ust-ctl.
245 * Return 0 on success else a negative value.
247 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
248 struct lttng_consumer_local_data
*ctx
)
251 struct ustctl_consumer_stream
*ustream
;
252 struct lttng_consumer_stream
*stream
;
258 * While a stream is available from ustctl. When NULL is returned, we've
259 * reached the end of the possible stream for the channel.
261 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
263 int ust_metadata_pipe
[2];
265 health_code_update();
267 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
268 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
270 ERR("Create ust metadata poll pipe");
273 wait_fd
= ust_metadata_pipe
[0];
275 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
278 /* Allocate consumer stream object. */
279 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
283 stream
->ustream
= ustream
;
285 * Store it so we can save multiple function calls afterwards since
286 * this value is used heavily in the stream threads. This is UST
287 * specific so this is why it's done after allocation.
289 stream
->wait_fd
= wait_fd
;
292 * Increment channel refcount since the channel reference has now been
293 * assigned in the allocation process above.
295 if (stream
->chan
->monitor
) {
296 uatomic_inc(&stream
->chan
->refcount
);
300 * Order is important this is why a list is used. On error, the caller
301 * should clean this list.
303 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
305 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
306 &stream
->max_sb_size
);
308 ERR("ustctl_get_max_subbuf_size failed for stream %s",
313 /* Do actions once stream has been received. */
314 if (ctx
->on_recv_stream
) {
315 ret
= ctx
->on_recv_stream(stream
);
321 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
322 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
324 /* Set next CPU stream. */
325 channel
->streams
.count
= ++cpu
;
327 /* Keep stream reference when creating metadata. */
328 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
329 channel
->metadata_stream
= stream
;
330 stream
->ust_metadata_poll_pipe
[0] = ust_metadata_pipe
[0];
331 stream
->ust_metadata_poll_pipe
[1] = ust_metadata_pipe
[1];
343 * Create an UST channel with the given attributes and send it to the session
344 * daemon using the ust ctl API.
346 * Return 0 on success or else a negative value.
348 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
349 struct ustctl_consumer_channel
**chanp
)
352 struct ustctl_consumer_channel
*channel
;
357 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
358 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
359 "switch_timer_interval: %u, read_timer_interval: %u, "
360 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
361 attr
->num_subbuf
, attr
->switch_timer_interval
,
362 attr
->read_timer_interval
, attr
->output
, attr
->type
);
364 channel
= ustctl_create_channel(attr
);
379 * Send a single given stream to the session daemon using the sock.
381 * Return 0 on success else a negative value.
383 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
390 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
392 /* Send stream to session daemon. */
393 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
403 * Send channel to sessiond.
405 * Return 0 on success or else a negative value.
407 static int send_sessiond_channel(int sock
,
408 struct lttng_consumer_channel
*channel
,
409 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
411 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
412 struct lttng_consumer_stream
*stream
;
413 uint64_t net_seq_idx
= -1ULL;
419 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
421 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
422 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
424 health_code_update();
426 /* Try to send the stream to the relayd if one is available. */
427 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
430 * Flag that the relayd was the problem here probably due to a
431 * communicaton error on the socket.
436 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
438 if (net_seq_idx
== -1ULL) {
439 net_seq_idx
= stream
->net_seq_idx
;
444 /* Inform sessiond that we are about to send channel and streams. */
445 ret
= consumer_send_status_msg(sock
, ret_code
);
446 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
448 * Either the session daemon is not responding or the relayd died so we
454 /* Send channel to sessiond. */
455 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
460 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
465 /* The channel was sent successfully to the sessiond at this point. */
466 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
468 health_code_update();
470 /* Send stream to session daemon. */
471 ret
= send_sessiond_stream(sock
, stream
);
477 /* Tell sessiond there is no more stream. */
478 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
483 DBG("UST consumer NULL stream sent to sessiond");
488 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
495 * Creates a channel and streams and add the channel it to the channel internal
496 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
499 * Return 0 on success or else, a negative value is returned and the channel
500 * MUST be destroyed by consumer_del_channel().
502 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
503 struct lttng_consumer_channel
*channel
,
504 struct ustctl_consumer_channel_attr
*attr
)
513 * This value is still used by the kernel consumer since for the kernel,
514 * the stream ownership is not IN the consumer so we need to have the
515 * number of left stream that needs to be initialized so we can know when
516 * to delete the channel (see consumer.c).
518 * As for the user space tracer now, the consumer creates and sends the
519 * stream to the session daemon which only sends them to the application
520 * once every stream of a channel is received making this value useless
521 * because we they will be added to the poll thread before the application
522 * receives them. This ensures that a stream can not hang up during
523 * initilization of a channel.
525 channel
->nb_init_stream_left
= 0;
527 /* The reply msg status is handled in the following call. */
528 ret
= create_ust_channel(attr
, &channel
->uchan
);
533 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
536 * For the snapshots (no monitor), we create the metadata streams
537 * on demand, not during the channel creation.
539 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
544 /* Open all streams for this channel. */
545 ret
= create_ust_streams(channel
, ctx
);
555 * Send all stream of a channel to the right thread handling it.
557 * On error, return a negative value else 0 on success.
559 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
560 struct lttng_consumer_local_data
*ctx
)
563 struct lttng_consumer_stream
*stream
, *stmp
;
568 /* Send streams to the corresponding thread. */
569 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
572 health_code_update();
574 /* Sending the stream to the thread. */
575 ret
= send_stream_to_thread(stream
, ctx
);
578 * If we are unable to send the stream to the thread, there is
579 * a big problem so just stop everything.
581 /* Remove node from the channel stream list. */
582 cds_list_del(&stream
->send_node
);
586 /* Remove node from the channel stream list. */
587 cds_list_del(&stream
->send_node
);
596 * Flush channel's streams using the given key to retrieve the channel.
598 * Return 0 on success else an LTTng error code.
600 static int flush_channel(uint64_t chan_key
)
603 struct lttng_consumer_channel
*channel
;
604 struct lttng_consumer_stream
*stream
;
606 struct lttng_ht_iter iter
;
608 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
611 channel
= consumer_find_channel(chan_key
);
613 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
614 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
618 ht
= consumer_data
.stream_per_chan_id_ht
;
620 /* For each stream of the channel id, flush it. */
621 cds_lfht_for_each_entry_duplicate(ht
->ht
,
622 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
623 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
625 health_code_update();
627 ustctl_flush_buffer(stream
->ustream
, 1);
635 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
636 * RCU read side lock MUST be acquired before calling this function.
638 * Return 0 on success else an LTTng error code.
640 static int close_metadata(uint64_t chan_key
)
643 struct lttng_consumer_channel
*channel
;
645 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
647 channel
= consumer_find_channel(chan_key
);
650 * This is possible if the metadata thread has issue a delete because
651 * the endpoint point of the stream hung up. There is no way the
652 * session daemon can know about it thus use a DBG instead of an actual
655 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
656 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
660 pthread_mutex_lock(&consumer_data
.lock
);
661 pthread_mutex_lock(&channel
->lock
);
663 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
667 lttng_ustconsumer_close_metadata(channel
);
670 pthread_mutex_unlock(&channel
->lock
);
671 pthread_mutex_unlock(&consumer_data
.lock
);
677 * RCU read side lock MUST be acquired before calling this function.
679 * Return 0 on success else an LTTng error code.
681 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
684 struct lttng_consumer_channel
*metadata
;
686 DBG("UST consumer setup metadata key %" PRIu64
, key
);
688 metadata
= consumer_find_channel(key
);
690 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
691 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
696 * In no monitor mode, the metadata channel has no stream(s) so skip the
697 * ownership transfer to the metadata thread.
699 if (!metadata
->monitor
) {
700 DBG("Metadata channel in no monitor");
706 * Send metadata stream to relayd if one available. Availability is
707 * known if the stream is still in the list of the channel.
709 if (cds_list_empty(&metadata
->streams
.head
)) {
710 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
711 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
712 goto error_no_stream
;
715 /* Send metadata stream to relayd if needed. */
716 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
717 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
720 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
723 ret
= consumer_send_relayd_streams_sent(
724 metadata
->metadata_stream
->net_seq_idx
);
726 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
731 ret
= send_streams_to_thread(metadata
, ctx
);
734 * If we are unable to send the stream to the thread, there is
735 * a big problem so just stop everything.
737 ret
= LTTCOMM_CONSUMERD_FATAL
;
740 /* List MUST be empty after or else it could be reused. */
741 assert(cds_list_empty(&metadata
->streams
.head
));
748 * Delete metadata channel on error. At this point, the metadata stream can
749 * NOT be monitored by the metadata thread thus having the guarantee that
750 * the stream is still in the local stream list of the channel. This call
751 * will make sure to clean that list.
753 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
754 cds_list_del(&metadata
->metadata_stream
->send_node
);
755 metadata
->metadata_stream
= NULL
;
762 * Snapshot the whole metadata.
764 * Returns 0 on success, < 0 on error
766 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
767 struct lttng_consumer_local_data
*ctx
)
770 struct lttng_consumer_channel
*metadata_channel
;
771 struct lttng_consumer_stream
*metadata_stream
;
776 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
781 metadata_channel
= consumer_find_channel(key
);
782 if (!metadata_channel
) {
783 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
788 assert(!metadata_channel
->monitor
);
790 health_code_update();
793 * Ask the sessiond if we have new metadata waiting and update the
794 * consumer metadata cache.
796 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
801 health_code_update();
804 * The metadata stream is NOT created in no monitor mode when the channel
805 * is created on a sessiond ask channel command.
807 ret
= create_ust_streams(metadata_channel
, ctx
);
812 metadata_stream
= metadata_channel
->metadata_stream
;
813 assert(metadata_stream
);
815 if (relayd_id
!= (uint64_t) -1ULL) {
816 metadata_stream
->net_seq_idx
= relayd_id
;
817 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
822 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
823 metadata_stream
->chan
->tracefile_size
,
824 metadata_stream
->tracefile_count_current
,
825 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
829 metadata_stream
->out_fd
= ret
;
830 metadata_stream
->tracefile_size_current
= 0;
834 health_code_update();
836 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
844 * Clean up the stream completly because the next snapshot will use a new
847 consumer_stream_destroy(metadata_stream
, NULL
);
848 cds_list_del(&metadata_stream
->send_node
);
849 metadata_channel
->metadata_stream
= NULL
;
857 * Take a snapshot of all the stream of a channel.
859 * Returns 0 on success, < 0 on error
861 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
862 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
865 unsigned use_relayd
= 0;
866 unsigned long consumed_pos
, produced_pos
;
867 struct lttng_consumer_channel
*channel
;
868 struct lttng_consumer_stream
*stream
;
875 if (relayd_id
!= (uint64_t) -1ULL) {
879 channel
= consumer_find_channel(key
);
881 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
885 assert(!channel
->monitor
);
886 DBG("UST consumer snapshot channel %" PRIu64
, key
);
888 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
890 health_code_update();
892 /* Lock stream because we are about to change its state. */
893 pthread_mutex_lock(&stream
->lock
);
894 stream
->net_seq_idx
= relayd_id
;
897 ret
= consumer_send_relayd_stream(stream
, path
);
902 ret
= utils_create_stream_file(path
, stream
->name
,
903 stream
->chan
->tracefile_size
,
904 stream
->tracefile_count_current
,
905 stream
->uid
, stream
->gid
, NULL
);
909 stream
->out_fd
= ret
;
910 stream
->tracefile_size_current
= 0;
912 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
913 stream
->name
, stream
->key
);
915 if (relayd_id
!= -1ULL) {
916 ret
= consumer_send_relayd_streams_sent(relayd_id
);
922 ustctl_flush_buffer(stream
->ustream
, 1);
924 ret
= lttng_ustconsumer_take_snapshot(stream
);
926 ERR("Taking UST snapshot");
930 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
932 ERR("Produced UST snapshot position");
936 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
938 ERR("Consumerd UST snapshot position");
943 * The original value is sent back if max stream size is larger than
944 * the possible size of the snapshot. Also, we assume that the session
945 * daemon should never send a maximum stream size that is lower than
948 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
949 produced_pos
, nb_packets_per_stream
,
950 stream
->max_sb_size
);
952 while (consumed_pos
< produced_pos
) {
954 unsigned long len
, padded_len
;
956 health_code_update();
958 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
960 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
962 if (ret
!= -EAGAIN
) {
963 PERROR("ustctl_get_subbuf snapshot");
964 goto error_close_stream
;
966 DBG("UST consumer get subbuf failed. Skipping it.");
967 consumed_pos
+= stream
->max_sb_size
;
971 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
973 ERR("Snapshot ustctl_get_subbuf_size");
974 goto error_put_subbuf
;
977 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
979 ERR("Snapshot ustctl_get_padded_subbuf_size");
980 goto error_put_subbuf
;
983 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
984 padded_len
- len
, NULL
);
986 if (read_len
!= len
) {
988 goto error_put_subbuf
;
991 if (read_len
!= padded_len
) {
993 goto error_put_subbuf
;
997 ret
= ustctl_put_subbuf(stream
->ustream
);
999 ERR("Snapshot ustctl_put_subbuf");
1000 goto error_close_stream
;
1002 consumed_pos
+= stream
->max_sb_size
;
1005 /* Simply close the stream so we can use it on the next snapshot. */
1006 consumer_stream_close(stream
);
1007 pthread_mutex_unlock(&stream
->lock
);
1014 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1015 ERR("Snapshot ustctl_put_subbuf");
1018 consumer_stream_close(stream
);
1020 pthread_mutex_unlock(&stream
->lock
);
1027 * Receive the metadata updates from the sessiond.
1029 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1030 uint64_t len
, struct lttng_consumer_channel
*channel
,
1031 int timer
, int wait
)
1033 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1036 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1038 metadata_str
= zmalloc(len
* sizeof(char));
1039 if (!metadata_str
) {
1040 PERROR("zmalloc metadata string");
1041 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1045 health_code_update();
1047 /* Receive metadata string. */
1048 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1050 /* Session daemon is dead so return gracefully. */
1055 health_code_update();
1057 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1058 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1060 /* Unable to handle metadata. Notify session daemon. */
1061 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1063 * Skip metadata flush on write error since the offset and len might
1064 * not have been updated which could create an infinite loop below when
1065 * waiting for the metadata cache to be flushed.
1067 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1070 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1075 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1076 DBG("Waiting for metadata to be flushed");
1078 health_code_update();
1080 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1090 * Receive command from session daemon and process it.
1092 * Return 1 on success else a negative value or 0.
1094 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1095 int sock
, struct pollfd
*consumer_sockpoll
)
1098 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1099 struct lttcomm_consumer_msg msg
;
1100 struct lttng_consumer_channel
*channel
= NULL
;
1102 health_code_update();
1104 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1105 if (ret
!= sizeof(msg
)) {
1106 DBG("Consumer received unexpected message size %zd (expects %zu)",
1109 * The ret value might 0 meaning an orderly shutdown but this is ok
1110 * since the caller handles this.
1113 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1119 health_code_update();
1122 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1124 health_code_update();
1126 /* relayd needs RCU read-side lock */
1129 switch (msg
.cmd_type
) {
1130 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1132 /* Session daemon status message are handled in the following call. */
1133 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1134 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1135 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1136 msg
.u
.relayd_sock
.relayd_session_id
);
1139 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1141 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1142 struct consumer_relayd_sock_pair
*relayd
;
1144 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1146 /* Get relayd reference if exists. */
1147 relayd
= consumer_find_relayd(index
);
1148 if (relayd
== NULL
) {
1149 DBG("Unable to find relayd %" PRIu64
, index
);
1150 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1154 * Each relayd socket pair has a refcount of stream attached to it
1155 * which tells if the relayd is still active or not depending on the
1158 * This will set the destroy flag of the relayd object and destroy it
1159 * if the refcount reaches zero when called.
1161 * The destroy can happen either here or when a stream fd hangs up.
1164 consumer_flag_relayd_for_destroy(relayd
);
1167 goto end_msg_sessiond
;
1169 case LTTNG_CONSUMER_UPDATE_STREAM
:
1174 case LTTNG_CONSUMER_DATA_PENDING
:
1176 int ret
, is_data_pending
;
1177 uint64_t id
= msg
.u
.data_pending
.session_id
;
1179 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1181 is_data_pending
= consumer_data_pending(id
);
1183 /* Send back returned value to session daemon */
1184 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1185 sizeof(is_data_pending
));
1187 DBG("Error when sending the data pending ret code: %d", ret
);
1192 * No need to send back a status message since the data pending
1193 * returned value is the response.
1197 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1200 struct ustctl_consumer_channel_attr attr
;
1202 /* Create a plain object and reserve a channel key. */
1203 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1204 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1205 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1206 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1207 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1208 msg
.u
.ask_channel
.tracefile_size
,
1209 msg
.u
.ask_channel
.tracefile_count
,
1210 msg
.u
.ask_channel
.session_id_per_pid
,
1211 msg
.u
.ask_channel
.monitor
,
1212 msg
.u
.ask_channel
.live_timer_interval
);
1214 goto end_channel_error
;
1218 * Assign UST application UID to the channel. This value is ignored for
1219 * per PID buffers. This is specific to UST thus setting this after the
1222 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1224 /* Build channel attributes from received message. */
1225 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1226 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1227 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1228 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1229 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1230 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1231 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1233 /* Match channel buffer type to the UST abi. */
1234 switch (msg
.u
.ask_channel
.output
) {
1235 case LTTNG_EVENT_MMAP
:
1237 attr
.output
= LTTNG_UST_MMAP
;
1241 /* Translate and save channel type. */
1242 switch (msg
.u
.ask_channel
.type
) {
1243 case LTTNG_UST_CHAN_PER_CPU
:
1244 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1245 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1247 * Set refcount to 1 for owner. Below, we will
1248 * pass ownership to the
1249 * consumer_thread_channel_poll() thread.
1251 channel
->refcount
= 1;
1253 case LTTNG_UST_CHAN_METADATA
:
1254 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1255 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1262 health_code_update();
1264 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1266 goto end_channel_error
;
1269 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1270 ret
= consumer_metadata_cache_allocate(channel
);
1272 ERR("Allocating metadata cache");
1273 goto end_channel_error
;
1275 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1276 attr
.switch_timer_interval
= 0;
1278 consumer_timer_live_start(channel
,
1279 msg
.u
.ask_channel
.live_timer_interval
);
1282 health_code_update();
1285 * Add the channel to the internal state AFTER all streams were created
1286 * and successfully sent to session daemon. This way, all streams must
1287 * be ready before this channel is visible to the threads.
1288 * If add_channel succeeds, ownership of the channel is
1289 * passed to consumer_thread_channel_poll().
1291 ret
= add_channel(channel
, ctx
);
1293 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1294 if (channel
->switch_timer_enabled
== 1) {
1295 consumer_timer_switch_stop(channel
);
1297 consumer_metadata_cache_destroy(channel
);
1299 if (channel
->live_timer_enabled
== 1) {
1300 consumer_timer_live_stop(channel
);
1302 goto end_channel_error
;
1305 health_code_update();
1308 * Channel and streams are now created. Inform the session daemon that
1309 * everything went well and should wait to receive the channel and
1310 * streams with ustctl API.
1312 ret
= consumer_send_status_channel(sock
, channel
);
1315 * There is probably a problem on the socket.
1322 case LTTNG_CONSUMER_GET_CHANNEL
:
1324 int ret
, relayd_err
= 0;
1325 uint64_t key
= msg
.u
.get_channel
.key
;
1326 struct lttng_consumer_channel
*channel
;
1328 channel
= consumer_find_channel(key
);
1330 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1331 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1332 goto end_msg_sessiond
;
1335 health_code_update();
1337 /* Send everything to sessiond. */
1338 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1342 * We were unable to send to the relayd the stream so avoid
1343 * sending back a fatal error to the thread since this is OK
1344 * and the consumer can continue its work. The above call
1345 * has sent the error status message to the sessiond.
1350 * The communicaton was broken hence there is a bad state between
1351 * the consumer and sessiond so stop everything.
1356 health_code_update();
1359 * In no monitor mode, the streams ownership is kept inside the channel
1360 * so don't send them to the data thread.
1362 if (!channel
->monitor
) {
1363 goto end_msg_sessiond
;
1366 ret
= send_streams_to_thread(channel
, ctx
);
1369 * If we are unable to send the stream to the thread, there is
1370 * a big problem so just stop everything.
1374 /* List MUST be empty after or else it could be reused. */
1375 assert(cds_list_empty(&channel
->streams
.head
));
1376 goto end_msg_sessiond
;
1378 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1380 uint64_t key
= msg
.u
.destroy_channel
.key
;
1383 * Only called if streams have not been sent to stream
1384 * manager thread. However, channel has been sent to
1385 * channel manager thread.
1387 notify_thread_del_channel(ctx
, key
);
1388 goto end_msg_sessiond
;
1390 case LTTNG_CONSUMER_CLOSE_METADATA
:
1394 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1399 goto end_msg_sessiond
;
1401 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1405 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1410 goto end_msg_sessiond
;
1412 case LTTNG_CONSUMER_PUSH_METADATA
:
1415 uint64_t len
= msg
.u
.push_metadata
.len
;
1416 uint64_t key
= msg
.u
.push_metadata
.key
;
1417 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1418 struct lttng_consumer_channel
*channel
;
1420 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1423 channel
= consumer_find_channel(key
);
1426 * This is possible if the metadata creation on the consumer side
1427 * is in flight vis-a-vis a concurrent push metadata from the
1428 * session daemon. Simply return that the channel failed and the
1429 * session daemon will handle that message correctly considering
1430 * that this race is acceptable thus the DBG() statement here.
1432 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1433 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1434 goto end_msg_sessiond
;
1437 health_code_update();
1439 /* Tell session daemon we are ready to receive the metadata. */
1440 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1442 /* Somehow, the session daemon is not responding anymore. */
1446 health_code_update();
1448 /* Wait for more data. */
1449 health_poll_entry();
1450 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1456 health_code_update();
1458 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1459 len
, channel
, 0, 1);
1461 /* error receiving from sessiond */
1465 goto end_msg_sessiond
;
1468 case LTTNG_CONSUMER_SETUP_METADATA
:
1472 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1476 goto end_msg_sessiond
;
1478 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1480 if (msg
.u
.snapshot_channel
.metadata
) {
1481 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1482 msg
.u
.snapshot_channel
.pathname
,
1483 msg
.u
.snapshot_channel
.relayd_id
,
1486 ERR("Snapshot metadata failed");
1487 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1490 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1491 msg
.u
.snapshot_channel
.pathname
,
1492 msg
.u
.snapshot_channel
.relayd_id
,
1493 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1496 ERR("Snapshot channel failed");
1497 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1501 health_code_update();
1502 ret
= consumer_send_status_msg(sock
, ret_code
);
1504 /* Somehow, the session daemon is not responding anymore. */
1507 health_code_update();
1517 health_code_update();
1520 * Return 1 to indicate success since the 0 value can be a socket
1521 * shutdown during the recv() or send() call.
1527 * The returned value here is not useful since either way we'll return 1 to
1528 * the caller because the session daemon socket management is done
1529 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1531 ret
= consumer_send_status_msg(sock
, ret_code
);
1537 health_code_update();
1543 * Free channel here since no one has a reference to it. We don't
1544 * free after that because a stream can store this pointer.
1546 destroy_channel(channel
);
1548 /* We have to send a status channel message indicating an error. */
1549 ret
= consumer_send_status_channel(sock
, NULL
);
1551 /* Stop everything if session daemon can not be notified. */
1556 health_code_update();
1561 /* This will issue a consumer stop. */
1566 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1567 * compiled out, we isolate it in this library.
1569 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1573 assert(stream
->ustream
);
1575 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1579 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1580 * compiled out, we isolate it in this library.
1582 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1585 assert(stream
->ustream
);
1587 return ustctl_get_mmap_base(stream
->ustream
);
1591 * Take a snapshot for a specific fd
1593 * Returns 0 on success, < 0 on error
1595 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1598 assert(stream
->ustream
);
1600 return ustctl_snapshot(stream
->ustream
);
1604 * Get the produced position
1606 * Returns 0 on success, < 0 on error
1608 int lttng_ustconsumer_get_produced_snapshot(
1609 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1612 assert(stream
->ustream
);
1615 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1619 * Get the consumed position
1621 * Returns 0 on success, < 0 on error
1623 int lttng_ustconsumer_get_consumed_snapshot(
1624 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1627 assert(stream
->ustream
);
1630 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1633 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1637 assert(stream
->ustream
);
1639 ustctl_flush_buffer(stream
->ustream
, producer
);
1642 int lttng_ustconsumer_get_current_timestamp(
1643 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1646 assert(stream
->ustream
);
1649 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1653 * Called when the stream signal the consumer that it has hang up.
1655 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1658 assert(stream
->ustream
);
1660 ustctl_flush_buffer(stream
->ustream
, 0);
1661 stream
->hangup_flush_done
= 1;
1664 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1667 assert(chan
->uchan
);
1669 if (chan
->switch_timer_enabled
== 1) {
1670 consumer_timer_switch_stop(chan
);
1672 consumer_metadata_cache_destroy(chan
);
1673 ustctl_destroy_channel(chan
->uchan
);
1676 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1679 assert(stream
->ustream
);
1681 if (stream
->chan
->switch_timer_enabled
== 1) {
1682 consumer_timer_switch_stop(stream
->chan
);
1684 ustctl_destroy_stream(stream
->ustream
);
1687 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
1690 assert(stream
->ustream
);
1692 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
1695 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
1698 assert(stream
->ustream
);
1700 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
1704 * Populate index values of a UST stream. Values are set in big endian order.
1706 * Return 0 on success or else a negative value.
1708 static int get_index_values(struct ctf_packet_index
*index
,
1709 struct ustctl_consumer_stream
*ustream
)
1713 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1715 PERROR("ustctl_get_timestamp_begin");
1718 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1720 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1722 PERROR("ustctl_get_timestamp_end");
1725 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1727 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1729 PERROR("ustctl_get_events_discarded");
1732 index
->events_discarded
= htobe64(index
->events_discarded
);
1734 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1736 PERROR("ustctl_get_content_size");
1739 index
->content_size
= htobe64(index
->content_size
);
1741 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1743 PERROR("ustctl_get_packet_size");
1746 index
->packet_size
= htobe64(index
->packet_size
);
1748 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1750 PERROR("ustctl_get_stream_id");
1753 index
->stream_id
= htobe64(index
->stream_id
);
1760 * Write up to one packet from the metadata cache to the channel.
1762 * Returns the number of bytes pushed in the cache, or a negative value
1766 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1771 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1772 if (stream
->chan
->metadata_cache
->contiguous
1773 == stream
->ust_metadata_pushed
) {
1778 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1779 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1780 stream
->chan
->metadata_cache
->contiguous
1781 - stream
->ust_metadata_pushed
);
1782 assert(write_len
!= 0);
1783 if (write_len
< 0) {
1784 ERR("Writing one metadata packet");
1788 stream
->ust_metadata_pushed
+= write_len
;
1790 assert(stream
->chan
->metadata_cache
->contiguous
>=
1791 stream
->ust_metadata_pushed
);
1795 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1801 * Sync metadata meaning request them to the session daemon and snapshot to the
1802 * metadata thread can consumer them.
1804 * Metadata stream lock MUST be acquired.
1806 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1807 * is empty or a negative value on error.
1809 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1810 struct lttng_consumer_stream
*metadata
)
1819 * Request metadata from the sessiond, but don't wait for the flush
1820 * because we locked the metadata thread.
1822 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1827 ret
= commit_one_metadata_packet(metadata
);
1830 } else if (ret
> 0) {
1834 ustctl_flush_buffer(metadata
->ustream
, 1);
1835 ret
= ustctl_snapshot(metadata
->ustream
);
1837 if (errno
!= EAGAIN
) {
1838 ERR("Sync metadata, taking UST snapshot");
1841 DBG("No new metadata when syncing them.");
1842 /* No new metadata, exit. */
1848 * After this flush, we still need to extract metadata.
1859 * Return 0 on success else a negative value.
1861 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
1862 struct lttng_consumer_local_data
*ctx
)
1865 struct ustctl_consumer_stream
*ustream
;
1870 ustream
= stream
->ustream
;
1873 * First, we are going to check if there is a new subbuffer available
1874 * before reading the stream wait_fd.
1876 /* Get the next subbuffer */
1877 ret
= ustctl_get_next_subbuf(ustream
);
1879 /* No more data found, flag the stream. */
1880 stream
->has_data
= 0;
1885 ret
= ustctl_put_subbuf(ustream
);
1888 /* This stream still has data. Flag it and wake up the data thread. */
1889 stream
->has_data
= 1;
1891 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
1894 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
1895 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1900 /* The wake up pipe has been notified. */
1901 ctx
->has_wakeup
= 1;
1910 * Read subbuffer from the given stream.
1912 * Stream lock MUST be acquired.
1914 * Return 0 on success else a negative value.
1916 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1917 struct lttng_consumer_local_data
*ctx
)
1919 unsigned long len
, subbuf_size
, padding
;
1920 int err
, write_index
= 1;
1922 struct ustctl_consumer_stream
*ustream
;
1923 struct ctf_packet_index index
;
1926 assert(stream
->ustream
);
1929 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1932 /* Ease our life for what's next. */
1933 ustream
= stream
->ustream
;
1936 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
1937 * error if we cannot read this one byte (read returns 0), or if the error
1938 * is EAGAIN or EWOULDBLOCK.
1940 * This is only done when the stream is monitored by a thread, before the
1941 * flush is done after a hangup and if the stream is not flagged with data
1942 * since there might be nothing to consume in the wait fd but still have
1943 * data available flagged by the consumer wake up pipe.
1945 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
1949 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
1950 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1957 /* Get the next subbuffer */
1958 err
= ustctl_get_next_subbuf(ustream
);
1961 * Populate metadata info if the existing info has
1962 * already been read.
1964 if (stream
->metadata_flag
) {
1965 ret
= commit_one_metadata_packet(stream
);
1969 ustctl_flush_buffer(stream
->ustream
, 1);
1973 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1975 * This is a debug message even for single-threaded consumer,
1976 * because poll() have more relaxed criterions than get subbuf,
1977 * so get_subbuf may fail for short race windows where poll()
1978 * would issue wakeups.
1980 DBG("Reserving sub buffer failed (everything is normal, "
1981 "it is due to concurrency) [ret: %d]", err
);
1984 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1986 if (!stream
->metadata_flag
) {
1987 index
.offset
= htobe64(stream
->out_fd_offset
);
1988 ret
= get_index_values(&index
, ustream
);
1996 /* Get the full padded subbuffer size */
1997 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2000 /* Get subbuffer data size (without padding) */
2001 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2004 /* Make sure we don't get a subbuffer size bigger than the padded */
2005 assert(len
>= subbuf_size
);
2007 padding
= len
- subbuf_size
;
2008 /* write the subbuffer to the tracefile */
2009 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2011 * The mmap operation should write subbuf_size amount of data when network
2012 * streaming or the full padding (len) size when we are _not_ streaming.
2014 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2015 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2017 * Display the error but continue processing to try to release the
2018 * subbuffer. This is a DBG statement since any unexpected kill or
2019 * signal, the application gets unregistered, relayd gets closed or
2020 * anything that affects the buffer lifetime will trigger this error.
2021 * So, for the sake of the user, don't print this error since it can
2022 * happen and it is OK with the code flow.
2024 DBG("Error writing to tracefile "
2025 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2026 ret
, len
, subbuf_size
);
2029 err
= ustctl_put_next_subbuf(ustream
);
2033 * This will consumer the byte on the wait_fd if and only if there is not
2034 * next subbuffer to be acquired.
2036 if (!stream
->metadata_flag
) {
2037 ret
= notify_if_more_data(stream
, ctx
);
2043 /* Write index if needed. */
2048 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2050 * In live, block until all the metadata is sent.
2052 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2058 assert(!stream
->metadata_flag
);
2059 err
= consumer_stream_write_index(stream
, &index
);
2069 * Called when a stream is created.
2071 * Return 0 on success or else a negative value.
2073 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2079 /* Don't create anything if this is set for streaming. */
2080 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2081 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2082 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2083 stream
->uid
, stream
->gid
, NULL
);
2087 stream
->out_fd
= ret
;
2088 stream
->tracefile_size_current
= 0;
2090 if (!stream
->metadata_flag
) {
2091 ret
= index_create_file(stream
->chan
->pathname
,
2092 stream
->name
, stream
->uid
, stream
->gid
,
2093 stream
->chan
->tracefile_size
,
2094 stream
->tracefile_count_current
);
2098 stream
->index_fd
= ret
;
2108 * Check if data is still being extracted from the buffers for a specific
2109 * stream. Consumer data lock MUST be acquired before calling this function
2110 * and the stream lock.
2112 * Return 1 if the traced data are still getting read else 0 meaning that the
2113 * data is available for trace viewer reading.
2115 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2120 assert(stream
->ustream
);
2122 DBG("UST consumer checking data pending");
2124 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2129 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2130 uint64_t contiguous
, pushed
;
2132 /* Ease our life a bit. */
2133 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
2134 pushed
= stream
->ust_metadata_pushed
;
2137 * We can simply check whether all contiguously available data
2138 * has been pushed to the ring buffer, since the push operation
2139 * is performed within get_next_subbuf(), and because both
2140 * get_next_subbuf() and put_next_subbuf() are issued atomically
2141 * thanks to the stream lock within
2142 * lttng_ustconsumer_read_subbuffer(). This basically means that
2143 * whetnever ust_metadata_pushed is incremented, the associated
2144 * metadata has been consumed from the metadata stream.
2146 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2147 contiguous
, pushed
);
2148 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2149 if ((contiguous
!= pushed
) ||
2150 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2151 ret
= 1; /* Data is pending */
2155 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2158 * There is still data so let's put back this
2161 ret
= ustctl_put_subbuf(stream
->ustream
);
2163 ret
= 1; /* Data is pending */
2168 /* Data is NOT pending so ready to be read. */
2176 * Stop a given metadata channel timer if enabled and close the wait fd which
2177 * is the poll pipe of the metadata stream.
2179 * This MUST be called with the metadata channel acquired.
2181 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2186 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2188 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2190 if (metadata
->switch_timer_enabled
== 1) {
2191 consumer_timer_switch_stop(metadata
);
2194 if (!metadata
->metadata_stream
) {
2199 * Closing write side so the thread monitoring the stream wakes up if any
2200 * and clean the metadata stream.
2202 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2203 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2205 PERROR("closing metadata pipe write side");
2207 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2215 * Close every metadata stream wait fd of the metadata hash table. This
2216 * function MUST be used very carefully so not to run into a race between the
2217 * metadata thread handling streams and this function closing their wait fd.
2219 * For UST, this is used when the session daemon hangs up. Its the metadata
2220 * producer so calling this is safe because we are assured that no state change
2221 * can occur in the metadata thread for the streams in the hash table.
2223 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2225 struct lttng_ht_iter iter
;
2226 struct lttng_consumer_stream
*stream
;
2228 assert(metadata_ht
);
2229 assert(metadata_ht
->ht
);
2231 DBG("UST consumer closing all metadata streams");
2234 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2237 health_code_update();
2239 pthread_mutex_lock(&stream
->chan
->lock
);
2240 lttng_ustconsumer_close_metadata(stream
->chan
);
2241 pthread_mutex_unlock(&stream
->chan
->lock
);
2247 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2251 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2253 ERR("Unable to close wakeup fd");
2258 * Please refer to consumer-timer.c before adding any lock within this
2259 * function or any of its callees. Timers have a very strict locking
2260 * semantic with respect to teardown. Failure to respect this semantic
2261 * introduces deadlocks.
2263 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2264 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2266 struct lttcomm_metadata_request_msg request
;
2267 struct lttcomm_consumer_msg msg
;
2268 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2269 uint64_t len
, key
, offset
;
2273 assert(channel
->metadata_cache
);
2275 memset(&request
, 0, sizeof(request
));
2277 /* send the metadata request to sessiond */
2278 switch (consumer_data
.type
) {
2279 case LTTNG_CONSUMER64_UST
:
2280 request
.bits_per_long
= 64;
2282 case LTTNG_CONSUMER32_UST
:
2283 request
.bits_per_long
= 32;
2286 request
.bits_per_long
= 0;
2290 request
.session_id
= channel
->session_id
;
2291 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2293 * Request the application UID here so the metadata of that application can
2294 * be sent back. The channel UID corresponds to the user UID of the session
2295 * used for the rights on the stream file(s).
2297 request
.uid
= channel
->ust_app_uid
;
2298 request
.key
= channel
->key
;
2300 DBG("Sending metadata request to sessiond, session id %" PRIu64
2301 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2302 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2305 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2307 health_code_update();
2309 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2312 ERR("Asking metadata to sessiond");
2316 health_code_update();
2318 /* Receive the metadata from sessiond */
2319 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2321 if (ret
!= sizeof(msg
)) {
2322 DBG("Consumer received unexpected message size %d (expects %zu)",
2324 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2326 * The ret value might 0 meaning an orderly shutdown but this is ok
2327 * since the caller handles this.
2332 health_code_update();
2334 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2335 /* No registry found */
2336 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2340 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2341 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2346 len
= msg
.u
.push_metadata
.len
;
2347 key
= msg
.u
.push_metadata
.key
;
2348 offset
= msg
.u
.push_metadata
.target_offset
;
2350 assert(key
== channel
->key
);
2352 DBG("No new metadata to receive for key %" PRIu64
, key
);
2355 health_code_update();
2357 /* Tell session daemon we are ready to receive the metadata. */
2358 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2359 LTTCOMM_CONSUMERD_SUCCESS
);
2360 if (ret
< 0 || len
== 0) {
2362 * Somehow, the session daemon is not responding anymore or there is
2363 * nothing to receive.
2368 health_code_update();
2370 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2371 key
, offset
, len
, channel
, timer
, wait
);
2374 * Only send the status msg if the sessiond is alive meaning a positive
2377 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2382 health_code_update();
2384 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2389 * Return the ustctl call for the get stream id.
2391 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2392 uint64_t *stream_id
)
2397 return ustctl_get_stream_id(stream
->ustream
, stream_id
);