[babeltrace.git] / formats / ctf / callbacks.c

/*
 * callbacks.c
 *
 * Babeltrace Library
 *
 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@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.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/context.h>
#include <babeltrace/context-internal.h>
#include <babeltrace/ctf-ir/metadata.h>
#include <babeltrace/iterator-internal.h>
#include <babeltrace/ctf/events.h>
#include <babeltrace/ctf/events-internal.h>
#include <babeltrace/ctf/callbacks-internal.h>
#include <inttypes.h>

static
struct bt_dependencies *_bt_dependencies_create(const char *first,
							va_list ap)
{
	const char *iter;
	struct bt_dependencies *dep;

	dep = g_new0(struct bt_dependencies, 1);
	dep->refcount = 1;
	dep->deps = g_array_new(FALSE, TRUE, sizeof(GQuark));
	iter = first;
	while (iter) {
		GQuark q = g_quark_from_string(iter);
		g_array_append_val(dep->deps, q);
		iter = va_arg(ap, const char *);
	}
	return dep;
}

struct bt_dependencies *bt_dependencies_create(const char *first, ...)
{
	va_list ap;
	struct bt_dependencies *deps;

	va_start(ap, first);
	deps = _bt_dependencies_create(first, ap);
	va_end(ap);
	return deps;
}

/*
 * bt_ctf_iter_add_callback: Add a callback to CTF iterator.
 */
int bt_ctf_iter_add_callback(struct bt_ctf_iter *iter,
		bt_intern_str event, void *private_data, int flags,
		enum bt_cb_ret (*callback)(struct bt_ctf_event *ctf_data,
					   void *private_data),
		struct bt_dependencies *depends,
		struct bt_dependencies *weak_depends,
		struct bt_dependencies *provides)
{
	int i, stream_id;
	gpointer *event_id_ptr;
	unsigned long event_id;
	struct trace_collection *tc;

	if (!iter || !callback)
		return -EINVAL;

	tc = iter->parent.ctx->tc;
	for (i = 0; i < tc->array->len; i++) {
		struct ctf_trace *tin;
		struct bt_trace_descriptor *td_read;

		td_read = g_ptr_array_index(tc->array, i);
		tin = container_of(td_read, struct ctf_trace, parent);

		for (stream_id = 0; stream_id < tin->streams->len; stream_id++) {
			struct ctf_stream_declaration *stream;
			struct bt_stream_callbacks *bt_stream_cb = NULL;
			struct bt_callback_chain *bt_chain = NULL;
			struct bt_callback new_callback;

			stream = g_ptr_array_index(tin->streams, stream_id);

			if (stream_id >= iter->callbacks->len) {
				g_array_set_size(iter->callbacks, stream->stream_id + 1);
			}
			bt_stream_cb = &g_array_index(iter->callbacks,
					struct bt_stream_callbacks, stream->stream_id);
			if (!bt_stream_cb->per_id_callbacks) {
				bt_stream_cb->per_id_callbacks = g_array_new(FALSE, TRUE,
						sizeof(struct bt_callback_chain));
			}

			if (event) {
				/* find the event id */
				event_id_ptr = g_hash_table_lookup(stream->event_quark_to_id,
						(gconstpointer) (unsigned long) event);
				/* event not found in this stream class */
				if (!event_id_ptr) {
					fprintf(stderr, "[error] Event ID not found in stream class\n");
					continue;
				}
				event_id = (uint64_t)(unsigned long) *event_id_ptr;

				/* find or create the bt_callback_chain for this event */
				if (event_id >= bt_stream_cb->per_id_callbacks->len) {
					g_array_set_size(bt_stream_cb->per_id_callbacks, event_id + 1);
				}
				bt_chain = &g_array_index(bt_stream_cb->per_id_callbacks,
						struct bt_callback_chain, event_id);
				if (!bt_chain->callback) {
					bt_chain->callback = g_array_new(FALSE, TRUE,
						sizeof(struct bt_callback));
				}
			} else {
				/* callback for all events */
				if (!iter->main_callbacks.callback) {
					iter->main_callbacks.callback = g_array_new(FALSE, TRUE,
							sizeof(struct bt_callback));
				}
				bt_chain = &iter->main_callbacks;
			}

			new_callback.private_data = private_data;
			new_callback.flags = flags;
			new_callback.callback = callback;
			new_callback.depends = depends;
			new_callback.weak_depends = weak_depends;
			new_callback.provides = provides;

			/* TODO : take care of priority, for now just FIFO */
			g_array_append_val(bt_chain->callback, new_callback);
		}
	}

	return 0;
}

static
int extract_ctf_stream_event(struct ctf_stream_definition *stream,
		struct bt_ctf_event *event)
{
	struct ctf_stream_declaration *stream_class = stream->stream_class;
	struct ctf_event_declaration *event_class;
	uint64_t id = stream->event_id;

	if (id >= stream_class->events_by_id->len) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
		return -1;
	}
	event->parent = g_ptr_array_index(stream->events_by_id, id);
	if (!event->parent) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
		return -1;
	}
	event_class = g_ptr_array_index(stream_class->events_by_id, id);
	if (!event_class) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
		return -1;
	}

	return 0;
}

void process_callbacks(struct bt_ctf_iter *iter,
		       struct ctf_stream_definition *stream)
{
	struct bt_stream_callbacks *bt_stream_cb;
	struct bt_callback_chain *bt_chain;
	struct bt_callback *cb;
	int i;
	enum bt_cb_ret ret;
	struct bt_ctf_event ctf_data;

	assert(iter && stream);

	ret = extract_ctf_stream_event(stream, &ctf_data);
	if (ret)
		goto end;

	/* process all events callback first */
	if (iter->main_callbacks.callback) {
		for (i = 0; i < iter->main_callbacks.callback->len; i++) {
			cb = &g_array_index(iter->main_callbacks.callback, struct bt_callback, i);
			if (!cb)
				goto end;
			ret = cb->callback(&ctf_data, cb->private_data);
			switch (ret) {
			case BT_CB_OK_STOP:
			case BT_CB_ERROR_STOP:
				goto end;
			default:
				break;
			}
		}
	}

	/* process per event callbacks */
	bt_stream_cb = &g_array_index(iter->callbacks,
			struct bt_stream_callbacks, stream->stream_id);
	if (!bt_stream_cb || !bt_stream_cb->per_id_callbacks)
		goto end;

	if (stream->event_id >= bt_stream_cb->per_id_callbacks->len)
		goto end;
	bt_chain = &g_array_index(bt_stream_cb->per_id_callbacks,
			struct bt_callback_chain, stream->event_id);
	if (!bt_chain || !bt_chain->callback)
		goto end;

	for (i = 0; i < bt_chain->callback->len; i++) {
		cb = &g_array_index(bt_chain->callback, struct bt_callback, i);
		if (!cb)
			goto end;
		ret = cb->callback(&ctf_data, cb->private_data);
		switch (ret) {
		case BT_CB_OK_STOP:
		case BT_CB_ERROR_STOP:
			goto end;
		default:
			break;
		}
	}

end:
	return;
}
Commit	Line	Data
6f3077a2 JD	1	/*
	2	* callbacks.c
	3	*
	4	* Babeltrace Library
	5	*
	6	* Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
	7	*
	8	* Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
c462e188 MD	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
6f3077a2 JD	27	*/
	28
	29	#include <babeltrace/babeltrace.h>
	30	#include <babeltrace/babeltrace-internal.h>
95d36295	31	#include <babeltrace/context.h>
08c22d05	32	#include <babeltrace/context-internal.h>
6f3077a2 JD	33	#include <babeltrace/ctf-ir/metadata.h>
6f3077a2 JD	34	#include <babeltrace/iterator-internal.h>
aacd0c69	35	#include <babeltrace/ctf/events.h>
634d474b MD	36	#include <babeltrace/ctf/events-internal.h>
634d474b MD	37	#include <babeltrace/ctf/callbacks-internal.h>
6f3077a2 JD	38	#include <inttypes.h>
	39
	40	static
9426d563	41	struct bt_dependencies _bt_dependencies_create(const char first,
6f3077a2 JD	42	va_list ap)
	43	{
	44	const char *iter;
	45	struct bt_dependencies *dep;
	46
	47	dep = g_new0(struct bt_dependencies, 1);
	48	dep->refcount = 1;
	49	dep->deps = g_array_new(FALSE, TRUE, sizeof(GQuark));
	50	iter = first;
	51	while (iter) {
	52	GQuark q = g_quark_from_string(iter);
	53	g_array_append_val(dep->deps, q);
	54	iter = va_arg(ap, const char *);
	55	}
	56	return dep;
	57	}
	58
9426d563	59	struct bt_dependencies bt_dependencies_create(const char first, ...)
6f3077a2 JD	60	{
	61	va_list ap;
	62	struct bt_dependencies *deps;
	63
	64	va_start(ap, first);
9426d563	65	deps = _bt_dependencies_create(first, ap);
6f3077a2 JD	66	va_end(ap);
	67	return deps;
	68	}
	69
	70	/*
634d474b	71	* bt_ctf_iter_add_callback: Add a callback to CTF iterator.
6f3077a2	72	*/
634d474b	73	int bt_ctf_iter_add_callback(struct bt_ctf_iter *iter,
34861b9d	74	bt_intern_str event, void *private_data, int flags,
c50d2a7a	75	enum bt_cb_ret (callback)(struct bt_ctf_event ctf_data,
6f3077a2 JD	76	void *private_data),
	77	struct bt_dependencies *depends,
	78	struct bt_dependencies *weak_depends,
	79	struct bt_dependencies *provides)
	80	{
	81	int i, stream_id;
	82	gpointer *event_id_ptr;
	83	unsigned long event_id;
7f89ddce	84	struct trace_collection *tc;
6f3077a2	85
7f89ddce MD	86	if (!iter \|\| !callback)
	87	return -EINVAL;
	88
	89	tc = iter->parent.ctx->tc;
6f3077a2 JD	90	for (i = 0; i < tc->array->len; i++) {
6f3077a2 JD	91	struct ctf_trace *tin;
1b8455b7	92	struct bt_trace_descriptor *td_read;
6f3077a2 JD	93
	94	td_read = g_ptr_array_index(tc->array, i);
	95	tin = container_of(td_read, struct ctf_trace, parent);
	96
	97	for (stream_id = 0; stream_id < tin->streams->len; stream_id++) {
f380e105	98	struct ctf_stream_declaration *stream;
6f3077a2 JD	99	struct bt_stream_callbacks *bt_stream_cb = NULL;
	100	struct bt_callback_chain *bt_chain = NULL;
	101	struct bt_callback new_callback;
	102
	103	stream = g_ptr_array_index(tin->streams, stream_id);
	104
	105	if (stream_id >= iter->callbacks->len) {
	106	g_array_set_size(iter->callbacks, stream->stream_id + 1);
	107	}
	108	bt_stream_cb = &g_array_index(iter->callbacks,
	109	struct bt_stream_callbacks, stream->stream_id);
	110	if (!bt_stream_cb->per_id_callbacks) {
	111	bt_stream_cb->per_id_callbacks = g_array_new(FALSE, TRUE,
	112	sizeof(struct bt_callback_chain));
	113	}
	114
	115	if (event) {
	116	/* find the event id */
	117	event_id_ptr = g_hash_table_lookup(stream->event_quark_to_id,
	118	(gconstpointer) (unsigned long) event);
	119	/* event not found in this stream class */
	120	if (!event_id_ptr) {
00607d51	121	fprintf(stderr, "[error] Event ID not found in stream class\n");
6f3077a2 JD	122	continue;
	123	}
	124	event_id = (uint64_t)(unsigned long) *event_id_ptr;
	125
	126	/* find or create the bt_callback_chain for this event */
	127	if (event_id >= bt_stream_cb->per_id_callbacks->len) {
	128	g_array_set_size(bt_stream_cb->per_id_callbacks, event_id + 1);
	129	}
	130	bt_chain = &g_array_index(bt_stream_cb->per_id_callbacks,
	131	struct bt_callback_chain, event_id);
	132	if (!bt_chain->callback) {
	133	bt_chain->callback = g_array_new(FALSE, TRUE,
	134	sizeof(struct bt_callback));
	135	}
	136	} else {
	137	/* callback for all events */
	138	if (!iter->main_callbacks.callback) {
	139	iter->main_callbacks.callback = g_array_new(FALSE, TRUE,
	140	sizeof(struct bt_callback));
	141	}
	142	bt_chain = &iter->main_callbacks;
	143	}
	144
	145	new_callback.private_data = private_data;
	146	new_callback.flags = flags;
	147	new_callback.callback = callback;
	148	new_callback.depends = depends;
	149	new_callback.weak_depends = weak_depends;
	150	new_callback.provides = provides;
	151
	152	/* TODO : take care of priority, for now just FIFO */
	153	g_array_append_val(bt_chain->callback, new_callback);
	154	}
	155	}
	156
	157	return 0;
	158	}
	159
	160	static
c50d2a7a JD	161	int extract_ctf_stream_event(struct ctf_stream_definition *stream,
c50d2a7a JD	162	struct bt_ctf_event *event)
6f3077a2	163	{
f380e105	164	struct ctf_stream_declaration *stream_class = stream->stream_class;
4716614a	165	struct ctf_event_declaration *event_class;
6f3077a2 JD	166	uint64_t id = stream->event_id;
	167
	168	if (id >= stream_class->events_by_id->len) {
3394d22e	169	fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
c50d2a7a	170	return -1;
6f3077a2	171	}
c50d2a7a JD	172	event->parent = g_ptr_array_index(stream->events_by_id, id);
c50d2a7a JD	173	if (!event->parent) {
3394d22e	174	fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
c50d2a7a	175	return -1;
6f3077a2 JD	176	}
	177	event_class = g_ptr_array_index(stream_class->events_by_id, id);
	178	if (!event_class) {
3394d22e	179	fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
c50d2a7a	180	return -1;
6f3077a2 JD	181	}
6f3077a2 JD	182
c50d2a7a	183	return 0;
6f3077a2 JD	184	}
6f3077a2 JD	185
634d474b	186	void process_callbacks(struct bt_ctf_iter *iter,
9e88d150	187	struct ctf_stream_definition *stream)
6f3077a2 JD	188	{
	189	struct bt_stream_callbacks *bt_stream_cb;
	190	struct bt_callback_chain *bt_chain;
	191	struct bt_callback *cb;
	192	int i;
	193	enum bt_cb_ret ret;
c50d2a7a	194	struct bt_ctf_event ctf_data;
6f3077a2	195
7f89ddce MD	196	assert(iter && stream);
7f89ddce MD	197
c50d2a7a	198	ret = extract_ctf_stream_event(stream, &ctf_data);
209fa296 MD	199	if (ret)
209fa296 MD	200	goto end;
6f3077a2 JD	201
	202	/* process all events callback first */
	203	if (iter->main_callbacks.callback) {
	204	for (i = 0; i < iter->main_callbacks.callback->len; i++) {
	205	cb = &g_array_index(iter->main_callbacks.callback, struct bt_callback, i);
	206	if (!cb)
	207	goto end;
c50d2a7a	208	ret = cb->callback(&ctf_data, cb->private_data);
6f3077a2 JD	209	switch (ret) {
	210	case BT_CB_OK_STOP:
	211	case BT_CB_ERROR_STOP:
	212	goto end;
	213	default:
	214	break;
	215	}
	216	}
	217	}
	218
	219	/* process per event callbacks */
	220	bt_stream_cb = &g_array_index(iter->callbacks,
	221	struct bt_stream_callbacks, stream->stream_id);
	222	if (!bt_stream_cb \|\| !bt_stream_cb->per_id_callbacks)
	223	goto end;
	224
a91196c6	225	if (stream->event_id >= bt_stream_cb->per_id_callbacks->len)
6f3077a2 JD	226	goto end;
	227	bt_chain = &g_array_index(bt_stream_cb->per_id_callbacks,
	228	struct bt_callback_chain, stream->event_id);
	229	if (!bt_chain \|\| !bt_chain->callback)
	230	goto end;
	231
	232	for (i = 0; i < bt_chain->callback->len; i++) {
	233	cb = &g_array_index(bt_chain->callback, struct bt_callback, i);
	234	if (!cb)
	235	goto end;
c50d2a7a	236	ret = cb->callback(&ctf_data, cb->private_data);
6f3077a2 JD	237	switch (ret) {
	238	case BT_CB_OK_STOP:
	239	case BT_CB_ERROR_STOP:
	240	goto end;
	241	default:
	242	break;
	243	}
	244	}
	245
	246	end:
	247	return;
	248	}