[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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/babeltrace.h>

#include "../common/notif-iter/notif-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_index_entry {
	/* Position, in bytes, of the packet from the beginning of the file. */
	uint64_t offset;

	/* Size of the packet, in bytes. */
	uint64_t packet_size;

	/*
	 * Extracted from the packet context, relative to the respective fields'
	 * mapped clock classes (in cycles).
	 */
	uint64_t timestamp_begin, timestamp_end;

	/*
	 * Converted from the packet context, relative to the trace's EPOCH
	 * (in ns since EPOCH).
	 */
	int64_t timestamp_begin_ns, timestamp_end_ns;
};

struct ctf_fs_ds_index {
	/* Array of struct ctf_fs_fd_index_entry. */
	GArray *entries;
};

struct ctf_fs_ds_file_info {
	/*
	 * Owned by this. May be NULL.
	 *
	 * A stream cannot be assumed to be indexed as the indexing might have
	 * been skipped. Moreover, the index's fields may not all be available
	 * depending on the producer (e.g. timestamp_begin/end are not
	 * mandatory).
	 *
	 * FIXME In such cases (missing fields), the indexing is aborted as
	 * no the index entries don't have a concept of fields being present
	 * or not.
	 */
	struct ctf_fs_ds_index *index;

	/* Owned by this. */
	GString *path;

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

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

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

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

	/* Weak */
	struct bt_notif_iter *notif_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,
		struct bt_notif_iter *notif_iter,
		struct bt_stream *stream, const char *path);

BT_HIDDEN
int ctf_fs_ds_file_borrow_packet_header_context_fields(
		struct ctf_fs_ds_file *ds_file,
		struct bt_field **packet_header_field,
		struct bt_field **packet_context_field);

BT_HIDDEN
void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);

BT_HIDDEN
struct bt_notification_iterator_next_method_return ctf_fs_ds_file_next(
		struct ctf_fs_ds_file *stream);

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

BT_HIDDEN
void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);

extern struct bt_notif_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 PP	28	#include <glib.h>
e98a2d6e PP	29	#include <babeltrace/babeltrace-internal.h>
9d408fca	30	#include <babeltrace/babeltrace.h>
e98a2d6e	31
413bc2c4	32	#include "../common/notif-iter/notif-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 JG	40	struct ctf_fs_ds_index_entry {
	41	/* Position, in bytes, of the packet from the beginning of the file. */
	42	uint64_t offset;
	43
	44	/* Size of the packet, in bytes. */
	45	uint64_t packet_size;
	46
	47	/*
	48	* Extracted from the packet context, relative to the respective fields'
	49	* mapped clock classes (in cycles).
	50	*/
b6c3dcb2	51	uint64_t timestamp_begin, timestamp_end;
97ade20b JG	52
	53	/*
	54	* Converted from the packet context, relative to the trace's EPOCH
	55	* (in ns since EPOCH).
	56	*/
	57	int64_t timestamp_begin_ns, timestamp_end_ns;
b6c3dcb2 JG	58	};
b6c3dcb2 JG	59
97ade20b JG	60	struct ctf_fs_ds_index {
	61	/* Array of struct ctf_fs_fd_index_entry. */
	62	GArray *entries;
	63	};
	64
	65	struct ctf_fs_ds_file_info {
	66	/*
	67	* Owned by this. May be NULL.
	68	*
	69	* A stream cannot be assumed to be indexed as the indexing might have
	70	* been skipped. Moreover, the index's fields may not all be available
	71	* depending on the producer (e.g. timestamp_begin/end are not
	72	* mandatory).
	73	*
	74	* FIXME In such cases (missing fields), the indexing is aborted as
	75	* no the index entries don't have a concept of fields being present
	76	* or not.
	77	*/
	78	struct ctf_fs_ds_index *index;
	79
	80	/* Owned by this. */
	81	GString *path;
	82
	83	/* Guaranteed to be set, as opposed to the index. */
	84	uint64_t begin_ns;
	85	};
	86
	87	struct ctf_fs_ds_file {
	88	/* Owned by this */
	89	struct ctf_fs_file *file;
	90
	91	/* Owned by this */
50842bdc	92	struct bt_stream *stream;
97ade20b JG	93
	94	/* Owned by this */
	95	struct bt_clock_class_priority_map *cc_prio_map;
	96
6de92955	97	/* Weak */
50842bdc	98	struct bt_notif_iter *notif_iter;
97ade20b JG	99
	100	void *mmap_addr;
	101
2f5a009b JG	102	/*
	103	* Max length of chunk to mmap() when updating the current mapping.
	104	* This value must be page-aligned.
	105	*/
97ade20b JG	106	size_t mmap_max_len;
97ade20b JG	107
2c701ca6	108	/* Length of the current mapping. Never exceeds the file's length. */
97ade20b JG	109	size_t mmap_len;
97ade20b JG	110
97ade20b JG	111	/* Offset in the file where the current mapping starts. */
	112	off_t mmap_offset;
	113
	114	/*
	115	* Offset, in the current mapping, of the address to return on the next
	116	* request.
	117	*/
	118	off_t request_offset;
	119
	120	bool end_reached;
b6c3dcb2	121	};
e98a2d6e PP	122
e98a2d6e PP	123	BT_HIDDEN
94cf822e PP	124	struct ctf_fs_ds_file *ctf_fs_ds_file_create(
94cf822e PP	125	struct ctf_fs_trace *ctf_fs_trace,
50842bdc PP	126	struct bt_notif_iter *notif_iter,
50842bdc PP	127	struct bt_stream stream, const char path);
e98a2d6e PP	128
e98a2d6e PP	129	BT_HIDDEN
312c056a	130	int ctf_fs_ds_file_borrow_packet_header_context_fields(
97ade20b	131	struct ctf_fs_ds_file *ds_file,
50842bdc PP	132	struct bt_field **packet_header_field,
50842bdc PP	133	struct bt_field **packet_context_field);
e98a2d6e PP	134
e98a2d6e PP	135	BT_HIDDEN
94cf822e	136	void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
e98a2d6e	137
4f1f88a6	138	BT_HIDDEN
90157d89	139	struct bt_notification_iterator_next_method_return ctf_fs_ds_file_next(
94cf822e	140	struct ctf_fs_ds_file *stream);
4f1f88a6	141
97ade20b JG	142	BT_HIDDEN
	143	struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
	144	struct ctf_fs_ds_file *ds_file);
	145
	146	BT_HIDDEN
	147	void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
	148
50842bdc	149	extern struct bt_notif_iter_medium_ops ctf_fs_ds_file_medops;
6de92955	150
94cf822e	151	#endif /* CTF_FS_DS_FILE_H */