src/lib/graph/component-filter.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2016 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-FILTER"
  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/value.h>
  31 #include <babeltrace2/graph/self-component-filter.h>
  32 #include <babeltrace2/graph/component-filter-const.h>
  33 #include <babeltrace2/graph/graph.h>
  34
  35 #include "component-filter.h"
  36 #include "component.h"
  37 #include "component-class.h"
  38
  39 BT_HIDDEN
  40 void bt_component_filter_destroy(struct bt_component *component)
  41 {
  42 }
  43
  44 BT_HIDDEN
  45 struct bt_component *bt_component_filter_create(
  46                 const struct bt_component_class *class)
  47 {
  48         struct bt_component_filter *filter = NULL;
  49
  50         filter = g_new0(struct bt_component_filter, 1);
  51         if (!filter) {
  52                 BT_LOGE_STR("Failed to allocate one filter component.");
  53                 goto end;
  54         }
  55
  56 end:
  57         return (void *) filter;
  58 }
  59
  60 const bt_component_class_filter *
  61 bt_component_filter_borrow_class_const(
  62                 const bt_component_filter *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_FILTER);
  72
  73         return (bt_component_class_filter *) cls;
  74 }
  75
  76 uint64_t bt_component_filter_get_output_port_count(
  77                 const struct bt_component_filter *comp)
  78 {
  79         return bt_component_get_output_port_count((void *) comp);
  80 }
  81
  82 const struct bt_port_output *
  83 bt_component_filter_borrow_output_port_by_name_const(
  84                 const struct bt_component_filter *comp, const char *name)
  85 {
  86         return bt_component_borrow_output_port_by_name(
  87                 (void *) comp, name);
  88 }
  89
  90 struct bt_self_component_port_output *
  91 bt_self_component_filter_borrow_output_port_by_name(
  92                 struct bt_self_component_filter *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_filter_borrow_output_port_by_index_const(
 100                 const struct bt_component_filter *comp, uint64_t index)
 101 {
 102         return bt_component_borrow_output_port_by_index(
 103                 (void *) comp, index);
 104 }
 105
 106 struct bt_self_component_port_output *
 107 bt_self_component_filter_borrow_output_port_by_index(
 108                 struct bt_self_component_filter *comp, uint64_t index)
 109 {
 110         return (void *) bt_component_borrow_output_port_by_index(
 111                 (void *) comp, index);
 112 }
 113
 114 enum bt_self_component_status bt_self_component_filter_add_output_port(
 115                 struct bt_self_component_filter *self_comp,
 116                 const char *name, void *user_data,
 117                 struct bt_self_component_port_output **self_port)
 118 {
 119         struct bt_component *comp = (void *) self_comp;
 120         enum bt_self_component_status status;
 121         struct bt_port *port = NULL;
 122
 123         /* bt_component_add_output_port() logs details and errors */
 124         status = bt_component_add_output_port(comp, name, user_data, &port);
 125         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 126                 goto end;
 127         }
 128
 129         if (self_port) {
 130                 /* Move reference to user */
 131                 *self_port = (void *) port;
 132                 port = NULL;
 133         }
 134
 135 end:
 136         bt_object_put_ref(port);
 137         return status;
 138 }
 139
 140 uint64_t bt_component_filter_get_input_port_count(
 141                 const struct bt_component_filter *component)
 142 {
 143         /* bt_component_get_input_port_count() logs details/errors */
 144         return bt_component_get_input_port_count((void *) component);
 145 }
 146
 147 const struct bt_port_input *bt_component_filter_borrow_input_port_by_name_const(
 148                 const struct bt_component_filter *component, const char *name)
 149 {
 150         /* bt_component_borrow_input_port_by_name() logs details/errors */
 151         return bt_component_borrow_input_port_by_name(
 152                 (void *) component, name);
 153 }
 154
 155 struct bt_self_component_port_input *
 156 bt_self_component_filter_borrow_input_port_by_name(
 157                 struct bt_self_component_filter *component, const char *name)
 158 {
 159         /* bt_component_borrow_input_port_by_name() logs details/errors */
 160         return (void *) bt_component_borrow_input_port_by_name(
 161                 (void *) component, name);
 162 }
 163
 164 const struct bt_port_input *
 165 bt_component_filter_borrow_input_port_by_index_const(
 166                 const struct bt_component_filter *component, uint64_t index)
 167 {
 168         /* bt_component_borrow_input_port_by_index() logs details/errors */
 169         return bt_component_borrow_input_port_by_index(
 170                 (void *) component, index);
 171 }
 172
 173 struct bt_self_component_port_input *
 174 bt_self_component_filter_borrow_input_port_by_index(
 175                 struct bt_self_component_filter *component, uint64_t index)
 176 {
 177         /* bt_component_borrow_input_port_by_index() logs details/errors */
 178         return (void *) bt_component_borrow_input_port_by_index(
 179                 (void *) component, index);
 180 }
 181
 182 enum bt_self_component_status bt_self_component_filter_add_input_port(
 183                 struct bt_self_component_filter *self_comp,
 184                 const char *name, void *user_data,
 185                 struct bt_self_component_port_input **self_port)
 186 {
 187         enum bt_self_component_status status;
 188         struct bt_port *port = NULL;
 189         struct bt_component *comp = (void *) self_comp;
 190
 191         /* bt_component_add_input_port() logs details/errors */
 192         status = bt_component_add_input_port(comp, name, user_data, &port);
 193         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 194                 goto end;
 195         }
 196
 197         if (self_port) {
 198                 /* Move reference to user */
 199                 *self_port = (void *) port;
 200                 port = NULL;
 201         }
 202
 203 end:
 204         bt_object_put_ref(port);
 205         return status;
 206 }
 207
 208 void bt_component_filter_get_ref(
 209                 const struct bt_component_filter *component_filter)
 210 {
 211         bt_object_get_ref(component_filter);
 212 }
 213
 214 void bt_component_filter_put_ref(
 215                 const struct bt_component_filter *component_filter)
 216 {
 217         bt_object_put_ref(component_filter);
 218 }