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