Fix : segfault when printing timestamp on index
[babeltrace.git] / formats / ctf / ctf.c
index 0e425bbb0b4d2abacc4a9d5c0297ebfb7278ab0e..fa19648155964faa6a8dbedc283a2fbb2d655ab2 100644 (file)
@@ -22,6 +22,7 @@
 #include <babeltrace/ctf/types.h>
 #include <babeltrace/ctf/metadata.h>
 #include <babeltrace/babeltrace-internal.h>
+#include <babeltrace/ctf/events-internal.h>
 #include <inttypes.h>
 #include <stdio.h>
 #include <uuid/uuid.h>
 #define min(a, b)      (((a) < (b)) ? (a) : (b))
 #endif
 
+#define NSEC_PER_SEC 1000000000ULL
+
+int opt_clock_raw,
+       opt_clock_seconds,
+       opt_clock_date,
+       opt_clock_gmt;
+
+uint64_t opt_clock_offset;
+
 extern int yydebug;
 
 static
-struct trace_descriptor *ctf_open_trace(const char *collection_path, const char *path, int flags,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
-                       int whence), FILE *metadata_fp);
+struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
+                       int whence),
+               FILE *metadata_fp);
 static
 struct trace_descriptor *ctf_open_mmap_trace(
                struct mmap_stream_list *mmap_list,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, int whence),
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
+                       int whence),
                FILE *metadata_fp);
 
 static
@@ -98,6 +110,9 @@ struct format ctf_format = {
        .close_trace = ctf_close_trace,
 };
 
+/*
+ * Update stream current timestamp, keep at clock frequency.
+ */
 static
 void ctf_update_timestamp(struct ctf_stream *stream,
                          struct definition_integer *integer_definition)
@@ -125,6 +140,82 @@ void ctf_update_timestamp(struct ctf_stream *stream,
        stream->timestamp = updateval;
 }
 
+/*
+ * Print timestamp, rescaling clock frequency to nanoseconds and
+ * applying offsets as needed (unix time).
+ */
+void ctf_print_timestamp(FILE *fp,
+                       struct ctf_stream *stream,
+                       uint64_t timestamp)
+{
+       uint64_t ts_sec = 0, ts_nsec;
+       struct ctf_trace *trace = stream->stream_class->trace;
+       struct trace_collection *tc = trace->collection;
+       uint64_t tc_offset = tc->single_clock_offset_avg;
+
+       if (stream->current_clock->freq == 1000000000ULL) {
+               ts_nsec = timestamp;
+       } else {
+               ts_nsec = (uint64_t) ((double) timestamp * 1000000000.0
+                               / (double) stream->current_clock->freq);
+       }
+
+       /* Add offsets */
+       if (!opt_clock_raw) {
+               ts_nsec += tc_offset;
+       }
+       ts_sec += opt_clock_offset;
+
+       ts_sec += ts_nsec / NSEC_PER_SEC;
+       ts_nsec = ts_nsec % NSEC_PER_SEC;
+
+       if (!opt_clock_seconds) {
+               struct tm tm;
+               time_t time_s = (time_t) ts_sec;
+
+               if (!opt_clock_gmt) {
+                       struct tm *res;
+
+                       res = localtime_r(&time_s, &tm);
+                       if (!res) {
+                               fprintf(stderr, "[warning] Unable to get localtime.\n");
+                               goto seconds;
+                       }
+               } else {
+                       struct tm *res;
+
+                       res = gmtime_r(&time_s, &tm);
+                       if (!res) {
+                               fprintf(stderr, "[warning] Unable to get gmtime.\n");
+                               goto seconds;
+                       }
+               }
+               if (opt_clock_date) {
+                       char timestr[26];
+                       size_t res;
+
+                       /* Print date and time */
+                       res = strftime(timestr, sizeof(timestr),
+                               "%F ", &tm);
+                       if (!res) {
+                               fprintf(stderr, "[warning] Unable to print ascii time.\n");
+                               goto seconds;
+                       }
+                       fprintf(fp, "%s", timestr);
+               }
+               /* Print time in HH:MM:SS.ns */
+               fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
+                       tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
+               goto end;
+       }
+seconds:
+       fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
+               ts_sec, ts_nsec);
+
+end:
+       return;
+}
+
 static
 int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
 {
@@ -141,6 +232,11 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
 
        ctf_pos_get_event(pos);
 
+       /* save the current position as a restore point */
+       pos->last_offset = pos->offset;
+       /* we just read the event, it is consumed when used by the caller */
+       stream->consumed = 0;
+
        /*
         * This is the EOF check after we've advanced the position in
         * ctf_pos_get_event.
@@ -318,7 +414,7 @@ void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
                pos->parent.rw_table = write_dispatch_table;
                pos->parent.event_cb = ctf_write_event;
                if (fd >= 0)
-                       ctf_move_pos_slow(pos, 0, SEEK_SET);    /* position for write */
+                       ctf_packet_seek(&pos->parent, 0, SEEK_SET);     /* position for write */
                break;
        default:
                assert(0);
@@ -343,13 +439,19 @@ void ctf_fini_pos(struct ctf_stream_pos *pos)
        (void) g_array_free(pos->packet_index, TRUE);
 }
 
-void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
+/*
+ * for SEEK_CUR: go to next packet.
+ * for SEEK_POS: go to packet numer (index).
+ */
+void ctf_packet_seek(struct stream_pos *stream_pos, size_t index, int whence)
 {
+       struct ctf_stream_pos *pos =
+               container_of(stream_pos, struct ctf_stream_pos, parent);
        struct ctf_file_stream *file_stream =
                container_of(pos, struct ctf_file_stream, pos);
        int ret;
        off_t off;
-       struct packet_index *index;
+       struct packet_index *packet_index;
 
        if (pos->prot == PROT_WRITE && pos->content_size_loc)
                *pos->content_size_loc = pos->offset;
@@ -373,11 +475,10 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                switch (whence) {
                case SEEK_CUR:
                        /* The writer will add padding */
-                       assert(pos->offset + offset == pos->packet_size);
                        pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
                        break;
                case SEEK_SET:
-                       assert(offset == 0);    /* only seek supported for now */
+                       assert(index == 0);     /* only seek supported for now */
                        pos->cur_index = 0;
                        break;
                default:
@@ -396,30 +497,29 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                {
                        uint32_t events_discarded_diff;
 
+                       if (pos->offset == EOF) {
+                               return;
+                       }
                        /* For printing discarded event count */
-                       index = &g_array_index(pos->packet_index,
+                       packet_index = &g_array_index(pos->packet_index,
                                        struct packet_index, pos->cur_index);
-                       events_discarded_diff = index->events_discarded;
+                       events_discarded_diff = packet_index->events_discarded;
                        file_stream->parent.prev_timestamp_end =
-                                               index->timestamp_end;
+                                               packet_index->timestamp_end;
                        if (pos->cur_index > 0) {
-                               index = &g_array_index(pos->packet_index,
+                               packet_index = &g_array_index(pos->packet_index,
                                                struct packet_index,
                                                pos->cur_index - 1);
-                               events_discarded_diff -= index->events_discarded;
+                               events_discarded_diff -= packet_index->events_discarded;
                        }
                        file_stream->parent.events_discarded = events_discarded_diff;
-                       if (pos->offset == EOF)
-                               return;
+                       file_stream->parent.prev_timestamp = file_stream->parent.timestamp;
                        /* The reader will expect us to skip padding */
-                       assert(pos->offset + offset == pos->content_size);
                        ++pos->cur_index;
-                       file_stream->parent.prev_timestamp = file_stream->parent.timestamp;
                        break;
                }
                case SEEK_SET:
-                       assert(offset == 0);    /* only seek supported for now */
-                       pos->cur_index = 0;
+                       pos->cur_index = index;
                        file_stream->parent.prev_timestamp = 0;
                        file_stream->parent.prev_timestamp_end = 0;
                        break;
@@ -427,23 +527,51 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                        assert(0);
                }
                if (pos->cur_index >= pos->packet_index->len) {
+                       /*
+                        * When a stream reaches the end of the
+                        * file, we need to show the number of
+                        * events discarded ourselves, because
+                        * there is no next event scheduled to
+                        * be printed in the output.
+                        */
+                       if (file_stream->parent.events_discarded) {
+                               /*
+                                * We need to check if we are in trace
+                                * read or called from packet indexing.
+                                * In this last case, the collection is
+                                * not there, so we cannot print the
+                                * timestamps.
+                                */
+                               if ((&file_stream->parent)->stream_class->trace->collection) {
+                                       fflush(stdout);
+                                       fprintf(stderr, "[warning] Tracer discarded %d events at end of stream between [",
+                                                       file_stream->parent.events_discarded);
+                                       ctf_print_timestamp(stderr, &file_stream->parent,
+                                                       file_stream->parent.prev_timestamp);
+                                       fprintf(stderr, "] and [");
+                                       ctf_print_timestamp(stderr, &file_stream->parent,
+                                                       file_stream->parent.prev_timestamp_end);
+                                       fprintf(stderr, "]. You should consider increasing the buffer size.\n");
+                                       fflush(stderr);
+                               }
+                               file_stream->parent.events_discarded = 0;
+                       }
                        pos->offset = EOF;
                        return;
                }
-               index = &g_array_index(pos->packet_index, struct packet_index,
+               packet_index = &g_array_index(pos->packet_index, struct packet_index,
                                       pos->cur_index);
-               pos->mmap_offset = index->offset;
+               pos->mmap_offset = packet_index->offset;
 
                /* Lookup context/packet size in index */
-               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) {
+               file_stream->parent.timestamp = packet_index->timestamp_begin;
+               pos->content_size = packet_index->content_size;
+               pos->packet_size = packet_index->packet_size;
+               if (packet_index->data_offset < packet_index->content_size) {
                        pos->offset = 0;        /* will read headers */
-               } else if (index->data_offset == index->content_size) {
+               } else if (packet_index->data_offset == packet_index->content_size) {
                        /* empty packet */
-                       pos->offset = index->data_offset;
-                       offset = 0;
+                       pos->offset = packet_index->data_offset;
                        whence = SEEK_CUR;
                        goto read_next_packet;
                } else {
@@ -654,7 +782,7 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
 
 static
 int ctf_open_trace_metadata_read(struct ctf_trace *td,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence), FILE *metadata_fp)
 {
        struct ctf_scanner *scanner;
@@ -665,10 +793,10 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td,
 
        metadata_stream = g_new0(struct ctf_file_stream, 1);
 
-       if (move_pos_slow) {
-               metadata_stream->pos.move_pos_slow = move_pos_slow;
+       if (packet_seek) {
+               metadata_stream->pos.packet_seek = packet_seek;
        } else {
-               fprintf(stderr, "[error] move_pos_slow function undefined.\n");
+               fprintf(stderr, "[error] packet_seek function undefined.\n");
                ret = -1;
                goto end_stream;
        }
@@ -1071,14 +1199,14 @@ int create_stream_packet_index(struct ctf_trace *td,
 
                /* Validate content size and packet size values */
                if (packet_index.content_size > packet_index.packet_size) {
-                       fprintf(stderr, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
+                       fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
                                packet_index.content_size, packet_index.packet_size);
                        return -EINVAL;
                }
 
-               if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) {
-                       fprintf(stderr, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
-                               packet_index.content_size, (size_t) (filestats.st_size - packet_index.offset) * CHAR_BIT);
+               if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) {
+                       fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
+                               packet_index.content_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT);
                        return -EINVAL;
                }
 
@@ -1092,7 +1220,7 @@ int create_stream_packet_index(struct ctf_trace *td,
        }
 
        /* Move pos back to beginning of file */
-       ctf_move_pos_slow(pos, 0, SEEK_SET);    /* position for write */
+       ctf_packet_seek(&pos->parent, 0, SEEK_SET);     /* position for write */
 
        return 0;
 }
@@ -1127,7 +1255,7 @@ error:
  */
 static
 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,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence))
 {
        int ret;
@@ -1140,10 +1268,10 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
        }
        file_stream = g_new0(struct ctf_file_stream, 1);
 
-       if (move_pos_slow) {
-               file_stream->pos.move_pos_slow = move_pos_slow;
+       if (packet_seek) {
+               file_stream->pos.packet_seek = packet_seek;
        } else {
-               fprintf(stderr, "[error] move_pos_slow function undefined.\n");
+               fprintf(stderr, "[error] packet_seek function undefined.\n");
                ret = -1;
                goto error_def;
        }
@@ -1152,6 +1280,10 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
        ret = create_trace_definitions(td, &file_stream->parent);
        if (ret)
                goto error_def;
+       /*
+        * For now, only a single slock is supported.
+        */
+       file_stream->parent.current_clock = td->single_clock;
        ret = create_stream_packet_index(td, file_stream);
        if (ret)
                goto error_index;
@@ -1171,106 +1303,16 @@ error:
        return ret;
 }
 
-static void
-init_domain_name(struct ctf_trace *td)
-{
-       char *start, *end;
-
-       start = td->path + strlen(td->collection_path);
-       while (start[0] == '/')
-               start++;        /* skip / */
-       end = strchr(start, '/');
-       if (!end)
-               end = start + strlen(start);
-       memcpy(td->domain, start, end - start);
-       td->domain[end - start] = '\0';
-}
-
-static void
-init_proc_name(struct ctf_trace *td)
-{
-       char buf[PATH_MAX];
-       char *start, *end;
-
-       if (td->domain[0] == '\0')
-               return;
-       memcpy(buf, td->path, PATH_MAX);
-       start = buf + strlen(td->collection_path);
-       while (start[0] == '/')
-               start++;        /* skip / */
-       start = strchr(start, '/');     /* get begin of domain content */
-       if (!start)
-               return;
-       while (start[0] == '/')
-               start++;        /* skip / */
-       /* find last -, skips time */
-       end = strrchr(start, '-');
-       if (!end)
-               return;
-       *end = '\0';
-       /* find previous -, skips date */
-       end = strrchr(start, '-');
-       if (!end)
-               return;
-       *end = '\0';
-       /* find previous -, skips pid */
-       end = strrchr(start, '-');
-       if (!end)
-               return;
-       *end = '\0';
-
-       memcpy(td->procname, start, end - start);
-       td->procname[end - start] = '\0';
-}
-
-static void
-init_vpid(struct ctf_trace *td)
-{
-       char buf[PATH_MAX];
-       char *start, *end;
-
-       if (td->domain[0] == '\0')
-               return;
-       memcpy(buf, td->path, PATH_MAX);
-       start = buf + strlen(td->collection_path);
-       while (start[0] == '/')
-               start++;        /* skip / */
-       start = strchr(start, '/');     /* get begin of domain content */
-       if (!start)
-               return;
-       while (start[0] == '/')
-               start++;        /* skip / */
-       /* find last -, skips time */
-       end = strrchr(start, '-');
-       if (!end)
-               return;
-       *end = '\0';
-       /* find previous -, skips date */
-       end = strrchr(start, '-');
-       if (!end)
-               return;
-       *end = '\0';
-       /* find previous -, skips pid */
-       start = strrchr(start, '-');
-       if (!start)
-               return;
-       start++;        /* skip - */
-
-       memcpy(td->vpid, start, end - start);
-       td->vpid[end - start] = '\0';
-}
-
 static
-int ctf_open_trace_read(struct ctf_trace *td, const char *collection_path,
+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,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence), FILE *metadata_fp)
 {
        int ret;
        struct dirent *dirent;
        struct dirent *diriter;
        size_t dirent_len;
-       char *respath, *rescolpath;
 
        td->flags = flags;
 
@@ -1289,25 +1331,14 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *collection_path,
                ret = -errno;
                goto error_dirfd;
        }
-       rescolpath = realpath(collection_path, td->collection_path);
-       if (!rescolpath) {
-               fprintf(stderr, "[error] collection path resolution failure\n");
-               return -EINVAL;
-       }
-       respath = realpath(path, td->path);
-       if (!respath) {
-               fprintf(stderr, "[error] path resolution failure\n");
-               return -EINVAL;
-       }
-       init_domain_name(td);
-       init_proc_name(td);
-       init_vpid(td);
+       strncpy(td->path, path, sizeof(td->path));
+       td->path[sizeof(td->path) - 1] = '\0';
 
        /*
         * Keep the metadata file separate.
         */
 
-       ret = ctf_open_trace_metadata_read(td, move_pos_slow, metadata_fp);
+       ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp);
        if (ret) {
                goto error_metadata;
        }
@@ -1336,7 +1367,8 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *collection_path,
                                || !strcmp(diriter->d_name, "..")
                                || !strcmp(diriter->d_name, "metadata"))
                        continue;
-               ret = ctf_open_file_stream_read(td, diriter->d_name, flags, move_pos_slow);
+               ret = ctf_open_file_stream_read(td, diriter->d_name,
+                                       flags, packet_seek);
                if (ret) {
                        fprintf(stderr, "[error] Open file stream error.\n");
                        goto readdir_error;
@@ -1357,13 +1389,19 @@ error:
 }
 
 static
-struct trace_descriptor *ctf_open_trace(const char *collection_path, const char *path, int flags,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence), FILE *metadata_fp)
 {
        struct ctf_trace *td;
        int ret;
 
+       /*
+        * If packet_seek is NULL, we provide our default version.
+        */
+       if (!packet_seek)
+               packet_seek = ctf_packet_seek;
+
        td = g_new0(struct ctf_trace, 1);
 
        switch (flags & O_ACCMODE) {
@@ -1372,7 +1410,7 @@ struct trace_descriptor *ctf_open_trace(const char *collection_path, const char
                        fprintf(stderr, "[error] Path missing for input CTF trace.\n");
                        goto error;
                }
-               ret = ctf_open_trace_read(td, collection_path, path, flags, move_pos_slow, metadata_fp);
+               ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
                if (ret)
                        goto error;
                break;
@@ -1441,7 +1479,7 @@ end:
 static
 int ctf_open_mmap_stream_read(struct ctf_trace *td,
                struct mmap_stream *mmap_info,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence))
 {
        int ret;
@@ -1450,7 +1488,7 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td,
        file_stream = g_new0(struct ctf_file_stream, 1);
        ctf_init_mmap_pos(&file_stream->pos, mmap_info);
 
-       file_stream->pos.move_pos_slow = move_pos_slow;
+       file_stream->pos.packet_seek = packet_seek;
 
        ret = create_trace_definitions(td, &file_stream->parent);
        if (ret) {
@@ -1476,14 +1514,14 @@ error_def:
 
 int ctf_open_mmap_trace_read(struct ctf_trace *td,
                struct mmap_stream_list *mmap_list,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
                        int whence),
                FILE *metadata_fp)
 {
        int ret;
        struct mmap_stream *mmap_info;
 
-       ret = ctf_open_trace_metadata_read(td, ctf_move_pos_slow, metadata_fp);
+       ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp);
        if (ret) {
                goto error;
        }
@@ -1492,8 +1530,8 @@ int ctf_open_mmap_trace_read(struct ctf_trace *td,
         * for each stream, try to open, check magic number, and get the
         * stream ID to add to the right location in the stream array.
         */
-       cds_list_for_each_entry(mmap_info, &mmap_list->head, list) {
-               ret = ctf_open_mmap_stream_read(td, mmap_info, move_pos_slow);
+       bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
+               ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
                if (ret) {
                        fprintf(stderr, "[error] Open file mmap stream error.\n");
                        goto error;
@@ -1509,7 +1547,8 @@ error:
 static
 struct trace_descriptor *ctf_open_mmap_trace(
                struct mmap_stream_list *mmap_list,
-               void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, int whence),
+               void (*packet_seek)(struct stream_pos *pos, size_t index,
+                       int whence),
                FILE *metadata_fp)
 {
        struct ctf_trace *td;
@@ -1520,12 +1559,12 @@ struct trace_descriptor *ctf_open_mmap_trace(
                                "required for mmap parsing\n");
                goto error;
        }
-       if (!move_pos_slow) {
-               fprintf(stderr, "[error] move_pos_slow function undefined.\n");
+       if (!packet_seek) {
+               fprintf(stderr, "[error] packet_seek function undefined.\n");
                goto error;
        }
        td = g_new0(struct ctf_trace, 1);
-       ret = ctf_open_mmap_trace_read(td, mmap_list, move_pos_slow, metadata_fp);
+       ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
        if (ret)
                goto error_free;
 
This page took 0.031506 seconds and 4 git commands to generate.