X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fgraph.c;h=d07762494966daaf7df3053abdf3216b7e3626cb;hb=1353b066072e6c389ff35853bac83f65597e7a6a;hp=b545a8ef234b247e9a0731902c4fb9d732bd6d41;hpb=43c59509042845f8d42c3e99ec74d45fa2dc0908;p=babeltrace.git diff --git a/src/lib/graph/graph.c b/src/lib/graph/graph.c index b545a8ef..d0776249 100644 --- a/src/lib/graph/graph.c +++ b/src/lib/graph/graph.c @@ -1,32 +1,15 @@ /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 2017 Jérémie Galarneau - * - * 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 - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. */ #define BT_LOG_TAG "LIB/GRAPH" #include "lib/logging.h" #include "common/assert.h" -#include "lib/assert-pre.h" -#include "lib/assert-post.h" +#include "lib/assert-cond.h" #include #include #include @@ -187,13 +170,15 @@ void notify_message_graph_is_destroyed(struct bt_message *msg) bt_message_unlink_graph(msg); } +BT_EXPORT struct bt_graph *bt_graph_create(uint64_t mip_version) { struct bt_graph *graph; int ret; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE(mip_version <= bt_get_maximal_mip_version(), + BT_ASSERT_PRE("valid-mip-version", + mip_version <= bt_get_maximal_mip_version(), "Unknown MIP version: mip-version=%" PRIu64 ", " "max-mip-version=%" PRIu64, mip_version, bt_get_maximal_mip_version()); @@ -313,6 +298,7 @@ error: goto end; } +BT_EXPORT enum bt_graph_connect_ports_status bt_graph_connect_ports( struct bt_graph *graph, const struct bt_port_output *upstream_port_out, @@ -329,20 +315,25 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( bool init_can_consume; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(upstream_port, "Upstream port"); - BT_ASSERT_PRE_NON_NULL(downstream_port, "Downstream port port"); - BT_ASSERT_PRE( + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_NON_NULL("upstream-port", upstream_port, "Upstream port"); + BT_ASSERT_PRE_NON_NULL("downstream-port", downstream_port, + "Downstream port port"); + BT_ASSERT_PRE("graph-is-not-configured", graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not in the \"configuring\" state: %!+g", graph); - BT_ASSERT_PRE(!bt_port_is_connected(upstream_port), + BT_ASSERT_PRE("upstream-port-is-not-connected", + !bt_port_is_connected(upstream_port), "Upstream port is already connected: %!+p", upstream_port); - BT_ASSERT_PRE(!bt_port_is_connected(downstream_port), + BT_ASSERT_PRE("downstream-port-is-not-connected", + !bt_port_is_connected(downstream_port), "Downstream port is already connected: %!+p", downstream_port); - BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port), + BT_ASSERT_PRE("upstream-port-has-component", + bt_port_borrow_component_inline((void *) upstream_port), "Upstream port does not belong to a component: %!+p", upstream_port); - BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port), + BT_ASSERT_PRE("downstream-port-has-component", + bt_port_borrow_component_inline((void *) downstream_port), "Downstream port does not belong to a component: %!+p", downstream_port); init_can_consume = graph->can_consume; @@ -443,6 +434,8 @@ end: return status; } +#define CONSUME_METHOD_NAME "bt_component_class_sink_consume_method" + static inline int consume_graph_sink(struct bt_component_sink *comp) { @@ -456,14 +449,16 @@ int consume_graph_sink(struct bt_component_sink *comp) consume_status = sink_class->methods.consume((void *) comp); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(consume_status)); - BT_ASSERT_POST_DEV(consume_status == BT_FUNC_STATUS_OK || + BT_ASSERT_POST_DEV(CONSUME_METHOD_NAME, "valid-status", + consume_status == BT_FUNC_STATUS_OK || consume_status == BT_FUNC_STATUS_END || consume_status == BT_FUNC_STATUS_AGAIN || consume_status == BT_FUNC_STATUS_ERROR || consume_status == BT_FUNC_STATUS_MEMORY_ERROR, "Invalid component status returned by consuming method: " "status=%s", bt_common_func_status_string(consume_status)); - BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status); + BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(CONSUME_METHOD_NAME, + consume_status); if (consume_status) { if (consume_status < 0) { BT_LIB_LOGW_APPEND_CAUSE( @@ -516,7 +511,6 @@ end: return status; } -BT_HIDDEN int bt_graph_consume_sink_no_check(struct bt_graph *graph, struct bt_component_sink *sink) { @@ -550,13 +544,14 @@ end: } static inline -int consume_no_check(struct bt_graph *graph) +int consume_no_check(struct bt_graph *graph, const char *api_func) { int status = BT_FUNC_STATUS_OK; struct bt_component *sink; GList *current_node; - BT_ASSERT_PRE_DEV(graph->has_sink, + BT_ASSERT_PRE_DEV_FROM_FUNC(api_func, + "graph-has-at-least-one-sink-component", graph->has_sink, "Graph has no sink component: %!+g", graph); BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph); @@ -575,45 +570,127 @@ end: return status; } +#define GRAPH_IS_CONFIGURED_METHOD_NAME \ + "bt_component_class_sink_graph_is_configured_method" + +static +int configure_graph(struct bt_graph *graph, const char *api_func) +{ + int status = BT_FUNC_STATUS_OK; + uint64_t i; + + BT_ASSERT_DBG(graph->config_state != + BT_GRAPH_CONFIGURATION_STATE_FAULTY); + + if (G_LIKELY(graph->config_state == + BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) { + goto end; + } + + BT_ASSERT_PRE_FROM_FUNC(api_func, + "graph-has-at-least-one-sink-component", + graph->has_sink, "Graph has no sink component: %!+g", graph); + graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED; + + for (i = 0; i < graph->components->len; i++) { + struct bt_component *comp = graph->components->pdata[i]; + struct bt_component_sink *comp_sink = (void *) comp; + struct bt_component_class_sink *comp_cls_sink = + (void *) comp->class; + + if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { + continue; + } + + if (comp_sink->graph_is_configured_method_called) { + continue; + } + + if (comp_cls_sink->methods.graph_is_configured) { + enum bt_component_class_sink_graph_is_configured_method_status comp_status; + + BT_LIB_LOGD("Calling user's \"graph is configured\" method: " + "%![graph-]+g, %![comp-]+c", + graph, comp); + comp_status = comp_cls_sink->methods.graph_is_configured( + (void *) comp_sink); + BT_LIB_LOGD("User method returned: status=%s", + bt_common_func_status_string(comp_status)); + BT_ASSERT_POST(GRAPH_IS_CONFIGURED_METHOD_NAME, + "valid-status", + comp_status == BT_FUNC_STATUS_OK || + comp_status == BT_FUNC_STATUS_ERROR || + comp_status == BT_FUNC_STATUS_MEMORY_ERROR, + "Unexpected returned status: status=%s", + bt_common_func_status_string(comp_status)); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + GRAPH_IS_CONFIGURED_METHOD_NAME, comp_status); + if (comp_status != BT_FUNC_STATUS_OK) { + if (comp_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Component's \"graph is configured\" method failed: " + "%![comp-]+c, status=%s", + comp, + bt_common_func_status_string( + comp_status)); + } + + status = comp_status; + goto end; + } + } + + comp_sink->graph_is_configured_method_called = true; + } + + graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED; + +end: + return status; +} + +BT_EXPORT enum bt_graph_run_once_status bt_graph_run_once(struct bt_graph *graph) { enum bt_graph_run_once_status status; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_DEV_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_DEV(graph->can_consume, + BT_ASSERT_PRE_DEV_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_DEV("graph-can-consume", graph->can_consume, "Cannot consume graph in its current state: %!+g", graph); - BT_ASSERT_PRE_DEV(graph->config_state != - BT_GRAPH_CONFIGURATION_STATE_FAULTY, + BT_ASSERT_PRE_DEV("graph-is-not-faulty", + graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, "Graph is in a faulty state: %!+g", graph); bt_graph_set_can_consume(graph, false); - status = bt_graph_configure(graph); + status = configure_graph(graph, __func__); if (G_UNLIKELY(status)) { - /* bt_graph_configure() logs errors */ + /* configure_graph() logs errors */ goto end; } - status = consume_no_check(graph); + status = consume_no_check(graph, __func__); bt_graph_set_can_consume(graph, true); end: return status; } +BT_EXPORT enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) { enum bt_graph_run_status status; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE(graph->can_consume, + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE("graph-can-consume", graph->can_consume, "Cannot consume graph in its current state: %!+g", graph); - BT_ASSERT_PRE(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, + BT_ASSERT_PRE("graph-is-not-faulty", + graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, "Graph is in a faulty state: %!+g", graph); bt_graph_set_can_consume(graph, false); - status = bt_graph_configure(graph); + status = configure_graph(graph, __func__); if (G_UNLIKELY(status)) { - /* bt_graph_configure() logs errors */ + /* configure_graph() logs errors */ goto end; } @@ -633,7 +710,7 @@ enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) goto end; } - status = consume_no_check(graph); + status = consume_no_check(graph, __func__); if (G_UNLIKELY(status == BT_FUNC_STATUS_AGAIN)) { /* * If AGAIN is received and there are multiple @@ -670,6 +747,7 @@ end: return status; } +BT_EXPORT enum bt_graph_add_listener_status bt_graph_add_source_component_output_port_added_listener( struct bt_graph *graph, @@ -683,8 +761,8 @@ bt_graph_add_source_component_output_port_added_listener( bt_listener_id listener_id; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func); g_array_append_val(graph->listeners.source_output_port_added, listener); listener_id = graph->listeners.source_output_port_added->len - 1; BT_LIB_LOGD("Added \"source component output port added\" listener to graph: " @@ -698,6 +776,7 @@ bt_graph_add_source_component_output_port_added_listener( return BT_FUNC_STATUS_OK; } +BT_EXPORT enum bt_graph_add_listener_status bt_graph_add_filter_component_output_port_added_listener( struct bt_graph *graph, @@ -711,8 +790,8 @@ bt_graph_add_filter_component_output_port_added_listener( bt_listener_id listener_id; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func); g_array_append_val(graph->listeners.filter_output_port_added, listener); listener_id = graph->listeners.filter_output_port_added->len - 1; BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: " @@ -726,6 +805,7 @@ bt_graph_add_filter_component_output_port_added_listener( return BT_FUNC_STATUS_OK; } +BT_EXPORT enum bt_graph_add_listener_status bt_graph_add_filter_component_input_port_added_listener( struct bt_graph *graph, @@ -739,8 +819,8 @@ bt_graph_add_filter_component_input_port_added_listener( bt_listener_id listener_id; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func); g_array_append_val(graph->listeners.filter_input_port_added, listener); listener_id = graph->listeners.filter_input_port_added->len - 1; BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: " @@ -754,6 +834,7 @@ bt_graph_add_filter_component_input_port_added_listener( return BT_FUNC_STATUS_OK; } +BT_EXPORT enum bt_graph_add_listener_status bt_graph_add_sink_component_input_port_added_listener( struct bt_graph *graph, @@ -767,8 +848,8 @@ bt_graph_add_sink_component_input_port_added_listener( bt_listener_id listener_id; BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func); g_array_append_val(graph->listeners.sink_input_port_added, listener); listener_id = graph->listeners.sink_input_port_added->len - 1; BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: " @@ -782,7 +863,6 @@ bt_graph_add_sink_component_input_port_added_listener( return BT_FUNC_STATUS_OK; } -BT_HIDDEN enum bt_graph_listener_func_status bt_graph_notify_port_added( struct bt_graph *graph, struct bt_port *port) { @@ -790,6 +870,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added( GArray *listeners; struct bt_component *comp; enum bt_graph_listener_func_status status = BT_FUNC_STATUS_OK; + const char *func_name; BT_ASSERT(graph); BT_ASSERT(port); @@ -804,6 +885,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added( switch (port->type) { case BT_PORT_TYPE_OUTPUT: listeners = graph->listeners.source_output_port_added; + func_name = "bt_graph_source_component_output_port_added_listener_func"; break; default: bt_common_abort(); @@ -816,9 +898,11 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added( switch (port->type) { case BT_PORT_TYPE_INPUT: listeners = graph->listeners.filter_input_port_added; + func_name = "bt_graph_filter_component_input_port_added_listener_func"; break; case BT_PORT_TYPE_OUTPUT: listeners = graph->listeners.filter_output_port_added; + func_name = "bt_graph_filter_component_output_port_added_listener_func"; break; default: bt_common_abort(); @@ -831,6 +915,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added( switch (port->type) { case BT_PORT_TYPE_INPUT: listeners = graph->listeners.sink_input_port_added; + func_name = "bt_graph_sink_component_input_port_added_listener_func"; break; default: bt_common_abort(); @@ -850,7 +935,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added( BT_ASSERT(listener->func); status = listener->func(comp, port, listener->data); - BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(func_name, status); if (status != BT_FUNC_STATUS_OK) { goto end; } @@ -860,7 +945,6 @@ end: return status; } -BT_HIDDEN void bt_graph_remove_connection(struct bt_graph *graph, struct bt_connection *connection) { @@ -881,7 +965,7 @@ bool component_name_exists(struct bt_graph *graph, const char *name) struct bt_component *other_comp = graph->components->pdata[i]; if (strcmp(name, bt_component_get_name(other_comp)) == 0) { - BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: " + BT_ASSERT_COND_MSG("Another component with the same name already exists in the graph: " "%![other-comp-]+c, name=\"%s\"", other_comp, name); exists = true; @@ -900,7 +984,9 @@ int add_component_with_init_method_data( comp_init_method_t init_method, const char *name, const struct bt_value *params, void *init_method_data, bt_logging_level log_level, - const struct bt_component **user_component) + const struct bt_component **user_component, + const char *api_func, + const char *init_method_name) { int status = BT_FUNC_STATUS_OK; enum bt_component_class_initialize_method_status init_status; @@ -910,15 +996,15 @@ int add_component_with_init_method_data( struct bt_value *new_params = NULL; BT_ASSERT(comp_cls); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE( + BT_ASSERT_PRE_GRAPH_NON_NULL_FROM_FUNC(api_func, graph); + BT_ASSERT_PRE_NAME_NON_NULL_FROM_FUNC(api_func, name); + BT_ASSERT_PRE_FROM_FUNC(api_func, "graph-is-not-configured", graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not in the \"configuring\" state: %!+g", graph); - BT_ASSERT_PRE(!component_name_exists(graph, name), + BT_ASSERT_PRE_FROM_FUNC(api_func, "component-name-is-unique", + !component_name_exists(graph, name), "Duplicate component name: %!+g, name=\"%s\"", graph, name); - BT_ASSERT_PRE(!params || bt_value_is_map(params), - "Parameter value is not a map value: %!+v", params); + BT_ASSERT_PRE_PARAM_VALUE_IS_MAP_FROM_FUNC(api_func, params); init_can_consume = graph->can_consume; bt_graph_set_can_consume(graph, false); BT_LIB_LOGI("Adding component to graph: " @@ -967,7 +1053,8 @@ int add_component_with_init_method_data( init_status = init_method(component, NULL, params, init_method_data); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(init_status)); - BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_status); + BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_method_name, + init_status); if (init_status != BT_FUNC_STATUS_OK) { if (init_status < 0) { BT_LIB_LOGW_APPEND_CAUSE( @@ -1030,21 +1117,38 @@ end: return status; } +static enum bt_graph_add_component_status -bt_graph_add_source_component_with_initialize_method_data( +add_source_component_with_initialize_method_data( struct bt_graph *graph, const struct bt_component_class_source *comp_cls, const char *name, const struct bt_value *params, void *init_method_data, bt_logging_level log_level, - const struct bt_component_source **component) + const struct bt_component_source **component, + const char *api_func) { - BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_COMP_CLS_NON_NULL_FROM_FUNC(api_func, comp_cls); return add_component_with_init_method_data(graph, (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, - name, params, init_method_data, log_level, (void *) component); + name, params, init_method_data, log_level, (void *) component, + api_func, "bt_component_class_source_initialize_method"); } +BT_EXPORT +enum bt_graph_add_component_status +bt_graph_add_source_component_with_initialize_method_data( + struct bt_graph *graph, + const struct bt_component_class_source *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, bt_logging_level log_level, + const struct bt_component_source **component) +{ + return add_source_component_with_initialize_method_data(graph, comp_cls, + name, params, init_method_data, log_level, component, __func__); +} + +BT_EXPORT enum bt_graph_add_component_status bt_graph_add_source_component( struct bt_graph *graph, const struct bt_component_class_source *comp_cls, @@ -1052,26 +1156,42 @@ enum bt_graph_add_component_status bt_graph_add_source_component( enum bt_logging_level log_level, const struct bt_component_source **component) { - BT_ASSERT_PRE_NO_ERROR(); - return bt_graph_add_source_component_with_initialize_method_data( - graph, comp_cls, name, params, NULL, log_level, component); + return add_source_component_with_initialize_method_data(graph, comp_cls, + name, params, NULL, log_level, component, __func__); } +static enum bt_graph_add_component_status -bt_graph_add_filter_component_with_initialize_method_data( +add_filter_component_with_initialize_method_data( struct bt_graph *graph, const struct bt_component_class_filter *comp_cls, const char *name, const struct bt_value *params, - void *init_method_data, enum bt_logging_level log_level, - const struct bt_component_filter **component) + void *init_method_data, bt_logging_level log_level, + const struct bt_component_filter **component, + const char *api_func) { - BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_COMP_CLS_NON_NULL_FROM_FUNC(api_func, comp_cls); return add_component_with_init_method_data(graph, (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, - name, params, init_method_data, log_level, (void *) component); + name, params, init_method_data, log_level, (void *) component, + api_func, "bt_component_class_filter_initialize_method"); } +BT_EXPORT +enum bt_graph_add_component_status +bt_graph_add_filter_component_with_initialize_method_data( + struct bt_graph *graph, + const struct bt_component_class_filter *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, bt_logging_level log_level, + const struct bt_component_filter **component) +{ + return add_filter_component_with_initialize_method_data(graph, comp_cls, + name, params, init_method_data, log_level, component, __func__); +} + +BT_EXPORT enum bt_graph_add_component_status bt_graph_add_filter_component( struct bt_graph *graph, const struct bt_component_class_filter *comp_cls, @@ -1079,26 +1199,43 @@ enum bt_graph_add_component_status bt_graph_add_filter_component( enum bt_logging_level log_level, const struct bt_component_filter **component) { - BT_ASSERT_PRE_NO_ERROR(); - return bt_graph_add_filter_component_with_initialize_method_data( - graph, comp_cls, name, params, NULL, log_level, component); + return add_filter_component_with_initialize_method_data(graph, comp_cls, + name, params, NULL, log_level, component, __func__); } +static enum bt_graph_add_component_status -bt_graph_add_sink_component_with_initialize_method_data( +add_sink_component_with_initialize_method_data( struct bt_graph *graph, const struct bt_component_class_sink *comp_cls, const char *name, const struct bt_value *params, - void *init_method_data, enum bt_logging_level log_level, - const struct bt_component_sink **component) + void *init_method_data, bt_logging_level log_level, + const struct bt_component_sink **component, + const char *api_func) { - BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_COMP_CLS_NON_NULL_FROM_FUNC(api_func, comp_cls); return add_component_with_init_method_data(graph, (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, - name, params, init_method_data, log_level, (void *) component); + name, params, init_method_data, log_level, (void *) component, + api_func, "bt_component_class_sink_initialize_method"); } +BT_EXPORT +enum bt_graph_add_component_status +bt_graph_add_sink_component_with_initialize_method_data( + struct bt_graph *graph, + const struct bt_component_class_sink *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, bt_logging_level log_level, + const struct bt_component_sink **component) +{ + return add_sink_component_with_initialize_method_data(graph, comp_cls, + name, params, init_method_data, log_level, component, + __func__); +} + +BT_EXPORT enum bt_graph_add_component_status bt_graph_add_sink_component( struct bt_graph *graph, const struct bt_component_class_sink *comp_cls, @@ -1106,11 +1243,11 @@ enum bt_graph_add_component_status bt_graph_add_sink_component( enum bt_logging_level log_level, const struct bt_component_sink **component) { - BT_ASSERT_PRE_NO_ERROR(); - return bt_graph_add_sink_component_with_initialize_method_data( - graph, comp_cls, name, params, NULL, log_level, component); + return add_sink_component_with_initialize_method_data(graph, comp_cls, + name, params, NULL, log_level, component, __func__); } +BT_EXPORT enum bt_graph_add_component_status bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name, bt_graph_simple_sink_component_initialize_func init_func, @@ -1131,9 +1268,10 @@ bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name, /* * Other preconditions are checked by - * bt_graph_add_sink_component_with_init_method_data(). + * add_sink_component_with_initialize_method_data(). */ - BT_ASSERT_PRE_NON_NULL(consume_func, "Consume function"); + BT_ASSERT_PRE_NON_NULL("consume-function", consume_func, + "Consume function"); comp_cls = bt_component_class_sink_simple_borrow(); if (!comp_cls) { @@ -1143,15 +1281,14 @@ bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name, goto end; } - status = bt_graph_add_sink_component_with_initialize_method_data(graph, + status = add_sink_component_with_initialize_method_data(graph, comp_cls, name, NULL, &init_method_data, - BT_LOGGING_LEVEL_NONE, component); + BT_LOGGING_LEVEL_NONE, component, __func__); end: return status; } -BT_HIDDEN void bt_graph_add_message(struct bt_graph *graph, struct bt_message *msg) { @@ -1169,19 +1306,19 @@ void bt_graph_add_message(struct bt_graph *graph, g_ptr_array_add(graph->messages, msg); } -BT_HIDDEN bool bt_graph_is_interrupted(const struct bt_graph *graph) { BT_ASSERT_DBG(graph); return bt_interrupter_array_any_is_set(graph->interrupters); } +BT_EXPORT enum bt_graph_add_interrupter_status bt_graph_add_interrupter( struct bt_graph *graph, const struct bt_interrupter *intr) { BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(intr, "Interrupter"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); + BT_ASSERT_PRE_INTR_NON_NULL(intr); g_ptr_array_add(graph->interrupters, (void *) intr); bt_object_get_ref_no_null_check(intr); BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z", @@ -1189,17 +1326,20 @@ enum bt_graph_add_interrupter_status bt_graph_add_interrupter( return BT_FUNC_STATUS_OK; } +BT_EXPORT struct bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph) { - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_GRAPH_NON_NULL(graph); return graph->default_interrupter; } +BT_EXPORT void bt_graph_get_ref(const struct bt_graph *graph) { bt_object_get_ref(graph); } +BT_EXPORT void bt_graph_put_ref(const struct bt_graph *graph) { bt_object_put_ref(graph);