src.ctf.lttng-live: make component class handle interruptions
[babeltrace.git] / src / plugins / ctf / lttng-live / metadata.c
index f77d62f8baf74d1ce049b1e35cb201b10563f03a..7a7a0d8a445c59815ba85e8a540c33b447a48819 100644 (file)
@@ -76,7 +76,8 @@ bool stream_classes_all_have_default_clock_class(bt_trace_class *tc,
                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));
@@ -120,15 +121,16 @@ enum lttng_live_iterator_status lttng_live_metadata_update(
 {
        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;
 
        /* No metadata stream yet. */
        if (!metadata) {
@@ -149,53 +151,73 @@ enum lttng_live_iterator_status lttng_live_metadata_update(
                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;
+               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:
+                       keep_receiving = false;
+                       break;
+               case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR:
+                       goto error;
+               default:
+                       bt_common_abort();
                }
-       } while (ret > 0);
+       }
 
        /*
-        * Consider metadata closed as soon as we get an error reading
-        * it (e.g. cannot be found).
+        * A closed metadata stream means the trace is no longer active. Return
+        * _END so that the caller can remove the trace from its list.
         */
-       if (ret < 0) {
-               if (!metadata->closed) {
-                       metadata->closed = true;
-                       /*
-                        * 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.
-                        */
-                       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;
-                       }
-               }
+       if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) {
+               status = LTTNG_LIVE_ITERATOR_STATUS_END;
+               goto end;
        }
 
+       /* 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_LOGE_APPEND_CAUSE_ERRNO(self_comp,
+                       "Metadata bt_close_memstream", ".");
        }
 
        fp = NULL;
@@ -209,11 +231,22 @@ enum lttng_live_iterator_status lttng_live_metadata_update(
                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;
        }
 
        /*
@@ -234,10 +267,14 @@ enum lttng_live_iterator_status lttng_live_metadata_update(
                                                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(
@@ -260,6 +297,7 @@ enum lttng_live_iterator_status lttng_live_metadata_update(
        }
 
        goto end;
+
 error:
        status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 end:
@@ -268,7 +306,8 @@ end:
 
                closeret = fclose(fp);
                if (closeret) {
-                       BT_COMP_LOGE("Error on fclose");
+                       BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
+                               "Error on fclose", ".");
                }
        }
        free(metadata_buf);
@@ -280,6 +319,8 @@ int lttng_live_metadata_create_stream(struct lttng_live_session *session,
                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 = {
@@ -300,10 +341,14 @@ int lttng_live_metadata_create_stream(struct lttng_live_session *session,
 
        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);
        if (!trace) {
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                       "Failed to borrow trace");
                goto error;
        }
        metadata->trace = trace;
This page took 0.026911 seconds and 4 git commands to generate.