/*
- * port.c
- *
- * Babeltrace Port
- *
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
#define BT_LOG_TAG "PORT"
#include <babeltrace/lib-logging-internal.h>
-#include <babeltrace/graph/port.h>
+#include <babeltrace/assert-internal.h>
+#include <babeltrace/assert-pre-internal.h>
+#include <babeltrace/graph/port-const.h>
+#include <babeltrace/graph/port-input-const.h>
+#include <babeltrace/graph/port-output-const.h>
+#include <babeltrace/graph/self-component-port.h>
+#include <babeltrace/graph/self-component-port-input.h>
+#include <babeltrace/graph/self-component-port-output.h>
#include <babeltrace/graph/component-internal.h>
#include <babeltrace/graph/port-internal.h>
#include <babeltrace/graph/connection-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/compiler-internal.h>
-#include <babeltrace/assert-internal.h>
static
-void bt_port_destroy(struct bt_object *obj)
+void destroy_port(struct bt_object *obj)
{
- struct bt_port *port = container_of(obj, struct bt_port, base);
+ struct bt_port *port = (void *) obj;
- BT_LOGD("Destroying port: addr=%p, name=\"%s\", comp-addr=%p",
- port, bt_port_get_name(port), obj->parent);
+ BT_LIB_LOGD("Destroying port: %!+p", port);
if (port->name) {
g_string_free(port->name, TRUE);
+ port->name = NULL;
}
g_free(port);
}
-struct bt_port *bt_port_borrow_from_private(
- struct bt_private_port *private_port)
-{
- return (void *) private_port;
-}
-
BT_HIDDEN
struct bt_port *bt_port_create(struct bt_component *parent_component,
enum bt_port_type type, const char *name, void *user_data)
BT_ASSERT(name);
BT_ASSERT(parent_component);
BT_ASSERT(type == BT_PORT_TYPE_INPUT || type == BT_PORT_TYPE_OUTPUT);
-
- if (strlen(name) == 0) {
- BT_LOGW_STR("Invalid parameter: name is an empty string.");
- goto end;
- }
-
+ BT_ASSERT(strlen(name) > 0);
port = g_new0(struct bt_port, 1);
if (!port) {
BT_LOGE_STR("Failed to allocate one port.");
goto end;
}
- BT_LOGD("Creating port for component: "
- "comp-addr=%p, comp-name=\"%s\", port-type=%s, "
- "port-name=\"%s\"",
- parent_component, bt_component_get_name(parent_component),
- bt_port_type_string(type), name);
-
- bt_object_init_shared_with_parent(&port->base, bt_port_destroy);
+ BT_LIB_LOGD("Creating port for component: %![comp-]+c, port-type=%s, "
+ "port-name=\"%s\"", parent_component, bt_port_type_string(type),
+ name);
+ bt_object_init_shared_with_parent(&port->base, destroy_port);
port->name = g_string_new(name);
if (!port->name) {
BT_LOGE_STR("Failed to allocate one GString.");
port->type = type;
port->user_data = user_data;
bt_object_set_parent(&port->base, &parent_component->base);
- BT_LOGD("Created port for component: "
- "comp-addr=%p, comp-name=\"%s\", port-type=%s, "
- "port-name=\"%s\", port-addr=%p",
- parent_component, bt_component_get_name(parent_component),
- bt_port_type_string(type), name, port);
+ BT_LIB_LOGD("Created port for component: "
+ "%![comp-]+c, %![port-]+p", parent_component, port);
end:
return port;
}
-const char *bt_port_get_name(struct bt_port *port)
-{
- return port ? port->name->str : NULL;
-}
-
-enum bt_port_type bt_port_get_type(struct bt_port *port)
+const char *bt_port_get_name(const struct bt_port *port)
{
- return port ? port->type : BT_PORT_TYPE_UNKOWN;
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return port->name->str;
}
-struct bt_connection *bt_port_get_connection(struct bt_port *port)
+enum bt_port_type bt_port_get_type(const struct bt_port *port)
{
- struct bt_connection *connection = NULL;
-
- if (!port) {
- BT_LOGW_STR("Invalid parameter: port is NULL.");
- goto end;
- }
-
- if (!port->connection) {
- /* Not an error: means disconnected */
- goto end;
- }
-
- connection = bt_object_get_ref(port->connection);
-
-end:
- return connection;
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return port->type;
}
-struct bt_component *bt_port_get_component(struct bt_port *port)
+const struct bt_connection *bt_port_borrow_connection_const(
+ const struct bt_port *port)
{
- return (struct bt_component *) bt_object_get_parent(&port->base);
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return port->connection;
}
-struct bt_private_connection *bt_private_port_get_private_connection(
- struct bt_private_port *private_port)
+const struct bt_component *bt_port_borrow_component_const(
+ const struct bt_port *port)
{
- return bt_private_connection_from_connection(bt_port_get_connection(
- bt_port_borrow_from_private(private_port)));
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return bt_port_borrow_component_inline(port);
}
-struct bt_private_component *bt_private_port_get_private_component(
- struct bt_private_port *private_port)
+struct bt_self_component *bt_self_component_port_borrow_component(
+ struct bt_self_component_port *port)
{
- return bt_private_component_from_component(bt_port_get_component(
- bt_port_borrow_from_private(private_port)));
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return (void *) bt_object_borrow_parent((void *) port);
}
BT_HIDDEN
* connection exists.
*/
port->connection = connection;
- BT_LOGV("Set port's connection: "
- "port-addr=%p, port-name=\"%s\", conn-addr=%p",
- port, bt_port_get_name(port), connection);
+ BT_LIB_LOGV("Set port's connection: %![port-]+p, %![conn-]+x", port,
+ connection);
}
-enum bt_port_status bt_private_port_remove_from_component(
- struct bt_private_port *private_port)
+static inline
+bool port_connection_iterators_are_finalized(struct bt_port *port)
{
- enum bt_port_status status = BT_PORT_STATUS_OK;
- struct bt_port *port = bt_port_borrow_from_private(private_port);
- struct bt_component *comp = NULL;
- enum bt_component_status comp_status;
+ bool ret = true;
+ struct bt_connection *conn = port->connection;
+ uint64_t i;
- if (!port) {
- BT_LOGW_STR("Invalid parameter: private port is NULL.");
- status = BT_PORT_STATUS_INVALID;
+ if (!conn) {
goto end;
}
- comp = (void *) bt_object_get_parent(&port->base);
- if (!comp) {
- BT_LOGV("Port already removed from its component: "
- "port-addr=%p, port-name=\"%s\", ",
- port, bt_port_get_name(port));
- goto end;
- }
+ for (i = 0; i < conn->iterators->len; i++) {
+ struct bt_self_component_port_input_message_iterator *iterator =
+ conn->iterators->pdata[i];
- /* bt_component_remove_port() logs details */
- comp_status = bt_component_remove_port(comp, port);
- BT_ASSERT(comp_status != BT_COMPONENT_STATUS_INVALID);
- if (comp_status < 0) {
- status = BT_PORT_STATUS_ERROR;
- goto end;
+ BT_ASSERT(iterator);
+
+ if (iterator->state != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING &&
+ iterator->state != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED) {
+ BT_ASSERT_PRE_MSG("Message iterator is not being finalized or finalized: "
+ "%!+i", iterator);
+ ret = false;
+ goto end;
+ }
}
end:
- bt_object_put_ref(comp);
- return status;
+ return ret;
}
-enum bt_port_status bt_port_disconnect(struct bt_port *port)
+enum bt_self_component_port_status bt_self_component_port_remove_from_component(
+ struct bt_self_component_port *self_port)
{
- enum bt_port_status status = BT_PORT_STATUS_OK;
+ struct bt_port *port = (void *) self_port;
+ struct bt_component *comp = NULL;
- if (!port) {
- BT_LOGW_STR("Invalid parameter: port is NULL.");
- status = BT_PORT_STATUS_INVALID;
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ BT_ASSERT_PRE(port_connection_iterators_are_finalized(port),
+ "At least one message iterator using this port has the wrong state.");
+ comp = (void *) bt_object_borrow_parent(&port->base);
+ if (!comp) {
+ BT_LIB_LOGV("Port already removed from its component: %!+p",
+ port);
goto end;
}
- if (port->connection) {
- bt_connection_end(port->connection, true);
- BT_LOGV("Disconnected port: "
- "port-addr=%p, port-name=\"%s\"",
- port, bt_port_get_name(port));
- }
+ /* bt_component_remove_port() logs details */
+ bt_component_remove_port(comp, port);
end:
- return status;
+ return BT_SELF_PORT_STATUS_OK;
}
-bt_bool bt_port_is_connected(struct bt_port *port)
+bt_bool bt_port_is_connected(const struct bt_port *port)
{
- int ret;
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return port->connection ? BT_TRUE : BT_FALSE;
+}
- if (!port) {
- BT_LOGW_STR("Invalid parameter: port is NULL.");
- ret = -1;
- goto end;
- }
+void *bt_self_component_port_get_data(const struct bt_self_component_port *port)
+{
+ BT_ASSERT_PRE_NON_NULL(port, "Port");
+ return ((struct bt_port *) port)->user_data;
+}
- ret = port->connection ? 1 : 0;
+void bt_port_get_ref(const struct bt_port *port)
+{
+ bt_object_get_ref(port);
+}
-end:
- return ret;
+void bt_port_put_ref(const struct bt_port *port)
+{
+ bt_object_put_ref(port);
+}
+
+void bt_port_input_get_ref(const struct bt_port_input *port_input)
+{
+ bt_object_get_ref(port_input);
+}
+
+void bt_port_input_put_ref(const struct bt_port_input *port_input)
+{
+ bt_object_put_ref(port_input);
+}
+
+void bt_port_output_get_ref(const struct bt_port_output *port_output)
+{
+ bt_object_get_ref(port_output);
}
-void *bt_private_port_get_user_data(
- struct bt_private_port *private_port)
+void bt_port_output_put_ref(const struct bt_port_output *port_output)
{
- return private_port ?
- bt_port_borrow_from_private(private_port)->user_data : NULL;
+ bt_object_put_ref(port_output);
}