[babeltrace.git] / plugins / utils / trimmer / iterator.c

/*
 * iterator.c
 *
 * Babeltrace Trace Trimmer Iterator
 *
 * 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/graph/notification-iterator.h>
#include <babeltrace/graph/private-notification-iterator.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/graph/notification-event.h>
#include <babeltrace/graph/notification-stream.h>
#include <babeltrace/graph/notification-packet.h>
#include <babeltrace/graph/component-filter.h>
#include <babeltrace/graph/private-component-filter.h>
#include <babeltrace/graph/private-port.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/graph/private-component.h>
#include <babeltrace/ctf-ir/event.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/clock-class.h>
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/ctf-ir/fields.h>
#include <assert.h>
#include <plugins-common.h>

#include "trimmer.h"
#include "iterator.h"
#include "copy.h"

BT_HIDDEN
void trimmer_iterator_finalize(struct bt_private_notification_iterator *it)
{
	struct trimmer_iterator *it_data;

	it_data = bt_private_notification_iterator_get_user_data(it);
	assert(it_data);

	bt_put(it_data->input_iterator);
	g_hash_table_destroy(it_data->packet_map);
	g_free(it_data);
}

BT_HIDDEN
enum bt_notification_iterator_status trimmer_iterator_init(
		struct bt_private_notification_iterator *iterator,
		struct bt_private_port *port)
{
	enum bt_notification_iterator_status ret =
		BT_NOTIFICATION_ITERATOR_STATUS_OK;
	enum bt_notification_iterator_status it_ret;
	struct bt_private_port *input_port = NULL;
	struct bt_private_connection *connection = NULL;
	struct bt_private_component *component =
		bt_private_notification_iterator_get_private_component(iterator);
	struct trimmer_iterator *it_data = g_new0(struct trimmer_iterator, 1);

	if (!it_data) {
		ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
		goto end;
	}

	/* Create a new iterator on the upstream component. */
	input_port = bt_private_component_filter_get_default_input_private_port(
		component);
	assert(input_port);
	connection = bt_private_port_get_private_connection(input_port);
	assert(connection);

	it_data->input_iterator =
		bt_private_connection_create_notification_iterator(connection);
	if (!it_data->input_iterator) {
		ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
		goto end;
	}

	it_data->err = stderr;
	it_data->packet_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, NULL);

	it_ret = bt_private_notification_iterator_set_user_data(iterator,
		it_data);
	if (it_ret) {
		goto end;
	}
end:
	bt_put(component);
	bt_put(connection);
	bt_put(input_port);
	return ret;
}

static
int update_lazy_bound(struct trimmer_bound *bound, const char *name,
		int64_t ts, bool *lazy_update)
{
	struct tm tm;
	int64_t value;
	time_t timeval;

	*lazy_update = false;

	if (!bound->lazy) {
		return 0;
	}
	tm.tm_isdst = -1;
	timeval = ts / NSEC_PER_SEC;

	if (bound->lazy_values.gmt) {
		/* Get day, month, year. */
		if (!gmtime_r(&timeval, &tm)) {
			printf_error("Failure in gmtime_r()");
			goto error;
		}
		tm.tm_sec = bound->lazy_values.ss;
		tm.tm_min = bound->lazy_values.mm;
		tm.tm_hour = bound->lazy_values.hh;
		timeval = timegm(&tm);
		if (timeval < 0) {
			printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
					name);
			goto error;
		}
	} else {
		/* Get day, month, year. */
		if (!localtime_r(&timeval, &tm)) {
			printf_error("Failure in localtime_r()");
			goto error;
		}
		tm.tm_sec = bound->lazy_values.ss;
		tm.tm_min = bound->lazy_values.mm;
		tm.tm_hour = bound->lazy_values.hh;
		timeval = mktime(&tm);
		if (timeval < 0) {
			printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
				name);
			goto error;
		}
	}
	value = (int64_t) timeval;
	value *= NSEC_PER_SEC;
	value += bound->lazy_values.ns;
	bound->value = value;
	bound->set = true;
	bound->lazy = false;
	*lazy_update = true;
	return 0;

error:
	return -1;
}

static
struct bt_notification *evaluate_event_notification(
		struct bt_notification *notification,
		struct trimmer_iterator *trim_it,
		struct trimmer_bound *begin, struct trimmer_bound *end,
		bool *_event_in_range)
{
	int64_t ts;
	int clock_ret;
	struct bt_ctf_event *event = NULL, *writer_event;
	bool in_range = true;
	struct bt_ctf_clock_class *clock_class = NULL;
	struct bt_ctf_trace *trace = NULL;
	struct bt_ctf_stream *stream = NULL;
	struct bt_ctf_stream_class *stream_class = NULL;
	struct bt_ctf_clock_value *clock_value = NULL;
	bool lazy_update = false;
	struct bt_notification *new_notification = NULL;
	struct bt_clock_class_priority_map *cc_prio_map;

	event = bt_notification_event_get_event(notification);
	assert(event);
	cc_prio_map = bt_notification_event_get_clock_class_priority_map(
			notification);
	assert(cc_prio_map);
	writer_event = trimmer_output_event(trim_it, event);
	assert(writer_event);
	new_notification = bt_notification_event_create(writer_event, cc_prio_map);
	assert(new_notification);
	bt_put(cc_prio_map);

	stream = bt_ctf_event_get_stream(event);
	assert(stream);

	stream_class = bt_ctf_stream_get_class(stream);
	assert(stream_class);

	trace = bt_ctf_stream_class_get_trace(stream_class);
	assert(trace);

	/* FIXME multi-clock? */
	clock_class = bt_ctf_trace_get_clock_class(trace, 0);
	if (!clock_class) {
		goto end;
	}

	clock_value = bt_ctf_event_get_clock_value(event, clock_class);
	if (!clock_value) {
		printf_error("Failed to retrieve clock value");
		goto error;
	}

	clock_ret = bt_ctf_clock_value_get_value_ns_from_epoch(
			clock_value, &ts);
	if (clock_ret) {
		printf_error("Failed to retrieve clock value timestamp");
		goto error;
	}
	if (update_lazy_bound(begin, "begin", ts, &lazy_update)) {
		goto end;
	}
	if (update_lazy_bound(end, "end", ts, &lazy_update)) {
		goto end;
	}
	if (lazy_update && begin->set && end->set) {
		if (begin->value > end->value) {
			printf_error("Unexpected: time range begin value is above end value");
			goto error;
		}
	}
	if (begin->set && ts < begin->value) {
		in_range = false;
	}
	if (end->set && ts > end->value) {
		in_range = false;
	}

	goto end;

error:
	BT_PUT(new_notification);
end:
	bt_put(event);
	bt_put(writer_event);
	bt_put(clock_class);
	bt_put(trace);
	bt_put(stream);
	bt_put(stream_class);
	bt_put(clock_value);
	*_event_in_range = in_range;
	return new_notification;
}

static
int ns_from_integer_field(struct bt_ctf_field *integer, int64_t *ns)
{
	int ret = 0;
	int is_signed;
	uint64_t raw_clock_value;
	struct bt_ctf_field_type *integer_type = NULL;
	struct bt_ctf_clock_class *clock_class = NULL;
	struct bt_ctf_clock_value *clock_value = NULL;

	integer_type = bt_ctf_field_get_type(integer);
	assert(integer_type);
	clock_class = bt_ctf_field_type_integer_get_mapped_clock_class(
		integer_type);
	if (!clock_class) {
		ret = -1;
		goto end;
	}

	is_signed = bt_ctf_field_type_integer_get_signed(integer_type);
	if (!is_signed) {
		ret = bt_ctf_field_unsigned_integer_get_value(integer,
				&raw_clock_value);
		if (ret) {
			goto end;
		}
	} else {
		/* Signed clock values are unsupported. */
		goto end;
	}

	clock_value = bt_ctf_clock_value_create(clock_class, raw_clock_value);
        if (!clock_value) {
		goto end;
	}

	ret = bt_ctf_clock_value_get_value_ns_from_epoch(clock_value, ns);
end:
	bt_put(integer_type);
	bt_put(clock_class);
	bt_put(clock_value);
	return ret;
}

static uint64_t ns_from_value(uint64_t frequency, uint64_t value)
{
	uint64_t ns;

	if (frequency == NSEC_PER_SEC) {
		ns = value;
	} else {
		ns = (uint64_t) ((1e9 * (double) value) / (double) frequency);
	}

	return ns;
}

/*
 * timestamp minus the offset.
 */
static
int64_t get_raw_timestamp(struct bt_ctf_packet *writer_packet,
		int64_t timestamp)
{
	struct bt_ctf_clock_class *writer_clock_class;
	int64_t sec_offset, cycles_offset, ns;
	struct bt_ctf_trace *writer_trace;
	struct bt_ctf_stream *writer_stream;
	struct bt_ctf_stream_class *writer_stream_class;
	int ret;
	uint64_t freq;

	writer_stream = bt_ctf_packet_get_stream(writer_packet);
	assert(writer_stream);

	writer_stream_class = bt_ctf_stream_get_class(writer_stream);
	assert(writer_stream_class);

	writer_trace = bt_ctf_stream_class_get_trace(writer_stream_class);
	assert(writer_trace);

	/* FIXME multi-clock? */
	writer_clock_class = bt_ctf_trace_get_clock_class(writer_trace, 0);
	assert(writer_clock_class);

	ret = bt_ctf_clock_class_get_offset_s(writer_clock_class, &sec_offset);
	assert(!ret);
	ns = sec_offset * NSEC_PER_SEC;

	freq = bt_ctf_clock_class_get_frequency(writer_clock_class);
	assert(freq != -1ULL);

	ret = bt_ctf_clock_class_get_offset_cycles(writer_clock_class, &cycles_offset);
	assert(!ret);

	ns += ns_from_value(freq, cycles_offset);

	bt_put(writer_clock_class);
	bt_put(writer_trace);
	bt_put(writer_stream_class);
	bt_put(writer_stream);

	return timestamp - ns;
}

static
struct bt_notification *evaluate_packet_notification(
		struct bt_notification *notification,
		struct trimmer_iterator *trim_it,
		struct trimmer_bound *begin, struct trimmer_bound *end,
		bool *_packet_in_range)
{
	int64_t begin_ns, pkt_begin_ns, end_ns, pkt_end_ns;
	bool in_range = true;
	struct bt_ctf_packet *packet = NULL, *writer_packet = NULL;
	struct bt_ctf_field *packet_context = NULL,
			*timestamp_begin = NULL,
			*timestamp_end = NULL;
	struct bt_notification *new_notification = NULL;
	enum bt_component_status ret;
	bool lazy_update = false;

        switch (bt_notification_get_type(notification)) {
	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
		packet = bt_notification_packet_begin_get_packet(notification);
		assert(packet);
		writer_packet = trimmer_new_packet(trim_it, packet);
		assert(writer_packet);
		break;
	case BT_NOTIFICATION_TYPE_PACKET_END:
		packet = bt_notification_packet_end_get_packet(notification);
		assert(packet);
		writer_packet = trimmer_close_packet(trim_it, packet);
		assert(writer_packet);
		break;
	default:
		goto end;
	}

	packet_context = bt_ctf_packet_get_context(writer_packet);
	if (!packet_context) {
		goto end_no_notif;
	}

	if (!bt_ctf_field_is_structure(packet_context)) {
		goto end_no_notif;
	}

	timestamp_begin = bt_ctf_field_structure_get_field(
			packet_context, "timestamp_begin");
	if (!timestamp_begin || !bt_ctf_field_is_integer(timestamp_begin)) {
		goto end_no_notif;
	}
	timestamp_end = bt_ctf_field_structure_get_field(
			packet_context, "timestamp_end");
	if (!timestamp_end || !bt_ctf_field_is_integer(timestamp_end)) {
		goto end_no_notif;
	}

	if (ns_from_integer_field(timestamp_begin, &pkt_begin_ns)) {
		goto end_no_notif;
	}
	if (ns_from_integer_field(timestamp_end, &pkt_end_ns)) {
		goto end_no_notif;
	}

	if (update_lazy_bound(begin, "begin", pkt_begin_ns, &lazy_update)) {
		goto end_no_notif;
	}
	if (update_lazy_bound(end, "end", pkt_end_ns, &lazy_update)) {
		goto end_no_notif;
	}
	if (lazy_update && begin->set && end->set) {
		if (begin->value > end->value) {
			printf_error("Unexpected: time range begin value is above end value");
			goto end_no_notif;
		}
	}

	begin_ns = begin->set ? begin->value : INT64_MIN;
	end_ns = end->set ? end->value : INT64_MAX;

	/*
	 * Accept if there is any overlap between the selected region and the
	 * packet.
	 */
	in_range = (pkt_end_ns >= begin_ns) && (pkt_begin_ns <= end_ns);
	if (!in_range) {
		goto end_no_notif;
	}

	if (begin_ns > pkt_begin_ns) {
		ret = update_packet_context_field(trim_it->err, writer_packet,
				"timestamp_begin",
				get_raw_timestamp(writer_packet, begin_ns));
		assert(!ret);
	}

	if (end_ns < pkt_end_ns) {
		ret = update_packet_context_field(trim_it->err, writer_packet,
				"timestamp_end",
				get_raw_timestamp(writer_packet, end_ns));
		assert(!ret);
	}

end:
        switch (bt_notification_get_type(notification)) {
	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
		new_notification = bt_notification_packet_begin_create(writer_packet);
		assert(new_notification);
		break;
	case BT_NOTIFICATION_TYPE_PACKET_END:
		new_notification = bt_notification_packet_end_create(writer_packet);
		assert(new_notification);
		break;
	default:
		break;
	}
end_no_notif:
	*_packet_in_range = in_range;
	bt_put(packet);
	bt_put(writer_packet);
	bt_put(packet_context);
	bt_put(timestamp_begin);
	bt_put(timestamp_end);
	return new_notification;
}

static
struct bt_notification *evaluate_stream_notification(
		struct bt_notification *notification,
		struct trimmer_iterator *trim_it)
{
	struct bt_ctf_stream *stream;

	stream = bt_notification_stream_end_get_stream(notification);
	assert(stream);

	/* FIXME: useless copy */
	return bt_notification_stream_end_create(stream);
}

/* Return true if the notification should be forwarded. */
static
enum bt_notification_iterator_status evaluate_notification(
		struct bt_notification **notification,
		struct trimmer_iterator *trim_it,
		struct trimmer_bound *begin, struct trimmer_bound *end,
		bool *in_range)
{
	enum bt_notification_type type;
	struct bt_notification *new_notification = NULL;

	*in_range = true;
	type = bt_notification_get_type(*notification);
	switch (type) {
	case BT_NOTIFICATION_TYPE_EVENT:
	        new_notification = evaluate_event_notification(*notification,
				trim_it, begin, end, in_range);
		break;
	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	case BT_NOTIFICATION_TYPE_PACKET_END:
	        new_notification = evaluate_packet_notification(*notification,
				trim_it, begin, end, in_range);
		break;
	case BT_NOTIFICATION_TYPE_STREAM_END:
		new_notification = evaluate_stream_notification(*notification,
				trim_it);
		break;
	default:
		/* Accept all other notifications. */
		break;
	}
	BT_PUT(*notification);
	*notification = new_notification;

	return BT_NOTIFICATION_ITERATOR_STATUS_OK;
}

BT_HIDDEN
struct bt_notification_iterator_next_return trimmer_iterator_next(
		struct bt_private_notification_iterator *iterator)
{
	struct trimmer_iterator *trim_it = NULL;
	struct bt_private_component *component = NULL;
	struct trimmer *trimmer = NULL;
	struct bt_notification_iterator *source_it = NULL;
	struct bt_notification_iterator_next_return ret = {
		.status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
		.notification = NULL,
	};
	bool notification_in_range = false;

	trim_it = bt_private_notification_iterator_get_user_data(iterator);
	assert(trim_it);

	component = bt_private_notification_iterator_get_private_component(
		iterator);
	assert(component);
	trimmer = bt_private_component_get_user_data(component);
	assert(trimmer);

	source_it = trim_it->input_iterator;
	assert(source_it);

	while (!notification_in_range) {
		ret.status = bt_notification_iterator_next(source_it);
		if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
			goto end;
		}

		ret.notification = bt_notification_iterator_get_notification(
			        source_it);
		if (!ret.notification) {
			ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
			goto end;
		}

	        ret.status = evaluate_notification(&ret.notification, trim_it,
				&trimmer->begin, &trimmer->end,
				&notification_in_range);
		if (!notification_in_range) {
			BT_PUT(ret.notification);
		}

		if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
			break;
		}
	}
end:
	bt_put(component);
	return ret;
}

BT_HIDDEN
enum bt_notification_iterator_status trimmer_iterator_seek_time(
		struct bt_private_notification_iterator *iterator,
		int64_t time)
{
	return BT_NOTIFICATION_ITERATOR_STATUS_OK;
}
Commit	Line	Data
cab3f160 JG	1	/*
	2	* iterator.c
	3	*
	4	* Babeltrace Trace Trimmer Iterator
	5	*
	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Author: Jérémie Galarneau <jeremie.galarneau@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.
	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.
	27	*/
	28
b2e0c907 PP	29	#include <babeltrace/graph/notification-iterator.h>
	30	#include <babeltrace/graph/private-notification-iterator.h>
	31	#include <babeltrace/graph/notification.h>
	32	#include <babeltrace/graph/notification-event.h>
	33	#include <babeltrace/graph/notification-stream.h>
	34	#include <babeltrace/graph/notification-packet.h>
	35	#include <babeltrace/graph/component-filter.h>
	36	#include <babeltrace/graph/private-component-filter.h>
	37	#include <babeltrace/graph/private-port.h>
	38	#include <babeltrace/graph/private-connection.h>
	39	#include <babeltrace/graph/private-component.h>
44d3cbf0 JG	40	#include <babeltrace/ctf-ir/event.h>
	41	#include <babeltrace/ctf-ir/stream.h>
	42	#include <babeltrace/ctf-ir/stream-class.h>
ac0c6bdd	43	#include <babeltrace/ctf-ir/clock-class.h>
44d3cbf0 JG	44	#include <babeltrace/ctf-ir/packet.h>
44d3cbf0 JG	45	#include <babeltrace/ctf-ir/trace.h>
72208f03	46	#include <babeltrace/ctf-ir/fields.h>
44d3cbf0	47	#include <assert.h>
8b0ce102	48	#include <plugins-common.h>
44d3cbf0	49
19ce87a4 JD	50	#include "trimmer.h"
	51	#include "iterator.h"
	52	#include "copy.h"
	53
d3eb6e8f	54	BT_HIDDEN
64cadc66	55	void trimmer_iterator_finalize(struct bt_private_notification_iterator *it)
44d3cbf0 JG	56	{
	57	struct trimmer_iterator *it_data;
	58
890882ef	59	it_data = bt_private_notification_iterator_get_user_data(it);
44d3cbf0 JG	60	assert(it_data);
44d3cbf0 JG	61
99cdb69e	62	bt_put(it_data->input_iterator);
19ce87a4	63	g_hash_table_destroy(it_data->packet_map);
44d3cbf0 JG	64	g_free(it_data);
44d3cbf0 JG	65	}
cab3f160 JG	66
cab3f160 JG	67	BT_HIDDEN
d3eb6e8f	68	enum bt_notification_iterator_status trimmer_iterator_init(
91457551 PP	69	struct bt_private_notification_iterator *iterator,
91457551 PP	70	struct bt_private_port *port)
cab3f160	71	{
d3eb6e8f PP	72	enum bt_notification_iterator_status ret =
d3eb6e8f PP	73	BT_NOTIFICATION_ITERATOR_STATUS_OK;
cab3f160	74	enum bt_notification_iterator_status it_ret;
890882ef PP	75	struct bt_private_port *input_port = NULL;
890882ef PP	76	struct bt_private_connection *connection = NULL;
91457551 PP	77	struct bt_private_component *component =
91457551 PP	78	bt_private_notification_iterator_get_private_component(iterator);
44d3cbf0 JG	79	struct trimmer_iterator *it_data = g_new0(struct trimmer_iterator, 1);
	80
	81	if (!it_data) {
d3eb6e8f	82	ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
44d3cbf0 JG	83	goto end;
	84	}
	85
99cdb69e	86	/* Create a new iterator on the upstream component. */
890882ef PP	87	input_port = bt_private_component_filter_get_default_input_private_port(
890882ef PP	88	component);
99cdb69e	89	assert(input_port);
890882ef	90	connection = bt_private_port_get_private_connection(input_port);
99cdb69e JG	91	assert(connection);
99cdb69e JG	92
890882ef PP	93	it_data->input_iterator =
890882ef PP	94	bt_private_connection_create_notification_iterator(connection);
99cdb69e JG	95	if (!it_data->input_iterator) {
	96	ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
	97	goto end;
	98	}
	99
19ce87a4 JD	100	it_data->err = stderr;
	101	it_data->packet_map = g_hash_table_new_full(g_direct_hash,
	102	g_direct_equal, NULL, NULL);
	103
890882ef PP	104	it_ret = bt_private_notification_iterator_set_user_data(iterator,
890882ef PP	105	it_data);
44d3cbf0 JG	106	if (it_ret) {
	107	goto end;
	108	}
cab3f160	109	end:
91457551	110	bt_put(component);
99cdb69e JG	111	bt_put(connection);
99cdb69e JG	112	bt_put(input_port);
cab3f160 JG	113	return ret;
	114	}
	115
528debdf MD	116	static
528debdf MD	117	int update_lazy_bound(struct trimmer_bound bound, const char name,
55595636	118	int64_t ts, bool *lazy_update)
528debdf MD	119	{
	120	struct tm tm;
	121	int64_t value;
	122	time_t timeval;
	123
55595636 MD	124	*lazy_update = false;
55595636 MD	125
528debdf MD	126	if (!bound->lazy) {
	127	return 0;
	128	}
	129	tm.tm_isdst = -1;
	130	timeval = ts / NSEC_PER_SEC;
	131
	132	if (bound->lazy_values.gmt) {
	133	/* Get day, month, year. */
	134	if (!gmtime_r(&timeval, &tm)) {
55595636	135	printf_error("Failure in gmtime_r()");
528debdf MD	136	goto error;
	137	}
	138	tm.tm_sec = bound->lazy_values.ss;
	139	tm.tm_min = bound->lazy_values.mm;
	140	tm.tm_hour = bound->lazy_values.hh;
	141	timeval = timegm(&tm);
	142	if (timeval < 0) {
55595636 MD	143	printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
55595636 MD	144	name);
528debdf MD	145	goto error;
	146	}
	147	} else {
	148	/* Get day, month, year. */
	149	if (!localtime_r(&timeval, &tm)) {
55595636	150	printf_error("Failure in localtime_r()");
528debdf MD	151	goto error;
	152	}
	153	tm.tm_sec = bound->lazy_values.ss;
	154	tm.tm_min = bound->lazy_values.mm;
	155	tm.tm_hour = bound->lazy_values.hh;
	156	timeval = mktime(&tm);
	157	if (timeval < 0) {
55595636	158	printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
528debdf MD	159	name);
	160	goto error;
	161	}
	162	}
	163	value = (int64_t) timeval;
	164	value *= NSEC_PER_SEC;
	165	value += bound->lazy_values.ns;
	166	bound->value = value;
	167	bound->set = true;
	168	bound->lazy = false;
55595636	169	*lazy_update = true;
528debdf MD	170	return 0;
	171
	172	error:
528debdf MD	173	return -1;
	174	}
	175
44d3cbf0	176	static
19ce87a4 JD	177	struct bt_notification *evaluate_event_notification(
	178	struct bt_notification *notification,
	179	struct trimmer_iterator *trim_it,
55595636 MD	180	struct trimmer_bound begin, struct trimmer_bound end,
55595636 MD	181	bool *_event_in_range)
44d3cbf0	182	{
72208f03 JG	183	int64_t ts;
72208f03 JG	184	int clock_ret;
19ce87a4	185	struct bt_ctf_event event = NULL, writer_event;
72208f03	186	bool in_range = true;
ac0c6bdd	187	struct bt_ctf_clock_class *clock_class = NULL;
72208f03	188	struct bt_ctf_trace *trace = NULL;
44d3cbf0	189	struct bt_ctf_stream *stream = NULL;
72208f03 JG	190	struct bt_ctf_stream_class *stream_class = NULL;
72208f03 JG	191	struct bt_ctf_clock_value *clock_value = NULL;
55595636	192	bool lazy_update = false;
19ce87a4 JD	193	struct bt_notification *new_notification = NULL;
19ce87a4 JD	194	struct bt_clock_class_priority_map *cc_prio_map;
44d3cbf0	195
72208f03 JG	196	event = bt_notification_event_get_event(notification);
72208f03 JG	197	assert(event);
19ce87a4 JD	198	cc_prio_map = bt_notification_event_get_clock_class_priority_map(
	199	notification);
	200	assert(cc_prio_map);
	201	writer_event = trimmer_output_event(trim_it, event);
	202	assert(writer_event);
	203	new_notification = bt_notification_event_create(writer_event, cc_prio_map);
	204	assert(new_notification);
	205	bt_put(cc_prio_map);
44d3cbf0	206
72208f03 JG	207	stream = bt_ctf_event_get_stream(event);
72208f03 JG	208	assert(stream);
44d3cbf0	209
72208f03 JG	210	stream_class = bt_ctf_stream_get_class(stream);
	211	assert(stream_class);
	212
	213	trace = bt_ctf_stream_class_get_trace(stream_class);
	214	assert(trace);
	215
	216	/* FIXME multi-clock? */
ac0c6bdd PP	217	clock_class = bt_ctf_trace_get_clock_class(trace, 0);
ac0c6bdd PP	218	if (!clock_class) {
72208f03	219	goto end;
44d3cbf0	220	}
44d3cbf0	221
ac0c6bdd	222	clock_value = bt_ctf_event_get_clock_value(event, clock_class);
72208f03	223	if (!clock_value) {
55595636	224	printf_error("Failed to retrieve clock value");
19ce87a4	225	goto error;
44d3cbf0	226	}
72208f03 JG	227
	228	clock_ret = bt_ctf_clock_value_get_value_ns_from_epoch(
	229	clock_value, &ts);
	230	if (clock_ret) {
55595636	231	printf_error("Failed to retrieve clock value timestamp");
19ce87a4	232	goto error;
44d3cbf0	233	}
55595636	234	if (update_lazy_bound(begin, "begin", ts, &lazy_update)) {
528debdf MD	235	goto end;
528debdf MD	236	}
55595636	237	if (update_lazy_bound(end, "end", ts, &lazy_update)) {
528debdf MD	238	goto end;
528debdf MD	239	}
55595636 MD	240	if (lazy_update && begin->set && end->set) {
	241	if (begin->value > end->value) {
	242	printf_error("Unexpected: time range begin value is above end value");
19ce87a4	243	goto error;
55595636 MD	244	}
55595636 MD	245	}
72208f03 JG	246	if (begin->set && ts < begin->value) {
	247	in_range = false;
	248	}
	249	if (end->set && ts > end->value) {
	250	in_range = false;
	251	}
19ce87a4 JD	252
	253	goto end;
	254
	255	error:
	256	BT_PUT(new_notification);
44d3cbf0	257	end:
72208f03	258	bt_put(event);
19ce87a4	259	bt_put(writer_event);
ac0c6bdd	260	bt_put(clock_class);
72208f03 JG	261	bt_put(trace);
	262	bt_put(stream);
	263	bt_put(stream_class);
	264	bt_put(clock_value);
55595636	265	*_event_in_range = in_range;
19ce87a4	266	return new_notification;
44d3cbf0 JG	267	}
44d3cbf0 JG	268
44d3cbf0	269	static
72208f03	270	int ns_from_integer_field(struct bt_ctf_field integer, int64_t ns)
44d3cbf0	271	{
72208f03 JG	272	int ret = 0;
	273	int is_signed;
	274	uint64_t raw_clock_value;
	275	struct bt_ctf_field_type *integer_type = NULL;
ac0c6bdd	276	struct bt_ctf_clock_class *clock_class = NULL;
44d3cbf0 JG	277	struct bt_ctf_clock_value *clock_value = NULL;
44d3cbf0 JG	278
72208f03 JG	279	integer_type = bt_ctf_field_get_type(integer);
72208f03 JG	280	assert(integer_type);
ac0c6bdd PP	281	clock_class = bt_ctf_field_type_integer_get_mapped_clock_class(
	282	integer_type);
	283	if (!clock_class) {
72208f03	284	ret = -1;
44d3cbf0 JG	285	goto end;
	286	}
	287
72208f03 JG	288	is_signed = bt_ctf_field_type_integer_get_signed(integer_type);
	289	if (!is_signed) {
	290	ret = bt_ctf_field_unsigned_integer_get_value(integer,
	291	&raw_clock_value);
	292	if (ret) {
44d3cbf0 JG	293	goto end;
44d3cbf0 JG	294	}
72208f03 JG	295	} else {
	296	/* Signed clock values are unsupported. */
	297	goto end;
	298	}
44d3cbf0	299
ac0c6bdd	300	clock_value = bt_ctf_clock_value_create(clock_class, raw_clock_value);
72208f03 JG	301	if (!clock_value) {
	302	goto end;
	303	}
44d3cbf0	304
72208f03 JG	305	ret = bt_ctf_clock_value_get_value_ns_from_epoch(clock_value, ns);
	306	end:
	307	bt_put(integer_type);
ac0c6bdd	308	bt_put(clock_class);
72208f03 JG	309	bt_put(clock_value);
	310	return ret;
	311	}
44d3cbf0	312
19ce87a4 JD	313	static uint64_t ns_from_value(uint64_t frequency, uint64_t value)
	314	{
	315	uint64_t ns;
	316
	317	if (frequency == NSEC_PER_SEC) {
	318	ns = value;
	319	} else {
	320	ns = (uint64_t) ((1e9 * (double) value) / (double) frequency);
	321	}
	322
	323	return ns;
	324	}
	325
	326	/*
	327	* timestamp minus the offset.
	328	*/
72208f03	329	static
19ce87a4 JD	330	int64_t get_raw_timestamp(struct bt_ctf_packet *writer_packet,
	331	int64_t timestamp)
	332	{
	333	struct bt_ctf_clock_class *writer_clock_class;
	334	int64_t sec_offset, cycles_offset, ns;
	335	struct bt_ctf_trace *writer_trace;
	336	struct bt_ctf_stream *writer_stream;
	337	struct bt_ctf_stream_class *writer_stream_class;
	338	int ret;
	339	uint64_t freq;
	340
	341	writer_stream = bt_ctf_packet_get_stream(writer_packet);
	342	assert(writer_stream);
	343
	344	writer_stream_class = bt_ctf_stream_get_class(writer_stream);
	345	assert(writer_stream_class);
	346
	347	writer_trace = bt_ctf_stream_class_get_trace(writer_stream_class);
	348	assert(writer_trace);
	349
	350	/* FIXME multi-clock? */
	351	writer_clock_class = bt_ctf_trace_get_clock_class(writer_trace, 0);
	352	assert(writer_clock_class);
	353
	354	ret = bt_ctf_clock_class_get_offset_s(writer_clock_class, &sec_offset);
	355	assert(!ret);
	356	ns = sec_offset * NSEC_PER_SEC;
	357
	358	freq = bt_ctf_clock_class_get_frequency(writer_clock_class);
	359	assert(freq != -1ULL);
	360
	361	ret = bt_ctf_clock_class_get_offset_cycles(writer_clock_class, &cycles_offset);
	362	assert(!ret);
	363
	364	ns += ns_from_value(freq, cycles_offset);
	365
	366	bt_put(writer_clock_class);
	367	bt_put(writer_trace);
	368	bt_put(writer_stream_class);
	369	bt_put(writer_stream);
	370
	371	return timestamp - ns;
	372	}
	373
	374	static
	375	struct bt_notification *evaluate_packet_notification(
55595636	376	struct bt_notification *notification,
19ce87a4	377	struct trimmer_iterator *trim_it,
55595636 MD	378	struct trimmer_bound begin, struct trimmer_bound end,
55595636 MD	379	bool *_packet_in_range)
72208f03	380	{
72208f03 JG	381	int64_t begin_ns, pkt_begin_ns, end_ns, pkt_end_ns;
72208f03 JG	382	bool in_range = true;
19ce87a4	383	struct bt_ctf_packet packet = NULL, writer_packet = NULL;
72208f03 JG	384	struct bt_ctf_field *packet_context = NULL,
	385	*timestamp_begin = NULL,
	386	*timestamp_end = NULL;
19ce87a4 JD	387	struct bt_notification *new_notification = NULL;
	388	enum bt_component_status ret;
	389	bool lazy_update = false;
72208f03 JG	390
	391	switch (bt_notification_get_type(notification)) {
	392	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	393	packet = bt_notification_packet_begin_get_packet(notification);
19ce87a4 JD	394	assert(packet);
	395	writer_packet = trimmer_new_packet(trim_it, packet);
	396	assert(writer_packet);
44d3cbf0	397	break;
72208f03 JG	398	case BT_NOTIFICATION_TYPE_PACKET_END:
72208f03 JG	399	packet = bt_notification_packet_end_get_packet(notification);
19ce87a4 JD	400	assert(packet);
	401	writer_packet = trimmer_close_packet(trim_it, packet);
	402	assert(writer_packet);
72208f03 JG	403	break;
72208f03 JG	404	default:
19ce87a4	405	goto end;
44d3cbf0	406	}
72208f03	407
19ce87a4	408	packet_context = bt_ctf_packet_get_context(writer_packet);
72208f03	409	if (!packet_context) {
19ce87a4	410	goto end_no_notif;
72208f03 JG	411	}
	412
	413	if (!bt_ctf_field_is_structure(packet_context)) {
19ce87a4	414	goto end_no_notif;
72208f03 JG	415	}
	416
	417	timestamp_begin = bt_ctf_field_structure_get_field(
	418	packet_context, "timestamp_begin");
	419	if (!timestamp_begin \|\| !bt_ctf_field_is_integer(timestamp_begin)) {
19ce87a4	420	goto end_no_notif;
72208f03 JG	421	}
	422	timestamp_end = bt_ctf_field_structure_get_field(
	423	packet_context, "timestamp_end");
	424	if (!timestamp_end \|\| !bt_ctf_field_is_integer(timestamp_end)) {
19ce87a4	425	goto end_no_notif;
72208f03 JG	426	}
72208f03 JG	427
55595636	428	if (ns_from_integer_field(timestamp_begin, &pkt_begin_ns)) {
19ce87a4	429	goto end_no_notif;
72208f03	430	}
55595636	431	if (ns_from_integer_field(timestamp_end, &pkt_end_ns)) {
19ce87a4 JD	432	goto end_no_notif;
	433	}
	434
	435	if (update_lazy_bound(begin, "begin", pkt_begin_ns, &lazy_update)) {
	436	goto end_no_notif;
	437	}
	438	if (update_lazy_bound(end, "end", pkt_end_ns, &lazy_update)) {
	439	goto end_no_notif;
	440	}
	441	if (lazy_update && begin->set && end->set) {
	442	if (begin->value > end->value) {
	443	printf_error("Unexpected: time range begin value is above end value");
	444	goto end_no_notif;
	445	}
72208f03 JG	446	}
	447
	448	begin_ns = begin->set ? begin->value : INT64_MIN;
	449	end_ns = end->set ? end->value : INT64_MAX;
	450
	451	/*
	452	* Accept if there is any overlap between the selected region and the
	453	* packet.
	454	*/
	455	in_range = (pkt_end_ns >= begin_ns) && (pkt_begin_ns <= end_ns);
19ce87a4 JD	456	if (!in_range) {
	457	goto end_no_notif;
	458	}
	459
	460	if (begin_ns > pkt_begin_ns) {
	461	ret = update_packet_context_field(trim_it->err, writer_packet,
	462	"timestamp_begin",
	463	get_raw_timestamp(writer_packet, begin_ns));
	464	assert(!ret);
	465	}
	466
	467	if (end_ns < pkt_end_ns) {
	468	ret = update_packet_context_field(trim_it->err, writer_packet,
	469	"timestamp_end",
	470	get_raw_timestamp(writer_packet, end_ns));
	471	assert(!ret);
	472	}
	473
72208f03	474	end:
19ce87a4 JD	475	switch (bt_notification_get_type(notification)) {
	476	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	477	new_notification = bt_notification_packet_begin_create(writer_packet);
	478	assert(new_notification);
	479	break;
	480	case BT_NOTIFICATION_TYPE_PACKET_END:
	481	new_notification = bt_notification_packet_end_create(writer_packet);
	482	assert(new_notification);
	483	break;
	484	default:
	485	break;
	486	}
	487	end_no_notif:
55595636	488	*_packet_in_range = in_range;
72208f03	489	bt_put(packet);
19ce87a4	490	bt_put(writer_packet);
72208f03 JG	491	bt_put(packet_context);
	492	bt_put(timestamp_begin);
	493	bt_put(timestamp_end);
19ce87a4 JD	494	return new_notification;
	495	}
	496
	497	static
	498	struct bt_notification *evaluate_stream_notification(
	499	struct bt_notification *notification,
	500	struct trimmer_iterator *trim_it)
	501	{
	502	struct bt_ctf_stream *stream;
	503
	504	stream = bt_notification_stream_end_get_stream(notification);
	505	assert(stream);
	506
	507	/* FIXME: useless copy */
	508	return bt_notification_stream_end_create(stream);
72208f03 JG	509	}
	510
	511	/* Return true if the notification should be forwarded. */
	512	static
55595636	513	enum bt_notification_iterator_status evaluate_notification(
19ce87a4 JD	514	struct bt_notification **notification,
19ce87a4 JD	515	struct trimmer_iterator *trim_it,
55595636 MD	516	struct trimmer_bound begin, struct trimmer_bound end,
55595636 MD	517	bool *in_range)
72208f03	518	{
72208f03	519	enum bt_notification_type type;
19ce87a4	520	struct bt_notification *new_notification = NULL;
72208f03	521
b61397c4	522	*in_range = true;
19ce87a4	523	type = bt_notification_get_type(*notification);
72208f03 JG	524	switch (type) {
72208f03 JG	525	case BT_NOTIFICATION_TYPE_EVENT:
19ce87a4 JD	526	new_notification = evaluate_event_notification(*notification,
19ce87a4 JD	527	trim_it, begin, end, in_range);
72208f03 JG	528	break;
	529	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	530	case BT_NOTIFICATION_TYPE_PACKET_END:
19ce87a4 JD	531	new_notification = evaluate_packet_notification(*notification,
	532	trim_it, begin, end, in_range);
	533	break;
	534	case BT_NOTIFICATION_TYPE_STREAM_END:
	535	new_notification = evaluate_stream_notification(*notification,
	536	trim_it);
72208f03	537	break;
44d3cbf0	538	default:
72208f03	539	/* Accept all other notifications. */
44d3cbf0 JG	540	break;
44d3cbf0 JG	541	}
19ce87a4 JD	542	BT_PUT(*notification);
	543	*notification = new_notification;
	544
	545	return BT_NOTIFICATION_ITERATOR_STATUS_OK;
cab3f160 JG	546	}
	547
	548	BT_HIDDEN
41a2b7ae	549	struct bt_notification_iterator_next_return trimmer_iterator_next(
890882ef	550	struct bt_private_notification_iterator *iterator)
cab3f160	551	{
44d3cbf0	552	struct trimmer_iterator *trim_it = NULL;
890882ef	553	struct bt_private_component *component = NULL;
44d3cbf0 JG	554	struct trimmer *trimmer = NULL;
44d3cbf0 JG	555	struct bt_notification_iterator *source_it = NULL;
41a2b7ae PP	556	struct bt_notification_iterator_next_return ret = {
	557	.status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
	558	.notification = NULL,
	559	};
72208f03	560	bool notification_in_range = false;
cab3f160	561
890882ef	562	trim_it = bt_private_notification_iterator_get_user_data(iterator);
44d3cbf0 JG	563	assert(trim_it);
44d3cbf0 JG	564
890882ef PP	565	component = bt_private_notification_iterator_get_private_component(
890882ef PP	566	iterator);
44d3cbf0	567	assert(component);
890882ef	568	trimmer = bt_private_component_get_user_data(component);
44d3cbf0 JG	569	assert(trimmer);
44d3cbf0 JG	570
99cdb69e JG	571	source_it = trim_it->input_iterator;
99cdb69e JG	572	assert(source_it);
44d3cbf0	573
72208f03	574	while (!notification_in_range) {
41a2b7ae PP	575	ret.status = bt_notification_iterator_next(source_it);
41a2b7ae PP	576	if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
44d3cbf0 JG	577	goto end;
	578	}
	579
41a2b7ae	580	ret.notification = bt_notification_iterator_get_notification(
44d3cbf0	581	source_it);
41a2b7ae PP	582	if (!ret.notification) {
41a2b7ae PP	583	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
44d3cbf0 JG	584	goto end;
	585	}
	586
19ce87a4	587	ret.status = evaluate_notification(&ret.notification, trim_it,
55595636 MD	588	&trimmer->begin, &trimmer->end,
55595636 MD	589	&notification_in_range);
41a2b7ae	590	if (!notification_in_range) {
19ce87a4	591	BT_PUT(ret.notification);
44d3cbf0	592	}
6d5f6792	593
41a2b7ae	594	if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
6d5f6792 JG	595	break;
6d5f6792 JG	596	}
44d3cbf0	597	}
cab3f160	598	end:
44d3cbf0	599	bt_put(component);
cab3f160 JG	600	return ret;
	601	}
	602
	603	BT_HIDDEN
	604	enum bt_notification_iterator_status trimmer_iterator_seek_time(
890882ef PP	605	struct bt_private_notification_iterator *iterator,
890882ef PP	606	int64_t time)
cab3f160	607	{
72b913fb	608	return BT_NOTIFICATION_ITERATOR_STATUS_OK;
cab3f160	609	}