[babeltrace.git] / include / babeltrace2 / graph / graph.h

#ifndef BABELTRACE2_GRAPH_GRAPH_H
#define BABELTRACE2_GRAPH_GRAPH_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#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

typedef enum bt_graph_listener_func_status {
	BT_GRAPH_LISTENER_FUNC_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_GRAPH_LISTENER_FUNC_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_GRAPH_LISTENER_FUNC_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_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 *data);

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 *data);

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 *data);

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 *data);

typedef bt_graph_listener_func_status
(*bt_graph_source_filter_component_ports_connected_listener_func)(
		const bt_component_source *source_component,
		const bt_component_filter *filter_component,
		const bt_port_output *upstream_port,
		const bt_port_input *downstream_port, void *data);

typedef bt_graph_listener_func_status
(*bt_graph_source_sink_component_ports_connected_listener_func)(
		const bt_component_source *source_component,
		const bt_component_sink *sink_component,
		const bt_port_output *upstream_port,
		const bt_port_input *downstream_port, void *data);

typedef bt_graph_listener_func_status
(*bt_graph_filter_filter_component_ports_connected_listener_func)(
		const bt_component_filter *filter_component_upstream,
		const bt_component_filter *filter_component_downstream,
		const bt_port_output *upstream_port,
		const bt_port_input *downstream_port,
		void *data);

typedef bt_graph_listener_func_status
(*bt_graph_filter_sink_component_ports_connected_listener_func)(
		const bt_component_filter *filter_component,
		const bt_component_sink *sink_component,
		const bt_port_output *upstream_port,
		const bt_port_input *downstream_port, void *data);

typedef void (* bt_graph_listener_removed_func)(void *data);

extern bt_graph *bt_graph_create(void);

typedef enum bt_graph_add_component_status {
	BT_GRAPH_ADD_COMPONENT_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_GRAPH_ADD_COMPONENT_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_GRAPH_ADD_COMPONENT_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_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 log_level, const bt_component_source **component);

extern bt_graph_add_component_status
bt_graph_add_source_component_with_init_method_data(
		bt_graph *graph,
		const bt_component_class_source *component_class,
		const char *name, const bt_value *params,
		void *init_method_data, bt_logging_level log_level,
		const bt_component_source **component);

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 log_level,
		const bt_component_filter **component);

extern bt_graph_add_component_status
bt_graph_add_filter_component_with_init_method_data(
		bt_graph *graph,
		const bt_component_class_filter *component_class,
		const char *name, const bt_value *params,
		void *init_method_data, bt_logging_level log_level,
		const bt_component_filter **component);

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 log_level,
		const bt_component_sink **component);

extern bt_graph_add_component_status
bt_graph_add_sink_component_with_init_method_data(
		bt_graph *graph, const bt_component_class_sink *component_class,
		const char *name, const bt_value *params,
		void *init_method_data, bt_logging_level log_level,
		const bt_component_sink **component);

typedef enum bt_graph_connect_ports_status {
	BT_GRAPH_CONNECT_PORTS_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_GRAPH_CONNECT_PORTS_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_GRAPH_CONNECT_PORTS_STATUS_CANCELED		= __BT_FUNC_STATUS_CANCELED,
	BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_graph_connect_ports_status;

extern bt_graph_connect_ports_status bt_graph_connect_ports(bt_graph *graph,
		const bt_port_output *upstream,
		const bt_port_input *downstream,
		const bt_connection **connection);

typedef enum bt_graph_run_status {
	BT_GRAPH_RUN_STATUS_OK			= __BT_FUNC_STATUS_OK,
	BT_GRAPH_RUN_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_GRAPH_RUN_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_GRAPH_RUN_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_GRAPH_RUN_STATUS_END			= __BT_FUNC_STATUS_END,
	BT_GRAPH_RUN_STATUS_CANCELED		= __BT_FUNC_STATUS_CANCELED,
} bt_graph_run_status;

extern bt_graph_run_status bt_graph_run(bt_graph *graph);

typedef enum bt_graph_consume_status {
	BT_GRAPH_CONSUME_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_GRAPH_CONSUME_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_GRAPH_CONSUME_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_GRAPH_CONSUME_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_GRAPH_CONSUME_STATUS_END		= __BT_FUNC_STATUS_END,
	BT_GRAPH_CONSUME_STATUS_CANCELED	= __BT_FUNC_STATUS_CANCELED,
} bt_graph_consume_status;

extern bt_graph_consume_status bt_graph_consume(bt_graph *graph);

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;

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 listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

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 listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

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 listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

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 listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

extern bt_graph_add_listener_status
bt_graph_add_source_filter_component_ports_connected_listener(
		bt_graph *graph,
		bt_graph_source_filter_component_ports_connected_listener_func listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

extern bt_graph_add_listener_status
bt_graph_add_filter_filter_component_ports_connected_listener(
		bt_graph *graph,
		bt_graph_filter_filter_component_ports_connected_listener_func listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

extern bt_graph_add_listener_status
bt_graph_add_source_sink_component_ports_connected_listener(
		bt_graph *graph,
		bt_graph_source_sink_component_ports_connected_listener_func listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

extern bt_graph_add_listener_status
bt_graph_add_filter_sink_component_ports_connected_listener(
		bt_graph *graph,
		bt_graph_filter_sink_component_ports_connected_listener_func listener,
		bt_graph_listener_removed_func listener_removed, void *data,
		int *listener_id);

typedef enum bt_graph_cancel_status {
	BT_GRAPH_CANCEL_STATUS_OK	= __BT_FUNC_STATUS_OK,
} bt_graph_cancel_status;

extern bt_graph_cancel_status bt_graph_cancel(bt_graph *graph);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_GRAPH_GRAPH_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_GRAPH_GRAPH_H
	2	#define BABELTRACE2_GRAPH_GRAPH_H
	3
	4	/*
	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
	30	#include <babeltrace2/types.h>
	31	#include <babeltrace2/logging.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	typedef enum bt_graph_listener_func_status {
	38	BT_GRAPH_LISTENER_FUNC_STATUS_OK = __BT_FUNC_STATUS_OK,
	39	BT_GRAPH_LISTENER_FUNC_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	40	BT_GRAPH_LISTENER_FUNC_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	41	} bt_graph_listener_func_status;
	42
	43	typedef bt_graph_listener_func_status
	44	(*bt_graph_filter_component_input_port_added_listener_func)(
	45	const bt_component_filter *component,
	46	const bt_port_input port, void data);
	47
	48	typedef bt_graph_listener_func_status
	49	(*bt_graph_sink_component_input_port_added_listener_func)(
	50	const bt_component_sink *component,
	51	const bt_port_input port, void data);
	52
	53	typedef bt_graph_listener_func_status
	54	(*bt_graph_source_component_output_port_added_listener_func)(
	55	const bt_component_source *component,
	56	const bt_port_output port, void data);
	57
	58	typedef bt_graph_listener_func_status
	59	(*bt_graph_filter_component_output_port_added_listener_func)(
	60	const bt_component_filter *component,
	61	const bt_port_output port, void data);
	62
	63	typedef bt_graph_listener_func_status
	64	(*bt_graph_source_filter_component_ports_connected_listener_func)(
	65	const bt_component_source *source_component,
	66	const bt_component_filter *filter_component,
	67	const bt_port_output *upstream_port,
	68	const bt_port_input downstream_port, void data);
	69
	70	typedef bt_graph_listener_func_status
	71	(*bt_graph_source_sink_component_ports_connected_listener_func)(
	72	const bt_component_source *source_component,
	73	const bt_component_sink *sink_component,
	74	const bt_port_output *upstream_port,
	75	const bt_port_input downstream_port, void data);
	76
	77	typedef bt_graph_listener_func_status
	78	(*bt_graph_filter_filter_component_ports_connected_listener_func)(
	79	const bt_component_filter *filter_component_upstream,
	80	const bt_component_filter *filter_component_downstream,
	81	const bt_port_output *upstream_port,
	82	const bt_port_input *downstream_port,
	83	void *data);
	84
	85	typedef bt_graph_listener_func_status
	86	(*bt_graph_filter_sink_component_ports_connected_listener_func)(
	87	const bt_component_filter *filter_component,
	88	const bt_component_sink *sink_component,
	89	const bt_port_output *upstream_port,
	90	const bt_port_input downstream_port, void data);
	91
	92	typedef void (* bt_graph_listener_removed_func)(void *data);
	93
	94	extern bt_graph *bt_graph_create(void);
	95
	96	typedef enum bt_graph_add_component_status {
	97	BT_GRAPH_ADD_COMPONENT_STATUS_OK = __BT_FUNC_STATUS_OK,
	98	BT_GRAPH_ADD_COMPONENT_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	99	BT_GRAPH_ADD_COMPONENT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	100	} bt_graph_add_component_status;
	101
	102	extern bt_graph_add_component_status
	103	bt_graph_add_source_component(bt_graph *graph,
	104	const bt_component_class_source *component_class,
	105	const char name, const bt_value params,
	106	bt_logging_level log_level, const bt_component_source **component);
	107
	108	extern bt_graph_add_component_status
	109	bt_graph_add_source_component_with_init_method_data(
	110	bt_graph *graph,
	111	const bt_component_class_source *component_class,
	112	const char name, const bt_value params,
	113	void *init_method_data, bt_logging_level log_level,
	114	const bt_component_source **component);
	115
	116	extern bt_graph_add_component_status
	117	bt_graph_add_filter_component(bt_graph *graph,
	118	const bt_component_class_filter *component_class,
	119	const char name, const bt_value params,
	120	bt_logging_level log_level,
	121	const bt_component_filter **component);
	122
	123	extern bt_graph_add_component_status
	124	bt_graph_add_filter_component_with_init_method_data(
	125	bt_graph *graph,
	126	const bt_component_class_filter *component_class,
	127	const char name, const bt_value params,
	128	void *init_method_data, bt_logging_level log_level,
	129	const bt_component_filter **component);
	130
	131	extern bt_graph_add_component_status
	132	bt_graph_add_sink_component(
	133	bt_graph graph, const bt_component_class_sink component_class,
	134	const char name, const bt_value params,
	135	bt_logging_level log_level,
	136	const bt_component_sink **component);
	137
	138	extern bt_graph_add_component_status
	139	bt_graph_add_sink_component_with_init_method_data(
	140	bt_graph graph, const bt_component_class_sink component_class,
	141	const char name, const bt_value params,
	142	void *init_method_data, bt_logging_level log_level,
	143	const bt_component_sink **component);
	144
	145	typedef enum bt_graph_connect_ports_status {
	146	BT_GRAPH_CONNECT_PORTS_STATUS_OK = __BT_FUNC_STATUS_OK,
	147	BT_GRAPH_CONNECT_PORTS_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	148	BT_GRAPH_CONNECT_PORTS_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED,
	149	BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	150	} bt_graph_connect_ports_status;
	151
	152	extern bt_graph_connect_ports_status bt_graph_connect_ports(bt_graph *graph,
	153	const bt_port_output *upstream,
	154	const bt_port_input *downstream,
	155	const bt_connection **connection);
	156
	157	typedef enum bt_graph_run_status {
	158	BT_GRAPH_RUN_STATUS_OK = __BT_FUNC_STATUS_OK,
	159	BT_GRAPH_RUN_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	160	BT_GRAPH_RUN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	161	BT_GRAPH_RUN_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	162	BT_GRAPH_RUN_STATUS_END = __BT_FUNC_STATUS_END,
	163	BT_GRAPH_RUN_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED,
	164	} bt_graph_run_status;
	165
	166	extern bt_graph_run_status bt_graph_run(bt_graph *graph);
	167
	168	typedef enum bt_graph_consume_status {
	169	BT_GRAPH_CONSUME_STATUS_OK = __BT_FUNC_STATUS_OK,
	170	BT_GRAPH_CONSUME_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	171	BT_GRAPH_CONSUME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	172	BT_GRAPH_CONSUME_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	173	BT_GRAPH_CONSUME_STATUS_END = __BT_FUNC_STATUS_END,
	174	BT_GRAPH_CONSUME_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED,
	175	} bt_graph_consume_status;
	176
	177	extern bt_graph_consume_status bt_graph_consume(bt_graph *graph);
	178
	179	typedef enum bt_graph_add_listener_status {
	180	BT_GRAPH_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
	181	BT_GRAPH_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	182	} bt_graph_add_listener_status;
	183
	184	extern bt_graph_add_listener_status
	185	bt_graph_add_filter_component_input_port_added_listener(
	186	bt_graph *graph,
	187	bt_graph_filter_component_input_port_added_listener_func listener,
	188	bt_graph_listener_removed_func listener_removed, void *data,
	189	int *listener_id);
	190
	191	extern bt_graph_add_listener_status
	192	bt_graph_add_sink_component_input_port_added_listener(
	193	bt_graph *graph,
	194	bt_graph_sink_component_input_port_added_listener_func listener,
	195	bt_graph_listener_removed_func listener_removed, void *data,
	196	int *listener_id);
	197
	198	extern bt_graph_add_listener_status
	199	bt_graph_add_source_component_output_port_added_listener(
	200	bt_graph *graph,
	201	bt_graph_source_component_output_port_added_listener_func listener,
	202	bt_graph_listener_removed_func listener_removed, void *data,
	203	int *listener_id);
	204
	205	extern bt_graph_add_listener_status
	206	bt_graph_add_filter_component_output_port_added_listener(
	207	bt_graph *graph,
	208	bt_graph_filter_component_output_port_added_listener_func listener,
	209	bt_graph_listener_removed_func listener_removed, void *data,
	210	int *listener_id);
	211
	212	extern bt_graph_add_listener_status
	213	bt_graph_add_source_filter_component_ports_connected_listener(
	214	bt_graph *graph,
	215	bt_graph_source_filter_component_ports_connected_listener_func listener,
	216	bt_graph_listener_removed_func listener_removed, void *data,
	217	int *listener_id);
	218
	219	extern bt_graph_add_listener_status
	220	bt_graph_add_filter_filter_component_ports_connected_listener(
	221	bt_graph *graph,
	222	bt_graph_filter_filter_component_ports_connected_listener_func listener,
	223	bt_graph_listener_removed_func listener_removed, void *data,
	224	int *listener_id);
	225
	226	extern bt_graph_add_listener_status
	227	bt_graph_add_source_sink_component_ports_connected_listener(
	228	bt_graph *graph,
	229	bt_graph_source_sink_component_ports_connected_listener_func listener,
	230	bt_graph_listener_removed_func listener_removed, void *data,
	231	int *listener_id);
	232
	233	extern bt_graph_add_listener_status
	234	bt_graph_add_filter_sink_component_ports_connected_listener(
	235	bt_graph *graph,
	236	bt_graph_filter_sink_component_ports_connected_listener_func listener,
	237	bt_graph_listener_removed_func listener_removed, void *data,
	238	int *listener_id);
	239
	240	typedef enum bt_graph_cancel_status {
	241	BT_GRAPH_CANCEL_STATUS_OK = __BT_FUNC_STATUS_OK,
	242	} bt_graph_cancel_status;
	243
	244	extern bt_graph_cancel_status bt_graph_cancel(bt_graph *graph);
	245
	246	#ifdef __cplusplus
	247	}
	248	#endif
	249
	250	#endif /* BABELTRACE2_GRAPH_GRAPH_H */