Values API: standardize parameters and return values
[babeltrace.git] / plugins / text / dmesg / dmesg.c
index 3bf57ef6a70e73bd42ad8bcad9b4b4521b94e43b..6659fd1edd2be83bb56c325519227e06868b4441 100644 (file)
@@ -29,6 +29,7 @@
 #include <ctype.h>
 #include <stdio.h>
 #include <babeltrace/assert-internal.h>
+#include <babeltrace/common-internal.h>
 #include <babeltrace/babeltrace.h>
 #include <babeltrace/values-internal.h>
 #include <babeltrace/compat/utc-internal.h>
@@ -44,6 +45,7 @@ struct dmesg_component;
 
 struct dmesg_notif_iter {
        struct dmesg_component *dmesg_comp;
+       struct bt_private_connection_private_notification_iterator *pc_notif_iter; /* Weak */
        char *linebuf;
        size_t linebuf_len;
        FILE *fp;
@@ -66,7 +68,6 @@ struct dmesg_component {
                bt_bool no_timestamp;
        } params;
 
-       struct bt_graph *graph; /* Weak */
        struct bt_trace *trace;
        struct bt_stream_class *stream_class;
        struct bt_event_class *event_class;
@@ -77,116 +78,27 @@ struct dmesg_component {
 };
 
 static
-struct bt_field_type *create_packet_header_ft(void)
+struct bt_field_class *create_event_payload_fc(void)
 {
-       struct bt_field_type *root_ft = NULL;
-       struct bt_field_type *ft = NULL;
+       struct bt_field_class *root_fc = NULL;
+       struct bt_field_class *fc = NULL;
        int ret;
 
-       root_ft = bt_field_type_structure_create();
-       if (!root_ft) {
-               BT_LOGE_STR("Cannot create an empty structure field type object.");
+       root_fc = bt_field_class_structure_create();
+       if (!root_fc) {
+               BT_LOGE_STR("Cannot create an empty structure field class object.");
                goto error;
        }
 
-       ft = bt_field_type_integer_create(32);
-       if (!ft) {
-               BT_LOGE_STR("Cannot create an integer field type object.");
+       fc = bt_field_class_string_create();
+       if (!fc) {
+               BT_LOGE_STR("Cannot create a string field class object.");
                goto error;
        }
 
-       ret = bt_field_type_structure_add_field(root_ft, ft, "magic");
+       ret = bt_field_class_structure_append_member(root_fc, "str", fc);
        if (ret) {
-               BT_LOGE("Cannot add `magic` field type to structure field type: "
-                       "ret=%d", ret);
-               goto error;
-       }
-
-       BT_PUT(ft);
-       ft = bt_field_type_integer_create(8);
-       if (!ft) {
-               BT_LOGE_STR("Cannot create an integer field type object.");
-               goto error;
-       }
-
-       goto end;
-
-error:
-       BT_PUT(root_ft);
-
-end:
-       bt_put(ft);
-       return root_ft;
-}
-
-static
-struct bt_field_type *create_event_header_ft(
-               struct bt_clock_class *clock_class)
-{
-       struct bt_field_type *root_ft = NULL;
-       struct bt_field_type *ft = NULL;
-       int ret;
-
-       root_ft = bt_field_type_structure_create();
-       if (!root_ft) {
-               BT_LOGE_STR("Cannot create an empty structure field type object.");
-               goto error;
-       }
-
-       ft = bt_field_type_integer_create(64);
-       if (!ft) {
-               BT_LOGE_STR("Cannot create an integer field type object.");
-               goto error;
-       }
-
-       ret = bt_field_type_integer_set_mapped_clock_class(ft, clock_class);
-       if (ret) {
-               BT_LOGE("Cannot map integer field type to clock class: "
-                       "ret=%d", ret);
-               goto error;
-       }
-
-       ret = bt_field_type_structure_add_field(root_ft,
-               ft, "timestamp");
-       if (ret) {
-               BT_LOGE("Cannot add `timestamp` field type to structure field type: "
-                       "ret=%d", ret);
-               goto error;
-       }
-
-       goto end;
-
-error:
-       BT_PUT(root_ft);
-
-end:
-       bt_put(ft);
-       return root_ft;
-}
-
-static
-struct bt_field_type *create_event_payload_ft(void)
-{
-       struct bt_field_type *root_ft = NULL;
-       struct bt_field_type *ft = NULL;
-       int ret;
-
-       root_ft = bt_field_type_structure_create();
-       if (!root_ft) {
-               BT_LOGE_STR("Cannot create an empty structure field type object.");
-               goto error;
-       }
-
-       ft = bt_field_type_string_create();
-       if (!ft) {
-               BT_LOGE_STR("Cannot create a string field type object.");
-               goto error;
-       }
-
-       ret = bt_field_type_structure_add_field(root_ft,
-               ft, "str");
-       if (ret) {
-               BT_LOGE("Cannot add `str` field type to structure field type: "
+               BT_LOGE("Cannot add `str` member to structure field class: "
                        "ret=%d", ret);
                goto error;
        }
@@ -194,23 +106,17 @@ struct bt_field_type *create_event_payload_ft(void)
        goto end;
 
 error:
-       BT_PUT(root_ft);
+       BT_OBJECT_PUT_REF_AND_RESET(root_fc);
 
 end:
-       bt_put(ft);
-       return root_ft;
-}
-
-static
-struct bt_clock_class *create_clock_class(void)
-{
-       return bt_clock_class_create("the_clock", 1000000000);
+       bt_object_put_ref(fc);
+       return root_fc;
 }
 
 static
 int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
 {
-       struct bt_field_type *ft = NULL;
+       struct bt_field_class *fc = NULL;
        const char *trace_name = NULL;
        gchar *basename = NULL;
        int ret = 0;
@@ -221,18 +127,6 @@ int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
                goto error;
        }
 
-       ft = create_packet_header_ft();
-       if (!ft) {
-               BT_LOGE_STR("Cannot create packet header field type.");
-               goto error;
-       }
-
-       ret = bt_trace_set_packet_header_field_type(dmesg_comp->trace, ft);
-       if (ret) {
-               BT_LOGE_STR("Cannot set trace's packet header field type.");
-               goto error;
-       }
-
        if (dmesg_comp->params.read_from_stdin) {
                trace_name = "STDIN";
        } else {
@@ -253,71 +147,49 @@ int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
                }
        }
 
-       dmesg_comp->stream_class = bt_stream_class_create(NULL);
+       dmesg_comp->stream_class = bt_stream_class_create(dmesg_comp->trace);
        if (!dmesg_comp->stream_class) {
-               BT_LOGE_STR("Cannot create an empty stream class object.");
+               BT_LOGE_STR("Cannot create a stream class object.");
                goto error;
        }
 
        if (has_ts) {
-               dmesg_comp->clock_class = create_clock_class();
+               dmesg_comp->clock_class = bt_clock_class_create();
                if (!dmesg_comp->clock_class) {
                        BT_LOGE_STR("Cannot create clock class.");
                        goto error;
                }
 
-               ret = bt_trace_add_clock_class(dmesg_comp->trace,
-                       dmesg_comp->clock_class);
-               if (ret) {
-                       BT_LOGE_STR("Cannot add clock class to trace.");
-                       goto error;
-               }
-
-               bt_put(ft);
-               ft = create_event_header_ft(dmesg_comp->clock_class);
-               if (!ft) {
-                       BT_LOGE_STR("Cannot create event header field type.");
-                       goto error;
-               }
-
-               ret = bt_stream_class_set_event_header_field_type(
-                       dmesg_comp->stream_class, ft);
+               ret = bt_stream_class_set_default_clock_class(
+                       dmesg_comp->stream_class, dmesg_comp->clock_class);
                if (ret) {
-                       BT_LOGE_STR("Cannot set stream class's event header field type.");
+                       BT_LOGE_STR("Cannot set stream class's default clock class.");
                        goto error;
                }
        }
 
-       dmesg_comp->event_class = bt_event_class_create("string");
+       dmesg_comp->event_class = bt_event_class_create(
+               dmesg_comp->stream_class);
        if (!dmesg_comp->event_class) {
-               BT_LOGE_STR("Cannot create an empty event class object.");
+               BT_LOGE_STR("Cannot create an event class object.");
                goto error;
        }
 
-       bt_put(ft);
-       ft = create_event_payload_ft();
-       if (!ft) {
-               BT_LOGE_STR("Cannot create event payload field type.");
-               goto error;
-       }
-
-       ret = bt_event_class_set_payload_field_type(dmesg_comp->event_class, ft);
+       ret = bt_event_class_set_name(dmesg_comp->event_class, "string");
        if (ret) {
-               BT_LOGE_STR("Cannot set event class's event payload field type.");
+               BT_LOGE_STR("Cannot set event class's name.");
                goto error;
        }
 
-       ret = bt_stream_class_add_event_class(dmesg_comp->stream_class,
-               dmesg_comp->event_class);
-       if (ret) {
-               BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
+       fc = create_event_payload_fc();
+       if (!fc) {
+               BT_LOGE_STR("Cannot create event payload field class.");
                goto error;
        }
 
-       ret = bt_trace_add_stream_class(dmesg_comp->trace,
-               dmesg_comp->stream_class);
+       ret = bt_event_class_set_payload_field_class(dmesg_comp->event_class, fc);
        if (ret) {
-               BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
+               BT_LOGE_STR("Cannot set event class's event payload field class.");
                goto error;
        }
 
@@ -327,7 +199,7 @@ error:
        ret = -1;
 
 end:
-       bt_put(ft);
+       bt_object_put_ref(fc);
 
        if (basename) {
                g_free(basename);
@@ -339,28 +211,27 @@ end:
 static
 int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
 {
-       struct bt_value *read_from_stdin = NULL;
        struct bt_value *no_timestamp = NULL;
        struct bt_value *path = NULL;
        const char *path_str;
        int ret = 0;
 
-       no_timestamp = bt_value_map_get(params, "no-extract-timestamp");
+       no_timestamp = bt_value_map_borrow_entry_value(params,
+               "no-extract-timestamp");
        if (no_timestamp) {
                if (!bt_value_is_bool(no_timestamp)) {
                        BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
                                "type=%s",
-                               bt_value_type_string(
+                               bt_common_value_type_string(
                                        bt_value_get_type(no_timestamp)));
                        goto error;
                }
 
-               ret = bt_value_bool_get(no_timestamp,
-                       &dmesg_comp->params.no_timestamp);
-               BT_ASSERT(ret == 0);
+               dmesg_comp->params.no_timestamp =
+                       bt_value_bool_get(no_timestamp);
        }
 
-       path = bt_value_map_get(params, "path");
+       path = bt_value_map_borrow_entry_value(params, "path");
        if (path) {
                if (dmesg_comp->params.read_from_stdin) {
                        BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
@@ -370,13 +241,12 @@ int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
                if (!bt_value_is_string(path)) {
                        BT_LOGE("Expecting a string value for the `path` parameter: "
                                "type=%s",
-                               bt_value_type_string(
+                               bt_common_value_type_string(
                                        bt_value_get_type(path)));
                        goto error;
                }
 
-               ret = bt_value_string_get(path, &path_str);
-               BT_ASSERT(ret == 0);
+               path_str = bt_value_string_get(path);
                g_string_assign(dmesg_comp->params.path, path_str);
        } else {
                dmesg_comp->params.read_from_stdin = true;
@@ -387,35 +257,6 @@ int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
 error:
        ret = -1;
 
-end:
-       bt_put(read_from_stdin);
-       bt_put(path);
-       bt_put(no_timestamp);
-       return ret;
-}
-
-static
-int fill_packet_header_field(struct bt_packet *packet)
-{
-       struct bt_field *ph = NULL;
-       struct bt_field *magic = NULL;
-       int ret;
-
-       ph = bt_packet_borrow_header(packet);
-       BT_ASSERT(ph);
-       magic = bt_field_structure_borrow_field_by_name(ph, "magic");
-       if (!magic) {
-               BT_LOGE_STR("Cannot borrow `magic` field from structure field.");
-               goto error;
-       }
-
-       ret = bt_field_integer_unsigned_set_value(magic, 0xc1fc1fc1);
-       BT_ASSERT(ret == 0);
-       goto end;
-
-error:
-       ret = -1;
-
 end:
        return ret;
 }
@@ -425,8 +266,7 @@ int create_packet_and_stream(struct dmesg_component *dmesg_comp)
 {
        int ret = 0;
 
-       dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class,
-               NULL, 0);
+       dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class);
        if (!dmesg_comp->stream) {
                BT_LOGE_STR("Cannot create stream object.");
                goto error;
@@ -438,13 +278,7 @@ int create_packet_and_stream(struct dmesg_component *dmesg_comp)
                goto error;
        }
 
-       ret = fill_packet_header_field(dmesg_comp->packet);
-       if (ret) {
-               BT_LOGE_STR("Cannot fill packet header field.");
-               goto error;
-       }
-
-       ret = bt_trace_set_is_static(dmesg_comp->trace);
+       ret = bt_trace_make_static(dmesg_comp->trace);
        if (ret) {
                BT_LOGE_STR("Cannot make trace static.");
                goto error;
@@ -504,13 +338,13 @@ void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
                g_string_free(dmesg_comp->params.path, TRUE);
        }
 
-       bt_put(dmesg_comp->packet);
-       bt_put(dmesg_comp->trace);
-       bt_put(dmesg_comp->stream_class);
-       bt_put(dmesg_comp->event_class);
-       bt_put(dmesg_comp->stream);
-       bt_put(dmesg_comp->clock_class);
-       bt_put(dmesg_comp->cc_prio_map);
+       bt_object_put_ref(dmesg_comp->packet);
+       bt_object_put_ref(dmesg_comp->trace);
+       bt_object_put_ref(dmesg_comp->stream_class);
+       bt_object_put_ref(dmesg_comp->event_class);
+       bt_object_put_ref(dmesg_comp->stream);
+       bt_object_put_ref(dmesg_comp->clock_class);
+       bt_object_put_ref(dmesg_comp->cc_prio_map);
        g_free(dmesg_comp);
 }
 
@@ -534,9 +368,6 @@ enum bt_component_status dmesg_init(struct bt_private_component *priv_comp,
                goto error;
        }
 
-       dmesg_comp->graph = bt_component_borrow_graph(
-               bt_component_borrow_from_private(priv_comp));
-       BT_ASSERT(dmesg_comp->graph);
        dmesg_comp->params.path = g_string_new(NULL);
        if (!dmesg_comp->params.path) {
                BT_LOGE_STR("Failed to allocate a GString.");
@@ -588,7 +419,7 @@ void dmesg_finalize(struct bt_private_component *priv_comp)
 
 static
 struct bt_notification *create_init_event_notif_from_line(
-               struct dmesg_component *dmesg_comp,
+               struct dmesg_notif_iter *notif_iter,
                const char *line, const char **new_start)
 {
        struct bt_event *event;
@@ -597,9 +428,8 @@ struct bt_notification *create_init_event_notif_from_line(
        unsigned long sec, usec, msec;
        unsigned int year, mon, mday, hour, min;
        uint64_t ts = 0;
-       struct bt_field *eh_field = NULL;
-       struct bt_field *ts_field = NULL;
        int ret = 0;
+       struct dmesg_component *dmesg_comp = notif_iter->dmesg_comp;
 
        *new_start = line;
 
@@ -654,7 +484,7 @@ struct bt_notification *create_init_event_notif_from_line(
 skip_ts:
        /*
         * At this point, we know if the stream class's event header
-        * field type should have a timestamp or not, so we can lazily
+        * field class should have a timestamp or not, so we can lazily
         * create the metadata, stream, and packet objects.
         */
        ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
@@ -663,7 +493,7 @@ skip_ts:
                goto error;
        }
 
-       notif = bt_notification_event_create(dmesg_comp->graph,
+       notif = bt_notification_event_create(notif_iter->pc_notif_iter,
                dmesg_comp->event_class, dmesg_comp->packet);
        if (!notif) {
                BT_LOGE_STR("Cannot create event notification.");
@@ -674,43 +504,31 @@ skip_ts:
        BT_ASSERT(event);
 
        if (dmesg_comp->clock_class) {
-               ret = bt_event_set_clock_value(event,
-                       dmesg_comp->clock_class, ts, BT_TRUE);
-               BT_ASSERT(ret == 0);
-               eh_field = bt_event_borrow_header(event);
-               BT_ASSERT(eh_field);
-               ts_field = bt_field_structure_borrow_field_by_name(eh_field,
-                       "timestamp");
-               if (!ts_field) {
-                       BT_LOGE_STR("Cannot borrow `timestamp` field from event header structure field.");
-                       goto error;
-               }
-
-               ret = bt_field_integer_unsigned_set_value(ts_field, ts);
+               ret = bt_event_set_default_clock_value(event, ts);
                BT_ASSERT(ret == 0);
        }
 
        goto end;
 
 error:
-       BT_PUT(notif);
+       BT_OBJECT_PUT_REF_AND_RESET(notif);
 
 end:
        return notif;
 }
 
 static
-int fill_event_payload_from_line(struct dmesg_component *dmesg_comp,
-               const char *line, struct bt_event *event)
+int fill_event_payload_from_line(const char *line, struct bt_event *event)
 {
        struct bt_field *ep_field = NULL;
        struct bt_field *str_field = NULL;
        size_t len;
        int ret;
 
-       ep_field = bt_event_borrow_payload(event);
+       ep_field = bt_event_borrow_payload_field(event);
        BT_ASSERT(ep_field);
-       str_field = bt_field_structure_borrow_field_by_name(ep_field, "str");
+       str_field = bt_field_structure_borrow_member_field_by_index(ep_field,
+               0);
        if (!str_field) {
                BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
                goto error;
@@ -728,7 +546,7 @@ int fill_event_payload_from_line(struct dmesg_component *dmesg_comp,
                goto error;
        }
 
-       ret = bt_field_string_append_len(str_field, line, len);
+       ret = bt_field_string_append_with_length(str_field, line, len);
        if (ret) {
                BT_LOGE("Cannot append value to string field object: "
                        "len=%zu", len);
@@ -746,14 +564,15 @@ end:
 
 static
 struct bt_notification *create_notif_from_line(
-               struct dmesg_component *dmesg_comp, const char *line)
+               struct dmesg_notif_iter *dmesg_notif_iter, const char *line)
 {
        struct bt_event *event = NULL;
        struct bt_notification *notif = NULL;
        const char *new_start;
        int ret;
 
-       notif = create_init_event_notif_from_line(dmesg_comp, line, &new_start);
+       notif = create_init_event_notif_from_line(dmesg_notif_iter,
+               line, &new_start);
        if (!notif) {
                BT_LOGE_STR("Cannot create and initialize event notification from line.");
                goto error;
@@ -761,8 +580,7 @@ struct bt_notification *create_notif_from_line(
 
        event = bt_notification_event_borrow_event(notif);
        BT_ASSERT(event);
-       ret = fill_event_payload_from_line(dmesg_comp, new_start,
-               event);
+       ret = fill_event_payload_from_line(new_start, event);
        if (ret) {
                BT_LOGE("Cannot fill event payload field from line: "
                        "ret=%d", ret);
@@ -772,7 +590,7 @@ struct bt_notification *create_notif_from_line(
        goto end;
 
 error:
-       BT_PUT(notif);
+       BT_OBJECT_PUT_REF_AND_RESET(notif);
 
 end:
        return notif;
@@ -791,7 +609,7 @@ void destroy_dmesg_notif_iter(struct dmesg_notif_iter *dmesg_notif_iter)
                }
        }
 
-       bt_put(dmesg_notif_iter->tmp_event_notif);
+       bt_object_put_ref(dmesg_notif_iter->tmp_event_notif);
        free(dmesg_notif_iter->linebuf);
        g_free(dmesg_notif_iter);
 }
@@ -819,6 +637,7 @@ enum bt_notification_iterator_status dmesg_notif_iter_init(
        dmesg_comp = bt_private_component_get_user_data(priv_comp);
        BT_ASSERT(dmesg_comp);
        dmesg_notif_iter->dmesg_comp = dmesg_comp;
+       dmesg_notif_iter->pc_notif_iter = priv_notif_iter;
 
        if (dmesg_comp->params.read_from_stdin) {
                dmesg_notif_iter->fp = stdin;
@@ -844,7 +663,7 @@ error:
        }
 
 end:
-       bt_put(priv_comp);
+       bt_object_put_ref(priv_comp);
        return status;
 }
 
@@ -924,8 +743,8 @@ enum bt_notification_iterator_status dmesg_notif_iter_next_one(
                }
        }
 
-       dmesg_notif_iter->tmp_event_notif = create_notif_from_line(dmesg_comp,
-               dmesg_notif_iter->linebuf);
+       dmesg_notif_iter->tmp_event_notif = create_notif_from_line(
+               dmesg_notif_iter, dmesg_notif_iter->linebuf);
        if (!dmesg_notif_iter->tmp_event_notif) {
                BT_LOGE("Cannot create event notification from line: "
                        "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
@@ -940,13 +759,13 @@ handle_state:
        case STATE_EMIT_STREAM_BEGINNING:
                BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
                *notif = bt_notification_stream_begin_create(
-                       dmesg_comp->graph, dmesg_comp->stream);
+                       dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
                dmesg_notif_iter->state = STATE_EMIT_PACKET_BEGINNING;
                break;
        case STATE_EMIT_PACKET_BEGINNING:
                BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
                *notif = bt_notification_packet_begin_create(
-                       dmesg_comp->graph, dmesg_comp->packet);
+                       dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
                dmesg_notif_iter->state = STATE_EMIT_EVENT;
                break;
        case STATE_EMIT_EVENT:
@@ -956,12 +775,12 @@ handle_state:
                break;
        case STATE_EMIT_PACKET_END:
                *notif = bt_notification_packet_end_create(
-                       dmesg_comp->graph, dmesg_comp->packet);
+                       dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
                dmesg_notif_iter->state = STATE_EMIT_STREAM_END;
                break;
        case STATE_EMIT_STREAM_END:
                *notif = bt_notification_stream_end_create(
-                       dmesg_comp->graph, dmesg_comp->stream);
+                       dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
                dmesg_notif_iter->state = STATE_DONE;
                break;
        default:
This page took 0.046972 seconds and 4 git commands to generate.