[lttngtop.git] / lib / babeltrace / ctf / types.h

#ifndef _BABELTRACE_CTF_TYPES_H
#define _BABELTRACE_CTF_TYPES_H

/*
 * Common Trace Format
 *
 * Type header
 *
 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@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/types.h>
#include <babeltrace/babeltrace-internal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <stdint.h>
#include <unistd.h>
#include <glib.h>
#include <stdio.h>
#include <inttypes.h>
#include <babeltrace/mmap-align.h>

#define LAST_OFFSET_POISON	((int64_t) ~0ULL)

struct bt_stream_callbacks;

struct packet_index_time {
	uint64_t timestamp_begin;
	uint64_t timestamp_end;
};

struct packet_index {
	off_t offset;		/* offset of the packet in the file, in bytes */
	int64_t data_offset;	/* offset of data within the packet, in bits */
	uint64_t packet_size;	/* packet size, in bits */
	uint64_t content_size;	/* content size, in bits */
	uint64_t events_discarded;
	uint64_t events_discarded_len;	/* length of the field, in bits */
	struct packet_index_time ts_cycles;	/* timestamp in cycles */
	struct packet_index_time ts_real;	/* realtime timestamp */
};

/*
 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
 */
struct ctf_stream_pos {
	struct bt_stream_pos parent;
	int fd;			/* backing file fd. -1 if unset. */
	FILE *index_fp;		/* backing index file fp. NULL if unset. */
	GArray *packet_index;	/* contains struct packet_index */
	int prot;		/* mmap protection */
	int flags;		/* mmap flags */

	/* Current position */
	off_t mmap_offset;	/* mmap offset in the file, in bytes */
	off_t mmap_base_offset;	/* offset of start of packet in mmap, in bytes */
	uint64_t packet_size;	/* current packet size, in bits */
	uint64_t content_size;	/* current content size, in bits */
	uint64_t *content_size_loc; /* pointer to current content size */
	struct mmap_align *base_mma;/* mmap base address */
	int64_t offset;		/* offset from base, in bits. EOF for end of file. */
	int64_t last_offset;	/* offset before the last read_event */
	int64_t data_offset;	/* offset of data in current packet */
	uint64_t cur_index;	/* current index in packet index */
	uint64_t last_events_discarded;	/* last known amount of event discarded */
	void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
			int whence); /* function called to switch packet */

	int dummy;		/* dummy position, for length calculation */
	struct bt_stream_callbacks *cb;	/* Callbacks registered for iterator. */
	void *priv;
};

static inline
struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
{
	return container_of(pos, struct ctf_stream_pos, parent);
}

BT_HIDDEN
int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
BT_HIDDEN
int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);

void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);

int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
		int fd, int open_flags);
int ctf_fini_pos(struct ctf_stream_pos *pos);

/*
 * move_pos - move position of a relative bit offset
 *
 * Return 1 if OK, 0 if out-of-bound.
 *
 * TODO: allow larger files by updating base too.
 */
static inline
int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
{
	uint64_t max_len;

	printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
	if (unlikely(pos->offset == EOF))
		return 0;
	if (pos->prot == PROT_READ)
		max_len = pos->content_size;
	else
		max_len = pos->packet_size;
	if (unlikely(pos->offset + bit_offset > max_len))
		return 0;

	pos->offset += bit_offset;
	printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
	return 1;
}

/*
 * align_pos - align position on a bit offset (> 0)
 *
 * Return 1 if OK, 0 if out-of-bound.
 *
 * TODO: allow larger files by updating base too.
 */
static inline
int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
{
	return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
}

static inline
char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
{
	/* Only makes sense to get the address after aligning on CHAR_BIT */
	assert(!(pos->offset % CHAR_BIT));
	return mmap_align_addr(pos->base_mma) +
		pos->mmap_base_offset + (pos->offset / CHAR_BIT);
}

static inline
void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
{
	memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
	dummy->dummy = 1;
	dummy->fd = -1;
}

/*
 * Check if current packet can hold data.
 * Returns 0 for success, negative error otherwise.
 */
static inline
int ctf_pos_packet(struct ctf_stream_pos *dummy)
{
	if (unlikely(dummy->offset > dummy->packet_size))
		return -ENOSPC;
	return 0;
}

static inline
void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
{
	ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
}

static inline
int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
{
	uint64_t max_len;

	if (unlikely(pos->offset == EOF))
		return 0;
	if (pos->prot == PROT_READ)
		max_len = pos->content_size;
	else
		max_len = pos->packet_size;
	if (unlikely(pos->offset + bit_len > max_len))
		return 0;
	return 1;
}

/*
 * Update the stream position to the current event. This moves to
 * the next packet if we are located at the end of the current packet.
 */
static inline
void ctf_pos_get_event(struct ctf_stream_pos *pos)
{
	assert(pos->offset <= pos->content_size);
	if (pos->offset == pos->content_size) {
		printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
			     pos->offset);
		pos->packet_seek(&pos->parent, 0, SEEK_CUR);
		printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
			     pos->offset);
	}
}

void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
			uint64_t timestamp);

#endif /* _BABELTRACE_CTF_TYPES_H */
Commit	Line	Data
b1acd2b3 JD	1	#ifndef _BABELTRACE_CTF_TYPES_H
	2	#define _BABELTRACE_CTF_TYPES_H
	3
	4	/*
	5	* Common Trace Format
	6	*
	7	* Type header
	8	*
	9	* Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#include <babeltrace/types.h>
	31	#include <babeltrace/babeltrace-internal.h>
	32	#include <sys/types.h>
	33	#include <sys/stat.h>
	34	#include <fcntl.h>
	35	#include <errno.h>
	36	#include <stdint.h>
	37	#include <unistd.h>
	38	#include <glib.h>
	39	#include <stdio.h>
	40	#include <inttypes.h>
	41	#include <babeltrace/mmap-align.h>
	42
	43	#define LAST_OFFSET_POISON ((int64_t) ~0ULL)
	44
	45	struct bt_stream_callbacks;
	46
3bac1a1f JD	47	struct packet_index_time {
	48	uint64_t timestamp_begin;
	49	uint64_t timestamp_end;
	50	};
	51
b1acd2b3 JD	52	struct packet_index {
	53	off_t offset; /* offset of the packet in the file, in bytes */
	54	int64_t data_offset; /* offset of data within the packet, in bits */
	55	uint64_t packet_size; /* packet size, in bits */
	56	uint64_t content_size; /* content size, in bits */
b1acd2b3 JD	57	uint64_t events_discarded;
b1acd2b3 JD	58	uint64_t events_discarded_len; /* length of the field, in bits */
3bac1a1f JD	59	struct packet_index_time ts_cycles; /* timestamp in cycles */
3bac1a1f JD	60	struct packet_index_time ts_real; /* realtime timestamp */
b1acd2b3 JD	61	};
	62
	63	/*
	64	* Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
	65	*/
	66	struct ctf_stream_pos {
	67	struct bt_stream_pos parent;
	68	int fd; /* backing file fd. -1 if unset. */
12a91e9d	69	FILE index_fp; / backing index file fp. NULL if unset. */
3bac1a1f	70	GArray packet_index; / contains struct packet_index */
b1acd2b3 JD	71	int prot; /* mmap protection */
	72	int flags; /* mmap flags */
	73
	74	/* Current position */
	75	off_t mmap_offset; /* mmap offset in the file, in bytes */
	76	off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
	77	uint64_t packet_size; /* current packet size, in bits */
	78	uint64_t content_size; /* current content size, in bits */
	79	uint64_t content_size_loc; / pointer to current content size */
	80	struct mmap_align base_mma;/ mmap base address */
	81	int64_t offset; /* offset from base, in bits. EOF for end of file. */
	82	int64_t last_offset; /* offset before the last read_event */
12a91e9d	83	int64_t data_offset; /* offset of data in current packet */
b1acd2b3 JD	84	uint64_t cur_index; /* current index in packet index */
	85	uint64_t last_events_discarded; /* last known amount of event discarded */
	86	void (packet_seek)(struct bt_stream_pos pos, size_t index,
	87	int whence); /* function called to switch packet */
	88
	89	int dummy; /* dummy position, for length calculation */
	90	struct bt_stream_callbacks cb; / Callbacks registered for iterator. */
12a91e9d	91	void *priv;
b1acd2b3 JD	92	};
	93
	94	static inline
	95	struct ctf_stream_pos ctf_pos(struct bt_stream_pos pos)
	96	{
	97	return container_of(pos, struct ctf_stream_pos, parent);
	98	}
	99
	100	BT_HIDDEN
	101	int ctf_integer_read(struct bt_stream_pos pos, struct bt_definition definition);
	102	BT_HIDDEN
	103	int ctf_integer_write(struct bt_stream_pos pos, struct bt_definition definition);
	104	BT_HIDDEN
	105	int ctf_float_read(struct bt_stream_pos pos, struct bt_definition definition);
	106	BT_HIDDEN
	107	int ctf_float_write(struct bt_stream_pos pos, struct bt_definition definition);
	108	BT_HIDDEN
	109	int ctf_string_read(struct bt_stream_pos pos, struct bt_definition definition);
	110	BT_HIDDEN
	111	int ctf_string_write(struct bt_stream_pos pos, struct bt_definition definition);
	112	BT_HIDDEN
	113	int ctf_enum_read(struct bt_stream_pos pos, struct bt_definition definition);
	114	BT_HIDDEN
	115	int ctf_enum_write(struct bt_stream_pos pos, struct bt_definition definition);
	116	BT_HIDDEN
	117	int ctf_struct_rw(struct bt_stream_pos pos, struct bt_definition definition);
	118	BT_HIDDEN
	119	int ctf_variant_rw(struct bt_stream_pos pos, struct bt_definition definition);
	120	BT_HIDDEN
	121	int ctf_array_read(struct bt_stream_pos pos, struct bt_definition definition);
	122	BT_HIDDEN
	123	int ctf_array_write(struct bt_stream_pos pos, struct bt_definition definition);
	124	BT_HIDDEN
	125	int ctf_sequence_read(struct bt_stream_pos pos, struct bt_definition definition);
	126	BT_HIDDEN
	127	int ctf_sequence_write(struct bt_stream_pos pos, struct bt_definition definition);
	128
	129	void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
	130
	131	int ctf_init_pos(struct ctf_stream_pos pos, struct bt_trace_descriptor trace,
	132	int fd, int open_flags);
	133	int ctf_fini_pos(struct ctf_stream_pos *pos);
	134
	135	/*
	136	* move_pos - move position of a relative bit offset
	137	*
12a91e9d JD	138	* Return 1 if OK, 0 if out-of-bound.
12a91e9d JD	139	*
b1acd2b3 JD	140	* TODO: allow larger files by updating base too.
	141	*/
	142	static inline
12a91e9d	143	int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
b1acd2b3	144	{
12a91e9d JD	145	uint64_t max_len;
12a91e9d JD	146
b1acd2b3 JD	147	printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
b1acd2b3 JD	148	if (unlikely(pos->offset == EOF))
12a91e9d JD	149	return 0;
	150	if (pos->prot == PROT_READ)
	151	max_len = pos->content_size;
	152	else
	153	max_len = pos->packet_size;
	154	if (unlikely(pos->offset + bit_offset > max_len))
	155	return 0;
	156
b1acd2b3 JD	157	pos->offset += bit_offset;
b1acd2b3 JD	158	printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
12a91e9d	159	return 1;
b1acd2b3 JD	160	}
	161
	162	/*
	163	* align_pos - align position on a bit offset (> 0)
	164	*
12a91e9d JD	165	* Return 1 if OK, 0 if out-of-bound.
12a91e9d JD	166	*
b1acd2b3 JD	167	* TODO: allow larger files by updating base too.
	168	*/
	169	static inline
12a91e9d	170	int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
b1acd2b3	171	{
12a91e9d	172	return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
b1acd2b3 JD	173	}
	174
	175	static inline
	176	char ctf_get_pos_addr(struct ctf_stream_pos pos)
	177	{
	178	/* Only makes sense to get the address after aligning on CHAR_BIT */
	179	assert(!(pos->offset % CHAR_BIT));
	180	return mmap_align_addr(pos->base_mma) +
	181	pos->mmap_base_offset + (pos->offset / CHAR_BIT);
	182	}
	183
	184	static inline
	185	void ctf_dummy_pos(struct ctf_stream_pos pos, struct ctf_stream_pos dummy)
	186	{
	187	memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
	188	dummy->dummy = 1;
	189	dummy->fd = -1;
	190	}
	191
	192	/*
	193	* Check if current packet can hold data.
	194	* Returns 0 for success, negative error otherwise.
	195	*/
	196	static inline
	197	int ctf_pos_packet(struct ctf_stream_pos *dummy)
	198	{
	199	if (unlikely(dummy->offset > dummy->packet_size))
	200	return -ENOSPC;
	201	return 0;
	202	}
	203
	204	static inline
	205	void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
	206	{
12a91e9d	207	ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
b1acd2b3 JD	208	}
	209
	210	static inline
	211	int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
	212	{
12a91e9d JD	213	uint64_t max_len;
12a91e9d JD	214
b1acd2b3 JD	215	if (unlikely(pos->offset == EOF))
b1acd2b3 JD	216	return 0;
12a91e9d JD	217	if (pos->prot == PROT_READ)
	218	max_len = pos->content_size;
	219	else
	220	max_len = pos->packet_size;
	221	if (unlikely(pos->offset + bit_len > max_len))
b1acd2b3 JD	222	return 0;
	223	return 1;
	224	}
	225
	226	/*
12a91e9d	227	* Update the stream position to the current event. This moves to
b1acd2b3 JD	228	* the next packet if we are located at the end of the current packet.
	229	*/
	230	static inline
	231	void ctf_pos_get_event(struct ctf_stream_pos *pos)
	232	{
	233	assert(pos->offset <= pos->content_size);
	234	if (pos->offset == pos->content_size) {
	235	printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
	236	pos->offset);
	237	pos->packet_seek(&pos->parent, 0, SEEK_CUR);
	238	printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
	239	pos->offset);
	240	}
	241	}
	242
	243	void ctf_print_timestamp(FILE fp, struct ctf_stream_definition stream,
	244	uint64_t timestamp);
	245
	246	#endif /* _BABELTRACE_CTF_TYPES_H */