[babeltrace.git] / plugins / ctf / fs-src / metadata.c

/*
 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
 *
 * Some functions are based on older functions written by Mathieu Desnoyers.
 *
 * 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 <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <babeltrace/assert-internal.h>
#include <glib.h>
#include <babeltrace/compat/uuid-internal.h>
#include <babeltrace/compat/memstream-internal.h>
#include <babeltrace/babeltrace.h>

#include "fs.h"
#include "file.h"
#include "metadata.h"
#include "../common/metadata/decoder.h"

#define BT_LOG_TAG "PLUGIN-CTF-FS-METADATA-SRC"
#include "logging.h"

BT_HIDDEN
FILE *ctf_fs_metadata_open_file(const char *trace_path)
{
	GString *metadata_path;
	FILE *fp = NULL;

	metadata_path = g_string_new(trace_path);
	if (!metadata_path) {
		goto end;
	}

	g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
	fp = fopen(metadata_path->str, "rb");
	g_string_free(metadata_path, TRUE);
end:
	return fp;
}

static struct ctf_fs_file *get_file(const char *trace_path)
{
	struct ctf_fs_file *file = ctf_fs_file_create();

	if (!file) {
		goto error;
	}

	g_string_append(file->path, trace_path);
	g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);

	if (ctf_fs_file_open(file, "rb")) {
		goto error;
	}

	goto end;

error:
	if (file) {
		ctf_fs_file_destroy(file);
		file = NULL;
	}

end:
	return file;
}

int ctf_fs_metadata_set_trace(struct ctf_fs_trace *ctf_fs_trace,
		struct ctf_fs_metadata_config *config)
{
	int ret = 0;
	struct ctf_fs_file *file = NULL;
	struct ctf_metadata_decoder_config decoder_config = {
		.clock_class_offset_s = config ? config->clock_class_offset_s : 0,
		.clock_class_offset_ns = config ? config->clock_class_offset_ns : 0,
	};

	file = get_file(ctf_fs_trace->path->str);
	if (!file) {
		BT_LOGE("Cannot create metadata file object");
		ret = -1;
		goto end;
	}

	ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(
		config ? &decoder_config : NULL,
		ctf_fs_trace->name->str);
	if (!ctf_fs_trace->metadata->decoder) {
		BT_LOGE("Cannot create metadata decoder object");
		ret = -1;
		goto end;
	}

	ret = ctf_metadata_decoder_decode(ctf_fs_trace->metadata->decoder,
		file->fp);
	if (ret) {
		BT_LOGE("Cannot decode metadata file");
		goto end;
	}

	ctf_fs_trace->metadata->trace = ctf_metadata_decoder_get_ir_trace(
		ctf_fs_trace->metadata->decoder);
	BT_ASSERT(ctf_fs_trace->metadata->trace);
	ctf_fs_trace->metadata->tc =
		ctf_metadata_decoder_borrow_ctf_trace_class(
			ctf_fs_trace->metadata->decoder);
	BT_ASSERT(ctf_fs_trace->metadata->tc);

end:
	ctf_fs_file_destroy(file);
	return ret;
}

int ctf_fs_metadata_init(struct ctf_fs_metadata *metadata)
{
	/* Nothing to initialize for the moment. */
	return 0;
}

void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
{
	if (metadata->text) {
		free(metadata->text);
	}

	if (metadata->trace) {
		BT_PUT(metadata->trace);
	}

	if (metadata->decoder) {
		ctf_metadata_decoder_destroy(metadata->decoder);
	}
}
Commit	Line	Data
e98a2d6e PP	1	/*
	2	* Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
	3	* Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
	4	*
	5	* Some functions are based on older functions written by Mathieu Desnoyers.
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#include <stdio.h>
	27	#include <stdint.h>
	28	#include <stdlib.h>
	29	#include <stdbool.h>
f6ccaed9	30	#include <babeltrace/assert-internal.h>
e98a2d6e	31	#include <glib.h>
3d9990ac PP	32	#include <babeltrace/compat/uuid-internal.h>
3d9990ac PP	33	#include <babeltrace/compat/memstream-internal.h>
9d408fca	34	#include <babeltrace/babeltrace.h>
e98a2d6e	35
56a1cced JG	36	#include "fs.h"
	37	#include "file.h"
	38	#include "metadata.h"
1e649dff	39	#include "../common/metadata/decoder.h"
e98a2d6e	40
55314f2a JG	41	#define BT_LOG_TAG "PLUGIN-CTF-FS-METADATA-SRC"
	42	#include "logging.h"
	43
33f93973 PP	44	BT_HIDDEN
	45	FILE ctf_fs_metadata_open_file(const char trace_path)
	46	{
4dd8c9bf	47	GString *metadata_path;
33f93973 PP	48	FILE *fp = NULL;
33f93973 PP	49
4dd8c9bf	50	metadata_path = g_string_new(trace_path);
33f93973	51	if (!metadata_path) {
4dd8c9bf	52	goto end;
33f93973 PP	53	}
33f93973 PP	54
3743a302	55	g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
33f93973	56	fp = fopen(metadata_path->str, "rb");
33f93973	57	g_string_free(metadata_path, TRUE);
4dd8c9bf	58	end:
33f93973 PP	59	return fp;
	60	}
	61
55314f2a	62	static struct ctf_fs_file get_file(const char trace_path)
e98a2d6e	63	{
55314f2a	64	struct ctf_fs_file *file = ctf_fs_file_create();
e98a2d6e PP	65
	66	if (!file) {
	67	goto error;
	68	}
	69
	70	g_string_append(file->path, trace_path);
3743a302	71	g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
e98a2d6e	72
55314f2a	73	if (ctf_fs_file_open(file, "rb")) {
e98a2d6e PP	74	goto error;
	75	}
	76
	77	goto end;
	78
	79	error:
	80	if (file) {
	81	ctf_fs_file_destroy(file);
	82	file = NULL;
	83	}
	84
	85	end:
	86	return file;
	87	}
	88
55314f2a	89	int ctf_fs_metadata_set_trace(struct ctf_fs_trace *ctf_fs_trace,
a2a54545	90	struct ctf_fs_metadata_config *config)
e98a2d6e PP	91	{
e98a2d6e PP	92	int ret = 0;
1e649dff	93	struct ctf_fs_file *file = NULL;
a2a54545	94	struct ctf_metadata_decoder_config decoder_config = {
297941e3 JG	95	.clock_class_offset_s = config ? config->clock_class_offset_s : 0,
297941e3 JG	96	.clock_class_offset_ns = config ? config->clock_class_offset_ns : 0,
a2a54545	97	};
e98a2d6e	98
55314f2a	99	file = get_file(ctf_fs_trace->path->str);
e98a2d6e	100	if (!file) {
55314f2a	101	BT_LOGE("Cannot create metadata file object");
8318bbaa	102	ret = -1;
1e649dff	103	goto end;
e98a2d6e PP	104	}
e98a2d6e PP	105
44c440bc	106	ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(
297941e3	107	config ? &decoder_config : NULL,
55314f2a	108	ctf_fs_trace->name->str);
44c440bc	109	if (!ctf_fs_trace->metadata->decoder) {
55314f2a	110	BT_LOGE("Cannot create metadata decoder object");
8318bbaa	111	ret = -1;
1e649dff	112	goto end;
e98a2d6e PP	113	}
e98a2d6e PP	114
44c440bc PP	115	ret = ctf_metadata_decoder_decode(ctf_fs_trace->metadata->decoder,
44c440bc PP	116	file->fp);
1e649dff	117	if (ret) {
55314f2a	118	BT_LOGE("Cannot decode metadata file");
1e649dff	119	goto end;
e98a2d6e PP	120	}
e98a2d6e PP	121
44c440bc PP	122	ctf_fs_trace->metadata->trace = ctf_metadata_decoder_get_ir_trace(
44c440bc PP	123	ctf_fs_trace->metadata->decoder);
f6ccaed9	124	BT_ASSERT(ctf_fs_trace->metadata->trace);
44c440bc PP	125	ctf_fs_trace->metadata->tc =
	126	ctf_metadata_decoder_borrow_ctf_trace_class(
	127	ctf_fs_trace->metadata->decoder);
	128	BT_ASSERT(ctf_fs_trace->metadata->tc);
4f1f88a6	129
e98a2d6e	130	end:
1e649dff	131	ctf_fs_file_destroy(file);
4f1f88a6	132	return ret;
e98a2d6e PP	133	}
	134
	135	int ctf_fs_metadata_init(struct ctf_fs_metadata *metadata)
	136	{
5b29e799	137	/* Nothing to initialize for the moment. */
e98a2d6e PP	138	return 0;
	139	}
	140
413bc2c4	141	void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
e98a2d6e PP	142	{
	143	if (metadata->text) {
	144	free(metadata->text);
	145	}
	146
	147	if (metadata->trace) {
	148	BT_PUT(metadata->trace);
	149	}
44c440bc PP	150
	151	if (metadata->decoder) {
	152	ctf_metadata_decoder_destroy(metadata->decoder);
	153	}
e98a2d6e	154	}