lib/graph/filter.c

   1 /*
   2  * filter.c
   3  *
   4  * Babeltrace Filter Component
   5  *
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/compiler-internal.h>
  30 #include <babeltrace/values.h>
  31 #include <babeltrace/graph/component-filter-internal.h>
  32 #include <babeltrace/graph/component-internal.h>
  33 #include <babeltrace/graph/component-class-internal.h>
  34 #include <babeltrace/graph/notification.h>
  35 #include <babeltrace/graph/notification-iterator-internal.h>
  36
  37 BT_HIDDEN
  38 void bt_component_filter_destroy(struct bt_component *component)
  39 {
  40 }
  41
  42 BT_HIDDEN
  43 struct bt_component *bt_component_filter_create(
  44                 struct bt_component_class *class, struct bt_value *params)
  45 {
  46         struct bt_component_filter *filter = NULL;
  47
  48         filter = g_new0(struct bt_component_filter, 1);
  49         if (!filter) {
  50                 goto end;
  51         }
  52
  53 end:
  54         return filter ? &filter->parent : NULL;
  55 }
  56
  57 BT_HIDDEN
  58 enum bt_component_status bt_component_filter_validate(
  59                 struct bt_component *component)
  60 {
  61         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  62
  63         if (!component) {
  64                 ret = BT_COMPONENT_STATUS_INVALID;
  65                 goto end;
  66         }
  67
  68         if (!component->class) {
  69                 ret = BT_COMPONENT_STATUS_INVALID;
  70                 goto end;
  71         }
  72
  73         if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
  74                 ret = BT_COMPONENT_STATUS_INVALID;
  75                 goto end;
  76         }
  77
  78         /* Enforce iterator limits. */
  79 end:
  80         return ret;
  81 }
  82
  83 int64_t bt_component_filter_get_input_port_count(
  84                 struct bt_component *component)
  85 {
  86         int64_t ret;
  87
  88         if (!component ||
  89                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
  90                 ret = (int64_t) -1;
  91                 goto end;
  92         }
  93
  94         ret = (int64_t) bt_component_get_input_port_count(component);
  95 end:
  96         return ret;
  97 }
  98
  99 struct bt_port *bt_component_filter_get_input_port_by_name(
 100                 struct bt_component *component, const char *name)
 101 {
 102         struct bt_port *port = NULL;
 103
 104         if (!component || !name ||
 105                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 106                 goto end;
 107         }
 108
 109         port = bt_component_get_input_port_by_name(component, name);
 110 end:
 111         return port;
 112 }
 113
 114 struct bt_port *bt_component_filter_get_input_port_by_index(
 115                 struct bt_component *component, uint64_t index)
 116 {
 117         struct bt_port *port = NULL;
 118
 119         if (!component ||
 120                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 121                 goto end;
 122         }
 123
 124         port = bt_component_get_input_port_by_index(component, index);
 125 end:
 126         return port;
 127 }
 128
 129 int64_t bt_component_filter_get_output_port_count(
 130                 struct bt_component *component)
 131 {
 132         int64_t ret;
 133
 134         if (!component ||
 135                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 136                 ret = (int64_t) -1;
 137                 goto end;
 138         }
 139
 140         ret = bt_component_get_output_port_count(component);
 141 end:
 142         return ret;
 143 }
 144
 145 struct bt_port *bt_component_filter_get_output_port_by_name(
 146                 struct bt_component *component, const char *name)
 147 {
 148         struct bt_port *port = NULL;
 149
 150         if (!component || !name ||
 151                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 152                 goto end;
 153         }
 154
 155         port = bt_component_get_output_port_by_name(component, name);
 156 end:
 157         return port;
 158 }
 159
 160 struct bt_port *bt_component_filter_get_output_port_by_index(
 161                 struct bt_component *component, uint64_t index)
 162 {
 163         struct bt_port *port = NULL;
 164
 165         if (!component ||
 166                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 167                 goto end;
 168         }
 169
 170         port = bt_component_get_output_port_by_index(component, index);
 171 end:
 172         return port;
 173 }
 174
 175 struct bt_private_port *
 176 bt_private_component_filter_get_input_private_port_by_index(
 177                 struct bt_private_component *private_component, uint64_t index)
 178 {
 179         return bt_private_port_from_port(
 180                 bt_component_filter_get_input_port_by_index(
 181                         bt_component_from_private(private_component), index));
 182 }
 183
 184 struct bt_private_port *
 185 bt_private_component_filter_get_input_private_port_by_name(
 186                 struct bt_private_component *private_component,
 187                 const char *name)
 188 {
 189         return bt_private_port_from_port(
 190                 bt_component_filter_get_input_port_by_name(
 191                         bt_component_from_private(private_component), name));
 192 }
 193
 194 struct bt_private_port *bt_private_component_filter_add_input_private_port(
 195                 struct bt_private_component *private_component,
 196                 const char *name, void *user_data)
 197 {
 198         struct bt_port *port = NULL;
 199         struct bt_component *component =
 200                 bt_component_from_private(private_component);
 201
 202         if (!component ||
 203                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 204                 goto end;
 205         }
 206
 207         port = bt_component_add_input_port(component, name, user_data);
 208 end:
 209         return bt_private_port_from_port(port);
 210 }
 211
 212 struct bt_private_port *
 213 bt_private_component_filter_get_output_private_port_by_index(
 214                 struct bt_private_component *private_component, uint64_t index)
 215 {
 216         return bt_private_port_from_port(
 217                 bt_component_filter_get_output_port_by_index(
 218                         bt_component_from_private(private_component), index));
 219 }
 220
 221 struct bt_private_port *
 222 bt_private_component_filter_get_output_private_port_by_name(
 223                 struct bt_private_component *private_component,
 224                 const char *name)
 225 {
 226         return bt_private_port_from_port(
 227                 bt_component_filter_get_output_port_by_name(
 228                         bt_component_from_private(private_component), name));
 229 }
 230
 231 struct bt_private_port *bt_private_component_filter_add_output_private_port(
 232                 struct bt_private_component *private_component,
 233                 const char *name, void *user_data)
 234 {
 235         struct bt_port *port = NULL;
 236         struct bt_component *component =
 237                 bt_component_from_private(private_component);
 238
 239         if (!component ||
 240                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 241                 goto end;
 242         }
 243
 244         port = bt_component_add_output_port(component, name, user_data);
 245 end:
 246         return bt_private_port_from_port(port);
 247 }