[babeltrace.git] / include / babeltrace / ctf-writer / serialize-internal.h

#ifndef BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H
#define BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H

/*
 * Copyright 2017 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include <stdlib.h>
#include <stdint.h>
#include <limits.h>
#include <babeltrace/compat/mman-internal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <babeltrace/ctf-ir/field-types.h>
#include <babeltrace/ctf-ir/fields.h>
#include <babeltrace/ctf-ir/fields-internal.h>
#include <babeltrace/align-internal.h>
#include <babeltrace/common-internal.h>
#include <babeltrace/mmap-align-internal.h>
#include <babeltrace/types.h>

#define PACKET_LEN_INCREMENT	(bt_common_get_page_size() * 8 * CHAR_BIT)

struct bt_ctf_stream_pos {
	int fd;
	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 */
	int64_t offset;		/* offset from base, in bits. EOF for end of file. */
	struct mmap_align *base_mma;/* mmap base address */
};

BT_HIDDEN
int bt_ctf_field_integer_write(struct bt_ctf_field_integer *field,
		struct bt_ctf_stream_pos *pos,
		enum bt_ctf_byte_order native_byte_order);

BT_HIDDEN
int bt_ctf_field_floating_point_write(struct bt_ctf_field_floating_point *field,
		struct bt_ctf_stream_pos *pos,
		enum bt_ctf_byte_order native_byte_order);

static inline
int bt_ctf_stream_pos_access_ok(struct bt_ctf_stream_pos *pos, uint64_t bit_len)
{
	uint64_t max_len;

	if (unlikely(pos->offset == EOF))
		return 0;

	if (pos->prot == PROT_READ) {
		/*
		 * Reads may only reach up to the "content_size",
		 * regardless of the packet_size.
		 */
		max_len = pos->offset;
	} else {
		/* Writes may take place up to the end of the packet. */
		max_len = pos->packet_size;
	}
	if (unlikely(pos->offset < 0 || bit_len > INT64_MAX - pos->offset)) {
		return 0;
	}
	if (unlikely(pos->offset + bit_len > max_len))
		return 0;
	return 1;
}

static inline
int bt_ctf_stream_pos_move(struct bt_ctf_stream_pos *pos, uint64_t bit_offset)
{
	int ret = 0;

	ret = bt_ctf_stream_pos_access_ok(pos, bit_offset);
	if (!ret) {
		goto end;
	}
	pos->offset += bit_offset;
end:
	return ret;
}

static inline
int bt_ctf_stream_pos_align(struct bt_ctf_stream_pos *pos, uint64_t bit_offset)
{
	return bt_ctf_stream_pos_move(pos,
		offset_align(pos->offset, bit_offset));
}

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

static inline
int bt_ctf_stream_pos_init(struct bt_ctf_stream_pos *pos,
		int fd, int open_flags)
{
	pos->fd = fd;

	switch (open_flags & O_ACCMODE) {
	case O_RDONLY:
		pos->prot = PROT_READ;
		pos->flags = MAP_PRIVATE;
		break;
	case O_RDWR:
		pos->prot = PROT_READ | PROT_WRITE;
		pos->flags = MAP_SHARED;
		break;
	default:
		abort();
	}

	return 0;
}

static inline
int bt_ctf_stream_pos_fini(struct bt_ctf_stream_pos *pos)
{
	if (pos->base_mma) {
		int ret;

		/* unmap old base */
		ret = munmap_align(pos->base_mma);
		if (ret) {
			return -1;
		}
	}

	return 0;
}

BT_HIDDEN
void bt_ctf_stream_pos_packet_seek(struct bt_ctf_stream_pos *pos, size_t index,
	int whence);

#endif /* BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H */
Commit	Line	Data
dc3fffef PP	1	#ifndef BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H
	2	#define BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017 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	* The Common Trace Format (CTF) Specification is available at
	26	* http://www.efficios.com/ctf
	27	*/
	28
0fbb9a9f	29	#include <stdlib.h>
dc3fffef PP	30	#include <stdint.h>
dc3fffef PP	31	#include <limits.h>
8f76831a	32	#include <babeltrace/compat/mman-internal.h>
dc3fffef PP	33	#include <sys/types.h>
	34	#include <sys/stat.h>
	35	#include <fcntl.h>
	36	#include <babeltrace/ctf-ir/field-types.h>
	37	#include <babeltrace/ctf-ir/fields.h>
	38	#include <babeltrace/ctf-ir/fields-internal.h>
3d9990ac	39	#include <babeltrace/align-internal.h>
108e5a1e	40	#include <babeltrace/common-internal.h>
3d9990ac	41	#include <babeltrace/mmap-align-internal.h>
c55a9f58	42	#include <babeltrace/types.h>
dc3fffef	43
108e5a1e MJ	44	#define PACKET_LEN_INCREMENT (bt_common_get_page_size() * 8 * CHAR_BIT)
108e5a1e MJ	45
dc3fffef PP	46	struct bt_ctf_stream_pos {
	47	int fd;
	48	int prot; /* mmap protection */
	49	int flags; /* mmap flags */
	50
	51	/* Current position */
	52	off_t mmap_offset; /* mmap offset in the file, in bytes */
	53	off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
	54	uint64_t packet_size; /* current packet size, in bits */
dc3fffef PP	55	int64_t offset; /* offset from base, in bits. EOF for end of file. */
	56	struct mmap_align base_mma;/ mmap base address */
	57	};
	58
	59	BT_HIDDEN
	60	int bt_ctf_field_integer_write(struct bt_ctf_field_integer *field,
	61	struct bt_ctf_stream_pos *pos,
	62	enum bt_ctf_byte_order native_byte_order);
	63
	64	BT_HIDDEN
	65	int bt_ctf_field_floating_point_write(struct bt_ctf_field_floating_point *field,
	66	struct bt_ctf_stream_pos *pos,
	67	enum bt_ctf_byte_order native_byte_order);
	68
	69	static inline
	70	int bt_ctf_stream_pos_access_ok(struct bt_ctf_stream_pos *pos, uint64_t bit_len)
	71	{
	72	uint64_t max_len;
	73
	74	if (unlikely(pos->offset == EOF))
	75	return 0;
b3376dd9	76
dc3fffef PP	77	if (pos->prot == PROT_READ) {
	78	/*
	79	* Reads may only reach up to the "content_size",
	80	* regardless of the packet_size.
	81	*/
b3376dd9	82	max_len = pos->offset;
dc3fffef PP	83	} else {
	84	/* Writes may take place up to the end of the packet. */
	85	max_len = pos->packet_size;
	86	}
6c711b23 MD	87	if (unlikely(pos->offset < 0 \|\| bit_len > INT64_MAX - pos->offset)) {
	88	return 0;
	89	}
dc3fffef PP	90	if (unlikely(pos->offset + bit_len > max_len))
	91	return 0;
	92	return 1;
	93	}
	94
	95	static inline
	96	int bt_ctf_stream_pos_move(struct bt_ctf_stream_pos *pos, uint64_t bit_offset)
	97	{
	98	int ret = 0;
	99
	100	ret = bt_ctf_stream_pos_access_ok(pos, bit_offset);
	101	if (!ret) {
	102	goto end;
	103	}
	104	pos->offset += bit_offset;
	105	end:
	106	return ret;
	107	}
	108
	109	static inline
	110	int bt_ctf_stream_pos_align(struct bt_ctf_stream_pos *pos, uint64_t bit_offset)
	111	{
	112	return bt_ctf_stream_pos_move(pos,
	113	offset_align(pos->offset, bit_offset));
	114	}
	115
	116	static inline
	117	char bt_ctf_stream_pos_get_addr(struct bt_ctf_stream_pos pos)
	118	{
	119	/* Only makes sense to get the address after aligning on CHAR_BIT */
	120	assert(!(pos->offset % CHAR_BIT));
544d0515	121	return ((char *) mmap_align_addr(pos->base_mma)) +
dc3fffef PP	122	pos->mmap_base_offset + (pos->offset / CHAR_BIT);
	123	}
	124
	125	static inline
	126	int bt_ctf_stream_pos_init(struct bt_ctf_stream_pos *pos,
	127	int fd, int open_flags)
	128	{
	129	pos->fd = fd;
	130
	131	switch (open_flags & O_ACCMODE) {
	132	case O_RDONLY:
	133	pos->prot = PROT_READ;
	134	pos->flags = MAP_PRIVATE;
	135	break;
	136	case O_RDWR:
	137	pos->prot = PROT_READ \| PROT_WRITE;
	138	pos->flags = MAP_SHARED;
	139	break;
	140	default:
0fbb9a9f	141	abort();
dc3fffef PP	142	}
	143
	144	return 0;
	145	}
	146
	147	static inline
	148	int bt_ctf_stream_pos_fini(struct bt_ctf_stream_pos *pos)
	149	{
	150	if (pos->base_mma) {
	151	int ret;
	152
	153	/* unmap old base */
	154	ret = munmap_align(pos->base_mma);
	155	if (ret) {
	156	return -1;
	157	}
	158	}
	159
	160	return 0;
	161	}
	162
	163	BT_HIDDEN
	164	void bt_ctf_stream_pos_packet_seek(struct bt_ctf_stream_pos *pos, size_t index,
	165	int whence);
	166
	167	#endif /* BABELTRACE_CTF_WRITER_SERIALIZE_INTERNAL_H */