[babeltrace.git] / include / babeltrace / graph / component-internal.h

#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H

/*
 * BabelTrace - Component internal
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * 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.
 */

#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/graph/port-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/types.h>
#include <glib.h>
#include <stdio.h>

typedef void (*bt_component_destroy_listener_func)(
		struct bt_component *class, void *data);

struct bt_component_destroy_listener {
	bt_component_destroy_listener_func func;
	void *data;
};

struct bt_component {
	struct bt_object base;
	struct bt_component_class *class;
	GString *name;

	/*
	 * Internal destroy function specific to a source, filter, or
	 * sink component object.
	 */
	void (*destroy)(struct bt_component *);

	/* User-defined data */
	void *user_data;

	/* Input and output ports (weak references) */
	GPtrArray *input_ports;
	GPtrArray *output_ports;

	/* Array of struct bt_component_destroy_listener */
	GArray *destroy_listeners;
};

static inline
struct bt_component *bt_component_from_private(
		struct bt_private_component *private_component)
{
	return (void *) private_component;
}

static inline
struct bt_private_component *bt_private_component_from_component(
		struct bt_component *component)
{
	return (void *) component;
}

static inline
struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
{
	assert(comp);
	return (void *) comp->base.parent;
}

BT_HIDDEN
enum bt_component_status bt_component_accept_port_connection(
		struct bt_component *component, struct bt_port *self_port,
		struct bt_port *other_port);

BT_HIDDEN
void bt_component_port_connected(struct bt_component *comp,
		struct bt_port *self_port, struct bt_port *other_port);

BT_HIDDEN
void bt_component_port_disconnected(struct bt_component *comp,
		struct bt_port *port);

BT_HIDDEN
void bt_component_set_graph(struct bt_component *component,
		struct bt_graph *graph);

BT_HIDDEN
int64_t bt_component_get_input_port_count(struct bt_component *comp);

BT_HIDDEN
int64_t bt_component_get_output_port_count(struct bt_component *comp);

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
		uint64_t index);

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
		uint64_t index);

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
		const char *name);

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
		const char *name);

BT_HIDDEN
struct bt_port *bt_component_add_input_port(
		struct bt_component *component, const char *name,
		void *user_data);

BT_HIDDEN
struct bt_port *bt_component_add_output_port(
		struct bt_component *component, const char *name,
		void *user_data);

BT_HIDDEN
enum bt_component_status bt_component_remove_port(
		struct bt_component *component, struct bt_port *port);

BT_HIDDEN
void bt_component_add_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data);

BT_HIDDEN
void bt_component_remove_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data);

static inline
const char *bt_component_status_string(enum bt_component_status status)
{
	switch (status) {
	case BT_COMPONENT_STATUS_OK:
		return "BT_COMPONENT_STATUS_OK";
	case BT_COMPONENT_STATUS_END:
		return "BT_COMPONENT_STATUS_END";
	case BT_COMPONENT_STATUS_AGAIN:
		return "BT_COMPONENT_STATUS_AGAIN";
	case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
		return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
	case BT_COMPONENT_STATUS_ERROR:
		return "BT_COMPONENT_STATUS_ERROR";
	case BT_COMPONENT_STATUS_UNSUPPORTED:
		return "BT_COMPONENT_STATUS_UNSUPPORTED";
	case BT_COMPONENT_STATUS_INVALID:
		return "BT_COMPONENT_STATUS_INVALID";
	case BT_COMPONENT_STATUS_NOMEM:
		return "BT_COMPONENT_STATUS_NOMEM";
	case BT_COMPONENT_STATUS_NOT_FOUND:
		return "BT_COMPONENT_STATUS_NOT_FOUND";
	case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
		return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
90354d3a JG	3
90354d3a JG	4	/*
633edee0	5	* BabelTrace - Component internal
90354d3a JG	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
0db5ca2c	30	#include <babeltrace/babeltrace-internal.h>
b2e0c907 PP	31	#include <babeltrace/graph/component.h>
	32	#include <babeltrace/graph/component-class-internal.h>
	33	#include <babeltrace/graph/port-internal.h>
b8a06801	34	#include <babeltrace/object-internal.h>
c55a9f58	35	#include <babeltrace/types.h>
0db5ca2c	36	#include <glib.h>
38d02a17	37	#include <stdio.h>
90354d3a	38
3230ee6b PP	39	typedef void (*bt_component_destroy_listener_func)(
	40	struct bt_component class, void data);
	41
	42	struct bt_component_destroy_listener {
	43	bt_component_destroy_listener_func func;
	44	void *data;
	45	};
	46
633edee0	47	struct bt_component {
b8a06801	48	struct bt_object base;
fb2dcc52	49	struct bt_component_class *class;
0db5ca2c	50	GString *name;
584e4e78	51
72b913fb	52	/*
d3e4dcd8 PP	53	* Internal destroy function specific to a source, filter, or
	54	* sink component object.
	55	*/
890882ef	56	void (destroy)(struct bt_component );
d3e4dcd8	57
72b913fb	58	/* User-defined data */
0777b693	59	void *user_data;
fec2a9f2	60
72b913fb PP	61	/* Input and output ports (weak references) */
	62	GPtrArray *input_ports;
	63	GPtrArray *output_ports;
3230ee6b PP	64
	65	/* Array of struct bt_component_destroy_listener */
	66	GArray *destroy_listeners;
72b913fb	67	};
38b48196	68
890882ef PP	69	static inline
	70	struct bt_component *bt_component_from_private(
	71	struct bt_private_component *private_component)
	72	{
	73	return (void *) private_component;
	74	}
	75
	76	static inline
	77	struct bt_private_component *bt_private_component_from_component(
	78	struct bt_component *component)
	79	{
	80	return (void *) component;
	81	}
5645cd95	82
4dc8c91f PP	83	static inline
	84	struct bt_graph bt_component_borrow_graph(struct bt_component comp)
	85	{
	86	assert(comp);
	87	return (void *) comp->base.parent;
	88	}
	89
2d41b99e	90	BT_HIDDEN
72b913fb	91	enum bt_component_status bt_component_accept_port_connection(
8f4799f7 PP	92	struct bt_component component, struct bt_port self_port,
8f4799f7 PP	93	struct bt_port *other_port);
72b913fb	94
0d8b4d8e PP	95	BT_HIDDEN
	96	void bt_component_port_connected(struct bt_component *comp,
	97	struct bt_port self_port, struct bt_port other_port);
	98
72b913fb PP	99	BT_HIDDEN
	100	void bt_component_port_disconnected(struct bt_component *comp,
	101	struct bt_port *port);
2d41b99e	102
366e034f	103	BT_HIDDEN
f60c8b34	104	void bt_component_set_graph(struct bt_component *component,
366e034f JG	105	struct bt_graph *graph);
	106
	107	BT_HIDDEN
544d0515	108	int64_t bt_component_get_input_port_count(struct bt_component *comp);
366e034f JG	109
366e034f JG	110	BT_HIDDEN
544d0515	111	int64_t bt_component_get_output_port_count(struct bt_component *comp);
366e034f JG	112
366e034f JG	113	BT_HIDDEN
9ac68eb1 PP	114	struct bt_port bt_component_get_input_port_by_index(struct bt_component comp,
9ac68eb1 PP	115	uint64_t index);
366e034f JG	116
366e034f JG	117	BT_HIDDEN
9ac68eb1 PP	118	struct bt_port bt_component_get_output_port_by_index(struct bt_component comp,
9ac68eb1 PP	119	uint64_t index);
366e034f JG	120
366e034f JG	121	BT_HIDDEN
9ac68eb1	122	struct bt_port bt_component_get_input_port_by_name(struct bt_component comp,
72b913fb	123	const char *name);
366e034f JG	124
366e034f JG	125	BT_HIDDEN
9ac68eb1	126	struct bt_port bt_component_get_output_port_by_name(struct bt_component comp,
366e034f JG	127	const char *name);
366e034f JG	128
72b913fb PP	129	BT_HIDDEN
72b913fb PP	130	struct bt_port *bt_component_add_input_port(
3e9b0023 PP	131	struct bt_component component, const char name,
3e9b0023 PP	132	void *user_data);
72b913fb PP	133
	134	BT_HIDDEN
	135	struct bt_port *bt_component_add_output_port(
3e9b0023 PP	136	struct bt_component component, const char name,
3e9b0023 PP	137	void *user_data);
72b913fb PP	138
	139	BT_HIDDEN
	140	enum bt_component_status bt_component_remove_port(
	141	struct bt_component component, struct bt_port port);
	142
3230ee6b PP	143	BT_HIDDEN
	144	void bt_component_add_destroy_listener(struct bt_component *component,
	145	bt_component_destroy_listener_func func, void *data);
	146
	147	BT_HIDDEN
	148	void bt_component_remove_destroy_listener(struct bt_component *component,
	149	bt_component_destroy_listener_func func, void *data);
	150
262e5473 PP	151	static inline
	152	const char *bt_component_status_string(enum bt_component_status status)
	153	{
	154	switch (status) {
	155	case BT_COMPONENT_STATUS_OK:
	156	return "BT_COMPONENT_STATUS_OK";
	157	case BT_COMPONENT_STATUS_END:
	158	return "BT_COMPONENT_STATUS_END";
	159	case BT_COMPONENT_STATUS_AGAIN:
	160	return "BT_COMPONENT_STATUS_AGAIN";
	161	case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
	162	return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
	163	case BT_COMPONENT_STATUS_ERROR:
	164	return "BT_COMPONENT_STATUS_ERROR";
	165	case BT_COMPONENT_STATUS_UNSUPPORTED:
	166	return "BT_COMPONENT_STATUS_UNSUPPORTED";
	167	case BT_COMPONENT_STATUS_INVALID:
	168	return "BT_COMPONENT_STATUS_INVALID";
	169	case BT_COMPONENT_STATUS_NOMEM:
	170	return "BT_COMPONENT_STATUS_NOMEM";
	171	case BT_COMPONENT_STATUS_NOT_FOUND:
	172	return "BT_COMPONENT_STATUS_NOT_FOUND";
bd7cc15b PP	173	case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
bd7cc15b PP	174	return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
262e5473 PP	175	default:
	176	return "(unknown)";
	177	}
	178	}
	179
33b34c43	180	#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */