include/babeltrace/graph/component-internal.h

   1 #ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_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 <glib.h>
  37 #include <stdio.h>
  38
  39 typedef void (*bt_component_destroy_listener_func)(
  40                 struct bt_component *class, void *data);
  41
  42 struct bt_component_destroy_listener {
  43         bt_component_destroy_listener_func func;
  44         void *data;
  45 };
  46
  47 struct bt_component {
  48         struct bt_object base;
  49         struct bt_component_class *class;
  50         GString *name;
  51
  52         /*
  53          * Internal destroy function specific to a source, filter, or
  54          * sink component object.
  55          */
  56         void (*destroy)(struct bt_component *);
  57
  58         /* User-defined data */
  59         void *user_data;
  60
  61         /*
  62          * Used to protect operations which may only be used during
  63          * a component's initialization.
  64          */
  65         bt_bool initializing;
  66
  67         /* Input and output ports (weak references) */
  68         GPtrArray *input_ports;
  69         GPtrArray *output_ports;
  70
  71         /* Array of struct bt_component_destroy_listener */
  72         GArray *destroy_listeners;
  73 };
  74
  75 static inline
  76 struct bt_component *bt_component_from_private(
  77                 struct bt_private_component *private_component)
  78 {
  79         return (void *) private_component;
  80 }
  81
  82 static inline
  83 struct bt_private_component *bt_private_component_from_component(
  84                 struct bt_component *component)
  85 {
  86         return (void *) component;
  87 }
  88
  89 BT_HIDDEN
  90 enum bt_component_status bt_component_accept_port_connection(
  91                 struct bt_component *component, struct bt_port *self_port,
  92                 struct bt_port *other_port);
  93
  94 BT_HIDDEN
  95 void bt_component_port_connected(struct bt_component *comp,
  96                 struct bt_port *self_port, struct bt_port *other_port);
  97
  98 BT_HIDDEN
  99 void bt_component_port_disconnected(struct bt_component *comp,
 100                 struct bt_port *port);
 101
 102 BT_HIDDEN
 103 void bt_component_set_graph(struct bt_component *component,
 104                 struct bt_graph *graph);
 105
 106 BT_HIDDEN
 107 int64_t bt_component_get_input_port_count(struct bt_component *comp);
 108
 109 BT_HIDDEN
 110 int64_t bt_component_get_output_port_count(struct bt_component *comp);
 111
 112 BT_HIDDEN
 113 struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
 114                 uint64_t index);
 115
 116 BT_HIDDEN
 117 struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
 118                 uint64_t index);
 119
 120 BT_HIDDEN
 121 struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
 122                 const char *name);
 123
 124 BT_HIDDEN
 125 struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
 126                 const char *name);
 127
 128 BT_HIDDEN
 129 struct bt_port *bt_component_add_input_port(
 130                 struct bt_component *component, const char *name,
 131                 void *user_data);
 132
 133 BT_HIDDEN
 134 struct bt_port *bt_component_add_output_port(
 135                 struct bt_component *component, const char *name,
 136                 void *user_data);
 137
 138 BT_HIDDEN
 139 enum bt_component_status bt_component_remove_port(
 140                 struct bt_component *component, struct bt_port *port);
 141
 142 BT_HIDDEN
 143 void bt_component_add_destroy_listener(struct bt_component *component,
 144                 bt_component_destroy_listener_func func, void *data);
 145
 146 BT_HIDDEN
 147 void bt_component_remove_destroy_listener(struct bt_component *component,
 148                 bt_component_destroy_listener_func func, void *data);
 149
 150 static inline
 151 const char *bt_component_status_string(enum bt_component_status status)
 152 {
 153         switch (status) {
 154         case BT_COMPONENT_STATUS_OK:
 155                 return "BT_COMPONENT_STATUS_OK";
 156         case BT_COMPONENT_STATUS_END:
 157                 return "BT_COMPONENT_STATUS_END";
 158         case BT_COMPONENT_STATUS_AGAIN:
 159                 return "BT_COMPONENT_STATUS_AGAIN";
 160         case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
 161                 return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
 162         case BT_COMPONENT_STATUS_ERROR:
 163                 return "BT_COMPONENT_STATUS_ERROR";
 164         case BT_COMPONENT_STATUS_UNSUPPORTED:
 165                 return "BT_COMPONENT_STATUS_UNSUPPORTED";
 166         case BT_COMPONENT_STATUS_INVALID:
 167                 return "BT_COMPONENT_STATUS_INVALID";
 168         case BT_COMPONENT_STATUS_NOMEM:
 169                 return "BT_COMPONENT_STATUS_NOMEM";
 170         case BT_COMPONENT_STATUS_NOT_FOUND:
 171                 return "BT_COMPONENT_STATUS_NOT_FOUND";
 172         default:
 173                 return "(unknown)";
 174         }
 175 }
 176
 177 #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */