2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <lttng/ust-ctl.h>
28 #include <sys/socket.h>
30 #include <sys/types.h>
33 #include <urcu/list.h>
37 #include <bin/lttng-consumerd/health-consumerd.h>
38 #include <common/common.h>
39 #include <common/sessiond-comm/sessiond-comm.h>
40 #include <common/relayd/relayd.h>
41 #include <common/compat/fcntl.h>
42 #include <common/compat/endian.h>
43 #include <common/consumer/consumer-metadata-cache.h>
44 #include <common/consumer/consumer-stream.h>
45 #include <common/consumer/consumer-timer.h>
46 #include <common/utils.h>
47 #include <common/index/index.h>
49 #include "ust-consumer.h"
51 #define INT_MAX_STR_LEN 12 /* includes \0 */
53 extern struct lttng_consumer_global_data consumer_data
;
54 extern int consumer_poll_timeout
;
57 * Free channel object and all streams associated with it. This MUST be used
58 * only and only if the channel has _NEVER_ been added to the global channel
61 static void destroy_channel(struct lttng_consumer_channel
*channel
)
63 struct lttng_consumer_stream
*stream
, *stmp
;
67 DBG("UST consumer cleaning stream list");
69 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
74 cds_list_del(&stream
->send_node
);
75 ustctl_destroy_stream(stream
->ustream
);
80 * If a channel is available meaning that was created before the streams
84 lttng_ustconsumer_del_channel(channel
);
85 lttng_ustconsumer_free_channel(channel
);
91 * Add channel to internal consumer state.
93 * Returns 0 on success or else a negative value.
95 static int add_channel(struct lttng_consumer_channel
*channel
,
96 struct lttng_consumer_local_data
*ctx
)
103 if (ctx
->on_recv_channel
!= NULL
) {
104 ret
= ctx
->on_recv_channel(channel
);
106 ret
= consumer_add_channel(channel
, ctx
);
107 } else if (ret
< 0) {
108 /* Most likely an ENOMEM. */
109 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
113 ret
= consumer_add_channel(channel
, ctx
);
116 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
123 * Allocate and return a consumer channel object.
125 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
126 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
127 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
128 uint64_t tracefile_size
, uint64_t tracefile_count
,
129 uint64_t session_id_per_pid
, unsigned int monitor
,
130 unsigned int live_timer_interval
,
131 const char *root_shm_path
, const char *shm_path
)
136 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
137 gid
, relayd_id
, output
, tracefile_size
,
138 tracefile_count
, session_id_per_pid
, monitor
,
139 live_timer_interval
, root_shm_path
, shm_path
);
143 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
144 * error value if applicable is set in it else it is kept untouched.
146 * Return NULL on error else the newly allocated stream object.
148 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
149 struct lttng_consumer_channel
*channel
,
150 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
,
151 uint64_t trace_archive_id
)
154 struct lttng_consumer_stream
*stream
= NULL
;
159 stream
= consumer_allocate_stream(channel
->key
,
161 LTTNG_CONSUMER_ACTIVE_STREAM
,
172 if (stream
== NULL
) {
176 * We could not find the channel. Can happen if cpu hotplug
177 * happens while tearing down.
179 DBG3("Could not find channel");
184 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
190 consumer_stream_update_channel_attributes(stream
, channel
);
191 stream
->chan
= channel
;
195 *_alloc_ret
= alloc_ret
;
201 * Send the given stream pointer to the corresponding thread.
203 * Returns 0 on success else a negative value.
205 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
206 struct lttng_consumer_local_data
*ctx
)
209 struct lttng_pipe
*stream_pipe
;
211 /* Get the right pipe where the stream will be sent. */
212 if (stream
->metadata_flag
) {
213 consumer_add_metadata_stream(stream
);
214 stream_pipe
= ctx
->consumer_metadata_pipe
;
216 consumer_add_data_stream(stream
);
217 stream_pipe
= ctx
->consumer_data_pipe
;
221 * From this point on, the stream's ownership has been moved away from
222 * the channel and it becomes globally visible. Hence, remove it from
223 * the local stream list to prevent the stream from being both local and
226 stream
->globally_visible
= 1;
227 cds_list_del(&stream
->send_node
);
229 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
231 ERR("Consumer write %s stream to pipe %d",
232 stream
->metadata_flag
? "metadata" : "data",
233 lttng_pipe_get_writefd(stream_pipe
));
234 if (stream
->metadata_flag
) {
235 consumer_del_stream_for_metadata(stream
);
237 consumer_del_stream_for_data(stream
);
247 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
249 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
252 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
253 stream_shm_path
[PATH_MAX
- 1] = '\0';
254 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
259 strncat(stream_shm_path
, cpu_nr
,
260 PATH_MAX
- strlen(stream_shm_path
) - 1);
267 * Create streams for the given channel using liblttng-ust-ctl.
269 * Return 0 on success else a negative value.
271 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
272 struct lttng_consumer_local_data
*ctx
,
273 uint64_t trace_archive_id
)
276 struct ustctl_consumer_stream
*ustream
;
277 struct lttng_consumer_stream
*stream
;
283 * While a stream is available from ustctl. When NULL is returned, we've
284 * reached the end of the possible stream for the channel.
286 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
288 int ust_metadata_pipe
[2];
290 health_code_update();
292 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
293 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
295 ERR("Create ust metadata poll pipe");
298 wait_fd
= ust_metadata_pipe
[0];
300 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
303 /* Allocate consumer stream object. */
304 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
,
309 stream
->ustream
= ustream
;
311 * Store it so we can save multiple function calls afterwards since
312 * this value is used heavily in the stream threads. This is UST
313 * specific so this is why it's done after allocation.
315 stream
->wait_fd
= wait_fd
;
318 * Increment channel refcount since the channel reference has now been
319 * assigned in the allocation process above.
321 if (stream
->chan
->monitor
) {
322 uatomic_inc(&stream
->chan
->refcount
);
326 * Order is important this is why a list is used. On error, the caller
327 * should clean this list.
329 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
331 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
332 &stream
->max_sb_size
);
334 ERR("ustctl_get_max_subbuf_size failed for stream %s",
339 /* Do actions once stream has been received. */
340 if (ctx
->on_recv_stream
) {
341 ret
= ctx
->on_recv_stream(stream
);
347 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
348 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
350 /* Set next CPU stream. */
351 channel
->streams
.count
= ++cpu
;
353 /* Keep stream reference when creating metadata. */
354 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
355 channel
->metadata_stream
= stream
;
356 if (channel
->monitor
) {
357 /* Set metadata poll pipe if we created one */
358 memcpy(stream
->ust_metadata_poll_pipe
,
360 sizeof(ust_metadata_pipe
));
373 * create_posix_shm is never called concurrently within a process.
376 int create_posix_shm(void)
378 char tmp_name
[NAME_MAX
];
381 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
387 * Allocate shm, and immediately unlink its shm oject, keeping
388 * only the file descriptor as a reference to the object.
389 * We specifically do _not_ use the / at the beginning of the
390 * pathname so that some OS implementations can keep it local to
391 * the process (POSIX leaves this implementation-defined).
393 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
398 ret
= shm_unlink(tmp_name
);
399 if (ret
< 0 && errno
!= ENOENT
) {
400 PERROR("shm_unlink");
401 goto error_shm_release
;
414 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
)
416 char shm_path
[PATH_MAX
];
419 if (!channel
->shm_path
[0]) {
420 return create_posix_shm();
422 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
426 return run_as_open(shm_path
,
427 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
428 channel
->uid
, channel
->gid
);
435 * Create an UST channel with the given attributes and send it to the session
436 * daemon using the ust ctl API.
438 * Return 0 on success or else a negative value.
440 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
441 struct ustctl_consumer_channel_attr
*attr
,
442 struct ustctl_consumer_channel
**ust_chanp
)
444 int ret
, nr_stream_fds
, i
, j
;
446 struct ustctl_consumer_channel
*ust_channel
;
452 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
453 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
454 "switch_timer_interval: %u, read_timer_interval: %u, "
455 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
456 attr
->num_subbuf
, attr
->switch_timer_interval
,
457 attr
->read_timer_interval
, attr
->output
, attr
->type
);
459 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
462 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
463 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
468 for (i
= 0; i
< nr_stream_fds
; i
++) {
469 stream_fds
[i
] = open_ust_stream_fd(channel
, i
);
470 if (stream_fds
[i
] < 0) {
475 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
480 channel
->nr_stream_fds
= nr_stream_fds
;
481 channel
->stream_fds
= stream_fds
;
482 *ust_chanp
= ust_channel
;
488 for (j
= i
- 1; j
>= 0; j
--) {
491 closeret
= close(stream_fds
[j
]);
495 if (channel
->shm_path
[0]) {
496 char shm_path
[PATH_MAX
];
498 closeret
= get_stream_shm_path(shm_path
,
499 channel
->shm_path
, j
);
501 ERR("Cannot get stream shm path");
503 closeret
= run_as_unlink(shm_path
,
504 channel
->uid
, channel
->gid
);
506 PERROR("unlink %s", shm_path
);
510 /* Try to rmdir all directories under shm_path root. */
511 if (channel
->root_shm_path
[0]) {
512 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
513 channel
->uid
, channel
->gid
);
521 * Send a single given stream to the session daemon using the sock.
523 * Return 0 on success else a negative value.
525 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
532 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
534 /* Send stream to session daemon. */
535 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
545 * Send channel to sessiond and relayd if applicable.
547 * Return 0 on success or else a negative value.
549 static int send_channel_to_sessiond_and_relayd(int sock
,
550 struct lttng_consumer_channel
*channel
,
551 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
553 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
554 struct lttng_consumer_stream
*stream
;
555 uint64_t net_seq_idx
= -1ULL;
561 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
563 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
564 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
566 health_code_update();
568 /* Try to send the stream to the relayd if one is available. */
569 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
570 stream
->key
, channel
->name
);
571 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
574 * Flag that the relayd was the problem here probably due to a
575 * communicaton error on the socket.
580 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
582 if (net_seq_idx
== -1ULL) {
583 net_seq_idx
= stream
->net_seq_idx
;
588 /* Inform sessiond that we are about to send channel and streams. */
589 ret
= consumer_send_status_msg(sock
, ret_code
);
590 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
592 * Either the session daemon is not responding or the relayd died so we
598 /* Send channel to sessiond. */
599 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
604 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
609 /* The channel was sent successfully to the sessiond at this point. */
610 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
612 health_code_update();
614 /* Send stream to session daemon. */
615 ret
= send_sessiond_stream(sock
, stream
);
621 /* Tell sessiond there is no more stream. */
622 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
627 DBG("UST consumer NULL stream sent to sessiond");
632 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
639 * Creates a channel and streams and add the channel it to the channel internal
640 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
643 * Return 0 on success or else, a negative value is returned and the channel
644 * MUST be destroyed by consumer_del_channel().
646 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
647 struct lttng_consumer_channel
*channel
,
648 struct ustctl_consumer_channel_attr
*attr
,
649 uint64_t trace_archive_id
)
658 * This value is still used by the kernel consumer since for the kernel,
659 * the stream ownership is not IN the consumer so we need to have the
660 * number of left stream that needs to be initialized so we can know when
661 * to delete the channel (see consumer.c).
663 * As for the user space tracer now, the consumer creates and sends the
664 * stream to the session daemon which only sends them to the application
665 * once every stream of a channel is received making this value useless
666 * because we they will be added to the poll thread before the application
667 * receives them. This ensures that a stream can not hang up during
668 * initilization of a channel.
670 channel
->nb_init_stream_left
= 0;
672 /* The reply msg status is handled in the following call. */
673 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
678 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
681 * For the snapshots (no monitor), we create the metadata streams
682 * on demand, not during the channel creation.
684 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
689 /* Open all streams for this channel. */
690 ret
= create_ust_streams(channel
, ctx
, trace_archive_id
);
700 * Send all stream of a channel to the right thread handling it.
702 * On error, return a negative value else 0 on success.
704 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
705 struct lttng_consumer_local_data
*ctx
)
708 struct lttng_consumer_stream
*stream
, *stmp
;
713 /* Send streams to the corresponding thread. */
714 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
717 health_code_update();
719 /* Sending the stream to the thread. */
720 ret
= send_stream_to_thread(stream
, ctx
);
723 * If we are unable to send the stream to the thread, there is
724 * a big problem so just stop everything.
735 * Flush channel's streams using the given key to retrieve the channel.
737 * Return 0 on success else an LTTng error code.
739 static int flush_channel(uint64_t chan_key
)
742 struct lttng_consumer_channel
*channel
;
743 struct lttng_consumer_stream
*stream
;
745 struct lttng_ht_iter iter
;
747 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
750 channel
= consumer_find_channel(chan_key
);
752 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
753 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
757 ht
= consumer_data
.stream_per_chan_id_ht
;
759 /* For each stream of the channel id, flush it. */
760 cds_lfht_for_each_entry_duplicate(ht
->ht
,
761 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
762 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
764 health_code_update();
766 pthread_mutex_lock(&stream
->lock
);
767 if (!stream
->quiescent
) {
768 lttng_ustconsumer_flush_buffer(stream
, 0);
769 stream
->quiescent
= true;
771 pthread_mutex_unlock(&stream
->lock
);
779 * Clear quiescent state from channel's streams using the given key to
780 * retrieve the channel.
782 * Return 0 on success else an LTTng error code.
784 static int clear_quiescent_channel(uint64_t chan_key
)
787 struct lttng_consumer_channel
*channel
;
788 struct lttng_consumer_stream
*stream
;
790 struct lttng_ht_iter iter
;
792 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
795 channel
= consumer_find_channel(chan_key
);
797 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
798 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
802 ht
= consumer_data
.stream_per_chan_id_ht
;
804 /* For each stream of the channel id, clear quiescent state. */
805 cds_lfht_for_each_entry_duplicate(ht
->ht
,
806 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
807 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
809 health_code_update();
811 pthread_mutex_lock(&stream
->lock
);
812 stream
->quiescent
= false;
813 pthread_mutex_unlock(&stream
->lock
);
821 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
822 * RCU read side lock MUST be acquired before calling this function.
824 * Return 0 on success else an LTTng error code.
826 static int close_metadata(uint64_t chan_key
)
829 struct lttng_consumer_channel
*channel
;
830 unsigned int channel_monitor
;
832 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
834 channel
= consumer_find_channel(chan_key
);
837 * This is possible if the metadata thread has issue a delete because
838 * the endpoint point of the stream hung up. There is no way the
839 * session daemon can know about it thus use a DBG instead of an actual
842 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
843 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
847 pthread_mutex_lock(&consumer_data
.lock
);
848 pthread_mutex_lock(&channel
->lock
);
849 channel_monitor
= channel
->monitor
;
850 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
854 lttng_ustconsumer_close_metadata(channel
);
855 pthread_mutex_unlock(&channel
->lock
);
856 pthread_mutex_unlock(&consumer_data
.lock
);
859 * The ownership of a metadata channel depends on the type of
860 * session to which it belongs. In effect, the monitor flag is checked
861 * to determine if this metadata channel is in "snapshot" mode or not.
863 * In the non-snapshot case, the metadata channel is created along with
864 * a single stream which will remain present until the metadata channel
865 * is destroyed (on the destruction of its session). In this case, the
866 * metadata stream in "monitored" by the metadata poll thread and holds
867 * the ownership of its channel.
869 * Closing the metadata will cause the metadata stream's "metadata poll
870 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
871 * thread which will teardown the metadata stream which, in return,
872 * deletes the metadata channel.
874 * In the snapshot case, the metadata stream is created and destroyed
875 * on every snapshot record. Since the channel doesn't have an owner
876 * other than the session daemon, it is safe to destroy it immediately
877 * on reception of the CLOSE_METADATA command.
879 if (!channel_monitor
) {
881 * The channel and consumer_data locks must be
882 * released before this call since consumer_del_channel
883 * re-acquires the channel and consumer_data locks to teardown
884 * the channel and queue its reclamation by the "call_rcu"
887 consumer_del_channel(channel
);
892 pthread_mutex_unlock(&channel
->lock
);
893 pthread_mutex_unlock(&consumer_data
.lock
);
899 * RCU read side lock MUST be acquired before calling this function.
901 * Return 0 on success else an LTTng error code.
903 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
906 struct lttng_consumer_channel
*metadata
;
908 DBG("UST consumer setup metadata key %" PRIu64
, key
);
910 metadata
= consumer_find_channel(key
);
912 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
913 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
918 * In no monitor mode, the metadata channel has no stream(s) so skip the
919 * ownership transfer to the metadata thread.
921 if (!metadata
->monitor
) {
922 DBG("Metadata channel in no monitor");
928 * Send metadata stream to relayd if one available. Availability is
929 * known if the stream is still in the list of the channel.
931 if (cds_list_empty(&metadata
->streams
.head
)) {
932 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
933 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
934 goto error_no_stream
;
937 /* Send metadata stream to relayd if needed. */
938 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
939 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
942 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
945 ret
= consumer_send_relayd_streams_sent(
946 metadata
->metadata_stream
->net_seq_idx
);
948 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
954 * Ownership of metadata stream is passed along. Freeing is handled by
957 ret
= send_streams_to_thread(metadata
, ctx
);
960 * If we are unable to send the stream to the thread, there is
961 * a big problem so just stop everything.
963 ret
= LTTCOMM_CONSUMERD_FATAL
;
964 goto send_streams_error
;
966 /* List MUST be empty after or else it could be reused. */
967 assert(cds_list_empty(&metadata
->streams
.head
));
974 * Delete metadata channel on error. At this point, the metadata stream can
975 * NOT be monitored by the metadata thread thus having the guarantee that
976 * the stream is still in the local stream list of the channel. This call
977 * will make sure to clean that list.
979 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
980 cds_list_del(&metadata
->metadata_stream
->send_node
);
981 metadata
->metadata_stream
= NULL
;
989 * Snapshot the whole metadata.
990 * RCU read-side lock must be held across this function to ensure existence of
993 * Returns 0 on success, < 0 on error
995 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
996 uint64_t key
, char *path
, uint64_t relayd_id
,
997 struct lttng_consumer_local_data
*ctx
,
998 uint64_t trace_archive_id
)
1001 struct lttng_consumer_stream
*metadata_stream
;
1006 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
1011 assert(!metadata_channel
->monitor
);
1013 health_code_update();
1016 * Ask the sessiond if we have new metadata waiting and update the
1017 * consumer metadata cache.
1019 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
1024 health_code_update();
1027 * The metadata stream is NOT created in no monitor mode when the channel
1028 * is created on a sessiond ask channel command.
1030 ret
= create_ust_streams(metadata_channel
, ctx
, trace_archive_id
);
1035 metadata_stream
= metadata_channel
->metadata_stream
;
1036 assert(metadata_stream
);
1038 if (relayd_id
!= (uint64_t) -1ULL) {
1039 metadata_stream
->net_seq_idx
= relayd_id
;
1040 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1045 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
1046 metadata_stream
->chan
->tracefile_size
,
1047 metadata_stream
->tracefile_count_current
,
1048 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
1052 metadata_stream
->out_fd
= ret
;
1053 metadata_stream
->tracefile_size_current
= 0;
1057 health_code_update();
1059 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
1067 * Clean up the stream completly because the next snapshot will use a new
1070 consumer_stream_destroy(metadata_stream
, NULL
);
1071 cds_list_del(&metadata_stream
->send_node
);
1072 metadata_channel
->metadata_stream
= NULL
;
1080 * Take a snapshot of all the stream of a channel.
1081 * RCU read-side lock must be held across this function to ensure existence of
1084 * Returns 0 on success, < 0 on error
1086 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1087 uint64_t key
, char *path
, uint64_t relayd_id
,
1088 uint64_t nb_packets_per_stream
,
1089 struct lttng_consumer_local_data
*ctx
)
1092 unsigned use_relayd
= 0;
1093 unsigned long consumed_pos
, produced_pos
;
1094 struct lttng_consumer_stream
*stream
;
1101 if (relayd_id
!= (uint64_t) -1ULL) {
1105 assert(!channel
->monitor
);
1106 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1108 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1109 health_code_update();
1111 /* Lock stream because we are about to change its state. */
1112 pthread_mutex_lock(&stream
->lock
);
1113 stream
->net_seq_idx
= relayd_id
;
1116 ret
= consumer_send_relayd_stream(stream
, path
);
1121 ret
= utils_create_stream_file(path
, stream
->name
,
1122 stream
->chan
->tracefile_size
,
1123 stream
->tracefile_count_current
,
1124 stream
->uid
, stream
->gid
, NULL
);
1128 stream
->out_fd
= ret
;
1129 stream
->tracefile_size_current
= 0;
1131 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
1132 stream
->name
, stream
->key
);
1136 * If tracing is active, we want to perform a "full" buffer flush.
1137 * Else, if quiescent, it has already been done by the prior stop.
1139 if (!stream
->quiescent
) {
1140 lttng_ustconsumer_flush_buffer(stream
, 0);
1143 ret
= lttng_ustconsumer_take_snapshot(stream
);
1145 ERR("Taking UST snapshot");
1149 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1151 ERR("Produced UST snapshot position");
1155 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1157 ERR("Consumerd UST snapshot position");
1162 * The original value is sent back if max stream size is larger than
1163 * the possible size of the snapshot. Also, we assume that the session
1164 * daemon should never send a maximum stream size that is lower than
1167 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1168 produced_pos
, nb_packets_per_stream
,
1169 stream
->max_sb_size
);
1171 while (consumed_pos
< produced_pos
) {
1173 unsigned long len
, padded_len
;
1175 health_code_update();
1177 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1179 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1181 if (ret
!= -EAGAIN
) {
1182 PERROR("ustctl_get_subbuf snapshot");
1183 goto error_close_stream
;
1185 DBG("UST consumer get subbuf failed. Skipping it.");
1186 consumed_pos
+= stream
->max_sb_size
;
1187 stream
->chan
->lost_packets
++;
1191 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1193 ERR("Snapshot ustctl_get_subbuf_size");
1194 goto error_put_subbuf
;
1197 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1199 ERR("Snapshot ustctl_get_padded_subbuf_size");
1200 goto error_put_subbuf
;
1203 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1204 padded_len
- len
, NULL
);
1206 if (read_len
!= len
) {
1208 goto error_put_subbuf
;
1211 if (read_len
!= padded_len
) {
1213 goto error_put_subbuf
;
1217 ret
= ustctl_put_subbuf(stream
->ustream
);
1219 ERR("Snapshot ustctl_put_subbuf");
1220 goto error_close_stream
;
1222 consumed_pos
+= stream
->max_sb_size
;
1225 /* Simply close the stream so we can use it on the next snapshot. */
1226 consumer_stream_close(stream
);
1227 pthread_mutex_unlock(&stream
->lock
);
1234 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1235 ERR("Snapshot ustctl_put_subbuf");
1238 consumer_stream_close(stream
);
1240 pthread_mutex_unlock(&stream
->lock
);
1246 * Receive the metadata updates from the sessiond. Supports receiving
1247 * overlapping metadata, but is needs to always belong to a contiguous
1248 * range starting from 0.
1249 * Be careful about the locks held when calling this function: it needs
1250 * the metadata cache flush to concurrently progress in order to
1253 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1254 uint64_t len
, uint64_t version
,
1255 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1257 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1260 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1262 metadata_str
= zmalloc(len
* sizeof(char));
1263 if (!metadata_str
) {
1264 PERROR("zmalloc metadata string");
1265 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1269 health_code_update();
1271 /* Receive metadata string. */
1272 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1274 /* Session daemon is dead so return gracefully. */
1279 health_code_update();
1281 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1282 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1285 /* Unable to handle metadata. Notify session daemon. */
1286 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1288 * Skip metadata flush on write error since the offset and len might
1289 * not have been updated which could create an infinite loop below when
1290 * waiting for the metadata cache to be flushed.
1292 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1295 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1300 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1301 DBG("Waiting for metadata to be flushed");
1303 health_code_update();
1305 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1315 * Receive command from session daemon and process it.
1317 * Return 1 on success else a negative value or 0.
1319 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1320 int sock
, struct pollfd
*consumer_sockpoll
)
1323 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1324 struct lttcomm_consumer_msg msg
;
1325 struct lttng_consumer_channel
*channel
= NULL
;
1327 health_code_update();
1329 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1330 if (ret
!= sizeof(msg
)) {
1331 DBG("Consumer received unexpected message size %zd (expects %zu)",
1334 * The ret value might 0 meaning an orderly shutdown but this is ok
1335 * since the caller handles this.
1338 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1344 health_code_update();
1347 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1349 health_code_update();
1351 /* relayd needs RCU read-side lock */
1354 switch (msg
.cmd_type
) {
1355 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1357 /* Session daemon status message are handled in the following call. */
1358 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1359 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1360 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1361 msg
.u
.relayd_sock
.relayd_session_id
);
1364 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1366 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1367 struct consumer_relayd_sock_pair
*relayd
;
1369 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1371 /* Get relayd reference if exists. */
1372 relayd
= consumer_find_relayd(index
);
1373 if (relayd
== NULL
) {
1374 DBG("Unable to find relayd %" PRIu64
, index
);
1375 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1379 * Each relayd socket pair has a refcount of stream attached to it
1380 * which tells if the relayd is still active or not depending on the
1383 * This will set the destroy flag of the relayd object and destroy it
1384 * if the refcount reaches zero when called.
1386 * The destroy can happen either here or when a stream fd hangs up.
1389 consumer_flag_relayd_for_destroy(relayd
);
1392 goto end_msg_sessiond
;
1394 case LTTNG_CONSUMER_UPDATE_STREAM
:
1399 case LTTNG_CONSUMER_DATA_PENDING
:
1401 int ret
, is_data_pending
;
1402 uint64_t id
= msg
.u
.data_pending
.session_id
;
1404 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1406 is_data_pending
= consumer_data_pending(id
);
1408 /* Send back returned value to session daemon */
1409 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1410 sizeof(is_data_pending
));
1412 DBG("Error when sending the data pending ret code: %d", ret
);
1417 * No need to send back a status message since the data pending
1418 * returned value is the response.
1422 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1425 struct ustctl_consumer_channel_attr attr
;
1427 /* Create a plain object and reserve a channel key. */
1428 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1429 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1430 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1431 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1432 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1433 msg
.u
.ask_channel
.tracefile_size
,
1434 msg
.u
.ask_channel
.tracefile_count
,
1435 msg
.u
.ask_channel
.session_id_per_pid
,
1436 msg
.u
.ask_channel
.monitor
,
1437 msg
.u
.ask_channel
.live_timer_interval
,
1438 msg
.u
.ask_channel
.root_shm_path
,
1439 msg
.u
.ask_channel
.shm_path
);
1441 goto end_channel_error
;
1445 * Assign UST application UID to the channel. This value is ignored for
1446 * per PID buffers. This is specific to UST thus setting this after the
1449 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1451 /* Build channel attributes from received message. */
1452 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1453 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1454 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1455 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1456 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1457 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1458 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1459 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1461 /* Match channel buffer type to the UST abi. */
1462 switch (msg
.u
.ask_channel
.output
) {
1463 case LTTNG_EVENT_MMAP
:
1465 attr
.output
= LTTNG_UST_MMAP
;
1469 /* Translate and save channel type. */
1470 switch (msg
.u
.ask_channel
.type
) {
1471 case LTTNG_UST_CHAN_PER_CPU
:
1472 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1473 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1475 * Set refcount to 1 for owner. Below, we will
1476 * pass ownership to the
1477 * consumer_thread_channel_poll() thread.
1479 channel
->refcount
= 1;
1481 case LTTNG_UST_CHAN_METADATA
:
1482 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1483 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1490 health_code_update();
1492 ret
= ask_channel(ctx
, channel
, &attr
,
1493 msg
.u
.ask_channel
.trace_archive_id
);
1495 goto end_channel_error
;
1498 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1499 ret
= consumer_metadata_cache_allocate(channel
);
1501 ERR("Allocating metadata cache");
1502 goto end_channel_error
;
1504 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1505 attr
.switch_timer_interval
= 0;
1507 int monitor_start_ret
;
1509 consumer_timer_live_start(channel
,
1510 msg
.u
.ask_channel
.live_timer_interval
);
1511 monitor_start_ret
= consumer_timer_monitor_start(
1513 msg
.u
.ask_channel
.monitor_timer_interval
);
1514 if (monitor_start_ret
< 0) {
1515 ERR("Starting channel monitoring timer failed");
1516 goto end_channel_error
;
1520 health_code_update();
1523 * Add the channel to the internal state AFTER all streams were created
1524 * and successfully sent to session daemon. This way, all streams must
1525 * be ready before this channel is visible to the threads.
1526 * If add_channel succeeds, ownership of the channel is
1527 * passed to consumer_thread_channel_poll().
1529 ret
= add_channel(channel
, ctx
);
1531 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1532 if (channel
->switch_timer_enabled
== 1) {
1533 consumer_timer_switch_stop(channel
);
1535 consumer_metadata_cache_destroy(channel
);
1537 if (channel
->live_timer_enabled
== 1) {
1538 consumer_timer_live_stop(channel
);
1540 if (channel
->monitor_timer_enabled
== 1) {
1541 consumer_timer_monitor_stop(channel
);
1543 goto end_channel_error
;
1546 health_code_update();
1549 * Channel and streams are now created. Inform the session daemon that
1550 * everything went well and should wait to receive the channel and
1551 * streams with ustctl API.
1553 ret
= consumer_send_status_channel(sock
, channel
);
1556 * There is probably a problem on the socket.
1563 case LTTNG_CONSUMER_GET_CHANNEL
:
1565 int ret
, relayd_err
= 0;
1566 uint64_t key
= msg
.u
.get_channel
.key
;
1567 struct lttng_consumer_channel
*channel
;
1569 channel
= consumer_find_channel(key
);
1571 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1572 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1573 goto end_msg_sessiond
;
1576 health_code_update();
1578 /* Send the channel to sessiond (and relayd, if applicable). */
1579 ret
= send_channel_to_sessiond_and_relayd(sock
, channel
, ctx
,
1584 * We were unable to send to the relayd the stream so avoid
1585 * sending back a fatal error to the thread since this is OK
1586 * and the consumer can continue its work. The above call
1587 * has sent the error status message to the sessiond.
1592 * The communicaton was broken hence there is a bad state between
1593 * the consumer and sessiond so stop everything.
1598 health_code_update();
1601 * In no monitor mode, the streams ownership is kept inside the channel
1602 * so don't send them to the data thread.
1604 if (!channel
->monitor
) {
1605 goto end_msg_sessiond
;
1608 ret
= send_streams_to_thread(channel
, ctx
);
1611 * If we are unable to send the stream to the thread, there is
1612 * a big problem so just stop everything.
1616 /* List MUST be empty after or else it could be reused. */
1617 assert(cds_list_empty(&channel
->streams
.head
));
1618 goto end_msg_sessiond
;
1620 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1622 uint64_t key
= msg
.u
.destroy_channel
.key
;
1625 * Only called if streams have not been sent to stream
1626 * manager thread. However, channel has been sent to
1627 * channel manager thread.
1629 notify_thread_del_channel(ctx
, key
);
1630 goto end_msg_sessiond
;
1632 case LTTNG_CONSUMER_CLOSE_METADATA
:
1636 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1641 goto end_msg_sessiond
;
1643 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1647 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1652 goto end_msg_sessiond
;
1654 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1658 ret
= clear_quiescent_channel(
1659 msg
.u
.clear_quiescent_channel
.key
);
1664 goto end_msg_sessiond
;
1666 case LTTNG_CONSUMER_PUSH_METADATA
:
1669 uint64_t len
= msg
.u
.push_metadata
.len
;
1670 uint64_t key
= msg
.u
.push_metadata
.key
;
1671 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1672 uint64_t version
= msg
.u
.push_metadata
.version
;
1673 struct lttng_consumer_channel
*channel
;
1675 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1678 channel
= consumer_find_channel(key
);
1681 * This is possible if the metadata creation on the consumer side
1682 * is in flight vis-a-vis a concurrent push metadata from the
1683 * session daemon. Simply return that the channel failed and the
1684 * session daemon will handle that message correctly considering
1685 * that this race is acceptable thus the DBG() statement here.
1687 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1688 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1689 goto end_msg_sessiond
;
1692 health_code_update();
1696 * There is nothing to receive. We have simply
1697 * checked whether the channel can be found.
1699 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1700 goto end_msg_sessiond
;
1703 /* Tell session daemon we are ready to receive the metadata. */
1704 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1706 /* Somehow, the session daemon is not responding anymore. */
1710 health_code_update();
1712 /* Wait for more data. */
1713 health_poll_entry();
1714 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1720 health_code_update();
1722 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1723 len
, version
, channel
, 0, 1);
1725 /* error receiving from sessiond */
1729 goto end_msg_sessiond
;
1732 case LTTNG_CONSUMER_SETUP_METADATA
:
1736 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1740 goto end_msg_sessiond
;
1742 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1744 struct lttng_consumer_channel
*channel
;
1745 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1747 channel
= consumer_find_channel(key
);
1749 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1750 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1752 if (msg
.u
.snapshot_channel
.metadata
) {
1753 ret
= snapshot_metadata(channel
, key
,
1754 msg
.u
.snapshot_channel
.pathname
,
1755 msg
.u
.snapshot_channel
.relayd_id
,
1757 msg
.u
.snapshot_channel
.trace_archive_id
);
1759 ERR("Snapshot metadata failed");
1760 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1763 ret
= snapshot_channel(channel
, key
,
1764 msg
.u
.snapshot_channel
.pathname
,
1765 msg
.u
.snapshot_channel
.relayd_id
,
1766 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1769 ERR("Snapshot channel failed");
1770 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1774 health_code_update();
1775 ret
= consumer_send_status_msg(sock
, ret_code
);
1777 /* Somehow, the session daemon is not responding anymore. */
1780 health_code_update();
1783 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1786 uint64_t discarded_events
;
1787 struct lttng_ht_iter iter
;
1788 struct lttng_ht
*ht
;
1789 struct lttng_consumer_stream
*stream
;
1790 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1791 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1793 DBG("UST consumer discarded events command for session id %"
1796 pthread_mutex_lock(&consumer_data
.lock
);
1798 ht
= consumer_data
.stream_list_ht
;
1801 * We only need a reference to the channel, but they are not
1802 * directly indexed, so we just use the first matching stream
1803 * to extract the information we need, we default to 0 if not
1804 * found (no events are dropped if the channel is not yet in
1807 discarded_events
= 0;
1808 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1809 ht
->hash_fct(&id
, lttng_ht_seed
),
1811 &iter
.iter
, stream
, node_session_id
.node
) {
1812 if (stream
->chan
->key
== key
) {
1813 discarded_events
= stream
->chan
->discarded_events
;
1817 pthread_mutex_unlock(&consumer_data
.lock
);
1820 DBG("UST consumer discarded events command for session id %"
1821 PRIu64
", channel key %" PRIu64
, id
, key
);
1823 health_code_update();
1825 /* Send back returned value to session daemon */
1826 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1828 PERROR("send discarded events");
1834 case LTTNG_CONSUMER_LOST_PACKETS
:
1837 uint64_t lost_packets
;
1838 struct lttng_ht_iter iter
;
1839 struct lttng_ht
*ht
;
1840 struct lttng_consumer_stream
*stream
;
1841 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1842 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1844 DBG("UST consumer lost packets command for session id %"
1847 pthread_mutex_lock(&consumer_data
.lock
);
1849 ht
= consumer_data
.stream_list_ht
;
1852 * We only need a reference to the channel, but they are not
1853 * directly indexed, so we just use the first matching stream
1854 * to extract the information we need, we default to 0 if not
1855 * found (no packets lost if the channel is not yet in use).
1858 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1859 ht
->hash_fct(&id
, lttng_ht_seed
),
1861 &iter
.iter
, stream
, node_session_id
.node
) {
1862 if (stream
->chan
->key
== key
) {
1863 lost_packets
= stream
->chan
->lost_packets
;
1867 pthread_mutex_unlock(&consumer_data
.lock
);
1870 DBG("UST consumer lost packets command for session id %"
1871 PRIu64
", channel key %" PRIu64
, id
, key
);
1873 health_code_update();
1875 /* Send back returned value to session daemon */
1876 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1877 sizeof(lost_packets
));
1879 PERROR("send lost packets");
1885 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1887 int channel_monitor_pipe
;
1889 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1890 /* Successfully received the command's type. */
1891 ret
= consumer_send_status_msg(sock
, ret_code
);
1896 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1898 if (ret
!= sizeof(channel_monitor_pipe
)) {
1899 ERR("Failed to receive channel monitor pipe");
1903 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1904 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1905 channel_monitor_pipe
);
1909 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1910 /* Set the pipe as non-blocking. */
1911 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1913 PERROR("fcntl get flags of the channel monitoring pipe");
1918 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1919 flags
| O_NONBLOCK
);
1921 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1924 DBG("Channel monitor pipe set as non-blocking");
1926 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1928 goto end_msg_sessiond
;
1930 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
1932 struct lttng_consumer_channel
*channel
;
1933 uint64_t key
= msg
.u
.rotate_channel
.key
;
1935 channel
= consumer_find_channel(key
);
1937 DBG("Channel %" PRIu64
" not found", key
);
1938 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1941 * Sample the rotate position of all the streams in
1944 ret
= lttng_consumer_rotate_sample_channel(channel
, key
,
1945 msg
.u
.rotate_channel
.pathname
,
1946 msg
.u
.rotate_channel
.relayd_id
,
1947 msg
.u
.rotate_channel
.metadata
,
1948 msg
.u
.rotate_channel
.new_chunk_id
,
1951 ERR("Rotate channel failed");
1952 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
1955 health_code_update();
1957 ret
= consumer_send_status_msg(sock
, ret_code
);
1959 /* Somehow, the session daemon is not responding anymore. */
1964 * Rotate the streams that are ready right now.
1965 * FIXME: this is a second consecutive iteration over the
1966 * streams in a channel, there is probably a better way to
1967 * handle this, but it needs to be after the
1968 * consumer_send_status_msg() call.
1971 ret
= lttng_consumer_rotate_ready_streams(
1974 ERR("Rotate channel failed");
1979 case LTTNG_CONSUMER_ROTATE_RENAME
:
1981 DBG("Consumer rename session %" PRIu64
" after rotation",
1982 msg
.u
.rotate_rename
.session_id
);
1983 ret
= lttng_consumer_rotate_rename(msg
.u
.rotate_rename
.old_path
,
1984 msg
.u
.rotate_rename
.new_path
,
1985 msg
.u
.rotate_rename
.uid
,
1986 msg
.u
.rotate_rename
.gid
,
1987 msg
.u
.rotate_rename
.relayd_id
);
1989 ERR("Rotate rename failed");
1990 ret_code
= LTTCOMM_CONSUMERD_ROTATE_RENAME_FAILED
;
1993 health_code_update();
1995 ret
= consumer_send_status_msg(sock
, ret_code
);
1997 /* Somehow, the session daemon is not responding anymore. */
2002 case LTTNG_CONSUMER_CHECK_ROTATION_PENDING_LOCAL
:
2005 uint32_t pending_reply
;
2007 DBG("Perform local check of pending rotation for session id %" PRIu64
,
2008 msg
.u
.check_rotation_pending_local
.session_id
);
2009 pending
= lttng_consumer_check_rotation_pending_local(
2010 msg
.u
.check_rotation_pending_local
.session_id
,
2011 msg
.u
.check_rotation_pending_local
.chunk_id
);
2013 ERR("Local rotation pending check failed with code %i", pending
);
2014 ret_code
= LTTCOMM_CONSUMERD_ROTATION_PENDING_LOCAL_FAILED
;
2016 pending_reply
= !!pending
;
2019 health_code_update();
2021 ret
= consumer_send_status_msg(sock
, ret_code
);
2023 /* Somehow, the session daemon is not responding anymore. */
2029 * An error occurred while running the command;
2030 * don't send the 'pending' flag as the sessiond
2036 /* Send back returned value to session daemon */
2037 ret
= lttcomm_send_unix_sock(sock
, &pending_reply
,
2038 sizeof(pending_reply
));
2040 PERROR("Failed to send rotation pending return code");
2045 case LTTNG_CONSUMER_CHECK_ROTATION_PENDING_RELAY
:
2048 uint32_t pending_reply
;
2050 DBG("Perform relayd check of pending rotation for session id %" PRIu64
,
2051 msg
.u
.check_rotation_pending_relay
.session_id
);
2052 pending
= lttng_consumer_check_rotation_pending_relay(
2053 msg
.u
.check_rotation_pending_relay
.session_id
,
2054 msg
.u
.check_rotation_pending_relay
.relayd_id
,
2055 msg
.u
.check_rotation_pending_relay
.chunk_id
);
2057 ERR("Relayd rotation pending check failed with code %i", pending
);
2058 ret_code
= LTTCOMM_CONSUMERD_ROTATION_PENDING_RELAY_FAILED
;
2060 pending_reply
= !!pending
;
2063 health_code_update();
2065 ret
= consumer_send_status_msg(sock
, ret_code
);
2067 /* Somehow, the session daemon is not responding anymore. */
2073 * An error occurred while running the command;
2074 * don't send the 'pending' flag as the sessiond
2080 /* Send back returned value to session daemon */
2081 ret
= lttcomm_send_unix_sock(sock
, &pending_reply
,
2082 sizeof(pending_reply
));
2084 PERROR("Failed to send rotation pending return code");
2089 case LTTNG_CONSUMER_MKDIR
:
2091 DBG("Consumer mkdir %s in session %" PRIu64
,
2093 msg
.u
.mkdir
.session_id
);
2094 ret
= lttng_consumer_mkdir(msg
.u
.mkdir
.path
,
2097 msg
.u
.mkdir
.relayd_id
);
2099 ERR("consumer mkdir failed");
2100 ret_code
= LTTCOMM_CONSUMERD_MKDIR_FAILED
;
2103 health_code_update();
2105 ret
= consumer_send_status_msg(sock
, ret_code
);
2107 /* Somehow, the session daemon is not responding anymore. */
2119 health_code_update();
2122 * Return 1 to indicate success since the 0 value can be a socket
2123 * shutdown during the recv() or send() call.
2129 * The returned value here is not useful since either way we'll return 1 to
2130 * the caller because the session daemon socket management is done
2131 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
2133 ret
= consumer_send_status_msg(sock
, ret_code
);
2139 health_code_update();
2145 * Free channel here since no one has a reference to it. We don't
2146 * free after that because a stream can store this pointer.
2148 destroy_channel(channel
);
2150 /* We have to send a status channel message indicating an error. */
2151 ret
= consumer_send_status_channel(sock
, NULL
);
2153 /* Stop everything if session daemon can not be notified. */
2158 health_code_update();
2163 /* This will issue a consumer stop. */
2168 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
2169 * compiled out, we isolate it in this library.
2171 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
2175 assert(stream
->ustream
);
2177 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
2181 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
2182 * compiled out, we isolate it in this library.
2184 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
2187 assert(stream
->ustream
);
2189 return ustctl_get_mmap_base(stream
->ustream
);
2193 * Take a snapshot for a specific stream.
2195 * Returns 0 on success, < 0 on error
2197 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2200 assert(stream
->ustream
);
2202 return ustctl_snapshot(stream
->ustream
);
2206 * Sample consumed and produced positions for a specific stream.
2208 * Returns 0 on success, < 0 on error.
2210 int lttng_ustconsumer_sample_snapshot_positions(
2211 struct lttng_consumer_stream
*stream
)
2214 assert(stream
->ustream
);
2216 return ustctl_snapshot_sample_positions(stream
->ustream
);
2220 * Get the produced position
2222 * Returns 0 on success, < 0 on error
2224 int lttng_ustconsumer_get_produced_snapshot(
2225 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2228 assert(stream
->ustream
);
2231 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2235 * Get the consumed position
2237 * Returns 0 on success, < 0 on error
2239 int lttng_ustconsumer_get_consumed_snapshot(
2240 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2243 assert(stream
->ustream
);
2246 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2249 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2253 assert(stream
->ustream
);
2255 ustctl_flush_buffer(stream
->ustream
, producer
);
2258 int lttng_ustconsumer_get_current_timestamp(
2259 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2262 assert(stream
->ustream
);
2265 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2268 int lttng_ustconsumer_get_sequence_number(
2269 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2272 assert(stream
->ustream
);
2275 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2279 * Called when the stream signals the consumer that it has hung up.
2281 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2284 assert(stream
->ustream
);
2286 pthread_mutex_lock(&stream
->lock
);
2287 if (!stream
->quiescent
) {
2288 lttng_ustconsumer_flush_buffer(stream
, 0);
2289 stream
->quiescent
= true;
2291 pthread_mutex_unlock(&stream
->lock
);
2292 stream
->hangup_flush_done
= 1;
2295 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2300 assert(chan
->uchan
);
2302 if (chan
->switch_timer_enabled
== 1) {
2303 consumer_timer_switch_stop(chan
);
2305 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2308 ret
= close(chan
->stream_fds
[i
]);
2312 if (chan
->shm_path
[0]) {
2313 char shm_path
[PATH_MAX
];
2315 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2317 ERR("Cannot get stream shm path");
2319 ret
= run_as_unlink(shm_path
, chan
->uid
, chan
->gid
);
2321 PERROR("unlink %s", shm_path
);
2327 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2330 assert(chan
->uchan
);
2332 consumer_metadata_cache_destroy(chan
);
2333 ustctl_destroy_channel(chan
->uchan
);
2334 /* Try to rmdir all directories under shm_path root. */
2335 if (chan
->root_shm_path
[0]) {
2336 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2337 chan
->uid
, chan
->gid
);
2339 free(chan
->stream_fds
);
2342 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2345 assert(stream
->ustream
);
2347 if (stream
->chan
->switch_timer_enabled
== 1) {
2348 consumer_timer_switch_stop(stream
->chan
);
2350 ustctl_destroy_stream(stream
->ustream
);
2353 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2356 assert(stream
->ustream
);
2358 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2361 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2364 assert(stream
->ustream
);
2366 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2370 * Populate index values of a UST stream. Values are set in big endian order.
2372 * Return 0 on success or else a negative value.
2374 static int get_index_values(struct ctf_packet_index
*index
,
2375 struct ustctl_consumer_stream
*ustream
)
2379 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2381 PERROR("ustctl_get_timestamp_begin");
2384 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2386 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2388 PERROR("ustctl_get_timestamp_end");
2391 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2393 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2395 PERROR("ustctl_get_events_discarded");
2398 index
->events_discarded
= htobe64(index
->events_discarded
);
2400 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2402 PERROR("ustctl_get_content_size");
2405 index
->content_size
= htobe64(index
->content_size
);
2407 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2409 PERROR("ustctl_get_packet_size");
2412 index
->packet_size
= htobe64(index
->packet_size
);
2414 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2416 PERROR("ustctl_get_stream_id");
2419 index
->stream_id
= htobe64(index
->stream_id
);
2421 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2423 PERROR("ustctl_get_instance_id");
2426 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2428 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2430 PERROR("ustctl_get_sequence_number");
2433 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2440 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
,
2441 struct consumer_metadata_cache
*cache
)
2443 DBG("Metadata stream update to version %" PRIu64
,
2445 stream
->ust_metadata_pushed
= 0;
2446 stream
->metadata_version
= cache
->version
;
2447 stream
->reset_metadata_flag
= 1;
2451 * Check if the version of the metadata stream and metadata cache match.
2452 * If the cache got updated, reset the metadata stream.
2453 * The stream lock and metadata cache lock MUST be held.
2454 * Return 0 on success, a negative value on error.
2457 int metadata_stream_check_version(struct lttng_consumer_stream
*stream
)
2460 struct consumer_metadata_cache
*cache
= stream
->chan
->metadata_cache
;
2462 if (cache
->version
== stream
->metadata_version
) {
2465 metadata_stream_reset_cache(stream
, cache
);
2472 * Write up to one packet from the metadata cache to the channel.
2474 * Returns the number of bytes pushed in the cache, or a negative value
2478 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2483 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2484 ret
= metadata_stream_check_version(stream
);
2488 if (stream
->chan
->metadata_cache
->max_offset
2489 == stream
->ust_metadata_pushed
) {
2494 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2495 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2496 stream
->chan
->metadata_cache
->max_offset
2497 - stream
->ust_metadata_pushed
);
2498 assert(write_len
!= 0);
2499 if (write_len
< 0) {
2500 ERR("Writing one metadata packet");
2504 stream
->ust_metadata_pushed
+= write_len
;
2506 assert(stream
->chan
->metadata_cache
->max_offset
>=
2507 stream
->ust_metadata_pushed
);
2511 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2517 * Sync metadata meaning request them to the session daemon and snapshot to the
2518 * metadata thread can consumer them.
2520 * Metadata stream lock is held here, but we need to release it when
2521 * interacting with sessiond, else we cause a deadlock with live
2522 * awaiting on metadata to be pushed out.
2524 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2525 * is empty or a negative value on error.
2527 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2528 struct lttng_consumer_stream
*metadata
)
2536 pthread_mutex_unlock(&metadata
->lock
);
2538 * Request metadata from the sessiond, but don't wait for the flush
2539 * because we locked the metadata thread.
2541 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2542 pthread_mutex_lock(&metadata
->lock
);
2547 ret
= commit_one_metadata_packet(metadata
);
2550 } else if (ret
> 0) {
2554 lttng_ustconsumer_flush_buffer(metadata
, 1);
2555 ret
= ustctl_snapshot(metadata
->ustream
);
2557 if (errno
!= EAGAIN
) {
2558 ERR("Sync metadata, taking UST snapshot");
2561 DBG("No new metadata when syncing them.");
2562 /* No new metadata, exit. */
2568 * After this flush, we still need to extract metadata.
2579 * Return 0 on success else a negative value.
2581 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2582 struct lttng_consumer_local_data
*ctx
)
2585 struct ustctl_consumer_stream
*ustream
;
2590 ustream
= stream
->ustream
;
2593 * First, we are going to check if there is a new subbuffer available
2594 * before reading the stream wait_fd.
2596 /* Get the next subbuffer */
2597 ret
= ustctl_get_next_subbuf(ustream
);
2599 /* No more data found, flag the stream. */
2600 stream
->has_data
= 0;
2605 ret
= ustctl_put_subbuf(ustream
);
2608 /* This stream still has data. Flag it and wake up the data thread. */
2609 stream
->has_data
= 1;
2611 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2614 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2615 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2620 /* The wake up pipe has been notified. */
2621 ctx
->has_wakeup
= 1;
2630 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2633 uint64_t seq
, discarded
;
2635 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2637 PERROR("ustctl_get_sequence_number");
2641 * Start the sequence when we extract the first packet in case we don't
2642 * start at 0 (for example if a consumer is not connected to the
2643 * session immediately after the beginning).
2645 if (stream
->last_sequence_number
== -1ULL) {
2646 stream
->last_sequence_number
= seq
;
2647 } else if (seq
> stream
->last_sequence_number
) {
2648 stream
->chan
->lost_packets
+= seq
-
2649 stream
->last_sequence_number
- 1;
2651 /* seq <= last_sequence_number */
2652 ERR("Sequence number inconsistent : prev = %" PRIu64
2653 ", current = %" PRIu64
,
2654 stream
->last_sequence_number
, seq
);
2658 stream
->last_sequence_number
= seq
;
2660 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2662 PERROR("kernctl_get_events_discarded");
2665 if (discarded
< stream
->last_discarded_events
) {
2667 * Overflow has occurred. We assume only one wrap-around
2670 stream
->chan
->discarded_events
+=
2671 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2672 stream
->last_discarded_events
+ discarded
;
2674 stream
->chan
->discarded_events
+= discarded
-
2675 stream
->last_discarded_events
;
2677 stream
->last_discarded_events
= discarded
;
2685 * Read subbuffer from the given stream.
2687 * Stream lock MUST be acquired.
2689 * Return 0 on success else a negative value.
2691 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2692 struct lttng_consumer_local_data
*ctx
, bool *rotated
)
2694 unsigned long len
, subbuf_size
, padding
;
2695 int err
, write_index
= 1, rotation_ret
;
2697 struct ustctl_consumer_stream
*ustream
;
2698 struct ctf_packet_index index
;
2701 assert(stream
->ustream
);
2704 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2707 /* Ease our life for what's next. */
2708 ustream
= stream
->ustream
;
2711 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2712 * error if we cannot read this one byte (read returns 0), or if the error
2713 * is EAGAIN or EWOULDBLOCK.
2715 * This is only done when the stream is monitored by a thread, before the
2716 * flush is done after a hangup and if the stream is not flagged with data
2717 * since there might be nothing to consume in the wait fd but still have
2718 * data available flagged by the consumer wake up pipe.
2720 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2724 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2725 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2732 * If the stream was flagged to be ready for rotation before we extract the
2733 * next packet, rotate it now.
2735 if (stream
->rotate_ready
) {
2736 DBG("Rotate stream before extracting data");
2737 rotation_ret
= lttng_consumer_rotate_stream(ctx
, stream
, rotated
);
2738 if (rotation_ret
< 0) {
2739 ERR("Stream rotation error");
2746 /* Get the next subbuffer */
2747 err
= ustctl_get_next_subbuf(ustream
);
2750 * Populate metadata info if the existing info has
2751 * already been read.
2753 if (stream
->metadata_flag
) {
2754 ret
= commit_one_metadata_packet(stream
);
2758 lttng_ustconsumer_flush_buffer(stream
, 1);
2762 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2764 * This is a debug message even for single-threaded consumer,
2765 * because poll() have more relaxed criterions than get subbuf,
2766 * so get_subbuf may fail for short race windows where poll()
2767 * would issue wakeups.
2769 DBG("Reserving sub buffer failed (everything is normal, "
2770 "it is due to concurrency) [ret: %d]", err
);
2773 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2775 if (!stream
->metadata_flag
) {
2776 index
.offset
= htobe64(stream
->out_fd_offset
);
2777 ret
= get_index_values(&index
, ustream
);
2779 err
= ustctl_put_subbuf(ustream
);
2784 /* Update the stream's sequence and discarded events count. */
2785 ret
= update_stream_stats(stream
);
2787 PERROR("kernctl_get_events_discarded");
2788 err
= ustctl_put_subbuf(ustream
);
2796 /* Get the full padded subbuffer size */
2797 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2800 /* Get subbuffer data size (without padding) */
2801 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2804 /* Make sure we don't get a subbuffer size bigger than the padded */
2805 assert(len
>= subbuf_size
);
2807 padding
= len
- subbuf_size
;
2809 /* write the subbuffer to the tracefile */
2810 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2812 * The mmap operation should write subbuf_size amount of data when network
2813 * streaming or the full padding (len) size when we are _not_ streaming.
2815 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2816 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2818 * Display the error but continue processing to try to release the
2819 * subbuffer. This is a DBG statement since any unexpected kill or
2820 * signal, the application gets unregistered, relayd gets closed or
2821 * anything that affects the buffer lifetime will trigger this error.
2822 * So, for the sake of the user, don't print this error since it can
2823 * happen and it is OK with the code flow.
2825 DBG("Error writing to tracefile "
2826 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2827 ret
, len
, subbuf_size
);
2830 err
= ustctl_put_next_subbuf(ustream
);
2834 * This will consumer the byte on the wait_fd if and only if there is not
2835 * next subbuffer to be acquired.
2837 if (!stream
->metadata_flag
) {
2838 ret
= notify_if_more_data(stream
, ctx
);
2844 /* Write index if needed. */
2849 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2851 * In live, block until all the metadata is sent.
2853 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2854 assert(!stream
->missed_metadata_flush
);
2855 stream
->waiting_on_metadata
= true;
2856 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2858 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2860 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2861 stream
->waiting_on_metadata
= false;
2862 if (stream
->missed_metadata_flush
) {
2863 stream
->missed_metadata_flush
= false;
2864 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2865 (void) consumer_flush_ust_index(stream
);
2867 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2875 assert(!stream
->metadata_flag
);
2876 err
= consumer_stream_write_index(stream
, &index
);
2883 * After extracting the packet, we check if the stream is now ready to be
2884 * rotated and perform the action immediately.
2886 rotation_ret
= lttng_consumer_stream_is_rotate_ready(stream
);
2887 if (rotation_ret
== 1) {
2888 rotation_ret
= lttng_consumer_rotate_stream(ctx
, stream
, rotated
);
2889 if (rotation_ret
< 0) {
2890 ERR("Stream rotation error");
2894 } else if (rotation_ret
< 0) {
2895 ERR("Checking if stream is ready to rotate");
2904 * Called when a stream is created.
2906 * Return 0 on success or else a negative value.
2908 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2914 /* Don't create anything if this is set for streaming. */
2915 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2916 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2917 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2918 stream
->uid
, stream
->gid
, NULL
);
2922 stream
->out_fd
= ret
;
2923 stream
->tracefile_size_current
= 0;
2925 if (!stream
->metadata_flag
) {
2926 struct lttng_index_file
*index_file
;
2928 index_file
= lttng_index_file_create(stream
->chan
->pathname
,
2929 stream
->name
, stream
->uid
, stream
->gid
,
2930 stream
->chan
->tracefile_size
,
2931 stream
->tracefile_count_current
,
2932 CTF_INDEX_MAJOR
, CTF_INDEX_MINOR
);
2936 assert(!stream
->index_file
);
2937 stream
->index_file
= index_file
;
2947 * Check if data is still being extracted from the buffers for a specific
2948 * stream. Consumer data lock MUST be acquired before calling this function
2949 * and the stream lock.
2951 * Return 1 if the traced data are still getting read else 0 meaning that the
2952 * data is available for trace viewer reading.
2954 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2959 assert(stream
->ustream
);
2961 DBG("UST consumer checking data pending");
2963 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2968 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2969 uint64_t contiguous
, pushed
;
2971 /* Ease our life a bit. */
2972 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2973 pushed
= stream
->ust_metadata_pushed
;
2976 * We can simply check whether all contiguously available data
2977 * has been pushed to the ring buffer, since the push operation
2978 * is performed within get_next_subbuf(), and because both
2979 * get_next_subbuf() and put_next_subbuf() are issued atomically
2980 * thanks to the stream lock within
2981 * lttng_ustconsumer_read_subbuffer(). This basically means that
2982 * whetnever ust_metadata_pushed is incremented, the associated
2983 * metadata has been consumed from the metadata stream.
2985 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2986 contiguous
, pushed
);
2987 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2988 if ((contiguous
!= pushed
) ||
2989 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2990 ret
= 1; /* Data is pending */
2994 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2997 * There is still data so let's put back this
3000 ret
= ustctl_put_subbuf(stream
->ustream
);
3002 ret
= 1; /* Data is pending */
3007 /* Data is NOT pending so ready to be read. */
3015 * Stop a given metadata channel timer if enabled and close the wait fd which
3016 * is the poll pipe of the metadata stream.
3018 * This MUST be called with the metadata channel acquired.
3020 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
3025 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
3027 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
3029 if (metadata
->switch_timer_enabled
== 1) {
3030 consumer_timer_switch_stop(metadata
);
3033 if (!metadata
->metadata_stream
) {
3038 * Closing write side so the thread monitoring the stream wakes up if any
3039 * and clean the metadata stream.
3041 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
3042 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
3044 PERROR("closing metadata pipe write side");
3046 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3054 * Close every metadata stream wait fd of the metadata hash table. This
3055 * function MUST be used very carefully so not to run into a race between the
3056 * metadata thread handling streams and this function closing their wait fd.
3058 * For UST, this is used when the session daemon hangs up. Its the metadata
3059 * producer so calling this is safe because we are assured that no state change
3060 * can occur in the metadata thread for the streams in the hash table.
3062 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3064 struct lttng_ht_iter iter
;
3065 struct lttng_consumer_stream
*stream
;
3067 assert(metadata_ht
);
3068 assert(metadata_ht
->ht
);
3070 DBG("UST consumer closing all metadata streams");
3073 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3076 health_code_update();
3078 pthread_mutex_lock(&stream
->chan
->lock
);
3079 lttng_ustconsumer_close_metadata(stream
->chan
);
3080 pthread_mutex_unlock(&stream
->chan
->lock
);
3086 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3090 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
3092 ERR("Unable to close wakeup fd");
3097 * Please refer to consumer-timer.c before adding any lock within this
3098 * function or any of its callees. Timers have a very strict locking
3099 * semantic with respect to teardown. Failure to respect this semantic
3100 * introduces deadlocks.
3102 * DON'T hold the metadata lock when calling this function, else this
3103 * can cause deadlock involving consumer awaiting for metadata to be
3104 * pushed out due to concurrent interaction with the session daemon.
3106 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3107 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3109 struct lttcomm_metadata_request_msg request
;
3110 struct lttcomm_consumer_msg msg
;
3111 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3112 uint64_t len
, key
, offset
, version
;
3116 assert(channel
->metadata_cache
);
3118 memset(&request
, 0, sizeof(request
));
3120 /* send the metadata request to sessiond */
3121 switch (consumer_data
.type
) {
3122 case LTTNG_CONSUMER64_UST
:
3123 request
.bits_per_long
= 64;
3125 case LTTNG_CONSUMER32_UST
:
3126 request
.bits_per_long
= 32;
3129 request
.bits_per_long
= 0;
3133 request
.session_id
= channel
->session_id
;
3134 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3136 * Request the application UID here so the metadata of that application can
3137 * be sent back. The channel UID corresponds to the user UID of the session
3138 * used for the rights on the stream file(s).
3140 request
.uid
= channel
->ust_app_uid
;
3141 request
.key
= channel
->key
;
3143 DBG("Sending metadata request to sessiond, session id %" PRIu64
3144 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3145 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3148 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3150 health_code_update();
3152 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3155 ERR("Asking metadata to sessiond");
3159 health_code_update();
3161 /* Receive the metadata from sessiond */
3162 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3164 if (ret
!= sizeof(msg
)) {
3165 DBG("Consumer received unexpected message size %d (expects %zu)",
3167 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3169 * The ret value might 0 meaning an orderly shutdown but this is ok
3170 * since the caller handles this.
3175 health_code_update();
3177 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3178 /* No registry found */
3179 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3183 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3184 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3189 len
= msg
.u
.push_metadata
.len
;
3190 key
= msg
.u
.push_metadata
.key
;
3191 offset
= msg
.u
.push_metadata
.target_offset
;
3192 version
= msg
.u
.push_metadata
.version
;
3194 assert(key
== channel
->key
);
3196 DBG("No new metadata to receive for key %" PRIu64
, key
);
3199 health_code_update();
3201 /* Tell session daemon we are ready to receive the metadata. */
3202 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3203 LTTCOMM_CONSUMERD_SUCCESS
);
3204 if (ret
< 0 || len
== 0) {
3206 * Somehow, the session daemon is not responding anymore or there is
3207 * nothing to receive.
3212 health_code_update();
3214 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3215 key
, offset
, len
, version
, channel
, timer
, wait
);
3218 * Only send the status msg if the sessiond is alive meaning a positive
3221 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3226 health_code_update();
3228 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3233 * Return the ustctl call for the get stream id.
3235 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3236 uint64_t *stream_id
)
3241 return ustctl_get_stream_id(stream
->ustream
, stream_id
);