/*
- * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com>
- * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
- * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
+ * SPDX-License-Identifier: MIT
*
- * Some functions are based on older functions written by Mathieu Desnoyers.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
+ * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
*/
#define BT_COMP_LOG_SELF_COMP self_comp
cc = bt_stream_class_borrow_default_clock_class_const(sc);
if (!cc) {
ret = false;
- BT_COMP_LOGE("Stream class doesn't have a default clock class: "
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Stream class doesn't have a default clock class: "
"sc-id=%" PRIu64 ", sc-name=\"%s\"",
bt_stream_class_get_id(sc),
bt_stream_class_get_name(sc));
sc_count = bt_trace_class_get_stream_class_count(tc);
for (i = 0; i < sc_count; i++) {
sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
- BT_ASSERT(sc);
+ BT_ASSERT_DBG(sc);
cc = bt_stream_class_borrow_default_clock_class_const(sc);
if (cc) {
}
}
end:
- BT_ASSERT(cc);
+ BT_ASSERT_DBG(cc);
return cc;
}
{
struct lttng_live_session *session = trace->session;
struct lttng_live_metadata *metadata = trace->metadata;
- ssize_t ret = 0;
size_t size, len_read = 0;
char *metadata_buf = NULL;
+ bool keep_receiving;
FILE *fp = NULL;
enum ctf_metadata_decoder_status decoder_status;
enum lttng_live_iterator_status status =
LTTNG_LIVE_ITERATOR_STATUS_OK;
bt_logging_level log_level = trace->log_level;
bt_self_component *self_comp = trace->self_comp;
+ enum lttng_live_get_one_metadata_status metadata_status;
+
+ BT_COMP_LOGD("Updating metadata for trace: trace-id=%"PRIu64, trace->id);
/* No metadata stream yet. */
if (!metadata) {
goto end;
}
- if (!metadata->trace) {
- trace->new_metadata_needed = false;
- }
-
- if (!trace->new_metadata_needed) {
+ if (trace->metadata_stream_state != LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) {
goto end;
}
- /* Open for writing */
+ /*
+ * Open a new write only file handle to populate the `metadata_buf`
+ * memory buffer so we can write in loop in it easily.
+ */
fp = bt_open_memstream(&metadata_buf, &size);
if (!fp) {
- BT_COMP_LOGE("Metadata open_memstream: %s", strerror(errno));
- goto error;
+ if (errno == EINTR &&
+ lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
+ session->lttng_live_msg_iter->was_interrupted = true;
+ status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
+ } else {
+ BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
+ "Metadata open_memstream", ".");
+ status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
+ }
+ goto end;
}
+ keep_receiving = true;
/* Grab all available metadata. */
- do {
+ while (keep_receiving) {
+ size_t reply_len = 0;
/*
- * get_one_metadata_packet returns the number of bytes
- * received, 0 when we have received everything, a
- * negative value on error.
+ * lttng_live_get_one_metadata_packet() asks the Relay Daemon
+ * for new metadata. If new metadata is received, the function
+ * writes it to the provided file handle and updates the
+ * reply_len output parameter. We call this function in loop
+ * until it returns _END meaning that no new metadata is
+ * available.
+ * We may receive a _CLOSED status if the metadata stream we
+ * are requesting is no longer available on the relay.
+ * If we receive an _ERROR status, it means there was a
+ * networking, allocating, or some other unrecoverable error.
*/
- ret = lttng_live_get_one_metadata_packet(trace, fp);
- if (ret > 0) {
- len_read += ret;
- }
- } while (ret > 0);
-
- /*
- * Consider metadata closed as soon as we get an error reading
- * it (e.g. cannot be found).
- */
- if (ret < 0) {
- if (!metadata->closed) {
- metadata->closed = true;
+ metadata_status = lttng_live_get_one_metadata_packet(trace, fp,
+ &reply_len);
+
+ switch (metadata_status) {
+ case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK:
+ len_read += reply_len;
+ break;
+ case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END:
+ keep_receiving = false;
+ break;
+ case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED:
+ BT_COMP_LOGD("Metadata stream was closed by the Relay, the trace is no longer active: "
+ "trace-id=%"PRIu64", metadata-stream-id=%"PRIu64,
+ trace->id, metadata->stream_id);
/*
- * Release our reference on the trace as soon as
- * we know the metadata stream is not available
- * anymore. This won't necessarily teardown the
- * metadata objects immediately, but only when
- * the data streams are done.
+ * The stream was closed and we received everything
+ * there was to receive for this metadata stream.
+ * We go on with the decoding of what we received. So
+ * that data stream can be decoded.
*/
- metadata->trace = NULL;
- }
- if (errno == EINTR) {
- if (lttng_live_graph_is_canceled(
- session->lttng_live_msg_iter)) {
- status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
- goto end;
- }
+ keep_receiving = false;
+ trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED;
+ break;
+ case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR:
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Error getting one trace metadata packet: "
+ "trace-id=%"PRIu64, trace->id);
+ goto error;
+ default:
+ bt_common_abort();
}
}
+ /* The memory buffer `metadata_buf` contains all the metadata. */
if (bt_close_memstream(&metadata_buf, &size, fp)) {
- BT_COMP_LOGE("bt_close_memstream: %s", strerror(errno));
+ BT_COMP_LOGW_ERRNO("Metadata bt_close_memstream", ".");
}
fp = NULL;
status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
goto end;
}
- trace->new_metadata_needed = false;
+
+ /* The relay sent zero bytes of metdata. */
+ trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED;
goto end;
}
+ /*
+ * Open a new reading file handle on the `metadata_buf` and pass it to
+ * the metadata decoder.
+ */
fp = bt_fmemopen(metadata_buf, len_read, "rb");
if (!fp) {
- BT_COMP_LOGE("Cannot memory-open metadata buffer: %s",
- strerror(errno));
- goto error;
+ if (errno == EINTR &&
+ lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
+ session->lttng_live_msg_iter->was_interrupted = true;
+ status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
+ } else {
+ BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
+ "Cannot memory-open metadata buffer", ".");
+ status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
+ }
+ goto end;
}
/*
* The call to ctf_metadata_decoder_append_content() will append
* new metadata to our current trace class.
*/
+ BT_COMP_LOGD("Appending new metadata to the ctf_trace class");
decoder_status = ctf_metadata_decoder_append_content(
metadata->decoder, fp);
switch (decoder_status) {
metadata->decoder);
trace->trace = bt_trace_create(trace->trace_class);
if (!trace->trace) {
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Failed to create bt_trace");
goto error;
}
if (ctf_trace_class_configure_ir_trace(tc,
trace->trace)) {
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Failed to configure ctf trace class");
goto error;
}
if (!stream_classes_all_have_default_clock_class(
trace->clock_class =
borrow_any_clock_class(trace->trace_class);
}
- trace->new_metadata_needed = false;
+
+ /* The metadata was updated succesfully. */
+ trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED;
break;
case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
}
goto end;
+
error:
status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
end:
closeret = fclose(fp);
if (closeret) {
- BT_COMP_LOGE("Error on fclose");
+ BT_COMP_LOGW_ERRNO("Error on fclose", ".");
}
}
free(metadata_buf);
uint64_t ctf_trace_id, uint64_t stream_id,
const char *trace_name)
{
+ bt_self_component *self_comp = session->self_comp;
+ bt_logging_level log_level = session->log_level;
struct lttng_live_metadata *metadata = NULL;
struct lttng_live_trace *trace;
struct ctf_metadata_decoder_config cfg = {
metadata->decoder = ctf_metadata_decoder_create(&cfg);
if (!metadata->decoder) {
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Failed to create CTF metadata decoder");
goto error;
}
- trace = lttng_live_borrow_trace(session, ctf_trace_id);
+ trace = lttng_live_session_borrow_or_create_trace_by_id(session,
+ ctf_trace_id);
if (!trace) {
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ "Failed to borrow trace");
goto error;
}
- metadata->trace = trace;
trace->metadata = metadata;
return 0;
projects / babeltrace.git / blobdiff