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 if (channel
->monitor
) {
331 /* Set metadata poll pipe if we created one */
332 memcpy(stream
->ust_metadata_poll_pipe
,
334 sizeof(ust_metadata_pipe
));
347 * Create an UST channel with the given attributes and send it to the session
348 * daemon using the ust ctl API.
350 * Return 0 on success or else a negative value.
352 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
353 struct ustctl_consumer_channel
**chanp
)
356 struct ustctl_consumer_channel
*channel
;
361 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
362 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
363 "switch_timer_interval: %u, read_timer_interval: %u, "
364 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
365 attr
->num_subbuf
, attr
->switch_timer_interval
,
366 attr
->read_timer_interval
, attr
->output
, attr
->type
);
368 channel
= ustctl_create_channel(attr
);
383 * Send a single given stream to the session daemon using the sock.
385 * Return 0 on success else a negative value.
387 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
394 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
396 /* Send stream to session daemon. */
397 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
407 * Send channel to sessiond.
409 * Return 0 on success or else a negative value.
411 static int send_sessiond_channel(int sock
,
412 struct lttng_consumer_channel
*channel
,
413 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
415 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
416 struct lttng_consumer_stream
*stream
;
417 uint64_t net_seq_idx
= -1ULL;
423 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
425 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
426 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
428 health_code_update();
430 /* Try to send the stream to the relayd if one is available. */
431 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
434 * Flag that the relayd was the problem here probably due to a
435 * communicaton error on the socket.
440 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
442 if (net_seq_idx
== -1ULL) {
443 net_seq_idx
= stream
->net_seq_idx
;
448 /* Inform sessiond that we are about to send channel and streams. */
449 ret
= consumer_send_status_msg(sock
, ret_code
);
450 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
452 * Either the session daemon is not responding or the relayd died so we
458 /* Send channel to sessiond. */
459 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
464 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
469 /* The channel was sent successfully to the sessiond at this point. */
470 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
472 health_code_update();
474 /* Send stream to session daemon. */
475 ret
= send_sessiond_stream(sock
, stream
);
481 /* Tell sessiond there is no more stream. */
482 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
487 DBG("UST consumer NULL stream sent to sessiond");
492 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
499 * Creates a channel and streams and add the channel it to the channel internal
500 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
503 * Return 0 on success or else, a negative value is returned and the channel
504 * MUST be destroyed by consumer_del_channel().
506 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
507 struct lttng_consumer_channel
*channel
,
508 struct ustctl_consumer_channel_attr
*attr
)
517 * This value is still used by the kernel consumer since for the kernel,
518 * the stream ownership is not IN the consumer so we need to have the
519 * number of left stream that needs to be initialized so we can know when
520 * to delete the channel (see consumer.c).
522 * As for the user space tracer now, the consumer creates and sends the
523 * stream to the session daemon which only sends them to the application
524 * once every stream of a channel is received making this value useless
525 * because we they will be added to the poll thread before the application
526 * receives them. This ensures that a stream can not hang up during
527 * initilization of a channel.
529 channel
->nb_init_stream_left
= 0;
531 /* The reply msg status is handled in the following call. */
532 ret
= create_ust_channel(attr
, &channel
->uchan
);
537 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
540 * For the snapshots (no monitor), we create the metadata streams
541 * on demand, not during the channel creation.
543 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
548 /* Open all streams for this channel. */
549 ret
= create_ust_streams(channel
, ctx
);
559 * Send all stream of a channel to the right thread handling it.
561 * On error, return a negative value else 0 on success.
563 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
564 struct lttng_consumer_local_data
*ctx
)
567 struct lttng_consumer_stream
*stream
, *stmp
;
572 /* Send streams to the corresponding thread. */
573 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
576 health_code_update();
578 /* Sending the stream to the thread. */
579 ret
= send_stream_to_thread(stream
, ctx
);
582 * If we are unable to send the stream to the thread, there is
583 * a big problem so just stop everything.
585 /* Remove node from the channel stream list. */
586 cds_list_del(&stream
->send_node
);
590 /* Remove node from the channel stream list. */
591 cds_list_del(&stream
->send_node
);
600 * Flush channel's streams using the given key to retrieve the channel.
602 * Return 0 on success else an LTTng error code.
604 static int flush_channel(uint64_t chan_key
)
607 struct lttng_consumer_channel
*channel
;
608 struct lttng_consumer_stream
*stream
;
610 struct lttng_ht_iter iter
;
612 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
615 channel
= consumer_find_channel(chan_key
);
617 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
618 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
622 ht
= consumer_data
.stream_per_chan_id_ht
;
624 /* For each stream of the channel id, flush it. */
625 cds_lfht_for_each_entry_duplicate(ht
->ht
,
626 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
627 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
629 health_code_update();
631 ustctl_flush_buffer(stream
->ustream
, 1);
639 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
640 * RCU read side lock MUST be acquired before calling this function.
642 * Return 0 on success else an LTTng error code.
644 static int close_metadata(uint64_t chan_key
)
647 struct lttng_consumer_channel
*channel
;
649 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
651 channel
= consumer_find_channel(chan_key
);
654 * This is possible if the metadata thread has issue a delete because
655 * the endpoint point of the stream hung up. There is no way the
656 * session daemon can know about it thus use a DBG instead of an actual
659 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
660 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
664 pthread_mutex_lock(&consumer_data
.lock
);
665 pthread_mutex_lock(&channel
->lock
);
667 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
671 lttng_ustconsumer_close_metadata(channel
);
674 pthread_mutex_unlock(&channel
->lock
);
675 pthread_mutex_unlock(&consumer_data
.lock
);
681 * RCU read side lock MUST be acquired before calling this function.
683 * Return 0 on success else an LTTng error code.
685 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
688 struct lttng_consumer_channel
*metadata
;
690 DBG("UST consumer setup metadata key %" PRIu64
, key
);
692 metadata
= consumer_find_channel(key
);
694 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
695 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
700 * In no monitor mode, the metadata channel has no stream(s) so skip the
701 * ownership transfer to the metadata thread.
703 if (!metadata
->monitor
) {
704 DBG("Metadata channel in no monitor");
710 * Send metadata stream to relayd if one available. Availability is
711 * known if the stream is still in the list of the channel.
713 if (cds_list_empty(&metadata
->streams
.head
)) {
714 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
715 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
716 goto error_no_stream
;
719 /* Send metadata stream to relayd if needed. */
720 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
721 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
724 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
727 ret
= consumer_send_relayd_streams_sent(
728 metadata
->metadata_stream
->net_seq_idx
);
730 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
735 ret
= send_streams_to_thread(metadata
, ctx
);
738 * If we are unable to send the stream to the thread, there is
739 * a big problem so just stop everything.
741 ret
= LTTCOMM_CONSUMERD_FATAL
;
744 /* List MUST be empty after or else it could be reused. */
745 assert(cds_list_empty(&metadata
->streams
.head
));
752 * Delete metadata channel on error. At this point, the metadata stream can
753 * NOT be monitored by the metadata thread thus having the guarantee that
754 * the stream is still in the local stream list of the channel. This call
755 * will make sure to clean that list.
757 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
758 cds_list_del(&metadata
->metadata_stream
->send_node
);
759 metadata
->metadata_stream
= NULL
;
766 * Snapshot the whole metadata.
768 * Returns 0 on success, < 0 on error
770 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
771 struct lttng_consumer_local_data
*ctx
)
774 struct lttng_consumer_channel
*metadata_channel
;
775 struct lttng_consumer_stream
*metadata_stream
;
780 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
785 metadata_channel
= consumer_find_channel(key
);
786 if (!metadata_channel
) {
787 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
792 assert(!metadata_channel
->monitor
);
794 health_code_update();
797 * Ask the sessiond if we have new metadata waiting and update the
798 * consumer metadata cache.
800 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
805 health_code_update();
808 * The metadata stream is NOT created in no monitor mode when the channel
809 * is created on a sessiond ask channel command.
811 ret
= create_ust_streams(metadata_channel
, ctx
);
816 metadata_stream
= metadata_channel
->metadata_stream
;
817 assert(metadata_stream
);
819 if (relayd_id
!= (uint64_t) -1ULL) {
820 metadata_stream
->net_seq_idx
= relayd_id
;
821 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
826 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
827 metadata_stream
->chan
->tracefile_size
,
828 metadata_stream
->tracefile_count_current
,
829 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
833 metadata_stream
->out_fd
= ret
;
834 metadata_stream
->tracefile_size_current
= 0;
838 health_code_update();
840 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
848 * Clean up the stream completly because the next snapshot will use a new
851 consumer_stream_destroy(metadata_stream
, NULL
);
852 cds_list_del(&metadata_stream
->send_node
);
853 metadata_channel
->metadata_stream
= NULL
;
861 * Take a snapshot of all the stream of a channel.
863 * Returns 0 on success, < 0 on error
865 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
866 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
869 unsigned use_relayd
= 0;
870 unsigned long consumed_pos
, produced_pos
;
871 struct lttng_consumer_channel
*channel
;
872 struct lttng_consumer_stream
*stream
;
879 if (relayd_id
!= (uint64_t) -1ULL) {
883 channel
= consumer_find_channel(key
);
885 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
889 assert(!channel
->monitor
);
890 DBG("UST consumer snapshot channel %" PRIu64
, key
);
892 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
894 health_code_update();
896 /* Lock stream because we are about to change its state. */
897 pthread_mutex_lock(&stream
->lock
);
898 stream
->net_seq_idx
= relayd_id
;
901 ret
= consumer_send_relayd_stream(stream
, path
);
906 ret
= utils_create_stream_file(path
, stream
->name
,
907 stream
->chan
->tracefile_size
,
908 stream
->tracefile_count_current
,
909 stream
->uid
, stream
->gid
, NULL
);
913 stream
->out_fd
= ret
;
914 stream
->tracefile_size_current
= 0;
916 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
917 stream
->name
, stream
->key
);
919 if (relayd_id
!= -1ULL) {
920 ret
= consumer_send_relayd_streams_sent(relayd_id
);
926 ustctl_flush_buffer(stream
->ustream
, 1);
928 ret
= lttng_ustconsumer_take_snapshot(stream
);
930 ERR("Taking UST snapshot");
934 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
936 ERR("Produced UST snapshot position");
940 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
942 ERR("Consumerd UST snapshot position");
947 * The original value is sent back if max stream size is larger than
948 * the possible size of the snapshot. Also, we assume that the session
949 * daemon should never send a maximum stream size that is lower than
952 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
953 produced_pos
, nb_packets_per_stream
,
954 stream
->max_sb_size
);
956 while (consumed_pos
< produced_pos
) {
958 unsigned long len
, padded_len
;
960 health_code_update();
962 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
964 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
966 if (ret
!= -EAGAIN
) {
967 PERROR("ustctl_get_subbuf snapshot");
968 goto error_close_stream
;
970 DBG("UST consumer get subbuf failed. Skipping it.");
971 consumed_pos
+= stream
->max_sb_size
;
975 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
977 ERR("Snapshot ustctl_get_subbuf_size");
978 goto error_put_subbuf
;
981 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
983 ERR("Snapshot ustctl_get_padded_subbuf_size");
984 goto error_put_subbuf
;
987 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
988 padded_len
- len
, NULL
);
990 if (read_len
!= len
) {
992 goto error_put_subbuf
;
995 if (read_len
!= padded_len
) {
997 goto error_put_subbuf
;
1001 ret
= ustctl_put_subbuf(stream
->ustream
);
1003 ERR("Snapshot ustctl_put_subbuf");
1004 goto error_close_stream
;
1006 consumed_pos
+= stream
->max_sb_size
;
1009 /* Simply close the stream so we can use it on the next snapshot. */
1010 consumer_stream_close(stream
);
1011 pthread_mutex_unlock(&stream
->lock
);
1018 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1019 ERR("Snapshot ustctl_put_subbuf");
1022 consumer_stream_close(stream
);
1024 pthread_mutex_unlock(&stream
->lock
);
1031 * Receive the metadata updates from the sessiond.
1033 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1034 uint64_t len
, struct lttng_consumer_channel
*channel
,
1035 int timer
, int wait
)
1037 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1040 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1042 metadata_str
= zmalloc(len
* sizeof(char));
1043 if (!metadata_str
) {
1044 PERROR("zmalloc metadata string");
1045 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1049 health_code_update();
1051 /* Receive metadata string. */
1052 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1054 /* Session daemon is dead so return gracefully. */
1059 health_code_update();
1061 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1062 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1064 /* Unable to handle metadata. Notify session daemon. */
1065 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1067 * Skip metadata flush on write error since the offset and len might
1068 * not have been updated which could create an infinite loop below when
1069 * waiting for the metadata cache to be flushed.
1071 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1074 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1079 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1080 DBG("Waiting for metadata to be flushed");
1082 health_code_update();
1084 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1094 * Receive command from session daemon and process it.
1096 * Return 1 on success else a negative value or 0.
1098 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1099 int sock
, struct pollfd
*consumer_sockpoll
)
1102 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1103 struct lttcomm_consumer_msg msg
;
1104 struct lttng_consumer_channel
*channel
= NULL
;
1106 health_code_update();
1108 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1109 if (ret
!= sizeof(msg
)) {
1110 DBG("Consumer received unexpected message size %zd (expects %zu)",
1113 * The ret value might 0 meaning an orderly shutdown but this is ok
1114 * since the caller handles this.
1117 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1123 health_code_update();
1126 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1128 health_code_update();
1130 /* relayd needs RCU read-side lock */
1133 switch (msg
.cmd_type
) {
1134 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1136 /* Session daemon status message are handled in the following call. */
1137 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1138 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1139 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1140 msg
.u
.relayd_sock
.relayd_session_id
);
1143 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1145 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1146 struct consumer_relayd_sock_pair
*relayd
;
1148 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1150 /* Get relayd reference if exists. */
1151 relayd
= consumer_find_relayd(index
);
1152 if (relayd
== NULL
) {
1153 DBG("Unable to find relayd %" PRIu64
, index
);
1154 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1158 * Each relayd socket pair has a refcount of stream attached to it
1159 * which tells if the relayd is still active or not depending on the
1162 * This will set the destroy flag of the relayd object and destroy it
1163 * if the refcount reaches zero when called.
1165 * The destroy can happen either here or when a stream fd hangs up.
1168 consumer_flag_relayd_for_destroy(relayd
);
1171 goto end_msg_sessiond
;
1173 case LTTNG_CONSUMER_UPDATE_STREAM
:
1178 case LTTNG_CONSUMER_DATA_PENDING
:
1180 int ret
, is_data_pending
;
1181 uint64_t id
= msg
.u
.data_pending
.session_id
;
1183 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1185 is_data_pending
= consumer_data_pending(id
);
1187 /* Send back returned value to session daemon */
1188 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1189 sizeof(is_data_pending
));
1191 DBG("Error when sending the data pending ret code: %d", ret
);
1196 * No need to send back a status message since the data pending
1197 * returned value is the response.
1201 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1204 struct ustctl_consumer_channel_attr attr
;
1206 /* Create a plain object and reserve a channel key. */
1207 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1208 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1209 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1210 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1211 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1212 msg
.u
.ask_channel
.tracefile_size
,
1213 msg
.u
.ask_channel
.tracefile_count
,
1214 msg
.u
.ask_channel
.session_id_per_pid
,
1215 msg
.u
.ask_channel
.monitor
,
1216 msg
.u
.ask_channel
.live_timer_interval
);
1218 goto end_channel_error
;
1222 * Assign UST application UID to the channel. This value is ignored for
1223 * per PID buffers. This is specific to UST thus setting this after the
1226 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1228 /* Build channel attributes from received message. */
1229 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1230 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1231 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1232 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1233 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1234 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1235 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1237 /* Match channel buffer type to the UST abi. */
1238 switch (msg
.u
.ask_channel
.output
) {
1239 case LTTNG_EVENT_MMAP
:
1241 attr
.output
= LTTNG_UST_MMAP
;
1245 /* Translate and save channel type. */
1246 switch (msg
.u
.ask_channel
.type
) {
1247 case LTTNG_UST_CHAN_PER_CPU
:
1248 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1249 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1251 * Set refcount to 1 for owner. Below, we will
1252 * pass ownership to the
1253 * consumer_thread_channel_poll() thread.
1255 channel
->refcount
= 1;
1257 case LTTNG_UST_CHAN_METADATA
:
1258 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1259 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1266 health_code_update();
1268 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1270 goto end_channel_error
;
1273 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1274 ret
= consumer_metadata_cache_allocate(channel
);
1276 ERR("Allocating metadata cache");
1277 goto end_channel_error
;
1279 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1280 attr
.switch_timer_interval
= 0;
1282 consumer_timer_live_start(channel
,
1283 msg
.u
.ask_channel
.live_timer_interval
);
1286 health_code_update();
1289 * Add the channel to the internal state AFTER all streams were created
1290 * and successfully sent to session daemon. This way, all streams must
1291 * be ready before this channel is visible to the threads.
1292 * If add_channel succeeds, ownership of the channel is
1293 * passed to consumer_thread_channel_poll().
1295 ret
= add_channel(channel
, ctx
);
1297 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1298 if (channel
->switch_timer_enabled
== 1) {
1299 consumer_timer_switch_stop(channel
);
1301 consumer_metadata_cache_destroy(channel
);
1303 if (channel
->live_timer_enabled
== 1) {
1304 consumer_timer_live_stop(channel
);
1306 goto end_channel_error
;
1309 health_code_update();
1312 * Channel and streams are now created. Inform the session daemon that
1313 * everything went well and should wait to receive the channel and
1314 * streams with ustctl API.
1316 ret
= consumer_send_status_channel(sock
, channel
);
1319 * There is probably a problem on the socket.
1326 case LTTNG_CONSUMER_GET_CHANNEL
:
1328 int ret
, relayd_err
= 0;
1329 uint64_t key
= msg
.u
.get_channel
.key
;
1330 struct lttng_consumer_channel
*channel
;
1332 channel
= consumer_find_channel(key
);
1334 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1335 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1336 goto end_msg_sessiond
;
1339 health_code_update();
1341 /* Send everything to sessiond. */
1342 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1346 * We were unable to send to the relayd the stream so avoid
1347 * sending back a fatal error to the thread since this is OK
1348 * and the consumer can continue its work. The above call
1349 * has sent the error status message to the sessiond.
1354 * The communicaton was broken hence there is a bad state between
1355 * the consumer and sessiond so stop everything.
1360 health_code_update();
1363 * In no monitor mode, the streams ownership is kept inside the channel
1364 * so don't send them to the data thread.
1366 if (!channel
->monitor
) {
1367 goto end_msg_sessiond
;
1370 ret
= send_streams_to_thread(channel
, ctx
);
1373 * If we are unable to send the stream to the thread, there is
1374 * a big problem so just stop everything.
1378 /* List MUST be empty after or else it could be reused. */
1379 assert(cds_list_empty(&channel
->streams
.head
));
1380 goto end_msg_sessiond
;
1382 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1384 uint64_t key
= msg
.u
.destroy_channel
.key
;
1387 * Only called if streams have not been sent to stream
1388 * manager thread. However, channel has been sent to
1389 * channel manager thread.
1391 notify_thread_del_channel(ctx
, key
);
1392 goto end_msg_sessiond
;
1394 case LTTNG_CONSUMER_CLOSE_METADATA
:
1398 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1403 goto end_msg_sessiond
;
1405 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1409 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1414 goto end_msg_sessiond
;
1416 case LTTNG_CONSUMER_PUSH_METADATA
:
1419 uint64_t len
= msg
.u
.push_metadata
.len
;
1420 uint64_t key
= msg
.u
.push_metadata
.key
;
1421 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1422 struct lttng_consumer_channel
*channel
;
1424 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1427 channel
= consumer_find_channel(key
);
1430 * This is possible if the metadata creation on the consumer side
1431 * is in flight vis-a-vis a concurrent push metadata from the
1432 * session daemon. Simply return that the channel failed and the
1433 * session daemon will handle that message correctly considering
1434 * that this race is acceptable thus the DBG() statement here.
1436 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1437 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1438 goto end_msg_sessiond
;
1441 health_code_update();
1443 /* Tell session daemon we are ready to receive the metadata. */
1444 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1446 /* Somehow, the session daemon is not responding anymore. */
1450 health_code_update();
1452 /* Wait for more data. */
1453 health_poll_entry();
1454 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1460 health_code_update();
1462 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1463 len
, channel
, 0, 1);
1465 /* error receiving from sessiond */
1469 goto end_msg_sessiond
;
1472 case LTTNG_CONSUMER_SETUP_METADATA
:
1476 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1480 goto end_msg_sessiond
;
1482 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1484 if (msg
.u
.snapshot_channel
.metadata
) {
1485 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1486 msg
.u
.snapshot_channel
.pathname
,
1487 msg
.u
.snapshot_channel
.relayd_id
,
1490 ERR("Snapshot metadata failed");
1491 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1494 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1495 msg
.u
.snapshot_channel
.pathname
,
1496 msg
.u
.snapshot_channel
.relayd_id
,
1497 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1500 ERR("Snapshot channel failed");
1501 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1505 health_code_update();
1506 ret
= consumer_send_status_msg(sock
, ret_code
);
1508 /* Somehow, the session daemon is not responding anymore. */
1511 health_code_update();
1521 health_code_update();
1524 * Return 1 to indicate success since the 0 value can be a socket
1525 * shutdown during the recv() or send() call.
1531 * The returned value here is not useful since either way we'll return 1 to
1532 * the caller because the session daemon socket management is done
1533 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1535 ret
= consumer_send_status_msg(sock
, ret_code
);
1541 health_code_update();
1547 * Free channel here since no one has a reference to it. We don't
1548 * free after that because a stream can store this pointer.
1550 destroy_channel(channel
);
1552 /* We have to send a status channel message indicating an error. */
1553 ret
= consumer_send_status_channel(sock
, NULL
);
1555 /* Stop everything if session daemon can not be notified. */
1560 health_code_update();
1565 /* This will issue a consumer stop. */
1570 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1571 * compiled out, we isolate it in this library.
1573 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1577 assert(stream
->ustream
);
1579 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1583 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1584 * compiled out, we isolate it in this library.
1586 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1589 assert(stream
->ustream
);
1591 return ustctl_get_mmap_base(stream
->ustream
);
1595 * Take a snapshot for a specific fd
1597 * Returns 0 on success, < 0 on error
1599 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1602 assert(stream
->ustream
);
1604 return ustctl_snapshot(stream
->ustream
);
1608 * Get the produced position
1610 * Returns 0 on success, < 0 on error
1612 int lttng_ustconsumer_get_produced_snapshot(
1613 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1616 assert(stream
->ustream
);
1619 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1623 * Get the consumed position
1625 * Returns 0 on success, < 0 on error
1627 int lttng_ustconsumer_get_consumed_snapshot(
1628 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1631 assert(stream
->ustream
);
1634 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1637 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1641 assert(stream
->ustream
);
1643 ustctl_flush_buffer(stream
->ustream
, producer
);
1646 int lttng_ustconsumer_get_current_timestamp(
1647 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1650 assert(stream
->ustream
);
1653 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1657 * Called when the stream signal the consumer that it has hang up.
1659 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1662 assert(stream
->ustream
);
1664 ustctl_flush_buffer(stream
->ustream
, 0);
1665 stream
->hangup_flush_done
= 1;
1668 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1671 assert(chan
->uchan
);
1673 if (chan
->switch_timer_enabled
== 1) {
1674 consumer_timer_switch_stop(chan
);
1676 consumer_metadata_cache_destroy(chan
);
1677 ustctl_destroy_channel(chan
->uchan
);
1680 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1683 assert(stream
->ustream
);
1685 if (stream
->chan
->switch_timer_enabled
== 1) {
1686 consumer_timer_switch_stop(stream
->chan
);
1688 ustctl_destroy_stream(stream
->ustream
);
1691 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
1694 assert(stream
->ustream
);
1696 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
1699 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
1702 assert(stream
->ustream
);
1704 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
1708 * Populate index values of a UST stream. Values are set in big endian order.
1710 * Return 0 on success or else a negative value.
1712 static int get_index_values(struct ctf_packet_index
*index
,
1713 struct ustctl_consumer_stream
*ustream
)
1717 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1719 PERROR("ustctl_get_timestamp_begin");
1722 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1724 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1726 PERROR("ustctl_get_timestamp_end");
1729 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1731 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1733 PERROR("ustctl_get_events_discarded");
1736 index
->events_discarded
= htobe64(index
->events_discarded
);
1738 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1740 PERROR("ustctl_get_content_size");
1743 index
->content_size
= htobe64(index
->content_size
);
1745 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1747 PERROR("ustctl_get_packet_size");
1750 index
->packet_size
= htobe64(index
->packet_size
);
1752 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1754 PERROR("ustctl_get_stream_id");
1757 index
->stream_id
= htobe64(index
->stream_id
);
1764 * Write up to one packet from the metadata cache to the channel.
1766 * Returns the number of bytes pushed in the cache, or a negative value
1770 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1775 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1776 if (stream
->chan
->metadata_cache
->contiguous
1777 == stream
->ust_metadata_pushed
) {
1782 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1783 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1784 stream
->chan
->metadata_cache
->contiguous
1785 - stream
->ust_metadata_pushed
);
1786 assert(write_len
!= 0);
1787 if (write_len
< 0) {
1788 ERR("Writing one metadata packet");
1792 stream
->ust_metadata_pushed
+= write_len
;
1794 assert(stream
->chan
->metadata_cache
->contiguous
>=
1795 stream
->ust_metadata_pushed
);
1799 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1805 * Sync metadata meaning request them to the session daemon and snapshot to the
1806 * metadata thread can consumer them.
1808 * Metadata stream lock MUST be acquired.
1810 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1811 * is empty or a negative value on error.
1813 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1814 struct lttng_consumer_stream
*metadata
)
1823 * Request metadata from the sessiond, but don't wait for the flush
1824 * because we locked the metadata thread.
1826 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1831 ret
= commit_one_metadata_packet(metadata
);
1834 } else if (ret
> 0) {
1838 ustctl_flush_buffer(metadata
->ustream
, 1);
1839 ret
= ustctl_snapshot(metadata
->ustream
);
1841 if (errno
!= EAGAIN
) {
1842 ERR("Sync metadata, taking UST snapshot");
1845 DBG("No new metadata when syncing them.");
1846 /* No new metadata, exit. */
1852 * After this flush, we still need to extract metadata.
1863 * Return 0 on success else a negative value.
1865 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
1866 struct lttng_consumer_local_data
*ctx
)
1869 struct ustctl_consumer_stream
*ustream
;
1874 ustream
= stream
->ustream
;
1877 * First, we are going to check if there is a new subbuffer available
1878 * before reading the stream wait_fd.
1880 /* Get the next subbuffer */
1881 ret
= ustctl_get_next_subbuf(ustream
);
1883 /* No more data found, flag the stream. */
1884 stream
->has_data
= 0;
1889 ret
= ustctl_put_subbuf(ustream
);
1892 /* This stream still has data. Flag it and wake up the data thread. */
1893 stream
->has_data
= 1;
1895 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
1898 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
1899 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1904 /* The wake up pipe has been notified. */
1905 ctx
->has_wakeup
= 1;
1914 * Read subbuffer from the given stream.
1916 * Stream lock MUST be acquired.
1918 * Return 0 on success else a negative value.
1920 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1921 struct lttng_consumer_local_data
*ctx
)
1923 unsigned long len
, subbuf_size
, padding
;
1924 int err
, write_index
= 1;
1926 struct ustctl_consumer_stream
*ustream
;
1927 struct ctf_packet_index index
;
1930 assert(stream
->ustream
);
1933 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1936 /* Ease our life for what's next. */
1937 ustream
= stream
->ustream
;
1940 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
1941 * error if we cannot read this one byte (read returns 0), or if the error
1942 * is EAGAIN or EWOULDBLOCK.
1944 * This is only done when the stream is monitored by a thread, before the
1945 * flush is done after a hangup and if the stream is not flagged with data
1946 * since there might be nothing to consume in the wait fd but still have
1947 * data available flagged by the consumer wake up pipe.
1949 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
1953 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
1954 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1961 /* Get the next subbuffer */
1962 err
= ustctl_get_next_subbuf(ustream
);
1965 * Populate metadata info if the existing info has
1966 * already been read.
1968 if (stream
->metadata_flag
) {
1969 ret
= commit_one_metadata_packet(stream
);
1973 ustctl_flush_buffer(stream
->ustream
, 1);
1977 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1979 * This is a debug message even for single-threaded consumer,
1980 * because poll() have more relaxed criterions than get subbuf,
1981 * so get_subbuf may fail for short race windows where poll()
1982 * would issue wakeups.
1984 DBG("Reserving sub buffer failed (everything is normal, "
1985 "it is due to concurrency) [ret: %d]", err
);
1988 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1990 if (!stream
->metadata_flag
) {
1991 index
.offset
= htobe64(stream
->out_fd_offset
);
1992 ret
= get_index_values(&index
, ustream
);
2000 /* Get the full padded subbuffer size */
2001 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2004 /* Get subbuffer data size (without padding) */
2005 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2008 /* Make sure we don't get a subbuffer size bigger than the padded */
2009 assert(len
>= subbuf_size
);
2011 padding
= len
- subbuf_size
;
2012 /* write the subbuffer to the tracefile */
2013 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2015 * The mmap operation should write subbuf_size amount of data when network
2016 * streaming or the full padding (len) size when we are _not_ streaming.
2018 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2019 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2021 * Display the error but continue processing to try to release the
2022 * subbuffer. This is a DBG statement since any unexpected kill or
2023 * signal, the application gets unregistered, relayd gets closed or
2024 * anything that affects the buffer lifetime will trigger this error.
2025 * So, for the sake of the user, don't print this error since it can
2026 * happen and it is OK with the code flow.
2028 DBG("Error writing to tracefile "
2029 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2030 ret
, len
, subbuf_size
);
2033 err
= ustctl_put_next_subbuf(ustream
);
2037 * This will consumer the byte on the wait_fd if and only if there is not
2038 * next subbuffer to be acquired.
2040 if (!stream
->metadata_flag
) {
2041 ret
= notify_if_more_data(stream
, ctx
);
2047 /* Write index if needed. */
2052 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2054 * In live, block until all the metadata is sent.
2056 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2062 assert(!stream
->metadata_flag
);
2063 err
= consumer_stream_write_index(stream
, &index
);
2073 * Called when a stream is created.
2075 * Return 0 on success or else a negative value.
2077 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2083 /* Don't create anything if this is set for streaming. */
2084 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2085 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2086 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2087 stream
->uid
, stream
->gid
, NULL
);
2091 stream
->out_fd
= ret
;
2092 stream
->tracefile_size_current
= 0;
2094 if (!stream
->metadata_flag
) {
2095 ret
= index_create_file(stream
->chan
->pathname
,
2096 stream
->name
, stream
->uid
, stream
->gid
,
2097 stream
->chan
->tracefile_size
,
2098 stream
->tracefile_count_current
);
2102 stream
->index_fd
= ret
;
2112 * Check if data is still being extracted from the buffers for a specific
2113 * stream. Consumer data lock MUST be acquired before calling this function
2114 * and the stream lock.
2116 * Return 1 if the traced data are still getting read else 0 meaning that the
2117 * data is available for trace viewer reading.
2119 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2124 assert(stream
->ustream
);
2126 DBG("UST consumer checking data pending");
2128 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2133 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2134 uint64_t contiguous
, pushed
;
2136 /* Ease our life a bit. */
2137 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
2138 pushed
= stream
->ust_metadata_pushed
;
2141 * We can simply check whether all contiguously available data
2142 * has been pushed to the ring buffer, since the push operation
2143 * is performed within get_next_subbuf(), and because both
2144 * get_next_subbuf() and put_next_subbuf() are issued atomically
2145 * thanks to the stream lock within
2146 * lttng_ustconsumer_read_subbuffer(). This basically means that
2147 * whetnever ust_metadata_pushed is incremented, the associated
2148 * metadata has been consumed from the metadata stream.
2150 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2151 contiguous
, pushed
);
2152 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2153 if ((contiguous
!= pushed
) ||
2154 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2155 ret
= 1; /* Data is pending */
2159 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2162 * There is still data so let's put back this
2165 ret
= ustctl_put_subbuf(stream
->ustream
);
2167 ret
= 1; /* Data is pending */
2172 /* Data is NOT pending so ready to be read. */
2180 * Stop a given metadata channel timer if enabled and close the wait fd which
2181 * is the poll pipe of the metadata stream.
2183 * This MUST be called with the metadata channel acquired.
2185 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2190 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2192 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2194 if (metadata
->switch_timer_enabled
== 1) {
2195 consumer_timer_switch_stop(metadata
);
2198 if (!metadata
->metadata_stream
) {
2203 * Closing write side so the thread monitoring the stream wakes up if any
2204 * and clean the metadata stream.
2206 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2207 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2209 PERROR("closing metadata pipe write side");
2211 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2219 * Close every metadata stream wait fd of the metadata hash table. This
2220 * function MUST be used very carefully so not to run into a race between the
2221 * metadata thread handling streams and this function closing their wait fd.
2223 * For UST, this is used when the session daemon hangs up. Its the metadata
2224 * producer so calling this is safe because we are assured that no state change
2225 * can occur in the metadata thread for the streams in the hash table.
2227 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2229 struct lttng_ht_iter iter
;
2230 struct lttng_consumer_stream
*stream
;
2232 assert(metadata_ht
);
2233 assert(metadata_ht
->ht
);
2235 DBG("UST consumer closing all metadata streams");
2238 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2241 health_code_update();
2243 pthread_mutex_lock(&stream
->chan
->lock
);
2244 lttng_ustconsumer_close_metadata(stream
->chan
);
2245 pthread_mutex_unlock(&stream
->chan
->lock
);
2251 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2255 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2257 ERR("Unable to close wakeup fd");
2262 * Please refer to consumer-timer.c before adding any lock within this
2263 * function or any of its callees. Timers have a very strict locking
2264 * semantic with respect to teardown. Failure to respect this semantic
2265 * introduces deadlocks.
2267 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2268 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2270 struct lttcomm_metadata_request_msg request
;
2271 struct lttcomm_consumer_msg msg
;
2272 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2273 uint64_t len
, key
, offset
;
2277 assert(channel
->metadata_cache
);
2279 memset(&request
, 0, sizeof(request
));
2281 /* send the metadata request to sessiond */
2282 switch (consumer_data
.type
) {
2283 case LTTNG_CONSUMER64_UST
:
2284 request
.bits_per_long
= 64;
2286 case LTTNG_CONSUMER32_UST
:
2287 request
.bits_per_long
= 32;
2290 request
.bits_per_long
= 0;
2294 request
.session_id
= channel
->session_id
;
2295 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2297 * Request the application UID here so the metadata of that application can
2298 * be sent back. The channel UID corresponds to the user UID of the session
2299 * used for the rights on the stream file(s).
2301 request
.uid
= channel
->ust_app_uid
;
2302 request
.key
= channel
->key
;
2304 DBG("Sending metadata request to sessiond, session id %" PRIu64
2305 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2306 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2309 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2311 health_code_update();
2313 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2316 ERR("Asking metadata to sessiond");
2320 health_code_update();
2322 /* Receive the metadata from sessiond */
2323 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2325 if (ret
!= sizeof(msg
)) {
2326 DBG("Consumer received unexpected message size %d (expects %zu)",
2328 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2330 * The ret value might 0 meaning an orderly shutdown but this is ok
2331 * since the caller handles this.
2336 health_code_update();
2338 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2339 /* No registry found */
2340 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2344 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2345 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2350 len
= msg
.u
.push_metadata
.len
;
2351 key
= msg
.u
.push_metadata
.key
;
2352 offset
= msg
.u
.push_metadata
.target_offset
;
2354 assert(key
== channel
->key
);
2356 DBG("No new metadata to receive for key %" PRIu64
, key
);
2359 health_code_update();
2361 /* Tell session daemon we are ready to receive the metadata. */
2362 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2363 LTTCOMM_CONSUMERD_SUCCESS
);
2364 if (ret
< 0 || len
== 0) {
2366 * Somehow, the session daemon is not responding anymore or there is
2367 * nothing to receive.
2372 health_code_update();
2374 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2375 key
, offset
, len
, channel
, timer
, wait
);
2378 * Only send the status msg if the sessiond is alive meaning a positive
2381 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2386 health_code_update();
2388 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2393 * Return the ustctl call for the get stream id.
2395 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2396 uint64_t *stream_id
)
2401 return ustctl_get_stream_id(stream
->ustream
, stream_id
);