[babeltrace.git] / plugins / ctf / fs / 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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include "data-stream.h"

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

BT_HIDDEN
extern bool ctf_fs_debug;

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;
	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 {
};

struct ctf_fs_port_data {
	GString *path;
};

struct ctf_fs_component {
	struct bt_private_component *priv_comp;
	GString *trace_path;
	FILE *error_fp;
	size_t page_size;
	struct ctf_fs_component_options options;
	struct ctf_fs_metadata *metadata;

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

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);

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);

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

#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 <babeltrace/babeltrace-internal.h>
	32	#include <babeltrace/graph/component.h>
	33	#include "data-stream.h"
	34
	35	#define CTF_FS_COMPONENT_DESCRIPTION \
	36	"Component used to read a CTF trace located on a file system."
	37
	38	BT_HIDDEN
	39	extern bool ctf_fs_debug;
	40
	41	struct ctf_fs_file {
	42	struct ctf_fs_component *ctf_fs;
	43	GString *path;
	44	FILE *fp;
	45	off_t size;
	46	};
	47
	48	struct ctf_fs_metadata {
	49	struct bt_ctf_trace *trace;
	50	uint8_t uuid[16];
	51	bool is_uuid_set;
	52	int bo;
	53	char *text;
	54	};
	55
	56	struct ctf_fs_stream {
	57	struct ctf_fs_file *file;
	58	struct bt_ctf_stream *stream;
	59	struct bt_ctf_notif_iter *notif_iter;
	60	/* A stream is assumed to be indexed. */
	61	struct index index;
	62	void *mmap_addr;
	63	/* Max length of chunk to mmap() when updating the current mapping. */
	64	size_t mmap_max_len;
	65	/* Length of the current mapping. */
	66	size_t mmap_len;
	67	/* Length of the current mapping which exists in the backing file. */
	68	size_t mmap_valid_len;
	69	/* Offset in the file where the current mapping starts. */
	70	off_t mmap_offset;
	71	/*
	72	* Offset, in the current mapping, of the address to return on the next
	73	* request.
	74	*/
	75	off_t request_offset;
	76	bool end_reached;
	77	};
	78
	79	struct ctf_fs_component_options {
	80	};
	81
	82	struct ctf_fs_port_data {
	83	GString *path;
	84	};
	85
	86	struct ctf_fs_component {
	87	struct bt_private_component *priv_comp;
	88	GString *trace_path;
	89	FILE *error_fp;
	90	size_t page_size;
	91	struct ctf_fs_component_options options;
	92	struct ctf_fs_metadata *metadata;
	93
	94	/* Array of struct ctf_fs_port_data , owned by this /
	95	GPtrArray *port_data;
	96	};
	97
	98	BT_HIDDEN
	99	enum bt_component_status ctf_fs_init(struct bt_private_component *source,
	100	struct bt_value params, void init_method_data);
	101
	102	BT_HIDDEN
	103	void ctf_fs_finalize(struct bt_private_component *component);
	104
	105	BT_HIDDEN
	106	enum bt_notification_iterator_status ctf_fs_iterator_init(
	107	struct bt_private_notification_iterator *it,
	108	struct bt_private_port *port);
	109
	110	void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
	111
	112	struct bt_notification_iterator_next_return ctf_fs_iterator_next(
	113	struct bt_private_notification_iterator *iterator);
	114
	115	BT_HIDDEN
	116	struct bt_value ctf_fs_query(struct bt_component_class comp_class,
	117	const char object, struct bt_value params);
	118
	119	#endif /* BABELTRACE_PLUGIN_CTF_FS_H */