[babeltrace.git] / include / 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.
 */

#include <babeltrace/types.h>
#include <babeltrace/babeltrace-internal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <errno.h>
#include <stdint.h>
#include <unistd.h>
#include <glib.h>
#include <stdio.h>

struct packet_index {
	off_t offset;		/* offset of the packet in the file, in bytes */
	off_t data_offset;	/* offset of data within the packet, in bits */
	size_t packet_size;	/* packet size, in bits */
	size_t content_size;	/* content size, in bits */
	uint64_t timestamp_begin;
	uint64_t timestamp_end;
};

/*
 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
 */
struct ctf_stream_pos {
	struct stream_pos parent;
	int fd;			/* backing file fd. -1 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 */
	size_t packet_size;	/* current packet size, in bits */
	size_t content_size;	/* current content size, in bits */
	uint32_t *content_size_loc; /* pointer to current content size */
	char *base;		/* mmap base address */
	ssize_t offset;		/* offset from base, in bits. EOF for end of file. */
	size_t cur_index;	/* current index in packet index */

	int dummy;		/* dummy position, for length calculation */
};

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

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

void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence);

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

/*
 * move_pos - move position of a relative bit offset
 *
 * TODO: allow larger files by updating base too.
 */
static inline
void ctf_move_pos(struct ctf_stream_pos *pos, size_t bit_offset)
{
	printf_debug("ctf_move_pos test EOF: %zd\n", pos->offset);
	if (pos->offset == EOF)
		return;

	if (pos->fd >= 0) {
		/*
		 * PROT_READ ctf_move_pos_slow is called from within
		 * ctf_pos_get_event so end of packet does not change
		 * the packet context on for the last event of the
		 * packet.
		 */
		if ((pos->prot == PROT_WRITE)
		    	&& (pos->offset + bit_offset >= pos->packet_size)) {
			printf_debug("ctf_move_pos_slow (before call): %zd\n",
				     pos->offset);
			ctf_move_pos_slow(pos, bit_offset, SEEK_CUR);
			printf_debug("ctf_move_pos_slow (after call): %zd\n",
				     pos->offset);
			return;
		}
	}
	pos->offset += bit_offset;
	printf_debug("ctf_move_pos after increment: %zd\n", pos->offset);
}

/*
 * align_pos - align position on a bit offset (> 0)
 *
 * TODO: allow larger files by updating base too.
 */
static inline
void ctf_align_pos(struct ctf_stream_pos *pos, size_t bit_offset)
{
	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 pos->base + (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 (dummy->offset > dummy->packet_size)
		return -ENOSPC;
	return 0;
}

static inline
void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
{
	ctf_move_pos(pos, pos->packet_size - pos->offset);
}

static inline
int ctf_pos_access_ok(struct ctf_stream_pos *pos, size_t bit_len)
{
	if (pos->offset == EOF)
		return 0;
	if (pos->offset + bit_len > pos->packet_size)
		return 0;
	return 1;
}

/*
 * Update the stream position for 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_move_pos_slow (before call): %zd\n",
			     pos->offset);
		ctf_move_pos_slow(pos, 0, SEEK_CUR);
		printf_debug("ctf_move_pos_slow (after call): %zd\n",
			     pos->offset);
	}
}

#endif /* _BABELTRACE_CTF_TYPES_H */
Commit	Line	Data
d79865b9 MD	1	#ifndef _BABELTRACE_CTF_TYPES_H
d79865b9 MD	2	#define _BABELTRACE_CTF_TYPES_H
6dc2ca62 MD	3
	4	/*
	5	* Common Trace Format
	6	*
	7	* Type header
	8	*
ccd7e1c8	9	* Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6dc2ca62	10	*
ccd7e1c8 MD	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:
de0ba614	17	*
ccd7e1c8 MD	18	* The above copyright notice and this permission notice shall be included in
ccd7e1c8 MD	19	* all copies or substantial portions of the Software.
6dc2ca62 MD	20	*/
6dc2ca62 MD	21
4c8bfb7e	22	#include <babeltrace/types.h>
70bd0a12	23	#include <babeltrace/babeltrace-internal.h>
8563e754 MD	24	#include <sys/types.h>
	25	#include <sys/stat.h>
	26	#include <fcntl.h>
8c572eba MD	27	#include <sys/mman.h>
8c572eba MD	28	#include <errno.h>
6dc2ca62	29	#include <stdint.h>
0f980a35	30	#include <unistd.h>
6dc2ca62	31	#include <glib.h>
c5e74408	32	#include <stdio.h>
847bf71a	33
0f980a35 MD	34	struct packet_index {
0f980a35 MD	35	off_t offset; /* offset of the packet in the file, in bytes */
2b9a764d	36	off_t data_offset; /* offset of data within the packet, in bits */
0f980a35 MD	37	size_t packet_size; /* packet size, in bits */
0f980a35 MD	38	size_t content_size; /* content size, in bits */
75cc2c35 MD	39	uint64_t timestamp_begin;
75cc2c35 MD	40	uint64_t timestamp_end;
dd2544fd MD	41	};
dd2544fd MD	42
dd2544fd	43	/*
46322b33	44	* Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
dd2544fd	45	*/
46322b33 MD	46	struct ctf_stream_pos {
46322b33 MD	47	struct stream_pos parent;
0f980a35 MD	48	int fd; /* backing file fd. -1 if unset. */
0f980a35 MD	49	GArray packet_index; / contains struct packet_index */
8c572eba MD	50	int prot; /* mmap protection */
8c572eba MD	51	int flags; /* mmap flags */
dd2544fd	52
0f980a35 MD	53	/* Current position */
	54	off_t mmap_offset; /* mmap offset in the file, in bytes */
	55	size_t packet_size; /* current packet size, in bits */
	56	size_t content_size; /* current content size, in bits */
8c572eba	57	uint32_t content_size_loc; / pointer to current content size */
0f980a35	58	char base; / mmap base address */
670977d3	59	ssize_t offset; /* offset from base, in bits. EOF for end of file. */
8c572eba	60	size_t cur_index; /* current index in packet index */
dd2544fd	61
0f980a35 MD	62	int dummy; /* dummy position, for length calculation */
0f980a35 MD	63	};
dd2544fd	64
46322b33 MD	65	static inline
	66	struct ctf_stream_pos ctf_pos(struct stream_pos pos)
	67	{
	68	return container_of(pos, struct ctf_stream_pos, parent);
	69	}
	70
c5e74408 MD	71	int ctf_integer_read(struct stream_pos pos, struct definition definition);
	72	int ctf_integer_write(struct stream_pos pos, struct definition definition);
	73	int ctf_float_read(struct stream_pos pos, struct definition definition);
	74	int ctf_float_write(struct stream_pos pos, struct definition definition);
	75	int ctf_string_read(struct stream_pos pos, struct definition definition);
	76	int ctf_string_write(struct stream_pos pos, struct definition definition);
	77	int ctf_enum_read(struct stream_pos pos, struct definition definition);
	78	int ctf_enum_write(struct stream_pos pos, struct definition definition);
	79	int ctf_struct_rw(struct stream_pos pos, struct definition definition);
	80	int ctf_variant_rw(struct stream_pos pos, struct definition definition);
81dee1bb MD	81	int ctf_array_read(struct stream_pos pos, struct definition definition);
	82	int ctf_array_write(struct stream_pos pos, struct definition definition);
	83	int ctf_sequence_read(struct stream_pos pos, struct definition definition);
	84	int ctf_sequence_write(struct stream_pos pos, struct definition definition);
6dc2ca62	85
847bf71a	86	void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence);
0f980a35	87
8563e754	88	void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags);
46322b33	89	void ctf_fini_pos(struct ctf_stream_pos *pos);
0f980a35 MD	90
	91	/*
	92	* move_pos - move position of a relative bit offset
	93	*
	94	* TODO: allow larger files by updating base too.
	95	*/
	96	static inline
46322b33	97	void ctf_move_pos(struct ctf_stream_pos *pos, size_t bit_offset)
0f980a35	98	{
670977d3 MD	99	printf_debug("ctf_move_pos test EOF: %zd\n", pos->offset);
670977d3 MD	100	if (pos->offset == EOF)
c5e74408 MD	101	return;
c5e74408 MD	102
8c572eba	103	if (pos->fd >= 0) {
5f643ed7 MD	104	/*
	105	* PROT_READ ctf_move_pos_slow is called from within
	106	* ctf_pos_get_event so end of packet does not change
	107	* the packet context on for the last event of the
	108	* packet.
	109	*/
	110	if ((pos->prot == PROT_WRITE)
	111	&& (pos->offset + bit_offset >= pos->packet_size)) {
670977d3 MD	112	printf_debug("ctf_move_pos_slow (before call): %zd\n",
670977d3 MD	113	pos->offset);
847bf71a	114	ctf_move_pos_slow(pos, bit_offset, SEEK_CUR);
670977d3 MD	115	printf_debug("ctf_move_pos_slow (after call): %zd\n",
670977d3 MD	116	pos->offset);
8c572eba MD	117	return;
	118	}
	119	}
	120	pos->offset += bit_offset;
670977d3	121	printf_debug("ctf_move_pos after increment: %zd\n", pos->offset);
0f980a35 MD	122	}
	123
	124	/*
	125	* align_pos - align position on a bit offset (> 0)
	126	*
	127	* TODO: allow larger files by updating base too.
	128	*/
	129	static inline
46322b33	130	void ctf_align_pos(struct ctf_stream_pos *pos, size_t bit_offset)
0f980a35	131	{
46322b33	132	ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
0f980a35 MD	133	}
	134
	135	static inline
46322b33	136	char ctf_get_pos_addr(struct ctf_stream_pos pos)
0f980a35 MD	137	{
	138	/* Only makes sense to get the address after aligning on CHAR_BIT */
	139	assert(!(pos->offset % CHAR_BIT));
	140	return pos->base + (pos->offset / CHAR_BIT);
	141	}
	142
8c572eba	143	static inline
46322b33	144	void ctf_dummy_pos(struct ctf_stream_pos pos, struct ctf_stream_pos dummy)
8c572eba	145	{
46322b33	146	memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
8c572eba MD	147	dummy->dummy = 1;
	148	dummy->fd = -1;
	149	}
	150
	151	/*
	152	* Check if current packet can hold data.
	153	* Returns 0 for success, negative error otherwise.
	154	*/
	155	static inline
46322b33	156	int ctf_pos_packet(struct ctf_stream_pos *dummy)
8c572eba MD	157	{
	158	if (dummy->offset > dummy->packet_size)
	159	return -ENOSPC;
	160	return 0;
	161	}
	162
	163	static inline
46322b33	164	void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
8c572eba	165	{
46322b33	166	ctf_move_pos(pos, pos->packet_size - pos->offset);
8c572eba MD	167	}
8c572eba MD	168
c5e74408 MD	169	static inline
	170	int ctf_pos_access_ok(struct ctf_stream_pos *pos, size_t bit_len)
	171	{
670977d3	172	if (pos->offset == EOF)
c5e74408 MD	173	return 0;
	174	if (pos->offset + bit_len > pos->packet_size)
	175	return 0;
	176	return 1;
	177	}
	178
5f643ed7 MD	179	/*
	180	* Update the stream position for to the current event. This moves to
	181	* the next packet if we are located at the end of the current packet.
	182	*/
	183	static inline
	184	void ctf_pos_get_event(struct ctf_stream_pos *pos)
	185	{
	186	assert(pos->offset <= pos->content_size);
	187	if (pos->offset == pos->content_size) {
	188	printf_debug("ctf_move_pos_slow (before call): %zd\n",
	189	pos->offset);
	190	ctf_move_pos_slow(pos, 0, SEEK_CUR);
	191	printf_debug("ctf_move_pos_slow (after call): %zd\n",
	192	pos->offset);
	193	}
	194	}
	195
d79865b9	196	#endif /* _BABELTRACE_CTF_TYPES_H */