[babeltrace.git] / plugins / ctf / fs / fs.c

/*
 * fs.c
 *
 * Babeltrace CTF file system Reader Component
 *
 * 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-system.h>
#include <babeltrace/plugin/notification/iterator.h>
#include <glib.h>
#include <assert.h>
#include <unistd.h>
#include "fs.h"
#include "metadata.h"
#include "data-stream.h"

static bool ctf_fs_debug;

static
struct bt_notification *ctf_fs_iterator_get(
		struct bt_notification_iterator *iterator)
{
	struct bt_notification *notification = NULL;
	struct ctf_fs_component *ctf_fs;
	struct bt_component *component = bt_notification_iterator_get_component(
			iterator);

	if (!component) {
		goto end;
	}

	ctf_fs = bt_component_get_private_data(component);
	if (!ctf_fs) {
		goto end;
	}

	notification = bt_get(ctf_fs->current_notification);
end:
	return notification;
}

static
enum bt_notification_iterator_status ctf_fs_iterator_next(
		struct bt_notification_iterator *iterator)
{
	enum bt_notification_iterator_status ret;
	struct bt_ctf_notif_iter_notif *notification;
//	struct bt_notification *notification = NULL;
	struct ctf_fs_component *ctf_fs;
	struct bt_component *component = bt_notification_iterator_get_component(
			iterator);

	if (!component) {
		ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
		goto end;
	}

	ctf_fs = bt_component_get_private_data(component);
	assert(ctf_fs);

	ret = ctf_fs_data_stream_get_next_notification(ctf_fs, &notification);
	if (ret || !notification) {
		goto end;
	}

	switch (notification->type) {
	case BT_CTF_NOTIF_ITER_NOTIF_NEW_PACKET:
	{
		struct bt_ctf_notif_iter_notif_new_packet *notif =
			(struct bt_ctf_notif_iter_notif_new_packet *) notification;
		break;
	}
	case BT_CTF_NOTIF_ITER_NOTIF_EVENT:
	{
		struct bt_ctf_notif_iter_notif_event *notif =
			(struct bt_ctf_notif_iter_notif_event *) notification;
		break;
	}
	case BT_CTF_NOTIF_ITER_NOTIF_END_OF_PACKET:
	{
		struct bt_ctf_notif_iter_notif_end_of_packet *notif =
			(struct bt_ctf_notif_iter_notif_end_of_packet *) notification;
		break;
	}
	default:
		break;
	}

end:
	return ret;
}

static
void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
{
	g_free(ctf_it);
}

static
void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
{
	void *data = bt_notification_iterator_get_private_data(it);

	ctf_fs_iterator_destroy_data(data);
}

static
enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
		struct bt_notification_iterator *it)
{
	struct ctf_fs_iterator *ctf_it;
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;

	assert(source && it);
	ctf_it = g_new0(struct ctf_fs_iterator, 1);
	if (!ctf_it) {
		ret = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
	if (ret) {
		goto error;
	}

	ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
	if (ret) {
		goto error;
	}

	ret = bt_notification_iterator_set_destroy_cb(it,
			ctf_fs_iterator_destroy);
	if (ret) {
		goto error;
	}

	ret = bt_notification_iterator_set_private_data(it, ctf_it);
	if (ret) {
		goto error;
	}
end:
	return ret;
error:
	(void) bt_notification_iterator_set_private_data(it, NULL);
	ctf_fs_iterator_destroy_data(ctf_it);
	return ret;
}

static
void ctf_fs_destroy_data(struct ctf_fs_component *component)
{
	if (component->trace_path) {
		g_string_free(component->trace_path, TRUE);
	}

	ctf_fs_metadata_fini(&component->metadata);
	ctf_fs_data_stream_fini(&component->data_stream);
	BT_PUT(component->current_notification);
	g_free(component);
}

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

	ctf_fs_destroy_data(data);
}

static
struct ctf_fs_component *ctf_fs_create(struct bt_value *params)
{
	struct ctf_fs_component *ctf_fs;
	struct bt_value *value = NULL;
	const char *path;
	enum bt_value_status ret;

	ctf_fs = g_new0(struct ctf_fs_component, 1);
	if (!ctf_fs) {
		goto end;
	}

	/* FIXME: should probably look for a source URI */
	value = bt_value_map_get(params, "path");
	if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
		goto error;
	}

	ret = bt_value_string_get(value, &path);
	if (ret != BT_VALUE_STATUS_OK) {
		goto error;
	}

	ctf_fs->trace_path = g_string_new(path);
	if (!ctf_fs->trace_path) {
		goto error;
	}

	ctf_fs->error_fp = stderr;
	ctf_fs->page_size = (size_t) getpagesize();
	ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
	ctf_fs_metadata_set_trace(ctf_fs);
	ctf_fs_data_stream_open_streams(ctf_fs);
	goto end;

error:
	ctf_fs_destroy_data(ctf_fs);
end:
	BT_PUT(value);
	return ctf_fs;
}

BT_HIDDEN
enum bt_component_status ctf_fs_init(struct bt_component *source,
		struct bt_value *params)
{
	struct ctf_fs_component *ctf_fs;
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;

	assert(source);
	ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
	ctf_fs = ctf_fs_create(params);
	if (!ctf_fs) {
		ret = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_set_private_data(source, ctf_fs);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_source_set_iterator_init_cb(source,
			ctf_fs_iterator_init);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

end:
	return ret;
error:
	(void) bt_component_set_private_data(source, NULL);
        ctf_fs_destroy_data(ctf_fs);
	return ret;
}
Commit	Line	Data
7a278c8e	1	/*
ea0b4b9e	2	* fs.c
7a278c8e	3	*
ea0b4b9e	4	* Babeltrace CTF file system Reader Component
7a278c8e	5	*
f3bc2010	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7a278c8e JG	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
ea0b4b9e	29	#include <babeltrace/plugin/plugin-system.h>
760051fa	30	#include <babeltrace/plugin/notification/iterator.h>
ea0b4b9e JG	31	#include <glib.h>
ea0b4b9e JG	32	#include <assert.h>
56a1cced JG	33	#include <unistd.h>
56a1cced JG	34	#include "fs.h"
413bc2c4 JG	35	#include "metadata.h"
413bc2c4 JG	36	#include "data-stream.h"
ea0b4b9e JG	37
	38	static bool ctf_fs_debug;
	39
	40	static
760051fa JG	41	struct bt_notification *ctf_fs_iterator_get(
760051fa JG	42	struct bt_notification_iterator *iterator)
ea0b4b9e	43	{
d01e0f33 JG	44	struct bt_notification *notification = NULL;
	45	struct ctf_fs_component *ctf_fs;
	46	struct bt_component *component = bt_notification_iterator_get_component(
	47	iterator);
	48
	49	if (!component) {
	50	goto end;
	51	}
	52
	53	ctf_fs = bt_component_get_private_data(component);
	54	if (!ctf_fs) {
	55	goto end;
	56	}
	57
	58	notification = bt_get(ctf_fs->current_notification);
	59	end:
	60	return notification;
ea0b4b9e JG	61	}
	62
	63	static
760051fa JG	64	enum bt_notification_iterator_status ctf_fs_iterator_next(
760051fa JG	65	struct bt_notification_iterator *iterator)
ea0b4b9e	66	{
d01e0f33 JG	67	enum bt_notification_iterator_status ret;
	68	struct bt_ctf_notif_iter_notif *notification;
	69	// struct bt_notification *notification = NULL;
	70	struct ctf_fs_component *ctf_fs;
	71	struct bt_component *component = bt_notification_iterator_get_component(
	72	iterator);
	73
	74	if (!component) {
	75	ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
	76	goto end;
	77	}
	78
7aeb43bf JG	79	ctf_fs = bt_component_get_private_data(component);
	80	assert(ctf_fs);
	81
d01e0f33 JG	82	ret = ctf_fs_data_stream_get_next_notification(ctf_fs, &notification);
	83	if (ret \|\| !notification) {
	84	goto end;
	85	}
	86
	87	switch (notification->type) {
	88	case BT_CTF_NOTIF_ITER_NOTIF_NEW_PACKET:
	89	{
	90	struct bt_ctf_notif_iter_notif_new_packet *notif =
	91	(struct bt_ctf_notif_iter_notif_new_packet *) notification;
	92	break;
	93	}
	94	case BT_CTF_NOTIF_ITER_NOTIF_EVENT:
	95	{
	96	struct bt_ctf_notif_iter_notif_event *notif =
	97	(struct bt_ctf_notif_iter_notif_event *) notification;
	98	break;
	99	}
	100	case BT_CTF_NOTIF_ITER_NOTIF_END_OF_PACKET:
	101	{
	102	struct bt_ctf_notif_iter_notif_end_of_packet *notif =
	103	(struct bt_ctf_notif_iter_notif_end_of_packet *) notification;
	104	break;
	105	}
	106	default:
	107	break;
	108	}
	109
	110	end:
	111	return ret;
ea0b4b9e	112	}
bfd20a42	113
760051fa JG	114	static
	115	void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
	116	{
	117	g_free(ctf_it);
	118	}
	119
	120	static
	121	void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
	122	{
	123	void *data = bt_notification_iterator_get_private_data(it);
	124
	125	ctf_fs_iterator_destroy_data(data);
	126	}
	127
	128	static
ea0b4b9e JG	129	enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
ea0b4b9e JG	130	struct bt_notification_iterator *it)
4c1456f0	131	{
760051fa	132	struct ctf_fs_iterator *ctf_it;
413bc2c4	133	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
ea0b4b9e JG	134
ea0b4b9e JG	135	assert(source && it);
760051fa JG	136	ctf_it = g_new0(struct ctf_fs_iterator, 1);
	137	if (!ctf_it) {
	138	ret = BT_COMPONENT_STATUS_NOMEM;
	139	goto end;
	140	}
	141
	142	ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
	143	if (ret) {
	144	goto error;
	145	}
	146
	147	ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
	148	if (ret) {
	149	goto error;
	150	}
	151
	152	ret = bt_notification_iterator_set_destroy_cb(it,
	153	ctf_fs_iterator_destroy);
	154	if (ret) {
	155	goto error;
	156	}
	157
	158	ret = bt_notification_iterator_set_private_data(it, ctf_it);
	159	if (ret) {
	160	goto error;
	161	}
	162	end:
ea0b4b9e	163	return ret;
760051fa JG	164	error:
	165	(void) bt_notification_iterator_set_private_data(it, NULL);
	166	ctf_fs_iterator_destroy_data(ctf_it);
	167	return ret;
	168	}
	169
760051fa JG	170	static
	171	void ctf_fs_destroy_data(struct ctf_fs_component *component)
	172	{
56a1cced JG	173	if (component->trace_path) {
	174	g_string_free(component->trace_path, TRUE);
	175	}
	176
413bc2c4 JG	177	ctf_fs_metadata_fini(&component->metadata);
413bc2c4 JG	178	ctf_fs_data_stream_fini(&component->data_stream);
d01e0f33	179	BT_PUT(component->current_notification);
760051fa JG	180	g_free(component);
	181	}
	182
	183	static
	184	void ctf_fs_destroy(struct bt_component *component)
	185	{
	186	void *data = bt_component_get_private_data(component);
	187
	188	ctf_fs_destroy_data(data);
4c1456f0 JG	189	}
4c1456f0 JG	190
56a1cced JG	191	static
	192	struct ctf_fs_component ctf_fs_create(struct bt_value params)
	193	{
	194	struct ctf_fs_component *ctf_fs;
1ef09eb5	195	struct bt_value *value = NULL;
56a1cced JG	196	const char *path;
	197	enum bt_value_status ret;
	198
	199	ctf_fs = g_new0(struct ctf_fs_component, 1);
	200	if (!ctf_fs) {
	201	goto end;
	202	}
	203
	204	/* FIXME: should probably look for a source URI */
	205	value = bt_value_map_get(params, "path");
	206	if (!value \|\| bt_value_is_null(value) \|\| !bt_value_is_string(value)) {
	207	goto error;
	208	}
	209
	210	ret = bt_value_string_get(value, &path);
	211	if (ret != BT_VALUE_STATUS_OK) {
	212	goto error;
	213	}
	214
	215	ctf_fs->trace_path = g_string_new(path);
	216	if (!ctf_fs->trace_path) {
	217	goto error;
	218	}
	219
	220	ctf_fs->error_fp = stderr;
	221	ctf_fs->page_size = (size_t) getpagesize();
413bc2c4 JG	222	ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
	223	ctf_fs_metadata_set_trace(ctf_fs);
	224	ctf_fs_data_stream_open_streams(ctf_fs);
1ef09eb5 JG	225	goto end;
1ef09eb5 JG	226
56a1cced JG	227	error:
56a1cced JG	228	ctf_fs_destroy_data(ctf_fs);
1ef09eb5 JG	229	end:
1ef09eb5 JG	230	BT_PUT(value);
56a1cced JG	231	return ctf_fs;
	232	}
	233
ea0b4b9e JG	234	BT_HIDDEN
ea0b4b9e JG	235	enum bt_component_status ctf_fs_init(struct bt_component *source,
5c80adeb	236	struct bt_value *params)
ea0b4b9e JG	237	{
	238	struct ctf_fs_component *ctf_fs;
	239	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
	240
	241	assert(source);
	242	ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
	243	ctf_fs = ctf_fs_create(params);
	244	if (!ctf_fs) {
	245	ret = BT_COMPONENT_STATUS_NOMEM;
	246	goto end;
	247	}
4c1456f0	248
ea0b4b9e JG	249	ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
	250	if (ret != BT_COMPONENT_STATUS_OK) {
	251	goto error;
	252	}
	253
	254	ret = bt_component_set_private_data(source, ctf_fs);
	255	if (ret != BT_COMPONENT_STATUS_OK) {
	256	goto error;
	257	}
	258
	259	ret = bt_component_source_set_iterator_init_cb(source,
	260	ctf_fs_iterator_init);
	261	if (ret != BT_COMPONENT_STATUS_OK) {
	262	goto error;
	263	}
413bc2c4	264
ea0b4b9e JG	265	end:
	266	return ret;
	267	error:
	268	(void) bt_component_set_private_data(source, NULL);
760051fa	269	ctf_fs_destroy_data(ctf_fs);
ea0b4b9e JG	270	return ret;
ea0b4b9e JG	271	}