Specify callback to move packet in open_trace
[babeltrace.git] / formats / ctf / ctf.c
index ce21464e562b0601540f7beacb96c8da3b597c20..93d13e8a5bc5bfcbfefe75529181fe5d41ab8fc0 100644 (file)
@@ -3,7 +3,9 @@
  *
  * Format registration.
  *
- * 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
@@ -19,7 +21,7 @@
 #include <babeltrace/format.h>
 #include <babeltrace/ctf/types.h>
 #include <babeltrace/ctf/metadata.h>
-#include <babeltrace/babeltrace.h>
+#include <babeltrace/babeltrace-internal.h>
 #include <inttypes.h>
 #include <stdio.h>
 #include <uuid/uuid.h>
@@ -53,7 +55,9 @@
 extern int yydebug;
 
 static
-struct trace_descriptor *ctf_open_trace(const char *path, int flags);
+struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                       int whence));
 static
 void ctf_close_trace(struct trace_descriptor *descriptor);
 
@@ -95,7 +99,7 @@ void ctf_update_timestamp(struct ctf_stream *stream,
                integer_definition->declaration;
        uint64_t oldval, newval, updateval;
 
-       if (integer_declaration->len == 64) {
+       if (unlikely(integer_declaration->len == 64)) {
                stream->timestamp = integer_definition->value._unsigned;
                return;
        }
@@ -123,16 +127,19 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
        uint64_t id = 0;
        int ret;
 
-       if (pos->offset == EOF)
+       ctf_pos_get_event(pos);
+
+       if (unlikely(pos->offset == EOF))
                return EOF;
+       assert(pos->offset < pos->content_size);
 
        /* Read event header */
-       if (stream->stream_event_header) {
+       if (likely(stream->stream_event_header)) {
                struct definition_integer *integer_definition;
                struct definition *variant;
 
                ret = generic_rw(ppos, &stream->stream_event_header->p);
-               if (ret)
+               if (unlikely(ret))
                        goto error;
                /* lookup event id */
                integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
@@ -154,16 +161,20 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
                                id = integer_definition->value._unsigned;
                        }
                }
+               stream->event_id = id;
 
                /* lookup timestamp */
+               stream->has_timestamp = 0;
                integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
                if (integer_definition) {
                        ctf_update_timestamp(stream, integer_definition);
+                       stream->has_timestamp = 1;
                } else {
                        if (variant) {
                                integer_definition = lookup_integer(variant, "timestamp", FALSE);
                                if (integer_definition) {
                                        ctf_update_timestamp(stream, integer_definition);
+                                       stream->has_timestamp = 1;
                                }
                        }
                }
@@ -176,12 +187,12 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
                        goto error;
        }
 
-       if (id >= stream_class->events_by_id->len) {
+       if (unlikely(id >= stream_class->events_by_id->len)) {
                fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
                return -EINVAL;
        }
        event = g_ptr_array_index(stream->events_by_id, id);
-       if (!event) {
+       if (unlikely(!event)) {
                fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
                return -EINVAL;
        }
@@ -194,7 +205,7 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
        }
 
        /* Read event payload */
-       if (event->event_fields) {
+       if (likely(event->event_fields)) {
                ret = generic_rw(ppos, &event->event_fields->p);
                if (ret)
                        goto error;
@@ -212,35 +223,13 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream)
 {
        struct ctf_stream_class *stream_class = stream->stream_class;
        struct ctf_stream_event *event;
-       uint64_t id = 0;
+       uint64_t id;
        int ret;
 
-       /* print event header */
-       if (stream->stream_event_header) {
-               struct definition_integer *integer_definition;
-               struct definition *variant;
-
-               /* lookup event id */
-               integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
-               if (integer_definition) {
-                       id = integer_definition->value._unsigned;
-               } else {
-                       struct definition_enum *enum_definition;
-
-                       enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
-                       if (enum_definition) {
-                               id = enum_definition->integer->value._unsigned;
-                       }
-               }
-
-               variant = lookup_variant(&stream->stream_event_header->p, "v");
-               if (variant) {
-                       integer_definition = lookup_integer(variant, "id", FALSE);
-                       if (integer_definition) {
-                               id = integer_definition->value._unsigned;
-                       }
-               }
+       id = stream->event_id;
 
+       /* print event header */
+       if (likely(stream->stream_event_header)) {
                ret = generic_rw(pos, &stream->stream_event_header->p);
                if (ret)
                        goto error;
@@ -253,12 +242,12 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream)
                        goto error;
        }
 
-       if (id >= stream_class->events_by_id->len) {
+       if (unlikely(id >= stream_class->events_by_id->len)) {
                fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
                return -EINVAL;
        }
        event = g_ptr_array_index(stream->events_by_id, id);
-       if (!event) {
+       if (unlikely(!event)) {
                fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
                return -EINVAL;
        }
@@ -271,7 +260,7 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream)
        }
 
        /* Read and print event payload */
-       if (event->event_fields) {
+       if (likely(event->event_fields)) {
                ret = generic_rw(pos, &event->event_fields->p);
                if (ret)
                        goto error;
@@ -385,8 +374,11 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                assert(off >= 0);
                pos->offset = 0;
        } else {
+       read_next_packet:
                switch (whence) {
                case SEEK_CUR:
+                       if (pos->offset == EOF)
+                               return;
                        /* The reader will expect us to skip padding */
                        assert(pos->offset + offset == pos->content_size);
                        ++pos->cur_index;
@@ -410,9 +402,14 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                file_stream->parent.timestamp = index->timestamp_begin;
                pos->content_size = index->content_size;
                pos->packet_size = index->packet_size;
-               if (index->data_offset < index->content_size)
+               if (index->data_offset < index->content_size) {
                        pos->offset = 0;        /* will read headers */
-               else {
+               } else if (index->data_offset == index->content_size) {
+                       /* empty packet */
+                       pos->offset = index->data_offset;
+                       offset = 0;
+                       goto read_next_packet;
+               } else {
                        pos->offset = EOF;
                        return;
                }
@@ -453,24 +450,51 @@ int packet_metadata(struct ctf_trace *td, FILE *fp)
        if (magic == TSDL_MAGIC) {
                ret = 1;
                td->byte_order = BYTE_ORDER;
+               CTF_TRACE_SET_FIELD(td, byte_order);
        } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
                ret = 1;
                td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
                                        LITTLE_ENDIAN : BIG_ENDIAN;
+               CTF_TRACE_SET_FIELD(td, byte_order);
        }
-       CTF_TRACE_SET_FIELD(td, byte_order);
 end:
        rewind(fp);
        return ret;
 }
 
+/*
+ * Returns 0 on success, -1 on error.
+ */
+static
+int check_version(unsigned int major, unsigned int minor)
+{
+       switch (major) {
+       case 1:
+               switch (minor) {
+               case 8:
+                       return 0;
+               default:
+                       goto warning;
+               }
+       default:
+               goto warning;
+               
+       }
+
+       /* eventually return an error instead of warning */
+warning:
+       fprintf(stdout, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
+               major, minor);
+       return 0;
+}
+
 static
 int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
                                        FILE *out)
 {
        struct metadata_packet_header header;
        size_t readlen, writelen, toread;
-       char buf[4096];
+       char buf[4096 + 1];     /* + 1 for debug-mode \0 */
        int ret = 0;
 
        readlen = fread(&header, header_sizeof(header), 1, in);
@@ -500,6 +524,8 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
                        header.checksum_scheme);
                return -EINVAL;
        }
+       if (check_version(header.major, header.minor) < 0)
+               return -EINVAL;
        if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
                memcpy(td->uuid, header.uuid, sizeof(header.uuid));
                CTF_TRACE_SET_FIELD(td, uuid);
@@ -511,12 +537,13 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
        toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
 
        for (;;) {
-               readlen = fread(buf, sizeof(char), min(sizeof(buf), toread), in);
+               readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
                if (ferror(in)) {
                        ret = -EINVAL;
                        break;
                }
                if (babeltrace_debug) {
+                       buf[readlen] = '\0';
                        fprintf(stdout, "[debug] metadata packet read: %s\n",
                                buf);
                }
@@ -533,10 +560,19 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
                toread -= readlen;
                if (!toread) {
                        ret = 0;        /* continue reading next packet */
-                       break;
+                       goto read_padding;
                }
        }
        return ret;
+
+read_padding:
+       toread = (header.packet_size - header.content_size) / CHAR_BIT;
+       ret = fseek(in, toread, SEEK_CUR);
+       if (ret < 0) {
+               fprintf(stdout, "[warning] Missing padding at end of file\n");
+               ret = 0;
+       }
+       return ret;
 }
 
 static
@@ -575,7 +611,9 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
 }
 
 static
-int ctf_open_trace_metadata_read(struct ctf_trace *td)
+int ctf_open_trace_metadata_read(struct ctf_trace *td,
+               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                       int whence))
 {
        struct ctf_scanner *scanner;
        struct ctf_file_stream *metadata_stream;
@@ -584,6 +622,15 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td)
        int ret = 0;
 
        metadata_stream = g_new0(struct ctf_file_stream, 1);
+
+       if (move_pos_slow) {
+               metadata_stream->pos.move_pos_slow = move_pos_slow;
+       } else {
+               fprintf(stderr, "[error] move_pos_slow function undefined.\n");
+               ret = -1;
+               goto end_stream;
+       }
+
        td->metadata = &metadata_stream->parent;
        metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
        if (metadata_stream->pos.fd < 0) {
@@ -605,6 +652,21 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td)
                ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf);
                if (ret)
                        goto end_packet_read;
+       } else {
+               unsigned int major, minor;
+               ssize_t nr_items;
+
+               td->byte_order = BYTE_ORDER;
+
+               /* Check text-only metadata header and version */
+               nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor);
+               if (nr_items < 2)
+                       fprintf(stdout, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
+               if (check_version(major, minor) < 0) {
+                       ret = -EINVAL;
+                       goto end_packet_read;
+               }
+               rewind(fp);
        }
 
        scanner = ctf_scanner_alloc(fp);
@@ -633,7 +695,7 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td)
                goto end;
        }
        ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root,
-                       td, BYTE_ORDER);
+                       td, td->byte_order);
        if (ret) {
                fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret);
                goto end;
@@ -902,13 +964,12 @@ int create_stream_packet_index(struct ctf_trace *td,
                                return -EINVAL;
                        }
                        file_stream->parent.stream_class = stream;
+                       ret = create_stream_definitions(td, &file_stream->parent);
+                       if (ret)
+                               return ret;
                }
                first_packet = 0;
 
-               ret = create_stream_definitions(td, &file_stream->parent);
-               if (ret)
-                       return ret;
-
                if (file_stream->parent.stream_packet_context) {
                        /* Read packet context */
                        ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
@@ -987,7 +1048,7 @@ int create_stream_packet_index(struct ctf_trace *td,
 
                if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) {
                        fprintf(stdout, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
-                               packet_index.content_size, (filestats.st_size - packet_index.offset) * CHAR_BIT);
+                               packet_index.content_size, (size_t) (filestats.st_size - packet_index.offset) * CHAR_BIT);
                        return -EINVAL;
                }
 
@@ -1035,7 +1096,9 @@ error:
  * description (metadata).
  */
 static
-int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags)
+int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
+               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                       int whence))
 {
        int ret;
        struct ctf_file_stream *file_stream;
@@ -1044,6 +1107,15 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags)
        if (ret < 0)
                goto error;
        file_stream = g_new0(struct ctf_file_stream, 1);
+
+       if (move_pos_slow) {
+               file_stream->pos.move_pos_slow = move_pos_slow;
+       } else {
+               fprintf(stderr, "[error] move_pos_slow function undefined.\n");
+               ret = -1;
+               goto error_def;
+       }
+
        ctf_init_pos(&file_stream->pos, ret, flags);
        ret = create_trace_definitions(td, &file_stream->parent);
        if (ret)
@@ -1068,7 +1140,9 @@ error:
 }
 
 static
-int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags)
+int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags,
+               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                       int whence))
 {
        int ret;
        struct dirent *dirent;
@@ -1096,7 +1170,7 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags)
         * Keep the metadata file separate.
         */
 
-       ret = ctf_open_trace_metadata_read(td);
+       ret = ctf_open_trace_metadata_read(td, move_pos_slow);
        if (ret) {
                goto error_metadata;
        }
@@ -1125,7 +1199,7 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags)
                                || !strcmp(diriter->d_name, "..")
                                || !strcmp(diriter->d_name, "metadata"))
                        continue;
-               ret = ctf_open_file_stream_read(td, diriter->d_name, flags);
+               ret = ctf_open_file_stream_read(td, diriter->d_name, flags, move_pos_slow);
                if (ret) {
                        fprintf(stdout, "[error] Open file stream error.\n");
                        goto readdir_error;
@@ -1146,7 +1220,9 @@ error:
 }
 
 static
-struct trace_descriptor *ctf_open_trace(const char *path, int flags)
+struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                       int whence))
 {
        struct ctf_trace *td;
        int ret;
@@ -1159,7 +1235,7 @@ struct trace_descriptor *ctf_open_trace(const char *path, int flags)
                        fprintf(stdout, "[error] Path missing for input CTF trace.\n");
                        goto error;
                }
-               ret = ctf_open_trace_read(td, path, flags);
+               ret = ctf_open_trace_read(td, path, flags, move_pos_slow);
                if (ret)
                        goto error;
                break;
This page took 0.037582 seconds and 4 git commands to generate.