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

/*
 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
 * Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _INDEX_H
#define _INDEX_H

#include <inttypes.h>
#include <urcu/ref.h>

#include "ctf-index.h"
#include <common/fs-handle.h>
#include <common/trace-chunk.h>

struct lttng_index_file {
	struct fs_handle *file;
	uint32_t major;
	uint32_t minor;
	uint32_t element_len;
	struct lttng_trace_chunk *trace_chunk;
	struct urcu_ref ref;
};

/*
 * create and open have refcount of 1. Use put to decrement the
 * refcount. Destroys when reaching 0. Use "get" to increment refcount.
 */
enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk(
		struct lttng_trace_chunk *chunk,
		const char *channel_path, const char *stream_name,
		uint64_t stream_file_size, uint64_t stream_count,
		uint32_t index_major, uint32_t index_minor,
		bool unlink_existing_file, struct lttng_index_file **file);

enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk_read_only(
		struct lttng_trace_chunk *chunk,
		const char *channel_path, const char *stream_name,
		uint64_t stream_file_size, uint64_t stream_file_index,
		uint32_t index_major, uint32_t index_minor,
		bool expect_no_file, struct lttng_index_file **file);

int lttng_index_file_write(const struct lttng_index_file *index_file,
		const struct ctf_packet_index *element);
int lttng_index_file_read(const struct lttng_index_file *index_file,
		struct ctf_packet_index *element);

void lttng_index_file_get(struct lttng_index_file *index_file);
void lttng_index_file_put(struct lttng_index_file *index_file);

#endif /* _INDEX_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
	3	* Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
	4	* Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	*
	6	* SPDX-License-Identifier: GPL-2.0-only
	7	*
	8	*/
	9
	10	#ifndef _INDEX_H
	11	#define _INDEX_H
	12
	13	#include <inttypes.h>
	14	#include <urcu/ref.h>
	15
	16	#include "ctf-index.h"
	17	#include <common/fs-handle.h>
	18	#include <common/trace-chunk.h>
	19
	20	struct lttng_index_file {
	21	struct fs_handle *file;
	22	uint32_t major;
	23	uint32_t minor;
	24	uint32_t element_len;
	25	struct lttng_trace_chunk *trace_chunk;
	26	struct urcu_ref ref;
	27	};
	28
	29	/*
	30	* create and open have refcount of 1. Use put to decrement the
	31	* refcount. Destroys when reaching 0. Use "get" to increment refcount.
	32	*/
	33	enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk(
	34	struct lttng_trace_chunk *chunk,
	35	const char channel_path, const char stream_name,
	36	uint64_t stream_file_size, uint64_t stream_count,
	37	uint32_t index_major, uint32_t index_minor,
	38	bool unlink_existing_file, struct lttng_index_file **file);
	39
	40	enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk_read_only(
	41	struct lttng_trace_chunk *chunk,
	42	const char channel_path, const char stream_name,
	43	uint64_t stream_file_size, uint64_t stream_file_index,
	44	uint32_t index_major, uint32_t index_minor,
	45	bool expect_no_file, struct lttng_index_file **file);
	46
	47	int lttng_index_file_write(const struct lttng_index_file *index_file,
	48	const struct ctf_packet_index *element);
	49	int lttng_index_file_read(const struct lttng_index_file *index_file,
	50	struct ctf_packet_index *element);
	51
	52	void lttng_index_file_get(struct lttng_index_file *index_file);
	53	void lttng_index_file_put(struct lttng_index_file *index_file);
	54
	55	#endif /* _INDEX_H */