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 max_stream_size
, 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 asume that the session
945 * daemon should never send a maximum stream size that is lower than
948 consumed_pos
= consumer_get_consumed_maxsize(consumed_pos
,
949 produced_pos
, max_stream_size
);
951 while (consumed_pos
< produced_pos
) {
953 unsigned long len
, padded_len
;
955 health_code_update();
957 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
959 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
961 if (ret
!= -EAGAIN
) {
962 PERROR("ustctl_get_subbuf snapshot");
963 goto error_close_stream
;
965 DBG("UST consumer get subbuf failed. Skipping it.");
966 consumed_pos
+= stream
->max_sb_size
;
970 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
972 ERR("Snapshot ustctl_get_subbuf_size");
973 goto error_put_subbuf
;
976 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
978 ERR("Snapshot ustctl_get_padded_subbuf_size");
979 goto error_put_subbuf
;
982 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
983 padded_len
- len
, NULL
);
985 if (read_len
!= len
) {
987 goto error_put_subbuf
;
990 if (read_len
!= padded_len
) {
992 goto error_put_subbuf
;
996 ret
= ustctl_put_subbuf(stream
->ustream
);
998 ERR("Snapshot ustctl_put_subbuf");
999 goto error_close_stream
;
1001 consumed_pos
+= stream
->max_sb_size
;
1004 /* Simply close the stream so we can use it on the next snapshot. */
1005 consumer_stream_close(stream
);
1006 pthread_mutex_unlock(&stream
->lock
);
1013 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1014 ERR("Snapshot ustctl_put_subbuf");
1017 consumer_stream_close(stream
);
1019 pthread_mutex_unlock(&stream
->lock
);
1026 * Receive the metadata updates from the sessiond.
1028 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1029 uint64_t len
, struct lttng_consumer_channel
*channel
,
1030 int timer
, int wait
)
1032 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1035 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1037 metadata_str
= zmalloc(len
* sizeof(char));
1038 if (!metadata_str
) {
1039 PERROR("zmalloc metadata string");
1040 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1044 health_code_update();
1046 /* Receive metadata string. */
1047 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1049 /* Session daemon is dead so return gracefully. */
1054 health_code_update();
1056 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1057 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1059 /* Unable to handle metadata. Notify session daemon. */
1060 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1062 * Skip metadata flush on write error since the offset and len might
1063 * not have been updated which could create an infinite loop below when
1064 * waiting for the metadata cache to be flushed.
1066 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1069 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1074 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1075 DBG("Waiting for metadata to be flushed");
1077 health_code_update();
1079 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1089 * Receive command from session daemon and process it.
1091 * Return 1 on success else a negative value or 0.
1093 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1094 int sock
, struct pollfd
*consumer_sockpoll
)
1097 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1098 struct lttcomm_consumer_msg msg
;
1099 struct lttng_consumer_channel
*channel
= NULL
;
1101 health_code_update();
1103 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1104 if (ret
!= sizeof(msg
)) {
1105 DBG("Consumer received unexpected message size %zd (expects %zu)",
1108 * The ret value might 0 meaning an orderly shutdown but this is ok
1109 * since the caller handles this.
1112 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1118 health_code_update();
1121 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1123 health_code_update();
1125 /* relayd needs RCU read-side lock */
1128 switch (msg
.cmd_type
) {
1129 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1131 /* Session daemon status message are handled in the following call. */
1132 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1133 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1134 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1135 msg
.u
.relayd_sock
.relayd_session_id
);
1138 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1140 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1141 struct consumer_relayd_sock_pair
*relayd
;
1143 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1145 /* Get relayd reference if exists. */
1146 relayd
= consumer_find_relayd(index
);
1147 if (relayd
== NULL
) {
1148 DBG("Unable to find relayd %" PRIu64
, index
);
1149 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1153 * Each relayd socket pair has a refcount of stream attached to it
1154 * which tells if the relayd is still active or not depending on the
1157 * This will set the destroy flag of the relayd object and destroy it
1158 * if the refcount reaches zero when called.
1160 * The destroy can happen either here or when a stream fd hangs up.
1163 consumer_flag_relayd_for_destroy(relayd
);
1166 goto end_msg_sessiond
;
1168 case LTTNG_CONSUMER_UPDATE_STREAM
:
1173 case LTTNG_CONSUMER_DATA_PENDING
:
1175 int ret
, is_data_pending
;
1176 uint64_t id
= msg
.u
.data_pending
.session_id
;
1178 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1180 is_data_pending
= consumer_data_pending(id
);
1182 /* Send back returned value to session daemon */
1183 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1184 sizeof(is_data_pending
));
1186 DBG("Error when sending the data pending ret code: %d", ret
);
1191 * No need to send back a status message since the data pending
1192 * returned value is the response.
1196 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1199 struct ustctl_consumer_channel_attr attr
;
1201 /* Create a plain object and reserve a channel key. */
1202 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1203 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1204 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1205 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1206 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1207 msg
.u
.ask_channel
.tracefile_size
,
1208 msg
.u
.ask_channel
.tracefile_count
,
1209 msg
.u
.ask_channel
.session_id_per_pid
,
1210 msg
.u
.ask_channel
.monitor
,
1211 msg
.u
.ask_channel
.live_timer_interval
);
1213 goto end_channel_error
;
1217 * Assign UST application UID to the channel. This value is ignored for
1218 * per PID buffers. This is specific to UST thus setting this after the
1221 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1223 /* Build channel attributes from received message. */
1224 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1225 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1226 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1227 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1228 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1229 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1230 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1232 /* Match channel buffer type to the UST abi. */
1233 switch (msg
.u
.ask_channel
.output
) {
1234 case LTTNG_EVENT_MMAP
:
1236 attr
.output
= LTTNG_UST_MMAP
;
1240 /* Translate and save channel type. */
1241 switch (msg
.u
.ask_channel
.type
) {
1242 case LTTNG_UST_CHAN_PER_CPU
:
1243 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1244 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1246 * Set refcount to 1 for owner. Below, we will
1247 * pass ownership to the
1248 * consumer_thread_channel_poll() thread.
1250 channel
->refcount
= 1;
1252 case LTTNG_UST_CHAN_METADATA
:
1253 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1254 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1261 health_code_update();
1263 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1265 goto end_channel_error
;
1268 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1269 ret
= consumer_metadata_cache_allocate(channel
);
1271 ERR("Allocating metadata cache");
1272 goto end_channel_error
;
1274 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1275 attr
.switch_timer_interval
= 0;
1277 consumer_timer_live_start(channel
,
1278 msg
.u
.ask_channel
.live_timer_interval
);
1281 health_code_update();
1284 * Add the channel to the internal state AFTER all streams were created
1285 * and successfully sent to session daemon. This way, all streams must
1286 * be ready before this channel is visible to the threads.
1287 * If add_channel succeeds, ownership of the channel is
1288 * passed to consumer_thread_channel_poll().
1290 ret
= add_channel(channel
, ctx
);
1292 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1293 if (channel
->switch_timer_enabled
== 1) {
1294 consumer_timer_switch_stop(channel
);
1296 consumer_metadata_cache_destroy(channel
);
1298 if (channel
->live_timer_enabled
== 1) {
1299 consumer_timer_live_stop(channel
);
1301 goto end_channel_error
;
1304 health_code_update();
1307 * Channel and streams are now created. Inform the session daemon that
1308 * everything went well and should wait to receive the channel and
1309 * streams with ustctl API.
1311 ret
= consumer_send_status_channel(sock
, channel
);
1314 * There is probably a problem on the socket.
1321 case LTTNG_CONSUMER_GET_CHANNEL
:
1323 int ret
, relayd_err
= 0;
1324 uint64_t key
= msg
.u
.get_channel
.key
;
1325 struct lttng_consumer_channel
*channel
;
1327 channel
= consumer_find_channel(key
);
1329 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1330 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1331 goto end_msg_sessiond
;
1334 health_code_update();
1336 /* Send everything to sessiond. */
1337 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1341 * We were unable to send to the relayd the stream so avoid
1342 * sending back a fatal error to the thread since this is OK
1343 * and the consumer can continue its work. The above call
1344 * has sent the error status message to the sessiond.
1349 * The communicaton was broken hence there is a bad state between
1350 * the consumer and sessiond so stop everything.
1355 health_code_update();
1358 * In no monitor mode, the streams ownership is kept inside the channel
1359 * so don't send them to the data thread.
1361 if (!channel
->monitor
) {
1362 goto end_msg_sessiond
;
1365 ret
= send_streams_to_thread(channel
, ctx
);
1368 * If we are unable to send the stream to the thread, there is
1369 * a big problem so just stop everything.
1373 /* List MUST be empty after or else it could be reused. */
1374 assert(cds_list_empty(&channel
->streams
.head
));
1375 goto end_msg_sessiond
;
1377 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1379 uint64_t key
= msg
.u
.destroy_channel
.key
;
1382 * Only called if streams have not been sent to stream
1383 * manager thread. However, channel has been sent to
1384 * channel manager thread.
1386 notify_thread_del_channel(ctx
, key
);
1387 goto end_msg_sessiond
;
1389 case LTTNG_CONSUMER_CLOSE_METADATA
:
1393 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1398 goto end_msg_sessiond
;
1400 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1404 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1409 goto end_msg_sessiond
;
1411 case LTTNG_CONSUMER_PUSH_METADATA
:
1414 uint64_t len
= msg
.u
.push_metadata
.len
;
1415 uint64_t key
= msg
.u
.push_metadata
.key
;
1416 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1417 struct lttng_consumer_channel
*channel
;
1419 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1422 channel
= consumer_find_channel(key
);
1425 * This is possible if the metadata creation on the consumer side
1426 * is in flight vis-a-vis a concurrent push metadata from the
1427 * session daemon. Simply return that the channel failed and the
1428 * session daemon will handle that message correctly considering
1429 * that this race is acceptable thus the DBG() statement here.
1431 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1432 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1433 goto end_msg_sessiond
;
1436 health_code_update();
1438 /* Tell session daemon we are ready to receive the metadata. */
1439 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1441 /* Somehow, the session daemon is not responding anymore. */
1445 health_code_update();
1447 /* Wait for more data. */
1448 health_poll_entry();
1449 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1455 health_code_update();
1457 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1458 len
, channel
, 0, 1);
1460 /* error receiving from sessiond */
1464 goto end_msg_sessiond
;
1467 case LTTNG_CONSUMER_SETUP_METADATA
:
1471 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1475 goto end_msg_sessiond
;
1477 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1479 if (msg
.u
.snapshot_channel
.metadata
) {
1480 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1481 msg
.u
.snapshot_channel
.pathname
,
1482 msg
.u
.snapshot_channel
.relayd_id
,
1485 ERR("Snapshot metadata failed");
1486 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1489 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1490 msg
.u
.snapshot_channel
.pathname
,
1491 msg
.u
.snapshot_channel
.relayd_id
,
1492 msg
.u
.snapshot_channel
.max_stream_size
,
1495 ERR("Snapshot channel failed");
1496 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1500 health_code_update();
1501 ret
= consumer_send_status_msg(sock
, ret_code
);
1503 /* Somehow, the session daemon is not responding anymore. */
1506 health_code_update();
1516 health_code_update();
1519 * Return 1 to indicate success since the 0 value can be a socket
1520 * shutdown during the recv() or send() call.
1526 * The returned value here is not useful since either way we'll return 1 to
1527 * the caller because the session daemon socket management is done
1528 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1530 ret
= consumer_send_status_msg(sock
, ret_code
);
1536 health_code_update();
1542 * Free channel here since no one has a reference to it. We don't
1543 * free after that because a stream can store this pointer.
1545 destroy_channel(channel
);
1547 /* We have to send a status channel message indicating an error. */
1548 ret
= consumer_send_status_channel(sock
, NULL
);
1550 /* Stop everything if session daemon can not be notified. */
1555 health_code_update();
1560 /* This will issue a consumer stop. */
1565 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1566 * compiled out, we isolate it in this library.
1568 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1572 assert(stream
->ustream
);
1574 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1578 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1579 * compiled out, we isolate it in this library.
1581 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1584 assert(stream
->ustream
);
1586 return ustctl_get_mmap_base(stream
->ustream
);
1590 * Take a snapshot for a specific fd
1592 * Returns 0 on success, < 0 on error
1594 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1597 assert(stream
->ustream
);
1599 return ustctl_snapshot(stream
->ustream
);
1603 * Get the produced position
1605 * Returns 0 on success, < 0 on error
1607 int lttng_ustconsumer_get_produced_snapshot(
1608 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1611 assert(stream
->ustream
);
1614 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1618 * Get the consumed position
1620 * Returns 0 on success, < 0 on error
1622 int lttng_ustconsumer_get_consumed_snapshot(
1623 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1626 assert(stream
->ustream
);
1629 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1632 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1636 assert(stream
->ustream
);
1638 ustctl_flush_buffer(stream
->ustream
, producer
);
1641 int lttng_ustconsumer_get_current_timestamp(
1642 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1645 assert(stream
->ustream
);
1648 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1652 * Called when the stream signal the consumer that it has hang up.
1654 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1657 assert(stream
->ustream
);
1659 ustctl_flush_buffer(stream
->ustream
, 0);
1660 stream
->hangup_flush_done
= 1;
1663 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1666 assert(chan
->uchan
);
1668 if (chan
->switch_timer_enabled
== 1) {
1669 consumer_timer_switch_stop(chan
);
1671 consumer_metadata_cache_destroy(chan
);
1672 ustctl_destroy_channel(chan
->uchan
);
1675 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1678 assert(stream
->ustream
);
1680 if (stream
->chan
->switch_timer_enabled
== 1) {
1681 consumer_timer_switch_stop(stream
->chan
);
1683 ustctl_destroy_stream(stream
->ustream
);
1686 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
1689 assert(stream
->ustream
);
1691 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
1694 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
1697 assert(stream
->ustream
);
1699 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
1703 * Populate index values of a UST stream. Values are set in big endian order.
1705 * Return 0 on success or else a negative value.
1707 static int get_index_values(struct ctf_packet_index
*index
,
1708 struct ustctl_consumer_stream
*ustream
)
1712 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1714 PERROR("ustctl_get_timestamp_begin");
1717 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1719 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1721 PERROR("ustctl_get_timestamp_end");
1724 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1726 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1728 PERROR("ustctl_get_events_discarded");
1731 index
->events_discarded
= htobe64(index
->events_discarded
);
1733 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1735 PERROR("ustctl_get_content_size");
1738 index
->content_size
= htobe64(index
->content_size
);
1740 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1742 PERROR("ustctl_get_packet_size");
1745 index
->packet_size
= htobe64(index
->packet_size
);
1747 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1749 PERROR("ustctl_get_stream_id");
1752 index
->stream_id
= htobe64(index
->stream_id
);
1759 * Write up to one packet from the metadata cache to the channel.
1761 * Returns the number of bytes pushed in the cache, or a negative value
1765 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1770 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1771 if (stream
->chan
->metadata_cache
->contiguous
1772 == stream
->ust_metadata_pushed
) {
1777 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1778 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1779 stream
->chan
->metadata_cache
->contiguous
1780 - stream
->ust_metadata_pushed
);
1781 assert(write_len
!= 0);
1782 if (write_len
< 0) {
1783 ERR("Writing one metadata packet");
1787 stream
->ust_metadata_pushed
+= write_len
;
1789 assert(stream
->chan
->metadata_cache
->contiguous
>=
1790 stream
->ust_metadata_pushed
);
1794 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1800 * Sync metadata meaning request them to the session daemon and snapshot to the
1801 * metadata thread can consumer them.
1803 * Metadata stream lock MUST be acquired.
1805 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1806 * is empty or a negative value on error.
1808 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1809 struct lttng_consumer_stream
*metadata
)
1818 * Request metadata from the sessiond, but don't wait for the flush
1819 * because we locked the metadata thread.
1821 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1826 ret
= commit_one_metadata_packet(metadata
);
1829 } else if (ret
> 0) {
1833 ustctl_flush_buffer(metadata
->ustream
, 1);
1834 ret
= ustctl_snapshot(metadata
->ustream
);
1836 if (errno
!= EAGAIN
) {
1837 ERR("Sync metadata, taking UST snapshot");
1840 DBG("No new metadata when syncing them.");
1841 /* No new metadata, exit. */
1847 * After this flush, we still need to extract metadata.
1858 * Return 0 on success else a negative value.
1860 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
1861 struct lttng_consumer_local_data
*ctx
)
1864 struct ustctl_consumer_stream
*ustream
;
1869 ustream
= stream
->ustream
;
1872 * First, we are going to check if there is a new subbuffer available
1873 * before reading the stream wait_fd.
1875 /* Get the next subbuffer */
1876 ret
= ustctl_get_next_subbuf(ustream
);
1878 /* No more data found, flag the stream. */
1879 stream
->has_data
= 0;
1884 ret
= ustctl_put_next_subbuf(ustream
);
1887 /* This stream still has data. Flag it and wake up the data thread. */
1888 stream
->has_data
= 1;
1890 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
1893 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
1894 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1899 /* The wake up pipe has been notified. */
1900 ctx
->has_wakeup
= 1;
1909 * Read subbuffer from the given stream.
1911 * Stream lock MUST be acquired.
1913 * Return 0 on success else a negative value.
1915 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1916 struct lttng_consumer_local_data
*ctx
)
1918 unsigned long len
, subbuf_size
, padding
;
1919 int err
, write_index
= 1;
1921 struct ustctl_consumer_stream
*ustream
;
1922 struct ctf_packet_index index
;
1925 assert(stream
->ustream
);
1928 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1931 /* Ease our life for what's next. */
1932 ustream
= stream
->ustream
;
1935 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
1936 * error if we cannot read this one byte (read returns 0), or if the error
1937 * is EAGAIN or EWOULDBLOCK.
1939 * This is only done when the stream is monitored by a thread, before the
1940 * flush is done after a hangup and if the stream is not flagged with data
1941 * since there might be nothing to consume in the wait fd but still have
1942 * data available flagged by the consumer wake up pipe.
1944 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
1948 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
1949 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1956 /* Get the next subbuffer */
1957 err
= ustctl_get_next_subbuf(ustream
);
1960 * Populate metadata info if the existing info has
1961 * already been read.
1963 if (stream
->metadata_flag
) {
1964 ret
= commit_one_metadata_packet(stream
);
1968 ustctl_flush_buffer(stream
->ustream
, 1);
1972 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1974 * This is a debug message even for single-threaded consumer,
1975 * because poll() have more relaxed criterions than get subbuf,
1976 * so get_subbuf may fail for short race windows where poll()
1977 * would issue wakeups.
1979 DBG("Reserving sub buffer failed (everything is normal, "
1980 "it is due to concurrency) [ret: %d]", err
);
1983 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1985 if (!stream
->metadata_flag
) {
1986 index
.offset
= htobe64(stream
->out_fd_offset
);
1987 ret
= get_index_values(&index
, ustream
);
1995 /* Get the full padded subbuffer size */
1996 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1999 /* Get subbuffer data size (without padding) */
2000 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2003 /* Make sure we don't get a subbuffer size bigger than the padded */
2004 assert(len
>= subbuf_size
);
2006 padding
= len
- subbuf_size
;
2007 /* write the subbuffer to the tracefile */
2008 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2010 * The mmap operation should write subbuf_size amount of data when network
2011 * streaming or the full padding (len) size when we are _not_ streaming.
2013 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2014 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2016 * Display the error but continue processing to try to release the
2017 * subbuffer. This is a DBG statement since any unexpected kill or
2018 * signal, the application gets unregistered, relayd gets closed or
2019 * anything that affects the buffer lifetime will trigger this error.
2020 * So, for the sake of the user, don't print this error since it can
2021 * happen and it is OK with the code flow.
2023 DBG("Error writing to tracefile "
2024 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2025 ret
, len
, subbuf_size
);
2028 err
= ustctl_put_next_subbuf(ustream
);
2032 * This will consumer the byte on the wait_fd if and only if there is not
2033 * next subbuffer to be acquired.
2035 if (!stream
->metadata_flag
) {
2036 ret
= notify_if_more_data(stream
, ctx
);
2042 /* Write index if needed. */
2047 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2049 * In live, block until all the metadata is sent.
2051 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2057 assert(!stream
->metadata_flag
);
2058 err
= consumer_stream_write_index(stream
, &index
);
2068 * Called when a stream is created.
2070 * Return 0 on success or else a negative value.
2072 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2078 /* Don't create anything if this is set for streaming. */
2079 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2080 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2081 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2082 stream
->uid
, stream
->gid
, NULL
);
2086 stream
->out_fd
= ret
;
2087 stream
->tracefile_size_current
= 0;
2089 if (!stream
->metadata_flag
) {
2090 ret
= index_create_file(stream
->chan
->pathname
,
2091 stream
->name
, stream
->uid
, stream
->gid
,
2092 stream
->chan
->tracefile_size
,
2093 stream
->tracefile_count_current
);
2097 stream
->index_fd
= ret
;
2107 * Check if data is still being extracted from the buffers for a specific
2108 * stream. Consumer data lock MUST be acquired before calling this function
2109 * and the stream lock.
2111 * Return 1 if the traced data are still getting read else 0 meaning that the
2112 * data is available for trace viewer reading.
2114 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2119 assert(stream
->ustream
);
2121 DBG("UST consumer checking data pending");
2123 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2128 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2129 uint64_t contiguous
, pushed
;
2131 /* Ease our life a bit. */
2132 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
2133 pushed
= stream
->ust_metadata_pushed
;
2136 * We can simply check whether all contiguously available data
2137 * has been pushed to the ring buffer, since the push operation
2138 * is performed within get_next_subbuf(), and because both
2139 * get_next_subbuf() and put_next_subbuf() are issued atomically
2140 * thanks to the stream lock within
2141 * lttng_ustconsumer_read_subbuffer(). This basically means that
2142 * whetnever ust_metadata_pushed is incremented, the associated
2143 * metadata has been consumed from the metadata stream.
2145 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2146 contiguous
, pushed
);
2147 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2148 if ((contiguous
!= pushed
) ||
2149 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2150 ret
= 1; /* Data is pending */
2154 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2157 * There is still data so let's put back this
2160 ret
= ustctl_put_subbuf(stream
->ustream
);
2162 ret
= 1; /* Data is pending */
2167 /* Data is NOT pending so ready to be read. */
2175 * Stop a given metadata channel timer if enabled and close the wait fd which
2176 * is the poll pipe of the metadata stream.
2178 * This MUST be called with the metadata channel acquired.
2180 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2185 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2187 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2189 if (metadata
->switch_timer_enabled
== 1) {
2190 consumer_timer_switch_stop(metadata
);
2193 if (!metadata
->metadata_stream
) {
2198 * Closing write side so the thread monitoring the stream wakes up if any
2199 * and clean the metadata stream.
2201 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2202 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2204 PERROR("closing metadata pipe write side");
2206 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2214 * Close every metadata stream wait fd of the metadata hash table. This
2215 * function MUST be used very carefully so not to run into a race between the
2216 * metadata thread handling streams and this function closing their wait fd.
2218 * For UST, this is used when the session daemon hangs up. Its the metadata
2219 * producer so calling this is safe because we are assured that no state change
2220 * can occur in the metadata thread for the streams in the hash table.
2222 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2224 struct lttng_ht_iter iter
;
2225 struct lttng_consumer_stream
*stream
;
2227 assert(metadata_ht
);
2228 assert(metadata_ht
->ht
);
2230 DBG("UST consumer closing all metadata streams");
2233 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2236 health_code_update();
2238 pthread_mutex_lock(&stream
->chan
->lock
);
2239 lttng_ustconsumer_close_metadata(stream
->chan
);
2240 pthread_mutex_unlock(&stream
->chan
->lock
);
2246 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2250 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2252 ERR("Unable to close wakeup fd");
2257 * Please refer to consumer-timer.c before adding any lock within this
2258 * function or any of its callees. Timers have a very strict locking
2259 * semantic with respect to teardown. Failure to respect this semantic
2260 * introduces deadlocks.
2262 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2263 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2265 struct lttcomm_metadata_request_msg request
;
2266 struct lttcomm_consumer_msg msg
;
2267 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2268 uint64_t len
, key
, offset
;
2272 assert(channel
->metadata_cache
);
2274 memset(&request
, 0, sizeof(request
));
2276 /* send the metadata request to sessiond */
2277 switch (consumer_data
.type
) {
2278 case LTTNG_CONSUMER64_UST
:
2279 request
.bits_per_long
= 64;
2281 case LTTNG_CONSUMER32_UST
:
2282 request
.bits_per_long
= 32;
2285 request
.bits_per_long
= 0;
2289 request
.session_id
= channel
->session_id
;
2290 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2292 * Request the application UID here so the metadata of that application can
2293 * be sent back. The channel UID corresponds to the user UID of the session
2294 * used for the rights on the stream file(s).
2296 request
.uid
= channel
->ust_app_uid
;
2297 request
.key
= channel
->key
;
2299 DBG("Sending metadata request to sessiond, session id %" PRIu64
2300 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2301 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2304 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2306 health_code_update();
2308 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2311 ERR("Asking metadata to sessiond");
2315 health_code_update();
2317 /* Receive the metadata from sessiond */
2318 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2320 if (ret
!= sizeof(msg
)) {
2321 DBG("Consumer received unexpected message size %d (expects %zu)",
2323 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2325 * The ret value might 0 meaning an orderly shutdown but this is ok
2326 * since the caller handles this.
2331 health_code_update();
2333 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2334 /* No registry found */
2335 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2339 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2340 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2345 len
= msg
.u
.push_metadata
.len
;
2346 key
= msg
.u
.push_metadata
.key
;
2347 offset
= msg
.u
.push_metadata
.target_offset
;
2349 assert(key
== channel
->key
);
2351 DBG("No new metadata to receive for key %" PRIu64
, key
);
2354 health_code_update();
2356 /* Tell session daemon we are ready to receive the metadata. */
2357 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2358 LTTCOMM_CONSUMERD_SUCCESS
);
2359 if (ret
< 0 || len
== 0) {
2361 * Somehow, the session daemon is not responding anymore or there is
2362 * nothing to receive.
2367 health_code_update();
2369 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2370 key
, offset
, len
, channel
, timer
, wait
);
2373 * Only send the status msg if the sessiond is alive meaning a positive
2376 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2381 health_code_update();
2383 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2388 * Return the ustctl call for the get stream id.
2390 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2391 uint64_t *stream_id
)
2396 return ustctl_get_stream_id(stream
->ustream
, stream_id
);