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 #include <config.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <sys/mman.h>
  28 #include <dirent.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <stdint.h>
  32 #include <unistd.h>
  33 #include <errno.h>
  34 #include <uuid/uuid.h>
  35 #include <string.h>
  36 #include <endian.h>
  37
  38 #include <babeltrace/babeltrace.h>
  39 #include <babeltrace/ctf/types.h>
  40
  41 #define USEC_PER_SEC 1000000UL
  42
  43 #ifndef UUID_STR_LEN
  44 #define UUID_STR_LEN    37      /* With \0 */
  45 #endif
  46
  47 int babeltrace_debug, babeltrace_verbose;
  48
  49 static char *s_outputname;
  50 static int s_timestamp;
  51 static int s_help;
  52 static uuid_t s_uuid;
  53
  54 /* Metadata format string */
  55 static const char metadata_fmt[] =
  56 "typealias integer { size = 8; align = 8; signed = false; } := uint8_t;\n"
  57 "typealias integer { size = 32; align = 32; signed = false; } := uint32_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 "               uint32_t content_size;\n"
  73 "               uint32_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[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         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, uuid_t 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, 16);
 131         ctf_move_pos(pos, 16 * 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(uint32_t) * CHAR_BIT);
 142         ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
 143         assert(!ctf_pos_packet(&dummy));
 144
 145         ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
 146         *(uint32_t *) ctf_get_pos_addr(pos) = -1U;      /* Not known yet */
 147         pos->content_size_loc = (uint32_t *) ctf_get_pos_addr(pos);
 148         ctf_move_pos(pos, sizeof(uint32_t) * CHAR_BIT);
 149
 150         /* packet_size */
 151         ctf_dummy_pos(pos, &dummy);
 152         ctf_align_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
 153         ctf_move_pos(&dummy, sizeof(uint32_t) * CHAR_BIT);
 154         assert(!ctf_pos_packet(&dummy));
 155
 156         ctf_align_pos(pos, sizeof(uint32_t) * CHAR_BIT);
 157         *(uint32_t *) ctf_get_pos_addr(pos) = pos->packet_size;
 158         ctf_move_pos(pos, sizeof(uint32_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         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 */
 175                 ret = sscanf(line, "[%lu.%lu] ", &sec, &usec);
 176                 if (ret == 2) {
 177                         *tline = strchr(line, ']');
 178                         assert(*tline);
 179                         (*tline)++;
 180                         if ((*tline)[0] == ' ') {
 181                                 (*tline)++;
 182                         }
 183                         *tlen = len + line - *tline;
 184                         *ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 185                 }
 186         }
 187         /* timestamp */
 188         ctf_align_pos(pos, sizeof(uint64_t) * CHAR_BIT);
 189         if (!pos->dummy)
 190                 *(uint64_t *) ctf_get_pos_addr(pos) = *ts;
 191         ctf_move_pos(pos, sizeof(uint64_t) * CHAR_BIT);
 192 }
 193
 194 static
 195 void trace_string(char *line, struct ctf_stream_pos *pos, size_t len)
 196 {
 197         struct ctf_stream_pos dummy;
 198         int attempt = 0;
 199         char *tline = line;     /* tline is start of text, after timestamp */
 200         size_t tlen = len;
 201         uint64_t ts = 0;
 202
 203         printf_debug("read: %s\n", line);
 204 retry:
 205         ctf_dummy_pos(pos, &dummy);
 206         write_event_header(&dummy, line, &tline, len, &tlen, &ts);
 207         ctf_align_pos(&dummy, sizeof(uint8_t) * CHAR_BIT);
 208         ctf_move_pos(&dummy, tlen * CHAR_BIT);
 209         if (ctf_pos_packet(&dummy)) {
 210                 ctf_pos_pad_packet(pos);
 211                 write_packet_header(pos, s_uuid);
 212                 write_packet_context(pos);
 213                 if (attempt++ == 1) {
 214                         fprintf(stdout, "[Error] Line too large for packet size (%zukB) (discarded)\n",
 215                                 pos->packet_size / CHAR_BIT / 1024);
 216                         return;
 217                 }
 218                 goto retry;
 219         }
 220
 221         write_event_header(pos, line, &tline, len, &tlen, &ts);
 222         ctf_align_pos(pos, sizeof(uint8_t) * CHAR_BIT);
 223         memcpy(ctf_get_pos_addr(pos), tline, tlen);
 224         ctf_move_pos(pos, tlen * CHAR_BIT);
 225 }
 226
 227 static
 228 void trace_text(FILE *input, int output)
 229 {
 230         struct ctf_stream_pos pos;
 231         ssize_t len;
 232         char *line = NULL, *nl;
 233         size_t linesize;
 234
 235         ctf_init_pos(&pos, output, O_RDWR);
 236
 237         write_packet_header(&pos, s_uuid);
 238         write_packet_context(&pos);
 239         for (;;) {
 240                 len = getline(&line, &linesize, input);
 241                 if (len < 0)
 242                         break;
 243                 nl = strrchr(line, '\n');
 244                 if (nl)
 245                         *nl = '\0';
 246                 trace_string(line, &pos, nl - line + 1);
 247         }
 248         ctf_fini_pos(&pos);
 249 }
 250
 251 static
 252 void usage(FILE *fp)
 253 {
 254         fprintf(fp, "BabelTrace Log Converter %s\n", VERSION);
 255         fprintf(fp, "\n");
 256         fprintf(fp, "Convert for a text log (read from standard input) to CTF.\n");
 257         fprintf(fp, "\n");
 258         fprintf(fp, "usage : babeltrace-log [OPTIONS] OUTPUT\n");
 259         fprintf(fp, "\n");
 260         fprintf(fp, "  OUTPUT                         Output trace path\n");
 261         fprintf(fp, "\n");
 262         fprintf(fp, "  -t                             With timestamps (format: [sec.usec] string\\n)\n");
 263         fprintf(fp, "\n");
 264 }
 265
 266 static
 267 int parse_args(int argc, char **argv)
 268 {
 269         int i;
 270
 271         for (i = 1; i < argc; i++) {
 272                 if (!strcmp(argv[i], "-t"))
 273                         s_timestamp = 1;
 274                 else if (!strcmp(argv[i], "-h")) {
 275                         s_help = 1;
 276                         return 0;
 277                 } else if (argv[i][0] == '-')
 278                         return -EINVAL;
 279                 else
 280                         s_outputname = argv[i];
 281         }
 282         if (!s_outputname)
 283                 return -EINVAL;
 284         return 0;
 285 }
 286
 287 int main(int argc, char **argv)
 288 {
 289         int fd, metadata_fd, ret;
 290         DIR *dir;
 291         int dir_fd;
 292         FILE *metadata_fp;
 293
 294         ret = parse_args(argc, argv);
 295         if (ret) {
 296                 fprintf(stdout, "Error: invalid argument.\n");
 297                 usage(stdout);
 298                 goto error;
 299         }
 300
 301         if (s_help) {
 302                 usage(stdout);
 303                 exit(EXIT_SUCCESS);
 304         }
 305
 306         ret = mkdir(s_outputname, S_IRWXU|S_IRWXG);
 307         if (ret) {
 308                 perror("mkdir");
 309                 goto error;
 310         }
 311
 312         dir = opendir(s_outputname);
 313         if (!dir) {
 314                 perror("opendir");
 315                 goto error_rmdir;
 316         }
 317         dir_fd = dirfd(dir);
 318         if (dir_fd < 0) {
 319                 perror("dirfd");
 320                 goto error_closedir;
 321         }
 322
 323         fd = openat(dir_fd, "datastream", O_RDWR|O_CREAT,
 324                     S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
 325         if (fd < 0) {
 326                 perror("openat");
 327                 goto error_closedirfd;
 328         }
 329
 330         metadata_fd = openat(dir_fd, "metadata", O_RDWR|O_CREAT,
 331                              S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP);
 332         if (fd < 0) {
 333                 perror("openat");
 334                 goto error_closedatastream;
 335         }
 336         metadata_fp = fdopen(metadata_fd, "w");
 337         if (!metadata_fp) {
 338                 perror("fdopen");
 339                 goto error_closemetadatafd;
 340         }
 341
 342         uuid_generate(s_uuid);
 343         print_metadata(metadata_fp);
 344         trace_text(stdin, fd);
 345
 346         close(fd);
 347         exit(EXIT_SUCCESS);
 348
 349         /* error handling */
 350 error_closemetadatafd:
 351         ret = close(metadata_fd);
 352         if (ret)
 353                 perror("close");
 354 error_closedatastream:
 355         ret = close(fd);
 356         if (ret)
 357                 perror("close");
 358 error_closedirfd:
 359         ret = close(dir_fd);
 360         if (ret)
 361                 perror("close");
 362 error_closedir:
 363         ret = closedir(dir);
 364         if (ret)
 365                 perror("closedir");
 366 error_rmdir:
 367         ret = rmdir(s_outputname);
 368         if (ret)
 369                 perror("rmdir");
 370 error:
 371         exit(EXIT_FAILURE);
 372 }