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 <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/value.h>
  31 #include <babeltrace2/graph/self-component-filter.h>
  32 #include <babeltrace2/graph/component-filter-const.h>
  33 #include <babeltrace2/graph/component-filter-internal.h>
  34 #include <babeltrace2/graph/component-internal.h>
  35 #include <babeltrace2/graph/component-class-internal.h>
  36 #include <babeltrace2/graph/graph.h>
  37
  38 BT_HIDDEN
  39 void bt_component_filter_destroy(struct bt_component *component)
  40 {
  41 }
  42
  43 BT_HIDDEN
  44 struct bt_component *bt_component_filter_create(
  45                 const struct bt_component_class *class)
  46 {
  47         struct bt_component_filter *filter = NULL;
  48
  49         filter = g_new0(struct bt_component_filter, 1);
  50         if (!filter) {
  51                 BT_LOGE_STR("Failed to allocate one filter component.");
  52                 goto end;
  53         }
  54
  55 end:
  56         return (void *) filter;
  57 }
  58
  59 const bt_component_class_filter *
  60 bt_component_filter_borrow_class_const(
  61                 const bt_component_filter *component)
  62 {
  63         struct bt_component_class *cls;
  64
  65         BT_ASSERT_PRE_NON_NULL(component, "Component");
  66
  67         cls = component->parent.class;
  68
  69         BT_ASSERT(cls);
  70         BT_ASSERT(cls->type == BT_COMPONENT_CLASS_TYPE_FILTER);
  71
  72         return (bt_component_class_filter *) cls;
  73 }
  74
  75 uint64_t bt_component_filter_get_output_port_count(
  76                 const struct bt_component_filter *comp)
  77 {
  78         return bt_component_get_output_port_count((void *) comp);
  79 }
  80
  81 const struct bt_port_output *
  82 bt_component_filter_borrow_output_port_by_name_const(
  83                 const struct bt_component_filter *comp, const char *name)
  84 {
  85         return bt_component_borrow_output_port_by_name(
  86                 (void *) comp, name);
  87 }
  88
  89 struct bt_self_component_port_output *
  90 bt_self_component_filter_borrow_output_port_by_name(
  91                 struct bt_self_component_filter *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_filter_borrow_output_port_by_index_const(
  99                 const struct bt_component_filter *comp, uint64_t index)
 100 {
 101         return bt_component_borrow_output_port_by_index(
 102                 (void *) comp, index);
 103 }
 104
 105 struct bt_self_component_port_output *
 106 bt_self_component_filter_borrow_output_port_by_index(
 107                 struct bt_self_component_filter *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_filter_add_output_port(
 114                 struct bt_self_component_filter *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 uint64_t bt_component_filter_get_input_port_count(
 140                 const struct bt_component_filter *component)
 141 {
 142         /* bt_component_get_input_port_count() logs details/errors */
 143         return bt_component_get_input_port_count((void *) component);
 144 }
 145
 146 const struct bt_port_input *bt_component_filter_borrow_input_port_by_name_const(
 147                 const struct bt_component_filter *component, const char *name)
 148 {
 149         /* bt_component_borrow_input_port_by_name() logs details/errors */
 150         return bt_component_borrow_input_port_by_name(
 151                 (void *) component, name);
 152 }
 153
 154 struct bt_self_component_port_input *
 155 bt_self_component_filter_borrow_input_port_by_name(
 156                 struct bt_self_component_filter *component, const char *name)
 157 {
 158         /* bt_component_borrow_input_port_by_name() logs details/errors */
 159         return (void *) bt_component_borrow_input_port_by_name(
 160                 (void *) component, name);
 161 }
 162
 163 const struct bt_port_input *
 164 bt_component_filter_borrow_input_port_by_index_const(
 165                 const struct bt_component_filter *component, uint64_t index)
 166 {
 167         /* bt_component_borrow_input_port_by_index() logs details/errors */
 168         return bt_component_borrow_input_port_by_index(
 169                 (void *) component, index);
 170 }
 171
 172 struct bt_self_component_port_input *
 173 bt_self_component_filter_borrow_input_port_by_index(
 174                 struct bt_self_component_filter *component, uint64_t index)
 175 {
 176         /* bt_component_borrow_input_port_by_index() logs details/errors */
 177         return (void *) bt_component_borrow_input_port_by_index(
 178                 (void *) component, index);
 179 }
 180
 181 enum bt_self_component_status bt_self_component_filter_add_input_port(
 182                 struct bt_self_component_filter *self_comp,
 183                 const char *name, void *user_data,
 184                 struct bt_self_component_port_input **self_port)
 185 {
 186         enum bt_self_component_status status;
 187         struct bt_port *port = NULL;
 188         struct bt_component *comp = (void *) self_comp;
 189
 190         /* bt_component_add_input_port() logs details/errors */
 191         status = bt_component_add_input_port(comp, name, user_data, &port);
 192         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 193                 goto end;
 194         }
 195
 196         if (self_port) {
 197                 /* Move reference to user */
 198                 *self_port = (void *) port;
 199                 port = NULL;
 200         }
 201
 202 end:
 203         bt_object_put_ref(port);
 204         return status;
 205 }
 206
 207 void bt_component_filter_get_ref(
 208                 const struct bt_component_filter *component_filter)
 209 {
 210         bt_object_get_ref(component_filter);
 211 }
 212
 213 void bt_component_filter_put_ref(
 214                 const struct bt_component_filter *component_filter)
 215 {
 216         bt_object_put_ref(component_filter);
 217 }