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

#ifndef CTF_FS_DS_FILE_H
#define CTF_FS_DS_FILE_H

/*
 * Copyright 2016 - Philippe Proulx <pproulx@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 <stdio.h>
#include <stdbool.h>
#include <glib.h>
#include <babeltrace2/babeltrace-internal.h>
#include <babeltrace2/babeltrace.h>

#include "../common/msg-iter/msg-iter.h"
#include "lttng-index.h"

struct ctf_fs_component;
struct ctf_fs_file;
struct ctf_fs_trace;
struct ctf_fs_ds_file;

struct ctf_fs_ds_file_info {
	/* Owned by this. */
	GString *path;

	/* Guaranteed to be set, as opposed to the index. */
	int64_t begin_ns;
};

struct ctf_fs_metadata;

struct ctf_fs_ds_file {
	/* Weak */
	struct ctf_fs_metadata *metadata;

	/* Weak */
	bt_self_message_iterator *pc_msg_iter;

	/* Owned by this */
	struct ctf_fs_file *file;

	/* Owned by this */
	bt_stream *stream;

	/* Weak */
	struct bt_msg_iter *msg_iter;

	void *mmap_addr;

	/*
	 * Max length of chunk to mmap() when updating the current mapping.
	 * This value must be page-aligned.
	 */
	size_t mmap_max_len;

	/* Length of the current mapping. Never exceeds the file's length. */
	size_t mmap_len;

	/* Offset in the file where the current mapping starts. */
	off_t mmap_offset;

	/*
	 * Offset, in the current mapping, of the address to return on the next
	 * request.
	 */
	off_t request_offset;

	bool end_reached;
};

BT_HIDDEN
struct ctf_fs_ds_file *ctf_fs_ds_file_create(
		struct ctf_fs_trace *ctf_fs_trace,
		bt_self_message_iterator *pc_msg_iter,
		struct bt_msg_iter *msg_iter,
		bt_stream *stream, const char *path);

BT_HIDDEN
void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);

BT_HIDDEN
bt_self_message_iterator_status ctf_fs_ds_file_next(
		struct ctf_fs_ds_file *ds_file,
		bt_message **msg);

BT_HIDDEN
struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
		struct ctf_fs_ds_file *ds_file);

BT_HIDDEN
struct ctf_fs_ds_index *ctf_fs_ds_index_create();

BT_HIDDEN
void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);

extern struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops;

#endif /* CTF_FS_DS_FILE_H */
Commit	Line	Data
94cf822e PP	1	#ifndef CTF_FS_DS_FILE_H
94cf822e PP	2	#define CTF_FS_DS_FILE_H
e98a2d6e PP	3
	4	/*
	5	* Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
	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>
94cf822e	27	#include <stdbool.h>
e98a2d6e	28	#include <glib.h>
3fadfbc0 MJ	29	#include <babeltrace2/babeltrace-internal.h>
3fadfbc0 MJ	30	#include <babeltrace2/babeltrace.h>
e98a2d6e	31
d6e69534	32	#include "../common/msg-iter/msg-iter.h"
b6c3dcb2 JG	33	#include "lttng-index.h"
	34
	35	struct ctf_fs_component;
	36	struct ctf_fs_file;
1a9f7075	37	struct ctf_fs_trace;
94cf822e	38	struct ctf_fs_ds_file;
b6c3dcb2	39
97ade20b	40	struct ctf_fs_ds_file_info {
97ade20b JG	41	/* Owned by this. */
	42	GString *path;
	43
	44	/* Guaranteed to be set, as opposed to the index. */
44c440bc	45	int64_t begin_ns;
97ade20b JG	46	};
97ade20b JG	47
44c440bc PP	48	struct ctf_fs_metadata;
44c440bc PP	49
97ade20b	50	struct ctf_fs_ds_file {
44c440bc PP	51	/* Weak */
	52	struct ctf_fs_metadata *metadata;
	53
5c563278	54	/* Weak */
d6e69534	55	bt_self_message_iterator *pc_msg_iter;
5c563278	56
97ade20b JG	57	/* Owned by this */
	58	struct ctf_fs_file *file;
	59
	60	/* Owned by this */
b19ff26f	61	bt_stream *stream;
97ade20b	62
6de92955	63	/* Weak */
d6e69534	64	struct bt_msg_iter *msg_iter;
97ade20b JG	65
	66	void *mmap_addr;
	67
2f5a009b JG	68	/*
	69	* Max length of chunk to mmap() when updating the current mapping.
	70	* This value must be page-aligned.
	71	*/
97ade20b JG	72	size_t mmap_max_len;
97ade20b JG	73
2c701ca6	74	/* Length of the current mapping. Never exceeds the file's length. */
97ade20b JG	75	size_t mmap_len;
97ade20b JG	76
97ade20b JG	77	/* Offset in the file where the current mapping starts. */
	78	off_t mmap_offset;
	79
	80	/*
	81	* Offset, in the current mapping, of the address to return on the next
	82	* request.
	83	*/
	84	off_t request_offset;
	85
	86	bool end_reached;
b6c3dcb2	87	};
e98a2d6e PP	88
e98a2d6e PP	89	BT_HIDDEN
94cf822e PP	90	struct ctf_fs_ds_file *ctf_fs_ds_file_create(
94cf822e PP	91	struct ctf_fs_trace *ctf_fs_trace,
d6e69534 PP	92	bt_self_message_iterator *pc_msg_iter,
d6e69534 PP	93	struct bt_msg_iter *msg_iter,
b19ff26f	94	bt_stream stream, const char path);
e98a2d6e	95
e98a2d6e	96	BT_HIDDEN
94cf822e	97	void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
e98a2d6e	98
4f1f88a6	99	BT_HIDDEN
13d42859	100	bt_self_message_iterator_status ctf_fs_ds_file_next(
d4393e08	101	struct ctf_fs_ds_file *ds_file,
d6e69534	102	bt_message **msg);
4f1f88a6	103
97ade20b JG	104	BT_HIDDEN
	105	struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
	106	struct ctf_fs_ds_file *ds_file);
	107
7ed5243a FD	108	BT_HIDDEN
	109	struct ctf_fs_ds_index *ctf_fs_ds_index_create();
	110
97ade20b JG	111	BT_HIDDEN
	112	void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
	113
d6e69534	114	extern struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops;
6de92955	115
94cf822e	116	#endif /* CTF_FS_DS_FILE_H */