Values API: standardize parameters and return values

[babeltrace.git] / plugins / utils / trimmer / trimmer.c

diff --git a/plugins/utils/trimmer/trimmer.c b/plugins/utils/trimmer/trimmer.c
index d3f907e168f4f40eaa81247df333a2bab367d37c..777b14fac3c74f2d4a077968c4a288401a886d0e 100644 (file)
--- a/plugins/utils/trimmer/trimmer.c
+++ b/plugins/utils/trimmer/trimmer.c
@@ -26,18 +26,15 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/plugin/plugin-dev.h>
-#include <babeltrace/graph/component.h>
-#include <babeltrace/graph/private-component.h>
-#include <babeltrace/graph/component-filter.h>
-#include <babeltrace/graph/notification.h>
-#include <babeltrace/graph/notification-iterator.h>
-#include <babeltrace/graph/private-notification-iterator.h>
-#include <babeltrace/graph/notification-event.h>
+#define BT_LOG_TAG "PLUGIN-UTILS-TRIMMER-FLT"
+#include "logging.h"
+
+#include <babeltrace/compat/utc-internal.h>
+#include <babeltrace/babeltrace.h>
 #include <plugins-common.h>
 #include "trimmer.h"
 #include "iterator.h"
-#include <assert.h>
+#include <babeltrace/assert-internal.h>
 
 static
 void destroy_trimmer_data(struct trimmer *trimmer)
@@ -48,14 +45,7 @@ void destroy_trimmer_data(struct trimmer *trimmer)
 static
 struct trimmer *create_trimmer_data(void)
 {
-       struct trimmer *trimmer;
-
-       trimmer = g_new0(struct trimmer, 1);
-       if (!trimmer) {
-               goto end;
-       }
-end:
-       return trimmer;
+       return g_new0(struct trimmer, 1);
 }
 
 void finalize_trimmer(struct bt_private_component *component)
@@ -82,12 +72,25 @@ void finalize_trimmer(struct bt_private_component *component)
  *   ss
  */
 static
-int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
-               struct trimmer_bound *result_bound, bool gmt)
+int timestamp_from_param(const char *param_name, struct bt_value *param,
+               struct trimmer *trimmer, struct trimmer_bound *result_bound,
+               bt_bool gmt)
 {
        int ret;
        int64_t value;
        unsigned int year, month, day, hh, mm, ss, ns;
+       const char *arg;
+
+       if (bt_value_is_integer(param)) {
+               (void) bt_value_integer_get(param, &value);
+               goto set;
+       } else if (!bt_value_is_string(param)) {
+               BT_LOGE("`%s` parameter must be an integer or a string value.",
+                       param_name);
+               goto error;
+       }
+
+       (void) bt_value_string_get(param, &arg);
 
        /* YYYY-MM-DD hh:mm:ss.ns */
        ret = sscanf(arg, "%u-%u-%u %u:%u:%u.%u",
@@ -105,7 +108,7 @@ int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
                time_t result;
 
                if (gmt) {
-                       result = timegm(&tm);
+                       result = bt_timegm(&tm);
                        if (result < 0) {
                                return -1;
                        }
@@ -151,7 +154,7 @@ int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
                        time_t result;
 
                        if (gmt) {
-                               result = timegm(&tm);
+                               result = bt_timegm(&tm);
                                if (result < 0) {
                                        return -1;
                                }
@@ -199,7 +202,7 @@ int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
                };
 
                if (gmt) {
-                       value = timegm(&tm);
+                       value = bt_timegm(&tm);
                        if (value < 0) {
                                return -1;
                        }
@@ -243,7 +246,7 @@ int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
                        time_t result;
 
                        if (gmt) {
-                               result = timegm(&tm);
+                               result = bt_timegm(&tm);
                                if (result < 0) {
                                        return -1;
                                }
@@ -273,6 +276,7 @@ int timestamp_from_arg(const char *arg, struct trimmer *trimmer,
                goto set;
        }
 
+error:
        /* Not found. */
        return -1;
 
@@ -291,60 +295,49 @@ enum bt_component_status init_from_params(struct trimmer *trimmer,
                struct bt_value *params)
 {
        struct bt_value *value = NULL;
-       bool gmt = false;
+       bt_bool gmt = BT_FALSE;
        enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 
-       assert(params);
+       BT_ASSERT(params);
 
         value = bt_value_map_get(params, "clock-gmt");
        if (value) {
                enum bt_value_status value_ret;
 
-               value_ret = bt_value_bool_get(value, &gmt);
-               if (value_ret) {
-                       ret = BT_COMPONENT_STATUS_INVALID;
-                       printf_error("Failed to retrieve clock-gmt value. Expecting a boolean");
-               }
+               gmt = bt_value_bool_get(value);
        }
-       bt_put(value);
        if (ret != BT_COMPONENT_STATUS_OK) {
                goto end;
        }
 
+       BT_OBJECT_PUT_REF_AND_RESET(value);
         value = bt_value_map_get(params, "begin");
        if (value) {
-               enum bt_value_status value_ret;
-               const char *str;
-
-               value_ret = bt_value_string_get(value, &str);
-               if (value_ret || timestamp_from_arg(str,
+               if (timestamp_from_param("begin", value,
                                trimmer, &trimmer->begin, gmt)) {
+                       BT_LOGE_STR("Failed to convert `begin` parameter to a timestamp.");
                        ret = BT_COMPONENT_STATUS_INVALID;
-                       printf_error("Failed to retrieve begin value. Expecting a timestamp string");
+                       goto end;
                }
        }
-       bt_put(value);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto end;
-       }
 
+       BT_OBJECT_PUT_REF_AND_RESET(value);
         value = bt_value_map_get(params, "end");
        if (value) {
-               enum bt_value_status value_ret;
-               const char *str;
-
-               value_ret = bt_value_string_get(value, &str);
-               if (value_ret || timestamp_from_arg(str,
+               if (timestamp_from_param("end", value,
                                trimmer, &trimmer->end, gmt)) {
+                       BT_LOGE_STR("Failed to convert `end` parameter to a timestamp.");
                        ret = BT_COMPONENT_STATUS_INVALID;
-                       printf_error("Failed to retrieve end value. Expecting a timestamp string");
+                       goto end;
                }
        }
-       bt_put(value);
+
 end:
+       bt_object_put_ref(value);
+
        if (trimmer->begin.set && trimmer->end.set) {
                if (trimmer->begin.value > trimmer->end.value) {
-                       printf_error("Unexpected: time range begin value is above end value");
+                       BT_LOGE_STR("Unexpected: time range begin value is above end value");
                        ret = BT_COMPONENT_STATUS_INVALID;
                }
        }
@@ -363,6 +356,19 @@ enum bt_component_status trimmer_component_init(
                goto end;
        }
 
+       /* Create input and output ports */
+       ret = bt_private_component_filter_add_input_private_port(
+               component, "in", NULL, NULL);
+       if (ret != BT_COMPONENT_STATUS_OK) {
+               goto error;
+       }
+
+       ret = bt_private_component_filter_add_output_private_port(
+               component, "out", NULL, NULL);
+       if (ret != BT_COMPONENT_STATUS_OK) {
+               goto error;
+       }
+
        ret = bt_private_component_set_user_data(component, trimmer);
        if (ret != BT_COMPONENT_STATUS_OK) {
                goto error;
@@ -373,5 +379,6 @@ end:
        return ret;
 error:
        destroy_trimmer_data(trimmer);
+       ret = BT_COMPONENT_STATUS_ERROR;
        return ret;
 }