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

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