[lttng-tools.git] / src / common / index / index.c

/*
 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
 *                      David Goulet <dgoulet@efficios.com>
 *               2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _LGPL_SOURCE
#include <assert.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>

#include <common/common.h>
#include <common/defaults.h>
#include <common/compat/endian.h>
#include <common/utils.h>

#include "index.h"

/*
 * Create the index file associated with a trace file.
 *
 * Return allocated struct lttng_index_file, NULL on error.
 */
struct lttng_index_file *lttng_index_file_create(const char *path_name,
		char *stream_name, int uid, int gid,
		uint64_t size, uint64_t count, uint32_t major, uint32_t minor)
{
	struct lttng_index_file *index_file;
	int ret, fd = -1;
	ssize_t size_ret;
	struct ctf_packet_index_file_hdr hdr;
	char fullpath[PATH_MAX];
	uint32_t element_len = ctf_packet_index_len(major, minor);

	index_file = zmalloc(sizeof(*index_file));
	if (!index_file) {
		PERROR("allocating lttng_index_file");
		goto error;
	}

	ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR,
			path_name);
	if (ret < 0) {
		PERROR("snprintf index path");
		goto error;
	}

	/* Create index directory if necessary. */
	ret = utils_mkdir(fullpath, S_IRWXU | S_IRWXG, uid, gid);
	if (ret < 0) {
		if (errno != EEXIST) {
			PERROR("Index trace directory creation error");
			goto error;
		}
	}

	/*
	 * For tracefile rotation. We need to unlink the old
	 * file if present to synchronize with the tail of the
	 * live viewer which could be working on this same file.
	 * By doing so, any reference to the old index file
	 * stays valid even if we re-create a new file with the
	 * same name afterwards.
	 */
	ret = utils_unlink_stream_file(fullpath, stream_name, size, count, uid,
			gid, DEFAULT_INDEX_FILE_SUFFIX);
	if (ret < 0 && errno != ENOENT) {
		goto error;
	}
	ret = utils_create_stream_file(fullpath, stream_name, size, count, uid,
			gid, DEFAULT_INDEX_FILE_SUFFIX);
	if (ret < 0) {
		goto error;
	}
	fd = ret;

	ctf_packet_index_file_hdr_init(&hdr, major, minor);
	size_ret = lttng_write(fd, &hdr, sizeof(hdr));
	if (size_ret < sizeof(hdr)) {
		PERROR("write index header");
		goto error;
	}
	index_file->fd = fd;
	index_file->major = major;
	index_file->minor = minor;
	index_file->element_len = element_len;
	urcu_ref_init(&index_file->ref);

	return index_file;

error:
	if (fd >= 0) {
		int close_ret;

		close_ret = close(fd);
		if (close_ret < 0) {
			PERROR("close index fd");
		}
	}
	free(index_file);
	return NULL;
}

/*
 * Write index values to the given index file.
 *
 * Return 0 on success, -1 on error.
 */
int lttng_index_file_write(const struct lttng_index_file *index_file,
		const struct ctf_packet_index *element)
{
	int fd;
	size_t len;
	ssize_t ret;

	assert(index_file);
	assert(element);

	fd = index_file->fd;
	len = index_file->element_len;

	if (fd < 0) {
		goto error;
	}

	ret = lttng_write(fd, element, len);
	if (ret < len) {
		PERROR("writing index file");
		goto error;
	}
	return 0;

error:
	return -1;
}

/*
 * Read index values from the given index file.
 *
 * Return 0 on success, -1 on error.
 */
int lttng_index_file_read(const struct lttng_index_file *index_file,
		struct ctf_packet_index *element)
{
	ssize_t ret;
	int fd = index_file->fd;
	size_t len = index_file->element_len;

	assert(element);

	if (fd < 0) {
		goto error;
	}

	ret = lttng_read(fd, element, len);
	if (ret < 0) {
		PERROR("read index file");
		goto error;
	}
	if (ret < len) {
		ERR("lttng_read expected %zu, returned %zd", len, ret);
		goto error;
	}
	return 0;

error:
	return -1;
}

/*
 * Open index file using a given path, channel name and tracefile count.
 *
 * Return allocated struct lttng_index_file, NULL on error.
 */
struct lttng_index_file *lttng_index_file_open(const char *path_name,
		const char *channel_name, uint64_t tracefile_count,
		uint64_t tracefile_count_current)
{
	struct lttng_index_file *index_file;
	int ret, read_fd;
	ssize_t read_len;
	char fullpath[PATH_MAX];
	struct ctf_packet_index_file_hdr hdr;
	uint32_t major, minor, element_len;

	assert(path_name);
	assert(channel_name);

	index_file = zmalloc(sizeof(*index_file));
	if (!index_file) {
		PERROR("allocating lttng_index_file");
		goto error;
	}

	if (tracefile_count > 0) {
		ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR "/%s_%"
				PRIu64 DEFAULT_INDEX_FILE_SUFFIX, path_name,
				channel_name, tracefile_count_current);
	} else {
		ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR "/%s"
				DEFAULT_INDEX_FILE_SUFFIX, path_name, channel_name);
	}
	if (ret < 0) {
		PERROR("snprintf index path");
		goto error;
	}

	DBG("Index opening file %s in read only", fullpath);
	read_fd = open(fullpath, O_RDONLY);
	if (read_fd < 0) {
		PERROR("opening index in read-only");
		goto error;
	}

	read_len = lttng_read(read_fd, &hdr, sizeof(hdr));
	if (read_len < 0) {
		PERROR("Reading index header");
		goto error_close;
	}

	if (be32toh(hdr.magic) != CTF_INDEX_MAGIC) {
		ERR("Invalid header magic");
		goto error_close;
	}
	major = be32toh(hdr.index_major);
	minor = be32toh(hdr.index_minor);
	element_len = be32toh(hdr.packet_index_len);

	if (major != CTF_INDEX_MAJOR) {
		ERR("Invalid header version");
		goto error_close;
	}
	if (element_len > sizeof(struct ctf_packet_index)) {
		ERR("Index element length too long");
		goto error_close;
	}

	index_file->fd = read_fd;
	index_file->major = major;
	index_file->minor = minor;
	index_file->element_len = element_len;
	urcu_ref_init(&index_file->ref);

	return index_file;

error_close:
	if (read_fd >= 0) {
		int close_ret;

		close_ret = close(read_fd);
		if (close_ret < 0) {
			PERROR("close read fd %d", read_fd);
		}
	}

error:
	free(index_file);
	return NULL;
}

void lttng_index_file_get(struct lttng_index_file *index_file)
{
	urcu_ref_get(&index_file->ref);
}

static void lttng_index_file_release(struct urcu_ref *ref)
{
	struct lttng_index_file *index_file = caa_container_of(ref,
			struct lttng_index_file, ref);

	if (close(index_file->fd)) {
		PERROR("close index fd");
	}
	free(index_file);
}

void lttng_index_file_put(struct lttng_index_file *index_file)
{
	urcu_ref_put(&index_file->ref, lttng_index_file_release);
}
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
	3	* David Goulet <dgoulet@efficios.com>
	4	* 2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License, version 2 only, as
	8	* published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	15	* You should have received a copy of the GNU General Public License along with
	16	* this program; if not, write to the Free Software Foundation, Inc., 51
	17	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	18	*/
	19
	20	#define _LGPL_SOURCE
	21	#include <assert.h>
	22	#include <sys/stat.h>
	23	#include <sys/types.h>
	24	#include <fcntl.h>
	25
	26	#include <common/common.h>
	27	#include <common/defaults.h>
	28	#include <common/compat/endian.h>
	29	#include <common/utils.h>
	30
	31	#include "index.h"
	32
	33	/*
	34	* Create the index file associated with a trace file.
	35	*
	36	* Return allocated struct lttng_index_file, NULL on error.
	37	*/
	38	struct lttng_index_file lttng_index_file_create(const char path_name,
	39	char *stream_name, int uid, int gid,
	40	uint64_t size, uint64_t count, uint32_t major, uint32_t minor)
	41	{
	42	struct lttng_index_file *index_file;
	43	int ret, fd = -1;
	44	ssize_t size_ret;
	45	struct ctf_packet_index_file_hdr hdr;
	46	char fullpath[PATH_MAX];
	47	uint32_t element_len = ctf_packet_index_len(major, minor);
	48
	49	index_file = zmalloc(sizeof(*index_file));
	50	if (!index_file) {
	51	PERROR("allocating lttng_index_file");
	52	goto error;
	53	}
	54
	55	ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR,
	56	path_name);
	57	if (ret < 0) {
	58	PERROR("snprintf index path");
	59	goto error;
	60	}
	61
	62	/* Create index directory if necessary. */
	63	ret = utils_mkdir(fullpath, S_IRWXU \| S_IRWXG, uid, gid);
	64	if (ret < 0) {
	65	if (errno != EEXIST) {
	66	PERROR("Index trace directory creation error");
	67	goto error;
	68	}
	69	}
	70
	71	/*
	72	* For tracefile rotation. We need to unlink the old
	73	* file if present to synchronize with the tail of the
	74	* live viewer which could be working on this same file.
	75	* By doing so, any reference to the old index file
	76	* stays valid even if we re-create a new file with the
	77	* same name afterwards.
	78	*/
	79	ret = utils_unlink_stream_file(fullpath, stream_name, size, count, uid,
	80	gid, DEFAULT_INDEX_FILE_SUFFIX);
	81	if (ret < 0 && errno != ENOENT) {
	82	goto error;
	83	}
	84	ret = utils_create_stream_file(fullpath, stream_name, size, count, uid,
	85	gid, DEFAULT_INDEX_FILE_SUFFIX);
	86	if (ret < 0) {
	87	goto error;
	88	}
	89	fd = ret;
	90
	91	ctf_packet_index_file_hdr_init(&hdr, major, minor);
	92	size_ret = lttng_write(fd, &hdr, sizeof(hdr));
	93	if (size_ret < sizeof(hdr)) {
	94	PERROR("write index header");
	95	goto error;
	96	}
	97	index_file->fd = fd;
	98	index_file->major = major;
	99	index_file->minor = minor;
	100	index_file->element_len = element_len;
	101	urcu_ref_init(&index_file->ref);
	102
	103	return index_file;
	104
	105	error:
	106	if (fd >= 0) {
	107	int close_ret;
	108
	109	close_ret = close(fd);
	110	if (close_ret < 0) {
	111	PERROR("close index fd");
	112	}
	113	}
	114	free(index_file);
	115	return NULL;
	116	}
	117
	118	/*
	119	* Write index values to the given index file.
	120	*
	121	* Return 0 on success, -1 on error.
	122	*/
	123	int lttng_index_file_write(const struct lttng_index_file *index_file,
	124	const struct ctf_packet_index *element)
	125	{
	126	int fd;
	127	size_t len;
	128	ssize_t ret;
	129
	130	assert(index_file);
	131	assert(element);
	132
	133	fd = index_file->fd;
	134	len = index_file->element_len;
	135
	136	if (fd < 0) {
	137	goto error;
	138	}
	139
	140	ret = lttng_write(fd, element, len);
	141	if (ret < len) {
	142	PERROR("writing index file");
	143	goto error;
	144	}
	145	return 0;
	146
	147	error:
	148	return -1;
	149	}
	150
	151	/*
	152	* Read index values from the given index file.
	153	*
	154	* Return 0 on success, -1 on error.
	155	*/
	156	int lttng_index_file_read(const struct lttng_index_file *index_file,
	157	struct ctf_packet_index *element)
	158	{
	159	ssize_t ret;
	160	int fd = index_file->fd;
	161	size_t len = index_file->element_len;
	162
	163	assert(element);
	164
	165	if (fd < 0) {
	166	goto error;
	167	}
	168
	169	ret = lttng_read(fd, element, len);
	170	if (ret < 0) {
	171	PERROR("read index file");
	172	goto error;
	173	}
	174	if (ret < len) {
	175	ERR("lttng_read expected %zu, returned %zd", len, ret);
	176	goto error;
	177	}
	178	return 0;
	179
	180	error:
	181	return -1;
	182	}
	183
	184	/*
	185	* Open index file using a given path, channel name and tracefile count.
	186	*
	187	* Return allocated struct lttng_index_file, NULL on error.
	188	*/
	189	struct lttng_index_file lttng_index_file_open(const char path_name,
	190	const char *channel_name, uint64_t tracefile_count,
	191	uint64_t tracefile_count_current)
	192	{
	193	struct lttng_index_file *index_file;
	194	int ret, read_fd;
	195	ssize_t read_len;
	196	char fullpath[PATH_MAX];
	197	struct ctf_packet_index_file_hdr hdr;
	198	uint32_t major, minor, element_len;
	199
	200	assert(path_name);
	201	assert(channel_name);
	202
	203	index_file = zmalloc(sizeof(*index_file));
	204	if (!index_file) {
	205	PERROR("allocating lttng_index_file");
	206	goto error;
	207	}
	208
	209	if (tracefile_count > 0) {
	210	ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR "/%s_%"
	211	PRIu64 DEFAULT_INDEX_FILE_SUFFIX, path_name,
	212	channel_name, tracefile_count_current);
	213	} else {
	214	ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR "/%s"
	215	DEFAULT_INDEX_FILE_SUFFIX, path_name, channel_name);
	216	}
	217	if (ret < 0) {
	218	PERROR("snprintf index path");
	219	goto error;
	220	}
	221
	222	DBG("Index opening file %s in read only", fullpath);
	223	read_fd = open(fullpath, O_RDONLY);
	224	if (read_fd < 0) {
	225	PERROR("opening index in read-only");
	226	goto error;
	227	}
	228
	229	read_len = lttng_read(read_fd, &hdr, sizeof(hdr));
	230	if (read_len < 0) {
	231	PERROR("Reading index header");
	232	goto error_close;
	233	}
	234
	235	if (be32toh(hdr.magic) != CTF_INDEX_MAGIC) {
	236	ERR("Invalid header magic");
	237	goto error_close;
	238	}
	239	major = be32toh(hdr.index_major);
	240	minor = be32toh(hdr.index_minor);
	241	element_len = be32toh(hdr.packet_index_len);
	242
	243	if (major != CTF_INDEX_MAJOR) {
	244	ERR("Invalid header version");
	245	goto error_close;
	246	}
	247	if (element_len > sizeof(struct ctf_packet_index)) {
	248	ERR("Index element length too long");
	249	goto error_close;
	250	}
	251
	252	index_file->fd = read_fd;
	253	index_file->major = major;
	254	index_file->minor = minor;
	255	index_file->element_len = element_len;
	256	urcu_ref_init(&index_file->ref);
	257
	258	return index_file;
	259
	260	error_close:
	261	if (read_fd >= 0) {
	262	int close_ret;
	263
	264	close_ret = close(read_fd);
	265	if (close_ret < 0) {
	266	PERROR("close read fd %d", read_fd);
	267	}
	268	}
	269
	270	error:
	271	free(index_file);
	272	return NULL;
	273	}
	274
	275	void lttng_index_file_get(struct lttng_index_file *index_file)
	276	{
	277	urcu_ref_get(&index_file->ref);
	278	}
	279
	280	static void lttng_index_file_release(struct urcu_ref *ref)
	281	{
	282	struct lttng_index_file *index_file = caa_container_of(ref,
	283	struct lttng_index_file, ref);
	284
	285	if (close(index_file->fd)) {
	286	PERROR("close index fd");
	287	}
	288	free(index_file);
	289	}
	290
	291	void lttng_index_file_put(struct lttng_index_file *index_file)
	292	{
	293	urcu_ref_put(&index_file->ref, lttng_index_file_release);
	294	}