component.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_COMPONENT_H
#define BABELTRACE2_GRAPH_COMPONENT_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/types.h>
#include <babeltrace2/logging.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern bt_component_class_type bt_component_get_class_type(
        const bt_component *component) __BT_NOEXCEPT;
 
static inline
bt_bool bt_component_is_source(const bt_component *component) __BT_NOEXCEPT
{
    return bt_component_get_class_type(component) ==
        BT_COMPONENT_CLASS_TYPE_SOURCE;
}
 
static inline
bt_bool bt_component_is_filter(const bt_component *component) __BT_NOEXCEPT
{
    return bt_component_get_class_type(component) ==
        BT_COMPONENT_CLASS_TYPE_FILTER;
}
 
static inline
bt_bool bt_component_is_sink(const bt_component *component) __BT_NOEXCEPT
{
    return bt_component_get_class_type(component) ==
        BT_COMPONENT_CLASS_TYPE_SINK;
}
 
extern const bt_component_class *bt_component_borrow_class_const(
        const bt_component *component) __BT_NOEXCEPT;
 
extern const char *bt_component_get_name(const bt_component *component)
        __BT_NOEXCEPT;
 
extern bt_logging_level bt_component_get_logging_level(
        const bt_component *component) __BT_NOEXCEPT;
 
extern void bt_component_get_ref(const bt_component *component) __BT_NOEXCEPT;
 
extern void bt_component_put_ref(const bt_component *component) __BT_NOEXCEPT;
 
#define BT_COMPONENT_PUT_REF_AND_RESET(_component)  \
    do {                        \
        bt_component_put_ref(_component);   \
        (_component) = NULL;            \
    } while (0)
 
#define BT_COMPONENT_MOVE_REF(_dst, _src)   \
    do {                    \
        bt_component_put_ref(_dst); \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
extern const bt_component_class_source *
bt_component_source_borrow_class_const(
        const bt_component_source *component) __BT_NOEXCEPT;
 
static inline
const bt_component *bt_component_source_as_component_const(
        const bt_component_source *component) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component, component);
}
 
extern uint64_t bt_component_source_get_output_port_count(
        const bt_component_source *component) __BT_NOEXCEPT;
 
extern const bt_port_output *
bt_component_source_borrow_output_port_by_index_const(
        const bt_component_source *component,
        uint64_t index) __BT_NOEXCEPT;
 
extern const bt_port_output *
bt_component_source_borrow_output_port_by_name_const(
        const bt_component_source *component,
        const char *name) __BT_NOEXCEPT;
 
extern void bt_component_source_get_ref(
        const bt_component_source *component) __BT_NOEXCEPT;
 
extern void bt_component_source_put_ref(
        const bt_component_source *component) __BT_NOEXCEPT;
 
#define BT_COMPONENT_SOURCE_PUT_REF_AND_RESET(_component)   \
    do {                            \
        bt_component_source_put_ref(_component);    \
        (_component) = NULL;                \
    } while (0)
 
#define BT_COMPONENT_SOURCE_MOVE_REF(_dst, _src)    \
    do {                        \
        bt_component_source_put_ref(_dst);  \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
extern const bt_component_class_filter *
bt_component_filter_borrow_class_const(
        const bt_component_filter *component) __BT_NOEXCEPT;
 
static inline
const bt_component *bt_component_filter_as_component_const(
        const bt_component_filter *component) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component, component);
}
 
extern uint64_t bt_component_filter_get_input_port_count(
        const bt_component_filter *component) __BT_NOEXCEPT;
 
extern const bt_port_input *
bt_component_filter_borrow_input_port_by_index_const(
        const bt_component_filter *component, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_port_input *
bt_component_filter_borrow_input_port_by_name_const(
        const bt_component_filter *component, const char *name)
        __BT_NOEXCEPT;
 
extern uint64_t bt_component_filter_get_output_port_count(
        const bt_component_filter *component) __BT_NOEXCEPT;
 
extern const bt_port_output *
bt_component_filter_borrow_output_port_by_index_const(
        const bt_component_filter *component, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_port_output *
bt_component_filter_borrow_output_port_by_name_const(
        const bt_component_filter *component, const char *name)
        __BT_NOEXCEPT;
 
extern void bt_component_filter_get_ref(
        const bt_component_filter *component) __BT_NOEXCEPT;
 
extern void bt_component_filter_put_ref(
        const bt_component_filter *component) __BT_NOEXCEPT;
 
#define BT_COMPONENT_FILTER_PUT_REF_AND_RESET(_component)   \
    do {                            \
        bt_component_filter_put_ref(_component);    \
        (_component) = NULL;                \
    } while (0)
 
#define BT_COMPONENT_FILTER_MOVE_REF(_dst, _src)    \
    do {                        \
        bt_component_filter_put_ref(_dst);  \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
extern const bt_component_class_sink *
bt_component_sink_borrow_class_const(
        const bt_component_sink *component) __BT_NOEXCEPT;
 
static inline
const bt_component *bt_component_sink_as_component_const(
        const bt_component_sink *component) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component, component);
}
 
extern uint64_t bt_component_sink_get_input_port_count(
        const bt_component_sink *component) __BT_NOEXCEPT;
 
extern const bt_port_input *
bt_component_sink_borrow_input_port_by_index_const(
        const bt_component_sink *component, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_port_input *
bt_component_sink_borrow_input_port_by_name_const(
        const bt_component_sink *component, const char *name)
        __BT_NOEXCEPT;
 
extern void bt_component_sink_get_ref(
        const bt_component_sink *component) __BT_NOEXCEPT;
 
extern void bt_component_sink_put_ref(
        const bt_component_sink *component) __BT_NOEXCEPT;
 
#define BT_COMPONENT_SINK_PUT_REF_AND_RESET(_component)     \
    do {                            \
        bt_component_sink_put_ref(_component);      \
        (_component) = NULL;                \
    } while (0)
 
#define BT_COMPONENT_SINK_MOVE_REF(_dst, _src)      \
    do {                        \
        bt_component_sink_put_ref(_dst);    \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_COMPONENT_H */