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

#ifndef BABELTRACE_PLUGIN_CTF_FS_H
#define BABELTRACE_PLUGIN_CTF_FS_H

/*
 * BabelTrace - CTF on File System Component
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2016 Philippe Proulx <pproulx@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 <stdbool.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/clock-class-priority-map.h>
#include "data-stream-file.h"

BT_HIDDEN
extern bool ctf_fs_debug;

struct ctf_fs_file {
	/* Owned by this */
	GString *path;

	/* Owned by this */
	FILE *fp;

	off_t size;
};

struct ctf_fs_metadata {
	/* Owned by this */
	struct bt_ctf_trace *trace;

	/* Owned by this */
	char *text;

	uint8_t uuid[16];
	bool is_uuid_set;
	int bo;
};

struct ctf_fs_ds_file_info {
	GString *path;
	uint64_t begin_ns;
};

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

	/* Owned by this */
	struct bt_ctf_stream *stream;

	/* Owned by this */
	struct bt_clock_class_priority_map *cc_prio_map;

	/* Owned by this */
	struct bt_ctf_notif_iter *notif_iter;

	/* A stream is assumed to be indexed. */
	struct index index;
	void *mmap_addr;
	/* Max length of chunk to mmap() when updating the current mapping. */
	size_t mmap_max_len;
	/* Length of the current mapping. */
	size_t mmap_len;
	/* Length of the current mapping which *exists* in the backing file. */
	size_t mmap_valid_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;
};

struct ctf_fs_component_options {
	int64_t clock_offset;
	int64_t clock_offset_ns;
};

struct ctf_fs_component {
	/* Weak, guaranteed to exist */
	struct bt_private_component *priv_comp;

	/* Array of struct ctf_fs_port_data *, owned by this */
	GPtrArray *port_data;

	/* Array of struct ctf_fs_trace *, owned by this */
	GPtrArray *traces;

	struct ctf_fs_component_options options;
};

struct ctf_fs_trace {
	/* Owned by this */
	struct ctf_fs_metadata *metadata;

	/* Owned by this */
	struct bt_clock_class_priority_map *cc_prio_map;

	/* Array of struct ctf_fs_ds_file_group *, owned by this */
	GPtrArray *ds_file_groups;

	/* Owned by this */
	GString *path;

	/* Owned by this */
	GString *name;
};

struct ctf_fs_ds_file_group {
	/*
	 * Array of struct ctf_fs_ds_file_info, owned by this.
	 *
	 * This is an _ordered_ array of data stream file infos which
	 * belong to this group (a single stream instance).
	 *
	 * You can call ctf_fs_ds_file_create() with one of those paths
	 * and the CTF IR stream below.
	 */
	GPtrArray *ds_file_infos;

	/* Owned by this */
	struct bt_ctf_stream *stream;

	/* Weak, belongs to component */
	struct ctf_fs_trace *ctf_fs_trace;
};

struct ctf_fs_port_data {
	/* Weak, belongs to ctf_fs_trace */
	struct ctf_fs_ds_file_group *ds_file_group;
};

struct ctf_fs_notif_iter_data {
	/* Weak, belongs to ctf_fs_trace */
	struct ctf_fs_ds_file_group *ds_file_group;

	/* Owned by this */
	struct ctf_fs_ds_file *ds_file;

	/* Which file the iterator is _currently_ operating on */
	size_t ds_file_info_index;
};

BT_HIDDEN
enum bt_component_status ctf_fs_init(struct bt_private_component *source,
		struct bt_value *params, void *init_method_data);

BT_HIDDEN
void ctf_fs_finalize(struct bt_private_component *component);

BT_HIDDEN
enum bt_notification_iterator_status ctf_fs_iterator_init(
		struct bt_private_notification_iterator *it,
		struct bt_private_port *port);

BT_HIDDEN
struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
		const char *object, struct bt_value *params);

BT_HIDDEN
int ctf_fs_find_traces(GList **trace_paths, const char *start_path);

BT_HIDDEN
GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path);

void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);

struct bt_notification_iterator_next_return ctf_fs_iterator_next(
		struct bt_private_notification_iterator *iterator);

#endif /* BABELTRACE_PLUGIN_CTF_FS_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_PLUGIN_CTF_FS_H
	2	#define BABELTRACE_PLUGIN_CTF_FS_H
	3
	4	/*
	5	* BabelTrace - CTF on File System Component
	6	*
	7	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	* Copyright 2016 Philippe Proulx <pproulx@efficios.com>
	9	*
	10	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	11	*
	12	* Permission is hereby granted, free of charge, to any person obtaining a copy
	13	* of this software and associated documentation files (the "Software"), to deal
	14	* in the Software without restriction, including without limitation the rights
	15	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	16	* copies of the Software, and to permit persons to whom the Software is
	17	* furnished to do so, subject to the following conditions:
	18	*
	19	* The above copyright notice and this permission notice shall be included in
	20	* all copies or substantial portions of the Software.
	21	*
	22	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	23	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	25	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	26	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	27	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	28	* SOFTWARE.
	29	*/
	30
	31	#include <stdbool.h>
	32	#include <babeltrace/babeltrace-internal.h>
	33	#include <babeltrace/graph/component.h>
	34	#include <babeltrace/graph/clock-class-priority-map.h>
	35	#include "data-stream-file.h"
	36
	37	BT_HIDDEN
	38	extern bool ctf_fs_debug;
	39
	40	struct ctf_fs_file {
	41	/* Owned by this */
	42	GString *path;
	43
	44	/* Owned by this */
	45	FILE *fp;
	46
	47	off_t size;
	48	};
	49
	50	struct ctf_fs_metadata {
	51	/* Owned by this */
	52	struct bt_ctf_trace *trace;
	53
	54	/* Owned by this */
	55	char *text;
	56
	57	uint8_t uuid[16];
	58	bool is_uuid_set;
	59	int bo;
	60	};
	61
	62	struct ctf_fs_ds_file_info {
	63	GString *path;
	64	uint64_t begin_ns;
	65	};
	66
	67	struct ctf_fs_ds_file {
	68	/* Owned by this */
	69	struct ctf_fs_file *file;
	70
	71	/* Owned by this */
	72	struct bt_ctf_stream *stream;
	73
	74	/* Owned by this */
	75	struct bt_clock_class_priority_map *cc_prio_map;
	76
	77	/* Owned by this */
	78	struct bt_ctf_notif_iter *notif_iter;
	79
	80	/* A stream is assumed to be indexed. */
	81	struct index index;
	82	void *mmap_addr;
	83	/* Max length of chunk to mmap() when updating the current mapping. */
	84	size_t mmap_max_len;
	85	/* Length of the current mapping. */
	86	size_t mmap_len;
	87	/* Length of the current mapping which exists in the backing file. */
	88	size_t mmap_valid_len;
	89	/* Offset in the file where the current mapping starts. */
	90	off_t mmap_offset;
	91	/*
	92	* Offset, in the current mapping, of the address to return on the next
	93	* request.
	94	*/
	95	off_t request_offset;
	96	bool end_reached;
	97	};
	98
	99	struct ctf_fs_component_options {
	100	int64_t clock_offset;
	101	int64_t clock_offset_ns;
	102	};
	103
	104	struct ctf_fs_component {
	105	/* Weak, guaranteed to exist */
	106	struct bt_private_component *priv_comp;
	107
	108	/* Array of struct ctf_fs_port_data , owned by this /
	109	GPtrArray *port_data;
	110
	111	/* Array of struct ctf_fs_trace , owned by this /
	112	GPtrArray *traces;
	113
	114	struct ctf_fs_component_options options;
	115	};
	116
	117	struct ctf_fs_trace {
	118	/* Owned by this */
	119	struct ctf_fs_metadata *metadata;
	120
	121	/* Owned by this */
	122	struct bt_clock_class_priority_map *cc_prio_map;
	123
	124	/* Array of struct ctf_fs_ds_file_group , owned by this /
	125	GPtrArray *ds_file_groups;
	126
	127	/* Owned by this */
	128	GString *path;
	129
	130	/* Owned by this */
	131	GString *name;
	132	};
	133
	134	struct ctf_fs_ds_file_group {
	135	/*
	136	* Array of struct ctf_fs_ds_file_info, owned by this.
	137	*
	138	* This is an _ordered_ array of data stream file infos which
	139	* belong to this group (a single stream instance).
	140	*
	141	* You can call ctf_fs_ds_file_create() with one of those paths
	142	* and the CTF IR stream below.
	143	*/
	144	GPtrArray *ds_file_infos;
	145
	146	/* Owned by this */
	147	struct bt_ctf_stream *stream;
	148
	149	/* Weak, belongs to component */
	150	struct ctf_fs_trace *ctf_fs_trace;
	151	};
	152
	153	struct ctf_fs_port_data {
	154	/* Weak, belongs to ctf_fs_trace */
	155	struct ctf_fs_ds_file_group *ds_file_group;
	156	};
	157
	158	struct ctf_fs_notif_iter_data {
	159	/* Weak, belongs to ctf_fs_trace */
	160	struct ctf_fs_ds_file_group *ds_file_group;
	161
	162	/* Owned by this */
	163	struct ctf_fs_ds_file *ds_file;
	164
	165	/* Which file the iterator is _currently_ operating on */
	166	size_t ds_file_info_index;
	167	};
	168
	169	BT_HIDDEN
	170	enum bt_component_status ctf_fs_init(struct bt_private_component *source,
	171	struct bt_value params, void init_method_data);
	172
	173	BT_HIDDEN
	174	void ctf_fs_finalize(struct bt_private_component *component);
	175
	176	BT_HIDDEN
	177	enum bt_notification_iterator_status ctf_fs_iterator_init(
	178	struct bt_private_notification_iterator *it,
	179	struct bt_private_port *port);
	180
	181	BT_HIDDEN
	182	struct bt_value ctf_fs_query(struct bt_component_class comp_class,
	183	const char object, struct bt_value params);
	184
	185	BT_HIDDEN
	186	int ctf_fs_find_traces(GList *trace_paths, const char start_path);
	187
	188	BT_HIDDEN
	189	GList ctf_fs_create_trace_names(GList trace_paths, const char *base_path);
	190
	191	void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
	192
	193	struct bt_notification_iterator_next_return ctf_fs_iterator_next(
	194	struct bt_private_notification_iterator *iterator);
	195
	196	#endif /* BABELTRACE_PLUGIN_CTF_FS_H */