[babeltrace.git] / lib / graph / notification / event.c

/*
 * Babeltrace Plug-in Event Notification
 *
 * Copyright 2016 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/compiler-internal.h>
#include <babeltrace/ctf-ir/event.h>
#include <babeltrace/ctf-ir/event-internal.h>
#include <babeltrace/ctf-ir/event-class-internal.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/graph/clock-class-priority-map.h>
#include <babeltrace/graph/clock-class-priority-map-internal.h>
#include <babeltrace/graph/notification-event-internal.h>
#include <babeltrace/types.h>
#include <stdbool.h>

static
void bt_notification_event_destroy(struct bt_object *obj)
{
	struct bt_notification_event *notification =
			(struct bt_notification_event *) obj;

	BT_PUT(notification->event);
	BT_PUT(notification->cc_prio_map);
	g_free(notification);
}

static
bt_bool validate_clock_classes(struct bt_notification_event *notif)
{
	/*
	 * For each clock class found in the notification's clock class
	 * priority map, make sure the event has a clock value set for
	 * this clock class. Also make sure that those clock classes
	 * are part of the trace to which the event belongs.
	 */
	bt_bool is_valid = BT_TRUE;
	int trace_cc_count;
	int cc_prio_map_cc_count;
	size_t cc_prio_map_cc_i, trace_cc_i;
	struct bt_ctf_event_class *event_class = NULL;
	struct bt_ctf_stream_class *stream_class = NULL;
	struct bt_ctf_trace *trace = NULL;

	event_class = bt_ctf_event_borrow_event_class(notif->event);
	assert(event_class);
	stream_class = bt_ctf_event_class_borrow_stream_class(event_class);
	assert(stream_class);
	trace = bt_ctf_stream_class_borrow_trace(stream_class);
	assert(trace);
	trace_cc_count = bt_ctf_trace_get_clock_class_count(trace);
	assert(trace_cc_count >= 0);
	cc_prio_map_cc_count =
		bt_clock_class_priority_map_get_clock_class_count(
			notif->cc_prio_map);
	assert(cc_prio_map_cc_count >= 0);

	for (cc_prio_map_cc_i = 0; cc_prio_map_cc_i < cc_prio_map_cc_count;
			cc_prio_map_cc_i++) {
		struct bt_ctf_clock_class *clock_class =
			bt_clock_class_priority_map_get_clock_class_by_index(
				notif->cc_prio_map, cc_prio_map_cc_i);
		struct bt_ctf_clock_value *clock_value;
		bt_bool found_in_trace = BT_FALSE;

		assert(clock_class);
		clock_value = bt_ctf_event_get_clock_value(notif->event,
			clock_class);
		if (!clock_value) {
			is_valid = BT_FALSE;
			goto end;
		}

		bt_put(clock_value);

		for (trace_cc_i = 0; trace_cc_i < trace_cc_count;
				trace_cc_i++) {
			struct bt_ctf_clock_class *trace_clock_class =
				bt_ctf_trace_get_clock_class_by_index(trace,
					trace_cc_i);

			assert(trace_clock_class);

			if (trace_clock_class == clock_class) {
				found_in_trace = BT_TRUE;
				break;
			}
		}

		bt_put(clock_class);

		if (!found_in_trace) {
			is_valid = BT_FALSE;
			goto end;
		}
	}

end:
	return is_valid;
}

static
bool event_has_trace(struct bt_ctf_event *event)
{
	struct bt_ctf_event_class *event_class;
	struct bt_ctf_stream_class *stream_class;

	event_class = bt_ctf_event_borrow_event_class(event);
	assert(event_class);
	stream_class = bt_ctf_event_class_borrow_stream_class(event_class);
	assert(stream_class);
	return bt_ctf_stream_class_borrow_trace(stream_class) != NULL;
}

struct bt_notification *bt_notification_event_create(struct bt_ctf_event *event,
		struct bt_clock_class_priority_map *cc_prio_map)
{
	struct bt_notification_event *notification = NULL;

	if (!event || !cc_prio_map) {
		goto error;
	}

	if (!bt_ctf_event_borrow_packet(event)) {
		goto error;
	}

	if (!event_has_trace(event)) {
		goto error;
	}

	notification = g_new0(struct bt_notification_event, 1);
	if (!notification) {
		goto error;
	}
	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_EVENT,
			bt_notification_event_destroy);
	notification->event = bt_get(event);
	notification->cc_prio_map = bt_get(cc_prio_map);
	if (!validate_clock_classes(notification)) {
		goto error;
	}

	bt_ctf_event_freeze(notification->event);
	bt_clock_class_priority_map_freeze(notification->cc_prio_map);
	return &notification->parent;
error:
	bt_put(notification);
	return NULL;
}

struct bt_ctf_event *bt_notification_event_get_event(
		struct bt_notification *notification)
{
	struct bt_ctf_event *event = NULL;
	struct bt_notification_event *event_notification;

	if (bt_notification_get_type(notification) !=
			BT_NOTIFICATION_TYPE_EVENT) {
		goto end;
	}
	event_notification = container_of(notification,
			struct bt_notification_event, parent);
	event = bt_get(event_notification->event);
end:
	return event;
}

extern struct bt_clock_class_priority_map *
bt_notification_event_get_clock_class_priority_map(
		struct bt_notification *notification)
{
	struct bt_clock_class_priority_map *cc_prio_map = NULL;
	struct bt_notification_event *event_notification;

	if (bt_notification_get_type(notification) !=
			BT_NOTIFICATION_TYPE_EVENT) {
		goto end;
	}

	event_notification = container_of(notification,
			struct bt_notification_event, parent);
	cc_prio_map = bt_get(event_notification->cc_prio_map);
end:
	return cc_prio_map;
}
Commit	Line	Data
d51202da JG	1	/*
	2	* Babeltrace Plug-in Event Notification
	3	*
	4	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	*
	6	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
3d9990ac	27	#include <babeltrace/compiler-internal.h>
599faa1c	28	#include <babeltrace/ctf-ir/event.h>
80f00602	29	#include <babeltrace/ctf-ir/event-internal.h>
d8a36e14 PP	30	#include <babeltrace/ctf-ir/event-class-internal.h>
d8a36e14 PP	31	#include <babeltrace/ctf-ir/stream-class-internal.h>
599faa1c PP	32	#include <babeltrace/ctf-ir/trace.h>
599faa1c PP	33	#include <babeltrace/graph/clock-class-priority-map.h>
fe650ea4	34	#include <babeltrace/graph/clock-class-priority-map-internal.h>
b2e0c907	35	#include <babeltrace/graph/notification-event-internal.h>
c55a9f58	36	#include <babeltrace/types.h>
a68c0f97	37	#include <stdbool.h>
d51202da JG	38
	39	static
	40	void bt_notification_event_destroy(struct bt_object *obj)
	41	{
	42	struct bt_notification_event *notification =
	43	(struct bt_notification_event *) obj;
	44
	45	BT_PUT(notification->event);
599faa1c	46	BT_PUT(notification->cc_prio_map);
d51202da JG	47	g_free(notification);
	48	}
	49
599faa1c	50	static
c55a9f58	51	bt_bool validate_clock_classes(struct bt_notification_event *notif)
599faa1c PP	52	{
599faa1c PP	53	/*
d8a36e14 PP	54	* For each clock class found in the notification's clock class
	55	* priority map, make sure the event has a clock value set for
	56	* this clock class. Also make sure that those clock classes
	57	* are part of the trace to which the event belongs.
599faa1c	58	*/
c55a9f58	59	bt_bool is_valid = BT_TRUE;
d8a36e14 PP	60	int trace_cc_count;
	61	int cc_prio_map_cc_count;
	62	size_t cc_prio_map_cc_i, trace_cc_i;
599faa1c PP	63	struct bt_ctf_event_class *event_class = NULL;
	64	struct bt_ctf_stream_class *stream_class = NULL;
	65	struct bt_ctf_trace *trace = NULL;
599faa1c	66
d8a36e14	67	event_class = bt_ctf_event_borrow_event_class(notif->event);
599faa1c	68	assert(event_class);
d8a36e14	69	stream_class = bt_ctf_event_class_borrow_stream_class(event_class);
599faa1c	70	assert(stream_class);
d8a36e14	71	trace = bt_ctf_stream_class_borrow_trace(stream_class);
599faa1c	72	assert(trace);
d8a36e14 PP	73	trace_cc_count = bt_ctf_trace_get_clock_class_count(trace);
	74	assert(trace_cc_count >= 0);
	75	cc_prio_map_cc_count =
	76	bt_clock_class_priority_map_get_clock_class_count(
	77	notif->cc_prio_map);
	78	assert(cc_prio_map_cc_count >= 0);
599faa1c	79
d8a36e14 PP	80	for (cc_prio_map_cc_i = 0; cc_prio_map_cc_i < cc_prio_map_cc_count;
d8a36e14 PP	81	cc_prio_map_cc_i++) {
599faa1c	82	struct bt_ctf_clock_class *clock_class =
9ac68eb1	83	bt_clock_class_priority_map_get_clock_class_by_index(
d8a36e14 PP	84	notif->cc_prio_map, cc_prio_map_cc_i);
d8a36e14 PP	85	struct bt_ctf_clock_value *clock_value;
c55a9f58	86	bt_bool found_in_trace = BT_FALSE;
599faa1c PP	87
599faa1c PP	88	assert(clock_class);
d8a36e14 PP	89	clock_value = bt_ctf_event_get_clock_value(notif->event,
	90	clock_class);
	91	if (!clock_value) {
c55a9f58	92	is_valid = BT_FALSE;
d8a36e14 PP	93	goto end;
	94	}
	95
	96	bt_put(clock_value);
	97
	98	for (trace_cc_i = 0; trace_cc_i < trace_cc_count;
	99	trace_cc_i++) {
	100	struct bt_ctf_clock_class *trace_clock_class =
9ac68eb1 PP	101	bt_ctf_trace_get_clock_class_by_index(trace,
9ac68eb1 PP	102	trace_cc_i);
d8a36e14 PP	103
	104	assert(trace_clock_class);
	105
	106	if (trace_clock_class == clock_class) {
c55a9f58	107	found_in_trace = BT_TRUE;
d8a36e14 PP	108	break;
	109	}
	110	}
	111
599faa1c	112	bt_put(clock_class);
d8a36e14 PP	113
d8a36e14 PP	114	if (!found_in_trace) {
c55a9f58	115	is_valid = BT_FALSE;
599faa1c PP	116	goto end;
	117	}
	118	}
	119
	120	end:
599faa1c PP	121	return is_valid;
	122	}
	123
a68c0f97 PP	124	static
	125	bool event_has_trace(struct bt_ctf_event *event)
	126	{
	127	struct bt_ctf_event_class *event_class;
	128	struct bt_ctf_stream_class *stream_class;
	129
	130	event_class = bt_ctf_event_borrow_event_class(event);
	131	assert(event_class);
	132	stream_class = bt_ctf_event_class_borrow_stream_class(event_class);
	133	assert(stream_class);
	134	return bt_ctf_stream_class_borrow_trace(stream_class) != NULL;
	135	}
	136
599faa1c PP	137	struct bt_notification bt_notification_event_create(struct bt_ctf_event event,
599faa1c PP	138	struct bt_clock_class_priority_map *cc_prio_map)
d51202da	139	{
80f00602	140	struct bt_notification_event *notification = NULL;
d51202da	141
599faa1c	142	if (!event \|\| !cc_prio_map) {
d51202da JG	143	goto error;
	144	}
	145
80f00602 PP	146	if (!bt_ctf_event_borrow_packet(event)) {
	147	goto error;
	148	}
	149
a68c0f97 PP	150	if (!event_has_trace(event)) {
	151	goto error;
	152	}
	153
d51202da	154	notification = g_new0(struct bt_notification_event, 1);
24626e8b JG	155	if (!notification) {
	156	goto error;
	157	}
d51202da JG	158	bt_notification_init(&notification->parent,
	159	BT_NOTIFICATION_TYPE_EVENT,
	160	bt_notification_event_destroy);
	161	notification->event = bt_get(event);
599faa1c	162	notification->cc_prio_map = bt_get(cc_prio_map);
599faa1c	163	if (!validate_clock_classes(notification)) {
599faa1c PP	164	goto error;
	165	}
	166
80f00602	167	bt_ctf_event_freeze(notification->event);
fe650ea4	168	bt_clock_class_priority_map_freeze(notification->cc_prio_map);
d51202da JG	169	return &notification->parent;
d51202da JG	170	error:
80f00602	171	bt_put(notification);
d51202da JG	172	return NULL;
	173	}
	174
	175	struct bt_ctf_event *bt_notification_event_get_event(
	176	struct bt_notification *notification)
	177	{
08bfb670	178	struct bt_ctf_event *event = NULL;
d51202da JG	179	struct bt_notification_event *event_notification;
d51202da JG	180
08bfb670 JG	181	if (bt_notification_get_type(notification) !=
	182	BT_NOTIFICATION_TYPE_EVENT) {
	183	goto end;
	184	}
d51202da JG	185	event_notification = container_of(notification,
d51202da JG	186	struct bt_notification_event, parent);
08bfb670 JG	187	event = bt_get(event_notification->event);
	188	end:
	189	return event;
d51202da	190	}
599faa1c PP	191
	192	extern struct bt_clock_class_priority_map *
	193	bt_notification_event_get_clock_class_priority_map(
	194	struct bt_notification *notification)
	195	{
	196	struct bt_clock_class_priority_map *cc_prio_map = NULL;
	197	struct bt_notification_event *event_notification;
	198
	199	if (bt_notification_get_type(notification) !=
	200	BT_NOTIFICATION_TYPE_EVENT) {
	201	goto end;
	202	}
	203
	204	event_notification = container_of(notification,
	205	struct bt_notification_event, parent);
	206	cc_prio_map = bt_get(event_notification->cc_prio_map);
	207	end:
	208	return cc_prio_map;
	209	}