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

/*
 * Copyright 2016-2017 - 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 <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <glib.h>
#include <inttypes.h>
#include <babeltrace/compat/mman-internal.h>
#include <babeltrace/endian-internal.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 <babeltrace/common-internal.h>
#include "file.h"
#include "metadata.h"
#include "../common/notif-iter/notif-iter.h"
#include <assert.h>
#include "data-stream-file.h"
#include <string.h>

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

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

static
int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
{
	int ret = 0;

	if (!ds_file || !ds_file->mmap_addr) {
		goto end;
	}

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

	ds_file->mmap_addr = NULL;

end:
	return ret;
}

static
enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
		struct ctf_fs_ds_file *ds_file)
{
	const size_t page_size = bt_common_get_page_size();
	enum bt_ctf_notif_iter_medium_status ret =
			BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;

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

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

	ds_file->mmap_valid_len = MIN(ds_file->file->size - ds_file->mmap_offset,
			ds_file->mmap_max_len);
	if (ds_file->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. */
	ds_file->mmap_len = (ds_file->mmap_valid_len + page_size - 1)
			& ~(page_size - 1);
	/* Map new region */
	assert(ds_file->mmap_len);
	ds_file->mmap_addr = mmap((void *) 0, ds_file->mmap_len,
			PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
			ds_file->mmap_offset);
	if (ds_file->mmap_addr == MAP_FAILED) {
		BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s",
				ds_file->mmap_len, ds_file->file->path->str,
				ds_file->file->fp, ds_file->mmap_offset,
				strerror(errno));
		goto error;
	}

	goto end;
error:
	ds_file_munmap(ds_file);
	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_ds_file *ds_file = data;

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

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

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

	*buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
	*buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset;
	ds_file->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_ds_file *ds_file = data;
	struct bt_ctf_stream_class *ds_file_stream_class;
	struct bt_ctf_stream *stream = NULL;

	ds_file_stream_class = bt_ctf_stream_get_class(ds_file->stream);
	bt_put(ds_file_stream_class);

	if (stream_class != ds_file_stream_class) {
		/*
		 * Not supported: two packets described by two different
		 * stream classes within the same data stream file.
		 */
		goto end;
	}

	stream = ds_file->stream;

end:
	return 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_ds_file *ds_file)
{
	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(ds_file->file->path->str);
	if (!basename) {
		BT_LOGE("Failed to get the  basename of datastream file %s",
				ds_file->file->path->str);
		ret = -1;
		goto end;
	}

	directory = g_path_get_dirname(ds_file->file->path->str);
	if (!directory) {
		BT_LOGE("Failed to get dirname of datastream file %s",
				ds_file->file->path->str);
		ret = -1;
		goto end;
	}

	index_basename = g_string_new(basename);
	if (!index_basename) {
		BT_LOGE("Failed to allocate index file basename string");
		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) {
		BT_LOGD("Failed to create new mapped file %s",
				index_file_path);
		ret = -1;
		goto end;
	}
	filesize = g_mapped_file_get_length(mapped_file);
	if (filesize < sizeof(*header)) {
		BT_LOGW("Invalid LTTng trace index file: 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) {
		BT_LOGW("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)) {
		BT_LOGW("Invalid index file size; not a multiple of index entry size");
		ret = -1;
		goto end;
	}

	ds_file->index.entries = g_array_sized_new(FALSE, TRUE,
			sizeof(struct index_entry), file_entry_count);
	if (!ds_file->index.entries) {
		ret = -1;
		goto end;
	}
	index = (struct index_entry *) ds_file->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;
			BT_LOGW("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) {
			BT_LOGW("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) {
			BT_LOGW("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 (ds_file->file->size != total_packets_size) {
		BT_LOGW("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(ds_file->index.entries, TRUE);
	goto end;
}

static
int build_index_from_data_stream_file(struct ctf_fs_ds_file *stream)
{
	return 0;
}

static
int init_stream_index(struct ctf_fs_ds_file *ds_file)
{
	int ret;

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

	ret = build_index_from_data_stream_file(ds_file);
end:
	return ret;
}

BT_HIDDEN
struct ctf_fs_ds_file *ctf_fs_ds_file_create(
		struct ctf_fs_trace *ctf_fs_trace,
		struct bt_ctf_stream *stream, const char *path,
		bool build_index)
{
	int ret;
	const size_t page_size = bt_common_get_page_size();
	struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);

	if (!ds_file) {
		goto error;
	}

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

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

	ds_file->notif_iter = bt_ctf_notif_iter_create(
		ctf_fs_trace->metadata->trace, page_size, medops, ds_file);
	if (!ds_file->notif_iter) {
		goto error;
	}

	ds_file->mmap_max_len = page_size * 2048;

	if (build_index) {
		ret = init_stream_index(ds_file);
		if (ret) {
			goto error;
		}
	}

	goto end;

error:
	/* Do not touch "borrowed" file. */
	ctf_fs_ds_file_destroy(ds_file);
	ds_file = NULL;

end:
	return ds_file;
}

BT_HIDDEN
void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
{
	if (!ds_file) {
		return;
	}

	bt_put(ds_file->cc_prio_map);
	bt_put(ds_file->stream);
	(void) ds_file_munmap(ds_file);

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

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

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

	g_free(ds_file);
}

BT_HIDDEN
struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
		struct ctf_fs_ds_file *ds_file)
{
	enum bt_ctf_notif_iter_status notif_iter_status;
	struct bt_notification_iterator_next_return ret = {
		.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
		.notification = NULL,
	};

	notif_iter_status = bt_ctf_notif_iter_get_next_notification(
		ds_file->notif_iter, ds_file->cc_prio_map, &ret.notification);

	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.
		 */
		abort();
	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;
}

BT_HIDDEN
int ctf_fs_ds_file_get_packet_header_context_fields(
		struct ctf_fs_trace *ctf_fs_trace, const char *path,
		struct bt_ctf_field **packet_header_field,
		struct bt_ctf_field **packet_context_field)
{
	enum bt_ctf_notif_iter_status notif_iter_status;
	struct ctf_fs_ds_file *ds_file;
	int ret = 0;

	ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, path, false);
	if (!ds_file) {
		goto error;
	}

	notif_iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
		ds_file->notif_iter, packet_header_field, packet_context_field);
	switch (notif_iter_status) {
	case BT_CTF_NOTIF_ITER_STATUS_EOF:
	case BT_CTF_NOTIF_ITER_STATUS_OK:
		break;
	case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
		abort();
	case BT_CTF_NOTIF_ITER_STATUS_INVAL:
	case BT_CTF_NOTIF_ITER_STATUS_ERROR:
	default:
		goto error;
		break;
	}

	goto end;

error:
	ret = -1;

	if (packet_header_field) {
		bt_put(*packet_header_field);
	}

	if (packet_context_field) {
		bt_put(*packet_context_field);
	}

end:
	ctf_fs_ds_file_destroy(ds_file);
	return ret;
}
Commit	Line	Data
e98a2d6e	1	/*
94cf822e	2	* Copyright 2016-2017 - 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
0fbb9a9f	25	#include <stdlib.h>
e98a2d6e PP	26	#include <stdio.h>
	27	#include <stdint.h>
	28	#include <stdlib.h>
	29	#include <stdbool.h>
	30	#include <glib.h>
	31	#include <inttypes.h>
8f76831a	32	#include <babeltrace/compat/mman-internal.h>
e9383dfd	33	#include <babeltrace/endian-internal.h>
e98a2d6e	34	#include <babeltrace/ctf-ir/stream.h>
b2e0c907	35	#include <babeltrace/graph/notification-iterator.h>
4f1f88a6 PP	36	#include <babeltrace/graph/notification-stream.h>
	37	#include <babeltrace/graph/notification-event.h>
	38	#include <babeltrace/graph/notification-packet.h>
55314f2a	39	#include <babeltrace/common-internal.h>
78586d8a JG	40	#include "file.h"
	41	#include "metadata.h"
	42	#include "../common/notif-iter/notif-iter.h"
	43	#include <assert.h>
94cf822e	44	#include "data-stream-file.h"
e9383dfd	45	#include <string.h>
e98a2d6e	46
55314f2a JG	47	#define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-DS"
55314f2a JG	48	#include "logging.h"
e98a2d6e	49
4f1f88a6	50	static inline
94cf822e	51	size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
e98a2d6e	52	{
94cf822e	53	return ds_file->mmap_valid_len - ds_file->request_offset;
e98a2d6e PP	54	}
e98a2d6e PP	55
5b29e799	56	static
94cf822e	57	int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
e98a2d6e	58	{
fc9a526c	59	int ret = 0;
e98a2d6e	60
d238196d	61	if (!ds_file \|\| !ds_file->mmap_addr) {
94cf822e PP	62	goto end;
	63	}
	64
	65	if (munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
55314f2a	66	BT_LOGE("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s",
94cf822e PP	67	ds_file->mmap_addr, ds_file->mmap_len,
94cf822e PP	68	ds_file->file->path->str, ds_file->file->fp,
e98a2d6e	69	strerror(errno));
fc9a526c JG	70	ret = -1;
fc9a526c JG	71	goto end;
e98a2d6e	72	}
94cf822e PP	73
	74	ds_file->mmap_addr = NULL;
	75
fc9a526c JG	76	end:
fc9a526c JG	77	return ret;
e98a2d6e PP	78	}
e98a2d6e PP	79
5b29e799	80	static
94cf822e PP	81	enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
94cf822e PP	82	struct ctf_fs_ds_file *ds_file)
e98a2d6e	83	{
55314f2a	84	const size_t page_size = bt_common_get_page_size();
e0f6a64a JG	85	enum bt_ctf_notif_iter_medium_status ret =
e0f6a64a JG	86	BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
e98a2d6e PP	87
e98a2d6e PP	88	/* Unmap old region */
94cf822e PP	89	if (ds_file->mmap_addr) {
94cf822e PP	90	if (ds_file_munmap(ds_file)) {
e98a2d6e PP	91	goto error;
	92	}
	93
94cf822e PP	94	ds_file->mmap_offset += ds_file->mmap_valid_len;
94cf822e PP	95	ds_file->request_offset = 0;
e98a2d6e PP	96	}
e98a2d6e PP	97
94cf822e PP	98	ds_file->mmap_valid_len = MIN(ds_file->file->size - ds_file->mmap_offset,
	99	ds_file->mmap_max_len);
	100	if (ds_file->mmap_valid_len == 0) {
e0f6a64a JG	101	ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
	102	goto end;
	103	}
fc9a526c	104	/* Round up to next page, assuming page size being a power of 2. */
55314f2a JG	105	ds_file->mmap_len = (ds_file->mmap_valid_len + page_size - 1)
55314f2a JG	106	& ~(page_size - 1);
e98a2d6e	107	/* Map new region */
94cf822e PP	108	assert(ds_file->mmap_len);
	109	ds_file->mmap_addr = mmap((void *) 0, ds_file->mmap_len,
	110	PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
	111	ds_file->mmap_offset);
	112	if (ds_file->mmap_addr == MAP_FAILED) {
55314f2a	113	BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s",
94cf822e PP	114	ds_file->mmap_len, ds_file->file->path->str,
94cf822e PP	115	ds_file->file->fp, ds_file->mmap_offset,
78586d8a	116	strerror(errno));
e98a2d6e PP	117	goto error;
	118	}
	119
	120	goto end;
e98a2d6e	121	error:
94cf822e	122	ds_file_munmap(ds_file);
e0f6a64a	123	ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
e98a2d6e PP	124	end:
	125	return ret;
	126	}
	127
5b29e799 JG	128	static
5b29e799 JG	129	enum bt_ctf_notif_iter_medium_status medop_request_bytes(
e98a2d6e PP	130	size_t request_sz, uint8_t **buffer_addr,
	131	size_t buffer_sz, void data)
	132	{
	133	enum bt_ctf_notif_iter_medium_status status =
	134	BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
94cf822e	135	struct ctf_fs_ds_file *ds_file = data;
e98a2d6e PP	136
	137	if (request_sz == 0) {
	138	goto end;
	139	}
	140
e98a2d6e	141	/* Check if we have at least one memory-mapped byte left */
94cf822e	142	if (remaining_mmap_bytes(ds_file) == 0) {
e98a2d6e	143	/* Are we at the end of the file? */
94cf822e	144	if (ds_file->mmap_offset >= ds_file->file->size) {
55314f2a	145	BT_LOGD("Reached end of file \"%s\" (%p)",
94cf822e	146	ds_file->file->path->str, ds_file->file->fp);
e98a2d6e PP	147	status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
	148	goto end;
	149	}
	150
94cf822e	151	status = ds_file_mmap_next(ds_file);
e0f6a64a JG	152	switch (status) {
	153	case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK:
	154	break;
	155	case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF:
	156	goto end;
	157	default:
55314f2a	158	BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
94cf822e PP	159	ds_file->file->path->str,
94cf822e PP	160	ds_file->file->fp);
e98a2d6e PP	161	goto error;
	162	}
	163	}
	164
94cf822e PP	165	*buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
	166	buffer_addr = ((uint8_t ) ds_file->mmap_addr) + ds_file->request_offset;
	167	ds_file->request_offset += *buffer_sz;
e98a2d6e PP	168	goto end;
	169
	170	error:
	171	status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
	172
	173	end:
	174	return status;
	175	}
	176
5b29e799 JG	177	static
5b29e799 JG	178	struct bt_ctf_stream *medop_get_stream(
e98a2d6e PP	179	struct bt_ctf_stream_class stream_class, void data)
e98a2d6e PP	180	{
94cf822e PP	181	struct ctf_fs_ds_file *ds_file = data;
	182	struct bt_ctf_stream_class *ds_file_stream_class;
	183	struct bt_ctf_stream *stream = NULL;
	184
	185	ds_file_stream_class = bt_ctf_stream_get_class(ds_file->stream);
	186	bt_put(ds_file_stream_class);
	187
	188	if (stream_class != ds_file_stream_class) {
	189	/*
	190	* Not supported: two packets described by two different
	191	* stream classes within the same data stream file.
	192	*/
	193	goto end;
e98a2d6e PP	194	}
e98a2d6e PP	195
94cf822e PP	196	stream = ds_file->stream;
	197
	198	end:
	199	return stream;
e98a2d6e PP	200	}
	201
	202	static struct bt_ctf_notif_iter_medium_ops medops = {
	203	.request_bytes = medop_request_bytes,
	204	.get_stream = medop_get_stream,
	205	};
	206
b6c3dcb2	207	static
94cf822e	208	int build_index_from_idx_file(struct ctf_fs_ds_file *ds_file)
b6c3dcb2 JG	209	{
	210	int ret = 0;
	211	gchar *directory = NULL;
	212	gchar *basename = NULL;
	213	GString *index_basename = NULL;
	214	gchar *index_file_path = NULL;
	215	GMappedFile *mapped_file = NULL;
	216	gsize filesize;
	217	const struct ctf_packet_index_file_hdr *header;
	218	const char mmap_begin, file_pos;
	219	struct index_entry *index;
	220	uint64_t total_packets_size = 0;
	221	size_t file_index_entry_size;
	222	size_t file_entry_count;
	223	size_t i;
	224
	225	/* Look for index file in relative path index/name.idx. */
94cf822e	226	basename = g_path_get_basename(ds_file->file->path->str);
b6c3dcb2	227	if (!basename) {
55314f2a JG	228	BT_LOGE("Failed to get the basename of datastream file %s",
55314f2a JG	229	ds_file->file->path->str);
b6c3dcb2 JG	230	ret = -1;
	231	goto end;
	232	}
	233
94cf822e	234	directory = g_path_get_dirname(ds_file->file->path->str);
b6c3dcb2	235	if (!directory) {
55314f2a JG	236	BT_LOGE("Failed to get dirname of datastream file %s",
55314f2a JG	237	ds_file->file->path->str);
b6c3dcb2 JG	238	ret = -1;
	239	goto end;
	240	}
	241
	242	index_basename = g_string_new(basename);
	243	if (!index_basename) {
55314f2a	244	BT_LOGE("Failed to allocate index file basename string");
b6c3dcb2 JG	245	ret = -1;
	246	goto end;
	247	}
	248
	249	g_string_append(index_basename, ".idx");
	250	index_file_path = g_build_filename(directory, "index",
	251	index_basename->str, NULL);
	252	mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
06367fa3	253	if (!mapped_file) {
55314f2a JG	254	BT_LOGD("Failed to create new mapped file %s",
55314f2a JG	255	index_file_path);
06367fa3 JG	256	ret = -1;
	257	goto end;
	258	}
b6c3dcb2 JG	259	filesize = g_mapped_file_get_length(mapped_file);
b6c3dcb2 JG	260	if (filesize < sizeof(*header)) {
55314f2a	261	BT_LOGW("Invalid LTTng trace index file: file size < header size");
b6c3dcb2 JG	262	ret = -1;
	263	goto end;
	264	}
	265
	266	mmap_begin = g_mapped_file_get_contents(mapped_file);
	267	header = (struct ctf_packet_index_file_hdr *) mmap_begin;
	268
	269	file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
	270	if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
55314f2a	271	BT_LOGW("Invalid LTTng trace index: \"magic\" validation failed");
b6c3dcb2 JG	272	ret = -1;
	273	goto end;
	274	}
b6c3dcb2 JG	275
	276	file_index_entry_size = be32toh(header->packet_index_len);
	277	file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
	278	if ((filesize - sizeof(header)) % (file_entry_count file_index_entry_size)) {
55314f2a	279	BT_LOGW("Invalid index file size; not a multiple of index entry size");
b6c3dcb2 JG	280	ret = -1;
	281	goto end;
	282	}
	283
94cf822e	284	ds_file->index.entries = g_array_sized_new(FALSE, TRUE,
b6c3dcb2	285	sizeof(struct index_entry), file_entry_count);
94cf822e	286	if (!ds_file->index.entries) {
b6c3dcb2 JG	287	ret = -1;
	288	goto end;
	289	}
94cf822e	290	index = (struct index_entry *) ds_file->index.entries->data;
b6c3dcb2 JG	291	for (i = 0; i < file_entry_count; i++) {
	292	struct ctf_packet_index *file_index =
	293	(struct ctf_packet_index *) file_pos;
	294	uint64_t packet_size = be64toh(file_index->packet_size);
	295
	296	if (packet_size % CHAR_BIT) {
	297	ret = -1;
55314f2a	298	BT_LOGW("Invalid packet size encountered in index file");
b6c3dcb2 JG	299	goto invalid_index;
	300	}
	301
	302	/* Convert size in bits to bytes. */
	303	packet_size /= CHAR_BIT;
	304	index->packet_size = packet_size;
	305
	306	index->offset = be64toh(file_index->offset);
	307	if (i != 0 && index->offset < (index - 1)->offset) {
55314f2a	308	BT_LOGW("Invalid, non-monotonic, packet offset encountered in index file");
b6c3dcb2 JG	309	ret = -1;
	310	goto invalid_index;
	311	}
	312
	313	index->timestamp_begin = be64toh(file_index->timestamp_begin);
	314	index->timestamp_end = be64toh(file_index->timestamp_end);
	315	if (index->timestamp_end < index->timestamp_begin) {
55314f2a	316	BT_LOGW("Invalid packet time bounds encountered in index file");
b6c3dcb2 JG	317	ret = -1;
	318	goto invalid_index;
	319	}
	320
	321	total_packets_size += packet_size;
	322	file_pos += file_index_entry_size;
	323	index++;
	324	}
	325
	326	/* Validate that the index addresses the complete stream. */
94cf822e	327	if (ds_file->file->size != total_packets_size) {
55314f2a	328	BT_LOGW("Invalid index; indexed size != stream file size");
b6c3dcb2 JG	329	ret = -1;
	330	goto invalid_index;
	331	}
	332	end:
	333	g_free(directory);
	334	g_free(basename);
	335	g_free(index_file_path);
06367fa3 JG	336	if (index_basename) {
	337	g_string_free(index_basename, TRUE);
	338	}
	339	if (mapped_file) {
	340	g_mapped_file_unref(mapped_file);
	341	}
b6c3dcb2 JG	342	return ret;
b6c3dcb2 JG	343	invalid_index:
94cf822e	344	g_array_free(ds_file->index.entries, TRUE);
b6c3dcb2 JG	345	goto end;
	346	}
	347
	348	static
94cf822e	349	int build_index_from_data_stream_file(struct ctf_fs_ds_file *stream)
b6c3dcb2	350	{
4f1f88a6	351	return 0;
b6c3dcb2 JG	352	}
	353
	354	static
94cf822e	355	int init_stream_index(struct ctf_fs_ds_file *ds_file)
b6c3dcb2 JG	356	{
	357	int ret;
	358
94cf822e	359	ret = build_index_from_idx_file(ds_file);
b6c3dcb2 JG	360	if (!ret) {
	361	goto end;
	362	}
	363
94cf822e	364	ret = build_index_from_data_stream_file(ds_file);
b6c3dcb2 JG	365	end:
	366	return ret;
	367	}
	368
e7a4393b	369	BT_HIDDEN
94cf822e PP	370	struct ctf_fs_ds_file *ctf_fs_ds_file_create(
	371	struct ctf_fs_trace *ctf_fs_trace,
	372	struct bt_ctf_stream stream, const char path,
	373	bool build_index)
e98a2d6e	374	{
b6c3dcb2	375	int ret;
55314f2a	376	const size_t page_size = bt_common_get_page_size();
94cf822e	377	struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
e98a2d6e	378
94cf822e	379	if (!ds_file) {
e98a2d6e PP	380	goto error;
	381	}
	382
55314f2a	383	ds_file->file = ctf_fs_file_create();
94cf822e	384	if (!ds_file->file) {
4f1f88a6 PP	385	goto error;
	386	}
	387
94cf822e PP	388	ds_file->stream = bt_get(stream);
	389	ds_file->cc_prio_map = bt_get(ctf_fs_trace->cc_prio_map);
	390	g_string_assign(ds_file->file->path, path);
55314f2a	391	ret = ctf_fs_file_open(ds_file->file, "rb");
4f1f88a6 PP	392	if (ret) {
	393	goto error;
	394	}
	395
94cf822e	396	ds_file->notif_iter = bt_ctf_notif_iter_create(
55314f2a	397	ctf_fs_trace->metadata->trace, page_size, medops, ds_file);
94cf822e	398	if (!ds_file->notif_iter) {
e98a2d6e PP	399	goto error;
e98a2d6e PP	400	}
5b29e799	401
55314f2a	402	ds_file->mmap_max_len = page_size * 2048;
94cf822e PP	403
	404	if (build_index) {
	405	ret = init_stream_index(ds_file);
	406	if (ret) {
	407	goto error;
	408	}
b6c3dcb2	409	}
1a9f7075	410
e98a2d6e	411	goto end;
1a9f7075	412
e98a2d6e	413	error:
78586d8a	414	/* Do not touch "borrowed" file. */
94cf822e PP	415	ctf_fs_ds_file_destroy(ds_file);
94cf822e PP	416	ds_file = NULL;
1a9f7075	417
e98a2d6e	418	end:
94cf822e	419	return ds_file;
e98a2d6e PP	420	}
e98a2d6e PP	421
5b29e799	422	BT_HIDDEN
94cf822e	423	void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
e98a2d6e	424	{
94cf822e	425	if (!ds_file) {
5b29e799	426	return;
043e2020 JG	427	}
043e2020 JG	428
94cf822e PP	429	bt_put(ds_file->cc_prio_map);
	430	bt_put(ds_file->stream);
	431	(void) ds_file_munmap(ds_file);
0982a26d	432
94cf822e PP	433	if (ds_file->file) {
94cf822e PP	434	ctf_fs_file_destroy(ds_file->file);
e98a2d6e PP	435	}
e98a2d6e PP	436
94cf822e PP	437	if (ds_file->notif_iter) {
94cf822e PP	438	bt_ctf_notif_iter_destroy(ds_file->notif_iter);
043e2020	439	}
5b29e799	440
94cf822e PP	441	if (ds_file->index.entries) {
94cf822e PP	442	g_array_free(ds_file->index.entries, TRUE);
78586d8a	443	}
5b29e799	444
94cf822e	445	g_free(ds_file);
e98a2d6e	446	}
4f1f88a6 PP	447
4f1f88a6 PP	448	BT_HIDDEN
94cf822e PP	449	struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
94cf822e PP	450	struct ctf_fs_ds_file *ds_file)
4f1f88a6 PP	451	{
	452	enum bt_ctf_notif_iter_status notif_iter_status;
	453	struct bt_notification_iterator_next_return ret = {
	454	.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
	455	.notification = NULL,
	456	};
	457
8915b7a7	458	notif_iter_status = bt_ctf_notif_iter_get_next_notification(
94cf822e	459	ds_file->notif_iter, ds_file->cc_prio_map, &ret.notification);
4f1f88a6	460
4f1f88a6 PP	461	switch (notif_iter_status) {
	462	case BT_CTF_NOTIF_ITER_STATUS_EOF:
	463	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
	464	break;
	465	case BT_CTF_NOTIF_ITER_STATUS_OK:
	466	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
	467	break;
	468	case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
	469	/*
	470	* Should not make it this far as this is
	471	* medium-specific; there is nothing for the user to do
	472	* and it should have been handled upstream.
	473	*/
0fbb9a9f	474	abort();
4f1f88a6 PP	475	case BT_CTF_NOTIF_ITER_STATUS_INVAL:
	476	case BT_CTF_NOTIF_ITER_STATUS_ERROR:
	477	default:
	478	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
	479	break;
	480	}
	481
	482	return ret;
	483	}
94cf822e PP	484
	485	BT_HIDDEN
	486	int ctf_fs_ds_file_get_packet_header_context_fields(
	487	struct ctf_fs_trace ctf_fs_trace, const char path,
	488	struct bt_ctf_field **packet_header_field,
	489	struct bt_ctf_field **packet_context_field)
	490	{
	491	enum bt_ctf_notif_iter_status notif_iter_status;
	492	struct ctf_fs_ds_file *ds_file;
	493	int ret = 0;
	494
	495	ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, path, false);
	496	if (!ds_file) {
	497	goto error;
	498	}
	499
	500	notif_iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
	501	ds_file->notif_iter, packet_header_field, packet_context_field);
	502	switch (notif_iter_status) {
	503	case BT_CTF_NOTIF_ITER_STATUS_EOF:
	504	case BT_CTF_NOTIF_ITER_STATUS_OK:
	505	break;
	506	case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
0fbb9a9f	507	abort();
94cf822e PP	508	case BT_CTF_NOTIF_ITER_STATUS_INVAL:
	509	case BT_CTF_NOTIF_ITER_STATUS_ERROR:
	510	default:
	511	goto error;
	512	break;
	513	}
	514
	515	goto end;
	516
	517	error:
	518	ret = -1;
	519
	520	if (packet_header_field) {
	521	bt_put(*packet_header_field);
	522	}
	523
	524	if (packet_context_field) {
	525	bt_put(*packet_context_field);
	526	}
	527
	528	end:
	529	ctf_fs_ds_file_destroy(ds_file);
	530	return ret;
	531	}