2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <lttng/ust-ctl.h>
27 #include <sys/socket.h>
29 #include <sys/types.h>
32 #include <urcu/list.h>
35 #include <common/common.h>
36 #include <common/sessiond-comm/sessiond-comm.h>
37 #include <common/relayd/relayd.h>
38 #include <common/compat/fcntl.h>
39 #include <common/consumer-metadata-cache.h>
40 #include <common/consumer-stream.h>
41 #include <common/consumer-timer.h>
42 #include <common/utils.h>
43 #include <common/index/index.h>
45 #include "ust-consumer.h"
47 extern struct lttng_consumer_global_data consumer_data
;
48 extern int consumer_poll_timeout
;
49 extern volatile int consumer_quit
;
52 * Free channel object and all streams associated with it. This MUST be used
53 * only and only if the channel has _NEVER_ been added to the global channel
56 static void destroy_channel(struct lttng_consumer_channel
*channel
)
58 struct lttng_consumer_stream
*stream
, *stmp
;
62 DBG("UST consumer cleaning stream list");
64 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
66 cds_list_del(&stream
->send_node
);
67 ustctl_destroy_stream(stream
->ustream
);
72 * If a channel is available meaning that was created before the streams
76 lttng_ustconsumer_del_channel(channel
);
82 * Add channel to internal consumer state.
84 * Returns 0 on success or else a negative value.
86 static int add_channel(struct lttng_consumer_channel
*channel
,
87 struct lttng_consumer_local_data
*ctx
)
94 if (ctx
->on_recv_channel
!= NULL
) {
95 ret
= ctx
->on_recv_channel(channel
);
97 ret
= consumer_add_channel(channel
, ctx
);
99 /* Most likely an ENOMEM. */
100 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
104 ret
= consumer_add_channel(channel
, ctx
);
107 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
114 * Allocate and return a consumer channel object.
116 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
117 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
118 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
119 uint64_t tracefile_size
, uint64_t tracefile_count
,
120 uint64_t session_id_per_pid
, unsigned int monitor
,
121 unsigned int live_timer_interval
)
126 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
127 gid
, relayd_id
, output
, tracefile_size
,
128 tracefile_count
, session_id_per_pid
, monitor
, live_timer_interval
);
132 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
133 * error value if applicable is set in it else it is kept untouched.
135 * Return NULL on error else the newly allocated stream object.
137 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
138 struct lttng_consumer_channel
*channel
,
139 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
142 struct lttng_consumer_stream
*stream
= NULL
;
147 stream
= consumer_allocate_stream(channel
->key
,
149 LTTNG_CONSUMER_ACTIVE_STREAM
,
159 if (stream
== NULL
) {
163 * We could not find the channel. Can happen if cpu hotplug
164 * happens while tearing down.
166 DBG3("Could not find channel");
171 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
177 stream
->chan
= channel
;
181 *_alloc_ret
= alloc_ret
;
187 * Send the given stream pointer to the corresponding thread.
189 * Returns 0 on success else a negative value.
191 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
192 struct lttng_consumer_local_data
*ctx
)
195 struct lttng_pipe
*stream_pipe
;
197 /* Get the right pipe where the stream will be sent. */
198 if (stream
->metadata_flag
) {
199 ret
= consumer_add_metadata_stream(stream
);
201 ERR("Consumer add metadata stream %" PRIu64
" failed.",
205 stream_pipe
= ctx
->consumer_metadata_pipe
;
207 ret
= consumer_add_data_stream(stream
);
209 ERR("Consumer add stream %" PRIu64
" failed.",
213 stream_pipe
= ctx
->consumer_data_pipe
;
217 * From this point on, the stream's ownership has been moved away from
218 * the channel and becomes globally visible.
220 stream
->globally_visible
= 1;
222 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
224 ERR("Consumer write %s stream to pipe %d",
225 stream
->metadata_flag
? "metadata" : "data",
226 lttng_pipe_get_writefd(stream_pipe
));
227 if (stream
->metadata_flag
) {
228 consumer_del_stream_for_metadata(stream
);
230 consumer_del_stream_for_data(stream
);
238 * Create streams for the given channel using liblttng-ust-ctl.
240 * Return 0 on success else a negative value.
242 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
243 struct lttng_consumer_local_data
*ctx
)
246 struct ustctl_consumer_stream
*ustream
;
247 struct lttng_consumer_stream
*stream
;
253 * While a stream is available from ustctl. When NULL is returned, we've
254 * reached the end of the possible stream for the channel.
256 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
258 int ust_metadata_pipe
[2];
260 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
261 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
263 ERR("Create ust metadata poll pipe");
266 wait_fd
= ust_metadata_pipe
[0];
268 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
271 /* Allocate consumer stream object. */
272 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
276 stream
->ustream
= ustream
;
278 * Store it so we can save multiple function calls afterwards since
279 * this value is used heavily in the stream threads. This is UST
280 * specific so this is why it's done after allocation.
282 stream
->wait_fd
= wait_fd
;
285 * Increment channel refcount since the channel reference has now been
286 * assigned in the allocation process above.
288 if (stream
->chan
->monitor
) {
289 uatomic_inc(&stream
->chan
->refcount
);
293 * Order is important this is why a list is used. On error, the caller
294 * should clean this list.
296 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
298 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
299 &stream
->max_sb_size
);
301 ERR("ustctl_get_max_subbuf_size failed for stream %s",
306 /* Do actions once stream has been received. */
307 if (ctx
->on_recv_stream
) {
308 ret
= ctx
->on_recv_stream(stream
);
314 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
315 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
317 /* Set next CPU stream. */
318 channel
->streams
.count
= ++cpu
;
320 /* Keep stream reference when creating metadata. */
321 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
322 channel
->metadata_stream
= stream
;
323 stream
->ust_metadata_poll_pipe
[0] = ust_metadata_pipe
[0];
324 stream
->ust_metadata_poll_pipe
[1] = ust_metadata_pipe
[1];
336 * Create an UST channel with the given attributes and send it to the session
337 * daemon using the ust ctl API.
339 * Return 0 on success or else a negative value.
341 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
342 struct ustctl_consumer_channel
**chanp
)
345 struct ustctl_consumer_channel
*channel
;
350 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
351 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
352 "switch_timer_interval: %u, read_timer_interval: %u, "
353 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
354 attr
->num_subbuf
, attr
->switch_timer_interval
,
355 attr
->read_timer_interval
, attr
->output
, attr
->type
);
357 channel
= ustctl_create_channel(attr
);
372 * Send a single given stream to the session daemon using the sock.
374 * Return 0 on success else a negative value.
376 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
383 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
385 /* Send stream to session daemon. */
386 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
396 * Send channel to sessiond.
398 * Return 0 on success or else a negative value.
400 static int send_sessiond_channel(int sock
,
401 struct lttng_consumer_channel
*channel
,
402 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
404 int ret
, ret_code
= LTTNG_OK
;
405 struct lttng_consumer_stream
*stream
;
411 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
413 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
414 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
415 /* Try to send the stream to the relayd if one is available. */
416 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
419 * Flag that the relayd was the problem here probably due to a
420 * communicaton error on the socket.
425 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
430 /* Inform sessiond that we are about to send channel and streams. */
431 ret
= consumer_send_status_msg(sock
, ret_code
);
432 if (ret
< 0 || ret_code
!= LTTNG_OK
) {
434 * Either the session daemon is not responding or the relayd died so we
440 /* Send channel to sessiond. */
441 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
446 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
451 /* The channel was sent successfully to the sessiond at this point. */
452 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
453 /* Send stream to session daemon. */
454 ret
= send_sessiond_stream(sock
, stream
);
460 /* Tell sessiond there is no more stream. */
461 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
466 DBG("UST consumer NULL stream sent to sessiond");
471 if (ret_code
!= LTTNG_OK
) {
478 * Creates a channel and streams and add the channel it to the channel internal
479 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
482 * Return 0 on success or else, a negative value is returned and the channel
483 * MUST be destroyed by consumer_del_channel().
485 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
486 struct lttng_consumer_channel
*channel
,
487 struct ustctl_consumer_channel_attr
*attr
)
496 * This value is still used by the kernel consumer since for the kernel,
497 * the stream ownership is not IN the consumer so we need to have the
498 * number of left stream that needs to be initialized so we can know when
499 * to delete the channel (see consumer.c).
501 * As for the user space tracer now, the consumer creates and sends the
502 * stream to the session daemon which only sends them to the application
503 * once every stream of a channel is received making this value useless
504 * because we they will be added to the poll thread before the application
505 * receives them. This ensures that a stream can not hang up during
506 * initilization of a channel.
508 channel
->nb_init_stream_left
= 0;
510 /* The reply msg status is handled in the following call. */
511 ret
= create_ust_channel(attr
, &channel
->uchan
);
516 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
519 * For the snapshots (no monitor), we create the metadata streams
520 * on demand, not during the channel creation.
522 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
527 /* Open all streams for this channel. */
528 ret
= create_ust_streams(channel
, ctx
);
538 * Send all stream of a channel to the right thread handling it.
540 * On error, return a negative value else 0 on success.
542 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
543 struct lttng_consumer_local_data
*ctx
)
546 struct lttng_consumer_stream
*stream
, *stmp
;
551 /* Send streams to the corresponding thread. */
552 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
554 /* Sending the stream to the thread. */
555 ret
= send_stream_to_thread(stream
, ctx
);
558 * If we are unable to send the stream to the thread, there is
559 * a big problem so just stop everything.
561 /* Remove node from the channel stream list. */
562 cds_list_del(&stream
->send_node
);
566 /* Remove node from the channel stream list. */
567 cds_list_del(&stream
->send_node
);
576 * Flush channel's streams using the given key to retrieve the channel.
578 * Return 0 on success else an LTTng error code.
580 static int flush_channel(uint64_t chan_key
)
583 struct lttng_consumer_channel
*channel
;
584 struct lttng_consumer_stream
*stream
;
586 struct lttng_ht_iter iter
;
588 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
591 channel
= consumer_find_channel(chan_key
);
593 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
594 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
598 ht
= consumer_data
.stream_per_chan_id_ht
;
600 /* For each stream of the channel id, flush it. */
601 cds_lfht_for_each_entry_duplicate(ht
->ht
,
602 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
603 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
604 ustctl_flush_buffer(stream
->ustream
, 1);
611 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
612 * RCU read side lock MUST be acquired before calling this function.
614 * NOTE: This function does NOT take any channel nor stream lock.
616 * Return 0 on success else LTTng error code.
618 static int _close_metadata(struct lttng_consumer_channel
*channel
)
623 assert(channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
625 if (channel
->switch_timer_enabled
== 1) {
626 DBG("Deleting timer on metadata channel");
627 consumer_timer_switch_stop(channel
);
630 if (channel
->metadata_stream
) {
631 ret
= ustctl_stream_close_wakeup_fd(channel
->metadata_stream
->ustream
);
633 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret
);
634 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
637 if (channel
->monitor
) {
638 /* Close the read-side in consumer_del_metadata_stream */
639 ret
= close(channel
->metadata_stream
->ust_metadata_poll_pipe
[1]);
641 PERROR("Close UST metadata write-side poll pipe");
642 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
651 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
652 * RCU read side lock MUST be acquired before calling this function.
654 * Return 0 on success else an LTTng error code.
656 static int close_metadata(uint64_t chan_key
)
659 struct lttng_consumer_channel
*channel
;
661 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
663 channel
= consumer_find_channel(chan_key
);
666 * This is possible if the metadata thread has issue a delete because
667 * the endpoint point of the stream hung up. There is no way the
668 * session daemon can know about it thus use a DBG instead of an actual
671 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
672 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
676 pthread_mutex_lock(&consumer_data
.lock
);
677 pthread_mutex_lock(&channel
->lock
);
679 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
683 ret
= _close_metadata(channel
);
686 pthread_mutex_unlock(&channel
->lock
);
687 pthread_mutex_unlock(&consumer_data
.lock
);
693 * RCU read side lock MUST be acquired before calling this function.
695 * Return 0 on success else an LTTng error code.
697 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
700 struct lttng_consumer_channel
*metadata
;
702 DBG("UST consumer setup metadata key %" PRIu64
, key
);
704 metadata
= consumer_find_channel(key
);
706 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
707 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
712 * In no monitor mode, the metadata channel has no stream(s) so skip the
713 * ownership transfer to the metadata thread.
715 if (!metadata
->monitor
) {
716 DBG("Metadata channel in no monitor");
722 * Send metadata stream to relayd if one available. Availability is
723 * known if the stream is still in the list of the channel.
725 if (cds_list_empty(&metadata
->streams
.head
)) {
726 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
727 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
728 goto error_no_stream
;
731 /* Send metadata stream to relayd if needed. */
732 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
733 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
736 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
741 ret
= send_streams_to_thread(metadata
, ctx
);
744 * If we are unable to send the stream to the thread, there is
745 * a big problem so just stop everything.
747 ret
= LTTCOMM_CONSUMERD_FATAL
;
750 /* List MUST be empty after or else it could be reused. */
751 assert(cds_list_empty(&metadata
->streams
.head
));
758 * Delete metadata channel on error. At this point, the metadata stream can
759 * NOT be monitored by the metadata thread thus having the guarantee that
760 * the stream is still in the local stream list of the channel. This call
761 * will make sure to clean that list.
763 cds_list_del(&metadata
->metadata_stream
->send_node
);
764 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
771 * Snapshot the whole metadata.
773 * Returns 0 on success, < 0 on error
775 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
776 struct lttng_consumer_local_data
*ctx
)
779 struct lttng_consumer_channel
*metadata_channel
;
780 struct lttng_consumer_stream
*metadata_stream
;
785 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
790 metadata_channel
= consumer_find_channel(key
);
791 if (!metadata_channel
) {
792 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
797 assert(!metadata_channel
->monitor
);
800 * Ask the sessiond if we have new metadata waiting and update the
801 * consumer metadata cache.
803 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
809 * The metadata stream is NOT created in no monitor mode when the channel
810 * is created on a sessiond ask channel command.
812 ret
= create_ust_streams(metadata_channel
, ctx
);
817 metadata_stream
= metadata_channel
->metadata_stream
;
818 assert(metadata_stream
);
820 if (relayd_id
!= (uint64_t) -1ULL) {
821 metadata_stream
->net_seq_idx
= relayd_id
;
822 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
827 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
828 metadata_stream
->chan
->tracefile_size
,
829 metadata_stream
->tracefile_count_current
,
830 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
834 metadata_stream
->out_fd
= ret
;
835 metadata_stream
->tracefile_size_current
= 0;
839 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
847 * Clean up the stream completly because the next snapshot will use a new
850 cds_list_del(&metadata_stream
->send_node
);
851 consumer_stream_destroy(metadata_stream
, NULL
);
852 metadata_channel
->metadata_stream
= NULL
;
860 * Take a snapshot of all the stream of a channel.
862 * Returns 0 on success, < 0 on error
864 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
865 uint64_t max_stream_size
, struct lttng_consumer_local_data
*ctx
)
868 unsigned use_relayd
= 0;
869 unsigned long consumed_pos
, produced_pos
;
870 struct lttng_consumer_channel
*channel
;
871 struct lttng_consumer_stream
*stream
;
878 if (relayd_id
!= (uint64_t) -1ULL) {
882 channel
= consumer_find_channel(key
);
884 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
888 assert(!channel
->monitor
);
889 DBG("UST consumer snapshot channel %" PRIu64
, key
);
891 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
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
);
916 ustctl_flush_buffer(stream
->ustream
, 1);
918 ret
= lttng_ustconsumer_take_snapshot(stream
);
920 ERR("Taking UST snapshot");
924 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
926 ERR("Produced UST snapshot position");
930 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
932 ERR("Consumerd UST snapshot position");
937 * The original value is sent back if max stream size is larger than
938 * the possible size of the snapshot. Also, we asume that the session
939 * daemon should never send a maximum stream size that is lower than
942 consumed_pos
= consumer_get_consumed_maxsize(consumed_pos
,
943 produced_pos
, max_stream_size
);
945 while (consumed_pos
< produced_pos
) {
947 unsigned long len
, padded_len
;
949 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
951 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
953 if (ret
!= -EAGAIN
) {
954 PERROR("ustctl_get_subbuf snapshot");
955 goto error_close_stream
;
957 DBG("UST consumer get subbuf failed. Skipping it.");
958 consumed_pos
+= stream
->max_sb_size
;
962 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
964 ERR("Snapshot ustctl_get_subbuf_size");
965 goto error_put_subbuf
;
968 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
970 ERR("Snapshot ustctl_get_padded_subbuf_size");
971 goto error_put_subbuf
;
974 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
975 padded_len
- len
, NULL
);
977 if (read_len
!= len
) {
979 goto error_put_subbuf
;
982 if (read_len
!= padded_len
) {
984 goto error_put_subbuf
;
988 ret
= ustctl_put_subbuf(stream
->ustream
);
990 ERR("Snapshot ustctl_put_subbuf");
991 goto error_close_stream
;
993 consumed_pos
+= stream
->max_sb_size
;
996 /* Simply close the stream so we can use it on the next snapshot. */
997 consumer_stream_close(stream
);
998 pthread_mutex_unlock(&stream
->lock
);
1005 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1006 ERR("Snapshot ustctl_put_subbuf");
1009 consumer_stream_close(stream
);
1011 pthread_mutex_unlock(&stream
->lock
);
1018 * Receive the metadata updates from the sessiond.
1020 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1021 uint64_t len
, struct lttng_consumer_channel
*channel
,
1022 int timer
, int wait
)
1024 int ret
, ret_code
= LTTNG_OK
;
1027 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1029 metadata_str
= zmalloc(len
* sizeof(char));
1030 if (!metadata_str
) {
1031 PERROR("zmalloc metadata string");
1032 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1036 /* Receive metadata string. */
1037 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1039 /* Session daemon is dead so return gracefully. */
1044 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1045 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1047 /* Unable to handle metadata. Notify session daemon. */
1048 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1050 * Skip metadata flush on write error since the offset and len might
1051 * not have been updated which could create an infinite loop below when
1052 * waiting for the metadata cache to be flushed.
1054 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1057 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1062 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1063 DBG("Waiting for metadata to be flushed");
1064 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1074 * Receive command from session daemon and process it.
1076 * Return 1 on success else a negative value or 0.
1078 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1079 int sock
, struct pollfd
*consumer_sockpoll
)
1082 enum lttng_error_code ret_code
= LTTNG_OK
;
1083 struct lttcomm_consumer_msg msg
;
1084 struct lttng_consumer_channel
*channel
= NULL
;
1086 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1087 if (ret
!= sizeof(msg
)) {
1088 DBG("Consumer received unexpected message size %zd (expects %zu)",
1091 * The ret value might 0 meaning an orderly shutdown but this is ok
1092 * since the caller handles this.
1095 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1100 if (msg
.cmd_type
== LTTNG_CONSUMER_STOP
) {
1102 * Notify the session daemon that the command is completed.
1104 * On transport layer error, the function call will print an error
1105 * message so handling the returned code is a bit useless since we
1106 * return an error code anyway.
1108 (void) consumer_send_status_msg(sock
, ret_code
);
1112 /* relayd needs RCU read-side lock */
1115 switch (msg
.cmd_type
) {
1116 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1118 /* Session daemon status message are handled in the following call. */
1119 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1120 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1121 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1122 msg
.u
.relayd_sock
.relayd_session_id
);
1125 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1127 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1128 struct consumer_relayd_sock_pair
*relayd
;
1130 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1132 /* Get relayd reference if exists. */
1133 relayd
= consumer_find_relayd(index
);
1134 if (relayd
== NULL
) {
1135 DBG("Unable to find relayd %" PRIu64
, index
);
1136 ret_code
= LTTNG_ERR_NO_CONSUMER
;
1140 * Each relayd socket pair has a refcount of stream attached to it
1141 * which tells if the relayd is still active or not depending on the
1144 * This will set the destroy flag of the relayd object and destroy it
1145 * if the refcount reaches zero when called.
1147 * The destroy can happen either here or when a stream fd hangs up.
1150 consumer_flag_relayd_for_destroy(relayd
);
1153 goto end_msg_sessiond
;
1155 case LTTNG_CONSUMER_UPDATE_STREAM
:
1160 case LTTNG_CONSUMER_DATA_PENDING
:
1162 int ret
, is_data_pending
;
1163 uint64_t id
= msg
.u
.data_pending
.session_id
;
1165 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1167 is_data_pending
= consumer_data_pending(id
);
1169 /* Send back returned value to session daemon */
1170 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1171 sizeof(is_data_pending
));
1173 DBG("Error when sending the data pending ret code: %d", ret
);
1178 * No need to send back a status message since the data pending
1179 * returned value is the response.
1183 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1186 struct ustctl_consumer_channel_attr attr
;
1188 /* Create a plain object and reserve a channel key. */
1189 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1190 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1191 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1192 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1193 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1194 msg
.u
.ask_channel
.tracefile_size
,
1195 msg
.u
.ask_channel
.tracefile_count
,
1196 msg
.u
.ask_channel
.session_id_per_pid
,
1197 msg
.u
.ask_channel
.monitor
,
1198 msg
.u
.ask_channel
.live_timer_interval
);
1200 goto end_channel_error
;
1204 * Assign UST application UID to the channel. This value is ignored for
1205 * per PID buffers. This is specific to UST thus setting this after the
1208 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1210 /* Build channel attributes from received message. */
1211 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1212 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1213 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1214 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1215 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1216 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1217 attr
.output
= msg
.u
.ask_channel
.output
;
1218 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1220 /* Translate and save channel type. */
1221 switch (msg
.u
.ask_channel
.type
) {
1222 case LTTNG_UST_CHAN_PER_CPU
:
1223 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1224 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1226 * Set refcount to 1 for owner. Below, we will
1227 * pass ownership to the
1228 * consumer_thread_channel_poll() thread.
1230 channel
->refcount
= 1;
1232 case LTTNG_UST_CHAN_METADATA
:
1233 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1234 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1241 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1243 goto end_channel_error
;
1246 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1247 ret
= consumer_metadata_cache_allocate(channel
);
1249 ERR("Allocating metadata cache");
1250 goto end_channel_error
;
1252 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1253 attr
.switch_timer_interval
= 0;
1255 consumer_timer_live_start(channel
,
1256 msg
.u
.ask_channel
.live_timer_interval
);
1260 * Add the channel to the internal state AFTER all streams were created
1261 * and successfully sent to session daemon. This way, all streams must
1262 * be ready before this channel is visible to the threads.
1263 * If add_channel succeeds, ownership of the channel is
1264 * passed to consumer_thread_channel_poll().
1266 ret
= add_channel(channel
, ctx
);
1268 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1269 if (channel
->switch_timer_enabled
== 1) {
1270 consumer_timer_switch_stop(channel
);
1272 consumer_metadata_cache_destroy(channel
);
1274 if (channel
->live_timer_enabled
== 1) {
1275 consumer_timer_live_stop(channel
);
1277 goto end_channel_error
;
1281 * Channel and streams are now created. Inform the session daemon that
1282 * everything went well and should wait to receive the channel and
1283 * streams with ustctl API.
1285 ret
= consumer_send_status_channel(sock
, channel
);
1288 * There is probably a problem on the socket.
1295 case LTTNG_CONSUMER_GET_CHANNEL
:
1297 int ret
, relayd_err
= 0;
1298 uint64_t key
= msg
.u
.get_channel
.key
;
1299 struct lttng_consumer_channel
*channel
;
1301 channel
= consumer_find_channel(key
);
1303 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1304 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1305 goto end_msg_sessiond
;
1308 /* Send everything to sessiond. */
1309 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1313 * We were unable to send to the relayd the stream so avoid
1314 * sending back a fatal error to the thread since this is OK
1315 * and the consumer can continue its work. The above call
1316 * has sent the error status message to the sessiond.
1321 * The communicaton was broken hence there is a bad state between
1322 * the consumer and sessiond so stop everything.
1328 * In no monitor mode, the streams ownership is kept inside the channel
1329 * so don't send them to the data thread.
1331 if (!channel
->monitor
) {
1332 goto end_msg_sessiond
;
1335 ret
= send_streams_to_thread(channel
, ctx
);
1338 * If we are unable to send the stream to the thread, there is
1339 * a big problem so just stop everything.
1343 /* List MUST be empty after or else it could be reused. */
1344 assert(cds_list_empty(&channel
->streams
.head
));
1345 goto end_msg_sessiond
;
1347 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1349 uint64_t key
= msg
.u
.destroy_channel
.key
;
1352 * Only called if streams have not been sent to stream
1353 * manager thread. However, channel has been sent to
1354 * channel manager thread.
1356 notify_thread_del_channel(ctx
, key
);
1357 goto end_msg_sessiond
;
1359 case LTTNG_CONSUMER_CLOSE_METADATA
:
1363 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1368 goto end_msg_sessiond
;
1370 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1374 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1379 goto end_msg_sessiond
;
1381 case LTTNG_CONSUMER_PUSH_METADATA
:
1384 uint64_t len
= msg
.u
.push_metadata
.len
;
1385 uint64_t key
= msg
.u
.push_metadata
.key
;
1386 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1387 struct lttng_consumer_channel
*channel
;
1389 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1392 channel
= consumer_find_channel(key
);
1394 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
1395 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1396 goto end_msg_sessiond
;
1399 /* Tell session daemon we are ready to receive the metadata. */
1400 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
1402 /* Somehow, the session daemon is not responding anymore. */
1406 /* Wait for more data. */
1407 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
1411 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1412 len
, channel
, 0, 1);
1414 /* error receiving from sessiond */
1418 goto end_msg_sessiond
;
1421 case LTTNG_CONSUMER_SETUP_METADATA
:
1425 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1429 goto end_msg_sessiond
;
1431 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1433 if (msg
.u
.snapshot_channel
.metadata
) {
1434 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1435 msg
.u
.snapshot_channel
.pathname
,
1436 msg
.u
.snapshot_channel
.relayd_id
,
1439 ERR("Snapshot metadata failed");
1440 ret_code
= LTTNG_ERR_UST_META_FAIL
;
1443 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1444 msg
.u
.snapshot_channel
.pathname
,
1445 msg
.u
.snapshot_channel
.relayd_id
,
1446 msg
.u
.snapshot_channel
.max_stream_size
,
1449 ERR("Snapshot channel failed");
1450 ret_code
= LTTNG_ERR_UST_CHAN_FAIL
;
1454 ret
= consumer_send_status_msg(sock
, ret_code
);
1456 /* Somehow, the session daemon is not responding anymore. */
1469 * Return 1 to indicate success since the 0 value can be a socket
1470 * shutdown during the recv() or send() call.
1476 * The returned value here is not useful since either way we'll return 1 to
1477 * the caller because the session daemon socket management is done
1478 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1480 ret
= consumer_send_status_msg(sock
, ret_code
);
1489 * Free channel here since no one has a reference to it. We don't
1490 * free after that because a stream can store this pointer.
1492 destroy_channel(channel
);
1494 /* We have to send a status channel message indicating an error. */
1495 ret
= consumer_send_status_channel(sock
, NULL
);
1497 /* Stop everything if session daemon can not be notified. */
1504 /* This will issue a consumer stop. */
1509 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1510 * compiled out, we isolate it in this library.
1512 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1516 assert(stream
->ustream
);
1518 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1522 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1523 * compiled out, we isolate it in this library.
1525 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1528 assert(stream
->ustream
);
1530 return ustctl_get_mmap_base(stream
->ustream
);
1534 * Take a snapshot for a specific fd
1536 * Returns 0 on success, < 0 on error
1538 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1541 assert(stream
->ustream
);
1543 return ustctl_snapshot(stream
->ustream
);
1547 * Get the produced position
1549 * Returns 0 on success, < 0 on error
1551 int lttng_ustconsumer_get_produced_snapshot(
1552 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1555 assert(stream
->ustream
);
1558 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1562 * Get the consumed position
1564 * Returns 0 on success, < 0 on error
1566 int lttng_ustconsumer_get_consumed_snapshot(
1567 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1570 assert(stream
->ustream
);
1573 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1577 * Called when the stream signal the consumer that it has hang up.
1579 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1582 assert(stream
->ustream
);
1584 ustctl_flush_buffer(stream
->ustream
, 0);
1585 stream
->hangup_flush_done
= 1;
1588 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1591 assert(chan
->uchan
);
1593 if (chan
->switch_timer_enabled
== 1) {
1594 consumer_timer_switch_stop(chan
);
1596 consumer_metadata_cache_destroy(chan
);
1597 ustctl_destroy_channel(chan
->uchan
);
1600 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1603 assert(stream
->ustream
);
1605 if (stream
->chan
->switch_timer_enabled
== 1) {
1606 consumer_timer_switch_stop(stream
->chan
);
1608 ustctl_destroy_stream(stream
->ustream
);
1612 * Populate index values of a UST stream. Values are set in big endian order.
1614 * Return 0 on success or else a negative value.
1616 static int get_index_values(struct lttng_packet_index
*index
,
1617 struct ustctl_consumer_stream
*ustream
)
1621 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1623 PERROR("ustctl_get_timestamp_begin");
1626 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1628 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1630 PERROR("ustctl_get_timestamp_end");
1633 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1635 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1637 PERROR("ustctl_get_events_discarded");
1640 index
->events_discarded
= htobe64(index
->events_discarded
);
1642 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1644 PERROR("ustctl_get_content_size");
1647 index
->content_size
= htobe64(index
->content_size
);
1649 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1651 PERROR("ustctl_get_packet_size");
1654 index
->packet_size
= htobe64(index
->packet_size
);
1656 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1658 PERROR("ustctl_get_stream_id");
1661 index
->stream_id
= htobe64(index
->stream_id
);
1668 * Write up to one packet from the metadata cache to the channel.
1670 * Returns the number of bytes pushed in the cache, or a negative value
1674 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1679 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1680 if (stream
->chan
->metadata_cache
->contiguous
1681 == stream
->ust_metadata_pushed
) {
1686 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1687 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1688 stream
->chan
->metadata_cache
->contiguous
1689 - stream
->ust_metadata_pushed
);
1690 assert(write_len
!= 0);
1691 if (write_len
< 0) {
1692 ERR("Writing one metadata packet");
1696 stream
->ust_metadata_pushed
+= write_len
;
1698 assert(stream
->chan
->metadata_cache
->contiguous
>=
1699 stream
->ust_metadata_pushed
);
1703 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1709 * Sync metadata meaning request them to the session daemon and snapshot to the
1710 * metadata thread can consumer them.
1712 * Metadata stream lock MUST be acquired.
1714 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1715 * is empty or a negative value on error.
1717 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1718 struct lttng_consumer_stream
*metadata
)
1727 * Request metadata from the sessiond, but don't wait for the flush
1728 * because we locked the metadata thread.
1730 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1735 ret
= commit_one_metadata_packet(metadata
);
1738 } else if (ret
> 0) {
1742 ustctl_flush_buffer(metadata
->ustream
, 1);
1743 ret
= ustctl_snapshot(metadata
->ustream
);
1745 if (errno
!= EAGAIN
) {
1746 ERR("Sync metadata, taking UST snapshot");
1749 DBG("No new metadata when syncing them.");
1750 /* No new metadata, exit. */
1756 * After this flush, we still need to extract metadata.
1767 * Read subbuffer from the given stream.
1769 * Stream lock MUST be acquired.
1771 * Return 0 on success else a negative value.
1773 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1774 struct lttng_consumer_local_data
*ctx
)
1776 unsigned long len
, subbuf_size
, padding
;
1777 int err
, write_index
= 1;
1780 struct ustctl_consumer_stream
*ustream
;
1781 struct lttng_packet_index index
;
1784 assert(stream
->ustream
);
1787 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1790 /* Ease our life for what's next. */
1791 ustream
= stream
->ustream
;
1793 /* We can consume the 1 byte written into the wait_fd by UST */
1794 if (stream
->monitor
&& !stream
->hangup_flush_done
) {
1798 readlen
= read(stream
->wait_fd
, &dummy
, 1);
1799 } while (readlen
== -1 && errno
== EINTR
);
1800 if (readlen
== -1 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1807 /* Get the next subbuffer */
1808 err
= ustctl_get_next_subbuf(ustream
);
1811 * Populate metadata info if the existing info has
1812 * already been read.
1814 if (stream
->metadata_flag
) {
1815 ret
= commit_one_metadata_packet(stream
);
1819 ustctl_flush_buffer(stream
->ustream
, 1);
1823 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1825 * This is a debug message even for single-threaded consumer,
1826 * because poll() have more relaxed criterions than get subbuf,
1827 * so get_subbuf may fail for short race windows where poll()
1828 * would issue wakeups.
1830 DBG("Reserving sub buffer failed (everything is normal, "
1831 "it is due to concurrency) [ret: %d]", err
);
1834 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1836 if (!stream
->metadata_flag
) {
1837 index
.offset
= htobe64(stream
->out_fd_offset
);
1838 ret
= get_index_values(&index
, ustream
);
1846 /* Get the full padded subbuffer size */
1847 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1850 /* Get subbuffer data size (without padding) */
1851 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
1854 /* Make sure we don't get a subbuffer size bigger than the padded */
1855 assert(len
>= subbuf_size
);
1857 padding
= len
- subbuf_size
;
1858 /* write the subbuffer to the tracefile */
1859 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
1861 * The mmap operation should write subbuf_size amount of data when network
1862 * streaming or the full padding (len) size when we are _not_ streaming.
1864 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1865 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1867 * Display the error but continue processing to try to release the
1868 * subbuffer. This is a DBG statement since any unexpected kill or
1869 * signal, the application gets unregistered, relayd gets closed or
1870 * anything that affects the buffer lifetime will trigger this error.
1871 * So, for the sake of the user, don't print this error since it can
1872 * happen and it is OK with the code flow.
1874 DBG("Error writing to tracefile "
1875 "(ret: %ld != len: %lu != subbuf_size: %lu)",
1876 ret
, len
, subbuf_size
);
1879 err
= ustctl_put_next_subbuf(ustream
);
1882 /* Write index if needed. */
1887 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
1889 * In live, block until all the metadata is sent.
1891 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
1897 assert(!stream
->metadata_flag
);
1898 err
= consumer_stream_write_index(stream
, &index
);
1908 * Called when a stream is created.
1910 * Return 0 on success or else a negative value.
1912 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
1918 /* Don't create anything if this is set for streaming. */
1919 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
1920 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
1921 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
1922 stream
->uid
, stream
->gid
, NULL
);
1926 stream
->out_fd
= ret
;
1927 stream
->tracefile_size_current
= 0;
1929 if (!stream
->metadata_flag
) {
1930 ret
= index_create_file(stream
->chan
->pathname
,
1931 stream
->name
, stream
->uid
, stream
->gid
,
1932 stream
->chan
->tracefile_size
,
1933 stream
->tracefile_count_current
);
1937 stream
->index_fd
= ret
;
1947 * Check if data is still being extracted from the buffers for a specific
1948 * stream. Consumer data lock MUST be acquired before calling this function
1949 * and the stream lock.
1951 * Return 1 if the traced data are still getting read else 0 meaning that the
1952 * data is available for trace viewer reading.
1954 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
1959 assert(stream
->ustream
);
1961 DBG("UST consumer checking data pending");
1963 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
1968 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
1969 uint64_t contiguous
, pushed
;
1971 /* Ease our life a bit. */
1972 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
1973 pushed
= stream
->ust_metadata_pushed
;
1976 * We can simply check whether all contiguously available data
1977 * has been pushed to the ring buffer, since the push operation
1978 * is performed within get_next_subbuf(), and because both
1979 * get_next_subbuf() and put_next_subbuf() are issued atomically
1980 * thanks to the stream lock within
1981 * lttng_ustconsumer_read_subbuffer(). This basically means that
1982 * whetnever ust_metadata_pushed is incremented, the associated
1983 * metadata has been consumed from the metadata stream.
1985 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
1986 contiguous
, pushed
);
1987 assert(((int64_t) contiguous
- pushed
) >= 0);
1988 if ((contiguous
!= pushed
) ||
1989 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
1990 ret
= 1; /* Data is pending */
1994 ret
= ustctl_get_next_subbuf(stream
->ustream
);
1997 * There is still data so let's put back this
2000 ret
= ustctl_put_subbuf(stream
->ustream
);
2002 ret
= 1; /* Data is pending */
2007 /* Data is NOT pending so ready to be read. */
2015 * Close every metadata stream wait fd of the metadata hash table. This
2016 * function MUST be used very carefully so not to run into a race between the
2017 * metadata thread handling streams and this function closing their wait fd.
2019 * For UST, this is used when the session daemon hangs up. Its the metadata
2020 * producer so calling this is safe because we are assured that no state change
2021 * can occur in the metadata thread for the streams in the hash table.
2023 void lttng_ustconsumer_close_metadata(struct lttng_ht
*metadata_ht
)
2025 struct lttng_ht_iter iter
;
2026 struct lttng_consumer_stream
*stream
;
2028 assert(metadata_ht
);
2029 assert(metadata_ht
->ht
);
2031 DBG("UST consumer closing all metadata streams");
2034 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2036 pthread_mutex_lock(&stream
->chan
->lock
);
2038 * Whatever returned value, we must continue to try to close everything
2041 (void) _close_metadata(stream
->chan
);
2042 DBG("Metadata wait fd %d and poll pipe fd %d closed", stream
->wait_fd
,
2043 stream
->ust_metadata_poll_pipe
[1]);
2044 pthread_mutex_unlock(&stream
->chan
->lock
);
2050 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2054 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2056 ERR("Unable to close wakeup fd");
2061 * Please refer to consumer-timer.c before adding any lock within this
2062 * function or any of its callees. Timers have a very strict locking
2063 * semantic with respect to teardown. Failure to respect this semantic
2064 * introduces deadlocks.
2066 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2067 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2069 struct lttcomm_metadata_request_msg request
;
2070 struct lttcomm_consumer_msg msg
;
2071 enum lttng_error_code ret_code
= LTTNG_OK
;
2072 uint64_t len
, key
, offset
;
2076 assert(channel
->metadata_cache
);
2078 /* send the metadata request to sessiond */
2079 switch (consumer_data
.type
) {
2080 case LTTNG_CONSUMER64_UST
:
2081 request
.bits_per_long
= 64;
2083 case LTTNG_CONSUMER32_UST
:
2084 request
.bits_per_long
= 32;
2087 request
.bits_per_long
= 0;
2091 request
.session_id
= channel
->session_id
;
2092 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2094 * Request the application UID here so the metadata of that application can
2095 * be sent back. The channel UID corresponds to the user UID of the session
2096 * used for the rights on the stream file(s).
2098 request
.uid
= channel
->ust_app_uid
;
2099 request
.key
= channel
->key
;
2101 DBG("Sending metadata request to sessiond, session id %" PRIu64
2102 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2103 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2106 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2107 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2110 ERR("Asking metadata to sessiond");
2114 /* Receive the metadata from sessiond */
2115 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2117 if (ret
!= sizeof(msg
)) {
2118 DBG("Consumer received unexpected message size %d (expects %zu)",
2120 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2122 * The ret value might 0 meaning an orderly shutdown but this is ok
2123 * since the caller handles this.
2128 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2129 /* No registry found */
2130 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2134 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2135 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2140 len
= msg
.u
.push_metadata
.len
;
2141 key
= msg
.u
.push_metadata
.key
;
2142 offset
= msg
.u
.push_metadata
.target_offset
;
2144 assert(key
== channel
->key
);
2146 DBG("No new metadata to receive for key %" PRIu64
, key
);
2149 /* Tell session daemon we are ready to receive the metadata. */
2150 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2152 if (ret
< 0 || len
== 0) {
2154 * Somehow, the session daemon is not responding anymore or there is
2155 * nothing to receive.
2160 ret_code
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2161 key
, offset
, len
, channel
, timer
, wait
);
2162 if (ret_code
>= 0) {
2164 * Only send the status msg if the sessiond is alive meaning a positive
2167 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret_code
);
2172 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);