Document libbabeltrace2's C API

[babeltrace.git] / src / lib / graph / component.c

diff --git a/src/lib/graph/component.c b/src/lib/graph/component.c
index 825d8963a96a4726f82e019de765647b8262c01a..65978e944cab83f5b1ce18f0070d437ee382ad2a 100644 (file)
--- a/src/lib/graph/component.c
+++ b/src/lib/graph/component.c
@@ -29,11 +29,8 @@
 #include "lib/assert-pre.h"
 #include "lib/assert-post.h"
 #include <babeltrace2/graph/self-component.h>
-#include <babeltrace2/graph/component-const.h>
-#include <babeltrace2/graph/component-source-const.h>
-#include <babeltrace2/graph/component-filter-const.h>
-#include <babeltrace2/graph/component-sink-const.h>
-#include <babeltrace2/graph/graph-const.h>
+#include <babeltrace2/graph/component.h>
+#include <babeltrace2/graph/graph.h>
 #include "common/macros.h"
 #include "compat/compiler.h"
 #include <babeltrace2/types.h>
@@ -100,13 +97,22 @@ void finalize_component(struct bt_component *comp)
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        if (method) {
+               const struct bt_error *saved_error;
+
+               saved_error = bt_current_thread_take_error();
+
                BT_LIB_LOGI("Calling user's component finalization method: "
                        "%![comp-]+c", comp);
                method(comp);
+               BT_ASSERT_POST_NO_ERROR();
+
+               if (saved_error) {
+                       BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
+               }
        }
 }
 
@@ -190,7 +196,7 @@ void destroy_component(struct bt_object *obj)
 enum bt_component_class_type bt_component_get_class_type(
                const struct bt_component *component)
 {
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        return component->class->type;
 }
 
@@ -208,9 +214,6 @@ enum bt_self_component_add_port_status add_port(
        BT_ASSERT_PRE_NON_NULL(name, "Name");
        BT_ASSERT_PRE(strlen(name) > 0, "Name is empty");
        graph = bt_component_borrow_graph(component);
-       BT_ASSERT_PRE(graph && !bt_graph_is_canceled(graph),
-               "Component's graph is canceled: %![comp-]+c, %![graph-]+g",
-               component, graph);
        BT_ASSERT_PRE(
                graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
                "Component's graph is already configured: "
@@ -224,7 +227,7 @@ enum bt_self_component_add_port_status add_port(
 
        new_port = bt_port_create(component, port_type, name, user_data);
        if (!new_port) {
-               BT_LOGE_STR("Cannot create port object.");
+               BT_LIB_LOGE_APPEND_CAUSE("Cannot create port object.");
                status = BT_FUNC_STATUS_MEMORY_ERROR;
                goto error;
        }
@@ -273,14 +276,14 @@ end:
 BT_HIDDEN
 uint64_t bt_component_get_input_port_count(const struct bt_component *comp)
 {
-       BT_ASSERT_PRE_NON_NULL(comp, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
        return (uint64_t) comp->input_ports->len;
 }
 
 BT_HIDDEN
 uint64_t bt_component_get_output_port_count(const struct bt_component *comp)
 {
-       BT_ASSERT_PRE_NON_NULL(comp, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
        return (uint64_t) comp->output_ports->len;
 }
 
@@ -302,18 +305,19 @@ int bt_component_create(struct bt_component_class *component_class,
                bt_common_logging_level_string(log_level));
        component = component_create_funcs[type](component_class);
        if (!component) {
-               BT_LOGE_STR("Cannot create specific component object.");
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Cannot create specific component object.");
                ret = -1;
                goto end;
        }
 
        bt_object_init_shared_with_parent(&component->base, destroy_component);
        component->class = component_class;
-       bt_object_get_no_null_check(component->class);
+       bt_object_get_ref_no_null_check(component->class);
        component->destroy = component_destroy_funcs[type];
        component->name = g_string_new(name);
        if (!component->name) {
-               BT_LOGE_STR("Failed to allocate one GString.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
                ret = -1;
                goto end;
        }
@@ -322,7 +326,7 @@ int bt_component_create(struct bt_component_class *component_class,
        component->input_ports = g_ptr_array_new_with_free_func(
                (GDestroyNotify) bt_object_try_spec_release);
        if (!component->input_ports) {
-               BT_LOGE_STR("Failed to allocate one GPtrArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                ret = -1;
                goto end;
        }
@@ -330,7 +334,7 @@ int bt_component_create(struct bt_component_class *component_class,
        component->output_ports = g_ptr_array_new_with_free_func(
                (GDestroyNotify) bt_object_try_spec_release);
        if (!component->output_ports) {
-               BT_LOGE_STR("Failed to allocate one GPtrArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                ret = -1;
                goto end;
        }
@@ -338,7 +342,7 @@ int bt_component_create(struct bt_component_class *component_class,
        component->destroy_listeners = g_array_new(FALSE, TRUE,
                sizeof(struct bt_component_destroy_listener));
        if (!component->destroy_listeners) {
-               BT_LOGE_STR("Failed to allocate one GArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
                ret = -1;
                goto end;
        }
@@ -354,14 +358,14 @@ end:
 
 const char *bt_component_get_name(const struct bt_component *component)
 {
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        return component->name->str;
 }
 
 const struct bt_component_class *bt_component_borrow_class_const(
                const struct bt_component *component)
 {
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        return component->class;
 }
 
@@ -369,7 +373,7 @@ void *bt_self_component_get_data(const struct bt_self_component *self_comp)
 {
        struct bt_component *component = (void *) self_comp;
 
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        return component->user_data;
 }
 
@@ -378,7 +382,7 @@ void bt_self_component_set_data(struct bt_self_component *self_comp,
 {
        struct bt_component *component = (void *) self_comp;
 
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        component->user_data = data;
        BT_LIB_LOGD("Set component's user data: %!+c", component);
 }
@@ -391,12 +395,6 @@ void bt_component_set_graph(struct bt_component *component,
                graph ? &graph->base : NULL);
 }
 
-bt_bool bt_component_graph_is_canceled(const struct bt_component *component)
-{
-       return bt_graph_is_canceled(
-               (void *) bt_object_borrow_parent(&component->base));
-}
-
 static
 struct bt_port *borrow_port_by_name(GPtrArray *ports,
                const char *name)
@@ -409,7 +407,7 @@ struct bt_port *borrow_port_by_name(GPtrArray *ports,
        for (i = 0; i < ports->len; i++) {
                struct bt_port *port = g_ptr_array_index(ports, i);
 
-               if (!strcmp(name, port->name->str)) {
+               if (strcmp(name, port->name->str) == 0) {
                        ret_port = port;
                        break;
                }
@@ -430,7 +428,7 @@ BT_HIDDEN
 struct bt_port_output *bt_component_borrow_output_port_by_name(
                struct bt_component *comp, const char *name)
 {
-       BT_ASSERT_PRE_NON_NULL(comp, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
        return (void *)
                borrow_port_by_name(comp->output_ports, name);
 }
@@ -446,8 +444,8 @@ BT_HIDDEN
 struct bt_port_input *bt_component_borrow_input_port_by_index(
                struct bt_component *comp, uint64_t index)
 {
-       BT_ASSERT_PRE_NON_NULL(comp, "Component");
-       BT_ASSERT_PRE_VALID_INDEX(index, comp->input_ports->len);
+       BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp->input_ports->len);
        return (void *)
                borrow_port_by_index(comp->input_ports, index);
 }
@@ -456,8 +454,8 @@ BT_HIDDEN
 struct bt_port_output *bt_component_borrow_output_port_by_index(
                struct bt_component *comp, uint64_t index)
 {
-       BT_ASSERT_PRE_NON_NULL(comp, "Component");
-       BT_ASSERT_PRE_VALID_INDEX(index, comp->output_ports->len);
+       BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp->output_ports->len);
        return (void *)
                borrow_port_by_index(comp->output_ports, index);
 }
@@ -491,7 +489,7 @@ bt_component_port_connected(
        typedef enum bt_component_class_port_connected_method_status (*method_t)(
                void *, void *, const void *);
 
-       enum bt_self_component_add_port_status status =
+       enum bt_component_class_port_connected_method_status status =
                BT_FUNC_STATUS_OK;
        method_t method = NULL;
 
@@ -509,7 +507,7 @@ bt_component_port_connected(
                        method = (method_t) src_cc->methods.output_port_connected;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
@@ -526,7 +524,7 @@ bt_component_port_connected(
                        method = (method_t) flt_cc->methods.output_port_connected;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
@@ -540,13 +538,13 @@ bt_component_port_connected(
                        method = (method_t) sink_cc->methods.input_port_connected;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        if (method) {
@@ -561,6 +559,7 @@ bt_component_port_connected(
                        status == BT_FUNC_STATUS_MEMORY_ERROR,
                        "Unexpected returned component status: status=%s",
                        bt_common_func_status_string(status));
+               BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
        }
 
        return status;
@@ -609,10 +608,19 @@ void bt_component_remove_destroy_listener(struct bt_component *component,
 bt_logging_level bt_component_get_logging_level(
                const struct bt_component *component)
 {
-       BT_ASSERT_PRE_NON_NULL(component, "Component");
+       BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
        return component->log_level;
 }
 
+uint64_t bt_self_component_get_graph_mip_version(
+               bt_self_component *self_component)
+{
+       struct bt_component *comp = (void *) self_component;
+
+       BT_ASSERT_PRE_NON_NULL(self_component, "Component");
+       return bt_component_borrow_graph(comp)->mip_version;
+}
+
 void bt_component_get_ref(const struct bt_component *component)
 {
        bt_object_get_ref(component);