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