[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/component/component.h>
#include "data-stream.h"

#define CTF_FS_COMPONENT_NAME "fs"
#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 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;
	/* 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_iterator {
	struct bt_notification_heap *pending_notifications;
	struct bt_notification *current_notification;
	/*
	 * struct ctf_fs_data_stream* which have not yet been associated to a
	 * bt_ctf_stream. The association is performed on the first packet
	 * read by the stream (since, at that point, we have read a packet
	 * header).
	 */
	GPtrArray *pending_streams;
	/* bt_ctf_stream -> ctf_fs_stream */
	GHashTable *stream_ht;
};

struct ctf_fs_component_options {
	bool opt_dummy : 1;
};

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

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

#endif /* BABELTRACE_PLUGIN_CTF_FS_H */
Commit	Line	Data
541b0a11 JG	1	#ifndef BABELTRACE_PLUGIN_CTF_FS_H
541b0a11 JG	2	#define BABELTRACE_PLUGIN_CTF_FS_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	31	#include <babeltrace/babeltrace-internal.h>
33b34c43	32	#include <babeltrace/component/component.h>
b6c3dcb2	33	#include "data-stream.h"
490db841	34
56a1cced	35	#define CTF_FS_COMPONENT_NAME "fs"
ea0b4b9e	36	#define CTF_FS_COMPONENT_DESCRIPTION \
6a29d9fd	37	"Component used to read a CTF trace located on a file system."
490db841	38
78bb6992 MD	39	BT_HIDDEN
78bb6992 MD	40	extern bool ctf_fs_debug;
56a1cced	41
78586d8a JG	42	struct bt_notification_heap;
78586d8a JG	43
56a1cced JG	44	struct ctf_fs_file {
	45	struct ctf_fs_component *ctf_fs;
	46	GString *path;
	47	FILE *fp;
	48	off_t size;
	49	};
	50
	51	struct ctf_fs_metadata {
	52	struct bt_ctf_trace *trace;
	53	uint8_t uuid[16];
	54	bool is_uuid_set;
	55	int bo;
	56	char *text;
	57	};
	58
	59	struct ctf_fs_stream {
	60	struct ctf_fs_file *file;
	61	struct bt_ctf_stream *stream;
78586d8a	62	/* FIXME There should be many and ctf_fs_stream should not own them. */
56a1cced	63	struct bt_ctf_notif_iter *notif_iter;
b6c3dcb2 JG	64	/* A stream is assumed to be indexed. */
b6c3dcb2 JG	65	struct index index;
56a1cced	66	void *mmap_addr;
fc9a526c JG	67	/* Max length of chunk to mmap() when updating the current mapping. */
	68	size_t mmap_max_len;
	69	/* Length of the current mapping. */
56a1cced	70	size_t mmap_len;
fc9a526c JG	71	/* Length of the current mapping which exists in the backing file. */
	72	size_t mmap_valid_len;
	73	/* Offset in the file where the current mapping starts. */
56a1cced	74	off_t mmap_offset;
fc9a526c JG	75	/*
	76	* Offset, in the current mapping, of the address to return on the next
	77	* request.
	78	*/
56a1cced	79	off_t request_offset;
043e2020	80	bool end_reached;
56a1cced JG	81	};
56a1cced JG	82
760051fa	83	struct ctf_fs_iterator {
78586d8a	84	struct bt_notification_heap *pending_notifications;
5b29e799 JG	85	struct bt_notification *current_notification;
	86	/*
	87	* struct ctf_fs_data_stream* which have not yet been associated to a
	88	* bt_ctf_stream. The association is performed on the first packet
	89	* read by the stream (since, at that point, we have read a packet
	90	* header).
	91	*/
	92	GPtrArray *pending_streams;
	93	/* bt_ctf_stream -> ctf_fs_stream */
	94	GHashTable *stream_ht;
760051fa JG	95	};
760051fa JG	96
ea0b4b9e JG	97	struct ctf_fs_component_options {
	98	bool opt_dummy : 1;
	99	};
	100
	101	struct ctf_fs_component {
56a1cced JG	102	GString *trace_path;
	103	FILE *error_fp;
	104	size_t page_size;
ea0b4b9e	105	struct ctf_fs_component_options options;
5b29e799	106	struct ctf_fs_metadata *metadata;
ea0b4b9e JG	107	};
ea0b4b9e JG	108
f3bc2010	109	BT_HIDDEN
ea0b4b9e	110	enum bt_component_status ctf_fs_init(struct bt_component *source,
f3bc2010	111	struct bt_value *params);
490db841	112
541b0a11	113	#endif /* BABELTRACE_PLUGIN_CTF_FS_H */