graph.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_GRAPH_H
#define BABELTRACE2_GRAPH_GRAPH_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <babeltrace2/types.h>
#include <babeltrace2/logging.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern bt_graph *bt_graph_create(uint64_t mip_version) __BT_NOEXCEPT;
 
typedef enum bt_graph_add_component_status {
    BT_GRAPH_ADD_COMPONENT_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_ADD_COMPONENT_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_ADD_COMPONENT_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_graph_add_component_status;
 
extern bt_graph_add_component_status
bt_graph_add_source_component(bt_graph *graph,
        const bt_component_class_source *component_class,
        const char *name, const bt_value *params,
        bt_logging_level logging_level,
        const bt_component_source **component) __BT_NOEXCEPT;
 
extern bt_graph_add_component_status
bt_graph_add_source_component_with_initialize_method_data(
        bt_graph *graph,
        const bt_component_class_source *component_class,
        const char *name, const bt_value *params,
        void *initialize_method_data, bt_logging_level logging_level,
        const bt_component_source **component) __BT_NOEXCEPT;
 
extern bt_graph_add_component_status
bt_graph_add_filter_component(bt_graph *graph,
        const bt_component_class_filter *component_class,
        const char *name, const bt_value *params,
        bt_logging_level logging_level,
        const bt_component_filter **component) __BT_NOEXCEPT;
 
extern bt_graph_add_component_status
bt_graph_add_filter_component_with_initialize_method_data(
        bt_graph *graph,
        const bt_component_class_filter *component_class,
        const char *name, const bt_value *params,
        void *initialize_method_data, bt_logging_level logging_level,
        const bt_component_filter **component) __BT_NOEXCEPT;
 
extern bt_graph_add_component_status
bt_graph_add_sink_component(
        bt_graph *graph, const bt_component_class_sink *component_class,
        const char *name, const bt_value *params,
        bt_logging_level logging_level,
        const bt_component_sink **component) __BT_NOEXCEPT;
 
extern bt_graph_add_component_status
bt_graph_add_sink_component_with_initialize_method_data(
        bt_graph *graph, const bt_component_class_sink *component_class,
        const char *name, const bt_value *params,
        void *initialize_method_data, bt_logging_level logging_level,
        const bt_component_sink **component) __BT_NOEXCEPT;
 
typedef enum bt_graph_simple_sink_component_initialize_func_status {
    BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_graph_simple_sink_component_initialize_func_status;
 
typedef bt_graph_simple_sink_component_initialize_func_status
(*bt_graph_simple_sink_component_initialize_func)(
        bt_message_iterator *message_iterator,
        void *user_data);
 
typedef enum bt_graph_simple_sink_component_consume_func_status {
    BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK           = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_END          = __BT_FUNC_STATUS_END,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_AGAIN        = __BT_FUNC_STATUS_AGAIN,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_ERROR        = __BT_FUNC_STATUS_ERROR,
} bt_graph_simple_sink_component_consume_func_status;
 
typedef bt_graph_simple_sink_component_consume_func_status
(*bt_graph_simple_sink_component_consume_func)(
        bt_message_iterator *message_iterator,
        void *user_data);
 
typedef void (*bt_graph_simple_sink_component_finalize_func)(void *user_data);
 
extern bt_graph_add_component_status
bt_graph_add_simple_sink_component(bt_graph *graph, const char *name,
        bt_graph_simple_sink_component_initialize_func initialize_func,
        bt_graph_simple_sink_component_consume_func consume_func,
        bt_graph_simple_sink_component_finalize_func finalize_func,
        void *user_data, const bt_component_sink **component) __BT_NOEXCEPT;
 
typedef enum bt_graph_connect_ports_status {
    BT_GRAPH_CONNECT_PORTS_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_CONNECT_PORTS_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_graph_connect_ports_status;
 
extern bt_graph_connect_ports_status bt_graph_connect_ports(bt_graph *graph,
        const bt_port_output *upstream_port,
        const bt_port_input *downstream_port,
        const bt_connection **connection) __BT_NOEXCEPT;
 
typedef enum bt_graph_run_status {
    BT_GRAPH_RUN_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_RUN_STATUS_AGAIN       = __BT_FUNC_STATUS_AGAIN,
 
    BT_GRAPH_RUN_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_RUN_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_graph_run_status;
 
extern bt_graph_run_status bt_graph_run(bt_graph *graph) __BT_NOEXCEPT;
 
typedef enum bt_graph_run_once_status {
    BT_GRAPH_RUN_ONCE_STATUS_OK     = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_RUN_ONCE_STATUS_END        = __BT_FUNC_STATUS_END,
 
    BT_GRAPH_RUN_ONCE_STATUS_AGAIN      = __BT_FUNC_STATUS_AGAIN,
 
    BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_RUN_ONCE_STATUS_ERROR      = __BT_FUNC_STATUS_ERROR,
} bt_graph_run_once_status;
 
extern bt_graph_run_once_status bt_graph_run_once(bt_graph *graph) __BT_NOEXCEPT;
 
typedef enum bt_graph_add_interrupter_status {
    BT_GRAPH_ADD_INTERRUPTER_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_ADD_INTERRUPTER_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_graph_add_interrupter_status;
 
extern bt_graph_add_interrupter_status bt_graph_add_interrupter(bt_graph *graph,
        const bt_interrupter *interrupter) __BT_NOEXCEPT;
 
extern bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph)
        __BT_NOEXCEPT;
 
typedef enum bt_graph_add_listener_status {
    BT_GRAPH_ADD_LISTENER_STATUS_OK         = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_ADD_LISTENER_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_graph_add_listener_status;
 
typedef enum bt_graph_listener_func_status {
    BT_GRAPH_LISTENER_FUNC_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_GRAPH_LISTENER_FUNC_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GRAPH_LISTENER_FUNC_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_graph_listener_func_status;
 
typedef bt_graph_listener_func_status
(*bt_graph_filter_component_input_port_added_listener_func)(
        const bt_component_filter *component,
        const bt_port_input *port, void *user_data);
 
extern bt_graph_add_listener_status
bt_graph_add_filter_component_input_port_added_listener(
        bt_graph *graph,
        bt_graph_filter_component_input_port_added_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
typedef bt_graph_listener_func_status
(*bt_graph_sink_component_input_port_added_listener_func)(
        const bt_component_sink *component,
        const bt_port_input *port, void *user_data);
 
extern bt_graph_add_listener_status
bt_graph_add_sink_component_input_port_added_listener(
        bt_graph *graph,
        bt_graph_sink_component_input_port_added_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
typedef bt_graph_listener_func_status
(*bt_graph_source_component_output_port_added_listener_func)(
        const bt_component_source *component,
        const bt_port_output *port, void *user_data);
 
extern bt_graph_add_listener_status
bt_graph_add_source_component_output_port_added_listener(
        bt_graph *graph,
        bt_graph_source_component_output_port_added_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
typedef bt_graph_listener_func_status
(*bt_graph_filter_component_output_port_added_listener_func)(
        const bt_component_filter *component,
        const bt_port_output *port, void *user_data);
 
extern bt_graph_add_listener_status
bt_graph_add_filter_component_output_port_added_listener(
        bt_graph *graph,
        bt_graph_filter_component_output_port_added_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
extern void bt_graph_get_ref(const bt_graph *graph) __BT_NOEXCEPT;
 
extern void bt_graph_put_ref(const bt_graph *graph) __BT_NOEXCEPT;
 
#define BT_GRAPH_PUT_REF_AND_RESET(_graph)  \
    do {                    \
        bt_graph_put_ref(_graph);   \
        (_graph) = NULL;        \
    } while (0)
 
#define BT_GRAPH_MOVE_REF(_dst, _src)       \
    do {                    \
        bt_graph_put_ref(_dst);     \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_GRAPH_H */