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_LIB_LOGE_APPEND_CAUSE("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_LIB_LOGE_APPEND_CAUSE(
 306                         "Cannot create specific component object.");
 307                 ret = -1;
 308                 goto end;
 309         }
 310
 311         bt_object_init_shared_with_parent(&component->base, destroy_component);
 312         component->class = component_class;
 313         bt_object_get_no_null_check(component->class);
 314         component->destroy = component_destroy_funcs[type];
 315         component->name = g_string_new(name);
 316         if (!component->name) {
 317                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
 318                 ret = -1;
 319                 goto end;
 320         }
 321
 322         component->log_level = log_level;
 323         component->input_ports = g_ptr_array_new_with_free_func(
 324                 (GDestroyNotify) bt_object_try_spec_release);
 325         if (!component->input_ports) {
 326                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
 327                 ret = -1;
 328                 goto end;
 329         }
 330
 331         component->output_ports = g_ptr_array_new_with_free_func(
 332                 (GDestroyNotify) bt_object_try_spec_release);
 333         if (!component->output_ports) {
 334                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
 335                 ret = -1;
 336                 goto end;
 337         }
 338
 339         component->destroy_listeners = g_array_new(FALSE, TRUE,
 340                 sizeof(struct bt_component_destroy_listener));
 341         if (!component->destroy_listeners) {
 342                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
 343                 ret = -1;
 344                 goto end;
 345         }
 346
 347         BT_LIB_LOGI("Created empty component from component class: "
 348                 "%![cc-]+C, %![comp-]+c", component_class, component);
 349         BT_OBJECT_MOVE_REF(*user_component, component);
 350
 351 end:
 352         bt_object_put_ref(component);
 353         return ret;
 354 }
 355
 356 const char *bt_component_get_name(const struct bt_component *component)
 357 {
 358         BT_ASSERT_PRE_NON_NULL(component, "Component");
 359         return component->name->str;
 360 }
 361
 362 const struct bt_component_class *bt_component_borrow_class_const(
 363                 const struct bt_component *component)
 364 {
 365         BT_ASSERT_PRE_NON_NULL(component, "Component");
 366         return component->class;
 367 }
 368
 369 void *bt_self_component_get_data(const struct bt_self_component *self_comp)
 370 {
 371         struct bt_component *component = (void *) self_comp;
 372
 373         BT_ASSERT_PRE_NON_NULL(component, "Component");
 374         return component->user_data;
 375 }
 376
 377 void bt_self_component_set_data(struct bt_self_component *self_comp,
 378                 void *data)
 379 {
 380         struct bt_component *component = (void *) self_comp;
 381
 382         BT_ASSERT_PRE_NON_NULL(component, "Component");
 383         component->user_data = data;
 384         BT_LIB_LOGD("Set component's user data: %!+c", component);
 385 }
 386
 387 BT_HIDDEN
 388 void bt_component_set_graph(struct bt_component *component,
 389                 struct bt_graph *graph)
 390 {
 391         bt_object_set_parent(&component->base,
 392                 graph ? &graph->base : NULL);
 393 }
 394
 395 bt_bool bt_component_graph_is_canceled(const struct bt_component *component)
 396 {
 397         return bt_graph_is_canceled(
 398                 (void *) bt_object_borrow_parent(&component->base));
 399 }
 400
 401 static
 402 struct bt_port *borrow_port_by_name(GPtrArray *ports,
 403                 const char *name)
 404 {
 405         uint64_t i;
 406         struct bt_port *ret_port = NULL;
 407
 408         BT_ASSERT(name);
 409
 410         for (i = 0; i < ports->len; i++) {
 411                 struct bt_port *port = g_ptr_array_index(ports, i);
 412
 413                 if (!strcmp(name, port->name->str)) {
 414                         ret_port = port;
 415                         break;
 416                 }
 417         }
 418
 419         return ret_port;
 420 }
 421
 422 BT_HIDDEN
 423 struct bt_port_input *bt_component_borrow_input_port_by_name(
 424                 struct bt_component *comp, const char *name)
 425 {
 426         BT_ASSERT(comp);
 427         return (void *) borrow_port_by_name(comp->input_ports, name);
 428 }
 429
 430 BT_HIDDEN
 431 struct bt_port_output *bt_component_borrow_output_port_by_name(
 432                 struct bt_component *comp, const char *name)
 433 {
 434         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 435         return (void *)
 436                 borrow_port_by_name(comp->output_ports, name);
 437 }
 438
 439 static
 440 struct bt_port *borrow_port_by_index(GPtrArray *ports, uint64_t index)
 441 {
 442         BT_ASSERT(index < ports->len);
 443         return g_ptr_array_index(ports, index);
 444 }
 445
 446 BT_HIDDEN
 447 struct bt_port_input *bt_component_borrow_input_port_by_index(
 448                 struct bt_component *comp, uint64_t index)
 449 {
 450         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 451         BT_ASSERT_PRE_VALID_INDEX(index, comp->input_ports->len);
 452         return (void *)
 453                 borrow_port_by_index(comp->input_ports, index);
 454 }
 455
 456 BT_HIDDEN
 457 struct bt_port_output *bt_component_borrow_output_port_by_index(
 458                 struct bt_component *comp, uint64_t index)
 459 {
 460         BT_ASSERT_PRE_NON_NULL(comp, "Component");
 461         BT_ASSERT_PRE_VALID_INDEX(index, comp->output_ports->len);
 462         return (void *)
 463                 borrow_port_by_index(comp->output_ports, index);
 464 }
 465
 466 BT_HIDDEN
 467 enum bt_self_component_add_port_status bt_component_add_input_port(
 468                 struct bt_component *component, const char *name,
 469                 void *user_data, struct bt_port **port)
 470 {
 471         /* add_port() logs details */
 472         return add_port(component, component->input_ports,
 473                 BT_PORT_TYPE_INPUT, name, user_data, port);
 474 }
 475
 476 BT_HIDDEN
 477 enum bt_self_component_add_port_status bt_component_add_output_port(
 478                 struct bt_component *component, const char *name,
 479                 void *user_data, struct bt_port **port)
 480 {
 481         /* add_port() logs details */
 482         return add_port(component, component->output_ports,
 483                 BT_PORT_TYPE_OUTPUT, name, user_data, port);
 484 }
 485
 486 BT_HIDDEN
 487 enum bt_component_class_port_connected_method_status
 488 bt_component_port_connected(
 489                 struct bt_component *comp, struct bt_port *self_port,
 490                 struct bt_port *other_port)
 491 {
 492         typedef enum bt_component_class_port_connected_method_status (*method_t)(
 493                 void *, void *, const void *);
 494
 495         enum bt_component_class_port_connected_method_status status =
 496                 BT_FUNC_STATUS_OK;
 497         method_t method = NULL;
 498
 499         BT_ASSERT(comp);
 500         BT_ASSERT(self_port);
 501         BT_ASSERT(other_port);
 502
 503         switch (comp->class->type) {
 504         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 505         {
 506                 struct bt_component_class_source *src_cc = (void *) comp->class;
 507
 508                 switch (self_port->type) {
 509                 case BT_PORT_TYPE_OUTPUT:
 510                         method = (method_t) src_cc->methods.output_port_connected;
 511                         break;
 512                 default:
 513                         abort();
 514                 }
 515
 516                 break;
 517         }
 518         case BT_COMPONENT_CLASS_TYPE_FILTER:
 519         {
 520                 struct bt_component_class_filter *flt_cc = (void *) comp->class;
 521
 522                 switch (self_port->type) {
 523                 case BT_PORT_TYPE_INPUT:
 524                         method = (method_t) flt_cc->methods.input_port_connected;
 525                         break;
 526                 case BT_PORT_TYPE_OUTPUT:
 527                         method = (method_t) flt_cc->methods.output_port_connected;
 528                         break;
 529                 default:
 530                         abort();
 531                 }
 532
 533                 break;
 534         }
 535         case BT_COMPONENT_CLASS_TYPE_SINK:
 536         {
 537                 struct bt_component_class_sink *sink_cc = (void *) comp->class;
 538
 539                 switch (self_port->type) {
 540                 case BT_PORT_TYPE_INPUT:
 541                         method = (method_t) sink_cc->methods.input_port_connected;
 542                         break;
 543                 default:
 544                         abort();
 545                 }
 546
 547                 break;
 548         }
 549         default:
 550                 abort();
 551         }
 552
 553         if (method) {
 554                 BT_LIB_LOGD("Calling user's \"port connected\" method: "
 555                         "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
 556                         comp, self_port, other_port);
 557                 status = (int) method(comp, self_port, (void *) other_port);
 558                 BT_LOGD("User method returned: status=%s",
 559                         bt_common_func_status_string(status));
 560                 BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
 561                         status == BT_FUNC_STATUS_ERROR ||
 562                         status == BT_FUNC_STATUS_MEMORY_ERROR,
 563                         "Unexpected returned component status: status=%s",
 564                         bt_common_func_status_string(status));
 565         }
 566
 567         return status;
 568 }
 569
 570 BT_HIDDEN
 571 void bt_component_add_destroy_listener(struct bt_component *component,
 572                 bt_component_destroy_listener_func func, void *data)
 573 {
 574         struct bt_component_destroy_listener listener;
 575
 576         BT_ASSERT(component);
 577         BT_ASSERT(func);
 578         listener.func = func;
 579         listener.data = data;
 580         g_array_append_val(component->destroy_listeners, listener);
 581         BT_LIB_LOGD("Added destroy listener: %![comp-]+c, "
 582                 "func-addr=%p, data-addr=%p",
 583                 component, func, data);
 584 }
 585
 586 BT_HIDDEN
 587 void bt_component_remove_destroy_listener(struct bt_component *component,
 588                 bt_component_destroy_listener_func func, void *data)
 589 {
 590         uint64_t i;
 591
 592         BT_ASSERT(component);
 593         BT_ASSERT(func);
 594
 595         for (i = 0; i < component->destroy_listeners->len; i++) {
 596                 struct bt_component_destroy_listener *listener =
 597                         &g_array_index(component->destroy_listeners,
 598                                 struct bt_component_destroy_listener, i);
 599
 600                 if (listener->func == func && listener->data == data) {
 601                         g_array_remove_index(component->destroy_listeners, i);
 602                         i--;
 603                         BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, "
 604                                 "func-addr=%p, data-addr=%p",
 605                                 component, func, data);
 606                 }
 607         }
 608 }
 609
 610 bt_logging_level bt_component_get_logging_level(
 611                 const struct bt_component *component)
 612 {
 613         BT_ASSERT_PRE_NON_NULL(component, "Component");
 614         return component->log_level;
 615 }
 616
 617 void bt_component_get_ref(const struct bt_component *component)
 618 {
 619         bt_object_get_ref(component);
 620 }
 621
 622 void bt_component_put_ref(const struct bt_component *component)
 623 {
 624         bt_object_put_ref(component);
 625 }