[babeltrace.git] / plugins / ctf / fs / data-stream.c

/*
 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
 *
 * 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 <glib.h>
#include <inttypes.h>
#include <sys/mman.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/notification-stream.h>
#include <babeltrace/graph/notification-event.h>
#include <babeltrace/graph/notification-packet.h>
#include "file.h"
#include "metadata.h"
#include "../common/notif-iter/notif-iter.h"
#include <assert.h>
#include "data-stream.h"

#define PRINT_ERR_STREAM	ctf_fs->error_fp
#define PRINT_PREFIX		"ctf-fs-data-stream"
#include "print.h"

static inline
size_t remaining_mmap_bytes(struct ctf_fs_stream *stream)
{
	return stream->mmap_valid_len - stream->request_offset;
}

static
int stream_munmap(struct ctf_fs_stream *stream)
{
	int ret = 0;
	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;

	if (munmap(stream->mmap_addr, stream->mmap_len)) {
		PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
			stream->mmap_addr, stream->mmap_len,
			stream->file->path->str, stream->file->fp,
			strerror(errno));
		ret = -1;
		goto end;
	}
end:
	return ret;
}

static
enum bt_ctf_notif_iter_medium_status mmap_next(struct ctf_fs_stream *stream)
{
	enum bt_ctf_notif_iter_medium_status ret =
			BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;

	/* Unmap old region */
	if (stream->mmap_addr) {
		if (stream_munmap(stream)) {
			goto error;
		}

		stream->mmap_offset += stream->mmap_valid_len;
		stream->request_offset = 0;
	}

	stream->mmap_valid_len = MIN(stream->file->size - stream->mmap_offset,
			stream->mmap_max_len);
	if (stream->mmap_valid_len == 0) {
		ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
		goto end;
	}
	/* Round up to next page, assuming page size being a power of 2. */
	stream->mmap_len = (stream->mmap_valid_len + ctf_fs->page_size - 1)
			& ~(ctf_fs->page_size - 1);
	/* Map new region */
	assert(stream->mmap_len);
	stream->mmap_addr = mmap((void *) 0, stream->mmap_len,
			PROT_READ, MAP_PRIVATE, fileno(stream->file->fp),
			stream->mmap_offset);
	if (stream->mmap_addr == MAP_FAILED) {
		PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
				stream->mmap_len, stream->file->path->str,
				stream->file->fp, stream->mmap_offset,
				strerror(errno));
		goto error;
	}

	goto end;
error:
	stream_munmap(stream);
	ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
end:
	return ret;
}

static
enum bt_ctf_notif_iter_medium_status medop_request_bytes(
		size_t request_sz, uint8_t **buffer_addr,
		size_t *buffer_sz, void *data)
{
	enum bt_ctf_notif_iter_medium_status status =
		BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
	struct ctf_fs_stream *stream = data;
	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;

	if (request_sz == 0) {
		goto end;
	}

	/* Check if we have at least one memory-mapped byte left */
	if (remaining_mmap_bytes(stream) == 0) {
		/* Are we at the end of the file? */
		if (stream->mmap_offset >= stream->file->size) {
			PDBG("Reached end of file \"%s\" (%p)\n",
				stream->file->path->str, stream->file->fp);
			status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
			goto end;
		}

		status = mmap_next(stream);
		switch (status) {
		case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK:
			break;
		case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF:
			goto end;
		default:
			PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
					stream->file->path->str,
					stream->file->fp);
			goto error;
		}
	}

	*buffer_sz = MIN(remaining_mmap_bytes(stream), request_sz);
	*buffer_addr = ((uint8_t *) stream->mmap_addr) + stream->request_offset;
	stream->request_offset += *buffer_sz;
	goto end;

error:
	status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;

end:
	return status;
}

static
struct bt_ctf_stream *medop_get_stream(
		struct bt_ctf_stream_class *stream_class, void *data)
{
	struct ctf_fs_stream *fs_stream = data;
	struct ctf_fs_component *ctf_fs = fs_stream->file->ctf_fs;

	if (!fs_stream->stream) {
		int64_t id = bt_ctf_stream_class_get_id(stream_class);

		PDBG("Creating stream out of stream class %" PRId64 "\n", id);
		fs_stream->stream = bt_ctf_stream_create(stream_class,
				fs_stream->file->path->str);
		if (!fs_stream->stream) {
			PERR("Cannot create stream (stream class %" PRId64 ")\n",
					id);
		}
	}

	return fs_stream->stream;
}

static struct bt_ctf_notif_iter_medium_ops medops = {
	.request_bytes = medop_request_bytes,
	.get_stream = medop_get_stream,
};

static
int build_index_from_idx_file(struct ctf_fs_stream *stream)
{
	int ret = 0;
	gchar *directory = NULL;
	gchar *basename = NULL;
	GString *index_basename = NULL;
	gchar *index_file_path = NULL;
	GMappedFile *mapped_file = NULL;
	gsize filesize;
	const struct ctf_packet_index_file_hdr *header;
	const char *mmap_begin, *file_pos;
	struct index_entry *index;
	uint64_t total_packets_size = 0;
	size_t file_index_entry_size;
	size_t file_entry_count;
	size_t i;

	/* Look for index file in relative path index/name.idx. */
	basename = g_path_get_basename(stream->file->path->str);
	if (!basename) {
		ret = -1;
		goto end;
	}

	directory = g_path_get_dirname(stream->file->path->str);
	if (!directory) {
		ret = -1;
		goto end;
	}

	index_basename = g_string_new(basename);
	if (!index_basename) {
		ret = -1;
		goto end;
	}

	g_string_append(index_basename, ".idx");
	index_file_path = g_build_filename(directory, "index",
			index_basename->str, NULL);
	mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
	if (!mapped_file) {
		ret = -1;
		goto end;
	}
	filesize = g_mapped_file_get_length(mapped_file);
	if (filesize < sizeof(*header)) {
		printf_error("Invalid LTTng trace index: file size < header size");
		ret = -1;
		goto end;
	}

	mmap_begin = g_mapped_file_get_contents(mapped_file);
	header = (struct ctf_packet_index_file_hdr *) mmap_begin;

	file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
	if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
		printf_error("Invalid LTTng trace index: \"magic\" validation failed");
		ret = -1;
		goto end;
	}

	file_index_entry_size = be32toh(header->packet_index_len);
	file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
	if ((filesize - sizeof(*header)) % (file_entry_count * file_index_entry_size)) {
		printf_error("Invalid index file size; not a multiple of index entry size");
		ret = -1;
		goto end;
	}

	stream->index.entries = g_array_sized_new(FALSE, TRUE,
			sizeof(struct index_entry), file_entry_count);
	if (!stream->index.entries) {
		ret = -1;
		goto end;
	}
	index = (struct index_entry *) stream->index.entries->data;
	for (i = 0; i < file_entry_count; i++) {
		struct ctf_packet_index *file_index =
				(struct ctf_packet_index *) file_pos;
		uint64_t packet_size = be64toh(file_index->packet_size);

		if (packet_size % CHAR_BIT) {
			ret = -1;
			printf_error("Invalid packet size encountered in index file");
			goto invalid_index;
		}

		/* Convert size in bits to bytes. */
		packet_size /= CHAR_BIT;
		index->packet_size = packet_size;

		index->offset = be64toh(file_index->offset);
		if (i != 0 && index->offset < (index - 1)->offset) {
			printf_error("Invalid, non-monotonic, packet offset encountered in index file");
			ret = -1;
			goto invalid_index;
		}

		index->timestamp_begin = be64toh(file_index->timestamp_begin);
		index->timestamp_end = be64toh(file_index->timestamp_end);
		if (index->timestamp_end < index->timestamp_begin) {
			printf_error("Invalid packet time bounds encountered in index file");
			ret = -1;
			goto invalid_index;
		}

		total_packets_size += packet_size;
		file_pos += file_index_entry_size;
		index++;
	}

	/* Validate that the index addresses the complete stream. */
	if (stream->file->size != total_packets_size) {
		printf_error("Invalid index; indexed size != stream file size");
		ret = -1;
		goto invalid_index;
	}
end:
	g_free(directory);
	g_free(basename);
	g_free(index_file_path);
	if (index_basename) {
		g_string_free(index_basename, TRUE);
	}
	if (mapped_file) {
		g_mapped_file_unref(mapped_file);
	}
	return ret;
invalid_index:
	g_array_free(stream->index.entries, TRUE);
	goto end;
}

static
int build_index_from_stream(struct ctf_fs_stream *stream)
{
	return 0;
}

static
int init_stream_index(struct ctf_fs_stream *stream)
{
	int ret;

	ret = build_index_from_idx_file(stream);
	if (!ret) {
		goto end;
	}

	ret = build_index_from_stream(stream);
end:
	return ret;
}

BT_HIDDEN
struct ctf_fs_stream *ctf_fs_stream_create(
		struct ctf_fs_component *ctf_fs, const char *path)
{
	int ret;
	struct ctf_fs_stream *stream = g_new0(struct ctf_fs_stream, 1);

	if (!stream) {
		goto error;
	}

	stream->file = ctf_fs_file_create(ctf_fs);
	if (!stream->file) {
		goto error;
	}

	g_string_assign(stream->file->path, path);
	ret = ctf_fs_file_open(ctf_fs, stream->file, "rb");
	if (ret) {
		goto error;
	}

	stream->notif_iter = bt_ctf_notif_iter_create(ctf_fs->metadata->trace,
			ctf_fs->cc_prio_map, ctf_fs->page_size, medops, stream,
			ctf_fs->error_fp);
	if (!stream->notif_iter) {
		goto error;
	}

	stream->mmap_max_len = ctf_fs->page_size * 2048;
	ret = init_stream_index(stream);
	if (ret) {
		goto error;
	}
	goto end;
error:
	/* Do not touch "borrowed" file. */
	ctf_fs_stream_destroy(stream);
	stream = NULL;
end:
	return stream;
}

BT_HIDDEN
void ctf_fs_stream_destroy(struct ctf_fs_stream *stream)
{
	if (!stream) {
		return;
	}

	if (stream->file) {
		ctf_fs_file_destroy(stream->file);
	}

	if (stream->stream) {
		BT_PUT(stream->stream);
	}

	if (stream->notif_iter) {
		bt_ctf_notif_iter_destroy(stream->notif_iter);
	}

	if (stream->index.entries) {
		g_array_free(stream->index.entries, TRUE);
	}

	g_free(stream);
}

BT_HIDDEN
struct bt_notification_iterator_next_return ctf_fs_stream_next(
		struct ctf_fs_stream *stream)
{
	enum bt_ctf_notif_iter_status notif_iter_status;
	struct bt_notification_iterator_next_return ret = {
		.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
		.notification = NULL,
	};

	if (stream->end_reached) {
		notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_EOF;
		goto translate_status;
	}

	notif_iter_status = bt_ctf_notif_iter_get_next_notification(stream->notif_iter,
			&ret.notification);
	if (notif_iter_status != BT_CTF_NOTIF_ITER_STATUS_OK &&
			notif_iter_status != BT_CTF_NOTIF_ITER_STATUS_EOF) {
		goto translate_status;
	}

	/* Should be handled in bt_ctf_notif_iter_get_next_notification. */
	if (notif_iter_status == BT_CTF_NOTIF_ITER_STATUS_EOF) {
		ret.notification = bt_notification_stream_end_create(
			stream->stream);
		if (!ret.notification) {
			notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
			goto translate_status;
		}

		notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_OK;
		stream->end_reached = true;
	}

translate_status:
	switch (notif_iter_status) {
	case BT_CTF_NOTIF_ITER_STATUS_EOF:
		ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
		break;
	case BT_CTF_NOTIF_ITER_STATUS_OK:
		ret.status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
		break;
	case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
		/*
		 * Should not make it this far as this is
		 * medium-specific; there is nothing for the user to do
		 * and it should have been handled upstream.
		 */
		assert(false);
	case BT_CTF_NOTIF_ITER_STATUS_INVAL:
	case BT_CTF_NOTIF_ITER_STATUS_ERROR:
	default:
		ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
		break;
	}

	return ret;
}
Commit	Line	Data
e98a2d6e PP	1	/*
e98a2d6e PP	2	* Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
fc9a526c	3	* Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
e98a2d6e PP	4	* Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
e98a2d6e PP	5	*
e98a2d6e PP	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	19	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	22	* SOFTWARE.
	23	*/
	24
	25	#include <stdio.h>
	26	#include <stdint.h>
	27	#include <stdlib.h>
	28	#include <stdbool.h>
	29	#include <glib.h>
	30	#include <inttypes.h>
	31	#include <sys/mman.h>
	32	#include <babeltrace/ctf-ir/stream.h>
b2e0c907	33	#include <babeltrace/graph/notification-iterator.h>
4f1f88a6 PP	34	#include <babeltrace/graph/notification-stream.h>
	35	#include <babeltrace/graph/notification-event.h>
	36	#include <babeltrace/graph/notification-packet.h>
78586d8a JG	37	#include "file.h"
	38	#include "metadata.h"
	39	#include "../common/notif-iter/notif-iter.h"
	40	#include <assert.h>
5b29e799	41	#include "data-stream.h"
e98a2d6e PP	42
	43	#define PRINT_ERR_STREAM ctf_fs->error_fp
	44	#define PRINT_PREFIX "ctf-fs-data-stream"
	45	#include "print.h"
	46
4f1f88a6	47	static inline
5b29e799	48	size_t remaining_mmap_bytes(struct ctf_fs_stream *stream)
e98a2d6e	49	{
fc9a526c	50	return stream->mmap_valid_len - stream->request_offset;
e98a2d6e PP	51	}
e98a2d6e PP	52
5b29e799 JG	53	static
5b29e799 JG	54	int stream_munmap(struct ctf_fs_stream *stream)
e98a2d6e	55	{
fc9a526c	56	int ret = 0;
56a1cced	57	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e PP	58
	59	if (munmap(stream->mmap_addr, stream->mmap_len)) {
	60	PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
	61	stream->mmap_addr, stream->mmap_len,
	62	stream->file->path->str, stream->file->fp,
	63	strerror(errno));
fc9a526c JG	64	ret = -1;
fc9a526c JG	65	goto end;
e98a2d6e	66	}
fc9a526c JG	67	end:
fc9a526c JG	68	return ret;
e98a2d6e PP	69	}
e98a2d6e PP	70
5b29e799	71	static
e0f6a64a	72	enum bt_ctf_notif_iter_medium_status mmap_next(struct ctf_fs_stream *stream)
e98a2d6e	73	{
e0f6a64a JG	74	enum bt_ctf_notif_iter_medium_status ret =
e0f6a64a JG	75	BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
fc9a526c	76	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e PP	77
	78	/* Unmap old region */
	79	if (stream->mmap_addr) {
	80	if (stream_munmap(stream)) {
	81	goto error;
	82	}
	83
fc9a526c JG	84	stream->mmap_offset += stream->mmap_valid_len;
fc9a526c JG	85	stream->request_offset = 0;
e98a2d6e PP	86	}
e98a2d6e PP	87
fc9a526c JG	88	stream->mmap_valid_len = MIN(stream->file->size - stream->mmap_offset,
fc9a526c JG	89	stream->mmap_max_len);
e0f6a64a JG	90	if (stream->mmap_valid_len == 0) {
	91	ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
	92	goto end;
	93	}
fc9a526c JG	94	/* Round up to next page, assuming page size being a power of 2. */
	95	stream->mmap_len = (stream->mmap_valid_len + ctf_fs->page_size - 1)
	96	& ~(ctf_fs->page_size - 1);
e98a2d6e	97	/* Map new region */
e0f6a64a	98	assert(stream->mmap_len);
e98a2d6e	99	stream->mmap_addr = mmap((void *) 0, stream->mmap_len,
78586d8a JG	100	PROT_READ, MAP_PRIVATE, fileno(stream->file->fp),
78586d8a JG	101	stream->mmap_offset);
e98a2d6e PP	102	if (stream->mmap_addr == MAP_FAILED) {
e98a2d6e PP	103	PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
78586d8a JG	104	stream->mmap_len, stream->file->path->str,
	105	stream->file->fp, stream->mmap_offset,
	106	strerror(errno));
e98a2d6e PP	107	goto error;
	108	}
	109
	110	goto end;
e98a2d6e PP	111	error:
e98a2d6e PP	112	stream_munmap(stream);
e0f6a64a	113	ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
e98a2d6e PP	114	end:
	115	return ret;
	116	}
	117
5b29e799 JG	118	static
5b29e799 JG	119	enum bt_ctf_notif_iter_medium_status medop_request_bytes(
e98a2d6e PP	120	size_t request_sz, uint8_t **buffer_addr,
	121	size_t buffer_sz, void data)
	122	{
	123	enum bt_ctf_notif_iter_medium_status status =
	124	BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
	125	struct ctf_fs_stream *stream = data;
56a1cced	126	struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e PP	127
	128	if (request_sz == 0) {
	129	goto end;
	130	}
	131
e98a2d6e PP	132	/* Check if we have at least one memory-mapped byte left */
	133	if (remaining_mmap_bytes(stream) == 0) {
	134	/* Are we at the end of the file? */
e0f6a64a	135	if (stream->mmap_offset >= stream->file->size) {
e98a2d6e PP	136	PDBG("Reached end of file \"%s\" (%p)\n",
	137	stream->file->path->str, stream->file->fp);
	138	status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
	139	goto end;
	140	}
	141
e0f6a64a JG	142	status = mmap_next(stream);
	143	switch (status) {
	144	case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK:
	145	break;
	146	case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF:
	147	goto end;
	148	default:
e98a2d6e	149	PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
e0f6a64a JG	150	stream->file->path->str,
e0f6a64a JG	151	stream->file->fp);
e98a2d6e PP	152	goto error;
	153	}
	154	}
	155
	156	*buffer_sz = MIN(remaining_mmap_bytes(stream), request_sz);
fc9a526c	157	buffer_addr = ((uint8_t ) stream->mmap_addr) + stream->request_offset;
e98a2d6e PP	158	stream->request_offset += *buffer_sz;
	159	goto end;
	160
	161	error:
	162	status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
	163
	164	end:
	165	return status;
	166	}
	167
5b29e799 JG	168	static
5b29e799 JG	169	struct bt_ctf_stream *medop_get_stream(
e98a2d6e PP	170	struct bt_ctf_stream_class stream_class, void data)
	171	{
	172	struct ctf_fs_stream *fs_stream = data;
56a1cced	173	struct ctf_fs_component *ctf_fs = fs_stream->file->ctf_fs;
e98a2d6e PP	174
	175	if (!fs_stream->stream) {
	176	int64_t id = bt_ctf_stream_class_get_id(stream_class);
	177
	178	PDBG("Creating stream out of stream class %" PRId64 "\n", id);
	179	fs_stream->stream = bt_ctf_stream_create(stream_class,
fc9a526c	180	fs_stream->file->path->str);
e98a2d6e PP	181	if (!fs_stream->stream) {
e98a2d6e PP	182	PERR("Cannot create stream (stream class %" PRId64 ")\n",
fc9a526c	183	id);
e98a2d6e PP	184	}
	185	}
	186
	187	return fs_stream->stream;
	188	}
	189
	190	static struct bt_ctf_notif_iter_medium_ops medops = {
	191	.request_bytes = medop_request_bytes,
	192	.get_stream = medop_get_stream,
	193	};
	194
b6c3dcb2 JG	195	static
	196	int build_index_from_idx_file(struct ctf_fs_stream *stream)
	197	{
	198	int ret = 0;
	199	gchar *directory = NULL;
	200	gchar *basename = NULL;
	201	GString *index_basename = NULL;
	202	gchar *index_file_path = NULL;
	203	GMappedFile *mapped_file = NULL;
	204	gsize filesize;
	205	const struct ctf_packet_index_file_hdr *header;
	206	const char mmap_begin, file_pos;
	207	struct index_entry *index;
	208	uint64_t total_packets_size = 0;
	209	size_t file_index_entry_size;
	210	size_t file_entry_count;
	211	size_t i;
	212
	213	/* Look for index file in relative path index/name.idx. */
	214	basename = g_path_get_basename(stream->file->path->str);
	215	if (!basename) {
	216	ret = -1;
	217	goto end;
	218	}
	219
	220	directory = g_path_get_dirname(stream->file->path->str);
	221	if (!directory) {
	222	ret = -1;
	223	goto end;
	224	}
	225
	226	index_basename = g_string_new(basename);
	227	if (!index_basename) {
	228	ret = -1;
	229	goto end;
	230	}
	231
	232	g_string_append(index_basename, ".idx");
	233	index_file_path = g_build_filename(directory, "index",
	234	index_basename->str, NULL);
	235	mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
06367fa3 JG	236	if (!mapped_file) {
	237	ret = -1;
	238	goto end;
	239	}
b6c3dcb2 JG	240	filesize = g_mapped_file_get_length(mapped_file);
	241	if (filesize < sizeof(*header)) {
	242	printf_error("Invalid LTTng trace index: file size < header size");
	243	ret = -1;
	244	goto end;
	245	}
	246
	247	mmap_begin = g_mapped_file_get_contents(mapped_file);
	248	header = (struct ctf_packet_index_file_hdr *) mmap_begin;
	249
	250	file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
	251	if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
	252	printf_error("Invalid LTTng trace index: \"magic\" validation failed");
	253	ret = -1;
	254	goto end;
	255	}
b6c3dcb2 JG	256
	257	file_index_entry_size = be32toh(header->packet_index_len);
	258	file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
	259	if ((filesize - sizeof(header)) % (file_entry_count file_index_entry_size)) {
	260	printf_error("Invalid index file size; not a multiple of index entry size");
	261	ret = -1;
	262	goto end;
	263	}
	264
	265	stream->index.entries = g_array_sized_new(FALSE, TRUE,
	266	sizeof(struct index_entry), file_entry_count);
	267	if (!stream->index.entries) {
	268	ret = -1;
	269	goto end;
	270	}
	271	index = (struct index_entry *) stream->index.entries->data;
	272	for (i = 0; i < file_entry_count; i++) {
	273	struct ctf_packet_index *file_index =
	274	(struct ctf_packet_index *) file_pos;
	275	uint64_t packet_size = be64toh(file_index->packet_size);
	276
	277	if (packet_size % CHAR_BIT) {
	278	ret = -1;
	279	printf_error("Invalid packet size encountered in index file");
	280	goto invalid_index;
	281	}
	282
	283	/* Convert size in bits to bytes. */
	284	packet_size /= CHAR_BIT;
	285	index->packet_size = packet_size;
	286
	287	index->offset = be64toh(file_index->offset);
	288	if (i != 0 && index->offset < (index - 1)->offset) {
	289	printf_error("Invalid, non-monotonic, packet offset encountered in index file");
	290	ret = -1;
	291	goto invalid_index;
	292	}
	293
	294	index->timestamp_begin = be64toh(file_index->timestamp_begin);
	295	index->timestamp_end = be64toh(file_index->timestamp_end);
	296	if (index->timestamp_end < index->timestamp_begin) {
	297	printf_error("Invalid packet time bounds encountered in index file");
	298	ret = -1;
	299	goto invalid_index;
	300	}
	301
	302	total_packets_size += packet_size;
	303	file_pos += file_index_entry_size;
	304	index++;
	305	}
	306
	307	/* Validate that the index addresses the complete stream. */
	308	if (stream->file->size != total_packets_size) {
	309	printf_error("Invalid index; indexed size != stream file size");
	310	ret = -1;
	311	goto invalid_index;
	312	}
	313	end:
	314	g_free(directory);
	315	g_free(basename);
	316	g_free(index_file_path);
06367fa3 JG	317	if (index_basename) {
	318	g_string_free(index_basename, TRUE);
	319	}
	320	if (mapped_file) {
	321	g_mapped_file_unref(mapped_file);
	322	}
b6c3dcb2 JG	323	return ret;
	324	invalid_index:
	325	g_array_free(stream->index.entries, TRUE);
	326	goto end;
	327	}
	328
	329	static
	330	int build_index_from_stream(struct ctf_fs_stream *stream)
	331	{
4f1f88a6	332	return 0;
b6c3dcb2 JG	333	}
	334
	335	static
	336	int init_stream_index(struct ctf_fs_stream *stream)
	337	{
	338	int ret;
	339
	340	ret = build_index_from_idx_file(stream);
	341	if (!ret) {
	342	goto end;
	343	}
	344
	345	ret = build_index_from_stream(stream);
	346	end:
	347	return ret;
	348	}
	349
e7a4393b JG	350	BT_HIDDEN
e7a4393b JG	351	struct ctf_fs_stream *ctf_fs_stream_create(
4f1f88a6	352	struct ctf_fs_component ctf_fs, const char path)
e98a2d6e	353	{
b6c3dcb2	354	int ret;
e98a2d6e PP	355	struct ctf_fs_stream *stream = g_new0(struct ctf_fs_stream, 1);
	356
	357	if (!stream) {
	358	goto error;
	359	}
	360
4f1f88a6 PP	361	stream->file = ctf_fs_file_create(ctf_fs);
	362	if (!stream->file) {
	363	goto error;
	364	}
	365
	366	g_string_assign(stream->file->path, path);
	367	ret = ctf_fs_file_open(ctf_fs, stream->file, "rb");
	368	if (ret) {
	369	goto error;
	370	}
	371
5b29e799	372	stream->notif_iter = bt_ctf_notif_iter_create(ctf_fs->metadata->trace,
599faa1c PP	373	ctf_fs->cc_prio_map, ctf_fs->page_size, medops, stream,
599faa1c PP	374	ctf_fs->error_fp);
e98a2d6e PP	375	if (!stream->notif_iter) {
	376	goto error;
	377	}
5b29e799	378
fc9a526c	379	stream->mmap_max_len = ctf_fs->page_size * 2048;
b6c3dcb2 JG	380	ret = init_stream_index(stream);
	381	if (ret) {
	382	goto error;
	383	}
e98a2d6e	384	goto end;
e98a2d6e	385	error:
78586d8a	386	/* Do not touch "borrowed" file. */
e98a2d6e PP	387	ctf_fs_stream_destroy(stream);
e98a2d6e PP	388	stream = NULL;
e98a2d6e PP	389	end:
	390	return stream;
	391	}
	392
5b29e799 JG	393	BT_HIDDEN
5b29e799 JG	394	void ctf_fs_stream_destroy(struct ctf_fs_stream *stream)
e98a2d6e	395	{
5b29e799 JG	396	if (!stream) {
5b29e799 JG	397	return;
043e2020 JG	398	}
043e2020 JG	399
5b29e799 JG	400	if (stream->file) {
5b29e799 JG	401	ctf_fs_file_destroy(stream->file);
e98a2d6e PP	402	}
e98a2d6e PP	403
5b29e799 JG	404	if (stream->stream) {
5b29e799 JG	405	BT_PUT(stream->stream);
043e2020	406	}
5b29e799 JG	407
	408	if (stream->notif_iter) {
	409	bt_ctf_notif_iter_destroy(stream->notif_iter);
78586d8a	410	}
5b29e799	411
b6c3dcb2 JG	412	if (stream->index.entries) {
	413	g_array_free(stream->index.entries, TRUE);
	414	}
	415
5b29e799	416	g_free(stream);
e98a2d6e	417	}
4f1f88a6 PP	418
	419	BT_HIDDEN
	420	struct bt_notification_iterator_next_return ctf_fs_stream_next(
	421	struct ctf_fs_stream *stream)
	422	{
	423	enum bt_ctf_notif_iter_status notif_iter_status;
	424	struct bt_notification_iterator_next_return ret = {
	425	.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
	426	.notification = NULL,
	427	};
	428
	429	if (stream->end_reached) {
	430	notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_EOF;
	431	goto translate_status;
	432	}
	433
	434	notif_iter_status = bt_ctf_notif_iter_get_next_notification(stream->notif_iter,
	435	&ret.notification);
	436	if (notif_iter_status != BT_CTF_NOTIF_ITER_STATUS_OK &&
	437	notif_iter_status != BT_CTF_NOTIF_ITER_STATUS_EOF) {
	438	goto translate_status;
	439	}
	440
	441	/* Should be handled in bt_ctf_notif_iter_get_next_notification. */
	442	if (notif_iter_status == BT_CTF_NOTIF_ITER_STATUS_EOF) {
	443	ret.notification = bt_notification_stream_end_create(
	444	stream->stream);
	445	if (!ret.notification) {
	446	notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
	447	goto translate_status;
	448	}
	449
	450	notif_iter_status = BT_CTF_NOTIF_ITER_STATUS_OK;
	451	stream->end_reached = true;
	452	}
	453
	454	translate_status:
	455	switch (notif_iter_status) {
	456	case BT_CTF_NOTIF_ITER_STATUS_EOF:
	457	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
	458	break;
	459	case BT_CTF_NOTIF_ITER_STATUS_OK:
	460	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
	461	break;
	462	case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
	463	/*
	464	* Should not make it this far as this is
	465	* medium-specific; there is nothing for the user to do
	466	* and it should have been handled upstream.
	467	*/
	468	assert(false);
	469	case BT_CTF_NOTIF_ITER_STATUS_INVAL:
	470	case BT_CTF_NOTIF_ITER_STATUS_ERROR:
	471	default:
	472	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
	473	break;
	474	}
	475
	476	return ret;
	477	}