common: index and trace-chunk file creation/open API change
[lttng-tools.git] / src / common / index / index.h
CommitLineData
309167d2
JD
1/*
2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
f8f3885c 4 * 2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
309167d2
JD
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#ifndef _INDEX_H
21#define _INDEX_H
22
23#include <inttypes.h>
f8f3885c 24#include <urcu/ref.h>
309167d2 25
d2956687 26#include <common/trace-chunk.h>
50adc264 27#include "ctf-index.h"
309167d2 28
f8f3885c
MD
29struct lttng_index_file {
30 int fd;
31 uint32_t major;
32 uint32_t minor;
33 uint32_t element_len;
c35f9726 34 struct lttng_trace_chunk *trace_chunk;
f8f3885c
MD
35 struct urcu_ref ref;
36};
37
38/*
39 * create and open have refcount of 1. Use put to decrement the
40 * refcount. Destroys when reaching 0. Use "get" to increment refcount.
41 */
3ff5c5db 42enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk(
d2956687 43 struct lttng_trace_chunk *chunk,
ebb29c10 44 const char *channel_path, const char *stream_name,
d2956687
JG
45 uint64_t stream_file_size, uint64_t stream_count,
46 uint32_t index_major, uint32_t index_minor,
3ff5c5db
MD
47 bool unlink_existing_file, struct lttng_index_file **file);
48
49enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk_read_only(
ebb29c10
JG
50 struct lttng_trace_chunk *chunk,
51 const char *channel_path, const char *stream_name,
52 uint64_t stream_file_size, uint64_t stream_file_index,
3ff5c5db
MD
53 uint32_t index_major, uint32_t index_minor,
54 bool expect_no_file, struct lttng_index_file **file);
55
f8f3885c
MD
56int lttng_index_file_write(const struct lttng_index_file *index_file,
57 const struct ctf_packet_index *element);
58int lttng_index_file_read(const struct lttng_index_file *index_file,
59 struct ctf_packet_index *element);
60
61void lttng_index_file_get(struct lttng_index_file *index_file);
62void lttng_index_file_put(struct lttng_index_file *index_file);
309167d2
JD
63
64#endif /* _INDEX_H */
This page took 0.042238 seconds and 4 git commands to generate.