1 #ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
2 #define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
5 * Babeltrace - Component Factory Class Interface.
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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
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>
40 * Status code. Errors are always negative.
42 enum bt_component_factory_status
{
44 BT_COMPONENT_FACTORY_STATUS_ERROR
= -128,
46 /** Invalid plugin. */
47 BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN
= -6,
49 /** Invalid arguments. */
50 BT_COMPONENT_FACTORY_STATUS_INVAL
= -5,
52 /** Memory allocation failure. */
53 BT_COMPONENT_FACTORY_STATUS_NOMEM
= -4,
56 BT_COMPONENT_FACTORY_STATUS_IO
= -3,
58 /** No such file or directory. */
59 BT_COMPONENT_FACTORY_STATUS_NOENT
= -2,
61 /** Operation not permitted. */
62 BT_COMPONENT_FACTORY_STATUS_PERM
= -1,
64 /** No error, okay. */
65 BT_COMPONENT_FACTORY_STATUS_OK
= 0,
68 struct bt_component_factory
;
71 * Create a component factory.
73 * @returns An instance of component factory
75 extern struct bt_component_factory
*bt_component_factory_create(void);
78 * Get the number of component classes registered to the component factory.
80 * @param factory A component factory instance
81 * @returns The number of component classes registered to the
82 * component factory, or a negative value on error.
84 extern int bt_component_factory_get_component_class_count(
85 struct bt_component_factory
*factory
);
88 * Get component class at index.
90 * @param factory A component factory instance
91 * @param index Index of the component class to return
92 * @returns A component class instance, NULL on error.
94 extern struct bt_component_class
*bt_component_factory_get_component_class_index(
95 struct bt_component_factory
*factory
, int index
);
98 * Look-up component class.
100 * @param factory A component factory instance
101 * @param plugin_name Name of the plug-in which registered the
103 * @param type Component type (@see #bt_component_type)
104 * @param component_name Component name
105 * @returns A component class instance, NULL on error.
107 extern struct bt_component_class
*bt_component_factory_get_component_class(
108 struct bt_component_factory
*factory
,
109 const char *plugin_name
, enum bt_component_type type
,
110 const char *component_name
);
113 * Recursively load and register Babeltrace plugins under a given path.
115 * Path will be traversed recursively if it is a directory, otherwise only the
116 * provided file will be loaded.
118 * @param factory A component factory instance
119 * @param path A path to a file or directory
120 * @returns One of #bt_component_factory_status values
122 extern enum bt_component_factory_status
bt_component_factory_load(
123 struct bt_component_factory
*factory
, const char *path
);
125 extern enum bt_component_factory_status
126 bt_component_factory_register_source_component_class(
127 struct bt_component_factory
*factory
, const char *name
,
128 bt_component_init_cb init
);
130 extern enum bt_component_factory_status
131 bt_component_factory_register_sink_component_class(
132 struct bt_component_factory
*factory
, const char *name
,
133 bt_component_init_cb init
);
139 #endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */