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

#ifndef BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H
#define BABELTRACE_PLUGIN_CTF_FS_INTERNAL_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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/plugin/component.h>

#define CTF_FS_COMPONENT_NAME "fs"
#define CTF_FS_COMPONENT_DESCRIPTION \
	"Component used to read a CTF trace located on a file system."

static bool ctf_fs_debug;

struct bt_notification_heap;

struct ctf_fs_file {
	struct ctf_fs_component *ctf_fs;
	GString *path;
	FILE *fp;
	off_t size;
};

struct ctf_fs_metadata {
	struct bt_ctf_trace *trace;
	uint8_t uuid[16];
	bool is_uuid_set;
	int bo;
	char *text;
};

struct ctf_fs_stream {
	struct ctf_fs_file *file;
	struct bt_ctf_stream *stream;
	/* FIXME There should be many and ctf_fs_stream should not own them. */
	struct bt_ctf_notif_iter *notif_iter;
	void *mmap_addr;
	size_t mmap_len;
	off_t mmap_offset;
	off_t request_offset;
	bool end_reached;
};

struct ctf_fs_data_stream {
	GPtrArray *streams;
};

struct ctf_fs_iterator {
	struct bt_notification_heap *pending_notifications;
};

struct ctf_fs_component_options {
	bool opt_dummy : 1;
};

struct ctf_fs_component {
	GString *trace_path;
	FILE *error_fp;
	size_t page_size;
	struct bt_notification *current_notification;
	struct ctf_fs_metadata metadata;
	struct ctf_fs_data_stream data_stream;
	struct ctf_fs_component_options options;
};

BT_HIDDEN
enum bt_component_status ctf_fs_init(struct bt_component *source,
		struct bt_value *params);

#endif /* BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H */
Commit	Line	Data
6a29d9fd PP	1	#ifndef BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H
6a29d9fd PP	2	#define BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H
490db841 JG	3
490db841 JG	4	/*
6a29d9fd	5	* BabelTrace - CTF on File System Component
490db841	6	*
f3bc2010	7	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
56a1cced	8	* Copyright 2016 Philippe Proulx <pproulx@efficios.com>
490db841 JG	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
f3bc2010 JG	31	#include <babeltrace/babeltrace-internal.h>
f3bc2010 JG	32	#include <babeltrace/plugin/component.h>
490db841	33
56a1cced	34	#define CTF_FS_COMPONENT_NAME "fs"
ea0b4b9e	35	#define CTF_FS_COMPONENT_DESCRIPTION \
6a29d9fd	36	"Component used to read a CTF trace located on a file system."
490db841	37
56a1cced JG	38	static bool ctf_fs_debug;
56a1cced JG	39
78586d8a JG	40	struct bt_notification_heap;
78586d8a JG	41
56a1cced JG	42	struct ctf_fs_file {
	43	struct ctf_fs_component *ctf_fs;
	44	GString *path;
	45	FILE *fp;
	46	off_t size;
	47	};
	48
	49	struct ctf_fs_metadata {
	50	struct bt_ctf_trace *trace;
	51	uint8_t uuid[16];
	52	bool is_uuid_set;
	53	int bo;
	54	char *text;
	55	};
	56
	57	struct ctf_fs_stream {
	58	struct ctf_fs_file *file;
	59	struct bt_ctf_stream *stream;
78586d8a	60	/* FIXME There should be many and ctf_fs_stream should not own them. */
56a1cced JG	61	struct bt_ctf_notif_iter *notif_iter;
	62	void *mmap_addr;
	63	size_t mmap_len;
	64	off_t mmap_offset;
	65	off_t request_offset;
043e2020	66	bool end_reached;
56a1cced JG	67	};
	68
	69	struct ctf_fs_data_stream {
	70	GPtrArray *streams;
	71	};
	72
760051fa	73	struct ctf_fs_iterator {
78586d8a	74	struct bt_notification_heap *pending_notifications;
760051fa JG	75	};
760051fa JG	76
ea0b4b9e JG	77	struct ctf_fs_component_options {
	78	bool opt_dummy : 1;
	79	};
	80
	81	struct ctf_fs_component {
56a1cced JG	82	GString *trace_path;
	83	FILE *error_fp;
	84	size_t page_size;
d01e0f33	85	struct bt_notification *current_notification;
56a1cced JG	86	struct ctf_fs_metadata metadata;
56a1cced JG	87	struct ctf_fs_data_stream data_stream;
ea0b4b9e JG	88	struct ctf_fs_component_options options;
	89	};
	90
f3bc2010	91	BT_HIDDEN
ea0b4b9e	92	enum bt_component_status ctf_fs_init(struct bt_component *source,
f3bc2010	93	struct bt_value *params);
490db841	94
6a29d9fd	95	#endif /* BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H */