include/babeltrace/graph/component-class.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_H
   3
   4 /*
   5  * Babeltrace - Component Class Interface.
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #include <stdint.h>
  29
  30 /* For enum bt_component_status */
  31 #include <babeltrace/graph/component-status.h>
  32
  33 /* For enum bt_notification_iterator_status */
  34 #include <babeltrace/graph/notification-iterator.h>
  35
  36 /* For enum bt_query_status */
  37 #include <babeltrace/graph/query-executor.h>
  38
  39 /* For bt_bool */
  40 #include <babeltrace/types.h>
  41
  42 /* For bt_notification_array */
  43 #include <babeltrace/graph/notification.h>
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 struct bt_component_class;
  50 struct bt_component;
  51 struct bt_private_component;
  52 struct bt_private_port;
  53 struct bt_port;
  54 struct bt_value;
  55 struct bt_private_connection_private_notification_iterator;
  56 struct bt_query_executor;
  57
  58 /**
  59  * Component class type.
  60  */
  61 enum bt_component_class_type {
  62         BT_COMPONENT_CLASS_TYPE_UNKNOWN =       -1,
  63
  64         /** A source component is a notification generator. */
  65         BT_COMPONENT_CLASS_TYPE_SOURCE =        0,
  66
  67         /** A sink component handles incoming notifications. */
  68         BT_COMPONENT_CLASS_TYPE_SINK =          1,
  69
  70         /** A filter component implements both Source and Sink interfaces. */
  71         BT_COMPONENT_CLASS_TYPE_FILTER =        2,
  72 };
  73
  74 struct bt_component_class_query_method_return {
  75         struct bt_value *result;
  76         enum bt_query_status status;
  77 };
  78
  79 typedef enum bt_component_status (*bt_component_class_init_method)(
  80                 struct bt_private_component *private_component,
  81                 struct bt_value *params, void *init_method_data);
  82
  83 typedef void (*bt_component_class_finalize_method)(
  84                 struct bt_private_component *private_component);
  85
  86 typedef enum bt_notification_iterator_status
  87                 (*bt_component_class_notification_iterator_init_method)(
  88                 struct bt_private_connection_private_notification_iterator *notification_iterator,
  89                 struct bt_private_port *private_port);
  90
  91 typedef void (*bt_component_class_notification_iterator_finalize_method)(
  92                 struct bt_private_connection_private_notification_iterator *notification_iterator);
  93
  94 typedef enum bt_notification_iterator_status
  95 (*bt_component_class_notification_iterator_next_method)(
  96                 struct bt_private_connection_private_notification_iterator *notification_iterator,
  97                 bt_notification_array notifs, uint64_t capacity,
  98                 uint64_t *count);
  99
 100 typedef struct bt_component_class_query_method_return (*bt_component_class_query_method)(
 101                 struct bt_component_class *component_class,
 102                 struct bt_query_executor *query_executor,
 103                 const char *object, struct bt_value *params);
 104
 105 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
 106                 struct bt_private_component *private_component,
 107                 struct bt_private_port *self_private_port,
 108                 struct bt_port *other_port);
 109
 110 typedef enum bt_component_status (*bt_component_class_port_connected_method)(
 111                 struct bt_private_component *private_component,
 112                 struct bt_private_port *self_private_port,
 113                 struct bt_port *other_port);
 114
 115 typedef void (*bt_component_class_port_disconnected_method)(
 116                 struct bt_private_component *private_component,
 117                 struct bt_private_port *private_port);
 118
 119 extern int bt_component_class_set_init_method(
 120                 struct bt_component_class *component_class,
 121                 bt_component_class_init_method method);
 122
 123 extern int bt_component_class_set_finalize_method(
 124                 struct bt_component_class *component_class,
 125                 bt_component_class_finalize_method method);
 126
 127 extern int bt_component_class_set_accept_port_connection_method(
 128                 struct bt_component_class *component_class,
 129                 bt_component_class_accept_port_connection_method method);
 130
 131 extern int bt_component_class_set_port_connected_method(
 132                 struct bt_component_class *component_class,
 133                 bt_component_class_port_connected_method method);
 134
 135 extern int bt_component_class_set_port_disconnected_method(
 136                 struct bt_component_class *component_class,
 137                 bt_component_class_port_disconnected_method method);
 138
 139 extern int bt_component_class_set_query_method(
 140                 struct bt_component_class *component_class,
 141                 bt_component_class_query_method method);
 142
 143 extern int bt_component_class_set_description(
 144                 struct bt_component_class *component_class,
 145                 const char *description);
 146
 147 extern int bt_component_class_set_help(
 148                 struct bt_component_class *component_class,
 149                 const char *help);
 150
 151 extern int bt_component_class_freeze(
 152                 struct bt_component_class *component_class);
 153
 154 /**
 155  * Get a component class' name.
 156  *
 157  * @param component_class       Component class of which to get the name
 158  * @returns                     Name of the component class
 159  */
 160 extern const char *bt_component_class_get_name(
 161                 struct bt_component_class *component_class);
 162
 163 /**
 164  * Get a component class' description.
 165  *
 166  * Component classes may provide an optional description. It may, however,
 167  * opt not to.
 168  *
 169  * @param component_class       Component class of which to get the description
 170  * @returns                     Description of the component class, or NULL.
 171  */
 172 extern const char *bt_component_class_get_description(
 173                 struct bt_component_class *component_class);
 174
 175 extern const char *bt_component_class_get_help(
 176                 struct bt_component_class *component_class);
 177
 178 /**
 179  * Get a component class' type.
 180  *
 181  * @param component_class       Component class of which to get the type
 182  * @returns                     One of #bt_component_type
 183  */
 184 extern enum bt_component_class_type bt_component_class_get_type(
 185                 struct bt_component_class *component_class);
 186
 187 static inline
 188 bt_bool bt_component_class_is_source(struct bt_component_class *component_class)
 189 {
 190         return bt_component_class_get_type(component_class) ==
 191                 BT_COMPONENT_CLASS_TYPE_SOURCE;
 192 }
 193
 194 static inline
 195 bt_bool bt_component_class_is_filter(struct bt_component_class *component_class)
 196 {
 197         return bt_component_class_get_type(component_class) ==
 198                 BT_COMPONENT_CLASS_TYPE_FILTER;
 199 }
 200
 201 static inline
 202 bt_bool bt_component_class_is_sink(struct bt_component_class *component_class)
 203 {
 204         return bt_component_class_get_type(component_class) ==
 205                 BT_COMPONENT_CLASS_TYPE_SINK;
 206 }
 207
 208 #ifdef __cplusplus
 209 }
 210 #endif
 211
 212 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */