src/common/index/index.h

   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 #ifndef _INDEX_H
  21 #define _INDEX_H
  22
  23 #include <inttypes.h>
  24 #include <urcu/ref.h>
  25
  26 #include <common/trace-chunk.h>
  27 #include "ctf-index.h"
  28
  29 struct lttng_index_file {
  30         int fd;
  31         uint32_t major;
  32         uint32_t minor;
  33         uint32_t element_len;
  34         struct lttng_trace_chunk *trace_chunk;
  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  */
  42 enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk(
  43                 struct lttng_trace_chunk *chunk,
  44                 const char *channel_path, const char *stream_name,
  45                 uint64_t stream_file_size, uint64_t stream_count,
  46                 uint32_t index_major, uint32_t index_minor,
  47                 bool unlink_existing_file, struct lttng_index_file **file);
  48
  49 enum lttng_trace_chunk_status lttng_index_file_create_from_trace_chunk_read_only(
  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,
  53                 uint32_t index_major, uint32_t index_minor,
  54                 bool expect_no_file, struct lttng_index_file **file);
  55
  56 int lttng_index_file_write(const struct lttng_index_file *index_file,
  57                 const struct ctf_packet_index *element);
  58 int lttng_index_file_read(const struct lttng_index_file *index_file,
  59                 struct ctf_packet_index *element);
  60
  61 void lttng_index_file_get(struct lttng_index_file *index_file);
  62 void lttng_index_file_put(struct lttng_index_file *index_file);
  63
  64 #endif /* _INDEX_H */