[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)
{
	return NULL;
}

static
enum bt_notification_iterator_status ctf_fs_iterator_next(
		struct bt_notification_iterator *iterator)
{
	return BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
}

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);
	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;
	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);
end:
	return ctf_fs;
error:
	ctf_fs_destroy_data(ctf_fs);
	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	{
760051fa	44	return NULL;
ea0b4b9e JG	45	}
	46
	47	static
760051fa JG	48	enum bt_notification_iterator_status ctf_fs_iterator_next(
760051fa JG	49	struct bt_notification_iterator *iterator)
ea0b4b9e	50	{
760051fa	51	return BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
ea0b4b9e	52	}
bfd20a42	53
760051fa JG	54	static
	55	void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
	56	{
	57	g_free(ctf_it);
	58	}
	59
	60	static
	61	void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
	62	{
	63	void *data = bt_notification_iterator_get_private_data(it);
	64
	65	ctf_fs_iterator_destroy_data(data);
	66	}
	67
	68	static
ea0b4b9e JG	69	enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
ea0b4b9e JG	70	struct bt_notification_iterator *it)
4c1456f0	71	{
760051fa	72	struct ctf_fs_iterator *ctf_it;
413bc2c4	73	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
ea0b4b9e JG	74
ea0b4b9e JG	75	assert(source && it);
760051fa JG	76	ctf_it = g_new0(struct ctf_fs_iterator, 1);
	77	if (!ctf_it) {
	78	ret = BT_COMPONENT_STATUS_NOMEM;
	79	goto end;
	80	}
	81
	82	ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
	83	if (ret) {
	84	goto error;
	85	}
	86
	87	ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
	88	if (ret) {
	89	goto error;
	90	}
	91
	92	ret = bt_notification_iterator_set_destroy_cb(it,
	93	ctf_fs_iterator_destroy);
	94	if (ret) {
	95	goto error;
	96	}
	97
	98	ret = bt_notification_iterator_set_private_data(it, ctf_it);
	99	if (ret) {
	100	goto error;
	101	}
	102	end:
ea0b4b9e	103	return ret;
760051fa JG	104	error:
	105	(void) bt_notification_iterator_set_private_data(it, NULL);
	106	ctf_fs_iterator_destroy_data(ctf_it);
	107	return ret;
	108	}
	109
760051fa JG	110	static
	111	void ctf_fs_destroy_data(struct ctf_fs_component *component)
	112	{
56a1cced JG	113	if (component->trace_path) {
	114	g_string_free(component->trace_path, TRUE);
	115	}
	116
413bc2c4 JG	117	ctf_fs_metadata_fini(&component->metadata);
413bc2c4 JG	118	ctf_fs_data_stream_fini(&component->data_stream);
760051fa JG	119	g_free(component);
	120	}
	121
	122	static
	123	void ctf_fs_destroy(struct bt_component *component)
	124	{
	125	void *data = bt_component_get_private_data(component);
	126
	127	ctf_fs_destroy_data(data);
4c1456f0 JG	128	}
4c1456f0 JG	129
56a1cced JG	130	static
	131	struct ctf_fs_component ctf_fs_create(struct bt_value params)
	132	{
	133	struct ctf_fs_component *ctf_fs;
	134	struct bt_value *value;
	135	const char *path;
	136	enum bt_value_status ret;
	137
	138	ctf_fs = g_new0(struct ctf_fs_component, 1);
	139	if (!ctf_fs) {
	140	goto end;
	141	}
	142
	143	/* FIXME: should probably look for a source URI */
	144	value = bt_value_map_get(params, "path");
	145	if (!value \|\| bt_value_is_null(value) \|\| !bt_value_is_string(value)) {
	146	goto error;
	147	}
	148
	149	ret = bt_value_string_get(value, &path);
	150	if (ret != BT_VALUE_STATUS_OK) {
	151	goto error;
	152	}
	153
	154	ctf_fs->trace_path = g_string_new(path);
	155	if (!ctf_fs->trace_path) {
	156	goto error;
	157	}
	158
	159	ctf_fs->error_fp = stderr;
	160	ctf_fs->page_size = (size_t) getpagesize();
413bc2c4 JG	161	ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
	162	ctf_fs_metadata_set_trace(ctf_fs);
	163	ctf_fs_data_stream_open_streams(ctf_fs);
56a1cced JG	164	end:
	165	return ctf_fs;
	166	error:
	167	ctf_fs_destroy_data(ctf_fs);
	168	return ctf_fs;
	169	}
	170
ea0b4b9e JG	171	BT_HIDDEN
ea0b4b9e JG	172	enum bt_component_status ctf_fs_init(struct bt_component *source,
5c80adeb	173	struct bt_value *params)
ea0b4b9e JG	174	{
	175	struct ctf_fs_component *ctf_fs;
	176	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
	177
	178	assert(source);
	179	ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
	180	ctf_fs = ctf_fs_create(params);
	181	if (!ctf_fs) {
	182	ret = BT_COMPONENT_STATUS_NOMEM;
	183	goto end;
	184	}
4c1456f0	185
ea0b4b9e JG	186	ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
	187	if (ret != BT_COMPONENT_STATUS_OK) {
	188	goto error;
	189	}
	190
	191	ret = bt_component_set_private_data(source, ctf_fs);
	192	if (ret != BT_COMPONENT_STATUS_OK) {
	193	goto error;
	194	}
	195
	196	ret = bt_component_source_set_iterator_init_cb(source,
	197	ctf_fs_iterator_init);
	198	if (ret != BT_COMPONENT_STATUS_OK) {
	199	goto error;
	200	}
413bc2c4	201
ea0b4b9e JG	202	end:
	203	return ret;
	204	error:
	205	(void) bt_component_set_private_data(source, NULL);
760051fa	206	ctf_fs_destroy_data(ctf_fs);
ea0b4b9e JG	207	return ret;
ea0b4b9e JG	208	}