| 1 | /* |
| 2 | * SPDX-License-Identifier: MIT |
| 3 | * |
| 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| 5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 6 | */ |
| 7 | |
| 8 | #define BT_LOG_TAG "LIB/COMPONENT-FILTER" |
| 9 | #include "lib/logging.h" |
| 10 | |
| 11 | #include "common/assert.h" |
| 12 | #include "lib/assert-cond.h" |
| 13 | #include "compat/compiler.h" |
| 14 | #include <babeltrace2/value.h> |
| 15 | #include <babeltrace2/graph/self-component.h> |
| 16 | #include <babeltrace2/graph/component.h> |
| 17 | #include <babeltrace2/graph/graph.h> |
| 18 | |
| 19 | #include "component-filter.h" |
| 20 | #include "component.h" |
| 21 | #include "component-class.h" |
| 22 | #include "lib/func-status.h" |
| 23 | |
| 24 | struct bt_component *bt_component_filter_create(void) |
| 25 | { |
| 26 | struct bt_component_filter *filter = NULL; |
| 27 | |
| 28 | filter = g_new0(struct bt_component_filter, 1); |
| 29 | if (!filter) { |
| 30 | BT_LIB_LOGE_APPEND_CAUSE( |
| 31 | "Failed to allocate one filter component."); |
| 32 | goto end; |
| 33 | } |
| 34 | |
| 35 | end: |
| 36 | return (void *) filter; |
| 37 | } |
| 38 | |
| 39 | BT_EXPORT |
| 40 | const bt_component_class_filter * |
| 41 | bt_component_filter_borrow_class_const( |
| 42 | const bt_component_filter *component) |
| 43 | { |
| 44 | struct bt_component_class *cls; |
| 45 | |
| 46 | BT_ASSERT_PRE_DEV_COMP_NON_NULL(component); |
| 47 | |
| 48 | cls = component->parent.class; |
| 49 | |
| 50 | BT_ASSERT_DBG(cls); |
| 51 | BT_ASSERT_DBG(cls->type == BT_COMPONENT_CLASS_TYPE_FILTER); |
| 52 | |
| 53 | return (bt_component_class_filter *) cls; |
| 54 | } |
| 55 | |
| 56 | BT_EXPORT |
| 57 | uint64_t bt_component_filter_get_output_port_count( |
| 58 | const struct bt_component_filter *comp) |
| 59 | { |
| 60 | /* bt_component_get_output_port_count() checks preconditions */ |
| 61 | return bt_component_get_output_port_count((void *) comp, __func__); |
| 62 | } |
| 63 | |
| 64 | BT_EXPORT |
| 65 | const struct bt_port_output * |
| 66 | bt_component_filter_borrow_output_port_by_name_const( |
| 67 | const struct bt_component_filter *comp, const char *name) |
| 68 | { |
| 69 | /* |
| 70 | * bt_component_borrow_output_port_by_name() logs details/errors |
| 71 | * and checks preconditions. |
| 72 | */ |
| 73 | return bt_component_borrow_output_port_by_name( |
| 74 | (void *) comp, name, __func__); |
| 75 | } |
| 76 | |
| 77 | BT_EXPORT |
| 78 | struct bt_self_component_port_output * |
| 79 | bt_self_component_filter_borrow_output_port_by_name( |
| 80 | struct bt_self_component_filter *comp, const char *name) |
| 81 | { |
| 82 | /* |
| 83 | * bt_component_borrow_output_port_by_name() logs details/errors |
| 84 | * and checks preconditions. |
| 85 | */ |
| 86 | return (void *) bt_component_borrow_output_port_by_name( |
| 87 | (void *) comp, name, __func__); |
| 88 | } |
| 89 | |
| 90 | BT_EXPORT |
| 91 | const struct bt_port_output * |
| 92 | bt_component_filter_borrow_output_port_by_index_const( |
| 93 | const struct bt_component_filter *comp, uint64_t index) |
| 94 | { |
| 95 | /* |
| 96 | * bt_component_borrow_output_port_by_index() logs |
| 97 | * details/errors and checks preconditions. |
| 98 | */ |
| 99 | return bt_component_borrow_output_port_by_index( |
| 100 | (void *) comp, index, __func__); |
| 101 | } |
| 102 | |
| 103 | BT_EXPORT |
| 104 | struct bt_self_component_port_output * |
| 105 | bt_self_component_filter_borrow_output_port_by_index( |
| 106 | struct bt_self_component_filter *comp, uint64_t index) |
| 107 | { |
| 108 | /* |
| 109 | * bt_component_borrow_output_port_by_index() logs |
| 110 | * details/errors and checks preconditions. |
| 111 | */ |
| 112 | return (void *) bt_component_borrow_output_port_by_index( |
| 113 | (void *) comp, index, __func__); |
| 114 | } |
| 115 | |
| 116 | BT_EXPORT |
| 117 | enum bt_self_component_add_port_status bt_self_component_filter_add_output_port( |
| 118 | struct bt_self_component_filter *self_comp, |
| 119 | const char *name, void *user_data, |
| 120 | struct bt_self_component_port_output **self_port) |
| 121 | { |
| 122 | struct bt_component *comp = (void *) self_comp; |
| 123 | enum bt_self_component_add_port_status status; |
| 124 | struct bt_port *port = NULL; |
| 125 | |
| 126 | /* |
| 127 | * bt_component_add_output_port() logs details/errors and checks |
| 128 | * preconditions. |
| 129 | */ |
| 130 | status = bt_component_add_output_port(comp, name, user_data, &port, |
| 131 | __func__); |
| 132 | if (status != BT_FUNC_STATUS_OK) { |
| 133 | goto end; |
| 134 | } |
| 135 | |
| 136 | if (self_port) { |
| 137 | /* Move reference to user */ |
| 138 | *self_port = (void *) port; |
| 139 | } |
| 140 | |
| 141 | end: |
| 142 | bt_object_put_ref(port); |
| 143 | return status; |
| 144 | } |
| 145 | |
| 146 | BT_EXPORT |
| 147 | uint64_t bt_component_filter_get_input_port_count( |
| 148 | const struct bt_component_filter *component) |
| 149 | { |
| 150 | /* bt_component_get_input_port_count() checks preconditions */ |
| 151 | return bt_component_get_input_port_count((void *) component, __func__); |
| 152 | } |
| 153 | |
| 154 | BT_EXPORT |
| 155 | const struct bt_port_input *bt_component_filter_borrow_input_port_by_name_const( |
| 156 | const struct bt_component_filter *component, const char *name) |
| 157 | { |
| 158 | /* |
| 159 | * bt_component_borrow_input_port_by_name() logs details/errors |
| 160 | * and checks preconditions. |
| 161 | */ |
| 162 | return bt_component_borrow_input_port_by_name( |
| 163 | (void *) component, name, __func__); |
| 164 | } |
| 165 | |
| 166 | BT_EXPORT |
| 167 | struct bt_self_component_port_input * |
| 168 | bt_self_component_filter_borrow_input_port_by_name( |
| 169 | struct bt_self_component_filter *component, const char *name) |
| 170 | { |
| 171 | /* |
| 172 | * bt_component_borrow_input_port_by_name() logs details/errors |
| 173 | * and checks preconditions. |
| 174 | */ |
| 175 | return (void *) bt_component_borrow_input_port_by_name( |
| 176 | (void *) component, name, __func__); |
| 177 | } |
| 178 | |
| 179 | BT_EXPORT |
| 180 | const struct bt_port_input * |
| 181 | bt_component_filter_borrow_input_port_by_index_const( |
| 182 | const struct bt_component_filter *component, uint64_t index) |
| 183 | { |
| 184 | /* |
| 185 | * bt_component_borrow_input_port_by_index() logs details/errors |
| 186 | * and checks preconditions. |
| 187 | */ |
| 188 | return bt_component_borrow_input_port_by_index( |
| 189 | (void *) component, index, __func__); |
| 190 | } |
| 191 | |
| 192 | BT_EXPORT |
| 193 | struct bt_self_component_port_input * |
| 194 | bt_self_component_filter_borrow_input_port_by_index( |
| 195 | struct bt_self_component_filter *component, uint64_t index) |
| 196 | { |
| 197 | /* |
| 198 | * bt_component_borrow_input_port_by_index() logs details/errors |
| 199 | * and checks preconditions. |
| 200 | */ |
| 201 | return (void *) bt_component_borrow_input_port_by_index( |
| 202 | (void *) component, index, __func__); |
| 203 | } |
| 204 | |
| 205 | BT_EXPORT |
| 206 | enum bt_self_component_add_port_status bt_self_component_filter_add_input_port( |
| 207 | struct bt_self_component_filter *self_comp, |
| 208 | const char *name, void *user_data, |
| 209 | struct bt_self_component_port_input **self_port) |
| 210 | { |
| 211 | enum bt_self_component_add_port_status status; |
| 212 | struct bt_port *port = NULL; |
| 213 | struct bt_component *comp = (void *) self_comp; |
| 214 | |
| 215 | /* |
| 216 | * bt_component_add_input_port() logs details/errors and checks |
| 217 | * preconditions. |
| 218 | */ |
| 219 | status = bt_component_add_input_port(comp, name, user_data, &port, |
| 220 | __func__); |
| 221 | if (status != BT_FUNC_STATUS_OK) { |
| 222 | goto end; |
| 223 | } |
| 224 | |
| 225 | if (self_port) { |
| 226 | /* Move reference to user */ |
| 227 | *self_port = (void *) port; |
| 228 | } |
| 229 | |
| 230 | end: |
| 231 | bt_object_put_ref(port); |
| 232 | return status; |
| 233 | } |
| 234 | |
| 235 | BT_EXPORT |
| 236 | void bt_component_filter_get_ref( |
| 237 | const struct bt_component_filter *component_filter) |
| 238 | { |
| 239 | bt_object_get_ref(component_filter); |
| 240 | } |
| 241 | |
| 242 | BT_EXPORT |
| 243 | void bt_component_filter_put_ref( |
| 244 | const struct bt_component_filter *component_filter) |
| 245 | { |
| 246 | bt_object_put_ref(component_filter); |
| 247 | } |