converter/babeltrace-log.c

   1 /*
   2  * babeltrace-log.c
   3  *
   4  * BabelTrace - Convert Text Log to CTF
   5  *
   6  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   7  *
   8  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   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
  23 #define _GNU_SOURCE
  24 #include <config.h>
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <fcntl.h>
  28 #include <sys/mman.h>
  29 #include <dirent.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <stdint.h>
  33 #include <unistd.h>
  34 #include <errno.h>
  35 #include <string.h>
  36 #include <inttypes.h>
  37
  38 #include <babeltrace/babeltrace-internal.h>
  39 #include <babeltrace/ctf/types.h>
  40 #include <babeltrace/uuid.h>
  41 #include <babeltrace/endian.h>
  42
  43 #define USEC_PER_SEC 1000000UL
  44
  45 int babeltrace_debug, babeltrace_verbose;
  46
  47 static char *s_outputname;
  48 static int s_timestamp;
  49 static int s_help;
  50 static unsigned char s_uuid[BABELTRACE_UUID_LEN];
  51
  52 /* Metadata format string */
  53 static const char metadata_fmt[] =
  54 "/* CTF 1.8 */\n"
  55 "typealias integer { size = 8; align = 8; signed = false; } := uint8_t;\n"
  56 "typealias integer { size = 32; align = 32; signed = false; } := uint32_t;\n"
  57 "typealias integer { size = 64; align = 64; signed = false; } := uint64_t;\n"
  58 "\n"
  59 "trace {\n"
  60 "       major = %u;\n"                  /* major (e.g. 0) */
  61 "       minor = %u;\n"                  /* minor (e.g. 1) */
  62 "       uuid = \"%s\";\n"               /* UUID */
  63 "       byte_order = %s;\n"             /* be or le */
  64 "       packet.header := struct {\n"
  65 "               uint32_t magic;\n"
  66 "               uint8_t  uuid[16];\n"
  67 "       };\n"
  68 "};\n"
  69 "\n"
  70 "stream {\n"
  71 "       packet.context := struct {\n"
  72 "               uint64_t content_size;\n"
  73 "               uint64_t packet_size;\n"
  74 "       };\n"
  75 "%s"                                    /* Stream event header (opt.) */
  76 "};\n"
  77 "\n"
  78 "event {\n"
  79 "       name = string;\n"
  80 "       fields := struct { string str; };\n"
  81 "};\n";
  82
  83 static 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";
  88
  89 static
  90 void print_metadata(FILE *fp)
  91 {
  92         char uuid_str[BABELTRACE_UUID_STR_LEN];
  93         unsigned int major = 0, minor = 0;
  94         int ret;
  95
  96         ret = sscanf(VERSION, "%u.%u", &major, &minor);
  97         if (ret != 2)
  98                 fprintf(stderr, "[warning] Incorrect babeltrace version format\n.");
  99         babeltrace_uuid_unparse(s_uuid, uuid_str);
 100         fprintf(fp, metadata_fmt,
 101                 major,
 102                 minor,
 103                 uuid_str,
 104                 BYTE_ORDER == LITTLE_ENDIAN ? "le" : "be",
 105                 s_timestamp ? metadata_stream_event_header_timestamp : "");
 106 }
 107
 108 static
 109 void write_packet_header(struct ctf_stream_pos *pos, unsigned char *uuid)
 110 {
 111         struct ctf_stream_pos dummy;
 112
 113         /* magic */
 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));
 118
 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);
 122
 123         /* uuid */
 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);
 130         memcpy(ctf_get_pos_addr(pos), uuid, BABELTRACE_UUID_LEN);
 131         ctf_move_pos(pos, BABELTRACE_UUID_LEN * CHAR_BIT);
 132 }
 133
 134 static
 135 void write_packet_context(struct ctf_stream_pos *pos)
 136 {
 137         struct ctf_stream_pos dummy;
 138
 139         /* content_size */
 140         ctf_dummy_pos(pos, &dummy);
 141         ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
 142         ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
 143         assert(!ctf_pos_packet(&dummy));
 144
 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);
 149
 150         /* packet_size */
 151         ctf_dummy_pos(pos, &dummy);
 152         ctf_align_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
 153         ctf_move_pos(&dummy, sizeof(uint64_t) * CHAR_BIT);
 154         assert(!ctf_pos_packet(&dummy));
 155
 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);
 159 }
 160
 161 static
 162 void write_event_header(struct ctf_stream_pos *pos, char *line,
 163                         char **tline, size_t len, size_t *tlen,
 164                         uint64_t *ts)
 165 {
 166         unsigned long sec, usec;
 167
 168         if (!s_timestamp)
 169                 return;
 170
 171         /* Only need to be executed on first pass (dummy) */
 172         if (pos->dummy) {
 173                 int ret;
 174
 175                 /* Extract time from input line */
 176                 ret = sscanf(line, "[%lu.%lu] ", &sec, &usec);
 177                 if (ret == 2) {
 178                         *tline = strchr(line, ']');
 179                         assert(*tline);
 180                         (*tline)++;
 181                         if ((*tline)[0] == ' ') {
 182                                 (*tline)++;
 183                         }
 184                         *tlen = len + line - *tline;
 185                         *ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 186                 }
 187         }
 188         /* timestamp */
 189         ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT);
 190         if (!pos->dummy)
 191                 *(uint64_t *) ctf_get_pos_addr(pos) = *ts;
 192         ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT);
 193 }
 194
 195 static
 196 void trace_string(char *line, struct ctf_stream_pos *pos, size_t len)
 197 {
 198         struct ctf_stream_pos dummy;
 199         int attempt = 0;
 200         char *tline = line;     /* tline is start of text, after timestamp */
 201         size_t tlen = len;
 202         uint64_t ts = 0;
 203
 204         printf_debug("read: %s\n", line);
 205
 206         for (;;) {
 207                 ctf_dummy_pos(pos, &dummy);
 208                 write_event_header(&dummy, line, &tline, len, &tlen, &ts);
 209                 ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
 210                 ctf_move_pos(&dummy, tlen * CHAR_BIT);
 211                 if (ctf_pos_packet(&dummy)) {
 212                         ctf_pos_pad_packet(pos);
 213                         write_packet_header(pos, s_uuid);
 214                         write_packet_context(pos);
 215                         if (attempt++ == 1) {
 216                                 fprintf(stderr, "[Error] Line too large for packet size (%" PRIu64 "kB) (discarded)\n",
 217                                         pos->packet_size / CHAR_BIT / 1024);
 218                                 return;
 219                         }
 220                         continue;
 221                 } else {
 222                         break;
 223                 }
 224         }
 225
 226         write_event_header(pos, line, &tline, len, &tlen, &ts);
 227         ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
 228         memcpy(ctf_get_pos_addr(pos), tline, tlen);
 229         ctf_move_pos(pos, tlen * CHAR_BIT);
 230 }
 231
 232 static
 233 void trace_text(FILE *input, int output)
 234 {
 235         struct ctf_stream_pos pos;
 236         ssize_t len;
 237         char *line = NULL, *nl;
 238         size_t linesize;
 239         int ret;
 240
 241         memset(&pos, 0, sizeof(pos));
 242         ret = ctf_init_pos(&pos, output, O_RDWR);
 243         if (ret) {
 244                 fprintf(stderr, "Error in ctf_init_pos\n");
 245                 return;
 246         }
 247         write_packet_header(&pos, s_uuid);
 248         write_packet_context(&pos);
 249         for (;;) {
 250                 len = getline(&line, &linesize, input);
 251                 if (len < 0)
 252                         break;
 253                 nl = strrchr(line, '\n');
 254                 if (nl) {
 255                         *nl = '\0';
 256                         trace_string(line, &pos, nl - line + 1);
 257                 } else {
 258                         trace_string(line, &pos, strlen(line) + 1);
 259                 }
 260         }
 261         ret = ctf_fini_pos(&pos);
 262         if (ret) {
 263                 fprintf(stderr, "Error in ctf_fini_pos\n");
 264         }
 265 }
 266
 267 static
 268 void usage(FILE *fp)
 269 {
 270         fprintf(fp, "BabelTrace Log Converter %s\n", VERSION);
 271         fprintf(fp, "\n");
 272         fprintf(fp, "Convert for a text log (read from standard input) to CTF.\n");
 273         fprintf(fp, "\n");
 274         fprintf(fp, "usage : babeltrace-log [OPTIONS] OUTPUT\n");
 275         fprintf(fp, "\n");
 276         fprintf(fp, "  OUTPUT                         Output trace path\n");
 277         fprintf(fp, "\n");
 278         fprintf(fp, "  -t                             With timestamps (format: [sec.usec] string\\n)\n");
 279         fprintf(fp, "\n");
 280 }
 281
 282 static
 283 int parse_args(int argc, char **argv)
 284 {
 285         int i;
 286
 287         for (i = 1; i < argc; i++) {
 288                 if (!strcmp(argv[i], "-t"))
 289                         s_timestamp = 1;
 290                 else if (!strcmp(argv[i], "-h")) {
 291                         s_help = 1;
 292                         return 0;
 293                 } else if (argv[i][0] == '-')
 294                         return -EINVAL;
 295                 else
 296                         s_outputname = argv[i];
 297         }
 298         if (!s_outputname)
 299                 return -EINVAL;
 300         return 0;
 301 }
 302
 303 int main(int argc, char **argv)
 304 {
 305         int fd, metadata_fd, ret;
 306         DIR *dir;
 307         int dir_fd;
 308         FILE *metadata_fp;
 309
 310         ret = parse_args(argc, argv);
 311         if (ret) {
 312                 fprintf(stderr, "Error: invalid argument.\n");
 313                 usage(stderr);
 314                 goto error;
 315         }
 316
 317         if (s_help) {
 318                 usage(stdout);
 319                 exit(EXIT_SUCCESS);
 320         }
 321
 322         ret = mkdir(s_outputname, S_IRWXU|S_IRWXG);
 323         if (ret) {
 324                 perror("mkdir");
 325                 goto error;
 326         }
 327
 328         dir = opendir(s_outputname);
 329         if (!dir) {
 330                 perror("opendir");
 331                 goto error_rmdir;
 332         }
 333         dir_fd = dirfd(dir);
 334         if (dir_fd < 0) {
 335                 perror("dirfd");
 336                 goto error_closedir;
 337         }
 338
 339         fd = openat(dir_fd, "datastream", O_RDWR|O_CREAT,
 340                     S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
 341         if (fd < 0) {
 342                 perror("openat");
 343                 goto error_closedirfd;
 344         }
 345
 346         metadata_fd = openat(dir_fd, "metadata", O_RDWR|O_CREAT,
 347                              S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
 348         if (fd < 0) {
 349                 perror("openat");
 350                 goto error_closedatastream;
 351         }
 352         metadata_fp = fdopen(metadata_fd, "w");
 353         if (!metadata_fp) {
 354                 perror("fdopen");
 355                 goto error_closemetadatafd;
 356         }
 357
 358         babeltrace_uuid_generate(s_uuid);
 359         print_metadata(metadata_fp);
 360         trace_text(stdin, fd);
 361
 362         ret = close(fd);
 363         if (ret)
 364                 perror("close");
 365         exit(EXIT_SUCCESS);
 366
 367         /* error handling */
 368 error_closemetadatafd:
 369         ret = close(metadata_fd);
 370         if (ret)
 371                 perror("close");
 372 error_closedatastream:
 373         ret = close(fd);
 374         if (ret)
 375                 perror("close");
 376 error_closedirfd:
 377         ret = close(dir_fd);
 378         if (ret)
 379                 perror("close");
 380 error_closedir:
 381         ret = closedir(dir);
 382         if (ret)
 383                 perror("closedir");
 384 error_rmdir:
 385         ret = rmdir(s_outputname);
 386         if (ret)
 387                 perror("rmdir");
 388 error:
 389         exit(EXIT_FAILURE);
 390 }