Cleanup: add missing newline
[babeltrace.git] / converter / babeltrace-log.c
CommitLineData
8c572eba 1/*
b522ac18 2 * babeltrace-log.c
8c572eba 3 *
b522ac18 4 * BabelTrace - Convert Text Log to CTF
8c572eba 5 *
64fa3fec
MD
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8c572eba
MD
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * Depends on glibc 2.10 for getline().
21 */
22
c696b1b1 23#define _GNU_SOURCE
00f7fbf0 24#include <config.h>
90219914
MD
25#include <sys/types.h>
26#include <sys/stat.h>
27#include <fcntl.h>
28#include <sys/mman.h>
989c73bc 29#include <dirent.h>
90219914 30#include <stdio.h>
989c73bc 31#include <stdlib.h>
90219914
MD
32#include <stdint.h>
33#include <unistd.h>
34#include <errno.h>
90219914 35#include <string.h>
fef3bf22 36#include <inttypes.h>
90219914 37
70bd0a12 38#include <babeltrace/babeltrace-internal.h>
8c572eba 39#include <babeltrace/ctf/types.h>
a4dfa07b 40#include <babeltrace/uuid.h>
43e34335 41#include <babeltrace/endian.h>
8c572eba 42
bfe09576 43#define USEC_PER_SEC 1000000UL
ca8b2b02 44
ca8b2b02
MD
45int babeltrace_debug, babeltrace_verbose;
46
47static char *s_outputname;
48static int s_timestamp;
39592eae 49static int s_help;
43e34335 50static unsigned char s_uuid[BABELTRACE_UUID_LEN];
ca8b2b02 51
b522ac18
MD
52/* Metadata format string */
53static const char metadata_fmt[] =
408a2c4d 54"/* CTF 1.8 */\n"
989c73bc
MD
55"typealias integer { size = 8; align = 8; signed = false; } := uint8_t;\n"
56"typealias integer { size = 32; align = 32; signed = false; } := uint32_t;\n"
fef3bf22 57"typealias integer { size = 64; align = 64; signed = false; } := uint64_t;\n"
989c73bc
MD
58"\n"
59"trace {\n"
c818559a
MD
60" major = %u;\n" /* major (e.g. 0) */
61" minor = %u;\n" /* minor (e.g. 1) */
b522ac18 62" uuid = \"%s\";\n" /* UUID */
989c73bc
MD
63" byte_order = %s;\n" /* be or le */
64" packet.header := struct {\n"
65" uint32_t magic;\n"
b4c19c1e 66" uint8_t uuid[16];\n"
989c73bc
MD
67" };\n"
68"};\n"
69"\n"
70"stream {\n"
71" packet.context := struct {\n"
fef3bf22
MD
72" uint64_t content_size;\n"
73" uint64_t packet_size;\n"
989c73bc 74" };\n"
ca8b2b02 75"%s" /* Stream event header (opt.) */
989c73bc
MD
76"};\n"
77"\n"
78"event {\n"
79" name = string;\n"
80" fields := struct { string str; };\n"
81"};\n";
82
ca8b2b02
MD
83static const char metadata_stream_event_header_timestamp[] =
84" typealias integer { size = 64; align = 64; signed = false; } := uint64_t;\n"
85" event.header := struct {\n"
86" uint64_t timestamp;\n"
87" };\n";
8c572eba 88
b522ac18
MD
89static
90void print_metadata(FILE *fp)
91{
a4dfa07b 92 char uuid_str[BABELTRACE_UUID_STR_LEN];
00f7fbf0
MD
93 unsigned int major = 0, minor = 0;
94 int ret;
b522ac18 95
00f7fbf0
MD
96 ret = sscanf(VERSION, "%u.%u", &major, &minor);
97 if (ret != 2)
98 fprintf(stderr, "[warning] Incorrect babeltrace version format\n.");
a4dfa07b 99 babeltrace_uuid_unparse(s_uuid, uuid_str);
b522ac18 100 fprintf(fp, metadata_fmt,
00f7fbf0
MD
101 major,
102 minor,
b522ac18 103 uuid_str,
ca8b2b02
MD
104 BYTE_ORDER == LITTLE_ENDIAN ? "le" : "be",
105 s_timestamp ? metadata_stream_event_header_timestamp : "");
b522ac18
MD
106}
107
8c572eba 108static
43e34335 109void write_packet_header(struct ctf_stream_pos *pos, unsigned char *uuid)
8c572eba 110{
46322b33 111 struct ctf_stream_pos dummy;
8c572eba
MD
112
113 /* magic */
46322b33
MD
114 ctf_dummy_pos(pos, &dummy);
115 ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
116 ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
117 assert(!ctf_pos_packet(&dummy));
8c572eba 118
46322b33
MD
119 ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
120 *(uint32_t *) ctf_get_pos_addr(pos) = 0xC1FC1FC1;
121 ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT);
8c572eba 122
b4c19c1e 123 /* uuid */
46322b33
MD
124 ctf_dummy_pos(pos, &dummy);
125 ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
126 ctf_move_pos(&dummy, 16 * CHAR_BIT);
127 assert(!ctf_pos_packet(&dummy));
128
129 ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
43e34335
MD
130 memcpy(ctf_get_pos_addr(pos), uuid, BABELTRACE_UUID_LEN);
131 ctf_move_pos(pos, BABELTRACE_UUID_LEN * CHAR_BIT);
8c572eba
MD
132}
133
134static
46322b33 135void write_packet_context(struct ctf_stream_pos *pos)
8c572eba 136{
46322b33 137 struct ctf_stream_pos dummy;
8c572eba
MD
138
139 /* content_size */
46322b33 140 ctf_dummy_pos(pos, &dummy);
fef3bf22
MD
141 ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
142 ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
46322b33 143 assert(!ctf_pos_packet(&dummy));
8c572eba 144
fef3bf22
MD
145 ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT);
146 *(uint64_t *) ctf_get_pos_addr(pos) = ~0ULL; /* Not known yet */
147 pos->content_size_loc = (uint64_t *) ctf_get_pos_addr(pos);
148 ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT);
8c572eba
MD
149
150 /* packet_size */
46322b33 151 ctf_dummy_pos(pos, &dummy);
fef3bf22
MD
152 ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
153 ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
46322b33 154 assert(!ctf_pos_packet(&dummy));
8c572eba 155
fef3bf22
MD
156 ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT);
157 *(uint64_t *) ctf_get_pos_addr(pos) = pos->packet_size;
158 ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT);
8c572eba
MD
159}
160
ca8b2b02
MD
161static
162void write_event_header(struct ctf_stream_pos *pos, char *line,
163 char **tline, size_t len, size_t *tlen,
164 uint64_t *ts)
165{
bfe09576 166 unsigned long sec, usec;
ca8b2b02
MD
167 int ret;
168
169 if (!s_timestamp)
170 return;
171
172 /* Only need to be executed on first pass (dummy) */
173 if (pos->dummy) {
174 /* Extract time from input line */
bfe09576 175 ret = sscanf(line, "[%lu.%lu] ", &sec, &usec);
ca8b2b02
MD
176 if (ret == 2) {
177 *tline = strchr(line, ']');
bfe09576
MD
178 assert(*tline);
179 (*tline)++;
180 if ((*tline)[0] == ' ') {
ca8b2b02 181 (*tline)++;
bfe09576 182 }
ca8b2b02 183 *tlen = len + line - *tline;
bfe09576 184 *ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
ca8b2b02
MD
185 }
186 }
187 /* timestamp */
188 ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT);
189 if (!pos->dummy)
bc7eb6c8 190 *(uint64_t *) ctf_get_pos_addr(pos) = *ts;
ca8b2b02
MD
191 ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT);
192}
193
8c572eba 194static
46322b33 195void trace_string(char *line, struct ctf_stream_pos *pos, size_t len)
8c572eba 196{
46322b33 197 struct ctf_stream_pos dummy;
8c572eba 198 int attempt = 0;
ca8b2b02
MD
199 char *tline = line; /* tline is start of text, after timestamp */
200 size_t tlen = len;
201 uint64_t ts = 0;
8c572eba
MD
202
203 printf_debug("read: %s\n", line);
204retry:
46322b33 205 ctf_dummy_pos(pos, &dummy);
ca8b2b02 206 write_event_header(&dummy, line, &tline, len, &tlen, &ts);
46322b33 207 ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
ca8b2b02 208 ctf_move_pos(&dummy, tlen * CHAR_BIT);
46322b33 209 if (ctf_pos_packet(&dummy)) {
46322b33 210 ctf_pos_pad_packet(pos);
8c572eba
MD
211 write_packet_header(pos, s_uuid);
212 write_packet_context(pos);
213 if (attempt++ == 1) {
fef3bf22 214 fprintf(stderr, "[Error] Line too large for packet size (%" PRIu64 "kB) (discarded)\n",
8c572eba
MD
215 pos->packet_size / CHAR_BIT / 1024);
216 return;
217 }
218 goto retry;
219 }
220
ca8b2b02 221 write_event_header(pos, line, &tline, len, &tlen, &ts);
46322b33 222 ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
ca8b2b02
MD
223 memcpy(ctf_get_pos_addr(pos), tline, tlen);
224 ctf_move_pos(pos, tlen * CHAR_BIT);
8c572eba
MD
225}
226
227static
228void trace_text(FILE *input, int output)
229{
46322b33 230 struct ctf_stream_pos pos;
8c572eba
MD
231 ssize_t len;
232 char *line = NULL, *nl;
233 size_t linesize;
234
89ca8829 235 memset(&pos, 0, sizeof(pos));
989c73bc 236 ctf_init_pos(&pos, output, O_RDWR);
8c572eba
MD
237
238 write_packet_header(&pos, s_uuid);
239 write_packet_context(&pos);
240 for (;;) {
241 len = getline(&line, &linesize, input);
242 if (len < 0)
243 break;
244 nl = strrchr(line, '\n');
c5e6c71b 245 if (nl) {
8c572eba 246 *nl = '\0';
c5e6c71b
HZ
247 trace_string(line, &pos, nl - line + 1);
248 } else {
249 trace_string(line, &pos, strlen(line) + 1);
250 }
8c572eba 251 }
46322b33 252 ctf_fini_pos(&pos);
8c572eba 253}
90219914 254
ca8b2b02
MD
255static
256void usage(FILE *fp)
989c73bc 257{
00f7fbf0 258 fprintf(fp, "BabelTrace Log Converter %s\n", VERSION);
989c73bc
MD
259 fprintf(fp, "\n");
260 fprintf(fp, "Convert for a text log (read from standard input) to CTF.\n");
261 fprintf(fp, "\n");
78893e6e 262 fprintf(fp, "usage : babeltrace-log [OPTIONS] OUTPUT\n");
989c73bc
MD
263 fprintf(fp, "\n");
264 fprintf(fp, " OUTPUT Output trace path\n");
265 fprintf(fp, "\n");
78893e6e
MD
266 fprintf(fp, " -t With timestamps (format: [sec.usec] string\\n)\n");
267 fprintf(fp, "\n");
989c73bc
MD
268}
269
ca8b2b02
MD
270static
271int parse_args(int argc, char **argv)
272{
273 int i;
274
275 for (i = 1; i < argc; i++) {
276 if (!strcmp(argv[i], "-t"))
277 s_timestamp = 1;
39592eae
MD
278 else if (!strcmp(argv[i], "-h")) {
279 s_help = 1;
280 return 0;
281 } else if (argv[i][0] == '-')
282 return -EINVAL;
ca8b2b02
MD
283 else
284 s_outputname = argv[i];
285 }
286 if (!s_outputname)
287 return -EINVAL;
288 return 0;
289}
290
90219914
MD
291int main(int argc, char **argv)
292{
b522ac18 293 int fd, metadata_fd, ret;
989c73bc
MD
294 DIR *dir;
295 int dir_fd;
b522ac18 296 FILE *metadata_fp;
90219914 297
ca8b2b02
MD
298 ret = parse_args(argc, argv);
299 if (ret) {
3394d22e
MD
300 fprintf(stderr, "Error: invalid argument.\n");
301 usage(stderr);
989c73bc 302 goto error;
90219914 303 }
90219914 304
39592eae
MD
305 if (s_help) {
306 usage(stdout);
307 exit(EXIT_SUCCESS);
308 }
309
ca8b2b02 310 ret = mkdir(s_outputname, S_IRWXU|S_IRWXG);
90219914 311 if (ret) {
989c73bc
MD
312 perror("mkdir");
313 goto error;
314 }
315
ca8b2b02 316 dir = opendir(s_outputname);
989c73bc
MD
317 if (!dir) {
318 perror("opendir");
319 goto error_rmdir;
320 }
321 dir_fd = dirfd(dir);
322 if (dir_fd < 0) {
323 perror("dirfd");
324 goto error_closedir;
325 }
326
327 fd = openat(dir_fd, "datastream", O_RDWR|O_CREAT,
328 S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
329 if (fd < 0) {
330 perror("openat");
331 goto error_closedirfd;
90219914 332 }
90219914 333
b522ac18
MD
334 metadata_fd = openat(dir_fd, "metadata", O_RDWR|O_CREAT,
335 S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
336 if (fd < 0) {
337 perror("openat");
338 goto error_closedatastream;
339 }
340 metadata_fp = fdopen(metadata_fd, "w");
341 if (!metadata_fp) {
342 perror("fdopen");
343 goto error_closemetadatafd;
344 }
345
43e34335 346 babeltrace_uuid_generate(s_uuid);
b522ac18 347 print_metadata(metadata_fp);
8c572eba 348 trace_text(stdin, fd);
989c73bc 349
90219914 350 close(fd);
989c73bc
MD
351 exit(EXIT_SUCCESS);
352
353 /* error handling */
b522ac18
MD
354error_closemetadatafd:
355 ret = close(metadata_fd);
356 if (ret)
357 perror("close");
358error_closedatastream:
359 ret = close(fd);
360 if (ret)
361 perror("close");
989c73bc
MD
362error_closedirfd:
363 ret = close(dir_fd);
364 if (ret)
365 perror("close");
366error_closedir:
367 ret = closedir(dir);
368 if (ret)
369 perror("closedir");
370error_rmdir:
ca8b2b02 371 ret = rmdir(s_outputname);
989c73bc
MD
372 if (ret)
373 perror("rmdir");
374error:
375 exit(EXIT_FAILURE);
90219914 376}
This page took 0.043561 seconds and 4 git commands to generate.