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
);
76 lttng_trace_chunk_put(stream
->trace_chunk
);
81 * If a channel is available meaning that was created before the streams
85 lttng_ustconsumer_del_channel(channel
);
86 lttng_ustconsumer_free_channel(channel
);
92 * Add channel to internal consumer state.
94 * Returns 0 on success or else a negative value.
96 static int add_channel(struct lttng_consumer_channel
*channel
,
97 struct lttng_consumer_local_data
*ctx
)
104 if (ctx
->on_recv_channel
!= NULL
) {
105 ret
= ctx
->on_recv_channel(channel
);
107 ret
= consumer_add_channel(channel
, ctx
);
108 } else if (ret
< 0) {
109 /* Most likely an ENOMEM. */
110 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
114 ret
= consumer_add_channel(channel
, ctx
);
117 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
124 * Allocate and return a consumer channel object.
126 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
127 const uint64_t *chunk_id
, const char *pathname
, const char *name
,
128 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
129 uint64_t tracefile_size
, uint64_t tracefile_count
,
130 uint64_t session_id_per_pid
, unsigned int monitor
,
131 unsigned int live_timer_interval
,
132 const char *root_shm_path
, const char *shm_path
)
137 return consumer_allocate_channel(key
, session_id
, chunk_id
, pathname
,
138 name
, relayd_id
, output
, tracefile_size
,
139 tracefile_count
, session_id_per_pid
, monitor
,
140 live_timer_interval
, root_shm_path
, shm_path
);
144 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
145 * error value if applicable is set in it else it is kept untouched.
147 * Return NULL on error else the newly allocated stream object.
149 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
150 struct lttng_consumer_channel
*channel
,
151 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
154 struct lttng_consumer_stream
*stream
= NULL
;
159 stream
= consumer_allocate_stream(channel
->key
,
164 channel
->trace_chunk
,
169 if (stream
== NULL
) {
173 * We could not find the channel. Can happen if cpu hotplug
174 * happens while tearing down.
176 DBG3("Could not find channel");
181 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
187 consumer_stream_update_channel_attributes(stream
, channel
);
188 stream
->chan
= channel
;
192 *_alloc_ret
= alloc_ret
;
198 * Send the given stream pointer to the corresponding thread.
200 * Returns 0 on success else a negative value.
202 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
203 struct lttng_consumer_local_data
*ctx
)
206 struct lttng_pipe
*stream_pipe
;
208 /* Get the right pipe where the stream will be sent. */
209 if (stream
->metadata_flag
) {
210 consumer_add_metadata_stream(stream
);
211 stream_pipe
= ctx
->consumer_metadata_pipe
;
213 consumer_add_data_stream(stream
);
214 stream_pipe
= ctx
->consumer_data_pipe
;
218 * From this point on, the stream's ownership has been moved away from
219 * the channel and it becomes globally visible. Hence, remove it from
220 * the local stream list to prevent the stream from being both local and
223 stream
->globally_visible
= 1;
224 cds_list_del(&stream
->send_node
);
226 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
228 ERR("Consumer write %s stream to pipe %d",
229 stream
->metadata_flag
? "metadata" : "data",
230 lttng_pipe_get_writefd(stream_pipe
));
231 if (stream
->metadata_flag
) {
232 consumer_del_stream_for_metadata(stream
);
234 consumer_del_stream_for_data(stream
);
244 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
246 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
249 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
250 stream_shm_path
[PATH_MAX
- 1] = '\0';
251 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
256 strncat(stream_shm_path
, cpu_nr
,
257 PATH_MAX
- strlen(stream_shm_path
) - 1);
264 * Create streams for the given channel using liblttng-ust-ctl.
265 * The channel lock must be acquired by the caller.
267 * Return 0 on success else a negative value.
269 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
270 struct lttng_consumer_local_data
*ctx
)
273 struct ustctl_consumer_stream
*ustream
;
274 struct lttng_consumer_stream
*stream
;
275 pthread_mutex_t
*current_stream_lock
= NULL
;
281 * While a stream is available from ustctl. When NULL is returned, we've
282 * reached the end of the possible stream for the channel.
284 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
286 int ust_metadata_pipe
[2];
288 health_code_update();
290 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
291 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
293 ERR("Create ust metadata poll pipe");
296 wait_fd
= ust_metadata_pipe
[0];
298 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
301 /* Allocate consumer stream object. */
302 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
306 stream
->ustream
= ustream
;
308 * Store it so we can save multiple function calls afterwards since
309 * this value is used heavily in the stream threads. This is UST
310 * specific so this is why it's done after allocation.
312 stream
->wait_fd
= wait_fd
;
315 * Increment channel refcount since the channel reference has now been
316 * assigned in the allocation process above.
318 if (stream
->chan
->monitor
) {
319 uatomic_inc(&stream
->chan
->refcount
);
322 pthread_mutex_lock(&stream
->lock
);
323 current_stream_lock
= &stream
->lock
;
325 * Order is important this is why a list is used. On error, the caller
326 * should clean this list.
328 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
330 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
331 &stream
->max_sb_size
);
333 ERR("ustctl_get_max_subbuf_size failed for stream %s",
338 /* Do actions once stream has been received. */
339 if (ctx
->on_recv_stream
) {
340 ret
= ctx
->on_recv_stream(stream
);
346 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
347 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
349 /* Set next CPU stream. */
350 channel
->streams
.count
= ++cpu
;
352 /* Keep stream reference when creating metadata. */
353 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
354 channel
->metadata_stream
= stream
;
355 if (channel
->monitor
) {
356 /* Set metadata poll pipe if we created one */
357 memcpy(stream
->ust_metadata_poll_pipe
,
359 sizeof(ust_metadata_pipe
));
362 pthread_mutex_unlock(&stream
->lock
);
363 current_stream_lock
= NULL
;
370 if (current_stream_lock
) {
371 pthread_mutex_unlock(current_stream_lock
);
377 * create_posix_shm is never called concurrently within a process.
380 int create_posix_shm(void)
382 char tmp_name
[NAME_MAX
];
385 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
391 * Allocate shm, and immediately unlink its shm oject, keeping
392 * only the file descriptor as a reference to the object.
393 * We specifically do _not_ use the / at the beginning of the
394 * pathname so that some OS implementations can keep it local to
395 * the process (POSIX leaves this implementation-defined).
397 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
402 ret
= shm_unlink(tmp_name
);
403 if (ret
< 0 && errno
!= ENOENT
) {
404 PERROR("shm_unlink");
405 goto error_shm_release
;
418 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
, int cpu
,
419 const struct lttng_credentials
*session_credentials
)
421 char shm_path
[PATH_MAX
];
424 if (!channel
->shm_path
[0]) {
425 return create_posix_shm();
427 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
431 return run_as_open(shm_path
,
432 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
433 session_credentials
->uid
, session_credentials
->gid
);
440 * Create an UST channel with the given attributes and send it to the session
441 * daemon using the ust ctl API.
443 * Return 0 on success or else a negative value.
445 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
446 struct ustctl_consumer_channel_attr
*attr
,
447 struct ustctl_consumer_channel
**ust_chanp
)
449 int ret
, nr_stream_fds
, i
, j
;
451 struct ustctl_consumer_channel
*ust_channel
;
456 assert(channel
->buffer_credentials
.is_set
);
458 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
459 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
460 "switch_timer_interval: %u, read_timer_interval: %u, "
461 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
462 attr
->num_subbuf
, attr
->switch_timer_interval
,
463 attr
->read_timer_interval
, attr
->output
, attr
->type
);
465 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
468 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
469 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
474 for (i
= 0; i
< nr_stream_fds
; i
++) {
475 stream_fds
[i
] = open_ust_stream_fd(channel
, i
,
476 &channel
->buffer_credentials
.value
);
477 if (stream_fds
[i
] < 0) {
482 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
487 channel
->nr_stream_fds
= nr_stream_fds
;
488 channel
->stream_fds
= stream_fds
;
489 *ust_chanp
= ust_channel
;
495 for (j
= i
- 1; j
>= 0; j
--) {
498 closeret
= close(stream_fds
[j
]);
502 if (channel
->shm_path
[0]) {
503 char shm_path
[PATH_MAX
];
505 closeret
= get_stream_shm_path(shm_path
,
506 channel
->shm_path
, j
);
508 ERR("Cannot get stream shm path");
510 closeret
= run_as_unlink(shm_path
,
511 channel
->buffer_credentials
.value
.uid
,
512 channel
->buffer_credentials
.value
.gid
);
514 PERROR("unlink %s", shm_path
);
518 /* Try to rmdir all directories under shm_path root. */
519 if (channel
->root_shm_path
[0]) {
520 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
521 channel
->buffer_credentials
.value
.uid
,
522 channel
->buffer_credentials
.value
.gid
);
530 * Send a single given stream to the session daemon using the sock.
532 * Return 0 on success else a negative value.
534 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
541 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
543 /* Send stream to session daemon. */
544 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
554 * Send channel to sessiond and relayd if applicable.
556 * Return 0 on success or else a negative value.
558 static int send_channel_to_sessiond_and_relayd(int sock
,
559 struct lttng_consumer_channel
*channel
,
560 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
562 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
563 struct lttng_consumer_stream
*stream
;
564 uint64_t net_seq_idx
= -1ULL;
570 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
572 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
573 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
575 health_code_update();
577 /* Try to send the stream to the relayd if one is available. */
578 DBG("Sending stream %" PRIu64
" of channel \"%s\" to relayd",
579 stream
->key
, channel
->name
);
580 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
583 * Flag that the relayd was the problem here probably due to a
584 * communicaton error on the socket.
589 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
591 if (net_seq_idx
== -1ULL) {
592 net_seq_idx
= stream
->net_seq_idx
;
597 /* Inform sessiond that we are about to send channel and streams. */
598 ret
= consumer_send_status_msg(sock
, ret_code
);
599 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
601 * Either the session daemon is not responding or the relayd died so we
607 /* Send channel to sessiond. */
608 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
613 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
618 /* The channel was sent successfully to the sessiond at this point. */
619 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
621 health_code_update();
623 /* Send stream to session daemon. */
624 ret
= send_sessiond_stream(sock
, stream
);
630 /* Tell sessiond there is no more stream. */
631 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
636 DBG("UST consumer NULL stream sent to sessiond");
641 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
648 * Creates a channel and streams and add the channel it to the channel internal
649 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
652 * Return 0 on success or else, a negative value is returned and the channel
653 * MUST be destroyed by consumer_del_channel().
655 static int ask_channel(struct lttng_consumer_local_data
*ctx
,
656 struct lttng_consumer_channel
*channel
,
657 struct ustctl_consumer_channel_attr
*attr
)
666 * This value is still used by the kernel consumer since for the kernel,
667 * the stream ownership is not IN the consumer so we need to have the
668 * number of left stream that needs to be initialized so we can know when
669 * to delete the channel (see consumer.c).
671 * As for the user space tracer now, the consumer creates and sends the
672 * stream to the session daemon which only sends them to the application
673 * once every stream of a channel is received making this value useless
674 * because we they will be added to the poll thread before the application
675 * receives them. This ensures that a stream can not hang up during
676 * initilization of a channel.
678 channel
->nb_init_stream_left
= 0;
680 /* The reply msg status is handled in the following call. */
681 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
686 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
689 * For the snapshots (no monitor), we create the metadata streams
690 * on demand, not during the channel creation.
692 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
697 /* Open all streams for this channel. */
698 pthread_mutex_lock(&channel
->lock
);
699 ret
= create_ust_streams(channel
, ctx
);
700 pthread_mutex_unlock(&channel
->lock
);
710 * Send all stream of a channel to the right thread handling it.
712 * On error, return a negative value else 0 on success.
714 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
715 struct lttng_consumer_local_data
*ctx
)
718 struct lttng_consumer_stream
*stream
, *stmp
;
723 /* Send streams to the corresponding thread. */
724 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
727 health_code_update();
729 /* Sending the stream to the thread. */
730 ret
= send_stream_to_thread(stream
, ctx
);
733 * If we are unable to send the stream to the thread, there is
734 * a big problem so just stop everything.
745 * Flush channel's streams using the given key to retrieve the channel.
747 * Return 0 on success else an LTTng error code.
749 static int flush_channel(uint64_t chan_key
)
752 struct lttng_consumer_channel
*channel
;
753 struct lttng_consumer_stream
*stream
;
755 struct lttng_ht_iter iter
;
757 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
760 channel
= consumer_find_channel(chan_key
);
762 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
763 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
767 ht
= consumer_data
.stream_per_chan_id_ht
;
769 /* For each stream of the channel id, flush it. */
770 cds_lfht_for_each_entry_duplicate(ht
->ht
,
771 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
772 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
774 health_code_update();
776 pthread_mutex_lock(&stream
->lock
);
777 if (!stream
->quiescent
) {
778 ustctl_flush_buffer(stream
->ustream
, 0);
779 stream
->quiescent
= true;
781 pthread_mutex_unlock(&stream
->lock
);
789 * Clear quiescent state from channel's streams using the given key to
790 * retrieve the channel.
792 * Return 0 on success else an LTTng error code.
794 static int clear_quiescent_channel(uint64_t chan_key
)
797 struct lttng_consumer_channel
*channel
;
798 struct lttng_consumer_stream
*stream
;
800 struct lttng_ht_iter iter
;
802 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
805 channel
= consumer_find_channel(chan_key
);
807 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
808 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
812 ht
= consumer_data
.stream_per_chan_id_ht
;
814 /* For each stream of the channel id, clear quiescent state. */
815 cds_lfht_for_each_entry_duplicate(ht
->ht
,
816 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
817 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
819 health_code_update();
821 pthread_mutex_lock(&stream
->lock
);
822 stream
->quiescent
= false;
823 pthread_mutex_unlock(&stream
->lock
);
831 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
833 * Return 0 on success else an LTTng error code.
835 static int close_metadata(uint64_t chan_key
)
838 struct lttng_consumer_channel
*channel
;
839 unsigned int channel_monitor
;
841 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
843 channel
= consumer_find_channel(chan_key
);
846 * This is possible if the metadata thread has issue a delete because
847 * the endpoint point of the stream hung up. There is no way the
848 * session daemon can know about it thus use a DBG instead of an actual
851 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
852 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
856 pthread_mutex_lock(&consumer_data
.lock
);
857 pthread_mutex_lock(&channel
->lock
);
858 channel_monitor
= channel
->monitor
;
859 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
863 lttng_ustconsumer_close_metadata(channel
);
864 pthread_mutex_unlock(&channel
->lock
);
865 pthread_mutex_unlock(&consumer_data
.lock
);
868 * The ownership of a metadata channel depends on the type of
869 * session to which it belongs. In effect, the monitor flag is checked
870 * to determine if this metadata channel is in "snapshot" mode or not.
872 * In the non-snapshot case, the metadata channel is created along with
873 * a single stream which will remain present until the metadata channel
874 * is destroyed (on the destruction of its session). In this case, the
875 * metadata stream in "monitored" by the metadata poll thread and holds
876 * the ownership of its channel.
878 * Closing the metadata will cause the metadata stream's "metadata poll
879 * pipe" to be closed. Closing this pipe will wake-up the metadata poll
880 * thread which will teardown the metadata stream which, in return,
881 * deletes the metadata channel.
883 * In the snapshot case, the metadata stream is created and destroyed
884 * on every snapshot record. Since the channel doesn't have an owner
885 * other than the session daemon, it is safe to destroy it immediately
886 * on reception of the CLOSE_METADATA command.
888 if (!channel_monitor
) {
890 * The channel and consumer_data locks must be
891 * released before this call since consumer_del_channel
892 * re-acquires the channel and consumer_data locks to teardown
893 * the channel and queue its reclamation by the "call_rcu"
896 consumer_del_channel(channel
);
901 pthread_mutex_unlock(&channel
->lock
);
902 pthread_mutex_unlock(&consumer_data
.lock
);
908 * RCU read side lock MUST be acquired before calling this function.
910 * Return 0 on success else an LTTng error code.
912 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
915 struct lttng_consumer_channel
*metadata
;
917 DBG("UST consumer setup metadata key %" PRIu64
, key
);
919 metadata
= consumer_find_channel(key
);
921 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
922 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
927 * In no monitor mode, the metadata channel has no stream(s) so skip the
928 * ownership transfer to the metadata thread.
930 if (!metadata
->monitor
) {
931 DBG("Metadata channel in no monitor");
937 * Send metadata stream to relayd if one available. Availability is
938 * known if the stream is still in the list of the channel.
940 if (cds_list_empty(&metadata
->streams
.head
)) {
941 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
942 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
943 goto error_no_stream
;
946 /* Send metadata stream to relayd if needed. */
947 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
948 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
951 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
954 ret
= consumer_send_relayd_streams_sent(
955 metadata
->metadata_stream
->net_seq_idx
);
957 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
963 * Ownership of metadata stream is passed along. Freeing is handled by
966 ret
= send_streams_to_thread(metadata
, ctx
);
969 * If we are unable to send the stream to the thread, there is
970 * a big problem so just stop everything.
972 ret
= LTTCOMM_CONSUMERD_FATAL
;
973 goto send_streams_error
;
975 /* List MUST be empty after or else it could be reused. */
976 assert(cds_list_empty(&metadata
->streams
.head
));
983 * Delete metadata channel on error. At this point, the metadata stream can
984 * NOT be monitored by the metadata thread thus having the guarantee that
985 * the stream is still in the local stream list of the channel. This call
986 * will make sure to clean that list.
988 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
989 cds_list_del(&metadata
->metadata_stream
->send_node
);
990 metadata
->metadata_stream
= NULL
;
998 * Snapshot the whole metadata.
999 * RCU read-side lock must be held by the caller.
1001 * Returns 0 on success, < 0 on error
1003 static int snapshot_metadata(struct lttng_consumer_channel
*metadata_channel
,
1004 uint64_t key
, char *path
, uint64_t relayd_id
,
1005 struct lttng_consumer_local_data
*ctx
)
1008 struct lttng_consumer_stream
*metadata_stream
;
1013 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
1018 assert(!metadata_channel
->monitor
);
1020 health_code_update();
1023 * Ask the sessiond if we have new metadata waiting and update the
1024 * consumer metadata cache.
1026 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
1031 health_code_update();
1034 * The metadata stream is NOT created in no monitor mode when the channel
1035 * is created on a sessiond ask channel command.
1037 ret
= create_ust_streams(metadata_channel
, ctx
);
1042 metadata_stream
= metadata_channel
->metadata_stream
;
1043 assert(metadata_stream
);
1045 pthread_mutex_lock(&metadata_stream
->lock
);
1046 if (relayd_id
!= (uint64_t) -1ULL) {
1047 metadata_stream
->net_seq_idx
= relayd_id
;
1048 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1050 ret
= consumer_stream_create_output_files(metadata_stream
,
1053 pthread_mutex_unlock(&metadata_stream
->lock
);
1059 health_code_update();
1061 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
1069 * Clean up the stream completly because the next snapshot will use a new
1072 pthread_mutex_lock(&metadata_stream
->lock
);
1073 consumer_stream_destroy(metadata_stream
, NULL
);
1074 cds_list_del(&metadata_stream
->send_node
);
1075 metadata_channel
->metadata_stream
= NULL
;
1083 * Take a snapshot of all the stream of a channel.
1084 * RCU read-side lock and the channel lock must be held by the caller.
1086 * Returns 0 on success, < 0 on error
1088 static int snapshot_channel(struct lttng_consumer_channel
*channel
,
1089 uint64_t key
, char *path
, uint64_t relayd_id
,
1090 uint64_t nb_packets_per_stream
,
1091 struct lttng_consumer_local_data
*ctx
)
1094 unsigned use_relayd
= 0;
1095 unsigned long consumed_pos
, produced_pos
;
1096 struct lttng_consumer_stream
*stream
;
1103 if (relayd_id
!= (uint64_t) -1ULL) {
1107 assert(!channel
->monitor
);
1108 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1110 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1111 health_code_update();
1113 /* Lock stream because we are about to change its state. */
1114 pthread_mutex_lock(&stream
->lock
);
1115 assert(channel
->trace_chunk
);
1116 if (!lttng_trace_chunk_get(channel
->trace_chunk
)) {
1118 * Can't happen barring an internal error as the channel
1119 * holds a reference to the trace chunk.
1121 ERR("Failed to acquire reference to channel's trace chunk");
1125 assert(!stream
->trace_chunk
);
1126 stream
->trace_chunk
= channel
->trace_chunk
;
1128 stream
->net_seq_idx
= relayd_id
;
1131 ret
= consumer_send_relayd_stream(stream
, path
);
1136 ret
= consumer_stream_create_output_files(stream
,
1141 DBG("UST consumer snapshot stream (%" PRIu64
")",
1146 * If tracing is active, we want to perform a "full" buffer flush.
1147 * Else, if quiescent, it has already been done by the prior stop.
1149 if (!stream
->quiescent
) {
1150 ustctl_flush_buffer(stream
->ustream
, 0);
1153 ret
= lttng_ustconsumer_take_snapshot(stream
);
1155 ERR("Taking UST snapshot");
1159 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1161 ERR("Produced UST snapshot position");
1165 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1167 ERR("Consumerd UST snapshot position");
1172 * The original value is sent back if max stream size is larger than
1173 * the possible size of the snapshot. Also, we assume that the session
1174 * daemon should never send a maximum stream size that is lower than
1177 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1178 produced_pos
, nb_packets_per_stream
,
1179 stream
->max_sb_size
);
1181 while ((long) (consumed_pos
- produced_pos
) < 0) {
1183 unsigned long len
, padded_len
;
1185 health_code_update();
1187 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1189 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1191 if (ret
!= -EAGAIN
) {
1192 PERROR("ustctl_get_subbuf snapshot");
1193 goto error_close_stream
;
1195 DBG("UST consumer get subbuf failed. Skipping it.");
1196 consumed_pos
+= stream
->max_sb_size
;
1197 stream
->chan
->lost_packets
++;
1201 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1203 ERR("Snapshot ustctl_get_subbuf_size");
1204 goto error_put_subbuf
;
1207 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1209 ERR("Snapshot ustctl_get_padded_subbuf_size");
1210 goto error_put_subbuf
;
1213 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1214 padded_len
- len
, NULL
);
1216 if (read_len
!= len
) {
1218 goto error_put_subbuf
;
1221 if (read_len
!= padded_len
) {
1223 goto error_put_subbuf
;
1227 ret
= ustctl_put_subbuf(stream
->ustream
);
1229 ERR("Snapshot ustctl_put_subbuf");
1230 goto error_close_stream
;
1232 consumed_pos
+= stream
->max_sb_size
;
1235 /* Simply close the stream so we can use it on the next snapshot. */
1236 consumer_stream_close(stream
);
1237 pthread_mutex_unlock(&stream
->lock
);
1244 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1245 ERR("Snapshot ustctl_put_subbuf");
1248 consumer_stream_close(stream
);
1250 pthread_mutex_unlock(&stream
->lock
);
1256 * Receive the metadata updates from the sessiond. Supports receiving
1257 * overlapping metadata, but is needs to always belong to a contiguous
1258 * range starting from 0.
1259 * Be careful about the locks held when calling this function: it needs
1260 * the metadata cache flush to concurrently progress in order to
1263 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1264 uint64_t len
, uint64_t version
,
1265 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1267 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1270 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1272 metadata_str
= zmalloc(len
* sizeof(char));
1273 if (!metadata_str
) {
1274 PERROR("zmalloc metadata string");
1275 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1279 health_code_update();
1281 /* Receive metadata string. */
1282 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1284 /* Session daemon is dead so return gracefully. */
1289 health_code_update();
1291 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1292 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1295 /* Unable to handle metadata. Notify session daemon. */
1296 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1298 * Skip metadata flush on write error since the offset and len might
1299 * not have been updated which could create an infinite loop below when
1300 * waiting for the metadata cache to be flushed.
1302 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1305 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1310 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1311 DBG("Waiting for metadata to be flushed");
1313 health_code_update();
1315 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1325 * Receive command from session daemon and process it.
1327 * Return 1 on success else a negative value or 0.
1329 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1330 int sock
, struct pollfd
*consumer_sockpoll
)
1333 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1334 struct lttcomm_consumer_msg msg
;
1335 struct lttng_consumer_channel
*channel
= NULL
;
1337 health_code_update();
1339 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1340 if (ret
!= sizeof(msg
)) {
1341 DBG("Consumer received unexpected message size %zd (expects %zu)",
1344 * The ret value might 0 meaning an orderly shutdown but this is ok
1345 * since the caller handles this.
1348 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1354 health_code_update();
1357 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1359 health_code_update();
1361 /* relayd needs RCU read-side lock */
1364 switch (msg
.cmd_type
) {
1365 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1367 /* Session daemon status message are handled in the following call. */
1368 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1369 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1370 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1371 msg
.u
.relayd_sock
.relayd_session_id
);
1374 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1376 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1377 struct consumer_relayd_sock_pair
*relayd
;
1379 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1381 /* Get relayd reference if exists. */
1382 relayd
= consumer_find_relayd(index
);
1383 if (relayd
== NULL
) {
1384 DBG("Unable to find relayd %" PRIu64
, index
);
1385 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1389 * Each relayd socket pair has a refcount of stream attached to it
1390 * which tells if the relayd is still active or not depending on the
1393 * This will set the destroy flag of the relayd object and destroy it
1394 * if the refcount reaches zero when called.
1396 * The destroy can happen either here or when a stream fd hangs up.
1399 consumer_flag_relayd_for_destroy(relayd
);
1402 goto end_msg_sessiond
;
1404 case LTTNG_CONSUMER_UPDATE_STREAM
:
1409 case LTTNG_CONSUMER_DATA_PENDING
:
1411 int ret
, is_data_pending
;
1412 uint64_t id
= msg
.u
.data_pending
.session_id
;
1414 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1416 is_data_pending
= consumer_data_pending(id
);
1418 /* Send back returned value to session daemon */
1419 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1420 sizeof(is_data_pending
));
1422 DBG("Error when sending the data pending ret code: %d", ret
);
1427 * No need to send back a status message since the data pending
1428 * returned value is the response.
1432 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1435 struct ustctl_consumer_channel_attr attr
;
1436 const uint64_t chunk_id
= msg
.u
.ask_channel
.chunk_id
.value
;
1437 const struct lttng_credentials buffer_credentials
= {
1438 .uid
= msg
.u
.ask_channel
.buffer_credentials
.uid
,
1439 .gid
= msg
.u
.ask_channel
.buffer_credentials
.gid
,
1442 /* Create a plain object and reserve a channel key. */
1443 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1444 msg
.u
.ask_channel
.chunk_id
.is_set
?
1446 msg
.u
.ask_channel
.pathname
,
1447 msg
.u
.ask_channel
.name
,
1448 msg
.u
.ask_channel
.relayd_id
,
1449 msg
.u
.ask_channel
.key
,
1450 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1451 msg
.u
.ask_channel
.tracefile_size
,
1452 msg
.u
.ask_channel
.tracefile_count
,
1453 msg
.u
.ask_channel
.session_id_per_pid
,
1454 msg
.u
.ask_channel
.monitor
,
1455 msg
.u
.ask_channel
.live_timer_interval
,
1456 msg
.u
.ask_channel
.root_shm_path
,
1457 msg
.u
.ask_channel
.shm_path
);
1459 goto end_channel_error
;
1462 LTTNG_OPTIONAL_SET(&channel
->buffer_credentials
,
1463 buffer_credentials
);
1466 * Assign UST application UID to the channel. This value is ignored for
1467 * per PID buffers. This is specific to UST thus setting this after the
1470 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1472 /* Build channel attributes from received message. */
1473 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1474 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1475 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1476 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1477 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1478 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1479 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1480 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1482 /* Match channel buffer type to the UST abi. */
1483 switch (msg
.u
.ask_channel
.output
) {
1484 case LTTNG_EVENT_MMAP
:
1486 attr
.output
= LTTNG_UST_MMAP
;
1490 /* Translate and save channel type. */
1491 switch (msg
.u
.ask_channel
.type
) {
1492 case LTTNG_UST_CHAN_PER_CPU
:
1493 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1494 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1496 * Set refcount to 1 for owner. Below, we will
1497 * pass ownership to the
1498 * consumer_thread_channel_poll() thread.
1500 channel
->refcount
= 1;
1502 case LTTNG_UST_CHAN_METADATA
:
1503 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1504 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1511 health_code_update();
1513 ret
= ask_channel(ctx
, channel
, &attr
);
1515 goto end_channel_error
;
1518 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1519 ret
= consumer_metadata_cache_allocate(channel
);
1521 ERR("Allocating metadata cache");
1522 goto end_channel_error
;
1524 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1525 attr
.switch_timer_interval
= 0;
1527 int monitor_start_ret
;
1529 consumer_timer_live_start(channel
,
1530 msg
.u
.ask_channel
.live_timer_interval
);
1531 monitor_start_ret
= consumer_timer_monitor_start(
1533 msg
.u
.ask_channel
.monitor_timer_interval
);
1534 if (monitor_start_ret
< 0) {
1535 ERR("Starting channel monitoring timer failed");
1536 goto end_channel_error
;
1540 health_code_update();
1543 * Add the channel to the internal state AFTER all streams were created
1544 * and successfully sent to session daemon. This way, all streams must
1545 * be ready before this channel is visible to the threads.
1546 * If add_channel succeeds, ownership of the channel is
1547 * passed to consumer_thread_channel_poll().
1549 ret
= add_channel(channel
, ctx
);
1551 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1552 if (channel
->switch_timer_enabled
== 1) {
1553 consumer_timer_switch_stop(channel
);
1555 consumer_metadata_cache_destroy(channel
);
1557 if (channel
->live_timer_enabled
== 1) {
1558 consumer_timer_live_stop(channel
);
1560 if (channel
->monitor_timer_enabled
== 1) {
1561 consumer_timer_monitor_stop(channel
);
1563 goto end_channel_error
;
1566 health_code_update();
1569 * Channel and streams are now created. Inform the session daemon that
1570 * everything went well and should wait to receive the channel and
1571 * streams with ustctl API.
1573 ret
= consumer_send_status_channel(sock
, channel
);
1576 * There is probably a problem on the socket.
1583 case LTTNG_CONSUMER_GET_CHANNEL
:
1585 int ret
, relayd_err
= 0;
1586 uint64_t key
= msg
.u
.get_channel
.key
;
1587 struct lttng_consumer_channel
*channel
;
1589 channel
= consumer_find_channel(key
);
1591 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1592 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1593 goto end_msg_sessiond
;
1596 health_code_update();
1598 /* Send the channel to sessiond (and relayd, if applicable). */
1599 ret
= send_channel_to_sessiond_and_relayd(sock
, channel
, ctx
,
1604 * We were unable to send to the relayd the stream so avoid
1605 * sending back a fatal error to the thread since this is OK
1606 * and the consumer can continue its work. The above call
1607 * has sent the error status message to the sessiond.
1612 * The communicaton was broken hence there is a bad state between
1613 * the consumer and sessiond so stop everything.
1618 health_code_update();
1621 * In no monitor mode, the streams ownership is kept inside the channel
1622 * so don't send them to the data thread.
1624 if (!channel
->monitor
) {
1625 goto end_msg_sessiond
;
1628 ret
= send_streams_to_thread(channel
, ctx
);
1631 * If we are unable to send the stream to the thread, there is
1632 * a big problem so just stop everything.
1636 /* List MUST be empty after or else it could be reused. */
1637 assert(cds_list_empty(&channel
->streams
.head
));
1638 goto end_msg_sessiond
;
1640 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1642 uint64_t key
= msg
.u
.destroy_channel
.key
;
1645 * Only called if streams have not been sent to stream
1646 * manager thread. However, channel has been sent to
1647 * channel manager thread.
1649 notify_thread_del_channel(ctx
, key
);
1650 goto end_msg_sessiond
;
1652 case LTTNG_CONSUMER_CLOSE_METADATA
:
1656 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1661 goto end_msg_sessiond
;
1663 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1667 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1672 goto end_msg_sessiond
;
1674 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1678 ret
= clear_quiescent_channel(
1679 msg
.u
.clear_quiescent_channel
.key
);
1684 goto end_msg_sessiond
;
1686 case LTTNG_CONSUMER_PUSH_METADATA
:
1689 uint64_t len
= msg
.u
.push_metadata
.len
;
1690 uint64_t key
= msg
.u
.push_metadata
.key
;
1691 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1692 uint64_t version
= msg
.u
.push_metadata
.version
;
1693 struct lttng_consumer_channel
*channel
;
1695 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1698 channel
= consumer_find_channel(key
);
1701 * This is possible if the metadata creation on the consumer side
1702 * is in flight vis-a-vis a concurrent push metadata from the
1703 * session daemon. Simply return that the channel failed and the
1704 * session daemon will handle that message correctly considering
1705 * that this race is acceptable thus the DBG() statement here.
1707 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1708 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1709 goto end_msg_sessiond
;
1712 health_code_update();
1716 * There is nothing to receive. We have simply
1717 * checked whether the channel can be found.
1719 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1720 goto end_msg_sessiond
;
1723 /* Tell session daemon we are ready to receive the metadata. */
1724 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1726 /* Somehow, the session daemon is not responding anymore. */
1730 health_code_update();
1732 /* Wait for more data. */
1733 health_poll_entry();
1734 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1740 health_code_update();
1742 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1743 len
, version
, channel
, 0, 1);
1745 /* error receiving from sessiond */
1749 goto end_msg_sessiond
;
1752 case LTTNG_CONSUMER_SETUP_METADATA
:
1756 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1760 goto end_msg_sessiond
;
1762 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1764 struct lttng_consumer_channel
*channel
;
1765 uint64_t key
= msg
.u
.snapshot_channel
.key
;
1767 channel
= consumer_find_channel(key
);
1769 DBG("UST snapshot channel not found for key %" PRIu64
, key
);
1770 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1772 if (msg
.u
.snapshot_channel
.metadata
) {
1773 ret
= snapshot_metadata(channel
, key
,
1774 msg
.u
.snapshot_channel
.pathname
,
1775 msg
.u
.snapshot_channel
.relayd_id
,
1778 ERR("Snapshot metadata failed");
1779 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1782 ret
= snapshot_channel(channel
, key
,
1783 msg
.u
.snapshot_channel
.pathname
,
1784 msg
.u
.snapshot_channel
.relayd_id
,
1785 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1788 ERR("Snapshot channel failed");
1789 ret_code
= LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
;
1793 health_code_update();
1794 ret
= consumer_send_status_msg(sock
, ret_code
);
1796 /* Somehow, the session daemon is not responding anymore. */
1799 health_code_update();
1802 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1805 uint64_t discarded_events
;
1806 struct lttng_ht_iter iter
;
1807 struct lttng_ht
*ht
;
1808 struct lttng_consumer_stream
*stream
;
1809 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1810 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1812 DBG("UST consumer discarded events command for session id %"
1815 pthread_mutex_lock(&consumer_data
.lock
);
1817 ht
= consumer_data
.stream_list_ht
;
1820 * We only need a reference to the channel, but they are not
1821 * directly indexed, so we just use the first matching stream
1822 * to extract the information we need, we default to 0 if not
1823 * found (no events are dropped if the channel is not yet in
1826 discarded_events
= 0;
1827 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1828 ht
->hash_fct(&id
, lttng_ht_seed
),
1830 &iter
.iter
, stream
, node_session_id
.node
) {
1831 if (stream
->chan
->key
== key
) {
1832 discarded_events
= stream
->chan
->discarded_events
;
1836 pthread_mutex_unlock(&consumer_data
.lock
);
1839 DBG("UST consumer discarded events command for session id %"
1840 PRIu64
", channel key %" PRIu64
, id
, key
);
1842 health_code_update();
1844 /* Send back returned value to session daemon */
1845 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1847 PERROR("send discarded events");
1853 case LTTNG_CONSUMER_LOST_PACKETS
:
1856 uint64_t lost_packets
;
1857 struct lttng_ht_iter iter
;
1858 struct lttng_ht
*ht
;
1859 struct lttng_consumer_stream
*stream
;
1860 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1861 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1863 DBG("UST consumer lost packets command for session id %"
1866 pthread_mutex_lock(&consumer_data
.lock
);
1868 ht
= consumer_data
.stream_list_ht
;
1871 * We only need a reference to the channel, but they are not
1872 * directly indexed, so we just use the first matching stream
1873 * to extract the information we need, we default to 0 if not
1874 * found (no packets lost if the channel is not yet in use).
1877 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1878 ht
->hash_fct(&id
, lttng_ht_seed
),
1880 &iter
.iter
, stream
, node_session_id
.node
) {
1881 if (stream
->chan
->key
== key
) {
1882 lost_packets
= stream
->chan
->lost_packets
;
1886 pthread_mutex_unlock(&consumer_data
.lock
);
1889 DBG("UST consumer lost packets command for session id %"
1890 PRIu64
", channel key %" PRIu64
, id
, key
);
1892 health_code_update();
1894 /* Send back returned value to session daemon */
1895 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1896 sizeof(lost_packets
));
1898 PERROR("send lost packets");
1904 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1906 int channel_monitor_pipe
;
1908 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1909 /* Successfully received the command's type. */
1910 ret
= consumer_send_status_msg(sock
, ret_code
);
1915 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1917 if (ret
!= sizeof(channel_monitor_pipe
)) {
1918 ERR("Failed to receive channel monitor pipe");
1922 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1923 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1924 channel_monitor_pipe
);
1928 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1929 /* Set the pipe as non-blocking. */
1930 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1932 PERROR("fcntl get flags of the channel monitoring pipe");
1937 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1938 flags
| O_NONBLOCK
);
1940 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1943 DBG("Channel monitor pipe set as non-blocking");
1945 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1947 goto end_msg_sessiond
;
1949 case LTTNG_CONSUMER_ROTATE_CHANNEL
:
1951 struct lttng_consumer_channel
*channel
;
1952 uint64_t key
= msg
.u
.rotate_channel
.key
;
1954 channel
= consumer_find_channel(key
);
1956 DBG("Channel %" PRIu64
" not found", key
);
1957 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1960 * Sample the rotate position of all the streams in
1963 ret
= lttng_consumer_rotate_channel(channel
, key
,
1964 msg
.u
.rotate_channel
.relayd_id
,
1965 msg
.u
.rotate_channel
.metadata
,
1968 ERR("Rotate channel failed");
1969 ret_code
= LTTCOMM_CONSUMERD_ROTATION_FAIL
;
1972 health_code_update();
1974 ret
= consumer_send_status_msg(sock
, ret_code
);
1976 /* Somehow, the session daemon is not responding anymore. */
1981 * Rotate the streams that are ready right now.
1982 * FIXME: this is a second consecutive iteration over the
1983 * streams in a channel, there is probably a better way to
1984 * handle this, but it needs to be after the
1985 * consumer_send_status_msg() call.
1988 ret
= lttng_consumer_rotate_ready_streams(
1991 ERR("Rotate channel failed");
1996 case LTTNG_CONSUMER_INIT
:
1998 ret_code
= lttng_consumer_init_command(ctx
,
1999 msg
.u
.init
.sessiond_uuid
);
2000 health_code_update();
2001 ret
= consumer_send_status_msg(sock
, ret_code
);
2003 /* Somehow, the session daemon is not responding anymore. */
2008 case LTTNG_CONSUMER_CREATE_TRACE_CHUNK
:
2010 const struct lttng_credentials credentials
= {
2011 .uid
= msg
.u
.create_trace_chunk
.credentials
.value
.uid
,
2012 .gid
= msg
.u
.create_trace_chunk
.credentials
.value
.gid
,
2014 const bool is_local_trace
=
2015 !msg
.u
.create_trace_chunk
.relayd_id
.is_set
;
2016 const uint64_t relayd_id
=
2017 msg
.u
.create_trace_chunk
.relayd_id
.value
;
2018 const char *chunk_override_name
=
2019 *msg
.u
.create_trace_chunk
.override_name
?
2020 msg
.u
.create_trace_chunk
.override_name
:
2022 LTTNG_OPTIONAL(struct lttng_directory_handle
) chunk_directory_handle
=
2023 LTTNG_OPTIONAL_INIT
;
2026 * The session daemon will only provide a chunk directory file
2027 * descriptor for local traces.
2029 if (is_local_trace
) {
2032 /* Acnowledge the reception of the command. */
2033 ret
= consumer_send_status_msg(sock
,
2034 LTTCOMM_CONSUMERD_SUCCESS
);
2036 /* Somehow, the session daemon is not responding anymore. */
2040 ret
= lttcomm_recv_fds_unix_sock(sock
, &chunk_dirfd
, 1);
2041 if (ret
!= sizeof(chunk_dirfd
)) {
2042 ERR("Failed to receive trace chunk directory file descriptor");
2046 DBG("Received trace chunk directory fd (%d)",
2048 ret
= lttng_directory_handle_init_from_dirfd(
2049 &chunk_directory_handle
.value
,
2052 ERR("Failed to initialize chunk directory handle from directory file descriptor");
2053 if (close(chunk_dirfd
)) {
2054 PERROR("Failed to close chunk directory file descriptor");
2058 chunk_directory_handle
.is_set
= true;
2061 ret_code
= lttng_consumer_create_trace_chunk(
2062 !is_local_trace
? &relayd_id
: NULL
,
2063 msg
.u
.create_trace_chunk
.session_id
,
2064 msg
.u
.create_trace_chunk
.chunk_id
,
2065 (time_t) msg
.u
.create_trace_chunk
2066 .creation_timestamp
,
2067 chunk_override_name
,
2068 msg
.u
.create_trace_chunk
.credentials
.is_set
?
2071 chunk_directory_handle
.is_set
?
2072 &chunk_directory_handle
.value
:
2075 if (chunk_directory_handle
.is_set
) {
2076 lttng_directory_handle_fini(
2077 &chunk_directory_handle
.value
);
2079 goto end_msg_sessiond
;
2081 case LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
:
2083 enum lttng_trace_chunk_command_type close_command
=
2084 msg
.u
.close_trace_chunk
.close_command
.value
;
2085 const uint64_t relayd_id
=
2086 msg
.u
.close_trace_chunk
.relayd_id
.value
;
2088 ret_code
= lttng_consumer_close_trace_chunk(
2089 msg
.u
.close_trace_chunk
.relayd_id
.is_set
?
2092 msg
.u
.close_trace_chunk
.session_id
,
2093 msg
.u
.close_trace_chunk
.chunk_id
,
2094 (time_t) msg
.u
.close_trace_chunk
.close_timestamp
,
2095 msg
.u
.close_trace_chunk
.close_command
.is_set
?
2098 goto end_msg_sessiond
;
2100 case LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
:
2102 const uint64_t relayd_id
=
2103 msg
.u
.trace_chunk_exists
.relayd_id
.value
;
2105 ret_code
= lttng_consumer_trace_chunk_exists(
2106 msg
.u
.trace_chunk_exists
.relayd_id
.is_set
?
2108 msg
.u
.trace_chunk_exists
.session_id
,
2109 msg
.u
.trace_chunk_exists
.chunk_id
);
2110 goto end_msg_sessiond
;
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();
2144 pthread_mutex_unlock(&channel
->lock
);
2146 * Free channel here since no one has a reference to it. We don't
2147 * free after that because a stream can store this pointer.
2149 destroy_channel(channel
);
2151 /* We have to send a status channel message indicating an error. */
2152 ret
= consumer_send_status_channel(sock
, NULL
);
2154 /* Stop everything if session daemon can not be notified. */
2159 health_code_update();
2164 /* This will issue a consumer stop. */
2169 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
2170 * compiled out, we isolate it in this library.
2172 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
2176 assert(stream
->ustream
);
2178 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
2182 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
2183 * compiled out, we isolate it in this library.
2185 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
2188 assert(stream
->ustream
);
2190 return ustctl_get_mmap_base(stream
->ustream
);
2193 void lttng_ustctl_flush_buffer(struct lttng_consumer_stream
*stream
,
2194 int producer_active
)
2197 assert(stream
->ustream
);
2199 ustctl_flush_buffer(stream
->ustream
, producer_active
);
2203 * Take a snapshot for a specific stream.
2205 * Returns 0 on success, < 0 on error
2207 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2210 assert(stream
->ustream
);
2212 return ustctl_snapshot(stream
->ustream
);
2216 * Sample consumed and produced positions for a specific stream.
2218 * Returns 0 on success, < 0 on error.
2220 int lttng_ustconsumer_sample_snapshot_positions(
2221 struct lttng_consumer_stream
*stream
)
2224 assert(stream
->ustream
);
2226 return ustctl_snapshot_sample_positions(stream
->ustream
);
2230 * Get the produced position
2232 * Returns 0 on success, < 0 on error
2234 int lttng_ustconsumer_get_produced_snapshot(
2235 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2238 assert(stream
->ustream
);
2241 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2245 * Get the consumed position
2247 * Returns 0 on success, < 0 on error
2249 int lttng_ustconsumer_get_consumed_snapshot(
2250 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2253 assert(stream
->ustream
);
2256 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2259 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2263 assert(stream
->ustream
);
2265 ustctl_flush_buffer(stream
->ustream
, producer
);
2268 int lttng_ustconsumer_get_current_timestamp(
2269 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2272 assert(stream
->ustream
);
2275 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2278 int lttng_ustconsumer_get_sequence_number(
2279 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2282 assert(stream
->ustream
);
2285 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2289 * Called when the stream signals the consumer that it has hung up.
2291 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2294 assert(stream
->ustream
);
2296 pthread_mutex_lock(&stream
->lock
);
2297 if (!stream
->quiescent
) {
2298 ustctl_flush_buffer(stream
->ustream
, 0);
2299 stream
->quiescent
= true;
2301 pthread_mutex_unlock(&stream
->lock
);
2302 stream
->hangup_flush_done
= 1;
2305 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2310 assert(chan
->uchan
);
2311 assert(chan
->buffer_credentials
.is_set
);
2313 if (chan
->switch_timer_enabled
== 1) {
2314 consumer_timer_switch_stop(chan
);
2316 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2319 ret
= close(chan
->stream_fds
[i
]);
2323 if (chan
->shm_path
[0]) {
2324 char shm_path
[PATH_MAX
];
2326 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2328 ERR("Cannot get stream shm path");
2330 ret
= run_as_unlink(shm_path
,
2331 chan
->buffer_credentials
.value
.uid
,
2332 chan
->buffer_credentials
.value
.gid
);
2334 PERROR("unlink %s", shm_path
);
2340 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2343 assert(chan
->uchan
);
2344 assert(chan
->buffer_credentials
.is_set
);
2346 consumer_metadata_cache_destroy(chan
);
2347 ustctl_destroy_channel(chan
->uchan
);
2348 /* Try to rmdir all directories under shm_path root. */
2349 if (chan
->root_shm_path
[0]) {
2350 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2351 chan
->buffer_credentials
.value
.uid
,
2352 chan
->buffer_credentials
.value
.gid
);
2354 free(chan
->stream_fds
);
2357 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2360 assert(stream
->ustream
);
2362 if (stream
->chan
->switch_timer_enabled
== 1) {
2363 consumer_timer_switch_stop(stream
->chan
);
2365 ustctl_destroy_stream(stream
->ustream
);
2368 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2371 assert(stream
->ustream
);
2373 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2376 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2379 assert(stream
->ustream
);
2381 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2385 * Populate index values of a UST stream. Values are set in big endian order.
2387 * Return 0 on success or else a negative value.
2389 static int get_index_values(struct ctf_packet_index
*index
,
2390 struct ustctl_consumer_stream
*ustream
)
2394 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2396 PERROR("ustctl_get_timestamp_begin");
2399 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2401 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2403 PERROR("ustctl_get_timestamp_end");
2406 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2408 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2410 PERROR("ustctl_get_events_discarded");
2413 index
->events_discarded
= htobe64(index
->events_discarded
);
2415 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2417 PERROR("ustctl_get_content_size");
2420 index
->content_size
= htobe64(index
->content_size
);
2422 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2424 PERROR("ustctl_get_packet_size");
2427 index
->packet_size
= htobe64(index
->packet_size
);
2429 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2431 PERROR("ustctl_get_stream_id");
2434 index
->stream_id
= htobe64(index
->stream_id
);
2436 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2438 PERROR("ustctl_get_instance_id");
2441 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2443 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2445 PERROR("ustctl_get_sequence_number");
2448 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2455 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
,
2456 struct consumer_metadata_cache
*cache
)
2458 DBG("Metadata stream update to version %" PRIu64
,
2460 stream
->ust_metadata_pushed
= 0;
2461 stream
->metadata_version
= cache
->version
;
2462 stream
->reset_metadata_flag
= 1;
2466 * Check if the version of the metadata stream and metadata cache match.
2467 * If the cache got updated, reset the metadata stream.
2468 * The stream lock and metadata cache lock MUST be held.
2469 * Return 0 on success, a negative value on error.
2472 int metadata_stream_check_version(struct lttng_consumer_stream
*stream
)
2475 struct consumer_metadata_cache
*cache
= stream
->chan
->metadata_cache
;
2477 if (cache
->version
== stream
->metadata_version
) {
2480 metadata_stream_reset_cache(stream
, cache
);
2487 * Write up to one packet from the metadata cache to the channel.
2489 * Returns the number of bytes pushed in the cache, or a negative value
2493 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2498 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2499 ret
= metadata_stream_check_version(stream
);
2503 if (stream
->chan
->metadata_cache
->max_offset
2504 == stream
->ust_metadata_pushed
) {
2509 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2510 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2511 stream
->chan
->metadata_cache
->max_offset
2512 - stream
->ust_metadata_pushed
);
2513 assert(write_len
!= 0);
2514 if (write_len
< 0) {
2515 ERR("Writing one metadata packet");
2519 stream
->ust_metadata_pushed
+= write_len
;
2521 assert(stream
->chan
->metadata_cache
->max_offset
>=
2522 stream
->ust_metadata_pushed
);
2526 * Switch packet (but don't open the next one) on every commit of
2527 * a metadata packet. Since the subbuffer is fully filled (with padding,
2528 * if needed), the stream is "quiescent" after this commit.
2530 ustctl_flush_buffer(stream
->ustream
, 1);
2531 stream
->quiescent
= true;
2533 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2539 * Sync metadata meaning request them to the session daemon and snapshot to the
2540 * metadata thread can consumer them.
2542 * Metadata stream lock is held here, but we need to release it when
2543 * interacting with sessiond, else we cause a deadlock with live
2544 * awaiting on metadata to be pushed out.
2546 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2547 * is empty or a negative value on error.
2549 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2550 struct lttng_consumer_stream
*metadata
)
2558 pthread_mutex_unlock(&metadata
->lock
);
2560 * Request metadata from the sessiond, but don't wait for the flush
2561 * because we locked the metadata thread.
2563 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2564 pthread_mutex_lock(&metadata
->lock
);
2569 ret
= commit_one_metadata_packet(metadata
);
2572 } else if (ret
> 0) {
2576 ret
= ustctl_snapshot(metadata
->ustream
);
2578 if (errno
!= EAGAIN
) {
2579 ERR("Sync metadata, taking UST snapshot");
2582 DBG("No new metadata when syncing them.");
2583 /* No new metadata, exit. */
2589 * After this flush, we still need to extract metadata.
2600 * Return 0 on success else a negative value.
2602 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2603 struct lttng_consumer_local_data
*ctx
)
2606 struct ustctl_consumer_stream
*ustream
;
2611 ustream
= stream
->ustream
;
2614 * First, we are going to check if there is a new subbuffer available
2615 * before reading the stream wait_fd.
2617 /* Get the next subbuffer */
2618 ret
= ustctl_get_next_subbuf(ustream
);
2620 /* No more data found, flag the stream. */
2621 stream
->has_data
= 0;
2626 ret
= ustctl_put_subbuf(ustream
);
2629 /* This stream still has data. Flag it and wake up the data thread. */
2630 stream
->has_data
= 1;
2632 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2635 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2636 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2641 /* The wake up pipe has been notified. */
2642 ctx
->has_wakeup
= 1;
2651 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2654 uint64_t seq
, discarded
;
2656 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2658 PERROR("ustctl_get_sequence_number");
2662 * Start the sequence when we extract the first packet in case we don't
2663 * start at 0 (for example if a consumer is not connected to the
2664 * session immediately after the beginning).
2666 if (stream
->last_sequence_number
== -1ULL) {
2667 stream
->last_sequence_number
= seq
;
2668 } else if (seq
> stream
->last_sequence_number
) {
2669 stream
->chan
->lost_packets
+= seq
-
2670 stream
->last_sequence_number
- 1;
2672 /* seq <= last_sequence_number */
2673 ERR("Sequence number inconsistent : prev = %" PRIu64
2674 ", current = %" PRIu64
,
2675 stream
->last_sequence_number
, seq
);
2679 stream
->last_sequence_number
= seq
;
2681 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2683 PERROR("kernctl_get_events_discarded");
2686 if (discarded
< stream
->last_discarded_events
) {
2688 * Overflow has occurred. We assume only one wrap-around
2691 stream
->chan
->discarded_events
+=
2692 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2693 stream
->last_discarded_events
+ discarded
;
2695 stream
->chan
->discarded_events
+= discarded
-
2696 stream
->last_discarded_events
;
2698 stream
->last_discarded_events
= discarded
;
2706 * Read subbuffer from the given stream.
2708 * Stream and channel locks MUST be acquired by the caller.
2710 * Return 0 on success else a negative value.
2712 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2713 struct lttng_consumer_local_data
*ctx
)
2715 unsigned long len
, subbuf_size
, padding
;
2716 int err
, write_index
= 1, rotation_ret
;
2718 struct ustctl_consumer_stream
*ustream
;
2719 struct ctf_packet_index index
;
2722 assert(stream
->ustream
);
2725 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2728 /* Ease our life for what's next. */
2729 ustream
= stream
->ustream
;
2732 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2733 * error if we cannot read this one byte (read returns 0), or if the error
2734 * is EAGAIN or EWOULDBLOCK.
2736 * This is only done when the stream is monitored by a thread, before the
2737 * flush is done after a hangup and if the stream is not flagged with data
2738 * since there might be nothing to consume in the wait fd but still have
2739 * data available flagged by the consumer wake up pipe.
2741 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2745 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2746 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2753 * If the stream was flagged to be ready for rotation before we extract the
2754 * next packet, rotate it now.
2756 if (stream
->rotate_ready
) {
2757 DBG("Rotate stream before extracting data");
2758 rotation_ret
= lttng_consumer_rotate_stream(ctx
, stream
);
2759 if (rotation_ret
< 0) {
2760 ERR("Stream rotation error");
2767 /* Get the next subbuffer */
2768 err
= ustctl_get_next_subbuf(ustream
);
2771 * Populate metadata info if the existing info has
2772 * already been read.
2774 if (stream
->metadata_flag
) {
2775 ret
= commit_one_metadata_packet(stream
);
2782 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2784 * This is a debug message even for single-threaded consumer,
2785 * because poll() have more relaxed criterions than get subbuf,
2786 * so get_subbuf may fail for short race windows where poll()
2787 * would issue wakeups.
2789 DBG("Reserving sub buffer failed (everything is normal, "
2790 "it is due to concurrency) [ret: %d]", err
);
2793 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2795 if (!stream
->metadata_flag
) {
2796 index
.offset
= htobe64(stream
->out_fd_offset
);
2797 ret
= get_index_values(&index
, ustream
);
2799 err
= ustctl_put_subbuf(ustream
);
2804 /* Update the stream's sequence and discarded events count. */
2805 ret
= update_stream_stats(stream
);
2807 PERROR("kernctl_get_events_discarded");
2808 err
= ustctl_put_subbuf(ustream
);
2816 /* Get the full padded subbuffer size */
2817 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2820 /* Get subbuffer data size (without padding) */
2821 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2824 /* Make sure we don't get a subbuffer size bigger than the padded */
2825 assert(len
>= subbuf_size
);
2827 padding
= len
- subbuf_size
;
2829 /* write the subbuffer to the tracefile */
2830 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2832 * The mmap operation should write subbuf_size amount of data when network
2833 * streaming or the full padding (len) size when we are _not_ streaming.
2835 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2836 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2838 * Display the error but continue processing to try to release the
2839 * subbuffer. This is a DBG statement since any unexpected kill or
2840 * signal, the application gets unregistered, relayd gets closed or
2841 * anything that affects the buffer lifetime will trigger this error.
2842 * So, for the sake of the user, don't print this error since it can
2843 * happen and it is OK with the code flow.
2845 DBG("Error writing to tracefile "
2846 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2847 ret
, len
, subbuf_size
);
2850 err
= ustctl_put_next_subbuf(ustream
);
2854 * This will consumer the byte on the wait_fd if and only if there is not
2855 * next subbuffer to be acquired.
2857 if (!stream
->metadata_flag
) {
2858 ret
= notify_if_more_data(stream
, ctx
);
2864 /* Write index if needed. */
2869 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2871 * In live, block until all the metadata is sent.
2873 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2874 assert(!stream
->missed_metadata_flush
);
2875 stream
->waiting_on_metadata
= true;
2876 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2878 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2880 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2881 stream
->waiting_on_metadata
= false;
2882 if (stream
->missed_metadata_flush
) {
2883 stream
->missed_metadata_flush
= false;
2884 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2885 (void) consumer_flush_ust_index(stream
);
2887 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2895 assert(!stream
->metadata_flag
);
2896 err
= consumer_stream_write_index(stream
, &index
);
2903 * After extracting the packet, we check if the stream is now ready to be
2904 * rotated and perform the action immediately.
2906 rotation_ret
= lttng_consumer_stream_is_rotate_ready(stream
);
2907 if (rotation_ret
== 1) {
2908 rotation_ret
= lttng_consumer_rotate_stream(ctx
, stream
);
2909 if (rotation_ret
< 0) {
2910 ERR("Stream rotation error");
2914 } else if (rotation_ret
< 0) {
2915 ERR("Checking if stream is ready to rotate");
2924 * Called when a stream is created.
2926 * Return 0 on success or else a negative value.
2928 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2935 * Don't create anything if this is set for streaming or if there is
2936 * no current trace chunk on the parent channel.
2938 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
&&
2939 stream
->chan
->trace_chunk
) {
2940 ret
= consumer_stream_create_output_files(stream
, true);
2952 * Check if data is still being extracted from the buffers for a specific
2953 * stream. Consumer data lock MUST be acquired before calling this function
2954 * and the stream lock.
2956 * Return 1 if the traced data are still getting read else 0 meaning that the
2957 * data is available for trace viewer reading.
2959 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2964 assert(stream
->ustream
);
2966 DBG("UST consumer checking data pending");
2968 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2973 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2974 uint64_t contiguous
, pushed
;
2976 /* Ease our life a bit. */
2977 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2978 pushed
= stream
->ust_metadata_pushed
;
2981 * We can simply check whether all contiguously available data
2982 * has been pushed to the ring buffer, since the push operation
2983 * is performed within get_next_subbuf(), and because both
2984 * get_next_subbuf() and put_next_subbuf() are issued atomically
2985 * thanks to the stream lock within
2986 * lttng_ustconsumer_read_subbuffer(). This basically means that
2987 * whetnever ust_metadata_pushed is incremented, the associated
2988 * metadata has been consumed from the metadata stream.
2990 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2991 contiguous
, pushed
);
2992 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2993 if ((contiguous
!= pushed
) ||
2994 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2995 ret
= 1; /* Data is pending */
2999 ret
= ustctl_get_next_subbuf(stream
->ustream
);
3002 * There is still data so let's put back this
3005 ret
= ustctl_put_subbuf(stream
->ustream
);
3007 ret
= 1; /* Data is pending */
3012 /* Data is NOT pending so ready to be read. */
3020 * Stop a given metadata channel timer if enabled and close the wait fd which
3021 * is the poll pipe of the metadata stream.
3023 * This MUST be called with the metadata channel acquired.
3025 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
3030 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
3032 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
3034 if (metadata
->switch_timer_enabled
== 1) {
3035 consumer_timer_switch_stop(metadata
);
3038 if (!metadata
->metadata_stream
) {
3043 * Closing write side so the thread monitoring the stream wakes up if any
3044 * and clean the metadata stream.
3046 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
3047 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
3049 PERROR("closing metadata pipe write side");
3051 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
3059 * Close every metadata stream wait fd of the metadata hash table. This
3060 * function MUST be used very carefully so not to run into a race between the
3061 * metadata thread handling streams and this function closing their wait fd.
3063 * For UST, this is used when the session daemon hangs up. Its the metadata
3064 * producer so calling this is safe because we are assured that no state change
3065 * can occur in the metadata thread for the streams in the hash table.
3067 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
3069 struct lttng_ht_iter iter
;
3070 struct lttng_consumer_stream
*stream
;
3072 assert(metadata_ht
);
3073 assert(metadata_ht
->ht
);
3075 DBG("UST consumer closing all metadata streams");
3078 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
3081 health_code_update();
3083 pthread_mutex_lock(&stream
->chan
->lock
);
3084 lttng_ustconsumer_close_metadata(stream
->chan
);
3085 pthread_mutex_unlock(&stream
->chan
->lock
);
3091 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
3095 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
3097 ERR("Unable to close wakeup fd");
3102 * Please refer to consumer-timer.c before adding any lock within this
3103 * function or any of its callees. Timers have a very strict locking
3104 * semantic with respect to teardown. Failure to respect this semantic
3105 * introduces deadlocks.
3107 * DON'T hold the metadata lock when calling this function, else this
3108 * can cause deadlock involving consumer awaiting for metadata to be
3109 * pushed out due to concurrent interaction with the session daemon.
3111 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
3112 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
3114 struct lttcomm_metadata_request_msg request
;
3115 struct lttcomm_consumer_msg msg
;
3116 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3117 uint64_t len
, key
, offset
, version
;
3121 assert(channel
->metadata_cache
);
3123 memset(&request
, 0, sizeof(request
));
3125 /* send the metadata request to sessiond */
3126 switch (consumer_data
.type
) {
3127 case LTTNG_CONSUMER64_UST
:
3128 request
.bits_per_long
= 64;
3130 case LTTNG_CONSUMER32_UST
:
3131 request
.bits_per_long
= 32;
3134 request
.bits_per_long
= 0;
3138 request
.session_id
= channel
->session_id
;
3139 request
.session_id_per_pid
= channel
->session_id_per_pid
;
3141 * Request the application UID here so the metadata of that application can
3142 * be sent back. The channel UID corresponds to the user UID of the session
3143 * used for the rights on the stream file(s).
3145 request
.uid
= channel
->ust_app_uid
;
3146 request
.key
= channel
->key
;
3148 DBG("Sending metadata request to sessiond, session id %" PRIu64
3149 ", per-pid %" PRIu64
", app UID %u and channel key %" PRIu64
,
3150 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
3153 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
3155 health_code_update();
3157 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
3160 ERR("Asking metadata to sessiond");
3164 health_code_update();
3166 /* Receive the metadata from sessiond */
3167 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
3169 if (ret
!= sizeof(msg
)) {
3170 DBG("Consumer received unexpected message size %d (expects %zu)",
3172 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
3174 * The ret value might 0 meaning an orderly shutdown but this is ok
3175 * since the caller handles this.
3180 health_code_update();
3182 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
3183 /* No registry found */
3184 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3188 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
3189 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
3194 len
= msg
.u
.push_metadata
.len
;
3195 key
= msg
.u
.push_metadata
.key
;
3196 offset
= msg
.u
.push_metadata
.target_offset
;
3197 version
= msg
.u
.push_metadata
.version
;
3199 assert(key
== channel
->key
);
3201 DBG("No new metadata to receive for key %" PRIu64
, key
);
3204 health_code_update();
3206 /* Tell session daemon we are ready to receive the metadata. */
3207 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
3208 LTTCOMM_CONSUMERD_SUCCESS
);
3209 if (ret
< 0 || len
== 0) {
3211 * Somehow, the session daemon is not responding anymore or there is
3212 * nothing to receive.
3217 health_code_update();
3219 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
3220 key
, offset
, len
, version
, channel
, timer
, wait
);
3223 * Only send the status msg if the sessiond is alive meaning a positive
3226 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
3231 health_code_update();
3233 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
3238 * Return the ustctl call for the get stream id.
3240 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
3241 uint64_t *stream_id
)
3246 return ustctl_get_stream_id(stream
->ustream
, stream_id
);