ctf.fs source: add `get-metadata-info` query info action
[babeltrace.git] / plugins / ctf / fs / fs.c
index 495540b475db7c9894ae2193acd90b5b21269abb..b406ee96deee4e494626c9ad4542a4c9383491b5 100644 (file)
  * SOFTWARE.
  */
 
-#include <babeltrace/plugin/plugin-system.h>
 #include <babeltrace/ctf-ir/packet.h>
-#include <babeltrace/plugin/notification/iterator.h>
-#include <babeltrace/plugin/notification/stream.h>
-#include <babeltrace/plugin/notification/event.h>
-#include <babeltrace/plugin/notification/packet.h>
-#include <babeltrace/plugin/notification/heap.h>
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/component/notification/iterator.h>
+#include <babeltrace/component/notification/stream.h>
+#include <babeltrace/component/notification/event.h>
+#include <babeltrace/component/notification/packet.h>
+#include <babeltrace/component/notification/heap.h>
+#include <plugins-common.h>
 #include <glib.h>
 #include <assert.h>
 #include <unistd.h>
 #define PRINT_ERR_STREAM       ctf_fs->error_fp
 #define PRINT_PREFIX           "ctf-fs"
 #include "print.h"
+#define METADATA_TEXT_SIG      "/* CTF 1.8"
 
-static bool ctf_fs_debug;
+BT_HIDDEN
+bool ctf_fs_debug;
+
+enum bt_notification_iterator_status ctf_fs_iterator_next(
+               struct bt_notification_iterator *iterator);
 
-static
 struct bt_notification *ctf_fs_iterator_get(
                struct bt_notification_iterator *iterator)
 {
        struct ctf_fs_iterator *ctf_it =
                        bt_notification_iterator_get_private_data(iterator);
 
+       if (!ctf_it->current_notification) {
+               (void) ctf_fs_iterator_next(iterator);
+       }
+
        return bt_get(ctf_it->current_notification);
 }
 
@@ -134,11 +143,11 @@ struct bt_ctf_stream *internal_bt_notification_get_stream(
                bt_put(event);
                break;
        }
-       case BT_NOTIFICATION_TYPE_PACKET_START:
+       case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
        {
                struct bt_ctf_packet *packet;
 
-               packet = bt_notification_packet_start_get_packet(notification);
+               packet = bt_notification_packet_begin_get_packet(notification);
                stream = bt_ctf_packet_get_stream(packet);
                bt_put(packet);
                break;
@@ -236,12 +245,11 @@ end:
        return ret;
 }
 
-static
 enum bt_notification_iterator_status ctf_fs_iterator_next(
                struct bt_notification_iterator *iterator)
 {
        int heap_ret;
-       struct bt_ctf_stream *stream;
+       struct bt_ctf_stream *stream = NULL;
        struct ctf_fs_stream *fs_stream;
        struct bt_notification *notification;
        struct bt_notification *next_stream_notification;
@@ -336,12 +344,16 @@ enum bt_notification_iterator_status ctf_fs_iterator_next(
         */
 end:
        BT_MOVE(ctf_it->current_notification, notification);
+       bt_put(stream);
        return ret;
 }
 
 static
 void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
 {
+       if (!ctf_it) {
+               return;
+       }
        bt_put(ctf_it->current_notification);
        bt_put(ctf_it->pending_notifications);
        if (ctf_it->pending_streams) {
@@ -353,7 +365,6 @@ void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
        g_free(ctf_it);
 }
 
-static
 void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
 {
        void *data = bt_notification_iterator_get_private_data(it);
@@ -361,10 +372,124 @@ void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
        ctf_fs_iterator_destroy_data(data);
 }
 
+static
+bool compare_event_notifications(struct bt_notification *a,
+               struct bt_notification *b)
+{
+       int ret;
+       struct bt_ctf_clock_class *clock_class;
+       struct bt_ctf_clock_value *a_clock_value, *b_clock_value;
+       struct bt_ctf_stream_class *a_stream_class;
+       struct bt_ctf_stream *a_stream;
+       struct bt_ctf_event *a_event, *b_event;
+       struct bt_ctf_trace *trace;
+       int64_t a_ts, b_ts;
+
+       // FIXME - assumes only one clock
+       a_event = bt_notification_event_get_event(a);
+       b_event = bt_notification_event_get_event(b);
+       assert(a_event);
+       assert(b_event);
+
+       a_stream = bt_ctf_event_get_stream(a_event);
+       assert(a_stream);
+       a_stream_class = bt_ctf_stream_get_class(a_stream);
+       assert(a_stream_class);
+       trace = bt_ctf_stream_class_get_trace(a_stream_class);
+       assert(trace);
+
+       clock_class = bt_ctf_trace_get_clock_class(trace, 0);
+       a_clock_value = bt_ctf_event_get_clock_value(a_event, clock_class);
+       b_clock_value = bt_ctf_event_get_clock_value(b_event, clock_class);
+       assert(a_clock_value);
+       assert(b_clock_value);
+
+       ret = bt_ctf_clock_value_get_value_ns_from_epoch(a_clock_value, &a_ts);
+       assert(!ret);
+       ret = bt_ctf_clock_value_get_value_ns_from_epoch(b_clock_value, &b_ts);
+       assert(!ret);
+
+       bt_put(a_event);
+       bt_put(b_event);
+       bt_put(a_clock_value);
+       bt_put(b_clock_value);
+       bt_put(a_stream);
+       bt_put(a_stream_class);
+       bt_put(clock_class);
+       bt_put(trace);
+       return a_ts < b_ts;
+}
+
 static
 bool compare_notifications(struct bt_notification *a, struct bt_notification *b,
                void *unused)
 {
+       static int notification_priorities[] = {
+               [BT_NOTIFICATION_TYPE_NEW_TRACE] = 0,
+               [BT_NOTIFICATION_TYPE_NEW_STREAM_CLASS] = 1,
+               [BT_NOTIFICATION_TYPE_NEW_EVENT_CLASS] = 2,
+               [BT_NOTIFICATION_TYPE_PACKET_BEGIN] = 3,
+               [BT_NOTIFICATION_TYPE_PACKET_END] = 4,
+               [BT_NOTIFICATION_TYPE_EVENT] = 5,
+               [BT_NOTIFICATION_TYPE_END_OF_TRACE] = 6,
+       };
+       int a_prio, b_prio;
+       enum bt_notification_type a_type, b_type;
+
+       assert(a && b);
+       a_type = bt_notification_get_type(a);
+       b_type = bt_notification_get_type(b);
+       assert(a_type > BT_NOTIFICATION_TYPE_ALL);
+       assert(a_type < BT_NOTIFICATION_TYPE_NR);
+       assert(b_type > BT_NOTIFICATION_TYPE_ALL);
+       assert(b_type < BT_NOTIFICATION_TYPE_NR);
+
+       a_prio = notification_priorities[a_type];
+       b_prio = notification_priorities[b_type];
+
+       if (likely((a_type == b_type) && a_type == BT_NOTIFICATION_TYPE_EVENT)) {
+               return compare_event_notifications(a, b);
+       }
+
+       if (unlikely(a_prio != b_prio)) {
+               return a_prio < b_prio;
+       }
+
+       /* Notification types are equal, but not of type "event". */
+       switch (a_type) {
+       case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
+       case BT_NOTIFICATION_TYPE_PACKET_END:
+       case BT_NOTIFICATION_TYPE_STREAM_END:
+       {
+               int64_t a_sc_id, b_sc_id;
+               struct bt_ctf_stream *a_stream, *b_stream;
+               struct bt_ctf_stream_class *a_sc, *b_sc;
+
+               a_stream = internal_bt_notification_get_stream(a);
+               b_stream = internal_bt_notification_get_stream(b);
+               assert(a_stream && b_stream);
+
+               a_sc = bt_ctf_stream_get_class(a_stream);
+               b_sc = bt_ctf_stream_get_class(b_stream);
+               assert(a_sc && b_sc);
+
+               a_sc_id = bt_ctf_stream_class_get_id(a_sc);
+               b_sc_id = bt_ctf_stream_class_get_id(b_sc);
+               assert(a_sc_id >= 0 && b_sc_id >= 0);
+               bt_put(a_sc);
+               bt_put(a_stream);
+               bt_put(b_sc);
+               bt_put(b_stream);
+               return a_sc_id < b_sc_id;
+       }
+       case BT_NOTIFICATION_TYPE_NEW_TRACE:
+       case BT_NOTIFICATION_TYPE_END_OF_TRACE:
+               /* Impossible to have two separate traces. */
+       default:
+               assert(0);
+       }
+
+       assert(0);
        return a < b;
 }
 
@@ -429,6 +554,12 @@ int open_trace_streams(struct ctf_fs_component *ctf_fs,
                        goto error;
                }
 
+               if (file->size == 0) {
+                       /* Skip empty stream. */
+                       ctf_fs_file_destroy(file);
+                       continue;
+               }
+
                /* Create a private stream; file ownership is passed to it. */
                stream = ctf_fs_stream_create(ctf_fs, file);
                if (!stream) {
@@ -453,25 +584,25 @@ end:
        return ret;
 }
 
-static
-enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
-               struct bt_notification_iterator *it)
+enum bt_notification_iterator_status ctf_fs_iterator_init(struct bt_component *source,
+               struct bt_notification_iterator *it,
+               UNUSED_VAR void *init_method_data)
 {
        struct ctf_fs_iterator *ctf_it;
        struct ctf_fs_component *ctf_fs;
-       enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       enum bt_notification_iterator_status ret = BT_NOTIFICATION_ITERATOR_STATUS_OK;
 
        assert(source && it);
 
        ctf_fs = bt_component_get_private_data(source);
        if (!ctf_fs) {
-               ret = BT_COMPONENT_STATUS_INVALID;
+               ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
                goto end;
        }
 
        ctf_it = g_new0(struct ctf_fs_iterator, 1);
        if (!ctf_it) {
-               ret = BT_COMPONENT_STATUS_NOMEM;
+               ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
                goto end;
        }
 
@@ -496,26 +627,11 @@ enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
                goto error;
        }
 
-       ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
-       if (ret) {
-               goto error;
-       }
-
-       ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
-       if (ret) {
-               goto error;
-       }
-
-       ret = bt_notification_iterator_set_destroy_cb(it,
-                       ctf_fs_iterator_destroy);
-       if (ret) {
-               goto error;
-       }
-
        ret = bt_notification_iterator_set_private_data(it, ctf_it);
        if (ret) {
                goto error;
        }
+
 end:
        return ret;
 error:
@@ -527,6 +643,9 @@ error:
 static
 void ctf_fs_destroy_data(struct ctf_fs_component *ctf_fs)
 {
+       if (!ctf_fs) {
+               return;
+       }
        if (ctf_fs->trace_path) {
                g_string_free(ctf_fs->trace_path, TRUE);
        }
@@ -537,7 +656,6 @@ void ctf_fs_destroy_data(struct ctf_fs_component *ctf_fs)
        g_free(ctf_fs);
 }
 
-static
 void ctf_fs_destroy(struct bt_component *component)
 {
        void *data = bt_component_get_private_data(component);
@@ -594,7 +712,7 @@ end:
 
 BT_HIDDEN
 enum bt_component_status ctf_fs_init(struct bt_component *source,
-               struct bt_value *params)
+               struct bt_value *params, UNUSED_VAR void *init_method_data)
 {
        struct ctf_fs_component *ctf_fs;
        enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
@@ -607,21 +725,10 @@ enum bt_component_status ctf_fs_init(struct bt_component *source,
                goto end;
        }
 
-       ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto error;
-       }
-
        ret = bt_component_set_private_data(source, ctf_fs);
        if (ret != BT_COMPONENT_STATUS_OK) {
                goto error;
        }
-
-       ret = bt_component_source_set_iterator_init_cb(source,
-                       ctf_fs_iterator_init);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto error;
-       }
 end:
        return ret;
 error:
@@ -629,3 +736,129 @@ error:
         ctf_fs_destroy_data(ctf_fs);
        return ret;
 }
+
+BT_HIDDEN
+struct bt_value *ctf_fs_query_info(struct bt_component_class *comp_class,
+               const char *action, struct bt_value *params)
+{
+       struct bt_value *results = NULL;
+       struct bt_value *path_value = NULL;
+       char *metadata_text = NULL;
+       FILE *metadata_fp = NULL;
+       GString *g_metadata_text = NULL;
+
+       if (strcmp(action, "get-metadata-info") == 0) {
+               int ret;
+               int bo;
+               const char *path;
+               bool is_packetized;
+
+               results = bt_value_map_create();
+               if (!results) {
+                       goto error;
+               }
+
+               if (!bt_value_is_map(params)) {
+                       fprintf(stderr,
+                               "Query info parameters is not a map value object\n");
+                       goto error;
+               }
+
+               path_value = bt_value_map_get(params, "path");
+               ret = bt_value_string_get(path_value, &path);
+               if (ret) {
+                       fprintf(stderr,
+                               "Cannot get `path` string parameter\n");
+                       goto error;
+               }
+
+               assert(path);
+               metadata_fp = ctf_fs_metadata_open_file(path);
+               if (!metadata_fp) {
+                       fprintf(stderr,
+                               "Cannot open trace at path `%s`\n", path);
+                       goto error;
+               }
+
+               is_packetized = ctf_metadata_is_packetized(metadata_fp, &bo);
+
+               if (is_packetized) {
+                       ret = ctf_metadata_packetized_file_to_buf(NULL,
+                               metadata_fp, (uint8_t **) &metadata_text, bo);
+                       if (ret) {
+                               fprintf(stderr,
+                                       "Cannot decode packetized metadata file\n");
+                               goto error;
+                       }
+               } else {
+                       long filesize;
+
+                       fseek(metadata_fp, 0, SEEK_END);
+                       filesize = ftell(metadata_fp);
+                       rewind(metadata_fp);
+                       metadata_text = malloc(filesize + 1);
+                       if (!metadata_text) {
+                               fprintf(stderr,
+                                       "Cannot allocate buffer for metadata text\n");
+                               goto error;
+                       }
+
+                       if (fread(metadata_text, filesize, 1, metadata_fp) !=
+                                       1) {
+                               fprintf(stderr,
+                                       "Cannot read metadata file\n");
+                               goto error;
+                       }
+
+                       metadata_text[filesize] = '\0';
+               }
+
+               g_metadata_text = g_string_new(NULL);
+               if (!g_metadata_text) {
+                       goto error;
+               }
+
+               if (strncmp(metadata_text, METADATA_TEXT_SIG,
+                               sizeof(METADATA_TEXT_SIG) - 1) != 0) {
+                       g_string_assign(g_metadata_text, METADATA_TEXT_SIG);
+                       g_string_append(g_metadata_text, " */\n\n");
+               }
+
+               g_string_append(g_metadata_text, metadata_text);
+
+               ret = bt_value_map_insert_string(results, "text",
+                       g_metadata_text->str);
+               if (ret) {
+                       fprintf(stderr, "Cannot insert metadata text into results\n");
+                       goto error;
+               }
+
+               ret = bt_value_map_insert_bool(results, "is-packetized",
+                       is_packetized);
+               if (ret) {
+                       fprintf(stderr, "Cannot insert is packetized into results\n");
+                       goto error;
+               }
+       } else {
+               fprintf(stderr, "Unknown query info action `%s`\n", action);
+               goto error;
+       }
+
+       goto end;
+
+error:
+       BT_PUT(results);
+
+end:
+       bt_put(path_value);
+       free(metadata_text);
+
+       if (g_metadata_text) {
+               g_string_free(g_metadata_text, TRUE);
+       }
+
+       if (metadata_fp) {
+               fclose(metadata_fp);
+       }
+       return results;
+}
This page took 0.029108 seconds and 4 git commands to generate.