[babeltrace.git] / lib / trace-collection.c

/*
 * trace-collection.c
 *
 * Babeltrace Library
 *
 * Copyright 2012 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/format.h>
#include <babeltrace/context.h>
#include <babeltrace/ctf/types.h>
#include <babeltrace/ctf-text/types.h>
#include <babeltrace/trace-collection.h>
#include <babeltrace/ctf-ir/metadata.h>	/* for clocks */
#include <babeltrace/clock-internal.h>

#include <inttypes.h>

struct clock_match {
	GHashTable *clocks;
	struct ctf_clock *clock_match;
	struct trace_collection *tc;
};

static void check_clock_match(gpointer key, gpointer value, gpointer user_data)
{
	struct clock_match *match = user_data;
	struct ctf_clock *clock_a = value, *clock_b;

	if (clock_a->absolute) {
		/*
		 * Absolute time references, such as NTP, are looked up
		 * by clock name.
		 */
		clock_b = g_hash_table_lookup(match->clocks,
			(gpointer) (unsigned long) clock_a->name);
		if (clock_b) {
			match->clock_match = clock_b;
			return;
		}
	} else if (clock_a->uuid != 0) {
		/*
		 * Lookup the the trace clocks into the collection
		 * clocks.
		 */
		clock_b = g_hash_table_lookup(match->clocks,
			(gpointer) (unsigned long) clock_a->uuid);
		if (clock_b) {
			match->clock_match = clock_b;
			return;
		}
	}
}

/*
 * Note: if using a frequency different from 1GHz for clock->offset, it
 * is recommended to express the seconds in offset_s, otherwise there
 * will be a loss of precision caused by the limited size of the double
 * mantissa.
 */
static
uint64_t clock_offset_ns(struct ctf_clock *clock)
{
	return clock->offset_s * 1000000000ULL
			+ clock_cycles_to_ns(clock, clock->offset);
}

static void clock_add(gpointer key, gpointer value, gpointer user_data)
{
	struct clock_match *clock_match = user_data;
	GHashTable *tc_clocks = clock_match->clocks;
	struct ctf_clock *t_clock = value;
	GQuark v;

	if (t_clock->absolute)
		v = t_clock->name;
	else
		v = t_clock->uuid;
	if (v) {
		struct ctf_clock *tc_clock;

		tc_clock = g_hash_table_lookup(tc_clocks,
				(gpointer) (unsigned long) v);
		if (!tc_clock) {
			/*
			 * For now we only support CTF that has one
			 * single clock uuid or name (absolute ref) per
			 * trace.
			 */
			if (g_hash_table_size(tc_clocks) > 0) {
				fprintf(stderr, "[error] Only CTF traces with a single clock description are supported by this babeltrace version.\n");
			}
			if (!clock_match->tc->offset_nr) {
				clock_match->tc->offset_first = clock_offset_ns(t_clock);
				clock_match->tc->delta_offset_first_sum = 0;
				clock_match->tc->offset_nr++;
				clock_match->tc->single_clock_offset_avg =
					clock_match->tc->offset_first;
			}
			g_hash_table_insert(tc_clocks,
				(gpointer) (unsigned long) v,
				value);
		} else if (!t_clock->absolute) {
			int64_t diff_ns;

			/*
			 * For non-absolute clocks, check that the
			 * offsets match. If not, warn the user that we
			 * do an arbitrary choice.
			 */
			diff_ns = clock_offset_ns(tc_clock) - clock_offset_ns(t_clock);
			printf_debug("Clock \"%s\" offset between traces has a delta of %" PRIu64 " ns.",
				g_quark_to_string(tc_clock->name),
				diff_ns < 0 ? -diff_ns : diff_ns);
			if (diff_ns > 10000 || diff_ns < -10000) {
				fprintf(stderr, "[warning] Clock \"%s\" offset differs between traces (delta %" PRIu64 " ns). Using average.\n",
					g_quark_to_string(tc_clock->name),
					diff_ns < 0 ? -diff_ns : diff_ns);
			}
			/* Compute average */
			clock_match->tc->delta_offset_first_sum +=
				clock_offset_ns(t_clock) - clock_match->tc->offset_first;
			clock_match->tc->offset_nr++;
			clock_match->tc->single_clock_offset_avg =
				clock_match->tc->offset_first
				+ (clock_match->tc->delta_offset_first_sum / clock_match->tc->offset_nr);
			/* Time need to use offset average */
			clock_match->tc->clock_use_offset_avg = 1;
		}
	}
}

/*
 * Whenever we add a trace to the trace collection, check that we can
 * correlate this trace with at least one other clock in the trace and
 * convert the index from cycles to real time.
 */
int bt_trace_collection_add(struct trace_collection *tc,
			struct bt_trace_descriptor *trace)
{
	if (!tc || !trace)
		return -EINVAL;

	if (!trace->clocks)
		return 0;

	if (tc->array->len > 1) {
		struct clock_match clock_match = {
			.clocks = tc->clocks,
			.clock_match = NULL,
			.tc = NULL,
		};

		/*
		 * With two or more traces, we need correlation info
		 * avalable.
		 */
		g_hash_table_foreach(trace->clocks,
				check_clock_match,
				&clock_match);
		if (!clock_match.clock_match) {
			fprintf(stderr, "[error] No clocks can be correlated and multiple traces are added to the collection. If you are certain those traces can be correlated, try using \"--clock-force-correlate\".\n");
			goto error;
		}
	}

	g_ptr_array_add(tc->array, trace);
	trace->collection = tc;

	{
		struct clock_match clock_match = {
			.clocks = tc->clocks,
			.clock_match = NULL,
			.tc = tc,
		};

		/*
		 * Add each clock from the trace clocks into the trace
		 * collection clocks.
		 */
		g_hash_table_foreach(trace->clocks,
				clock_add,
				&clock_match);
	}

	return 0;
error:
	return -EPERM;
}

int bt_trace_collection_remove(struct trace_collection *tc,
			    struct bt_trace_descriptor *td)
{
	if (!tc || !td)
		return -EINVAL;

	if (g_ptr_array_remove(tc->array, td)) {
		return 0;
	} else {
		return -1;
	}

}

void bt_init_trace_collection(struct trace_collection *tc)
{
	assert(tc);
	tc->array = g_ptr_array_new();
	tc->clocks = g_hash_table_new(g_direct_hash, g_direct_equal);
	tc->single_clock_offset_avg = 0;
	tc->offset_first = 0;
	tc->delta_offset_first_sum = 0;
	tc->offset_nr = 0;
}

/*
 * bt_finalize_trace_collection() closes the opened traces for read
 * and free the memory allocated for trace collection
 */
void bt_finalize_trace_collection(struct trace_collection *tc)
{
	assert(tc);
	g_ptr_array_free(tc->array, TRUE);
	g_hash_table_destroy(tc->clocks);
}
Commit	Line	Data
6cba487f MD	1	/*
	2	* trace-collection.c
	3	*
	4	* Babeltrace Library
	5	*
	6	* Copyright 2012 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.
6cba487f MD	27	*/
	28	#include <babeltrace/babeltrace.h>
	29	#include <babeltrace/format.h>
	30	#include <babeltrace/context.h>
	31	#include <babeltrace/ctf/types.h>
	32	#include <babeltrace/ctf-text/types.h>
	33	#include <babeltrace/trace-collection.h>
	34	#include <babeltrace/ctf-ir/metadata.h> /* for clocks */
75d9ab4b	35	#include <babeltrace/clock-internal.h>
6cba487f MD	36
	37	#include <inttypes.h>
	38
	39	struct clock_match {
	40	GHashTable *clocks;
	41	struct ctf_clock *clock_match;
	42	struct trace_collection *tc;
	43	};
	44
	45	static void check_clock_match(gpointer key, gpointer value, gpointer user_data)
	46	{
	47	struct clock_match *match = user_data;
	48	struct ctf_clock clock_a = value, clock_b;
	49
50052405	50	if (clock_a->absolute) {
6cba487f	51	/*
50052405 MD	52	* Absolute time references, such as NTP, are looked up
50052405 MD	53	* by clock name.
6cba487f MD	54	*/
6cba487f MD	55	clock_b = g_hash_table_lookup(match->clocks,
50052405	56	(gpointer) (unsigned long) clock_a->name);
6cba487f MD	57	if (clock_b) {
	58	match->clock_match = clock_b;
	59	return;
	60	}
50052405	61	} else if (clock_a->uuid != 0) {
6cba487f	62	/*
50052405 MD	63	* Lookup the the trace clocks into the collection
50052405 MD	64	* clocks.
6cba487f MD	65	*/
6cba487f MD	66	clock_b = g_hash_table_lookup(match->clocks,
50052405	67	(gpointer) (unsigned long) clock_a->uuid);
6cba487f MD	68	if (clock_b) {
	69	match->clock_match = clock_b;
	70	return;
	71	}
	72	}
	73	}
	74
75d9ab4b MD	75	/*
	76	* Note: if using a frequency different from 1GHz for clock->offset, it
	77	* is recommended to express the seconds in offset_s, otherwise there
	78	* will be a loss of precision caused by the limited size of the double
	79	* mantissa.
	80	*/
	81	static
	82	uint64_t clock_offset_ns(struct ctf_clock *clock)
	83	{
	84	return clock->offset_s * 1000000000ULL
	85	+ clock_cycles_to_ns(clock, clock->offset);
	86	}
	87
6cba487f MD	88	static void clock_add(gpointer key, gpointer value, gpointer user_data)
	89	{
	90	struct clock_match *clock_match = user_data;
	91	GHashTable *tc_clocks = clock_match->clocks;
	92	struct ctf_clock *t_clock = value;
	93	GQuark v;
	94
	95	if (t_clock->absolute)
	96	v = t_clock->name;
	97	else
	98	v = t_clock->uuid;
	99	if (v) {
	100	struct ctf_clock *tc_clock;
	101
	102	tc_clock = g_hash_table_lookup(tc_clocks,
	103	(gpointer) (unsigned long) v);
	104	if (!tc_clock) {
	105	/*
50052405 MD	106	* For now we only support CTF that has one
	107	* single clock uuid or name (absolute ref) per
	108	* trace.
6cba487f MD	109	*/
	110	if (g_hash_table_size(tc_clocks) > 0) {
	111	fprintf(stderr, "[error] Only CTF traces with a single clock description are supported by this babeltrace version.\n");
	112	}
	113	if (!clock_match->tc->offset_nr) {
75d9ab4b	114	clock_match->tc->offset_first = clock_offset_ns(t_clock);
6cba487f MD	115	clock_match->tc->delta_offset_first_sum = 0;
	116	clock_match->tc->offset_nr++;
	117	clock_match->tc->single_clock_offset_avg =
	118	clock_match->tc->offset_first;
	119	}
	120	g_hash_table_insert(tc_clocks,
	121	(gpointer) (unsigned long) v,
	122	value);
50052405	123	} else if (!t_clock->absolute) {
6cba487f MD	124	int64_t diff_ns;
	125
	126	/*
50052405 MD	127	* For non-absolute clocks, check that the
	128	* offsets match. If not, warn the user that we
	129	* do an arbitrary choice.
6cba487f	130	*/
75d9ab4b	131	diff_ns = clock_offset_ns(tc_clock) - clock_offset_ns(t_clock);
6cba487f MD	132	printf_debug("Clock \"%s\" offset between traces has a delta of %" PRIu64 " ns.",
	133	g_quark_to_string(tc_clock->name),
	134	diff_ns < 0 ? -diff_ns : diff_ns);
75d9ab4b	135	if (diff_ns > 10000 \|\| diff_ns < -10000) {
6cba487f MD	136	fprintf(stderr, "[warning] Clock \"%s\" offset differs between traces (delta %" PRIu64 " ns). Using average.\n",
	137	g_quark_to_string(tc_clock->name),
	138	diff_ns < 0 ? -diff_ns : diff_ns);
	139	}
	140	/* Compute average */
	141	clock_match->tc->delta_offset_first_sum +=
75d9ab4b	142	clock_offset_ns(t_clock) - clock_match->tc->offset_first;
6cba487f MD	143	clock_match->tc->offset_nr++;
	144	clock_match->tc->single_clock_offset_avg =
	145	clock_match->tc->offset_first
	146	+ (clock_match->tc->delta_offset_first_sum / clock_match->tc->offset_nr);
50052405 MD	147	/* Time need to use offset average */
50052405 MD	148	clock_match->tc->clock_use_offset_avg = 1;
6cba487f MD	149	}
	150	}
	151	}
	152
	153	/*
	154	* Whenever we add a trace to the trace collection, check that we can
03798a93 JD	155	* correlate this trace with at least one other clock in the trace and
03798a93 JD	156	* convert the index from cycles to real time.
6cba487f	157	*/
2552c374	158	int bt_trace_collection_add(struct trace_collection *tc,
7ec78969	159	struct bt_trace_descriptor *trace)
6cba487f	160	{
7ec78969	161	if (!tc \|\| !trace)
7f89ddce MD	162	return -EINVAL;
7f89ddce MD	163
34d99418 JD	164	if (!trace->clocks)
	165	return 0;
	166
6cba487f MD	167	if (tc->array->len > 1) {
	168	struct clock_match clock_match = {
	169	.clocks = tc->clocks,
	170	.clock_match = NULL,
	171	.tc = NULL,
	172	};
	173
	174	/*
	175	* With two or more traces, we need correlation info
	176	* avalable.
	177	*/
	178	g_hash_table_foreach(trace->clocks,
	179	check_clock_match,
	180	&clock_match);
	181	if (!clock_match.clock_match) {
17d37c4d	182	fprintf(stderr, "[error] No clocks can be correlated and multiple traces are added to the collection. If you are certain those traces can be correlated, try using \"--clock-force-correlate\".\n");
6cba487f MD	183	goto error;
	184	}
	185	}
	186
7ec78969 MD	187	g_ptr_array_add(tc->array, trace);
7ec78969 MD	188	trace->collection = tc;
391a4294	189
6cba487f MD	190	{
	191	struct clock_match clock_match = {
	192	.clocks = tc->clocks,
	193	.clock_match = NULL,
	194	.tc = tc,
	195	};
	196
	197	/*
	198	* Add each clock from the trace clocks into the trace
	199	* collection clocks.
	200	*/
	201	g_hash_table_foreach(trace->clocks,
	202	clock_add,
	203	&clock_match);
	204	}
03798a93	205
6cba487f MD	206	return 0;
	207	error:
	208	return -EPERM;
	209	}
	210
2552c374	211	int bt_trace_collection_remove(struct trace_collection *tc,
1b8455b7	212	struct bt_trace_descriptor *td)
6cba487f	213	{
7f89ddce MD	214	if (!tc \|\| !td)
	215	return -EINVAL;
	216
6cba487f MD	217	if (g_ptr_array_remove(tc->array, td)) {
	218	return 0;
	219	} else {
	220	return -1;
	221	}
	222
	223	}
	224
2552c374	225	void bt_init_trace_collection(struct trace_collection *tc)
6cba487f	226	{
7f89ddce	227	assert(tc);
6cba487f MD	228	tc->array = g_ptr_array_new();
	229	tc->clocks = g_hash_table_new(g_direct_hash, g_direct_equal);
	230	tc->single_clock_offset_avg = 0;
	231	tc->offset_first = 0;
	232	tc->delta_offset_first_sum = 0;
	233	tc->offset_nr = 0;
	234	}
	235
	236	/*
2552c374	237	* bt_finalize_trace_collection() closes the opened traces for read
6cba487f MD	238	* and free the memory allocated for trace collection
6cba487f MD	239	*/
2552c374	240	void bt_finalize_trace_collection(struct trace_collection *tc)
6cba487f	241	{
7f89ddce	242	assert(tc);
6cba487f MD	243	g_ptr_array_free(tc->array, TRUE);
	244	g_hash_table_destroy(tc->clocks);
	245	}