Rename bt_X_from_private_X() -> bt_X_from_private()
[babeltrace.git] / lib / graph / filter.c
index aaab3b78c91f6b7b0c9a20775f384521e00e5741..8914e1ef876477dd2135a1ea285a5e13b564bd48 100644 (file)
@@ -26,6 +26,9 @@
  * SOFTWARE.
  */
 
+#define BT_LOG_TAG "COMP-FILTER"
+#include <babeltrace/lib-logging-internal.h>
+
 #include <babeltrace/compiler-internal.h>
 #include <babeltrace/values.h>
 #include <babeltrace/graph/component-filter-internal.h>
@@ -33,6 +36,7 @@
 #include <babeltrace/graph/component-class-internal.h>
 #include <babeltrace/graph/notification.h>
 #include <babeltrace/graph/notification-iterator-internal.h>
+#include <babeltrace/graph/graph.h>
 
 BT_HIDDEN
 void bt_component_filter_destroy(struct bt_component *component)
@@ -41,12 +45,13 @@ void bt_component_filter_destroy(struct bt_component *component)
 
 BT_HIDDEN
 struct bt_component *bt_component_filter_create(
-               struct bt_component_class *class, struct bt_value *params)
+               struct bt_component_class *class)
 {
        struct bt_component_filter *filter = NULL;
 
        filter = g_new0(struct bt_component_filter, 1);
        if (!filter) {
+               BT_LOGE_STR("Failed to allocate one filter component.");
                goto end;
        }
 
@@ -54,44 +59,28 @@ end:
        return filter ? &filter->parent : NULL;
 }
 
-BT_HIDDEN
-enum bt_component_status bt_component_filter_validate(
+int64_t bt_component_filter_get_input_port_count(
                struct bt_component *component)
 {
-       enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       int64_t ret;
 
        if (!component) {
-               ret = BT_COMPONENT_STATUS_INVALID;
-               goto end;
-       }
-
-       if (!component->class) {
-               ret = BT_COMPONENT_STATUS_INVALID;
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               ret = (int64_t) -1;
                goto end;
        }
 
        if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
-               ret = BT_COMPONENT_STATUS_INVALID;
-               goto end;
-       }
-
-       /* Enforce iterator limits. */
-end:
-       return ret;
-}
-
-int64_t bt_component_filter_get_input_port_count(
-               struct bt_component *component)
-{
-       int64_t ret;
-
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
-               ret = (int64_t) -1;
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               ret = (int64_t) -1;
                goto end;
        }
 
        ret = (int64_t) bt_component_get_input_port_count(component);
+
 end:
        return ret;
 }
@@ -101,12 +90,27 @@ struct bt_port *bt_component_filter_get_input_port_by_name(
 {
        struct bt_port *port = NULL;
 
-       if (!component || !name ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               goto end;
+       }
+
+       if (!name) {
+               BT_LOGW_STR("Invalid parameter: name is NULL.");
                goto end;
        }
 
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               goto end;
+       }
+
+       /* bt_component_get_input_port_by_name() logs details/errors */
        port = bt_component_get_input_port_by_name(component, name);
+
 end:
        return port;
 }
@@ -116,12 +120,22 @@ struct bt_port *bt_component_filter_get_input_port_by_index(
 {
        struct bt_port *port = NULL;
 
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
                goto end;
        }
 
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               goto end;
+       }
+
+       /* bt_component_get_input_port_by_index() logs details/errors */
        port = bt_component_get_input_port_by_index(component, index);
+
 end:
        return port;
 }
@@ -131,13 +145,24 @@ int64_t bt_component_filter_get_output_port_count(
 {
        int64_t ret;
 
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
-               ret = (int64_t) -1;
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               ret = (int64_t) -1;
+               goto end;
+       }
+
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               ret = (int64_t) -1;
                goto end;
        }
 
+       /* bt_component_get_output_port_count() logs details/errors */
        ret = bt_component_get_output_port_count(component);
+
 end:
        return ret;
 }
@@ -147,12 +172,27 @@ struct bt_port *bt_component_filter_get_output_port_by_name(
 {
        struct bt_port *port = NULL;
 
-       if (!component || !name ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               goto end;
+       }
+
+       if (!name) {
+               BT_LOGW_STR("Invalid parameter: name is NULL.");
                goto end;
        }
 
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               goto end;
+       }
+
+       /* bt_component_get_output_port_by_name() logs details/errors */
        port = bt_component_get_output_port_by_name(component, name);
+
 end:
        return port;
 }
@@ -162,12 +202,22 @@ struct bt_port *bt_component_filter_get_output_port_by_index(
 {
        struct bt_port *port = NULL;
 
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
                goto end;
        }
 
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               goto end;
+       }
+
+       /* bt_component_get_output_port_by_index() logs details/errors */
        port = bt_component_get_output_port_by_index(component, index);
+
 end:
        return port;
 }
@@ -176,9 +226,10 @@ struct bt_private_port *
 bt_private_component_filter_get_input_private_port_by_index(
                struct bt_private_component *private_component, uint64_t index)
 {
+       /* bt_component_filter_get_input_port_by_index() logs details/errors */
        return bt_private_port_from_port(
                bt_component_filter_get_input_port_by_index(
-                       bt_component_from_private(private_component), index));
+                       bt_component_borrow_from_private(private_component), index));
 }
 
 struct bt_private_port *
@@ -186,36 +237,75 @@ bt_private_component_filter_get_input_private_port_by_name(
                struct bt_private_component *private_component,
                const char *name)
 {
+       /* bt_component_filter_get_input_port_by_name() logs details/errors */
        return bt_private_port_from_port(
                bt_component_filter_get_input_port_by_name(
-                       bt_component_from_private(private_component), name));
+                       bt_component_borrow_from_private(private_component), name));
 }
 
-struct bt_private_port *bt_private_component_filter_add_input_private_port(
+enum bt_component_status bt_private_component_filter_add_input_private_port(
                struct bt_private_component *private_component,
-               const char *name, void *user_data)
+               const char *name, void *user_data,
+               struct bt_private_port **user_priv_port)
 {
+       enum bt_component_status status = BT_COMPONENT_STATUS_OK;
        struct bt_port *port = NULL;
        struct bt_component *component =
-               bt_component_from_private(private_component);
+               bt_component_borrow_from_private(private_component);
+       struct bt_graph *graph;
+
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               status = BT_COMPONENT_STATUS_INVALID;
+               goto end;
+       }
+
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               status = BT_COMPONENT_STATUS_INVALID;
+               goto end;
+       }
+
+       graph = bt_component_borrow_graph(component);
 
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (graph && bt_graph_is_canceled(graph)) {
+               BT_LOGW("Cannot add input port to filter component: graph is canceled: "
+                       "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
+                       component, bt_component_get_name(component),
+                       bt_component_borrow_graph(component));
+               status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
                goto end;
        }
 
+       /* bt_component_add_input_port() logs details/errors */
        port = bt_component_add_input_port(component, name, user_data);
+       if (!port) {
+               status = BT_COMPONENT_STATUS_NOMEM;
+               goto end;
+       }
+
+       if (user_priv_port) {
+               /* Move reference to user */
+               *user_priv_port = bt_private_port_from_port(port);
+               port = NULL;
+       }
+
 end:
-       return bt_private_port_from_port(port);
+       bt_put(port);
+       return status;
 }
 
 struct bt_private_port *
 bt_private_component_filter_get_output_private_port_by_index(
                struct bt_private_component *private_component, uint64_t index)
 {
+       /* bt_component_filter_get_output_port_by_index() logs details/errors */
        return bt_private_port_from_port(
                bt_component_filter_get_output_port_by_index(
-                       bt_component_from_private(private_component), index));
+                       bt_component_borrow_from_private(private_component), index));
 }
 
 struct bt_private_port *
@@ -223,25 +313,63 @@ bt_private_component_filter_get_output_private_port_by_name(
                struct bt_private_component *private_component,
                const char *name)
 {
+       /* bt_component_filter_get_output_port_by_name() logs details/errors */
        return bt_private_port_from_port(
                bt_component_filter_get_output_port_by_name(
-                       bt_component_from_private(private_component), name));
+                       bt_component_borrow_from_private(private_component), name));
 }
 
-struct bt_private_port *bt_private_component_filter_add_output_private_port(
+enum bt_component_status bt_private_component_filter_add_output_private_port(
                struct bt_private_component *private_component,
-               const char *name, void *user_data)
+               const char *name, void *user_data,
+               struct bt_private_port **user_priv_port)
 {
+       enum bt_component_status status = BT_COMPONENT_STATUS_OK;
        struct bt_port *port = NULL;
        struct bt_component *component =
-               bt_component_from_private(private_component);
+               bt_component_borrow_from_private(private_component);
+       struct bt_graph *graph;
 
-       if (!component ||
-                       component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+       if (!component) {
+               BT_LOGW_STR("Invalid parameter: component is NULL.");
+               status = BT_COMPONENT_STATUS_INVALID;
                goto end;
        }
 
+       if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
+               BT_LOGW("Invalid parameter: component's class is not a filter component class: "
+                       "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
+                       component, bt_component_get_name(component),
+                       bt_component_class_type_string(component->class->type));
+               status = BT_COMPONENT_STATUS_INVALID;
+               goto end;
+       }
+
+       graph = bt_component_borrow_graph(component);
+
+       if (graph && bt_graph_is_canceled(graph)) {
+               BT_LOGW("Cannot add output port to filter component: graph is canceled: "
+                       "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
+                       component, bt_component_get_name(component),
+                       bt_component_borrow_graph(component));
+               status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
+               goto end;
+       }
+
+       /* bt_component_add_output_port() logs details/errors */
        port = bt_component_add_output_port(component, name, user_data);
+       if (!port) {
+               status = BT_COMPONENT_STATUS_NOMEM;
+               goto end;
+       }
+
+       if (user_priv_port) {
+               /* Move reference to user */
+               *user_priv_port = bt_private_port_from_port(port);
+               port = NULL;
+       }
+
 end:
-       return bt_private_port_from_port(port);
+       bt_put(port);
+       return status;
 }
This page took 0.027754 seconds and 4 git commands to generate.