lib/graph/component-source.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 "COMP-SOURCE"
  25 #include <babeltrace2/lib-logging-internal.h>
  26
  27 #include <babeltrace2/assert-internal.h>
  28 #include <babeltrace2/assert-pre-internal.h>
  29 #include <babeltrace2/compiler-internal.h>
  30 #include <babeltrace2/graph/self-component-source.h>
  31 #include <babeltrace2/graph/component-source-const.h>
  32 #include <babeltrace2/graph/component-source-internal.h>
  33 #include <babeltrace2/graph/component-internal.h>
  34 #include <babeltrace2/graph/port-internal.h>
  35 #include <babeltrace2/graph/message-iterator-const.h>
  36 #include <babeltrace2/graph/message-iterator-internal.h>
  37 #include <babeltrace2/graph/graph.h>
  38
  39 BT_HIDDEN
  40 void bt_component_source_destroy(struct bt_component *component)
  41 {
  42 }
  43
  44 BT_HIDDEN
  45 struct bt_component *bt_component_source_create(
  46                 const struct bt_component_class *class)
  47 {
  48         struct bt_component_source *source = NULL;
  49
  50         source = g_new0(struct bt_component_source, 1);
  51         if (!source) {
  52                 BT_LOGE_STR("Failed to allocate one source component.");
  53                 goto end;
  54         }
  55
  56 end:
  57         return (void *) source;
  58 }
  59
  60 const bt_component_class_source *
  61 bt_component_source_borrow_class_const(
  62                 const bt_component_source *component)
  63 {
  64         struct bt_component_class *cls;
  65
  66         BT_ASSERT_PRE_NON_NULL(component, "Component");
  67
  68         cls = component->parent.class;
  69
  70         BT_ASSERT(cls);
  71         BT_ASSERT(cls->type == BT_COMPONENT_CLASS_TYPE_SOURCE);
  72
  73         return (bt_component_class_source *) cls;
  74 }
  75
  76 uint64_t bt_component_source_get_output_port_count(
  77                 const struct bt_component_source *comp)
  78 {
  79         return bt_component_get_output_port_count((void *) comp);
  80 }
  81
  82 const struct bt_port_output *
  83 bt_component_source_borrow_output_port_by_name_const(
  84                 const struct bt_component_source *comp, const char *name)
  85 {
  86         return bt_component_borrow_output_port_by_name((void *) comp, name);
  87 }
  88
  89 struct bt_self_component_port_output *
  90 bt_self_component_source_borrow_output_port_by_name(
  91                 struct bt_self_component_source *comp, const char *name)
  92 {
  93         return (void *) bt_component_borrow_output_port_by_name(
  94                 (void *) comp, name);
  95 }
  96
  97 const struct bt_port_output *
  98 bt_component_source_borrow_output_port_by_index_const(
  99                 const struct bt_component_source *comp, uint64_t index)
 100 {
 101         return bt_component_borrow_output_port_by_index((void *) comp, index);
 102 }
 103
 104 struct bt_self_component_port_output *
 105 bt_self_component_source_borrow_output_port_by_index(
 106                 struct bt_self_component_source *comp, uint64_t index)
 107 {
 108         return (void *) bt_component_borrow_output_port_by_index(
 109                 (void *) comp, index);
 110 }
 111
 112 enum bt_self_component_status bt_self_component_source_add_output_port(
 113                 struct bt_self_component_source *self_comp,
 114                 const char *name, void *user_data,
 115                 struct bt_self_component_port_output **self_port)
 116 {
 117         struct bt_component *comp = (void *) self_comp;
 118         enum bt_self_component_status status;
 119         struct bt_port *port = NULL;
 120
 121         /* bt_component_add_output_port() logs details and errors */
 122         status = bt_component_add_output_port(comp, name, user_data, &port);
 123         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 124                 goto end;
 125         }
 126
 127         if (self_port) {
 128                 /* Move reference to user */
 129                 *self_port = (void *) port;
 130                 port = NULL;
 131         }
 132
 133 end:
 134         bt_object_put_ref(port);
 135         return status;
 136 }
 137
 138 void bt_component_source_get_ref(
 139                 const struct bt_component_source *component_source)
 140 {
 141         bt_object_get_ref(component_source);
 142 }
 143
 144 void bt_component_source_put_ref(
 145                 const struct bt_component_source *component_source)
 146 {
 147         bt_object_put_ref(component_source);
 148 }