plugin-loading.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_PLUGIN_PLUGIN_LOADING_H
#define BABELTRACE2_PLUGIN_PLUGIN_LOADING_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <stdint.h>
#include <stddef.h>
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum bt_plugin_find_status {
    BT_PLUGIN_FIND_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_PLUGIN_FIND_STATUS_NOT_FOUND     = __BT_FUNC_STATUS_NOT_FOUND,
 
    BT_PLUGIN_FIND_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_PLUGIN_FIND_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_plugin_find_status;
 
extern bt_plugin_find_status bt_plugin_find(const char *plugin_name,
        bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
        bt_bool find_in_sys_dir, bt_bool find_in_static,
        bt_bool fail_on_load_error, const bt_plugin **plugin)
        __BT_NOEXCEPT;
 
typedef enum bt_plugin_find_all_status {
    BT_PLUGIN_FIND_ALL_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_PLUGIN_FIND_ALL_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND,
 
    BT_PLUGIN_FIND_ALL_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_PLUGIN_FIND_ALL_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_plugin_find_all_status;
 
bt_plugin_find_all_status bt_plugin_find_all(bt_bool find_in_std_env_var,
        bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
        bt_bool find_in_static, bt_bool fail_on_load_error,
        const bt_plugin_set **plugins) __BT_NOEXCEPT;
 
typedef enum bt_plugin_find_all_from_file_status {
    BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_NOT_FOUND       = __BT_FUNC_STATUS_NOT_FOUND,
 
    BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_plugin_find_all_from_file_status;
 
extern bt_plugin_find_all_from_file_status bt_plugin_find_all_from_file(
        const char *path, bt_bool fail_on_load_error,
        const bt_plugin_set **plugins) __BT_NOEXCEPT;
 
typedef enum bt_plugin_find_all_from_dir_status {
    BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK           = __BT_FUNC_STATUS_OK,
 
    BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND        = __BT_FUNC_STATUS_NOT_FOUND,
 
    BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_ERROR        = __BT_FUNC_STATUS_ERROR,
} bt_plugin_find_all_from_dir_status;
 
extern bt_plugin_find_all_from_dir_status bt_plugin_find_all_from_dir(
        const char *path, bt_bool recurse, bt_bool fail_on_load_error,
        const bt_plugin_set **plugins) __BT_NOEXCEPT;
 
typedef enum bt_plugin_find_all_from_static_status {
    BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK            = __BT_FUNC_STATUS_OK,
 
    BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND         = __BT_FUNC_STATUS_NOT_FOUND,
 
    BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_ERROR         = __BT_FUNC_STATUS_ERROR,
} bt_plugin_find_all_from_static_status;
 
extern bt_plugin_find_all_from_static_status bt_plugin_find_all_from_static(
        bt_bool fail_on_load_error, const bt_plugin_set **plugins)
        __BT_NOEXCEPT;
 
extern const char *bt_plugin_get_name(const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern const char *bt_plugin_get_description(const bt_plugin *plugin)
        __BT_NOEXCEPT;
 
extern const char *bt_plugin_get_author(const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern const char *bt_plugin_get_license(const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern const char *bt_plugin_get_path(const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern bt_property_availability bt_plugin_get_version(
        const bt_plugin *plugin, unsigned int *major,
        unsigned int *minor, unsigned int *patch, const char **extra)
        __BT_NOEXCEPT;
 
extern uint64_t bt_plugin_get_source_component_class_count(
        const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern uint64_t bt_plugin_get_filter_component_class_count(
        const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern uint64_t bt_plugin_get_sink_component_class_count(
        const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern const bt_component_class_source *
bt_plugin_borrow_source_component_class_by_index_const(
        const bt_plugin *plugin, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_component_class_filter *
bt_plugin_borrow_filter_component_class_by_index_const(
        const bt_plugin *plugin, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_component_class_sink *
bt_plugin_borrow_sink_component_class_by_index_const(
        const bt_plugin *plugin, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_component_class_source *
bt_plugin_borrow_source_component_class_by_name_const(
        const bt_plugin *plugin, const char *name) __BT_NOEXCEPT;
 
extern const bt_component_class_filter *
bt_plugin_borrow_filter_component_class_by_name_const(
        const bt_plugin *plugin, const char *name) __BT_NOEXCEPT;
 
extern const bt_component_class_sink *
bt_plugin_borrow_sink_component_class_by_name_const(
        const bt_plugin *plugin, const char *name) __BT_NOEXCEPT;
 
extern void bt_plugin_get_ref(const bt_plugin *plugin) __BT_NOEXCEPT;
 
extern void bt_plugin_put_ref(const bt_plugin *plugin) __BT_NOEXCEPT;
 
#define BT_PLUGIN_PUT_REF_AND_RESET(_plugin)        \
    do {                        \
        bt_plugin_put_ref(_plugin);     \
        (_plugin) = NULL;           \
    } while (0)
 
#define BT_PLUGIN_MOVE_REF(_dst, _src)      \
    do {                    \
        bt_plugin_put_ref(_dst);    \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
extern uint64_t bt_plugin_set_get_plugin_count(
        const bt_plugin_set *plugin_set) __BT_NOEXCEPT;
 
extern const bt_plugin *bt_plugin_set_borrow_plugin_by_index_const(
        const bt_plugin_set *plugin_set, uint64_t index) __BT_NOEXCEPT;
 
extern void bt_plugin_set_get_ref(const bt_plugin_set *plugin_set)
        __BT_NOEXCEPT;
 
extern void bt_plugin_set_put_ref(const bt_plugin_set *plugin_set)
        __BT_NOEXCEPT;
 
#define BT_PLUGIN_SET_PUT_REF_AND_RESET(_plugin_set)    \
    do {                        \
        bt_plugin_set_put_ref(_plugin_set); \
        (_plugin_set) = NULL;           \
    } while (0)
 
#define BT_PLUGIN_SET_MOVE_REF(_dst, _src)  \
    do {                    \
        bt_plugin_set_put_ref(_dst);    \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_PLUGIN_PLUGIN_LOADING_H */