Rename LTTng index in CTF index

Also the magic becomes a uint32_t instead of 6 chars for more aligned
reads.

Apart from the CTF magic changes, this patch only renames stuff so no
behaviour is changed.

Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>
Signed-off-by: David Goulet <dgoulet@efficios.com>

diff --git a/src/bin/lttng-relayd/index.h b/src/bin/lttng-relayd/index.h
index 3ca7263e388b9c904092de56b51b1868fcc92510..9a10cea446e7529553a94588c296c0d867e12e28 100644 (file)
--- a/src/bin/lttng-relayd/index.h
+++ b/src/bin/lttng-relayd/index.h
@@ -36,7 +36,7 @@ struct relay_index {
        int to_close_fd;
 
        /* Index packet data. This is the data that is written on disk. */
-       struct lttng_packet_index index_data;
+       struct ctf_packet_index index_data;
 
        /* key1 = stream_id, key2 = net_seq_num */
        struct lttng_ht_two_u64 key;

diff --git a/src/bin/lttng-relayd/live.c b/src/bin/lttng-relayd/live.c
index 851be9f8e3165c85eb4bcf69bfbeb3d29508dade..cdbb5b12bdb873de53d56b617c25f0f95a9bf01b 100644 (file)
--- a/src/bin/lttng-relayd/live.c
+++ b/src/bin/lttng-relayd/live.c
@@ -614,7 +614,7 @@ static int open_index(struct relay_viewer_stream *stream)
 {
        int ret;
        char fullpath[PATH_MAX];
-       struct lttng_packet_index_file_hdr hdr;
+       struct ctf_packet_index_file_hdr hdr;
 
        if (stream->tracefile_count > 0) {
                ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR "/%s_%"
@@ -649,13 +649,13 @@ static int open_index(struct relay_viewer_stream *stream)
                PERROR("Reading index header");
                goto error;
        }
-       if (strncmp(hdr.magic, INDEX_MAGIC, sizeof(hdr.magic)) != 0) {
+       if (be32toh(hdr.magic) != CTF_INDEX_MAGIC) {
                ERR("Invalid header magic");
                ret = -1;
                goto error;
        }
-       if (be32toh(hdr.index_major) != INDEX_MAJOR ||
-                       be32toh(hdr.index_minor) != INDEX_MINOR) {
+       if (be32toh(hdr.index_major) != CTF_INDEX_MAJOR ||
+                       be32toh(hdr.index_minor) != CTF_INDEX_MINOR) {
                ERR("Invalid header version");
                ret = -1;
                goto error;
@@ -747,7 +747,7 @@ int init_viewer_stream(struct relay_stream *stream, int seek_last)
        if (seek_last && viewer_stream->index_read_fd > 0) {
                ret = lseek(viewer_stream->index_read_fd,
                                viewer_stream->total_index_received *
-                                       sizeof(struct lttng_packet_index),
+                                       sizeof(struct ctf_packet_index),
                                SEEK_CUR);
                if (ret < 0) {
                        goto error;
@@ -1075,7 +1075,7 @@ int viewer_get_next_index(struct relay_command *cmd,
        int ret;
        struct lttng_viewer_get_next_index request_index;
        struct lttng_viewer_index viewer_index;
-       struct lttng_packet_index packet_index;
+       struct ctf_packet_index packet_index;
        struct relay_viewer_stream *vstream;
        struct relay_stream *rstream;
 

diff --git a/src/bin/lttng-relayd/lttng-relayd.h b/src/bin/lttng-relayd/lttng-relayd.h
index f22b115c9d037e78c0737b10f2f7861e9efeb21e..6840aba31edda4c7c2181613ce35c06d081ca73f 100644 (file)
--- a/src/bin/lttng-relayd/lttng-relayd.h
+++ b/src/bin/lttng-relayd/lttng-relayd.h
@@ -25,7 +25,7 @@
 #include <urcu/wfqueue.h>
 
 #include <common/hashtable/hashtable.h>
-#include <common/index/lttng-index.h>
+#include <common/index/ctf-index.h>
 
 #include "ctf-trace.h"
 

diff --git a/src/common/consumer-stream.c b/src/common/consumer-stream.c
index 063ba50ab12eb968e4ee81c4f49cadefcb7f3d90..422dd0daa55929a7058e163977bcc05d7bba371e 100644 (file)
--- a/src/common/consumer-stream.c
+++ b/src/common/consumer-stream.c
@@ -331,7 +331,7 @@ void consumer_stream_destroy(struct lttng_consumer_stream *stream,
  * Return 0 on success or else a negative value.
  */
 int consumer_stream_write_index(struct lttng_consumer_stream *stream,
-               struct lttng_packet_index *index)
+               struct ctf_packet_index *index)
 {
        int ret;
        struct consumer_relayd_sock_pair *relayd;
@@ -348,8 +348,8 @@ int consumer_stream_write_index(struct lttng_consumer_stream *stream,
                ssize_t size_ret;
 
                size_ret = index_write(stream->index_fd, index,
-                               sizeof(struct lttng_packet_index));
-               if (size_ret < sizeof(struct lttng_packet_index)) {
+                               sizeof(struct ctf_packet_index));
+               if (size_ret < sizeof(struct ctf_packet_index)) {
                        ret = -1;
                } else {
                        ret = 0;

diff --git a/src/common/consumer-stream.h b/src/common/consumer-stream.h
index 79efa721e80388a934343254e56a8ac3a602dd8b..c5fb09732d7a94f065480b01bedd4f683e0daf39 100644 (file)
--- a/src/common/consumer-stream.h
+++ b/src/common/consumer-stream.h
@@ -72,7 +72,7 @@ void consumer_stream_destroy_buffers(struct lttng_consumer_stream *stream);
  * Write index of a specific stream either on the relayd or local disk.
  */
 int consumer_stream_write_index(struct lttng_consumer_stream *stream,
-               struct lttng_packet_index *index);
+               struct ctf_packet_index *index);
 
 int consumer_stream_sync_metadata(struct lttng_consumer_local_data *ctx,
                uint64_t session_id);

diff --git a/src/common/consumer-timer.c b/src/common/consumer-timer.c
index b97cb28443a99232550de4d543b2607896452ead..b681ae763379deaa55d68da8f6113b7b99b87eb3 100644 (file)
--- a/src/common/consumer-timer.c
+++ b/src/common/consumer-timer.c
@@ -115,7 +115,7 @@ static void metadata_switch_timer(struct lttng_consumer_local_data *ctx,
 static int send_empty_index(struct lttng_consumer_stream *stream, uint64_t ts)
 {
        int ret;
-       struct lttng_packet_index index;
+       struct ctf_packet_index index;
 
        memset(&index, 0, sizeof(index));
        index.timestamp_end = htobe64(ts);

diff --git a/src/common/consumer.c b/src/common/consumer.c
index 152064078d34b354263a79992e93d965a5b738a4..341f8a7fe4ecf29a570b0d577156385242d64012 100644 (file)
--- a/src/common/consumer.c
+++ b/src/common/consumer.c
@@ -1354,7 +1354,7 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap(
                struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream, unsigned long len,
                unsigned long padding,
-               struct lttng_packet_index *index)
+               struct ctf_packet_index *index)
 {
        unsigned long mmap_offset;
        void *mmap_base;
@@ -1562,7 +1562,7 @@ ssize_t lttng_consumer_on_read_subbuffer_splice(
                struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream, unsigned long len,
                unsigned long padding,
-               struct lttng_packet_index *index)
+               struct ctf_packet_index *index)
 {
        ssize_t ret = 0, written = 0, ret_splice = 0;
        loff_t offset = 0;

diff --git a/src/common/consumer.h b/src/common/consumer.h
index aef7f560e4dcae78e62343eae1492de6ea85434b..c206970bfdc778467bcdb0aa08c872d47b739ec4 100644 (file)
--- a/src/common/consumer.h
+++ b/src/common/consumer.h
@@ -32,7 +32,7 @@
 #include <common/compat/uuid.h>
 #include <common/sessiond-comm/sessiond-comm.h>
 #include <common/pipe.h>
-#include <common/index/lttng-index.h>
+#include <common/index/ctf-index.h>
 
 /* Commands for consumer */
 enum lttng_consumer_command {
@@ -611,12 +611,12 @@ ssize_t lttng_consumer_on_read_subbuffer_mmap(
                struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream, unsigned long len,
                unsigned long padding,
-               struct lttng_packet_index *index);
+               struct ctf_packet_index *index);
 ssize_t lttng_consumer_on_read_subbuffer_splice(
                struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream, unsigned long len,
                unsigned long padding,
-               struct lttng_packet_index *index);
+               struct ctf_packet_index *index);
 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
                unsigned long *pos);

diff --git a/src/common/index/Makefile.am b/src/common/index/Makefile.am
index 104d99c5097587abc46b75bce484ee1cbe1ef04b..054b0aa54bb9457e50cd4236dcaf8f0831606723 100644 (file)
--- a/src/common/index/Makefile.am
+++ b/src/common/index/Makefile.am
@@ -2,4 +2,4 @@ AM_CPPFLAGS = -I$(top_srcdir)/include -I$(top_srcdir)/src
 
 noinst_LTLIBRARIES = libindex.la
 
-libindex_la_SOURCES = index.c index.h lttng-index.h
+libindex_la_SOURCES = index.c index.h ctf-index.h

diff --git a/src/common/index/ctf-index.h b/src/common/index/ctf-index.h
new file mode 100644 (file)
index 0000000..0efa888
--- /dev/null
+++ b/src/common/index/ctf-index.h
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
+ *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *                      David Goulet <dgoulet@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.
+ */
+
+#ifndef LTTNG_INDEX_H
+#define LTTNG_INDEX_H
+
+#include <limits.h>
+
+#define CTF_INDEX_MAGIC 0xC1F1DCC1
+#define CTF_INDEX_MAJOR 1
+#define CTF_INDEX_MINOR 0
+
+/*
+ * Header at the beginning of each index file.
+ * All integer fields are stored in big endian.
+ */
+struct ctf_packet_index_file_hdr {
+       uint32_t magic;
+       uint32_t index_major;
+       uint32_t index_minor;
+       /* struct packet_index_len, in bytes */
+       uint32_t packet_index_len;
+} __attribute__((__packed__));
+
+/*
+ * Packet index generated for each trace packet store in a trace file.
+ * All integer fields are stored in big endian.
+ */
+struct ctf_packet_index {
+       uint64_t offset;                /* offset of the packet in the file, in bytes */
+       uint64_t packet_size;           /* packet size, in bits */
+       uint64_t content_size;          /* content size, in bits */
+       uint64_t timestamp_begin;
+       uint64_t timestamp_end;
+       uint64_t events_discarded;
+       uint64_t stream_id;
+} __attribute__((__packed__));
+
+#endif /* LTTNG_INDEX_H */

diff --git a/src/common/index/index.c b/src/common/index/index.c
index cddc58c09de1726b8322816b4eb3f308dace03f3..2946f7bab3335e5456d9628d9e0a3c6707e0eca6 100644 (file)
--- a/src/common/index/index.c
+++ b/src/common/index/index.c
@@ -36,7 +36,7 @@ int index_create_file(char *path_name, char *stream_name, int uid, int gid,
 {
        int ret, fd = -1;
        ssize_t size_ret;
-       struct lttng_packet_index_file_hdr hdr;
+       struct ctf_packet_index_file_hdr hdr;
        char fullpath[PATH_MAX];
 
        ret = snprintf(fullpath, sizeof(fullpath), "%s/" DEFAULT_INDEX_DIR,
@@ -62,9 +62,10 @@ int index_create_file(char *path_name, char *stream_name, int uid, int gid,
        }
        fd = ret;
 
-       memcpy(hdr.magic, INDEX_MAGIC, sizeof(hdr.magic));
-       hdr.index_major = htobe32(INDEX_MAJOR);
-       hdr.index_minor = htobe32(INDEX_MINOR);
+       hdr.magic = htobe32(CTF_INDEX_MAGIC);
+       hdr.index_major = htobe32(CTF_INDEX_MAJOR);
+       hdr.index_minor = htobe32(CTF_INDEX_MINOR);
+       hdr.packet_index_len = sizeof(struct ctf_packet_index);
 
        size_ret = lttng_write(fd, &hdr, sizeof(hdr));
        if (size_ret < sizeof(hdr)) {
@@ -93,7 +94,7 @@ error:
  * Return "len" on success or else < len on error. errno contains error
  * details.
  */
-ssize_t index_write(int fd, struct lttng_packet_index *index, size_t len)
+ssize_t index_write(int fd, struct ctf_packet_index *index, size_t len)
 {
        ssize_t ret;
 

diff --git a/src/common/index/index.h b/src/common/index/index.h
index 4ffc526598e11d6b65b1b00516d63d0cd2065866..744fe0107f82e22a1f73c4fb208beec964012dab 100644 (file)
--- a/src/common/index/index.h
+++ b/src/common/index/index.h
@@ -21,10 +21,10 @@
 
 #include <inttypes.h>
 
-#include "lttng-index.h"
+#include "ctf-index.h"
 
 int index_create_file(char *path_name, char *stream_name, int uid, int gid,
                uint64_t size, uint64_t count);
-ssize_t index_write(int fd, struct lttng_packet_index *index, size_t len);
+ssize_t index_write(int fd, struct ctf_packet_index *index, size_t len);
 
 #endif /* _INDEX_H */

diff --git a/src/common/index/lttng-index.h b/src/common/index/lttng-index.h
deleted file mode 100644 (file)
index 4327cbd..0000000
--- a/src/common/index/lttng-index.h
+++ /dev/null
@@ -1,58 +0,0 @@
-/*
- * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
- *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *                      David Goulet <dgoulet@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.
- */
-
-#ifndef LTTNG_INDEX_H
-#define LTTNG_INDEX_H
-
-#include <limits.h>
-
-#define INDEX_MAGIC "CTFIDX"
-#define INDEX_MAJOR 1
-#define INDEX_MINOR 0
-
-/*
- * Header at the beginning of each index file.
- * All integer fields are stored in big endian.
- */
-struct lttng_packet_index_file_hdr {
-       char magic[6];
-       uint32_t index_major;
-       uint32_t index_minor;
-} __attribute__((__packed__));
-
-/*
- * Packet index generated for each trace packet store in a trace file.
- * All integer fields are stored in big endian.
- */
-struct lttng_packet_index {
-       uint64_t offset;                /* offset of the packet in the file, in bytes */
-       uint64_t packet_size;           /* packet size, in bits */
-       uint64_t content_size;          /* content size, in bits */
-       uint64_t timestamp_begin;
-       uint64_t timestamp_end;
-       uint64_t events_discarded;
-       uint64_t stream_id;
-} __attribute__((__packed__));
-
-#endif /* LTTNG_INDEX_H */

diff --git a/src/common/kernel-consumer/kernel-consumer.c b/src/common/kernel-consumer/kernel-consumer.c
index 1b01d414a0248b0207bbf72aba620a8fa62b93e4..219da903781a25e5af5307e24aba5347d90e30c9 100644 (file)
--- a/src/common/kernel-consumer/kernel-consumer.c
+++ b/src/common/kernel-consumer/kernel-consumer.c
@@ -911,7 +911,7 @@ error_fatal:
  *
  * Return 0 on success or else a negative value.
  */
-static int get_index_values(struct lttng_packet_index *index, int infd)
+static int get_index_values(struct ctf_packet_index *index, int infd)
 {
        int ret;
 
@@ -1007,7 +1007,7 @@ ssize_t lttng_kconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
        int err, write_index = 1;
        ssize_t ret = 0;
        int infd = stream->wait_fd;
-       struct lttng_packet_index index;
+       struct ctf_packet_index index;
 
        DBG("In read_subbuffer (infd : %d)", infd);
 

diff --git a/src/common/relayd/relayd.c b/src/common/relayd/relayd.c
index ce46c9c54504645b9ff74827eea4151b41405fda..448d19e6e30c2a16b89f3732147659b8159cf051 100644 (file)
--- a/src/common/relayd/relayd.c
+++ b/src/common/relayd/relayd.c
@@ -26,7 +26,7 @@
 #include <common/common.h>
 #include <common/defaults.h>
 #include <common/sessiond-comm/relayd.h>
-#include <common/index/lttng-index.h>
+#include <common/index/ctf-index.h>
 
 #include "relayd.h"
 
@@ -734,7 +734,7 @@ error:
  * Send index to the relayd.
  */
 int relayd_send_index(struct lttcomm_relayd_sock *rsock,
-               struct lttng_packet_index *index, uint64_t relay_stream_id,
+               struct ctf_packet_index *index, uint64_t relay_stream_id,
                uint64_t net_seq_num)
 {
        int ret;

diff --git a/src/common/relayd/relayd.h b/src/common/relayd/relayd.h
index d12d7a495d80fdb3e19e191d49b7f22e010125c1..e61b2fff214ec698d67fb37696a0a673edafda67 100644 (file)
--- a/src/common/relayd/relayd.h
+++ b/src/common/relayd/relayd.h
@@ -46,7 +46,7 @@ int relayd_begin_data_pending(struct lttcomm_relayd_sock *sock, uint64_t id);
 int relayd_end_data_pending(struct lttcomm_relayd_sock *sock, uint64_t id,
                unsigned int *is_data_inflight);
 int relayd_send_index(struct lttcomm_relayd_sock *rsock,
-               struct lttng_packet_index *index, uint64_t relay_stream_id,
+               struct ctf_packet_index *index, uint64_t relay_stream_id,
                uint64_t net_seq_num);
 
 #endif /* _RELAYD_H */

diff --git a/src/common/sessiond-comm/relayd.h b/src/common/sessiond-comm/relayd.h
index 24c4c6e84336584f986921bddbdbf212b9ad686b..ff56d3a26fe1aff3bec9b678b020cea0da4c6de7 100644 (file)
--- a/src/common/sessiond-comm/relayd.h
+++ b/src/common/sessiond-comm/relayd.h
@@ -26,7 +26,7 @@
 
 #include <lttng/lttng.h>
 #include <common/defaults.h>
-#include <common/index/lttng-index.h>
+#include <common/index/ctf-index.h>
 #include <config.h>
 
 #define RELAYD_VERSION_COMM_MAJOR             VERSION_MAJOR

diff --git a/src/common/ust-consumer/ust-consumer.c b/src/common/ust-consumer/ust-consumer.c
index 79d8fd7a5012373164bbadfe420537fa1e418af5..83aa5986f7f663e122a92f58dd7895836d807149 100644 (file)
--- a/src/common/ust-consumer/ust-consumer.c
+++ b/src/common/ust-consumer/ust-consumer.c
@@ -1711,7 +1711,7 @@ void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
  *
  * Return 0 on success or else a negative value.
  */
-static int get_index_values(struct lttng_packet_index *index,
+static int get_index_values(struct ctf_packet_index *index,
                struct ustctl_consumer_stream *ustream)
 {
        int ret;
@@ -1876,7 +1876,7 @@ int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
        long ret = 0;
        char dummy;
        struct ustctl_consumer_stream *ustream;
-       struct lttng_packet_index index;
+       struct ctf_packet_index index;
 
        assert(stream);
        assert(stream->ustream);

diff --git a/tests/regression/tools/live/live_test.c b/tests/regression/tools/live/live_test.c
index 2482e50048610aa8b4c2ee45da5b939e24232993..75d4e4fdbd9a3f5b41a7f06186dfa2d0b26dabb2 100644 (file)
--- a/tests/regression/tools/live/live_test.c
+++ b/tests/regression/tools/live/live_test.c
@@ -41,7 +41,7 @@
 #include <common/common.h>
 
 #include <bin/lttng-relayd/lttng-viewer.h>
-#include <common/index/lttng-index.h>
+#include <common/index/ctf-index.h>
 
 #define SESSION1 "test1"
 #define RELAYD_URL "net://localhost"