src/lib/graph/component.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   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
  24 #define BT_LOG_TAG "LIB/COMPONENT"
  25 #include "lib/logging.h"
  26
  27 #include "common/common.h"
  28 #include "common/assert.h"
  29 #include "lib/assert-pre.h"
  30 #include "lib/assert-post.h"
  31 #include <babeltrace2/graph/self-component.h>
  32 #include <babeltrace2/graph/component-const.h>
  33 #include <babeltrace2/graph/component-source-const.h>
  34 #include <babeltrace2/graph/component-filter-const.h>
  35 #include <babeltrace2/graph/component-sink-const.h>
  36 #include <babeltrace2/graph/graph-const.h>
  37 #include "common/macros.h"
  38 #include "compat/compiler.h"
  39 #include <babeltrace2/types.h>
  40 #include <babeltrace2/value.h>
  41 #include "lib/value.h"
  42 #include <stdint.h>
  43 #include <inttypes.h>
  44
  45 #include "component.h"
  46 #include "component-class.h"
  47 #include "component-source.h"
  48 #include "component-filter.h"
  49 #include "component-sink.h"
  50 #include "connection.h"
  51 #include "graph.h"
  52 #include "message/iterator.h"
  53 #include "port.h"
  54 #include "lib/func-status.h"
  55
  56 static
  57 struct bt_component * (* const component_create_funcs[])(
  58                 const struct bt_component_class *) = {
  59         [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create,
  60         [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create,
  61         [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create,
  62 };
  63
  64 static
  65 void (*component_destroy_funcs[])(struct bt_component *) = {
  66         [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_destroy,
  67         [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_destroy,
  68         [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_destroy,
  69 };
  70
  71 static
  72 void finalize_component(struct bt_component *comp)
  73 {
  74         typedef void (*method_t)(void *);
  75
  76         method_t method = NULL;
  77
  78         BT_ASSERT(comp);
  79
  80         switch (comp->class->type) {
  81         case BT_COMPONENT_CLASS_TYPE_SOURCE:
  82         {
  83                 struct bt_component_class_source *src_cc = (void *) comp->class;
  84
  85                 method = (method_t) src_cc->methods.finalize;
  86                 break;
  87         }
  88         case BT_COMPONENT_CLASS_TYPE_FILTER:
  89         {
  90                 struct bt_component_class_filter *flt_cc = (void *) comp->class;
  91
  92                 method = (method_t) flt_cc->methods.finalize;
  93                 break;
  94         }
  95         case BT_COMPONENT_CLASS_TYPE_SINK:
  96         {
  97                 struct bt_component_class_sink *sink_cc = (void *) comp->class;
  98
  99                 method = (method_t) sink_cc->methods.finalize;
 100                 break;
 101         }
 102         default:
 103                 abort();
 104         }
 105
 106         if (method) {
 107                 BT_LIB_LOGI("Calling user's component finalization method: "
 108                         "%![comp-]+c", comp);
 109                 method(comp);
 110         }
 111 }
 112
 113 static
 114 void destroy_component(struct bt_object *obj)
 115 {
 116         struct bt_component *component = NULL;
 117         int i;
 118
 119         if (!obj) {
 120                 return;
 121         }
 122
 123         /*
 124          * The component's reference count is 0 if we're here. Increment
 125          * it to avoid a double-destroy (possibly infinitely recursive).
 126          * This could happen for example if the component's finalization
 127          * function does bt_object_get_ref() (or anything that causes
 128          * bt_object_get_ref() to be called) on itself (ref. count goes
 129          * from 0 to 1), and then bt_object_put_ref(): the reference
 130          * count would go from 1 to 0 again and this function would be
 131          * called again.
 132          */
 133         obj->ref_count++;
 134         component = container_of(obj, struct bt_component, base);
 135         BT_LIB_LOGI("Destroying component: %![comp-]+c, %![graph-]+g",
 136                 component, bt_component_borrow_graph(component));
 137
 138         /* Call destroy listeners in reverse registration order */
 139         BT_LOGD_STR("Calling destroy listeners.");
 140
 141         for (i = component->destroy_listeners->len - 1; i >= 0; i--) {
 142                 struct bt_component_destroy_listener *listener =
 143                         &g_array_index(component->destroy_listeners,
 144                                 struct bt_component_destroy_listener, i);
 145
 146                 listener->func(component, listener->data);
 147         }
 148
 149         /*
 150          * User data is destroyed first, followed by the concrete
 151          * component instance. Do not finalize if the component's user
 152          * initialization method failed in the first place.
 153          */
 154         if (component->initialized) {
 155                 finalize_component(component);
 156         }
 157
 158         if (component->destroy) {
 159                 BT_LOGD_STR("Destroying type-specific data.");
 160                 component->destroy(component);
 161         }
 162
 163         if (component->input_ports) {
 164                 BT_LOGD_STR("Destroying input ports.");
 165                 g_ptr_array_free(component->input_ports, TRUE);
 166                 component->input_ports = NULL;
 167         }
 168
 169         if (component->output_ports) {
 170                 BT_LOGD_STR("Destroying output ports.");
 171                 g_ptr_array_free(component->output_ports, TRUE);
 172                 component->output_ports = NULL;
 173         }
 174
 175         if (component->destroy_listeners) {
 176                 g_array_free(component->destroy_listeners, TRUE);
 177                 component->destroy_listeners = NULL;
 178         }
 179
 180         if (component->name) {
 181                 g_string_free(component->name, TRUE);
 182                 component->name = NULL;
 183         }
 184
 185         BT_LOGD_STR("Putting component class.");
 186         BT_OBJECT_PUT_REF_AND_RESET(component->class);
 187         g_free(component);
 188 }
 189
 190 enum bt_component_class_type bt_component_get_class_type(
 191                 const struct bt_component *component)
 192 {
 193         BT_ASSERT_PRE_NON_NULL(component, "Component");
 194         return component->class->type;
 195 }
 196
 197 static
 198 enum bt_self_component_add_port_status add_port(
 199                 struct bt_component *component, GPtrArray *ports,
 200                 enum bt_port_type port_type, const char *name, void *user_data,
 201                 struct bt_port **port)
 202 {
 203         struct bt_port *new_port = NULL;
 204         struct bt_graph *graph = NULL;
 205         enum bt_self_component_add_port_status status;
 206
 207         BT_ASSERT_PRE_NON_NULL(component, "Component");
 208         BT_ASSERT_PRE_NON_NULL(name, "Name");
 209         BT_ASSERT_PRE(strlen(name) > 0, "Name is empty");
 210         graph = bt_component_borrow_graph(component);
 211         BT_ASSERT_PRE(graph && !bt_graph_is_canceled(graph),
 212                 "Component's graph is canceled: %![comp-]+c, %![graph-]+g",
 213                 component, graph);
 214         BT_ASSERT_PRE(
 215                 graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 216                 "Component's graph is already configured: "
 217                 "%![comp-]+c, %![graph-]+g", component, graph);
 218
 219         // TODO: Validate that the name is not already used.
 220
 221         BT_LIB_LOGI("Adding port to component: %![comp-]+c, "
 222                 "port-type=%s, port-name=\"%s\"", component,
 223                 bt_port_type_string(port_type), name);
 224
 225         new_port = bt_port_create(component, port_type, name, user_data);
 226         if (!new_port) {
 227                 BT_LOGE_STR("Cannot create port object.");
 228                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 229                 goto error;
 230         }
 231
 232         /*
 233          * No name clash, add the port.
 234          * The component is now the port's parent; it should _not_
 235          * hold a reference to the port since the port's lifetime
 236          * is now protected by the component's own lifetime.
 237          */
 238         g_ptr_array_add(ports, new_port);
 239
 240         /*
 241          * Notify the graph's creator that a new port was added.
 242          */
 243         graph = bt_component_borrow_graph(component);
 244         if (graph) {
 245                 enum bt_graph_listener_func_status listener_status;
 246
 247                 listener_status = bt_graph_notify_port_added(graph, new_port);
 248                 if (listener_status != BT_FUNC_STATUS_OK) {
 249                         bt_graph_make_faulty(graph);
 250                         status = (int) listener_status;
 251                         goto error;
 252                 }
 253         }
 254
 255         BT_LIB_LOGI("Created and added port to component: "
 256                 "%![comp-]+c, %![port-]+p", component, new_port);
 257
 258         *port = new_port;
 259         status = BT_FUNC_STATUS_OK;
 260
 261         goto end;
 262 error:
 263         /*
 264          * We need to release the reference that we would otherwise have
 265          * returned to the caller.
 266          */
 267         BT_PORT_PUT_REF_AND_RESET(new_port);
 268
 269 end:
 270         return status;
 271 }
 272
 273 BT_HIDDEN
 274 uint64_t bt_component_get_input_port_count(const struct bt_component *comp)
 275 {
 276         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 277         return (uint64_t) comp->input_ports->len;
 278 }
 279
 280 BT_HIDDEN
 281 uint64_t bt_component_get_output_port_count(const struct bt_component *comp)
 282 {
 283         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 284         return (uint64_t) comp->output_ports->len;
 285 }
 286
 287 BT_HIDDEN
 288 int bt_component_create(struct bt_component_class *component_class,
 289                 const char *name, bt_logging_level log_level,
 290                 struct bt_component **user_component)
 291 {
 292         int ret = 0;
 293         struct bt_component *component = NULL;
 294         enum bt_component_class_type type;
 295
 296         BT_ASSERT(user_component);
 297         BT_ASSERT(component_class);
 298         BT_ASSERT(name);
 299         type = bt_component_class_get_type(component_class);
 300         BT_LIB_LOGI("Creating empty component from component class: %![cc-]+C, "
 301                 "comp-name=\"%s\", log-level=%s", component_class, name,
 302                 bt_common_logging_level_string(log_level));
 303         component = component_create_funcs[type](component_class);
 304         if (!component) {
 305                 BT_LOGE_STR("Cannot create specific component object.");
 306                 ret = -1;
 307                 goto end;
 308         }
 309
 310         bt_object_init_shared_with_parent(&component->base, destroy_component);
 311         component->class = component_class;
 312         bt_object_get_no_null_check(component->class);
 313         component->destroy = component_destroy_funcs[type];
 314         component->name = g_string_new(name);
 315         if (!component->name) {
 316                 BT_LOGE_STR("Failed to allocate one GString.");
 317                 ret = -1;
 318                 goto end;
 319         }
 320
 321         component->log_level = log_level;
 322         component->input_ports = g_ptr_array_new_with_free_func(
 323                 (GDestroyNotify) bt_object_try_spec_release);
 324         if (!component->input_ports) {
 325                 BT_LOGE_STR("Failed to allocate one GPtrArray.");
 326                 ret = -1;
 327                 goto end;
 328         }
 329
 330         component->output_ports = g_ptr_array_new_with_free_func(
 331                 (GDestroyNotify) bt_object_try_spec_release);
 332         if (!component->output_ports) {
 333                 BT_LOGE_STR("Failed to allocate one GPtrArray.");
 334                 ret = -1;
 335                 goto end;
 336         }
 337
 338         component->destroy_listeners = g_array_new(FALSE, TRUE,
 339                 sizeof(struct bt_component_destroy_listener));
 340         if (!component->destroy_listeners) {
 341                 BT_LOGE_STR("Failed to allocate one GArray.");
 342                 ret = -1;
 343                 goto end;
 344         }
 345
 346         BT_LIB_LOGI("Created empty component from component class: "
 347                 "%![cc-]+C, %![comp-]+c", component_class, component);
 348         BT_OBJECT_MOVE_REF(*user_component, component);
 349
 350 end:
 351         bt_object_put_ref(component);
 352         return ret;
 353 }
 354
 355 const char *bt_component_get_name(const struct bt_component *component)
 356 {
 357         BT_ASSERT_PRE_NON_NULL(component, "Component");
 358         return component->name->str;
 359 }
 360
 361 const struct bt_component_class *bt_component_borrow_class_const(
 362                 const struct bt_component *component)
 363 {
 364         BT_ASSERT_PRE_NON_NULL(component, "Component");
 365         return component->class;
 366 }
 367
 368 void *bt_self_component_get_data(const struct bt_self_component *self_comp)
 369 {
 370         struct bt_component *component = (void *) self_comp;
 371
 372         BT_ASSERT_PRE_NON_NULL(component, "Component");
 373         return component->user_data;
 374 }
 375
 376 void bt_self_component_set_data(struct bt_self_component *self_comp,
 377                 void *data)
 378 {
 379         struct bt_component *component = (void *) self_comp;
 380
 381         BT_ASSERT_PRE_NON_NULL(component, "Component");
 382         component->user_data = data;
 383         BT_LIB_LOGD("Set component's user data: %!+c", component);
 384 }
 385
 386 BT_HIDDEN
 387 void bt_component_set_graph(struct bt_component *component,
 388                 struct bt_graph *graph)
 389 {
 390         bt_object_set_parent(&component->base,
 391                 graph ? &graph->base : NULL);
 392 }
 393
 394 bt_bool bt_component_graph_is_canceled(const struct bt_component *component)
 395 {
 396         return bt_graph_is_canceled(
 397                 (void *) bt_object_borrow_parent(&component->base));
 398 }
 399
 400 static
 401 struct bt_port *borrow_port_by_name(GPtrArray *ports,
 402                 const char *name)
 403 {
 404         uint64_t i;
 405         struct bt_port *ret_port = NULL;
 406
 407         BT_ASSERT(name);
 408
 409         for (i = 0; i < ports->len; i++) {
 410                 struct bt_port *port = g_ptr_array_index(ports, i);
 411
 412                 if (!strcmp(name, port->name->str)) {
 413                         ret_port = port;
 414                         break;
 415                 }
 416         }
 417
 418         return ret_port;
 419 }
 420
 421 BT_HIDDEN
 422 struct bt_port_input *bt_component_borrow_input_port_by_name(
 423                 struct bt_component *comp, const char *name)
 424 {
 425         BT_ASSERT(comp);
 426         return (void *) borrow_port_by_name(comp->input_ports, name);
 427 }
 428
 429 BT_HIDDEN
 430 struct bt_port_output *bt_component_borrow_output_port_by_name(
 431                 struct bt_component *comp, const char *name)
 432 {
 433         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 434         return (void *)
 435                 borrow_port_by_name(comp->output_ports, name);
 436 }
 437
 438 static
 439 struct bt_port *borrow_port_by_index(GPtrArray *ports, uint64_t index)
 440 {
 441         BT_ASSERT(index < ports->len);
 442         return g_ptr_array_index(ports, index);
 443 }
 444
 445 BT_HIDDEN
 446 struct bt_port_input *bt_component_borrow_input_port_by_index(
 447                 struct bt_component *comp, uint64_t index)
 448 {
 449         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 450         BT_ASSERT_PRE_VALID_INDEX(index, comp->input_ports->len);
 451         return (void *)
 452                 borrow_port_by_index(comp->input_ports, index);
 453 }
 454
 455 BT_HIDDEN
 456 struct bt_port_output *bt_component_borrow_output_port_by_index(
 457                 struct bt_component *comp, uint64_t index)
 458 {
 459         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 460         BT_ASSERT_PRE_VALID_INDEX(index, comp->output_ports->len);
 461         return (void *)
 462                 borrow_port_by_index(comp->output_ports, index);
 463 }
 464
 465 BT_HIDDEN
 466 enum bt_self_component_add_port_status bt_component_add_input_port(
 467                 struct bt_component *component, const char *name,
 468                 void *user_data, struct bt_port **port)
 469 {
 470         /* add_port() logs details */
 471         return add_port(component, component->input_ports,
 472                 BT_PORT_TYPE_INPUT, name, user_data, port);
 473 }
 474
 475 BT_HIDDEN
 476 enum bt_self_component_add_port_status bt_component_add_output_port(
 477                 struct bt_component *component, const char *name,
 478                 void *user_data, struct bt_port **port)
 479 {
 480         /* add_port() logs details */
 481         return add_port(component, component->output_ports,
 482                 BT_PORT_TYPE_OUTPUT, name, user_data, port);
 483 }
 484
 485 BT_HIDDEN
 486 enum bt_component_class_port_connected_method_status
 487 bt_component_port_connected(
 488                 struct bt_component *comp, struct bt_port *self_port,
 489                 struct bt_port *other_port)
 490 {
 491         typedef enum bt_component_class_port_connected_method_status (*method_t)(
 492                 void *, void *, const void *);
 493
 494         enum bt_component_class_port_connected_method_status status =
 495                 BT_FUNC_STATUS_OK;
 496         method_t method = NULL;
 497
 498         BT_ASSERT(comp);
 499         BT_ASSERT(self_port);
 500         BT_ASSERT(other_port);
 501
 502         switch (comp->class->type) {
 503         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 504         {
 505                 struct bt_component_class_source *src_cc = (void *) comp->class;
 506
 507                 switch (self_port->type) {
 508                 case BT_PORT_TYPE_OUTPUT:
 509                         method = (method_t) src_cc->methods.output_port_connected;
 510                         break;
 511                 default:
 512                         abort();
 513                 }
 514
 515                 break;
 516         }
 517         case BT_COMPONENT_CLASS_TYPE_FILTER:
 518         {
 519                 struct bt_component_class_filter *flt_cc = (void *) comp->class;
 520
 521                 switch (self_port->type) {
 522                 case BT_PORT_TYPE_INPUT:
 523                         method = (method_t) flt_cc->methods.input_port_connected;
 524                         break;
 525                 case BT_PORT_TYPE_OUTPUT:
 526                         method = (method_t) flt_cc->methods.output_port_connected;
 527                         break;
 528                 default:
 529                         abort();
 530                 }
 531
 532                 break;
 533         }
 534         case BT_COMPONENT_CLASS_TYPE_SINK:
 535         {
 536                 struct bt_component_class_sink *sink_cc = (void *) comp->class;
 537
 538                 switch (self_port->type) {
 539                 case BT_PORT_TYPE_INPUT:
 540                         method = (method_t) sink_cc->methods.input_port_connected;
 541                         break;
 542                 default:
 543                         abort();
 544                 }
 545
 546                 break;
 547         }
 548         default:
 549                 abort();
 550         }
 551
 552         if (method) {
 553                 BT_LIB_LOGD("Calling user's \"port connected\" method: "
 554                         "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
 555                         comp, self_port, other_port);
 556                 status = (int) method(comp, self_port, (void *) other_port);
 557                 BT_LOGD("User method returned: status=%s",
 558                         bt_common_func_status_string(status));
 559                 BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
 560                         status == BT_FUNC_STATUS_ERROR ||
 561                         status == BT_FUNC_STATUS_MEMORY_ERROR,
 562                         "Unexpected returned component status: status=%s",
 563                         bt_common_func_status_string(status));
 564         }
 565
 566         return status;
 567 }
 568
 569 BT_HIDDEN
 570 void bt_component_add_destroy_listener(struct bt_component *component,
 571                 bt_component_destroy_listener_func func, void *data)
 572 {
 573         struct bt_component_destroy_listener listener;
 574
 575         BT_ASSERT(component);
 576         BT_ASSERT(func);
 577         listener.func = func;
 578         listener.data = data;
 579         g_array_append_val(component->destroy_listeners, listener);
 580         BT_LIB_LOGD("Added destroy listener: %![comp-]+c, "
 581                 "func-addr=%p, data-addr=%p",
 582                 component, func, data);
 583 }
 584
 585 BT_HIDDEN
 586 void bt_component_remove_destroy_listener(struct bt_component *component,
 587                 bt_component_destroy_listener_func func, void *data)
 588 {
 589         uint64_t i;
 590
 591         BT_ASSERT(component);
 592         BT_ASSERT(func);
 593
 594         for (i = 0; i < component->destroy_listeners->len; i++) {
 595                 struct bt_component_destroy_listener *listener =
 596                         &g_array_index(component->destroy_listeners,
 597                                 struct bt_component_destroy_listener, i);
 598
 599                 if (listener->func == func && listener->data == data) {
 600                         g_array_remove_index(component->destroy_listeners, i);
 601                         i--;
 602                         BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, "
 603                                 "func-addr=%p, data-addr=%p",
 604                                 component, func, data);
 605                 }
 606         }
 607 }
 608
 609 bt_logging_level bt_component_get_logging_level(
 610                 const struct bt_component *component)
 611 {
 612         BT_ASSERT_PRE_NON_NULL(component, "Component");
 613         return component->log_level;
 614 }
 615
 616 void bt_component_get_ref(const struct bt_component *component)
 617 {
 618         bt_object_get_ref(component);
 619 }
 620
 621 void bt_component_put_ref(const struct bt_component *component)
 622 {
 623         bt_object_put_ref(component);
 624 }