2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <sys/types.h>
26 #include <common/common.h>
27 #include <common/defaults.h>
28 #include <common/compat/endian.h>
29 #include <common/utils.h>
34 * Create the index file associated with a trace file.
36 * Return fd on success, a negative value on error.
38 int index_create_file(char *path_name
, char *stream_name
, int uid
, int gid
,
39 uint64_t size
, uint64_t count
)
43 struct ctf_packet_index_file_hdr hdr
;
44 char fullpath
[PATH_MAX
];
46 ret
= snprintf(fullpath
, sizeof(fullpath
), "%s/" DEFAULT_INDEX_DIR
,
49 PERROR("snprintf index path");
53 /* Create index directory if necessary. */
54 ret
= utils_mkdir(fullpath
, S_IRWXU
| S_IRWXG
, uid
, gid
);
57 PERROR("Index trace directory creation error");
63 * For tracefile rotation. We need to unlink the old
64 * file if present to synchronize with the tail of the
65 * live viewer which could be working on this same file.
66 * By doing so, any reference to the old index file
67 * stays valid even if we re-create a new file with the
68 * same name afterwards.
70 ret
= utils_unlink_stream_file(fullpath
, stream_name
, size
, count
, uid
,
71 gid
, DEFAULT_INDEX_FILE_SUFFIX
);
72 if (ret
< 0 && errno
!= ENOENT
) {
75 ret
= utils_create_stream_file(fullpath
, stream_name
, size
, count
, uid
,
76 gid
, DEFAULT_INDEX_FILE_SUFFIX
);
82 hdr
.magic
= htobe32(CTF_INDEX_MAGIC
);
83 hdr
.index_major
= htobe32(CTF_INDEX_MAJOR
);
84 hdr
.index_minor
= htobe32(CTF_INDEX_MINOR
);
85 hdr
.packet_index_len
= htobe32(sizeof(struct ctf_packet_index
));
87 size_ret
= lttng_write(fd
, &hdr
, sizeof(hdr
));
88 if (size_ret
< sizeof(hdr
)) {
89 PERROR("write index header");
100 close_ret
= close(fd
);
102 PERROR("close index fd");
109 * Write index values to the given fd of size len.
111 * Return "len" on success or else < len on error. errno contains error
114 ssize_t
index_write(int fd
, struct ctf_packet_index
*index
, size_t len
)
125 ret
= lttng_write(fd
, index
, len
);
127 PERROR("writing index file");
135 * Open index file using a given path, channel name and tracefile count.
137 * Return read only FD on success or else a negative value.
139 int index_open(const char *path_name
, const char *channel_name
,
140 uint64_t tracefile_count
, uint64_t tracefile_count_current
)
144 char fullpath
[PATH_MAX
];
145 struct ctf_packet_index_file_hdr hdr
;
148 assert(channel_name
);
150 if (tracefile_count
> 0) {
151 ret
= snprintf(fullpath
, sizeof(fullpath
), "%s/" DEFAULT_INDEX_DIR
"/%s_%"
152 PRIu64 DEFAULT_INDEX_FILE_SUFFIX
, path_name
,
153 channel_name
, tracefile_count_current
);
155 ret
= snprintf(fullpath
, sizeof(fullpath
), "%s/" DEFAULT_INDEX_DIR
"/%s"
156 DEFAULT_INDEX_FILE_SUFFIX
, path_name
, channel_name
);
159 PERROR("snprintf index path");
163 DBG("Index opening file %s in read only", fullpath
);
164 read_fd
= open(fullpath
, O_RDONLY
);
166 if (errno
== ENOENT
) {
169 PERROR("opening index in read-only");
174 read_len
= lttng_read(read_fd
, &hdr
, sizeof(hdr
));
176 PERROR("Reading index header");
180 if (be32toh(hdr
.magic
) != CTF_INDEX_MAGIC
) {
181 ERR("Invalid header magic");
184 if (be32toh(hdr
.index_major
) != CTF_INDEX_MAJOR
||
185 be32toh(hdr
.index_minor
) != CTF_INDEX_MINOR
) {
186 ERR("Invalid header version");
196 close_ret
= close(read_fd
);
198 PERROR("close read fd %d", read_fd
);