include/babeltrace/plugin/plugin-const.h

   1 #ifndef BABELTRACE_PLUGIN_PLUGIN_CONST_H
   2 #define BABELTRACE_PLUGIN_PLUGIN_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   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 <stdint.h>
  30 #include <stddef.h>
  31
  32 /* For bt_bool */
  33 #include <babeltrace/types.h>
  34
  35 /* For enum bt_component_class_type */
  36 #include <babeltrace/graph/component-class.h>
  37
  38 /* For enum bt_component_class_source */
  39 #include <babeltrace/graph/component-class-source.h>
  40
  41 /* For enum bt_component_class_filter */
  42 #include <babeltrace/graph/component-class-filter.h>
  43
  44 /* For enum bt_component_class_sink */
  45 #include <babeltrace/graph/component-class-sink.h>
  46
  47 /* For enum bt_property_availability */
  48 #include <babeltrace/property.h>
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 struct bt_plugin;
  55 struct bt_plugin_set;
  56 struct bt_component_class;
  57 struct bt_component_class_source;
  58 struct bt_component_class_filter;
  59 struct bt_component_class_sink;
  60
  61 enum bt_plugin_status {
  62         BT_PLUGIN_STATUS_OK =           0,
  63         BT_PLUGIN_STATUS_ERROR =        -1,
  64         BT_PLUGIN_STATUS_NOMEM =        -12,
  65 };
  66
  67 extern const struct bt_plugin *bt_plugin_find(const char *plugin_name);
  68
  69 extern const struct bt_plugin_set *bt_plugin_create_all_from_file(
  70                 const char *path);
  71
  72 extern const struct bt_plugin_set *bt_plugin_create_all_from_dir(
  73                 const char *path, bt_bool recurse);
  74
  75 extern const struct bt_plugin_set *bt_plugin_create_all_from_static(void);
  76
  77 extern const char *bt_plugin_get_name(const struct bt_plugin *plugin);
  78
  79 extern const char *bt_plugin_get_author(const struct bt_plugin *plugin);
  80
  81 extern const char *bt_plugin_get_license(const struct bt_plugin *plugin);
  82
  83 extern const char *bt_plugin_get_description(const struct bt_plugin *plugin);
  84
  85 extern const char *bt_plugin_get_path(const struct bt_plugin *plugin);
  86
  87 extern enum bt_property_availability bt_plugin_get_version(
  88                 const struct bt_plugin *plugin, unsigned int *major,
  89                 unsigned int *minor, unsigned int *patch, const char **extra);
  90
  91 extern uint64_t bt_plugin_get_source_component_class_count(
  92                 const struct bt_plugin *plugin);
  93
  94 extern uint64_t bt_plugin_get_filter_component_class_count(
  95                 const struct bt_plugin *plugin);
  96
  97 extern uint64_t bt_plugin_get_sink_component_class_count(
  98                 const struct bt_plugin *plugin);
  99
 100 extern const struct bt_component_class_source *
 101 bt_plugin_borrow_source_component_class_by_index_const_const(
 102                 const struct bt_plugin *plugin, uint64_t index);
 103
 104 extern const struct bt_component_class_filter *
 105 bt_plugin_borrow_filter_component_class_by_index_const(
 106                 const struct bt_plugin *plugin, uint64_t index);
 107
 108 extern const struct bt_component_class_sink *
 109 bt_plugin_borrow_sink_component_class_by_index_const(
 110                 const struct bt_plugin *plugin, uint64_t index);
 111
 112 extern const struct bt_component_class_source *
 113 bt_plugin_borrow_source_component_class_by_name_const(
 114                 const struct bt_plugin *plugin, const char *name);
 115
 116 extern const struct bt_component_class_filter *
 117 bt_plugin_borrow_filter_component_class_by_name_const(
 118                 const struct bt_plugin *plugin, const char *name);
 119
 120 extern const struct bt_component_class_sink *
 121 bt_plugin_borrow_sink_component_class_by_name_const(
 122                 const struct bt_plugin *plugin, const char *name);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */