include/babeltrace/plugin/plugin.h

   1 #ifndef BABELTRACE_PLUGIN_PLUGIN_H
   2 #define BABELTRACE_PLUGIN_PLUGIN_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Plug-in Interface
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <stddef.h>
  32 #include <stdbool.h>
  33 #include <babeltrace/graph/component-class.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_plugin;
  40 struct bt_component_class;
  41
  42 /**
  43  * Status code. Errors are always negative.
  44  */
  45 enum bt_plugin_status {
  46         /** No error, okay. */
  47         BT_PLUGIN_STATUS_OK =           0,
  48         /** General error. */
  49         BT_PLUGIN_STATUS_ERROR =        -1,
  50         /** Memory allocation failure. */
  51         BT_PLUGIN_STATUS_NOMEM =        -4,
  52 };
  53
  54 extern struct bt_plugin *bt_plugin_find(const char *plugin_name);
  55
  56 extern struct bt_component_class *bt_plugin_find_component_class(
  57                 const char *plugin_name, const char *component_class_name,
  58                 enum bt_component_class_type component_class_type);
  59
  60 extern struct bt_plugin **bt_plugin_create_all_from_file(const char *path);
  61
  62 extern struct bt_plugin **bt_plugin_create_all_from_dir(const char *path,
  63                 bool recurse);
  64
  65 extern struct bt_plugin **bt_plugin_create_all_from_static(void);
  66
  67 /**
  68  * Get the name of a plug-in.
  69  *
  70  * @param plugin        An instance of a plug-in
  71  * @returns             Plug-in name or NULL on error
  72  */
  73 extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
  74
  75 /**
  76  * Get the name of a plug-in's author.
  77  *
  78  * @param plugin        An instance of a plug-in
  79  * @returns             Plug-in author or NULL on error
  80  */
  81 extern const char *bt_plugin_get_author(struct bt_plugin *plugin);
  82
  83 /**
  84  * Get the license of a plug-in.
  85  *
  86  * @param plugin        An instance of a plug-in
  87  * @returns             Plug-in license or NULL on error
  88  */
  89 extern const char *bt_plugin_get_license(struct bt_plugin *plugin);
  90
  91 /**
  92  * Get the decription of a plug-in.
  93  *
  94  * @param plugin        An instance of a plug-in
  95  * @returns             Plug-in description or NULL if none is available
  96  */
  97 extern const char *bt_plugin_get_description(struct bt_plugin *plugin);
  98
  99 /**
 100  * Get the path of a plug-in.
 101  *
 102  * @param plugin        An instance of a plug-in
 103  * @returns             Plug-in path or NULL on error
 104  */
 105 extern const char *bt_plugin_get_path(struct bt_plugin *plugin);
 106
 107 extern enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin,
 108                 unsigned int *major, unsigned int *minor, unsigned int *patch,
 109                 const char **extra);
 110
 111 extern int bt_plugin_get_component_class_count(struct bt_plugin *plugin);
 112
 113 extern struct bt_component_class *bt_plugin_get_component_class(
 114                 struct bt_plugin *plugin, size_t index);
 115
 116 extern
 117 struct bt_component_class *bt_plugin_get_component_class_by_name_and_type(
 118                 struct bt_plugin *plugin, const char *name,
 119                 enum bt_component_class_type type);
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* BABELTRACE_PLUGIN_PLUGIN_H */