include/babeltrace/graph/component-internal.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
   2 #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Component internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/babeltrace-internal.h>
  31 #include <babeltrace/graph/component.h>
  32 #include <babeltrace/graph/component-class-internal.h>
  33 #include <babeltrace/graph/port-internal.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/types.h>
  36 #include <babeltrace/assert-internal.h>
  37 #include <glib.h>
  38 #include <stdio.h>
  39
  40 typedef void (*bt_component_destroy_listener_func)(
  41                 struct bt_component *class, void *data);
  42
  43 struct bt_component_destroy_listener {
  44         bt_component_destroy_listener_func func;
  45         void *data;
  46 };
  47
  48 struct bt_graph;
  49
  50 struct bt_component {
  51         struct bt_object base;
  52         struct bt_component_class *class;
  53         GString *name;
  54
  55         /*
  56          * Internal destroy function specific to a source, filter, or
  57          * sink component object.
  58          */
  59         void (*destroy)(struct bt_component *);
  60
  61         /* User-defined data */
  62         void *user_data;
  63
  64         /* Input and output ports (weak references) */
  65         GPtrArray *input_ports;
  66         GPtrArray *output_ports;
  67
  68         /* Array of struct bt_component_destroy_listener */
  69         GArray *destroy_listeners;
  70
  71         bool initialized;
  72 };
  73
  74 static inline
  75 struct bt_private_component *bt_private_component_from_component(
  76                 struct bt_component *component)
  77 {
  78         return (void *) component;
  79 }
  80
  81 static inline
  82 struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
  83 {
  84         BT_ASSERT(comp);
  85         return (void *) bt_object_borrow_parent(&comp->base);
  86 }
  87
  88 BT_HIDDEN
  89 enum bt_component_status bt_component_create(
  90                 struct bt_component_class *component_class,
  91                 const char *name, struct bt_component **component);
  92
  93 BT_HIDDEN
  94 enum bt_component_status bt_component_accept_port_connection(
  95                 struct bt_component *component, struct bt_port *self_port,
  96                 struct bt_port *other_port);
  97
  98 BT_HIDDEN
  99 enum bt_component_status bt_component_port_connected(
 100                 struct bt_component *comp,
 101                 struct bt_port *self_port, struct bt_port *other_port);
 102
 103 BT_HIDDEN
 104 void bt_component_port_disconnected(struct bt_component *comp,
 105                 struct bt_port *port);
 106
 107 BT_HIDDEN
 108 void bt_component_set_graph(struct bt_component *component,
 109                 struct bt_graph *graph);
 110
 111 BT_HIDDEN
 112 int64_t bt_component_get_input_port_count(struct bt_component *comp);
 113
 114 BT_HIDDEN
 115 int64_t bt_component_get_output_port_count(struct bt_component *comp);
 116
 117 BT_HIDDEN
 118 struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
 119                 uint64_t index);
 120
 121 BT_HIDDEN
 122 struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
 123                 uint64_t index);
 124
 125 BT_HIDDEN
 126 struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
 127                 const char *name);
 128
 129 BT_HIDDEN
 130 struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
 131                 const char *name);
 132
 133 BT_HIDDEN
 134 struct bt_port *bt_component_add_input_port(
 135                 struct bt_component *component, const char *name,
 136                 void *user_data);
 137
 138 BT_HIDDEN
 139 struct bt_port *bt_component_add_output_port(
 140                 struct bt_component *component, const char *name,
 141                 void *user_data);
 142
 143 BT_HIDDEN
 144 enum bt_component_status bt_component_remove_port(
 145                 struct bt_component *component, struct bt_port *port);
 146
 147 BT_HIDDEN
 148 void bt_component_add_destroy_listener(struct bt_component *component,
 149                 bt_component_destroy_listener_func func, void *data);
 150
 151 BT_HIDDEN
 152 void bt_component_remove_destroy_listener(struct bt_component *component,
 153                 bt_component_destroy_listener_func func, void *data);
 154
 155 static inline
 156 const char *bt_component_status_string(enum bt_component_status status)
 157 {
 158         switch (status) {
 159         case BT_COMPONENT_STATUS_OK:
 160                 return "BT_COMPONENT_STATUS_OK";
 161         case BT_COMPONENT_STATUS_END:
 162                 return "BT_COMPONENT_STATUS_END";
 163         case BT_COMPONENT_STATUS_AGAIN:
 164                 return "BT_COMPONENT_STATUS_AGAIN";
 165         case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
 166                 return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
 167         case BT_COMPONENT_STATUS_ERROR:
 168                 return "BT_COMPONENT_STATUS_ERROR";
 169         case BT_COMPONENT_STATUS_UNSUPPORTED:
 170                 return "BT_COMPONENT_STATUS_UNSUPPORTED";
 171         case BT_COMPONENT_STATUS_INVALID:
 172                 return "BT_COMPONENT_STATUS_INVALID";
 173         case BT_COMPONENT_STATUS_NOMEM:
 174                 return "BT_COMPONENT_STATUS_NOMEM";
 175         case BT_COMPONENT_STATUS_NOT_FOUND:
 176                 return "BT_COMPONENT_STATUS_NOT_FOUND";
 177         case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
 178                 return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
 179         default:
 180                 return "(unknown)";
 181         }
 182 }
 183
 184 #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */