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>
39 * Status code. Errors are always negative.
41 enum bt_component_factory_status
{
43 BT_COMPONENT_FACTORY_STATUS_ERROR
= -128,
45 /** Invalid arguments. */
46 /* -22 for compatibility with -EINVAL */
47 BT_COMPONENT_FACTORY_STATUS_INVAL
= -22,
49 /** Memory allocation failure. */
50 /* -12 for compatibility with -ENOMEM */
51 BT_COMPONENT_FACTORY_STATUS_NOMEM
= -12,
54 /* -5 for compatibility with -EIO */
55 BT_COMPONENT_FACTORY_STATUS_IO
= -5,
57 /** No such file or directory. */
58 /* -2 for compatibility with -ENOENT */
59 BT_COMPONENT_FACTORY_STATUS_NOENT
= -2,
61 /** Operation not permitted. */
62 /* -1 for compatibility with -EPERM */
63 BT_COMPONENT_FACTORY_STATUS_PERM
= -1,
65 /** No error, okay. */
66 BT_COMPONENT_FACTORY_STATUS_OK
= 0,
69 struct bt_component_factory
;
72 * Create a component factory.
74 * @returns An instance of component factory
77 struct bt_component_factory
*bt_component_factory_create(void);
80 * Recursively load and register Babeltrace plugins under a given path.
82 * Path will be traversed recursively if it is a directory, otherwise only the
83 * provided file will be loaded.
85 * @param factory A component factory instance
86 * @param path A path to a file or directory
87 * @returns One of #bt_component_factory_status values
90 enum bt_component_factory_status
bt_component_factory_load(
91 struct bt_component_factory
*factory
, const char *path
);
94 enum bt_component_factory_status
95 bt_component_factory_register_source_component_class(
96 struct bt_component_factory
*factory
, const char *name
,
97 bt_component_source_init_cb init
);
100 enum bt_component_factory_status
bt_component_factory_register_sink_component_class(
101 struct bt_component_factory
*factory
, const char *name
,
102 bt_component_sink_init_cb init
);
105 void bt_component_factory_destroy(struct bt_component_factory
*factory
);
111 #endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */