[babeltrace.git] / src / ctfser / ctfser.c

/*
 * Copyright 2019 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.
 */

#define BT_LOG_OUTPUT_LEVEL (ctfser->log_level)
#define BT_LOG_TAG "CTFSER"
#include "logging/log.h"

#include <unistd.h>
#include <string.h>
#include <inttypes.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include "common/assert.h"
#include <stdarg.h>
#include <ctype.h>
#include <glib.h>
#include <stdlib.h>
#include <stdio.h>
#include <wchar.h>
#include <stdbool.h>
#include "common/macros.h"
#include "common/common.h"
#include "ctfser/ctfser.h"
#include "compat/unistd.h"
#include "compat/fcntl.h"

static inline
uint64_t get_packet_size_increment_bytes(struct bt_ctfser *ctfser)
{
	return bt_common_get_page_size(ctfser->log_level) * 8;
}

static inline
void mmap_align_ctfser(struct bt_ctfser *ctfser)
{
	ctfser->base_mma = mmap_align(ctfser->cur_packet_size_bytes,
		PROT_READ | PROT_WRITE,
		MAP_SHARED, ctfser->fd, ctfser->mmap_offset, ctfser->log_level);
}

BT_HIDDEN
int _bt_ctfser_increase_cur_packet_size(struct bt_ctfser *ctfser)
{
	int ret;

	BT_ASSERT(ctfser);
	BT_LOGD("Increasing stream file's current packet size: "
		"path=\"%s\", fd=%d, "
		"offset-in-cur-packet-bits=%" PRIu64 ", "
		"cur-packet-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->offset_in_cur_packet_bits,
		ctfser->cur_packet_size_bytes);
	ret = munmap_align(ctfser->base_mma);
	if (ret) {
		BT_LOGE_ERRNO("Failed to perform an aligned memory unmapping",
			": ret=%d", ret);
		goto end;
	}

	ctfser->cur_packet_size_bytes += get_packet_size_increment_bytes(
		ctfser);

	do {
		ret = bt_posix_fallocate(ctfser->fd, ctfser->mmap_offset,
			ctfser->cur_packet_size_bytes);
	} while (ret == EINTR);

	if (ret) {
		BT_LOGE("Failed to preallocate memory space: ret=%d", ret);
		goto end;
	}

	mmap_align_ctfser(ctfser);
	if (ctfser->base_mma == MAP_FAILED) {
		BT_LOGE_ERRNO("Failed to perform an aligned memory mapping",
			": ret=%d", ret);
		ret = -1;
		goto end;
	}

	BT_LOGD("Increased packet size: "
		"path=\"%s\", fd=%d, "
		"offset-in-cur-packet-bits=%" PRIu64 ", "
		"new-packet-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->offset_in_cur_packet_bits,
		ctfser->cur_packet_size_bytes);

end:
	return ret;
}

BT_HIDDEN
int bt_ctfser_init(struct bt_ctfser *ctfser, const char *path, int log_level)
{
	int ret = 0;

	BT_ASSERT(ctfser);
	memset(ctfser, 0, sizeof(*ctfser));
	ctfser->fd = open(path, O_RDWR | O_CREAT | O_TRUNC,
		S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
	ctfser->log_level = log_level;
	if (ctfser->fd < 0) {
		BT_LOGW_ERRNO("Failed to open stream file for writing",
			": path=\"%s\", ret=%d",
			path, ctfser->fd);
		ret = -1;
		goto end;
	}

	ctfser->path = g_string_new(path);

end:
	return ret;
}

BT_HIDDEN
int bt_ctfser_fini(struct bt_ctfser *ctfser)
{
	int ret = 0;

	if (ctfser->fd == -1) {
		goto free_path;
	}

	/*
	 * Truncate the stream file's size to the minimum required to
	 * fit the last packet as we might have grown it too much during
	 * the last memory map.
	 */
	do {
		ret = ftruncate(ctfser->fd, ctfser->stream_size_bytes);
	} while (ret == -1 && errno == EINTR);

	if (ret) {
		BT_LOGE_ERRNO("Failed to truncate stream file",
			": ret=%d, size-bytes=%" PRIu64,
			ret, ctfser->stream_size_bytes);
		goto end;
	}

	if (ctfser->base_mma) {
		/* Unmap old base */
		ret = munmap_align(ctfser->base_mma);
		if (ret) {
			BT_LOGE_ERRNO("Failed to unmap stream file",
				": ret=%d, size-bytes=%" PRIu64,
				ret, ctfser->stream_size_bytes);
			goto end;
		}

		ctfser->base_mma = NULL;
	}

	ret = close(ctfser->fd);
	if (ret) {
		BT_LOGE_ERRNO("Failed to close stream file",
			": ret=%d", ret);
		goto end;
	}

	ctfser->fd = -1;

free_path:
	if (ctfser->path) {
		g_string_free(ctfser->path, TRUE);
		ctfser->path = NULL;
	}

end:
	return ret;
}

BT_HIDDEN
int bt_ctfser_open_packet(struct bt_ctfser *ctfser)
{
	int ret = 0;

	BT_LOGD("Opening packet: path=\"%s\", fd=%d, "
		"prev-packet-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->prev_packet_size_bytes);

	if (ctfser->base_mma) {
		/* Unmap old base (previous packet) */
		ret = munmap_align(ctfser->base_mma);
		if (ret) {
			BT_LOGE_ERRNO("Failed to unmap stream file",
				": ret=%d, size-bytes=%" PRIu64,
				ret, ctfser->stream_size_bytes);
			goto end;
		}

		ctfser->base_mma = NULL;
	}

	/*
	 * Add the previous packet's size to the memory map address
	 * offset to start writing immediately after it.
	 */
	ctfser->mmap_offset += ctfser->prev_packet_size_bytes;
	ctfser->prev_packet_size_bytes = 0;

	/* Make initial space for the current packet */
	ctfser->cur_packet_size_bytes = get_packet_size_increment_bytes(
		ctfser);

	do {
		ret = bt_posix_fallocate(ctfser->fd, ctfser->mmap_offset,
			ctfser->cur_packet_size_bytes);
	} while (ret == EINTR);

	if (ret) {
		BT_LOGE("Failed to preallocate memory space: ret=%d", ret);
		goto end;
	}

	/* Start writing at the beginning of the current packet */
	ctfser->offset_in_cur_packet_bits = 0;

	/* Get new base address */
	mmap_align_ctfser(ctfser);
	if (ctfser->base_mma == MAP_FAILED) {
		BT_LOGE_ERRNO("Failed to perform an aligned memory mapping",
			": ret=%d", ret);
		ret = -1;
		goto end;
	}

	BT_LOGD("Opened packet: path=\"%s\", fd=%d, "
		"cur-packet-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->cur_packet_size_bytes);

end:
	return ret;
}

BT_HIDDEN
void bt_ctfser_close_current_packet(struct bt_ctfser *ctfser,
		uint64_t packet_size_bytes)
{
	BT_LOGD("Closing packet: path=\"%s\", fd=%d, "
		"offset-in-cur-packet-bits=%" PRIu64
		"cur-packet-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->offset_in_cur_packet_bits,
		ctfser->cur_packet_size_bytes);

	/*
	 * This will be used during the next call to
	 * bt_ctfser_open_packet(): we add
	 * `ctfser->prev_packet_size_bytes` to the current memory map
	 * address offset (first byte of _this_ packet), effectively
	 * making _this_ packet the required size.
	 */
	ctfser->prev_packet_size_bytes = packet_size_bytes;
	ctfser->stream_size_bytes += packet_size_bytes;
	BT_LOGD("Closed packet: path=\"%s\", fd=%d, "
		"stream-file-size-bytes=%" PRIu64,
		ctfser->path->str, ctfser->fd,
		ctfser->stream_size_bytes);
}
Commit	Line	Data
013f35c6 PP	1	/*
	2	* Copyright 2019 Philippe Proulx <pproulx@efficios.com>
	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a copy
	5	* of this software and associated documentation files (the "Software"), to deal
	6	* in the Software without restriction, including without limitation the rights
	7	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	8	* copies of the Software, and to permit persons to whom the Software is
	9	* furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	17	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	18	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	19	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	20	* SOFTWARE.
	21	*/
	22
86d8b7b8	23	#define BT_LOG_OUTPUT_LEVEL (ctfser->log_level)
013f35c6	24	#define BT_LOG_TAG "CTFSER"
86d8b7b8	25	#include "logging/log.h"
013f35c6 PP	26
	27	#include <unistd.h>
	28	#include <string.h>
	29	#include <inttypes.h>
	30	#include <sys/types.h>
	31	#include <sys/stat.h>
	32	#include <unistd.h>
578e048b	33	#include "common/assert.h"
013f35c6 PP	34	#include <stdarg.h>
	35	#include <ctype.h>
	36	#include <glib.h>
	37	#include <stdlib.h>
	38	#include <stdio.h>
	39	#include <wchar.h>
	40	#include <stdbool.h>
91d81473	41	#include "common/macros.h"
578e048b MJ	42	#include "common/common.h"
	43	#include "ctfser/ctfser.h"
	44	#include "compat/unistd.h"
	45	#include "compat/fcntl.h"
013f35c6 PP	46
013f35c6 PP	47	static inline
86d8b7b8	48	uint64_t get_packet_size_increment_bytes(struct bt_ctfser *ctfser)
013f35c6	49	{
86d8b7b8	50	return bt_common_get_page_size(ctfser->log_level) * 8;
013f35c6 PP	51	}
	52
	53	static inline
	54	void mmap_align_ctfser(struct bt_ctfser *ctfser)
	55	{
9223d1f3 MJ	56	ctfser->base_mma = mmap_align(ctfser->cur_packet_size_bytes,
9223d1f3 MJ	57	PROT_READ \| PROT_WRITE,
86d8b7b8	58	MAP_SHARED, ctfser->fd, ctfser->mmap_offset, ctfser->log_level);
013f35c6 PP	59	}
	60
	61	BT_HIDDEN
	62	int _bt_ctfser_increase_cur_packet_size(struct bt_ctfser *ctfser)
	63	{
	64	int ret;
	65
	66	BT_ASSERT(ctfser);
3f7d4d90	67	BT_LOGD("Increasing stream file's current packet size: "
013f35c6 PP	68	"path=\"%s\", fd=%d, "
	69	"offset-in-cur-packet-bits=%" PRIu64 ", "
	70	"cur-packet-size-bytes=%" PRIu64,
	71	ctfser->path->str, ctfser->fd,
	72	ctfser->offset_in_cur_packet_bits,
	73	ctfser->cur_packet_size_bytes);
	74	ret = munmap_align(ctfser->base_mma);
	75	if (ret) {
	76	BT_LOGE_ERRNO("Failed to perform an aligned memory unmapping",
	77	": ret=%d", ret);
	78	goto end;
	79	}
	80
86d8b7b8 PP	81	ctfser->cur_packet_size_bytes += get_packet_size_increment_bytes(
86d8b7b8 PP	82	ctfser);
013f35c6 PP	83
	84	do {
	85	ret = bt_posix_fallocate(ctfser->fd, ctfser->mmap_offset,
	86	ctfser->cur_packet_size_bytes);
	87	} while (ret == EINTR);
	88
	89	if (ret) {
	90	BT_LOGE("Failed to preallocate memory space: ret=%d", ret);
	91	goto end;
	92	}
	93
	94	mmap_align_ctfser(ctfser);
	95	if (ctfser->base_mma == MAP_FAILED) {
	96	BT_LOGE_ERRNO("Failed to perform an aligned memory mapping",
	97	": ret=%d", ret);
	98	ret = -1;
	99	goto end;
	100	}
	101
3f7d4d90	102	BT_LOGD("Increased packet size: "
013f35c6 PP	103	"path=\"%s\", fd=%d, "
	104	"offset-in-cur-packet-bits=%" PRIu64 ", "
	105	"new-packet-size-bytes=%" PRIu64,
	106	ctfser->path->str, ctfser->fd,
	107	ctfser->offset_in_cur_packet_bits,
	108	ctfser->cur_packet_size_bytes);
	109
	110	end:
	111	return ret;
	112	}
	113
	114	BT_HIDDEN
86d8b7b8	115	int bt_ctfser_init(struct bt_ctfser ctfser, const char path, int log_level)
013f35c6 PP	116	{
	117	int ret = 0;
	118
	119	BT_ASSERT(ctfser);
	120	memset(ctfser, 0, sizeof(*ctfser));
	121	ctfser->fd = open(path, O_RDWR \| O_CREAT \| O_TRUNC,
	122	S_IRUSR \| S_IWUSR \| S_IRGRP \| S_IWGRP);
86d8b7b8	123	ctfser->log_level = log_level;
013f35c6 PP	124	if (ctfser->fd < 0) {
	125	BT_LOGW_ERRNO("Failed to open stream file for writing",
	126	": path=\"%s\", ret=%d",
	127	path, ctfser->fd);
	128	ret = -1;
	129	goto end;
	130	}
	131
	132	ctfser->path = g_string_new(path);
	133
	134	end:
	135	return ret;
	136	}
	137
	138	BT_HIDDEN
	139	int bt_ctfser_fini(struct bt_ctfser *ctfser)
	140	{
	141	int ret = 0;
	142
	143	if (ctfser->fd == -1) {
	144	goto free_path;
	145	}
	146
	147	/*
	148	* Truncate the stream file's size to the minimum required to
	149	* fit the last packet as we might have grown it too much during
	150	* the last memory map.
	151	*/
	152	do {
	153	ret = ftruncate(ctfser->fd, ctfser->stream_size_bytes);
	154	} while (ret == -1 && errno == EINTR);
	155
	156	if (ret) {
	157	BT_LOGE_ERRNO("Failed to truncate stream file",
	158	": ret=%d, size-bytes=%" PRIu64,
	159	ret, ctfser->stream_size_bytes);
	160	goto end;
	161	}
	162
	163	if (ctfser->base_mma) {
	164	/* Unmap old base */
	165	ret = munmap_align(ctfser->base_mma);
	166	if (ret) {
	167	BT_LOGE_ERRNO("Failed to unmap stream file",
	168	": ret=%d, size-bytes=%" PRIu64,
	169	ret, ctfser->stream_size_bytes);
	170	goto end;
	171	}
	172
	173	ctfser->base_mma = NULL;
	174	}
	175
	176	ret = close(ctfser->fd);
	177	if (ret) {
	178	BT_LOGE_ERRNO("Failed to close stream file",
	179	": ret=%d", ret);
	180	goto end;
	181	}
	182
	183	ctfser->fd = -1;
	184
	185	free_path:
	186	if (ctfser->path) {
	187	g_string_free(ctfser->path, TRUE);
188	ctfser->path = NULL;
189	}
190
191	end:
192	return ret;
193	}
194
195	BT_HIDDEN
196	int bt_ctfser_open_packet(struct bt_ctfser *ctfser)
197	{
198	int ret = 0;
199
3f7d4d90	200	BT_LOGD("Opening packet: path=\"%s\", fd=%d, "
013f35c6 PP	201	"prev-packet-size-bytes=%" PRIu64,
	202	ctfser->path->str, ctfser->fd,
	203	ctfser->prev_packet_size_bytes);
	204
	205	if (ctfser->base_mma) {
	206	/* Unmap old base (previous packet) */
	207	ret = munmap_align(ctfser->base_mma);
	208	if (ret) {
	209	BT_LOGE_ERRNO("Failed to unmap stream file",
	210	": ret=%d, size-bytes=%" PRIu64,
	211	ret, ctfser->stream_size_bytes);
	212	goto end;
	213	}
	214
	215	ctfser->base_mma = NULL;
	216	}
	217
	218	/*
	219	* Add the previous packet's size to the memory map address
	220	* offset to start writing immediately after it.
	221	*/
	222	ctfser->mmap_offset += ctfser->prev_packet_size_bytes;
	223	ctfser->prev_packet_size_bytes = 0;
	224
	225	/* Make initial space for the current packet */
86d8b7b8 PP	226	ctfser->cur_packet_size_bytes = get_packet_size_increment_bytes(
86d8b7b8 PP	227	ctfser);
013f35c6 PP	228
	229	do {
	230	ret = bt_posix_fallocate(ctfser->fd, ctfser->mmap_offset,
	231	ctfser->cur_packet_size_bytes);
	232	} while (ret == EINTR);
	233
	234	if (ret) {
	235	BT_LOGE("Failed to preallocate memory space: ret=%d", ret);
	236	goto end;
	237	}
	238
	239	/* Start writing at the beginning of the current packet */
	240	ctfser->offset_in_cur_packet_bits = 0;
	241
	242	/* Get new base address */
	243	mmap_align_ctfser(ctfser);
	244	if (ctfser->base_mma == MAP_FAILED) {
	245	BT_LOGE_ERRNO("Failed to perform an aligned memory mapping",
	246	": ret=%d", ret);
	247	ret = -1;
	248	goto end;
	249	}
	250
3f7d4d90	251	BT_LOGD("Opened packet: path=\"%s\", fd=%d, "
013f35c6 PP	252	"cur-packet-size-bytes=%" PRIu64,
	253	ctfser->path->str, ctfser->fd,
	254	ctfser->cur_packet_size_bytes);
	255
	256	end:
	257	return ret;
	258	}
	259
	260	BT_HIDDEN
	261	void bt_ctfser_close_current_packet(struct bt_ctfser *ctfser,
	262	uint64_t packet_size_bytes)
	263	{
3f7d4d90	264	BT_LOGD("Closing packet: path=\"%s\", fd=%d, "
013f35c6 PP	265	"offset-in-cur-packet-bits=%" PRIu64
	266	"cur-packet-size-bytes=%" PRIu64,
	267	ctfser->path->str, ctfser->fd,
	268	ctfser->offset_in_cur_packet_bits,
	269	ctfser->cur_packet_size_bytes);
	270
	271	/*
	272	* This will be used during the next call to
	273	* bt_ctfser_open_packet(): we add
	274	* `ctfser->prev_packet_size_bytes` to the current memory map
	275	* address offset (first byte of _this_ packet), effectively
	276	* making _this_ packet the required size.
	277	*/
	278	ctfser->prev_packet_size_bytes = packet_size_bytes;
	279	ctfser->stream_size_bytes += packet_size_bytes;
3f7d4d90	280	BT_LOGD("Closed packet: path=\"%s\", fd=%d, "
013f35c6 PP	281	"stream-file-size-bytes=%" PRIu64,
	282	ctfser->path->str, ctfser->fd,
	283	ctfser->stream_size_bytes);
	284	}