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

/*
 * trimmer.c
 *
 * Babeltrace Trace Trimmer
 *
 * 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/plugin/plugin-macros.h>
#include <babeltrace/plugin/component.h>
#include <babeltrace/plugin/filter.h>
#include <babeltrace/plugin/notification/notification.h>
#include <babeltrace/plugin/notification/iterator.h>
#include <babeltrace/plugin/notification/event.h>
#include "trimmer.h"
#include "iterator.h"
#include <assert.h>

static
void destroy_trimmer_data(struct trimmer *trimmer)
{
	g_free(trimmer);
}

static
struct trimmer *create_trimmer_data(void)
{
	struct trimmer *trimmer;

	trimmer = g_new0(struct trimmer, 1);
	if (!trimmer) {
		goto end;
	}
end:
	return trimmer;
}

static
void destroy_trimmer(struct bt_component *component)
{
	void *data = bt_component_get_private_data(component);

	destroy_trimmer_data(data);
}

static
void init_from_params(struct trimmer *trimmer, struct bt_value *params)
{
	struct bt_value *value = NULL;

	assert(params);

        value = bt_value_map_get(params, "begin_ns_epoch");
	if (value && bt_value_is_integer(value)) {
		enum bt_value_status value_ret;

		value_ret = bt_value_integer_get(value, &trimmer->begin.value);
		if (!value_ret) {
			trimmer->begin.set = true;
		} else {
			printf_error("Failed to retrieve begin_ns_epoch value\n");
		}
	}
	bt_put(value);
        value = bt_value_map_get(params, "end_ns_epoch");
	if (value && bt_value_is_integer(value)) {
		enum bt_value_status value_ret;

		value_ret = bt_value_integer_get(value, &trimmer->end.value);
		if (!value_ret) {
			trimmer->end.set = true;
		} else {
			printf_error("Failed to retrieve end_ns_epoch value\n");
		}
	}
	bt_put(value);
}

enum bt_component_status trimmer_component_init(
	struct bt_component *component, struct bt_value *params)
{
	enum bt_component_status ret;
	struct trimmer *trimmer = create_trimmer_data();

	if (!trimmer) {
		ret = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_component_set_destroy_cb(component,
			destroy_trimmer);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_set_private_data(component, trimmer);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_filter_set_iterator_init_cb(component,
			trimmer_iterator_init);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	init_from_params(trimmer, params);
end:
	return ret;
error:
	destroy_trimmer_data(trimmer);
	return ret;
}

/* Initialize plug-in entry points. */
BT_PLUGIN_NAME("utils");
BT_PLUGIN_DESCRIPTION("Babeltrace Trace Trimmer Plug-In.");
BT_PLUGIN_AUTHOR("Jérémie Galarneau");
BT_PLUGIN_LICENSE("MIT");

BT_PLUGIN_COMPONENT_CLASSES_BEGIN
BT_PLUGIN_FILTER_COMPONENT_CLASS_ENTRY("trimmer",
		"Ensure that trace notifications outside of a given range are filtered-out.",
		trimmer_component_init)
BT_PLUGIN_COMPONENT_CLASSES_END
Commit	Line	Data
cab3f160 JG	1	/*
	2	* trimmer.c
	3	*
	4	* Babeltrace Trace Trimmer
	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
	29	#include <babeltrace/plugin/plugin-macros.h>
	30	#include <babeltrace/plugin/component.h>
	31	#include <babeltrace/plugin/filter.h>
	32	#include <babeltrace/plugin/notification/notification.h>
	33	#include <babeltrace/plugin/notification/iterator.h>
	34	#include <babeltrace/plugin/notification/event.h>
	35	#include "trimmer.h"
	36	#include "iterator.h"
44d3cbf0	37	#include <assert.h>
cab3f160 JG	38
	39	static
	40	void destroy_trimmer_data(struct trimmer *trimmer)
	41	{
	42	g_free(trimmer);
	43	}
	44
	45	static
	46	struct trimmer *create_trimmer_data(void)
	47	{
	48	struct trimmer *trimmer;
	49
	50	trimmer = g_new0(struct trimmer, 1);
	51	if (!trimmer) {
	52	goto end;
	53	}
	54	end:
	55	return trimmer;
	56	}
	57
	58	static
	59	void destroy_trimmer(struct bt_component *component)
	60	{
	61	void *data = bt_component_get_private_data(component);
	62
	63	destroy_trimmer_data(data);
	64	}
	65
44d3cbf0 JG	66	static
	67	void init_from_params(struct trimmer trimmer, struct bt_value params)
	68	{
	69	struct bt_value *value = NULL;
	70
	71	assert(params);
	72
	73	value = bt_value_map_get(params, "begin_ns_epoch");
	74	if (value && bt_value_is_integer(value)) {
	75	enum bt_value_status value_ret;
	76
	77	value_ret = bt_value_integer_get(value, &trimmer->begin.value);
	78	if (!value_ret) {
	79	trimmer->begin.set = true;
	80	} else {
	81	printf_error("Failed to retrieve begin_ns_epoch value\n");
	82	}
	83	}
	84	bt_put(value);
	85	value = bt_value_map_get(params, "end_ns_epoch");
	86	if (value && bt_value_is_integer(value)) {
	87	enum bt_value_status value_ret;
	88
	89	value_ret = bt_value_integer_get(value, &trimmer->end.value);
	90	if (!value_ret) {
	91	trimmer->end.set = true;
	92	} else {
	93	printf_error("Failed to retrieve end_ns_epoch value\n");
	94	}
	95	}
	96	bt_put(value);
	97	}
	98
cab3f160 JG	99	enum bt_component_status trimmer_component_init(
	100	struct bt_component component, struct bt_value params)
	101	{
	102	enum bt_component_status ret;
	103	struct trimmer *trimmer = create_trimmer_data();
	104
	105	if (!trimmer) {
	106	ret = BT_COMPONENT_STATUS_NOMEM;
	107	goto end;
	108	}
	109
	110	ret = bt_component_set_destroy_cb(component,
	111	destroy_trimmer);
	112	if (ret != BT_COMPONENT_STATUS_OK) {
	113	goto error;
	114	}
	115
	116	ret = bt_component_set_private_data(component, trimmer);
	117	if (ret != BT_COMPONENT_STATUS_OK) {
	118	goto error;
	119	}
	120
	121	ret = bt_component_filter_set_iterator_init_cb(component,
	122	trimmer_iterator_init);
	123	if (ret != BT_COMPONENT_STATUS_OK) {
	124	goto error;
	125	}
44d3cbf0 JG	126
44d3cbf0 JG	127	init_from_params(trimmer, params);
cab3f160 JG	128	end:
	129	return ret;
	130	error:
	131	destroy_trimmer_data(trimmer);
	132	return ret;
	133	}
	134
	135	/* Initialize plug-in entry points. */
44d3cbf0	136	BT_PLUGIN_NAME("utils");
cab3f160 JG	137	BT_PLUGIN_DESCRIPTION("Babeltrace Trace Trimmer Plug-In.");
	138	BT_PLUGIN_AUTHOR("Jérémie Galarneau");
	139	BT_PLUGIN_LICENSE("MIT");
	140
	141	BT_PLUGIN_COMPONENT_CLASSES_BEGIN
	142	BT_PLUGIN_FILTER_COMPONENT_CLASS_ENTRY("trimmer",
	143	"Ensure that trace notifications outside of a given range are filtered-out.",
	144	trimmer_component_init)
	145	BT_PLUGIN_COMPONENT_CLASSES_END