lib/component/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.h>
  30 #include <babeltrace/values.h>
  31 #include <babeltrace/component/component-filter-internal.h>
  32 #include <babeltrace/component/component-internal.h>
  33 #include <babeltrace/component/component-class-internal.h>
  34 #include <babeltrace/component/notification/notification.h>
  35 #include <babeltrace/component/notification/iterator-internal.h>
  36
  37 BT_HIDDEN
  38 struct bt_notification_iterator *bt_component_filter_create_notification_iterator(
  39                 struct bt_component *component)
  40 {
  41         return bt_component_create_iterator(component, NULL);
  42 }
  43
  44 BT_HIDDEN
  45 struct bt_notification_iterator *bt_component_filter_create_notification_iterator_with_init_method_data(
  46                 struct bt_component *component, void *init_method_data)
  47 {
  48         return bt_component_create_iterator(component, init_method_data);
  49 }
  50
  51 BT_HIDDEN
  52 void bt_component_filter_destroy(struct bt_component *component)
  53 {
  54 }
  55
  56 BT_HIDDEN
  57 struct bt_component *bt_component_filter_create(
  58                 struct bt_component_class *class, struct bt_value *params)
  59 {
  60         struct bt_component_filter *filter = NULL;
  61
  62         filter = g_new0(struct bt_component_filter, 1);
  63         if (!filter) {
  64                 goto end;
  65         }
  66
  67 end:
  68         return filter ? &filter->parent : NULL;
  69 }
  70
  71 BT_HIDDEN
  72 enum bt_component_status bt_component_filter_validate(
  73                 struct bt_component *component)
  74 {
  75         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  76
  77         if (!component) {
  78                 ret = BT_COMPONENT_STATUS_INVALID;
  79                 goto end;
  80         }
  81
  82         if (!component->class) {
  83                 ret = BT_COMPONENT_STATUS_INVALID;
  84                 goto end;
  85         }
  86
  87         if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
  88                 ret = BT_COMPONENT_STATUS_INVALID;
  89                 goto end;
  90         }
  91
  92         /* Enforce iterator limits. */
  93 end:
  94         return ret;
  95 }
  96
  97 enum bt_component_status bt_component_filter_get_input_port_count(
  98                 struct bt_component *component, uint64_t *count)
  99 {
 100         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 101
 102         if (!component || !count ||
 103                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 104                 status = BT_COMPONENT_STATUS_INVALID;
 105                 goto end;
 106         }
 107
 108         *count = bt_component_get_input_port_count(component);
 109 end:
 110         return status;
 111 }
 112
 113 struct bt_port *bt_component_filter_get_input_port(
 114                 struct bt_component *component, const char *name)
 115 {
 116         struct bt_port *port = NULL;
 117
 118         if (!component || !name ||
 119                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 120                 goto end;
 121         }
 122
 123         port = bt_component_get_input_port(component, name);
 124 end:
 125         return port;
 126 }
 127
 128 struct bt_port *bt_component_filter_get_input_port_at_index(
 129                 struct bt_component *component, int index)
 130 {
 131         struct bt_port *port = NULL;
 132
 133         if (!component ||
 134                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 135                 goto end;
 136         }
 137
 138         port = bt_component_get_input_port_at_index(component, index);
 139 end:
 140         return port;
 141 }
 142
 143 struct bt_port *bt_component_filter_get_default_input_port(
 144                 struct bt_component *component)
 145 {
 146         return bt_component_filter_get_input_port(component,
 147                         DEFAULT_INPUT_PORT_NAME);
 148 }
 149
 150 struct bt_port *bt_component_filter_add_input_port(
 151                 struct bt_component *component, const char *name)
 152 {
 153         struct bt_port *port = NULL;
 154
 155         if (!component ||
 156                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 157                 goto end;
 158         }
 159
 160         port = bt_component_add_input_port(component, name);
 161 end:
 162         return port;
 163 }
 164
 165 enum bt_component_status bt_component_filter_get_output_port_count(
 166                 struct bt_component *component, uint64_t *count)
 167 {
 168         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 169
 170         if (!component || !count ||
 171                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 172                 status = BT_COMPONENT_STATUS_INVALID;
 173                 goto end;
 174         }
 175
 176         *count = bt_component_get_output_port_count(component);
 177 end:
 178         return status;
 179 }
 180
 181 struct bt_port *bt_component_filter_get_output_port(
 182                 struct bt_component *component, const char *name)
 183 {
 184         struct bt_port *port = NULL;
 185
 186         if (!component || !name ||
 187                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 188                 goto end;
 189         }
 190
 191         port = bt_component_get_output_port(component, name);
 192 end:
 193         return port;
 194 }
 195
 196 struct bt_port *bt_component_filter_get_output_port_at_index(
 197                 struct bt_component *component, int index)
 198 {
 199         struct bt_port *port = NULL;
 200
 201         if (!component ||
 202                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 203                 goto end;
 204         }
 205
 206         port = bt_component_get_output_port_at_index(component, index);
 207 end:
 208         return port;
 209 }
 210
 211 struct bt_port *bt_component_filter_get_default_output_port(
 212                 struct bt_component *component)
 213 {
 214         return bt_component_filter_get_output_port(component,
 215                         DEFAULT_OUTPUT_PORT_NAME);
 216 }
 217
 218 struct bt_port *bt_component_filter_add_output_port(
 219                 struct bt_component *component, const char *name)
 220 {
 221         struct bt_port *port = NULL;
 222
 223         if (!component ||
 224                         component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 225                 goto end;
 226         }
 227
 228         port = bt_component_add_output_port(component, name);
 229 end:
 230         return port;
 231 }