src/lib/graph/component-class.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2015 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 <babeltrace2/graph/component-const.h>
  30 #include <babeltrace2/graph/component-class.h>
  31 #include <babeltrace2/graph/component-class-source.h>
  32 #include <babeltrace2/graph/component-class-filter.h>
  33 #include <babeltrace2/graph/component-class-sink.h>
  34 #include "common/macros.h"
  35 #include "lib/object.h"
  36 #include "common/list.h"
  37 #include <babeltrace2/types.h>
  38 #include <stdbool.h>
  39 #include <glib.h>
  40
  41 struct bt_component_class;
  42 struct bt_plugin_so_shared_lib_handle;
  43
  44 typedef void (*bt_component_class_destroy_listener_func)(
  45                 struct bt_component_class *class, void *data);
  46
  47 struct bt_component_class_destroy_listener {
  48         bt_component_class_destroy_listener_func func;
  49         void *data;
  50 };
  51
  52 struct bt_component_class {
  53         struct bt_object base;
  54         enum bt_component_class_type type;
  55         GString *name;
  56         GString *description;
  57         GString *help;
  58         GString *plugin_name;
  59
  60         /* Array of struct bt_component_class_destroy_listener */
  61         GArray *destroy_listeners;
  62         bool frozen;
  63         struct bt_list_head node;
  64         struct bt_plugin_so_shared_lib_handle *so_handle;
  65 };
  66
  67 struct bt_component_class_with_iterator_class {
  68         struct bt_component_class parent;
  69         bt_message_iterator_class *msg_iter_cls;
  70 };
  71
  72 struct bt_component_class_source {
  73         struct bt_component_class_with_iterator_class parent;
  74         struct {
  75                 bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions;
  76                 bt_component_class_source_initialize_method init;
  77                 bt_component_class_source_finalize_method finalize;
  78                 bt_component_class_source_query_method query;
  79                 bt_component_class_source_output_port_connected_method output_port_connected;
  80         } methods;
  81 };
  82
  83 struct bt_component_class_filter {
  84         struct bt_component_class_with_iterator_class parent;
  85         struct {
  86                 bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions;
  87                 bt_component_class_filter_initialize_method init;
  88                 bt_component_class_filter_finalize_method finalize;
  89                 bt_component_class_filter_query_method query;
  90                 bt_component_class_filter_input_port_connected_method input_port_connected;
  91                 bt_component_class_filter_output_port_connected_method output_port_connected;
  92         } methods;
  93 };
  94
  95 struct bt_component_class_sink {
  96         struct bt_component_class parent;
  97         struct {
  98                 bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions;
  99                 bt_component_class_sink_initialize_method init;
 100                 bt_component_class_sink_finalize_method finalize;
 101                 bt_component_class_sink_query_method query;
 102                 bt_component_class_sink_input_port_connected_method input_port_connected;
 103                 bt_component_class_sink_graph_is_configured_method graph_is_configured;
 104                 bt_component_class_sink_consume_method consume;
 105         } methods;
 106 };
 107
 108 BT_HIDDEN
 109 void bt_component_class_add_destroy_listener(struct bt_component_class *class,
 110                 bt_component_class_destroy_listener_func func, void *data);
 111
 112 BT_HIDDEN
 113 void _bt_component_class_freeze(
 114                 const struct bt_component_class *component_class);
 115
 116 #ifdef BT_DEV_MODE
 117 # define bt_component_class_freeze      _bt_component_class_freeze
 118 #else
 119 # define bt_component_class_freeze(_cc)
 120 #endif
 121
 122 static inline
 123 const char *bt_component_class_type_string(enum bt_component_class_type type)
 124 {
 125         switch (type) {
 126         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 127                 return "SOURCE";
 128         case BT_COMPONENT_CLASS_TYPE_SINK:
 129                 return "SINK";
 130         case BT_COMPONENT_CLASS_TYPE_FILTER:
 131                 return "FILTER";
 132         default:
 133                 return "(unknown)";
 134         }
 135 }
 136
 137 static inline
 138 bool bt_component_class_has_message_iterator_class(
 139         struct bt_component_class *component_class)
 140 {
 141         return component_class->type == BT_COMPONENT_CLASS_TYPE_SOURCE ||
 142                 component_class->type == BT_COMPONENT_CLASS_TYPE_FILTER;
 143 }
 144
 145 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */