Change UUID API prefix from babeltrace_ to bt_
[babeltrace.git] / converter / babeltrace-log.c
index b320cbb0cd280484e91522b4a4c3357da71461e7..b724ccd67ebd5aecbb26d671d2e858e2d978b533 100644 (file)
@@ -3,7 +3,9 @@
  *
  * BabelTrace - Convert Text Log to CTF
  *
- * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@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
  * 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.
+ *
  * Depends on glibc 2.10 for getline().
  */
 
+#define _GNU_SOURCE
+#include <config.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <stdint.h>
 #include <unistd.h>
 #include <errno.h>
-#include <uuid/uuid.h>
 #include <string.h>
-#include <endian.h>
+#include <inttypes.h>
 
-#include <babeltrace/babeltrace.h>
+#include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/ctf/types.h>
+#include <babeltrace/compat/uuid.h>
+#include <babeltrace/compat/utc.h>
+#include <babeltrace/endian.h>
+
+#define NSEC_PER_USEC 1000UL
+#define NSEC_PER_MSEC 1000000UL
+#define NSEC_PER_SEC 1000000000ULL
+#define USEC_PER_SEC 1000000UL
+
+int babeltrace_debug, babeltrace_verbose;
 
-#ifndef UUID_STR_LEN
-#define UUID_STR_LEN   37      /* With \0 */
-#endif
+static char *s_outputname;
+static int s_timestamp;
+static int s_help;
+static unsigned char s_uuid[BABELTRACE_UUID_LEN];
 
 /* Metadata format string */
 static const char metadata_fmt[] =
+"/* CTF 1.8 */\n"
 "typealias integer { size = 8; align = 8; signed = false; } := uint8_t;\n"
 "typealias integer { size = 32; align = 32; signed = false; } := uint32_t;\n"
+"typealias integer { size = 64; align = 64; signed = false; } := uint64_t;\n"
 "\n"
 "trace {\n"
-"      major = %s;\n"                  /* major (e.g. 0) */
-"      minor = %s;\n"                  /* minor (e.g. 1) */
+"      major = %u;\n"                  /* major (e.g. 0) */
+"      minor = %u;\n"                  /* minor (e.g. 1) */
 "      uuid = \"%s\";\n"               /* UUID */
 "      byte_order = %s;\n"             /* be or le */
 "      packet.header := struct {\n"
 "              uint32_t magic;\n"
-"              uint8_t  trace_uuid[16];\n"
+"              uint8_t  uuid[16];\n"
 "      };\n"
 "};\n"
 "\n"
 "stream {\n"
 "      packet.context := struct {\n"
-"              uint32_t content_size;\n"
-"              uint32_t packet_size;\n"
+"              uint64_t content_size;\n"
+"              uint64_t packet_size;\n"
 "      };\n"
+"%s"                                   /* Stream event header (opt.) */
 "};\n"
 "\n"
 "event {\n"
@@ -67,48 +92,68 @@ static const char metadata_fmt[] =
 "      fields := struct { string str; };\n"
 "};\n";
 
-int babeltrace_debug, babeltrace_verbose;
-
-static uuid_t s_uuid;
+static const char metadata_stream_event_header_timestamp[] =
+"      typealias integer { size = 64; align = 64; signed = false; } := uint64_t;\n"
+"      event.header := struct {\n"
+"              uint64_t timestamp;\n"
+"      };\n";
 
 static
 void print_metadata(FILE *fp)
 {
-       char uuid_str[UUID_STR_LEN];
-
-       uuid_unparse(s_uuid, uuid_str);
+       char uuid_str[BABELTRACE_UUID_STR_LEN];
+       unsigned int major = 0, minor = 0;
+       int ret;
+
+       ret = sscanf(VERSION, "%u.%u", &major, &minor);
+       if (ret != 2)
+               fprintf(stderr, "[warning] Incorrect babeltrace version format\n.");
+       bt_uuid_unparse(s_uuid, uuid_str);
        fprintf(fp, metadata_fmt,
-               __stringify(BABELTRACE_VERSION_MAJOR),
-               __stringify(BABELTRACE_VERSION_MINOR),
+               major,
+               minor,
                uuid_str,
-               BYTE_ORDER == LITTLE_ENDIAN ? "le" : "be");
+               BYTE_ORDER == LITTLE_ENDIAN ? "le" : "be",
+               s_timestamp ? metadata_stream_event_header_timestamp : "");
 }
 
-
 static
-void write_packet_header(struct ctf_stream_pos *pos, uuid_t uuid)
+void write_packet_header(struct ctf_stream_pos *pos, unsigned char *uuid)
 {
        struct ctf_stream_pos dummy;
 
        /* magic */
        ctf_dummy_pos(pos, &dummy);
-       ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
-       ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
+       if (!ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT))
+               goto error;
+       if (!ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT))
+               goto error;
        assert(!ctf_pos_packet(&dummy));
-       
-       ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
+
+       if (!ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT))
+               goto error;
        *(uint32_t *) ctf_get_pos_addr(pos) = 0xC1FC1FC1;
-       ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT);
+       if (!ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT))
+               goto error;
 
-       /* trace_uuid */
+       /* uuid */
        ctf_dummy_pos(pos, &dummy);
-       ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
-       ctf_move_pos(&dummy, 16 * CHAR_BIT);
+       if (!ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT))
+               goto error;
+       if (!ctf_move_pos(&dummy, 16 * CHAR_BIT))
+               goto error;
        assert(!ctf_pos_packet(&dummy));
 
-       ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
-       memcpy(ctf_get_pos_addr(pos), uuid, 16);
-       ctf_move_pos(pos, 16 * CHAR_BIT);
+       if (!ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT))
+               goto error;
+       memcpy(ctf_get_pos_addr(pos), uuid, BABELTRACE_UUID_LEN);
+       if (!ctf_move_pos(pos, BABELTRACE_UUID_LEN * CHAR_BIT))
+               goto error;
+       return;
+
+error:
+       fprintf(stderr, "[error] Out of packet bounds when writing packet header\n");
+       abort();
 }
 
 static
@@ -118,24 +163,105 @@ void write_packet_context(struct ctf_stream_pos *pos)
 
        /* content_size */
        ctf_dummy_pos(pos, &dummy);
-       ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
-       ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
+       if (!ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       if (!ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
        assert(!ctf_pos_packet(&dummy));
-       
-       ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
-       *(uint32_t *) ctf_get_pos_addr(pos) = -1U;      /* Not known yet */
-       pos->content_size_loc = (uint32_t *) ctf_get_pos_addr(pos);
-       ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT);
+
+       if (!ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       *(uint64_t *) ctf_get_pos_addr(pos) = ~0ULL;    /* Not known yet */
+       pos->content_size_loc = (uint64_t *) ctf_get_pos_addr(pos);
+       if (!ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
 
        /* packet_size */
        ctf_dummy_pos(pos, &dummy);
-       ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
-       ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
+       if (!ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       if (!ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
        assert(!ctf_pos_packet(&dummy));
-       
-       ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
-       *(uint32_t *) ctf_get_pos_addr(pos) = pos->packet_size;
-       ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT);
+
+       if (!ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       *(uint64_t *) ctf_get_pos_addr(pos) = pos->packet_size;
+       if (!ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       return;
+
+error:
+       fprintf(stderr, "[error] Out of packet bounds when writing packet context\n");
+       abort();
+}
+
+static
+void write_event_header(struct ctf_stream_pos *pos, char *line,
+                       char **tline, size_t len, size_t *tlen,
+                       uint64_t *ts)
+{
+       if (!s_timestamp)
+               return;
+
+       /* Only need to be executed on first pass (dummy) */
+       if (pos->dummy) {
+               int has_timestamp = 0;
+               unsigned long sec, usec, msec;
+               unsigned int year, mon, mday, hour, min;
+
+               /* Extract time from input line */
+               if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
+                       *ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
+                       /*
+                        * Default CTF clock has 1GHz frequency. Convert
+                        * from usec to nsec.
+                        */
+                       *ts *= NSEC_PER_USEC;
+                       has_timestamp = 1;
+               } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
+                               &year, &mon, &mday, &hour, &min,
+                               &sec, &msec) == 7) {
+                       time_t ep_sec;
+                       struct tm ti;
+
+                       memset(&ti, 0, sizeof(ti));
+                       ti.tm_year = year - 1900;       /* from 1900 */
+                       ti.tm_mon = mon - 1;            /* 0 to 11 */
+                       ti.tm_mday = mday;
+                       ti.tm_hour = hour;
+                       ti.tm_min = min;
+                       ti.tm_sec = sec;
+
+                       ep_sec = babeltrace_timegm(&ti);
+                       if (ep_sec != (time_t) -1) {
+                               *ts = (uint64_t) ep_sec * NSEC_PER_SEC
+                                       + (uint64_t) msec * NSEC_PER_MSEC;
+                       }
+                       has_timestamp = 1;
+               }
+               if (has_timestamp) {
+                       *tline = strchr(line, ']');
+                       assert(*tline);
+                       (*tline)++;
+                       if ((*tline)[0] == ' ') {
+                               (*tline)++;
+                       }
+                       *tlen = len + line - *tline;
+               }
+       }
+       /* timestamp */
+       if (!ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       if (!pos->dummy)
+               *(uint64_t *) ctf_get_pos_addr(pos) = *ts;
+       if (!ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT))
+               goto error;
+       return;
+
+error:
+       fprintf(stderr, "[error] Out of packet bounds when writing event header\n");
+       abort();
 }
 
 static
@@ -143,27 +269,47 @@ void trace_string(char *line, struct ctf_stream_pos *pos, size_t len)
 {
        struct ctf_stream_pos dummy;
        int attempt = 0;
+       char *tline = line;     /* tline is start of text, after timestamp */
+       size_t tlen = len;
+       uint64_t ts = 0;
 
        printf_debug("read: %s\n", line);
-retry:
-       ctf_dummy_pos(pos, &dummy);
-       ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
-       ctf_move_pos(&dummy, len * CHAR_BIT);
-       if (ctf_pos_packet(&dummy)) {
-               ctf_pos_pad_packet(pos);
-               write_packet_header(pos, s_uuid);
-               write_packet_context(pos);
-               if (attempt++ == 1) {
-                       fprintf(stdout, "[Error] Line too large for packet size (%zukB) (discarded)\n",
-                               pos->packet_size / CHAR_BIT / 1024);
-                       return;
+
+       for (;;) {
+               int packet_filled = 0;
+
+               ctf_dummy_pos(pos, &dummy);
+               write_event_header(&dummy, line, &tline, len, &tlen, &ts);
+               if (!ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT))
+                       packet_filled = 1;
+               if (!ctf_move_pos(&dummy, tlen * CHAR_BIT))
+                       packet_filled = 1;
+               if (packet_filled || ctf_pos_packet(&dummy)) {
+                       ctf_pos_pad_packet(pos);
+                       write_packet_header(pos, s_uuid);
+                       write_packet_context(pos);
+                       if (attempt++ == 1) {
+                               fprintf(stderr, "[Error] Line too large for packet size (%" PRIu64 "kB) (discarded)\n",
+                                       pos->packet_size / CHAR_BIT / 1024);
+                               return;
+                       }
+                       continue;
+               } else {
+                       break;
                }
-               goto retry;
        }
 
-       ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
-       memcpy(ctf_get_pos_addr(pos), line, len);
-       ctf_move_pos(pos, len * CHAR_BIT);
+       write_event_header(pos, line, &tline, len, &tlen, &ts);
+       if (!ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT))
+               goto error;
+       memcpy(ctf_get_pos_addr(pos), tline, tlen);
+       if (!ctf_move_pos(pos, tlen * CHAR_BIT))
+               goto error;
+       return;
+
+error:
+       fprintf(stderr, "[error] Out of packet bounds when writing event payload\n");
+       abort();
 }
 
 static
@@ -173,9 +319,15 @@ void trace_text(FILE *input, int output)
        ssize_t len;
        char *line = NULL, *nl;
        size_t linesize;
+       int ret;
 
-       ctf_init_pos(&pos, output, O_RDWR);
-
+       memset(&pos, 0, sizeof(pos));
+       ret = ctf_init_pos(&pos, NULL, output, O_RDWR);
+       if (ret) {
+               fprintf(stderr, "Error in ctf_init_pos\n");
+               return;
+       }
+       ctf_packet_seek(&pos.parent, 0, SEEK_CUR);
        write_packet_header(&pos, s_uuid);
        write_packet_context(&pos);
        for (;;) {
@@ -183,48 +335,82 @@ void trace_text(FILE *input, int output)
                if (len < 0)
                        break;
                nl = strrchr(line, '\n');
-               if (nl)
+               if (nl) {
                        *nl = '\0';
-               trace_string(line, &pos, nl - line + 1);
+                       trace_string(line, &pos, nl - line + 1);
+               } else {
+                       trace_string(line, &pos, strlen(line) + 1);
+               }
+       }
+       ret = ctf_fini_pos(&pos);
+       if (ret) {
+               fprintf(stderr, "Error in ctf_fini_pos\n");
        }
-       ctf_fini_pos(&pos);
 }
 
-static void usage(FILE *fp)
+static
+void usage(FILE *fp)
 {
-       fprintf(fp, "BabelTrace Log Converter %u.%u\n",
-               BABELTRACE_VERSION_MAJOR,
-               BABELTRACE_VERSION_MINOR);
+       fprintf(fp, "BabelTrace Log Converter %s\n", VERSION);
        fprintf(fp, "\n");
        fprintf(fp, "Convert for a text log (read from standard input) to CTF.\n");
        fprintf(fp, "\n");
-       fprintf(fp, "usage : babeltrace-log OUTPUT\n");
+       fprintf(fp, "usage : babeltrace-log [OPTIONS] OUTPUT\n");
        fprintf(fp, "\n");
        fprintf(fp, "  OUTPUT                         Output trace path\n");
        fprintf(fp, "\n");
+       fprintf(fp, "  -t                             With timestamps (format: [sec.usec] string\\n)\n");
+       fprintf(fp, "                                                 (format: [YYYY-MM-DD HH:MM:SS.MS] string\\n)\n");
+       fprintf(fp, "\n");
+}
+
+static
+int parse_args(int argc, char **argv)
+{
+       int i;
+
+       for (i = 1; i < argc; i++) {
+               if (!strcmp(argv[i], "-t"))
+                       s_timestamp = 1;
+               else if (!strcmp(argv[i], "-h")) {
+                       s_help = 1;
+                       return 0;
+               } else if (argv[i][0] == '-')
+                       return -EINVAL;
+               else
+                       s_outputname = argv[i];
+       }
+       if (!s_outputname)
+               return -EINVAL;
+       return 0;
 }
 
 int main(int argc, char **argv)
 {
        int fd, metadata_fd, ret;
-       char *outputname;
        DIR *dir;
        int dir_fd;
        FILE *metadata_fp;
 
-       if (argc < 2) {
-               usage(stdout);
+       ret = parse_args(argc, argv);
+       if (ret) {
+               fprintf(stderr, "Error: invalid argument.\n");
+               usage(stderr);
                goto error;
        }
-       outputname = argv[1];
 
-       ret = mkdir(outputname, S_IRWXU|S_IRWXG);
+       if (s_help) {
+               usage(stdout);
+               exit(EXIT_SUCCESS);
+       }
+
+       ret = mkdir(s_outputname, S_IRWXU|S_IRWXG);
        if (ret) {
                perror("mkdir");
                goto error;
        }
 
-       dir = opendir(outputname);
+       dir = opendir(s_outputname);
        if (!dir) {
                perror("opendir");
                goto error_rmdir;
@@ -244,7 +430,7 @@ int main(int argc, char **argv)
 
        metadata_fd = openat(dir_fd, "metadata", O_RDWR|O_CREAT,
                             S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
-       if (fd < 0) {
+       if (metadata_fd < 0) {
                perror("openat");
                goto error_closedatastream;
        }
@@ -254,11 +440,13 @@ int main(int argc, char **argv)
                goto error_closemetadatafd;
        }
 
-       uuid_generate(s_uuid);
+       bt_uuid_generate(s_uuid);
        print_metadata(metadata_fp);
        trace_text(stdin, fd);
 
-       close(fd);
+       ret = close(fd);
+       if (ret)
+               perror("close");
        exit(EXIT_SUCCESS);
 
        /* error handling */
@@ -279,7 +467,7 @@ error_closedir:
        if (ret)
                perror("closedir");
 error_rmdir:
-       ret = rmdir(outputname);
+       ret = rmdir(s_outputname);
        if (ret)
                perror("rmdir");
 error:
This page took 0.028432 seconds and 4 git commands to generate.