[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;

	bool initialized;
};

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_create(
		struct bt_component_class *component_class,
		const char *name, struct bt_component **component);

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
	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	2	#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - Component internal
	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
	30	#include <babeltrace/babeltrace-internal.h>
	31	#include <babeltrace/graph/component.h>
	32	#include <babeltrace/graph/component-class-internal.h>
	33	#include <babeltrace/graph/port-internal.h>
	34	#include <babeltrace/object-internal.h>
	35	#include <babeltrace/types.h>
	36	#include <glib.h>
	37	#include <stdio.h>
	38
	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
	47	struct bt_component {
	48	struct bt_object base;
	49	struct bt_component_class *class;
	50	GString *name;
	51
	52	/*
	53	* Internal destroy function specific to a source, filter, or
	54	* sink component object.
	55	*/
	56	void (destroy)(struct bt_component );
	57
	58	/* User-defined data */
	59	void *user_data;
	60
	61	/* Input and output ports (weak references) */
	62	GPtrArray *input_ports;
	63	GPtrArray *output_ports;
	64
	65	/* Array of struct bt_component_destroy_listener */
	66	GArray *destroy_listeners;
	67
	68	bool initialized;
	69	};
	70
	71	static inline
	72	struct bt_component *bt_component_from_private(
	73	struct bt_private_component *private_component)
	74	{
	75	return (void *) private_component;
	76	}
	77
	78	static inline
	79	struct bt_private_component *bt_private_component_from_component(
	80	struct bt_component *component)
	81	{
	82	return (void *) component;
	83	}
	84
	85	static inline
	86	struct bt_graph bt_component_borrow_graph(struct bt_component comp)
	87	{
	88	assert(comp);
	89	return (void *) comp->base.parent;
	90	}
	91
	92	BT_HIDDEN
	93	enum bt_component_status bt_component_create(
	94	struct bt_component_class *component_class,
	95	const char name, struct bt_component *component);
	96
	97	BT_HIDDEN
	98	enum bt_component_status bt_component_accept_port_connection(
	99	struct bt_component component, struct bt_port self_port,
	100	struct bt_port *other_port);
	101
	102	BT_HIDDEN
	103	void bt_component_port_connected(struct bt_component *comp,
	104	struct bt_port self_port, struct bt_port other_port);
	105
	106	BT_HIDDEN
	107	void bt_component_port_disconnected(struct bt_component *comp,
	108	struct bt_port *port);
	109
	110	BT_HIDDEN
	111	void bt_component_set_graph(struct bt_component *component,
	112	struct bt_graph *graph);
	113
	114	BT_HIDDEN
	115	int64_t bt_component_get_input_port_count(struct bt_component *comp);
	116
	117	BT_HIDDEN
	118	int64_t bt_component_get_output_port_count(struct bt_component *comp);
	119
	120	BT_HIDDEN
	121	struct bt_port bt_component_get_input_port_by_index(struct bt_component comp,
	122	uint64_t index);
	123
	124	BT_HIDDEN
	125	struct bt_port bt_component_get_output_port_by_index(struct bt_component comp,
	126	uint64_t index);
	127
	128	BT_HIDDEN
	129	struct bt_port bt_component_get_input_port_by_name(struct bt_component comp,
	130	const char *name);
	131
	132	BT_HIDDEN
	133	struct bt_port bt_component_get_output_port_by_name(struct bt_component comp,
	134	const char *name);
	135
	136	BT_HIDDEN
	137	struct bt_port *bt_component_add_input_port(
	138	struct bt_component component, const char name,
	139	void *user_data);
	140
	141	BT_HIDDEN
	142	struct bt_port *bt_component_add_output_port(
	143	struct bt_component component, const char name,
	144	void *user_data);
	145
	146	BT_HIDDEN
	147	enum bt_component_status bt_component_remove_port(
	148	struct bt_component component, struct bt_port port);
	149
	150	BT_HIDDEN
	151	void bt_component_add_destroy_listener(struct bt_component *component,
	152	bt_component_destroy_listener_func func, void *data);
	153
	154	BT_HIDDEN
	155	void bt_component_remove_destroy_listener(struct bt_component *component,
	156	bt_component_destroy_listener_func func, void *data);
	157
	158	static inline
	159	const char *bt_component_status_string(enum bt_component_status status)
	160	{
	161	switch (status) {
	162	case BT_COMPONENT_STATUS_OK:
	163	return "BT_COMPONENT_STATUS_OK";
	164	case BT_COMPONENT_STATUS_END:
	165	return "BT_COMPONENT_STATUS_END";
	166	case BT_COMPONENT_STATUS_AGAIN:
	167	return "BT_COMPONENT_STATUS_AGAIN";
	168	case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
	169	return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
	170	case BT_COMPONENT_STATUS_ERROR:
	171	return "BT_COMPONENT_STATUS_ERROR";
	172	case BT_COMPONENT_STATUS_UNSUPPORTED:
	173	return "BT_COMPONENT_STATUS_UNSUPPORTED";
	174	case BT_COMPONENT_STATUS_INVALID:
	175	return "BT_COMPONENT_STATUS_INVALID";
	176	case BT_COMPONENT_STATUS_NOMEM:
	177	return "BT_COMPONENT_STATUS_NOMEM";
	178	case BT_COMPONENT_STATUS_NOT_FOUND:
	179	return "BT_COMPONENT_STATUS_NOT_FOUND";
	180	case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
	181	return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
	182	default:
	183	return "(unknown)";
	184	}
	185	}
	186
	187	#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */