X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fconsumer%2Fconsumer.c;h=84fdbcaaa6902e076476489c3ab4e6b1aa7a1c9a;hp=e99dc54ed0a98897eb866a19bceb5ecf7087f163;hb=1cbd136b2479ef142bfb339b13d3d25aa772dda5;hpb=c70636a7342f34e3be68fcf411cf3e3718b8e73f diff --git a/src/common/consumer/consumer.c b/src/common/consumer/consumer.c index e99dc54ed..84fdbcaaa 100644 --- a/src/common/consumer/consumer.c +++ b/src/common/consumer/consumer.c @@ -1,24 +1,14 @@ /* - * Copyright (C) 2011 - Julien Desfossez - * Mathieu Desnoyers - * 2012 - David Goulet + * Copyright (C) 2011 Julien Desfossez + * Copyright (C) 2011 Mathieu Desnoyers + * Copyright (C) 2012 David Goulet * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License, version 2 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: GPL-2.0-only * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for - * more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +#include "common/index/ctf-index.h" #define _LGPL_SOURCE -#include #include #include #include @@ -54,10 +44,10 @@ #include #include -struct lttng_consumer_global_data consumer_data = { - .stream_count = 0, - .need_update = 1, - .type = LTTNG_CONSUMER_UNKNOWN, +struct lttng_consumer_global_data the_consumer_data = { + .stream_count = 0, + .need_update = 1, + .type = LTTNG_CONSUMER_UNKNOWN, }; enum consumer_channel_action { @@ -91,6 +81,20 @@ int consumer_quit; static struct lttng_ht *metadata_ht; static struct lttng_ht *data_ht; +static const char *get_consumer_domain(void) +{ + switch (the_consumer_data.type) { + case LTTNG_CONSUMER_KERNEL: + return DEFAULT_KERNEL_TRACE_DIR; + case LTTNG_CONSUMER64_UST: + /* Fall-through. */ + case LTTNG_CONSUMER32_UST: + return DEFAULT_UST_TRACE_DIR; + default: + abort(); + } +} + /* * Notify a thread lttng pipe to poll back again. This usually means that some * global state has changed so we just send back the thread in a poll wait @@ -100,7 +104,7 @@ static void notify_thread_lttng_pipe(struct lttng_pipe *pipe) { struct lttng_consumer_stream *null_stream = NULL; - assert(pipe); + LTTNG_ASSERT(pipe); (void) lttng_pipe_write(pipe, &null_stream, sizeof(null_stream)); } @@ -168,7 +172,7 @@ static void clean_channel_stream_list(struct lttng_consumer_channel *channel) { struct lttng_consumer_stream *stream, *stmp; - assert(channel); + LTTNG_ASSERT(channel); /* Delete streams that might have been left in the stream list. */ cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head, @@ -196,7 +200,7 @@ static struct lttng_consumer_stream *find_stream(uint64_t key, struct lttng_ht_node_u64 *node; struct lttng_consumer_stream *stream = NULL; - assert(ht); + LTTNG_ASSERT(ht); /* -1ULL keys are lookup failures */ if (key == (uint64_t) -1ULL) { @@ -251,7 +255,7 @@ struct lttng_consumer_channel *consumer_find_channel(uint64_t key) return NULL; } - lttng_ht_lookup(consumer_data.channel_ht, &key, &iter); + lttng_ht_lookup(the_consumer_data.channel_ht, &key, &iter); node = lttng_ht_iter_get_node_u64(&iter); if (node != NULL) { channel = caa_container_of(node, struct lttng_consumer_channel, node); @@ -293,7 +297,7 @@ static void free_channel_rcu(struct rcu_head *head) struct lttng_consumer_channel *channel = caa_container_of(node, struct lttng_consumer_channel, node); - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: break; case LTTNG_CONSUMER32_UST: @@ -347,7 +351,7 @@ void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd) DBG("Consumer destroy and close relayd socket pair"); iter.iter.node = &relayd->node.node; - ret = lttng_ht_del(consumer_data.relayd_ht, &iter); + ret = lttng_ht_del(the_consumer_data.relayd_ht, &iter); if (ret != 0) { /* We assume the relayd is being or is destroyed */ return; @@ -367,7 +371,7 @@ void consumer_del_channel(struct lttng_consumer_channel *channel) DBG("Consumer delete channel key %" PRIu64, channel->key); - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); pthread_mutex_lock(&channel->lock); /* Destroy streams that might have been left in the stream list. */ @@ -380,7 +384,7 @@ void consumer_del_channel(struct lttng_consumer_channel *channel) consumer_timer_monitor_stop(channel); } - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: break; case LTTNG_CONSUMER32_UST: @@ -389,7 +393,7 @@ void consumer_del_channel(struct lttng_consumer_channel *channel) break; default: ERR("Unknown consumer_data type"); - assert(0); + abort(); goto end; } @@ -401,13 +405,13 @@ void consumer_del_channel(struct lttng_consumer_channel *channel) rcu_read_lock(); iter.iter.node = &channel->node.node; - ret = lttng_ht_del(consumer_data.channel_ht, &iter); - assert(!ret); + ret = lttng_ht_del(the_consumer_data.channel_ht, &iter); + LTTNG_ASSERT(!ret); iter.iter.node = &channel->channels_by_session_id_ht_node.node; - ret = lttng_ht_del(consumer_data.channels_by_session_id_ht, + ret = lttng_ht_del(the_consumer_data.channels_by_session_id_ht, &iter); - assert(!ret); + LTTNG_ASSERT(!ret); rcu_read_unlock(); } @@ -415,7 +419,7 @@ void consumer_del_channel(struct lttng_consumer_channel *channel) call_rcu(&channel->node.head, free_channel_rcu); end: pthread_mutex_unlock(&channel->lock); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); } /* @@ -429,14 +433,14 @@ static void cleanup_relayd_ht(void) rcu_read_lock(); - cds_lfht_for_each_entry(consumer_data.relayd_ht->ht, &iter.iter, relayd, - node.node) { + cds_lfht_for_each_entry(the_consumer_data.relayd_ht->ht, &iter.iter, + relayd, node.node) { consumer_destroy_relayd(relayd); } rcu_read_unlock(); - lttng_ht_destroy(consumer_data.relayd_ht); + lttng_ht_destroy(the_consumer_data.relayd_ht); } /* @@ -486,7 +490,7 @@ void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd) { uint64_t netidx; - assert(relayd); + LTTNG_ASSERT(relayd); DBG("Cleaning up relayd object ID %"PRIu64, relayd->net_seq_idx); @@ -520,7 +524,7 @@ void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd) */ void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair *relayd) { - assert(relayd); + LTTNG_ASSERT(relayd); /* Set destroy flag for this object */ uatomic_set(&relayd->destroy_flag, 1); @@ -564,94 +568,6 @@ void consumer_stream_update_channel_attributes( channel->tracefile_size; } -struct lttng_consumer_stream *consumer_allocate_stream(uint64_t channel_key, - uint64_t stream_key, - const char *channel_name, - uint64_t relayd_id, - uint64_t session_id, - struct lttng_trace_chunk *trace_chunk, - int cpu, - int *alloc_ret, - enum consumer_channel_type type, - unsigned int monitor) -{ - int ret; - struct lttng_consumer_stream *stream; - - stream = zmalloc(sizeof(*stream)); - if (stream == NULL) { - PERROR("malloc struct lttng_consumer_stream"); - ret = -ENOMEM; - goto end; - } - - if (trace_chunk && !lttng_trace_chunk_get(trace_chunk)) { - ERR("Failed to acquire trace chunk reference during the creation of a stream"); - ret = -1; - goto error; - } - - rcu_read_lock(); - stream->key = stream_key; - stream->trace_chunk = trace_chunk; - stream->out_fd = -1; - stream->out_fd_offset = 0; - stream->output_written = 0; - stream->net_seq_idx = relayd_id; - stream->session_id = session_id; - stream->monitor = monitor; - stream->endpoint_status = CONSUMER_ENDPOINT_ACTIVE; - stream->index_file = NULL; - stream->last_sequence_number = -1ULL; - pthread_mutex_init(&stream->lock, NULL); - pthread_mutex_init(&stream->metadata_timer_lock, NULL); - - /* If channel is the metadata, flag this stream as metadata. */ - if (type == CONSUMER_CHANNEL_TYPE_METADATA) { - stream->metadata_flag = 1; - /* Metadata is flat out. */ - strncpy(stream->name, DEFAULT_METADATA_NAME, sizeof(stream->name)); - /* Live rendez-vous point. */ - pthread_cond_init(&stream->metadata_rdv, NULL); - pthread_mutex_init(&stream->metadata_rdv_lock, NULL); - } else { - /* Format stream name to _ */ - ret = snprintf(stream->name, sizeof(stream->name), "%s_%d", - channel_name, cpu); - if (ret < 0) { - PERROR("snprintf stream name"); - goto error; - } - } - - /* Key is always the wait_fd for streams. */ - lttng_ht_node_init_u64(&stream->node, stream->key); - - /* Init node per channel id key */ - lttng_ht_node_init_u64(&stream->node_channel_id, channel_key); - - /* Init session id node with the stream session id */ - lttng_ht_node_init_u64(&stream->node_session_id, stream->session_id); - - DBG3("Allocated stream %s (key %" PRIu64 ", chan_key %" PRIu64 - " relayd_id %" PRIu64 ", session_id %" PRIu64, - stream->name, stream->key, channel_key, - stream->net_seq_idx, stream->session_id); - - rcu_read_unlock(); - return stream; - -error: - rcu_read_unlock(); - lttng_trace_chunk_put(stream->trace_chunk); - free(stream); -end: - if (alloc_ret) { - *alloc_ret = ret; - } - return NULL; -} - /* * Add a stream to the global list protected by a mutex. */ @@ -659,12 +575,12 @@ void consumer_add_data_stream(struct lttng_consumer_stream *stream) { struct lttng_ht *ht = data_ht; - assert(stream); - assert(ht); + LTTNG_ASSERT(stream); + LTTNG_ASSERT(ht); DBG3("Adding consumer stream %" PRIu64, stream->key); - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); pthread_mutex_lock(&stream->chan->lock); pthread_mutex_lock(&stream->chan->timer_lock); pthread_mutex_lock(&stream->lock); @@ -675,7 +591,7 @@ void consumer_add_data_stream(struct lttng_consumer_stream *stream) lttng_ht_add_unique_u64(ht, &stream->node); - lttng_ht_add_u64(consumer_data.stream_per_chan_id_ht, + lttng_ht_add_u64(the_consumer_data.stream_per_chan_id_ht, &stream->node_channel_id); /* @@ -683,7 +599,8 @@ void consumer_add_data_stream(struct lttng_consumer_stream *stream) * the key since the HT does not use it and we allow to add redundant keys * into this table. */ - lttng_ht_add_u64(consumer_data.stream_list_ht, &stream->node_session_id); + lttng_ht_add_u64(the_consumer_data.stream_list_ht, + &stream->node_session_id); /* * When nb_init_stream_left reaches 0, we don't need to trigger any action @@ -699,14 +616,14 @@ void consumer_add_data_stream(struct lttng_consumer_stream *stream) } /* Update consumer data once the node is inserted. */ - consumer_data.stream_count++; - consumer_data.need_update = 1; + the_consumer_data.stream_count++; + the_consumer_data.need_update = 1; rcu_read_unlock(); pthread_mutex_unlock(&stream->lock); pthread_mutex_unlock(&stream->chan->timer_lock); pthread_mutex_unlock(&stream->chan->lock); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); } /* @@ -719,15 +636,15 @@ static int add_relayd(struct consumer_relayd_sock_pair *relayd) struct lttng_ht_node_u64 *node; struct lttng_ht_iter iter; - assert(relayd); + LTTNG_ASSERT(relayd); - lttng_ht_lookup(consumer_data.relayd_ht, - &relayd->net_seq_idx, &iter); + lttng_ht_lookup(the_consumer_data.relayd_ht, &relayd->net_seq_idx, + &iter); node = lttng_ht_iter_get_node_u64(&iter); if (node != NULL) { goto end; } - lttng_ht_add_unique_u64(consumer_data.relayd_ht, &relayd->node); + lttng_ht_add_unique_u64(the_consumer_data.relayd_ht, &relayd->node); end: return ret; @@ -782,8 +699,7 @@ struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key) goto error; } - lttng_ht_lookup(consumer_data.relayd_ht, &key, - &iter); + lttng_ht_lookup(the_consumer_data.relayd_ht, &key, &iter); node = lttng_ht_iter_get_node_u64(&iter); if (node != NULL) { relayd = caa_container_of(node, struct consumer_relayd_sock_pair, node); @@ -804,9 +720,9 @@ int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, int ret = 0; struct consumer_relayd_sock_pair *relayd; - assert(stream); - assert(stream->net_seq_idx != -1ULL); - assert(path); + LTTNG_ASSERT(stream); + LTTNG_ASSERT(stream->net_seq_idx != -1ULL); + LTTNG_ASSERT(path); /* The stream is not metadata. Get relayd reference if exists. */ rcu_read_lock(); @@ -815,7 +731,7 @@ int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, /* Add stream on the relayd */ pthread_mutex_lock(&relayd->ctrl_sock_mutex); ret = relayd_add_stream(&relayd->control_sock, stream->name, - path, &stream->relayd_stream_id, + get_consumer_domain(), path, &stream->relayd_stream_id, stream->chan->tracefile_size, stream->chan->tracefile_count, stream->trace_chunk); @@ -853,7 +769,7 @@ int consumer_send_relayd_streams_sent(uint64_t net_seq_idx) int ret = 0; struct consumer_relayd_sock_pair *relayd; - assert(net_seq_idx != -1ULL); + LTTNG_ASSERT(net_seq_idx != -1ULL); /* The stream is not metadata. Get relayd reference if exists. */ rcu_read_lock(); @@ -913,8 +829,8 @@ static int write_relayd_stream_header(struct lttng_consumer_stream *stream, struct lttcomm_relayd_data_hdr data_hdr; /* Safety net */ - assert(stream); - assert(relayd); + LTTNG_ASSERT(stream); + LTTNG_ASSERT(relayd); /* Reset data header */ memset(&data_hdr, 0, sizeof(data_hdr)); @@ -960,6 +876,43 @@ error: return outfd; } +/* + * Write a character on the metadata poll pipe to wake the metadata thread. + * Returns 0 on success, -1 on error. + */ +int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel) +{ + int ret = 0; + + DBG("Waking up metadata poll thread (writing to pipe): channel name = '%s'", + channel->name); + if (channel->monitor && channel->metadata_stream) { + const char dummy = 'c'; + const ssize_t write_ret = lttng_write( + channel->metadata_stream->ust_metadata_poll_pipe[1], + &dummy, 1); + + if (write_ret < 1) { + if (errno == EWOULDBLOCK) { + /* + * This is fine, the metadata poll thread + * is having a hard time keeping-up, but + * it will eventually wake-up and consume + * the available data. + */ + ret = 0; + } else { + PERROR("Failed to write to UST metadata pipe while attempting to wake-up the metadata poll thread"); + ret = -1; + goto end; + } + } + } + +end: + return ret; +} + /* * Trigger a dump of the metadata content. Following/during the succesful * completion of this call, the metadata poll thread will start receiving @@ -974,10 +927,10 @@ int consumer_metadata_stream_dump(struct lttng_consumer_stream *stream) ASSERT_LOCKED(stream->chan->lock); ASSERT_LOCKED(stream->lock); - assert(stream->metadata_flag); - assert(stream->chan->trace_chunk); + LTTNG_ASSERT(stream->metadata_flag); + LTTNG_ASSERT(stream->chan->trace_chunk); - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: /* * Reset the position of what has been read from the @@ -1030,7 +983,7 @@ int lttng_consumer_channel_set_trace_chunk( const bool acquired_reference = lttng_trace_chunk_get( new_trace_chunk); - assert(acquired_reference); + LTTNG_ASSERT(acquired_reference); } lttng_trace_chunk_put(channel->trace_chunk); @@ -1058,6 +1011,7 @@ struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key, uint64_t session_id_per_pid, unsigned int monitor, unsigned int live_timer_interval, + bool is_in_live_session, const char *root_shm_path, const char *shm_path) { @@ -1066,7 +1020,7 @@ struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key, if (chunk_id) { trace_chunk = lttng_trace_chunk_registry_find_chunk( - consumer_data.chunk_registry, session_id, + the_consumer_data.chunk_registry, session_id, *chunk_id); if (!trace_chunk) { ERR("Failed to find trace chunk reference during creation of channel"); @@ -1089,6 +1043,7 @@ struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key, channel->tracefile_count = tracefile_count; channel->monitor = monitor; channel->live_timer_interval = live_timer_interval; + channel->is_live = is_in_live_session; pthread_mutex_init(&channel->lock, NULL); pthread_mutex_init(&channel->timer_lock, NULL); @@ -1100,7 +1055,7 @@ struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key, channel->output = CONSUMER_CHANNEL_MMAP; break; default: - assert(0); + abort(); free(channel); channel = NULL; goto end; @@ -1168,7 +1123,7 @@ error: int consumer_add_channel(struct lttng_consumer_channel *channel, struct lttng_consumer_local_data *ctx) { - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); pthread_mutex_lock(&channel->lock); pthread_mutex_lock(&channel->timer_lock); @@ -1180,15 +1135,15 @@ int consumer_add_channel(struct lttng_consumer_channel *channel, steal_channel_key(channel->key); rcu_read_lock(); - lttng_ht_add_unique_u64(consumer_data.channel_ht, &channel->node); - lttng_ht_add_u64(consumer_data.channels_by_session_id_ht, + lttng_ht_add_unique_u64(the_consumer_data.channel_ht, &channel->node); + lttng_ht_add_u64(the_consumer_data.channels_by_session_id_ht, &channel->channels_by_session_id_ht_node); rcu_read_unlock(); channel->is_published = true; pthread_mutex_unlock(&channel->timer_lock); pthread_mutex_unlock(&channel->lock); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); if (channel->wait_fd != -1 && channel->type == CONSUMER_CHANNEL_TYPE_DATA) { notify_channel_pipe(ctx, channel, -1, CONSUMER_CHANNEL_ADD); @@ -1212,10 +1167,10 @@ static int update_poll_array(struct lttng_consumer_local_data *ctx, struct lttng_ht_iter iter; struct lttng_consumer_stream *stream; - assert(ctx); - assert(ht); - assert(pollfd); - assert(local_stream); + LTTNG_ASSERT(ctx); + LTTNG_ASSERT(ht); + LTTNG_ASSERT(pollfd); + LTTNG_ASSERT(local_stream); DBG("Updating poll fd array"); *nb_inactive_fd = 0; @@ -1332,26 +1287,26 @@ void lttng_consumer_cleanup(void) rcu_read_lock(); - cds_lfht_for_each_entry(consumer_data.channel_ht->ht, &iter.iter, channel, - node.node) { + cds_lfht_for_each_entry(the_consumer_data.channel_ht->ht, &iter.iter, + channel, node.node) { consumer_del_channel(channel); } rcu_read_unlock(); - lttng_ht_destroy(consumer_data.channel_ht); - lttng_ht_destroy(consumer_data.channels_by_session_id_ht); + lttng_ht_destroy(the_consumer_data.channel_ht); + lttng_ht_destroy(the_consumer_data.channels_by_session_id_ht); cleanup_relayd_ht(); - lttng_ht_destroy(consumer_data.stream_per_chan_id_ht); + lttng_ht_destroy(the_consumer_data.stream_per_chan_id_ht); /* * This HT contains streams that are freed by either the metadata thread or * the data thread so we do *nothing* on the hash table and simply destroy * it. */ - lttng_ht_destroy(consumer_data.stream_list_ht); + lttng_ht_destroy(the_consumer_data.stream_list_ht); /* * Trace chunks in the registry may still exist if the session @@ -1366,7 +1321,7 @@ void lttng_consumer_cleanup(void) * to hit. */ trace_chunks_left = lttng_trace_chunk_registry_put_each_chunk( - consumer_data.chunk_registry); + the_consumer_data.chunk_registry); if (trace_chunks_left) { ERR("%u trace chunks are leaked by lttng-consumerd. " "This can be caused by an internal error of the session daemon.", @@ -1374,7 +1329,7 @@ void lttng_consumer_cleanup(void) } /* Run all callbacks freeing each chunk. */ rcu_barrier(); - lttng_trace_chunk_registry_destroy(consumer_data.chunk_registry); + lttng_trace_chunk_registry_destroy(the_consumer_data.chunk_registry); } /* @@ -1457,7 +1412,7 @@ void lttng_consumer_sync_trace_file(struct lttng_consumer_stream *stream, struct lttng_consumer_local_data *lttng_consumer_create( enum lttng_consumer_type type, ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream, - struct lttng_consumer_local_data *ctx), + struct lttng_consumer_local_data *ctx, bool locked_by_caller), int (*recv_channel)(struct lttng_consumer_channel *channel), int (*recv_stream)(struct lttng_consumer_stream *stream), int (*update_stream)(uint64_t stream_key, uint32_t state)) @@ -1465,9 +1420,9 @@ struct lttng_consumer_local_data *lttng_consumer_create( int ret; struct lttng_consumer_local_data *ctx; - assert(consumer_data.type == LTTNG_CONSUMER_UNKNOWN || - consumer_data.type == type); - consumer_data.type = type; + LTTNG_ASSERT(the_consumer_data.type == LTTNG_CONSUMER_UNKNOWN || + the_consumer_data.type == type); + the_consumer_data.type = type; ctx = zmalloc(sizeof(struct lttng_consumer_local_data)); if (ctx == NULL) { @@ -1664,23 +1619,22 @@ end: * Returns the number of bytes written */ ssize_t lttng_consumer_on_read_subbuffer_mmap( - struct lttng_consumer_local_data *ctx, - struct lttng_consumer_stream *stream, unsigned long len, - unsigned long padding, - struct ctf_packet_index *index) + struct lttng_consumer_stream *stream, + const struct lttng_buffer_view *buffer, + unsigned long padding) { - unsigned long mmap_offset; - void *mmap_base; ssize_t ret = 0; off_t orig_offset = stream->out_fd_offset; /* Default is on the disk */ int outfd = stream->out_fd; struct consumer_relayd_sock_pair *relayd = NULL; unsigned int relayd_hang_up = 0; + const size_t subbuf_content_size = buffer->size - padding; + size_t write_len; /* RCU lock for the relayd pointer */ rcu_read_lock(); - assert(stream->net_seq_idx != (uint64_t) -1ULL || + LTTNG_ASSERT(stream->net_seq_idx != (uint64_t) -1ULL || stream->trace_chunk); /* Flag that the current stream if set for network streaming. */ @@ -1692,39 +1646,9 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( } } - /* get the offset inside the fd to mmap */ - switch (consumer_data.type) { - case LTTNG_CONSUMER_KERNEL: - mmap_base = stream->mmap_base; - ret = kernctl_get_mmap_read_offset(stream->wait_fd, &mmap_offset); - if (ret < 0) { - PERROR("tracer ctl get_mmap_read_offset"); - goto end; - } - break; - case LTTNG_CONSUMER32_UST: - case LTTNG_CONSUMER64_UST: - mmap_base = lttng_ustctl_get_mmap_base(stream); - if (!mmap_base) { - ERR("read mmap get mmap base for stream %s", stream->name); - ret = -EPERM; - goto end; - } - ret = lttng_ustctl_get_mmap_read_offset(stream, &mmap_offset); - if (ret != 0) { - PERROR("tracer ctl get_mmap_read_offset"); - ret = -EINVAL; - goto end; - } - break; - default: - ERR("Unknown consumer_data type"); - assert(0); - } - /* Handle stream on the relayd if the output is on the network */ if (relayd) { - unsigned long netlen = len; + unsigned long netlen = subbuf_content_size; /* * Lock the control socket for the complete duration of the function @@ -1762,10 +1686,10 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( goto write_error; } } - } else { - /* No streaming, we have to set the len with the full padding */ - len += padding; + write_len = subbuf_content_size; + } else { + /* No streaming; we have to write the full padding. */ if (stream->metadata_flag && stream->reset_metadata_flag) { ret = utils_truncate_stream_file(stream->out_fd, 0); if (ret < 0) { @@ -1779,7 +1703,7 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( * Check if we need to change the tracefile before writing the packet. */ if (stream->chan->tracefile_size > 0 && - (stream->tracefile_size_current + len) > + (stream->tracefile_size_current + buffer->size) > stream->chan->tracefile_size) { ret = consumer_stream_rotate_output_files(stream); if (ret) { @@ -1788,19 +1712,17 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( outfd = stream->out_fd; orig_offset = 0; } - stream->tracefile_size_current += len; - if (index) { - index->offset = htobe64(stream->out_fd_offset); - } + stream->tracefile_size_current += buffer->size; + write_len = buffer->size; } /* * This call guarantee that len or less is returned. It's impossible to * receive a ret value that is bigger than len. */ - ret = lttng_write(outfd, mmap_base + mmap_offset, len); - DBG("Consumer mmap write() ret %zd (len %lu)", ret, len); - if (ret < 0 || ((size_t) ret != len)) { + ret = lttng_write(outfd, buffer->data, write_len); + DBG("Consumer mmap write() ret %zd (len %zu)", ret, write_len); + if (ret < 0 || ((size_t) ret != write_len)) { /* * Report error to caller if nothing was written else at least send the * amount written. @@ -1821,7 +1743,8 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( DBG("Consumer mmap write detected relayd hang up"); } else { /* Unhandled error, print it and stop function right now. */ - PERROR("Error in write mmap (ret %zd != len %lu)", ret, len); + PERROR("Error in write mmap (ret %zd != write_len %zu)", ret, + write_len); } goto write_error; } @@ -1830,9 +1753,9 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap( /* This call is useless on a socket so better save a syscall. */ if (!relayd) { /* This won't block, but will start writeout asynchronously */ - lttng_sync_file_range(outfd, stream->out_fd_offset, len, + lttng_sync_file_range(outfd, stream->out_fd_offset, write_len, SYNC_FILE_RANGE_WRITE); - stream->out_fd_offset += len; + stream->out_fd_offset += write_len; lttng_consumer_sync_trace_file(stream, orig_offset); } @@ -1866,8 +1789,7 @@ end: ssize_t lttng_consumer_on_read_subbuffer_splice( struct lttng_consumer_local_data *ctx, struct lttng_consumer_stream *stream, unsigned long len, - unsigned long padding, - struct ctf_packet_index *index) + unsigned long padding) { ssize_t ret = 0, written = 0, ret_splice = 0; loff_t offset = 0; @@ -1879,7 +1801,7 @@ ssize_t lttng_consumer_on_read_subbuffer_splice( int *splice_pipe; unsigned int relayd_hang_up = 0; - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: break; case LTTNG_CONSUMER32_UST: @@ -1888,7 +1810,7 @@ ssize_t lttng_consumer_on_read_subbuffer_splice( return -ENOSYS; default: ERR("Unknown consumer_data type"); - assert(0); + abort(); } /* RCU lock for the relayd pointer */ @@ -1971,7 +1893,6 @@ ssize_t lttng_consumer_on_read_subbuffer_splice( orig_offset = 0; } stream->tracefile_size_current += len; - index->offset = htobe64(stream->out_fd_offset); } while (len > 0) { @@ -2084,7 +2005,7 @@ end: */ int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_sample_snapshot_positions(stream); case LTTNG_CONSUMER32_UST: @@ -2092,7 +2013,7 @@ int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *strea return lttng_ustconsumer_sample_snapshot_positions(stream); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } @@ -2103,7 +2024,7 @@ int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *strea */ int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_take_snapshot(stream); case LTTNG_CONSUMER32_UST: @@ -2111,7 +2032,7 @@ int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream) return lttng_ustconsumer_take_snapshot(stream); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } @@ -2124,7 +2045,7 @@ int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream) int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_get_produced_snapshot(stream, pos); case LTTNG_CONSUMER32_UST: @@ -2132,7 +2053,7 @@ int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream, return lttng_ustconsumer_get_produced_snapshot(stream, pos); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } @@ -2145,7 +2066,7 @@ int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream, int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_get_consumed_snapshot(stream, pos); case LTTNG_CONSUMER32_UST: @@ -2153,7 +2074,7 @@ int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream, return lttng_ustconsumer_get_consumed_snapshot(stream, pos); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } @@ -2161,7 +2082,7 @@ int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream, int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx, int sock, struct pollfd *consumer_sockpoll) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_recv_cmd(ctx, sock, consumer_sockpoll); case LTTNG_CONSUMER32_UST: @@ -2169,14 +2090,15 @@ int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx, return lttng_ustconsumer_recv_cmd(ctx, sock, consumer_sockpoll); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } +static void lttng_consumer_close_all_metadata(void) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: /* * The Kernel consumer has a different metadata scheme so we don't @@ -2196,7 +2118,7 @@ void lttng_consumer_close_all_metadata(void) break; default: ERR("Unknown consumer_data type"); - assert(0); + abort(); } } @@ -2209,16 +2131,16 @@ void consumer_del_metadata_stream(struct lttng_consumer_stream *stream, struct lttng_consumer_channel *channel = NULL; bool free_channel = false; - assert(stream); + LTTNG_ASSERT(stream); /* * This call should NEVER receive regular stream. It must always be * metadata stream and this is crucial for data structure synchronization. */ - assert(stream->metadata_flag); + LTTNG_ASSERT(stream->metadata_flag); DBG3("Consumer delete metadata stream %d", stream->wait_fd); - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); /* * Note that this assumes that a stream's channel is never changed and * that the stream's lock doesn't need to be taken to sample its @@ -2260,7 +2182,7 @@ void consumer_del_metadata_stream(struct lttng_consumer_stream *stream, } pthread_mutex_unlock(&stream->lock); pthread_mutex_unlock(&channel->lock); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); if (free_channel) { consumer_del_channel(channel); @@ -2281,12 +2203,12 @@ void consumer_add_metadata_stream(struct lttng_consumer_stream *stream) struct lttng_ht_iter iter; struct lttng_ht_node_u64 *node; - assert(stream); - assert(ht); + LTTNG_ASSERT(stream); + LTTNG_ASSERT(ht); DBG3("Adding metadata stream %" PRIu64 " to hash table", stream->key); - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); pthread_mutex_lock(&stream->chan->lock); pthread_mutex_lock(&stream->chan->timer_lock); pthread_mutex_lock(&stream->lock); @@ -2304,7 +2226,7 @@ void consumer_add_metadata_stream(struct lttng_consumer_stream *stream) */ lttng_ht_lookup(ht, &stream->key, &iter); node = lttng_ht_iter_get_node_u64(&iter); - assert(!node); + LTTNG_ASSERT(!node); /* * When nb_init_stream_left reaches 0, we don't need to trigger any action @@ -2321,22 +2243,23 @@ void consumer_add_metadata_stream(struct lttng_consumer_stream *stream) lttng_ht_add_unique_u64(ht, &stream->node); - lttng_ht_add_u64(consumer_data.stream_per_chan_id_ht, - &stream->node_channel_id); + lttng_ht_add_u64(the_consumer_data.stream_per_chan_id_ht, + &stream->node_channel_id); /* * Add stream to the stream_list_ht of the consumer data. No need to steal * the key since the HT does not use it and we allow to add redundant keys * into this table. */ - lttng_ht_add_u64(consumer_data.stream_list_ht, &stream->node_session_id); + lttng_ht_add_u64(the_consumer_data.stream_list_ht, + &stream->node_session_id); rcu_read_unlock(); pthread_mutex_unlock(&stream->lock); pthread_mutex_unlock(&stream->chan->lock); pthread_mutex_unlock(&stream->chan->timer_lock); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); } /* @@ -2372,7 +2295,7 @@ static void validate_endpoint_status_metadata_stream( DBG("Consumer delete flagged metadata stream"); - assert(pollset); + LTTNG_ASSERT(pollset); rcu_read_lock(); cds_lfht_for_each_entry(metadata_ht->ht, &iter.iter, stream, node.node) { @@ -2524,7 +2447,7 @@ restart: lttng_ht_lookup(metadata_ht, &tmp_id, &iter); } node = lttng_ht_iter_get_node_u64(&iter); - assert(node); + LTTNG_ASSERT(node); stream = caa_container_of(node, struct lttng_consumer_stream, node); @@ -2532,12 +2455,12 @@ restart: if (revents & (LPOLLIN | LPOLLPRI)) { /* Get the data out of the metadata file descriptor */ DBG("Metadata available on fd %d", pollfd); - assert(stream->wait_fd == pollfd); + LTTNG_ASSERT(stream->wait_fd == pollfd); do { health_code_update(); - len = ctx->on_buffer_ready(stream, ctx); + len = ctx->on_buffer_ready(stream, ctx, false); /* * We don't check the return value here since if we get * a negative len, it means an error occurred thus we @@ -2554,9 +2477,10 @@ restart: } } else if (revents & (LPOLLERR | LPOLLHUP)) { DBG("Metadata fd %d is hup|err.", pollfd); - if (!stream->hangup_flush_done - && (consumer_data.type == LTTNG_CONSUMER32_UST - || consumer_data.type == LTTNG_CONSUMER64_UST)) { + if (!stream->hangup_flush_done && + (the_consumer_data.type == LTTNG_CONSUMER32_UST || + the_consumer_data.type == + LTTNG_CONSUMER64_UST)) { DBG("Attempting to flush and consume the UST buffers"); lttng_ustconsumer_on_stream_hangup(stream); @@ -2564,7 +2488,7 @@ restart: do { health_code_update(); - len = ctx->on_buffer_ready(stream, ctx); + len = ctx->on_buffer_ready(stream, ctx, false); /* * We don't check the return value here since if we get * a negative len, it means an error occurred thus we @@ -2652,8 +2576,8 @@ void *consumer_thread_data_poll(void *data) * the fds set has been updated, we need to update our * local array as well */ - pthread_mutex_lock(&consumer_data.lock); - if (consumer_data.need_update) { + pthread_mutex_lock(&the_consumer_data.lock); + if (the_consumer_data.need_update) { free(pollfd); pollfd = NULL; @@ -2661,18 +2585,21 @@ void *consumer_thread_data_poll(void *data) local_stream = NULL; /* Allocate for all fds */ - pollfd = zmalloc((consumer_data.stream_count + nb_pipes_fd) * sizeof(struct pollfd)); + pollfd = zmalloc((the_consumer_data.stream_count + + nb_pipes_fd) * + sizeof(struct pollfd)); if (pollfd == NULL) { PERROR("pollfd malloc"); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); goto end; } - local_stream = zmalloc((consumer_data.stream_count + nb_pipes_fd) * + local_stream = zmalloc((the_consumer_data.stream_count + + nb_pipes_fd) * sizeof(struct lttng_consumer_stream *)); if (local_stream == NULL) { PERROR("local_stream malloc"); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); goto end; } ret = update_poll_array(ctx, &pollfd, local_stream, @@ -2680,13 +2607,13 @@ void *consumer_thread_data_poll(void *data) if (ret < 0) { ERR("Error in allocating pollfd or local_outfds"); lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_POLL_ERROR); - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); goto end; } nb_fd = ret; - consumer_data.need_update = 0; + the_consumer_data.need_update = 0; } - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); /* No FDs and consumer_quit, consumer_cleanup the thread */ if (nb_fd == 0 && nb_inactive_fd == 0 && @@ -2780,7 +2707,7 @@ void *consumer_thread_data_poll(void *data) if (pollfd[i].revents & POLLPRI) { DBG("Urgent read on fd %d", pollfd[i].fd); high_prio = 1; - len = ctx->on_buffer_ready(local_stream[i], ctx); + len = ctx->on_buffer_ready(local_stream[i], ctx, false); /* it's ok to have an unavailable sub-buffer */ if (len < 0 && len != -EAGAIN && len != -ENODATA) { /* Clean the stream and free it. */ @@ -2811,7 +2738,7 @@ void *consumer_thread_data_poll(void *data) local_stream[i]->hangup_flush_done || local_stream[i]->has_data) { DBG("Normal read on fd %d", pollfd[i].fd); - len = ctx->on_buffer_ready(local_stream[i], ctx); + len = ctx->on_buffer_ready(local_stream[i], ctx, false); /* it's ok to have an unavailable sub-buffer */ if (len < 0 && len != -EAGAIN && len != -ENODATA) { /* Clean the stream and free it. */ @@ -2832,8 +2759,8 @@ void *consumer_thread_data_poll(void *data) } if (!local_stream[i]->hangup_flush_done && (pollfd[i].revents & (POLLHUP | POLLERR | POLLNVAL)) - && (consumer_data.type == LTTNG_CONSUMER32_UST - || consumer_data.type == LTTNG_CONSUMER64_UST)) { + && (the_consumer_data.type == LTTNG_CONSUMER32_UST + || the_consumer_data.type == LTTNG_CONSUMER64_UST)) { DBG("fd %d is hup|err|nval. Attempting flush and read.", pollfd[i].fd); lttng_ustconsumer_on_stream_hangup(local_stream[i]); @@ -2912,7 +2839,7 @@ void consumer_close_channel_streams(struct lttng_consumer_channel *channel) struct lttng_consumer_stream *stream; struct lttng_ht_iter iter; - ht = consumer_data.stream_per_chan_id_ht; + ht = the_consumer_data.stream_per_chan_id_ht; rcu_read_lock(); cds_lfht_for_each_entry_duplicate(ht->ht, @@ -2926,7 +2853,7 @@ void consumer_close_channel_streams(struct lttng_consumer_channel *channel) if (cds_lfht_is_node_deleted(&stream->node.node)) { goto next; } - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: break; case LTTNG_CONSUMER32_UST: @@ -2945,7 +2872,7 @@ void consumer_close_channel_streams(struct lttng_consumer_channel *channel) break; default: ERR("Unknown consumer_data type"); - assert(0); + abort(); } next: pthread_mutex_unlock(&stream->lock); @@ -2966,7 +2893,7 @@ static void destroy_channel_ht(struct lttng_ht *ht) rcu_read_lock(); cds_lfht_for_each_entry(ht->ht, &iter.iter, channel, wait_fd_node.node) { ret = lttng_ht_del(ht, &iter); - assert(ret != 0); + LTTNG_ASSERT(ret != 0); } rcu_read_unlock(); @@ -3104,9 +3031,9 @@ restart: lttng_poll_del(&events, chan->wait_fd); iter.iter.node = &chan->wait_fd_node.node; ret = lttng_ht_del(channel_ht, &iter); - assert(ret == 0); + LTTNG_ASSERT(ret == 0); - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: break; case LTTNG_CONSUMER32_UST: @@ -3117,7 +3044,7 @@ restart: break; default: ERR("Unknown consumer_data type"); - assert(0); + abort(); } /* @@ -3165,7 +3092,7 @@ restart: lttng_ht_lookup(channel_ht, &tmp_id, &iter); } node = lttng_ht_iter_get_node_u64(&iter); - assert(node); + LTTNG_ASSERT(node); chan = caa_container_of(node, struct lttng_consumer_channel, wait_fd_node); @@ -3176,7 +3103,7 @@ restart: lttng_poll_del(&events, chan->wait_fd); ret = lttng_ht_del(channel_ht, &iter); - assert(ret == 0); + LTTNG_ASSERT(ret == 0); /* * This will close the wait fd for each stream associated to @@ -3224,8 +3151,8 @@ static int set_metadata_socket(struct lttng_consumer_local_data *ctx, { int ret; - assert(ctx); - assert(sockpoll); + LTTNG_ASSERT(ctx); + LTTNG_ASSERT(sockpoll); ret = lttng_consumer_poll_socket(sockpoll); if (ret) { @@ -3367,7 +3294,7 @@ void *consumer_thread_sessiond_poll(void *data) err = 0; /* All is OK */ goto end; } - DBG("received command on sock"); + DBG("Received command on sock"); } /* All is OK */ err = 0; @@ -3424,45 +3351,144 @@ error_testpoint: return NULL; } -ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream, +static int post_consume(struct lttng_consumer_stream *stream, + const struct stream_subbuffer *subbuffer, struct lttng_consumer_local_data *ctx) { - ssize_t ret; + size_t i; + int ret = 0; + const size_t count = lttng_dynamic_array_get_count( + &stream->read_subbuffer_ops.post_consume_cbs); - pthread_mutex_lock(&stream->chan->lock); - pthread_mutex_lock(&stream->lock); - if (stream->metadata_flag) { - pthread_mutex_lock(&stream->metadata_rdv_lock); + for (i = 0; i < count; i++) { + const post_consume_cb op = *(post_consume_cb *) lttng_dynamic_array_get_element( + &stream->read_subbuffer_ops.post_consume_cbs, + i); + + ret = op(stream, subbuffer, ctx); + if (ret) { + goto end; + } } +end: + return ret; +} - switch (consumer_data.type) { - case LTTNG_CONSUMER_KERNEL: - ret = lttng_kconsumer_read_subbuffer(stream, ctx); - break; - case LTTNG_CONSUMER32_UST: - case LTTNG_CONSUMER64_UST: - ret = lttng_ustconsumer_read_subbuffer(stream, ctx); +ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream, + struct lttng_consumer_local_data *ctx, + bool locked_by_caller) +{ + ssize_t ret, written_bytes = 0; + int rotation_ret; + struct stream_subbuffer subbuffer = {}; + enum get_next_subbuffer_status get_next_status; + + if (!locked_by_caller) { + stream->read_subbuffer_ops.lock(stream); + } + + if (stream->read_subbuffer_ops.on_wake_up) { + ret = stream->read_subbuffer_ops.on_wake_up(stream); + if (ret) { + goto end; + } + } + + /* + * If the stream was flagged to be ready for rotation before we extract + * the next packet, rotate it now. + */ + if (stream->rotate_ready) { + DBG("Rotate stream before consuming data"); + ret = lttng_consumer_rotate_stream(ctx, stream); + if (ret < 0) { + ERR("Stream rotation error before consuming data"); + goto end; + } + } + + get_next_status = stream->read_subbuffer_ops.get_next_subbuffer( + stream, &subbuffer); + switch (get_next_status) { + case GET_NEXT_SUBBUFFER_STATUS_OK: break; + case GET_NEXT_SUBBUFFER_STATUS_NO_DATA: + /* Not an error. */ + ret = 0; + goto sleep_stream; + case GET_NEXT_SUBBUFFER_STATUS_ERROR: + ret = -1; + goto end; default: - ERR("Unknown consumer_data type"); - assert(0); - ret = -ENOSYS; - break; + abort(); } - if (stream->metadata_flag) { - pthread_cond_broadcast(&stream->metadata_rdv); - pthread_mutex_unlock(&stream->metadata_rdv_lock); + ret = stream->read_subbuffer_ops.pre_consume_subbuffer( + stream, &subbuffer); + if (ret) { + goto error_put_subbuf; + } + + written_bytes = stream->read_subbuffer_ops.consume_subbuffer( + ctx, stream, &subbuffer); + if (written_bytes <= 0) { + ERR("Error consuming subbuffer: (%zd)", written_bytes); + ret = (int) written_bytes; + goto error_put_subbuf; + } + + ret = stream->read_subbuffer_ops.put_next_subbuffer(stream, &subbuffer); + if (ret) { + goto end; + } + + ret = post_consume(stream, &subbuffer, ctx); + if (ret) { + goto end; + } + + /* + * After extracting the packet, we check if the stream is now ready to + * be rotated and perform the action immediately. + * + * Don't overwrite `ret` as callers expect the number of bytes + * consumed to be returned on success. + */ + rotation_ret = lttng_consumer_stream_is_rotate_ready(stream); + if (rotation_ret == 1) { + rotation_ret = lttng_consumer_rotate_stream(ctx, stream); + if (rotation_ret < 0) { + ret = rotation_ret; + ERR("Stream rotation error after consuming data"); + goto end; + } + + } else if (rotation_ret < 0) { + ret = rotation_ret; + ERR("Failed to check if stream was ready to rotate after consuming data"); + goto end; + } + +sleep_stream: + if (stream->read_subbuffer_ops.on_sleep) { + stream->read_subbuffer_ops.on_sleep(stream, ctx); + } + + ret = written_bytes; +end: + if (!locked_by_caller) { + stream->read_subbuffer_ops.unlock(stream); } - pthread_mutex_unlock(&stream->lock); - pthread_mutex_unlock(&stream->chan->lock); return ret; +error_put_subbuf: + (void) stream->read_subbuffer_ops.put_next_subbuffer(stream, &subbuffer); + goto end; } int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream) { - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: return lttng_kconsumer_on_recv_stream(stream); case LTTNG_CONSUMER32_UST: @@ -3470,7 +3496,7 @@ int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream) return lttng_ustconsumer_on_recv_stream(stream); default: ERR("Unknown consumer_data type"); - assert(0); + abort(); return -ENOSYS; } } @@ -3480,29 +3506,30 @@ int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream) */ int lttng_consumer_init(void) { - consumer_data.channel_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); - if (!consumer_data.channel_ht) { + the_consumer_data.channel_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); + if (!the_consumer_data.channel_ht) { goto error; } - consumer_data.channels_by_session_id_ht = + the_consumer_data.channels_by_session_id_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); - if (!consumer_data.channels_by_session_id_ht) { + if (!the_consumer_data.channels_by_session_id_ht) { goto error; } - consumer_data.relayd_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); - if (!consumer_data.relayd_ht) { + the_consumer_data.relayd_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); + if (!the_consumer_data.relayd_ht) { goto error; } - consumer_data.stream_list_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); - if (!consumer_data.stream_list_ht) { + the_consumer_data.stream_list_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); + if (!the_consumer_data.stream_list_ht) { goto error; } - consumer_data.stream_per_chan_id_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); - if (!consumer_data.stream_per_chan_id_ht) { + the_consumer_data.stream_per_chan_id_ht = + lttng_ht_new(0, LTTNG_HT_TYPE_U64); + if (!the_consumer_data.stream_per_chan_id_ht) { goto error; } @@ -3516,8 +3543,8 @@ int lttng_consumer_init(void) goto error; } - consumer_data.chunk_registry = lttng_trace_chunk_registry_create(); - if (!consumer_data.chunk_registry) { + the_consumer_data.chunk_registry = lttng_trace_chunk_registry_create(); + if (!the_consumer_data.chunk_registry) { goto error; } @@ -3543,15 +3570,15 @@ error: enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS; struct consumer_relayd_sock_pair *relayd = NULL; - assert(ctx); - assert(relayd_sock); + LTTNG_ASSERT(ctx); + LTTNG_ASSERT(relayd_sock); DBG("Consumer adding relayd socket (idx: %" PRIu64 ")", net_seq_idx); /* Get relayd reference if exists. */ relayd = consumer_find_relayd(net_seq_idx); if (relayd == NULL) { - assert(sock_type == LTTNG_STREAM_CONTROL); + LTTNG_ASSERT(sock_type == LTTNG_STREAM_CONTROL); /* Not found. Allocate one. */ relayd = consumer_allocate_relayd_sock_pair(net_seq_idx); if (relayd == NULL) { @@ -3571,7 +3598,7 @@ error: /* * relayd key should never be found for control socket. */ - assert(sock_type != LTTNG_STREAM_CONTROL); + LTTNG_ASSERT(sock_type != LTTNG_STREAM_CONTROL); } /* First send a status message before receiving the fds. */ @@ -3725,8 +3752,8 @@ static struct consumer_relayd_sock_pair *find_relayd_by_session_id(uint64_t id) struct consumer_relayd_sock_pair *relayd = NULL; /* Iterate over all relayd since they are indexed by net_seq_idx. */ - cds_lfht_for_each_entry(consumer_data.relayd_ht->ht, &iter.iter, relayd, - node.node) { + cds_lfht_for_each_entry(the_consumer_data.relayd_ht->ht, &iter.iter, + relayd, node.node) { /* * Check by sessiond id which is unique here where the relayd session * id might not be when having multiple relayd. @@ -3761,9 +3788,9 @@ int consumer_data_pending(uint64_t id) DBG("Consumer data pending command on session id %" PRIu64, id); rcu_read_lock(); - pthread_mutex_lock(&consumer_data.lock); + pthread_mutex_lock(&the_consumer_data.lock); - switch (consumer_data.type) { + switch (the_consumer_data.type) { case LTTNG_CONSUMER_KERNEL: data_pending = lttng_kconsumer_data_pending; break; @@ -3773,11 +3800,11 @@ int consumer_data_pending(uint64_t id) break; default: ERR("Unknown consumer data type"); - assert(0); + abort(); } /* Ease our life a bit */ - ht = consumer_data.stream_list_ht; + ht = the_consumer_data.stream_list_ht; cds_lfht_for_each_entry_duplicate(ht->ht, ht->hash_fct(&id, lttng_ht_seed), @@ -3864,13 +3891,13 @@ int consumer_data_pending(uint64_t id) data_not_pending: /* Data is available to be read by a viewer. */ - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); rcu_read_unlock(); return 0; data_pending: /* Data is still being extracted from buffers. */ - pthread_mutex_unlock(&consumer_data.lock); + pthread_mutex_unlock(&the_consumer_data.lock); rcu_read_unlock(); return 1; } @@ -3900,7 +3927,7 @@ int consumer_send_status_channel(int sock, { struct lttcomm_consumer_status_channel msg; - assert(sock >= 0); + LTTNG_ASSERT(sock >= 0); memset(&msg, 0, sizeof(msg)); if (!channel) { @@ -3923,7 +3950,7 @@ unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos, if (!nb_packets_per_stream) { return consumed_pos; /* Grab everything */ } - start_pos = produced_pos - offset_align_floor(produced_pos, max_sb_size); + start_pos = produced_pos - lttng_offset_align_floor(produced_pos, max_sb_size); start_pos -= max_sb_size * nb_packets_per_stream; if ((long) (start_pos - consumed_pos) < 0) { return consumed_pos; /* Grab everything */ @@ -3931,26 +3958,30 @@ unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos, return start_pos; } -static -int consumer_flush_buffer(struct lttng_consumer_stream *stream, int producer_active) +/* Stream lock must be held by the caller. */ +static int sample_stream_positions(struct lttng_consumer_stream *stream, + unsigned long *produced, unsigned long *consumed) { - int ret = 0; + int ret; - switch (consumer_data.type) { - case LTTNG_CONSUMER_KERNEL: - ret = kernctl_buffer_flush(stream->wait_fd); - if (ret < 0) { - ERR("Failed to flush kernel stream"); - goto end; - } - break; - case LTTNG_CONSUMER32_UST: - case LTTNG_CONSUMER64_UST: - lttng_ustctl_flush_buffer(stream, producer_active); - break; - default: - ERR("Unknown consumer_data type"); - abort(); + ASSERT_LOCKED(stream->lock); + + ret = lttng_consumer_sample_snapshot_positions(stream); + if (ret < 0) { + ERR("Failed to sample snapshot positions"); + goto end; + } + + ret = lttng_consumer_get_produced_snapshot(stream, produced); + if (ret < 0) { + ERR("Failed to sample produced position"); + goto end; + } + + ret = lttng_consumer_get_consumed_snapshot(stream, consumed); + if (ret < 0) { + ERR("Failed to sample consumed position"); + goto end; } end: @@ -3973,23 +4004,27 @@ int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel, int ret; struct lttng_consumer_stream *stream; struct lttng_ht_iter iter; - struct lttng_ht *ht = consumer_data.stream_per_chan_id_ht; + struct lttng_ht *ht = the_consumer_data.stream_per_chan_id_ht; struct lttng_dynamic_array stream_rotation_positions; uint64_t next_chunk_id, stream_count = 0; enum lttng_trace_chunk_status chunk_status; const bool is_local_trace = relayd_id == -1ULL; struct consumer_relayd_sock_pair *relayd = NULL; bool rotating_to_new_chunk = true; + /* Array of `struct lttng_consumer_stream *` */ + struct lttng_dynamic_pointer_array streams_packet_to_open; + size_t stream_idx; DBG("Consumer sample rotate position for channel %" PRIu64, key); lttng_dynamic_array_init(&stream_rotation_positions, sizeof(struct relayd_stream_rotation_position), NULL); + lttng_dynamic_pointer_array_init(&streams_packet_to_open, NULL); rcu_read_lock(); pthread_mutex_lock(&channel->lock); - assert(channel->trace_chunk); + LTTNG_ASSERT(channel->trace_chunk); chunk_status = lttng_trace_chunk_get_id(channel->trace_chunk, &next_chunk_id); if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { @@ -4001,7 +4036,7 @@ int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel, ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct, &channel->key, &iter.iter, stream, node_channel_id.node) { - unsigned long consumed_pos; + unsigned long produced_pos = 0, consumed_pos = 0; health_code_update(); @@ -4014,65 +4049,173 @@ int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel, rotating_to_new_chunk = false; } - ret = lttng_consumer_sample_snapshot_positions(stream); - if (ret < 0) { - ERR("Failed to sample snapshot position during channel rotation"); - goto end_unlock_stream; + /* + * Do not flush a packet when rotating from a NULL trace + * chunk. The stream has no means to output data, and the prior + * rotation which rotated to NULL performed that side-effect + * already. No new data can be produced when a stream has no + * associated trace chunk (e.g. a stop followed by a rotate). + */ + if (stream->trace_chunk) { + bool flush_active; + + if (stream->metadata_flag) { + /* + * Don't produce an empty metadata packet, + * simply close the current one. + * + * Metadata is regenerated on every trace chunk + * switch; there is no concern that no data was + * produced. + */ + flush_active = true; + } else { + /* + * Only flush an empty packet if the "packet + * open" could not be performed on transition + * to a new trace chunk and no packets were + * consumed within the chunk's lifetime. + */ + if (stream->opened_packet_in_current_trace_chunk) { + flush_active = true; + } else { + /* + * Stream could have been full at the + * time of rotation, but then have had + * no activity at all. + * + * It is important to flush a packet + * to prevent 0-length files from being + * produced as most viewers choke on + * them. + * + * Unfortunately viewers will not be + * able to know that tracing was active + * for this stream during this trace + * chunk's lifetime. + */ + ret = sample_stream_positions(stream, &produced_pos, &consumed_pos); + if (ret) { + goto end_unlock_stream; + } + + /* + * Don't flush an empty packet if data + * was produced; it will be consumed + * before the rotation completes. + */ + flush_active = produced_pos != consumed_pos; + if (!flush_active) { + const char *trace_chunk_name; + uint64_t trace_chunk_id; + + chunk_status = lttng_trace_chunk_get_name( + stream->trace_chunk, + &trace_chunk_name, + NULL); + if (chunk_status == LTTNG_TRACE_CHUNK_STATUS_NONE) { + trace_chunk_name = "none"; + } + + /* + * Consumer trace chunks are + * never anonymous. + */ + chunk_status = lttng_trace_chunk_get_id( + stream->trace_chunk, + &trace_chunk_id); + LTTNG_ASSERT(chunk_status == + LTTNG_TRACE_CHUNK_STATUS_OK); + + DBG("Unable to open packet for stream during trace chunk's lifetime. " + "Flushing an empty packet to prevent an empty file from being created: " + "stream id = %" PRIu64 ", trace chunk name = `%s`, trace chunk id = %" PRIu64, + stream->key, trace_chunk_name, trace_chunk_id); + } + } + } + + /* + * Close the current packet before sampling the + * ring buffer positions. + */ + ret = consumer_stream_flush_buffer(stream, flush_active); + if (ret < 0) { + ERR("Failed to flush stream %" PRIu64 " during channel rotation", + stream->key); + goto end_unlock_stream; + } } - ret = lttng_consumer_get_produced_snapshot(stream, - &stream->rotate_position); - if (ret < 0) { - ERR("Failed to sample produced position during channel rotation"); + ret = lttng_consumer_take_snapshot(stream); + if (ret < 0 && ret != -ENODATA && ret != -EAGAIN) { + ERR("Failed to sample snapshot position during channel rotation"); goto end_unlock_stream; } + if (!ret) { + ret = lttng_consumer_get_produced_snapshot(stream, + &produced_pos); + if (ret < 0) { + ERR("Failed to sample produced position during channel rotation"); + goto end_unlock_stream; + } - lttng_consumer_get_consumed_snapshot(stream, - &consumed_pos); - if (consumed_pos == stream->rotate_position) { + ret = lttng_consumer_get_consumed_snapshot(stream, + &consumed_pos); + if (ret < 0) { + ERR("Failed to sample consumed position during channel rotation"); + goto end_unlock_stream; + } + } + /* + * Align produced position on the start-of-packet boundary of the first + * packet going into the next trace chunk. + */ + produced_pos = lttng_align_floor(produced_pos, stream->max_sb_size); + if (consumed_pos == produced_pos) { + DBG("Set rotate ready for stream %" PRIu64 " produced = %lu consumed = %lu", + stream->key, produced_pos, consumed_pos); stream->rotate_ready = true; + } else { + DBG("Different consumed and produced positions " + "for stream %" PRIu64 " produced = %lu consumed = %lu", + stream->key, produced_pos, consumed_pos); } - /* - * Active flush; has no effect if the production position - * is at a packet boundary. + * The rotation position is based on the packet_seq_num of the + * packet following the last packet that was consumed for this + * stream, incremented by the offset between produced and + * consumed positions. This rotation position is a lower bound + * (inclusive) at which the next trace chunk starts. Since it + * is a lower bound, it is OK if the packet_seq_num does not + * correspond exactly to the same packet identified by the + * consumed_pos, which can happen in overwrite mode. */ - ret = consumer_flush_buffer(stream, 1); - if (ret < 0) { - ERR("Failed to flush stream %" PRIu64 " during channel rotation", + if (stream->sequence_number_unavailable) { + /* + * Rotation should never be performed on a session which + * interacts with a pre-2.8 lttng-modules, which does + * not implement packet sequence number. + */ + ERR("Failure to rotate stream %" PRIu64 ": sequence number unavailable", stream->key); + ret = -1; goto end_unlock_stream; } + stream->rotate_position = stream->last_sequence_number + 1 + + ((produced_pos - consumed_pos) / stream->max_sb_size); + DBG("Set rotation position for stream %" PRIu64 " at position %" PRIu64, + stream->key, stream->rotate_position); if (!is_local_trace) { /* * The relay daemon control protocol expects a rotation * position as "the sequence number of the first packet - * _after_ the current trace chunk. - * - * At the moment when the positions of the buffers are - * sampled, the production position does not necessarily - * sit at a packet boundary. The 'active' flush - * operation above will push the production position to - * the next packet boundary _if_ it is not already - * sitting at such a boundary. - * - * Assuming a current production position that is not - * on the bound of a packet, the 'target' sequence - * number is - * (consumed_pos / subbuffer_size) + 1 - * Note the '+ 1' to ensure the current packet is - * part of the current trace chunk. - * - * However, if the production position is already at - * a packet boundary, the '+ 1' is not necessary as the - * last packet of the current chunk is already - * 'complete'. + * _after_ the current trace chunk". */ const struct relayd_stream_rotation_position position = { .stream_id = stream->relayd_stream_id, - .rotate_at_seq_num = (stream->rotate_position / stream->max_sb_size) + - !!(stream->rotate_position % stream->max_sb_size), + .rotate_at_seq_num = stream->rotate_position, }; ret = lttng_dynamic_array_add_element( @@ -4084,36 +4227,135 @@ int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel, } stream_count++; } + + stream->opened_packet_in_current_trace_chunk = false; + + if (rotating_to_new_chunk && !stream->metadata_flag) { + /* + * Attempt to flush an empty packet as close to the + * rotation point as possible. In the event where a + * stream remains inactive after the rotation point, + * this ensures that the new trace chunk has a + * beginning timestamp set at the begining of the + * trace chunk instead of only creating an empty + * packet when the trace chunk is stopped. + * + * This indicates to the viewers that the stream + * was being recorded, but more importantly it + * allows viewers to determine a useable trace + * intersection. + * + * This presents a problem in the case where the + * ring-buffer is completely full. + * + * Consider the following scenario: + * - The consumption of data is slow (slow network, + * for instance), + * - The ring buffer is full, + * - A rotation is initiated, + * - The flush below does nothing (no space left to + * open a new packet), + * - The other streams rotate very soon, and new + * data is produced in the new chunk, + * - This stream completes its rotation long after the + * rotation was initiated + * - The session is stopped before any event can be + * produced in this stream's buffers. + * + * The resulting trace chunk will have a single packet + * temporaly at the end of the trace chunk for this + * stream making the stream intersection more narrow + * than it should be. + * + * To work-around this, an empty flush is performed + * after the first consumption of a packet during a + * rotation if open_packet fails. The idea is that + * consuming a packet frees enough space to switch + * packets in this scenario and allows the tracer to + * "stamp" the beginning of the new trace chunk at the + * earliest possible point. + * + * The packet open is performed after the channel + * rotation to ensure that no attempt to open a packet + * is performed in a stream that has no active trace + * chunk. + */ + ret = lttng_dynamic_pointer_array_add_pointer( + &streams_packet_to_open, stream); + if (ret) { + PERROR("Failed to add a stream pointer to array of streams in which to open a packet"); + ret = -1; + goto end_unlock_stream; + } + } + pthread_mutex_unlock(&stream->lock); } stream = NULL; - pthread_mutex_unlock(&channel->lock); - if (is_local_trace) { - ret = 0; - goto end; - } + if (!is_local_trace) { + relayd = consumer_find_relayd(relayd_id); + if (!relayd) { + ERR("Failed to find relayd %" PRIu64, relayd_id); + ret = -1; + goto end_unlock_channel; + } - relayd = consumer_find_relayd(relayd_id); - if (!relayd) { - ERR("Failed to find relayd %" PRIu64, relayd_id); - ret = -1; - goto end; + pthread_mutex_lock(&relayd->ctrl_sock_mutex); + ret = relayd_rotate_streams(&relayd->control_sock, stream_count, + rotating_to_new_chunk ? &next_chunk_id : NULL, + (const struct relayd_stream_rotation_position *) + stream_rotation_positions.buffer + .data); + pthread_mutex_unlock(&relayd->ctrl_sock_mutex); + if (ret < 0) { + ERR("Relayd rotate stream failed. Cleaning up relayd %" PRIu64, + relayd->net_seq_idx); + lttng_consumer_cleanup_relayd(relayd); + goto end_unlock_channel; + } } - pthread_mutex_lock(&relayd->ctrl_sock_mutex); - ret = relayd_rotate_streams(&relayd->control_sock, stream_count, - rotating_to_new_chunk ? &next_chunk_id : NULL, - (const struct relayd_stream_rotation_position *) - stream_rotation_positions.buffer.data); - pthread_mutex_unlock(&relayd->ctrl_sock_mutex); - if (ret < 0) { - ERR("Relayd rotate stream failed. Cleaning up relayd %" PRIu64, - relayd->net_seq_idx); - lttng_consumer_cleanup_relayd(relayd); - goto end; + for (stream_idx = 0; + stream_idx < lttng_dynamic_pointer_array_get_count( + &streams_packet_to_open); + stream_idx++) { + enum consumer_stream_open_packet_status status; + + stream = lttng_dynamic_pointer_array_get_pointer( + &streams_packet_to_open, stream_idx); + + pthread_mutex_lock(&stream->lock); + status = consumer_stream_open_packet(stream); + pthread_mutex_unlock(&stream->lock); + switch (status) { + case CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED: + DBG("Opened a packet after a rotation: stream id = %" PRIu64 + ", channel name = %s, session id = %" PRIu64, + stream->key, stream->chan->name, + stream->chan->session_id); + break; + case CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE: + /* + * Can't open a packet as there is no space left + * in the buffer. A new packet will be opened + * once one has been consumed. + */ + DBG("No space left to open a packet after a rotation: stream id = %" PRIu64 + ", channel name = %s, session id = %" PRIu64, + stream->key, stream->chan->name, + stream->chan->session_id); + break; + case CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR: + /* Logged by callee. */ + ret = -1; + goto end_unlock_channel; + default: + abort(); + } } + pthread_mutex_unlock(&channel->lock); ret = 0; goto end; @@ -4124,63 +4366,180 @@ end_unlock_channel: end: rcu_read_unlock(); lttng_dynamic_array_reset(&stream_rotation_positions); + lttng_dynamic_pointer_array_reset(&streams_packet_to_open); return ret; } -/* - * Check if a stream is ready to be rotated after extracting it. - * - * Return 1 if it is ready for rotation, 0 if it is not, a negative value on - * error. Stream lock must be held. - */ -int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream) +static +int consumer_clear_buffer(struct lttng_consumer_stream *stream) { - int ret; - unsigned long consumed_pos; + int ret = 0; + unsigned long consumed_pos_before, consumed_pos_after; - if (!stream->rotate_position && !stream->rotate_ready) { - ret = 0; + ret = lttng_consumer_sample_snapshot_positions(stream); + if (ret < 0) { + ERR("Taking snapshot positions"); goto end; } - if (stream->rotate_ready) { - ret = 1; + ret = lttng_consumer_get_consumed_snapshot(stream, &consumed_pos_before); + if (ret < 0) { + ERR("Consumed snapshot position"); goto end; } - /* - * If we don't have the rotate_ready flag, check the consumed position - * to determine if we need to rotate. - */ + switch (the_consumer_data.type) { + case LTTNG_CONSUMER_KERNEL: + ret = kernctl_buffer_clear(stream->wait_fd); + if (ret < 0) { + ERR("Failed to clear kernel stream (ret = %d)", ret); + goto end; + } + break; + case LTTNG_CONSUMER32_UST: + case LTTNG_CONSUMER64_UST: + ret = lttng_ustconsumer_clear_buffer(stream); + if (ret < 0) { + ERR("Failed to clear ust stream (ret = %d)", ret); + goto end; + } + break; + default: + ERR("Unknown consumer_data type"); + abort(); + } + ret = lttng_consumer_sample_snapshot_positions(stream); if (ret < 0) { ERR("Taking snapshot positions"); goto end; } - - ret = lttng_consumer_get_consumed_snapshot(stream, &consumed_pos); + ret = lttng_consumer_get_consumed_snapshot(stream, &consumed_pos_after); if (ret < 0) { ERR("Consumed snapshot position"); goto end; } + DBG("clear: before: %lu after: %lu", consumed_pos_before, consumed_pos_after); +end: + return ret; +} - /* Rotate position not reached yet (with check for overflow). */ - if ((long) (consumed_pos - stream->rotate_position) < 0) { - ret = 0; - goto end; +static +int consumer_clear_stream(struct lttng_consumer_stream *stream) +{ + int ret; + + ret = consumer_stream_flush_buffer(stream, 1); + if (ret < 0) { + ERR("Failed to flush stream %" PRIu64 " during channel clear", + stream->key); + ret = LTTCOMM_CONSUMERD_FATAL; + goto error; } - ret = 1; -end: + ret = consumer_clear_buffer(stream); + if (ret < 0) { + ERR("Failed to clear stream %" PRIu64 " during channel clear", + stream->key); + ret = LTTCOMM_CONSUMERD_FATAL; + goto error; + } + + ret = LTTCOMM_CONSUMERD_SUCCESS; +error: + return ret; +} + +static +int consumer_clear_unmonitored_channel(struct lttng_consumer_channel *channel) +{ + int ret; + struct lttng_consumer_stream *stream; + + rcu_read_lock(); + pthread_mutex_lock(&channel->lock); + cds_list_for_each_entry(stream, &channel->streams.head, send_node) { + health_code_update(); + pthread_mutex_lock(&stream->lock); + ret = consumer_clear_stream(stream); + if (ret) { + goto error_unlock; + } + pthread_mutex_unlock(&stream->lock); + } + pthread_mutex_unlock(&channel->lock); + rcu_read_unlock(); + return 0; + +error_unlock: + pthread_mutex_unlock(&stream->lock); + pthread_mutex_unlock(&channel->lock); + rcu_read_unlock(); return ret; } +/* + * Check if a stream is ready to be rotated after extracting it. + * + * Return 1 if it is ready for rotation, 0 if it is not, a negative value on + * error. Stream lock must be held. + */ +int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream) +{ + DBG("Check is rotate ready for stream %" PRIu64 + " ready %u rotate_position %" PRIu64 + " last_sequence_number %" PRIu64, + stream->key, stream->rotate_ready, + stream->rotate_position, stream->last_sequence_number); + if (stream->rotate_ready) { + return 1; + } + + /* + * If packet seq num is unavailable, it means we are interacting + * with a pre-2.8 lttng-modules which does not implement the + * sequence number. Rotation should never be used by sessiond in this + * scenario. + */ + if (stream->sequence_number_unavailable) { + ERR("Internal error: rotation used on stream %" PRIu64 + " with unavailable sequence number", + stream->key); + return -1; + } + + if (stream->rotate_position == -1ULL || + stream->last_sequence_number == -1ULL) { + return 0; + } + + /* + * Rotate position not reached yet. The stream rotate position is + * the position of the next packet belonging to the next trace chunk, + * but consumerd considers rotation ready when reaching the last + * packet of the current chunk, hence the "rotate_position - 1". + */ + + DBG("Check is rotate ready for stream %" PRIu64 + " last_sequence_number %" PRIu64 + " rotate_position %" PRIu64, + stream->key, stream->last_sequence_number, + stream->rotate_position); + if (stream->last_sequence_number >= stream->rotate_position - 1) { + return 1; + } + + return 0; +} + /* * Reset the state for a stream after a rotation occurred. */ void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream) { - stream->rotate_position = 0; + DBG("lttng_consumer_reset_stream_rotate_state for stream %" PRIu64, + stream->key); + stream->rotate_position = -1ULL; stream->rotate_ready = false; } @@ -4313,7 +4672,7 @@ int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel, int ret; struct lttng_consumer_stream *stream; struct lttng_ht_iter iter; - struct lttng_ht *ht = consumer_data.stream_per_chan_id_ht; + struct lttng_ht *ht = the_consumer_data.stream_per_chan_id_ht; rcu_read_lock(); @@ -4399,10 +4758,10 @@ enum lttcomm_return_code lttng_consumer_create_trace_chunk( } else { relayd_id_str = "(formatting error)"; } - } + } - /* Local protocol error. */ - assert(chunk_creation_timestamp); + /* Local protocol error. */ + LTTNG_ASSERT(chunk_creation_timestamp); ret = time_to_iso8601_str(chunk_creation_timestamp, creation_timestamp_buffer, sizeof(creation_timestamp_buffer)); @@ -4432,7 +4791,7 @@ enum lttcomm_return_code lttng_consumer_create_trace_chunk( * and LTTNG_CONSUMER_DESTROY_TRACE_CHUNK commands. */ created_chunk = lttng_trace_chunk_create(chunk_id, - chunk_creation_timestamp); + chunk_creation_timestamp, NULL); if (!created_chunk) { ERR("Failed to create trace chunk"); ret_code = LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED; @@ -4462,6 +4821,7 @@ enum lttcomm_return_code lttng_consumer_create_trace_chunk( */ chunk_status = lttng_trace_chunk_set_as_user(created_chunk, chunk_directory_handle); + chunk_directory_handle = NULL; if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { ERR("Failed to set trace chunk's directory handle"); ret_code = LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED; @@ -4470,7 +4830,7 @@ enum lttcomm_return_code lttng_consumer_create_trace_chunk( } published_chunk = lttng_trace_chunk_registry_publish_chunk( - consumer_data.chunk_registry, session_id, + the_consumer_data.chunk_registry, session_id, created_chunk); lttng_trace_chunk_put(created_chunk); created_chunk = NULL; @@ -4481,10 +4841,11 @@ enum lttcomm_return_code lttng_consumer_create_trace_chunk( } rcu_read_lock(); - cds_lfht_for_each_entry_duplicate(consumer_data.channels_by_session_id_ht->ht, - consumer_data.channels_by_session_id_ht->hash_fct( + cds_lfht_for_each_entry_duplicate( + the_consumer_data.channels_by_session_id_ht->ht, + the_consumer_data.channels_by_session_id_ht->hash_fct( &session_id, lttng_ht_seed), - consumer_data.channels_by_session_id_ht->match_fct, + the_consumer_data.channels_by_session_id_ht->match_fct, &session_id, &iter.iter, channel, channels_by_session_id_ht_node.node) { ret = lttng_consumer_channel_set_trace_chunk(channel, @@ -4597,7 +4958,7 @@ enum lttcomm_return_code lttng_consumer_close_trace_chunk( close_command_name); chunk = lttng_trace_chunk_registry_find_chunk( - consumer_data.chunk_registry, session_id, chunk_id); + the_consumer_data.chunk_registry, session_id, chunk_id); if (!chunk) { ERR("Failed to find chunk: session_id = %" PRIu64 ", chunk_id = %" PRIu64, @@ -4628,7 +4989,7 @@ enum lttcomm_return_code lttng_consumer_close_trace_chunk( * current chunk found in the session's channels. */ rcu_read_lock(); - cds_lfht_for_each_entry(consumer_data.channel_ht->ht, &iter.iter, + cds_lfht_for_each_entry(the_consumer_data.channel_ht->ht, &iter.iter, channel, node.node) { int ret; @@ -4699,8 +5060,6 @@ enum lttcomm_return_code lttng_consumer_trace_chunk_exists( bool chunk_exists_local, chunk_exists_remote; if (relayd_id) { - int ret; - /* Only used for logging purposes. */ ret = snprintf(relayd_id_buffer, sizeof(relayd_id_buffer), "%" PRIu64, *relayd_id); @@ -4709,14 +5068,14 @@ enum lttcomm_return_code lttng_consumer_trace_chunk_exists( } else { relayd_id_str = "(formatting error)"; } - } + } DBG("Consumer trace chunk exists command: relayd_id = %s" ", chunk_id = %" PRIu64, relayd_id_str, chunk_id); ret = lttng_trace_chunk_registry_chunk_exists( - consumer_data.chunk_registry, session_id, - chunk_id, &chunk_exists_local); + the_consumer_data.chunk_registry, session_id, chunk_id, + &chunk_exists_local); if (ret) { /* Internal error. */ ERR("Failed to query the existence of a trace chunk"); @@ -4762,3 +5121,139 @@ end_rcu_unlock: end: return ret_code; } + +static +int consumer_clear_monitored_channel(struct lttng_consumer_channel *channel) +{ + struct lttng_ht *ht; + struct lttng_consumer_stream *stream; + struct lttng_ht_iter iter; + int ret; + + ht = the_consumer_data.stream_per_chan_id_ht; + + rcu_read_lock(); + cds_lfht_for_each_entry_duplicate(ht->ht, + ht->hash_fct(&channel->key, lttng_ht_seed), + ht->match_fct, &channel->key, + &iter.iter, stream, node_channel_id.node) { + /* + * Protect against teardown with mutex. + */ + pthread_mutex_lock(&stream->lock); + if (cds_lfht_is_node_deleted(&stream->node.node)) { + goto next; + } + ret = consumer_clear_stream(stream); + if (ret) { + goto error_unlock; + } + next: + pthread_mutex_unlock(&stream->lock); + } + rcu_read_unlock(); + return LTTCOMM_CONSUMERD_SUCCESS; + +error_unlock: + pthread_mutex_unlock(&stream->lock); + rcu_read_unlock(); + return ret; +} + +int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel) +{ + int ret; + + DBG("Consumer clear channel %" PRIu64, channel->key); + + if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA) { + /* + * Nothing to do for the metadata channel/stream. + * Snapshot mechanism already take care of the metadata + * handling/generation, and monitored channels only need to + * have their data stream cleared.. + */ + ret = LTTCOMM_CONSUMERD_SUCCESS; + goto end; + } + + if (!channel->monitor) { + ret = consumer_clear_unmonitored_channel(channel); + } else { + ret = consumer_clear_monitored_channel(channel); + } +end: + return ret; +} + +enum lttcomm_return_code lttng_consumer_open_channel_packets( + struct lttng_consumer_channel *channel) +{ + struct lttng_consumer_stream *stream; + enum lttcomm_return_code ret = LTTCOMM_CONSUMERD_SUCCESS; + + if (channel->metadata_stream) { + ERR("Open channel packets command attempted on a metadata channel"); + ret = LTTCOMM_CONSUMERD_INVALID_PARAMETERS; + goto end; + } + + rcu_read_lock(); + cds_list_for_each_entry(stream, &channel->streams.head, send_node) { + enum consumer_stream_open_packet_status status; + + pthread_mutex_lock(&stream->lock); + if (cds_lfht_is_node_deleted(&stream->node.node)) { + goto next; + } + + status = consumer_stream_open_packet(stream); + switch (status) { + case CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED: + DBG("Opened a packet in \"open channel packets\" command: stream id = %" PRIu64 + ", channel name = %s, session id = %" PRIu64, + stream->key, stream->chan->name, + stream->chan->session_id); + stream->opened_packet_in_current_trace_chunk = true; + break; + case CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE: + DBG("No space left to open a packet in \"open channel packets\" command: stream id = %" PRIu64 + ", channel name = %s, session id = %" PRIu64, + stream->key, stream->chan->name, + stream->chan->session_id); + break; + case CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR: + /* + * Only unexpected internal errors can lead to this + * failing. Report an unknown error. + */ + ERR("Failed to flush empty buffer in \"open channel packets\" command: stream id = %" PRIu64 + ", channel id = %" PRIu64 + ", channel name = %s" + ", session id = %" PRIu64, + stream->key, channel->key, + channel->name, channel->session_id); + ret = LTTCOMM_CONSUMERD_UNKNOWN_ERROR; + goto error_unlock; + default: + abort(); + } + + next: + pthread_mutex_unlock(&stream->lock); + } + +end_rcu_unlock: + rcu_read_unlock(); +end: + return ret; + +error_unlock: + pthread_mutex_unlock(&stream->lock); + goto end_rcu_unlock; +} + +void lttng_consumer_sigbus_handle(void *addr) +{ + lttng_ustconsumer_sigbus_handle(addr); +}