| 1 | #ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H |
| 2 | #define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H |
| 3 | |
| 4 | /* |
| 5 | * Babeltrace - Component Factory Class Interface. |
| 6 | * |
| 7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * |
| 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 10 | * of this software and associated documentation files (the "Software"), to deal |
| 11 | * in the Software without restriction, including without limitation the rights |
| 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 13 | * copies of the Software, and to permit persons to whom the Software is |
| 14 | * furnished to do so, subject to the following conditions: |
| 15 | * |
| 16 | * The above copyright notice and this permission notice shall be included in |
| 17 | * all copies or substantial portions of the Software. |
| 18 | * |
| 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 25 | * SOFTWARE. |
| 26 | */ |
| 27 | |
| 28 | #include <babeltrace/plugin/component.h> |
| 29 | #include <babeltrace/plugin/source.h> |
| 30 | #include <babeltrace/plugin/sink.h> |
| 31 | #include <babeltrace/plugin/filter.h> |
| 32 | #include <babeltrace/plugin/plugin-system.h> |
| 33 | #include <babeltrace/values.h> |
| 34 | |
| 35 | #ifdef __cplusplus |
| 36 | extern "C" { |
| 37 | #endif |
| 38 | |
| 39 | /** |
| 40 | * Status code. Errors are always negative. |
| 41 | */ |
| 42 | enum bt_component_factory_status { |
| 43 | /** General error. */ |
| 44 | BT_COMPONENT_FACTORY_STATUS_ERROR = -128, |
| 45 | |
| 46 | /** Duplicate component class being registered. */ |
| 47 | BT_COMPONENT_FACTORY_STATUS_DUPLICATE = -7, |
| 48 | |
| 49 | /** Invalid plugin. */ |
| 50 | BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN = -6, |
| 51 | |
| 52 | /** Invalid arguments. */ |
| 53 | BT_COMPONENT_FACTORY_STATUS_INVAL = -5, |
| 54 | |
| 55 | /** Memory allocation failure. */ |
| 56 | BT_COMPONENT_FACTORY_STATUS_NOMEM = -4, |
| 57 | |
| 58 | /** I/O error. */ |
| 59 | BT_COMPONENT_FACTORY_STATUS_IO = -3, |
| 60 | |
| 61 | /** No such file or directory. */ |
| 62 | BT_COMPONENT_FACTORY_STATUS_NOENT = -2, |
| 63 | |
| 64 | /** Operation not permitted. */ |
| 65 | BT_COMPONENT_FACTORY_STATUS_PERM = -1, |
| 66 | |
| 67 | /** No error, okay. */ |
| 68 | BT_COMPONENT_FACTORY_STATUS_OK = 0, |
| 69 | }; |
| 70 | |
| 71 | struct bt_component_factory; |
| 72 | |
| 73 | /** |
| 74 | * Create a component factory. |
| 75 | * |
| 76 | * @returns An instance of component factory |
| 77 | */ |
| 78 | extern struct bt_component_factory *bt_component_factory_create(void); |
| 79 | |
| 80 | /** |
| 81 | * Get the number of component classes registered to the component factory. |
| 82 | * |
| 83 | * @param factory A component factory instance |
| 84 | * @returns The number of component classes registered to the |
| 85 | * component factory, or a negative value on error. |
| 86 | */ |
| 87 | extern int bt_component_factory_get_component_class_count( |
| 88 | struct bt_component_factory *factory); |
| 89 | |
| 90 | /** |
| 91 | * Get component class at index. |
| 92 | * |
| 93 | * @param factory A component factory instance |
| 94 | * @param index Index of the component class to return |
| 95 | * @returns A component class instance, NULL on error. |
| 96 | */ |
| 97 | extern struct bt_component_class *bt_component_factory_get_component_class_index( |
| 98 | struct bt_component_factory *factory, int index); |
| 99 | |
| 100 | /** |
| 101 | * Look-up component class. |
| 102 | * |
| 103 | * @param factory A component factory instance |
| 104 | * @param plugin_name Name of the plug-in which registered the |
| 105 | * component class |
| 106 | * @param type Component type (@see #bt_component_type) |
| 107 | * @param component_name Component name |
| 108 | * @returns A component class instance, NULL on error. |
| 109 | */ |
| 110 | extern struct bt_component_class *bt_component_factory_get_component_class( |
| 111 | struct bt_component_factory *factory, |
| 112 | const char *plugin_name, enum bt_component_type type, |
| 113 | const char *component_name); |
| 114 | |
| 115 | /** |
| 116 | * Load and register Babeltrace plugins under a given path. |
| 117 | * |
| 118 | * Path will be traversed if it is a directory, otherwise only the provided file |
| 119 | * will be loaded. |
| 120 | * |
| 121 | * @param factory A component factory instance |
| 122 | * @param path A path to a file or directory |
| 123 | * @returns One of #bt_component_factory_status values |
| 124 | */ |
| 125 | extern enum bt_component_factory_status bt_component_factory_load( |
| 126 | struct bt_component_factory *factory, const char *path); |
| 127 | |
| 128 | /** |
| 129 | * Recursively load and register Babeltrace plugins under a given path. |
| 130 | * |
| 131 | * Path will be traversed recursively if it is a directory, otherwise only the |
| 132 | * provided file will be loaded. |
| 133 | * |
| 134 | * @param factory A component factory instance |
| 135 | * @param path A path to a file or directory |
| 136 | * @returns One of #bt_component_factory_status values |
| 137 | */ |
| 138 | extern enum bt_component_factory_status bt_component_factory_load_recursive( |
| 139 | struct bt_component_factory *factory, const char *path); |
| 140 | |
| 141 | extern enum bt_component_factory_status |
| 142 | bt_component_factory_register_source_component_class( |
| 143 | struct bt_component_factory *factory, const char *name, |
| 144 | const char *description, bt_component_init_cb init); |
| 145 | |
| 146 | extern enum bt_component_factory_status |
| 147 | bt_component_factory_register_sink_component_class( |
| 148 | struct bt_component_factory *factory, const char *name, |
| 149 | const char *description, bt_component_init_cb init); |
| 150 | |
| 151 | extern enum bt_component_factory_status |
| 152 | bt_component_factory_register_filter_component_class( |
| 153 | struct bt_component_factory *factory, const char *name, |
| 154 | const char *description, bt_component_init_cb init); |
| 155 | |
| 156 | #ifdef __cplusplus |
| 157 | } |
| 158 | #endif |
| 159 | |
| 160 | #endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */ |