Commit | Line | Data |
---|---|---|
8b285017 | 1 | /* |
f2b0325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
8b285017 | 3 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
8b285017 JG |
4 | * |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
f3034355 PP |
24 | #define BT_LOG_TAG "PORT" |
25 | #include <babeltrace/lib-logging-internal.h> | |
26 | ||
7b53201c PP |
27 | #include <babeltrace/graph/port-const.h> |
28 | #include <babeltrace/graph/port-input-const.h> | |
29 | #include <babeltrace/graph/port-output-const.h> | |
834e9996 PP |
30 | #include <babeltrace/graph/self-component-port.h> |
31 | #include <babeltrace/graph/self-component-port-input.h> | |
32 | #include <babeltrace/graph/self-component-port-output.h> | |
b2e0c907 PP |
33 | #include <babeltrace/graph/component-internal.h> |
34 | #include <babeltrace/graph/port-internal.h> | |
35 | #include <babeltrace/graph/connection-internal.h> | |
8b285017 | 36 | #include <babeltrace/object-internal.h> |
834e9996 | 37 | #include <babeltrace/object.h> |
3d9990ac | 38 | #include <babeltrace/compiler-internal.h> |
8b45963b | 39 | #include <babeltrace/assert-internal.h> |
834e9996 | 40 | #include <babeltrace/assert-pre-internal.h> |
8b285017 JG |
41 | |
42 | static | |
834e9996 | 43 | void destroy_port(struct bt_object *obj) |
8b285017 | 44 | { |
834e9996 | 45 | struct bt_port *port = (void *) obj; |
8b285017 | 46 | |
834e9996 | 47 | BT_LIB_LOGD("Destroying port: %!+p", port); |
f3034355 | 48 | |
8b285017 JG |
49 | if (port->name) { |
50 | g_string_free(port->name, TRUE); | |
834e9996 | 51 | port->name = NULL; |
8b285017 | 52 | } |
f3034355 | 53 | |
8b285017 JG |
54 | g_free(port); |
55 | } | |
56 | ||
57 | BT_HIDDEN | |
58 | struct bt_port *bt_port_create(struct bt_component *parent_component, | |
3e9b0023 | 59 | enum bt_port_type type, const char *name, void *user_data) |
8b285017 | 60 | { |
72b913fb | 61 | struct bt_port *port = NULL; |
8b285017 | 62 | |
8b45963b PP |
63 | BT_ASSERT(name); |
64 | BT_ASSERT(parent_component); | |
65 | BT_ASSERT(type == BT_PORT_TYPE_INPUT || type == BT_PORT_TYPE_OUTPUT); | |
834e9996 | 66 | BT_ASSERT(strlen(name) > 0); |
8b285017 JG |
67 | port = g_new0(struct bt_port, 1); |
68 | if (!port) { | |
f3034355 | 69 | BT_LOGE_STR("Failed to allocate one port."); |
8b285017 JG |
70 | goto end; |
71 | } | |
72 | ||
834e9996 PP |
73 | BT_LIB_LOGD("Creating port for component: %![comp-]+c, port-type=%s, " |
74 | "port-name=\"%s\"", parent_component, bt_port_type_string(type), | |
75 | name); | |
76 | bt_object_init_shared_with_parent(&port->base, destroy_port); | |
8b285017 JG |
77 | port->name = g_string_new(name); |
78 | if (!port->name) { | |
f3034355 | 79 | BT_LOGE_STR("Failed to allocate one GString."); |
8138bfe1 | 80 | BT_OBJECT_PUT_REF_AND_RESET(port); |
8b285017 JG |
81 | goto end; |
82 | } | |
83 | ||
84 | port->type = type; | |
3e9b0023 | 85 | port->user_data = user_data; |
1d7bf349 | 86 | bt_object_set_parent(&port->base, &parent_component->base); |
834e9996 PP |
87 | BT_LIB_LOGD("Created port for component: " |
88 | "%![comp-]+c, %![port-]+p", parent_component, port); | |
f3034355 | 89 | |
8b285017 JG |
90 | end: |
91 | return port; | |
92 | } | |
93 | ||
7b53201c | 94 | const char *bt_port_get_name(const struct bt_port *port) |
8b285017 | 95 | { |
834e9996 PP |
96 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
97 | return port->name->str; | |
8b285017 JG |
98 | } |
99 | ||
7b53201c | 100 | enum bt_port_type bt_port_get_type(const struct bt_port *port) |
8b285017 | 101 | { |
834e9996 PP |
102 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
103 | return port->type; | |
8b285017 JG |
104 | } |
105 | ||
7b53201c PP |
106 | const struct bt_connection *bt_port_borrow_connection_const( |
107 | const struct bt_port *port) | |
8b285017 | 108 | { |
834e9996 PP |
109 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
110 | return port->connection; | |
8b285017 JG |
111 | } |
112 | ||
7b53201c PP |
113 | const struct bt_component *bt_port_borrow_component_const( |
114 | const struct bt_port *port) | |
890882ef | 115 | { |
834e9996 | 116 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
7b53201c | 117 | return bt_port_borrow_component_inline(port); |
890882ef PP |
118 | } |
119 | ||
834e9996 PP |
120 | struct bt_self_component *bt_self_component_port_borrow_component( |
121 | struct bt_self_component_port *port) | |
890882ef | 122 | { |
834e9996 PP |
123 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
124 | return (void *) bt_object_borrow_parent((void *) port); | |
890882ef PP |
125 | } |
126 | ||
8b285017 | 127 | BT_HIDDEN |
72b913fb | 128 | void bt_port_set_connection(struct bt_port *port, |
8b285017 | 129 | struct bt_connection *connection) |
72b913fb PP |
130 | { |
131 | /* | |
132 | * Don't take a reference on connection as its existence is | |
133 | * guaranteed by the existence of the graph in which the | |
134 | * connection exists. | |
135 | */ | |
136 | port->connection = connection; | |
834e9996 PP |
137 | BT_LIB_LOGV("Set port's connection: %![port-]+p, %![conn-]+x", port, |
138 | connection); | |
72b913fb PP |
139 | } |
140 | ||
834e9996 PP |
141 | enum bt_self_component_port_status bt_self_component_port_remove_from_component( |
142 | struct bt_self_component_port *self_port) | |
8b285017 | 143 | { |
834e9996 | 144 | struct bt_port *port = (void *) self_port; |
72b913fb | 145 | struct bt_component *comp = NULL; |
8b285017 | 146 | |
834e9996 | 147 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
8b285017 | 148 | |
834e9996 | 149 | comp = (void *) bt_object_borrow_parent(&port->base); |
a5fb1227 | 150 | if (!comp) { |
834e9996 PP |
151 | BT_LIB_LOGV("Port already removed from its component: %!+p", |
152 | port); | |
a5fb1227 PP |
153 | goto end; |
154 | } | |
f3034355 PP |
155 | |
156 | /* bt_component_remove_port() logs details */ | |
834e9996 | 157 | bt_component_remove_port(comp, port); |
72b913fb | 158 | |
8b285017 | 159 | end: |
834e9996 | 160 | return BT_SELF_PORT_STATUS_OK; |
8b285017 JG |
161 | } |
162 | ||
7b53201c | 163 | bt_bool bt_port_is_connected(const struct bt_port *port) |
8b285017 | 164 | { |
834e9996 PP |
165 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
166 | return port->connection ? BT_TRUE : BT_FALSE; | |
8b285017 | 167 | } |
a45a0b60 | 168 | |
7b53201c | 169 | void *bt_self_component_port_get_data(const struct bt_self_component_port *port) |
a45a0b60 | 170 | { |
834e9996 PP |
171 | BT_ASSERT_PRE_NON_NULL(port, "Port"); |
172 | return ((struct bt_port *) port)->user_data; | |
a45a0b60 | 173 | } |