Output a warning if packets are lost
[babeltrace.git] / formats / ctf / ctf.c
index e31808c3843d27380a63b0d173a949aa027e336e..a617497e05b719d544e5d662137632d4cb3d3718 100644 (file)
@@ -53,6 +53,7 @@
 #include "metadata/ctf-ast.h"
 #include "events-private.h"
 #include <babeltrace/compat/memstream.h>
+#include <babeltrace/compat/fcntl.h>
 
 #define LOG2_CHAR_BIT  3
 
@@ -420,16 +421,26 @@ void print_uuid(FILE *fp, unsigned char *uuid)
  * Given we have discarded counters of those two types merged into the
  * events_discarded counter, we need to use the union of those ranges:
  *   [ prev_timestamp_end, timestamp_end ]
+ *
+ * Lost packets occur if the tracer overwrote some subbuffer(s) before the
+ * consumer had time to extract them. We keep track of those gaps with the
+ * packet sequence number in each packet.
  */
 static
-void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream)
+void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream)
 {
-       if (!stream->events_discarded || !babeltrace_ctf_console_output) {
+       if ((!stream->events_discarded && !stream->packets_lost) ||
+                       !babeltrace_ctf_console_output) {
                return;
        }
        fflush(stdout);
-       fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [",
-               stream->events_discarded);
+       if (stream->events_discarded) {
+               fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [",
+                               stream->events_discarded);
+       } else if (stream->packets_lost) {
+               fprintf(fp, "[warning] Tracer lost %" PRIu64 " trace packets between [",
+                               stream->packets_lost);
+       }
        if (opt_clock_cycles) {
                ctf_print_timestamp(fp, stream,
                                stream->prev.cycles.end);
@@ -763,13 +774,11 @@ int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
                pos->parent.trace = trace;
                break;
        case O_RDWR:
-               pos->prot = PROT_WRITE; /* Write has priority */
+               pos->prot = PROT_READ | PROT_WRITE;
                pos->flags = MAP_SHARED;
                pos->parent.rw_table = write_dispatch_table;
                pos->parent.event_cb = ctf_write_event;
                pos->parent.trace = trace;
-               if (fd >= 0)
-                       ctf_packet_seek(&pos->parent, 0, SEEK_SET);     /* position for write */
                break;
        default:
                assert(0);
@@ -779,7 +788,7 @@ int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
 
 int ctf_fini_pos(struct ctf_stream_pos *pos)
 {
-       if (pos->prot == PROT_WRITE && pos->content_size_loc)
+       if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
                *pos->content_size_loc = pos->offset;
        if (pos->base_mma) {
                int ret;
@@ -802,6 +811,7 @@ void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
                struct packet_index *cur_index)
 {
        uint64_t events_discarded_diff;
+       uint64_t packets_lost_diff = 0;
 
        /* Update packet index time information */
 
@@ -829,6 +839,11 @@ void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
                        prev_index->ts_real.timestamp_end;
 
                events_discarded_diff -= prev_index->events_discarded;
+               /* packet_seq_num stays at 0 if not produced by the tracer */
+               if (cur_index->packet_seq_num) {
+                       packets_lost_diff = cur_index->packet_seq_num -
+                               prev_index->packet_seq_num - 1;
+               }
                /*
                 * Deal with 32-bit wrap-around if the tracer provided a
                 * 32-bit field.
@@ -849,6 +864,7 @@ void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
                                stream->current.real.begin;
        }
        stream->events_discarded = events_discarded_diff;
+       stream->packets_lost = packets_lost_diff;
 }
 
 /*
@@ -862,7 +878,6 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
        struct ctf_file_stream *file_stream =
                container_of(pos, struct ctf_file_stream, pos);
        int ret;
-       off_t off;
        struct packet_index *packet_index, *prev_index;
 
        switch (whence) {
@@ -873,7 +888,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                assert(0);
        }
 
-       if (pos->prot == PROT_WRITE && pos->content_size_loc)
+       if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
                *pos->content_size_loc = pos->offset;
 
        if (pos->base_mma) {
@@ -891,7 +906,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
         * The caller should never ask for ctf_move_pos across packets,
         * except to get exactly at the beginning of the next packet.
         */
-       if (pos->prot == PROT_WRITE) {
+       if (pos->prot & PROT_WRITE) {
                switch (whence) {
                case SEEK_CUR:
                        /* The writer will add padding */
@@ -906,9 +921,11 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                }
                pos->content_size = -1U;        /* Unknown at this point */
                pos->packet_size = WRITE_PACKET_LEN;
-               off = posix_fallocate(pos->fd, pos->mmap_offset,
-                                     pos->packet_size / CHAR_BIT);
-               assert(off >= 0);
+               do {
+                       ret = bt_posix_fallocate(pos->fd, pos->mmap_offset,
+                                             pos->packet_size / CHAR_BIT);
+               } while (ret == EINTR);
+               assert(ret == 0);
                pos->offset = 0;
        } else {
        read_next_packet:
@@ -958,7 +975,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                 * timestamps.
                 */
                if ((&file_stream->parent)->stream_class->trace->parent.collection) {
-                       ctf_print_discarded(stderr, &file_stream->parent);
+                       ctf_print_discarded_lost(stderr, &file_stream->parent);
                }
 
                packet_index = &g_array_index(pos->packet_index,
@@ -1001,12 +1018,14 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
        }
 
        /* update trace_packet_header and stream_packet_context */
-       if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) {
+       if (!(pos->prot & PROT_WRITE) &&
+               file_stream->parent.trace_packet_header) {
                /* Read packet header */
                ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
                assert(!ret);
        }
-       if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) {
+       if (!(pos->prot & PROT_WRITE) &&
+               file_stream->parent.stream_packet_context) {
                /* Read packet context */
                ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
                assert(!ret);
@@ -1107,7 +1126,7 @@ int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
                memcpy(td->uuid, header.uuid, sizeof(header.uuid));
                CTF_TRACE_SET_FIELD(td, uuid);
        } else {
-               if (babeltrace_uuid_compare(header.uuid, td->uuid))
+               if (bt_uuid_compare(header.uuid, td->uuid))
                        return -EINVAL;
        }
 
@@ -1508,6 +1527,7 @@ int create_stream_one_packet_index(struct ctf_stream_pos *pos,
        int ret;
 
 begin:
+       memset(&packet_index, 0, sizeof(packet_index));
        if (!pos->mmap_offset) {
                first_packet = 1;
        }
@@ -1539,14 +1559,6 @@ begin:
        pos->offset = 0;        /* Position of the packet header */
 
        packet_index.offset = pos->mmap_offset;
-       packet_index.content_size = 0;
-       packet_index.packet_size = 0;
-       packet_index.ts_real.timestamp_begin = 0;
-       packet_index.ts_real.timestamp_end = 0;
-       packet_index.ts_cycles.timestamp_begin = 0;
-       packet_index.ts_cycles.timestamp_end = 0;
-       packet_index.events_discarded = 0;
-       packet_index.events_discarded_len = 0;
 
        /* read and check header, set stream id (and check) */
        if (file_stream->parent.trace_packet_header) {
@@ -1593,7 +1605,7 @@ begin:
                                elem = bt_array_index(defarray, i);
                                uuidval[i] = bt_get_unsigned_int(elem);
                        }
-                       ret = babeltrace_uuid_compare(td->uuid, uuidval);
+                       ret = bt_uuid_compare(td->uuid, uuidval);
                        if (ret) {
                                fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
                                return -EINVAL;
@@ -1693,6 +1705,19 @@ begin:
                        packet_index.events_discarded = bt_get_unsigned_int(field);
                        packet_index.events_discarded_len = bt_get_int_len(field);
                }
+
+               /* read packet_seq_num from header */
+               len_index = bt_struct_declaration_lookup_field_index(
+                               file_stream->parent.stream_packet_context->declaration,
+                               g_quark_from_static_string("packet_seq_num"));
+               if (len_index >= 0) {
+                       struct bt_definition *field;
+
+                       field = bt_struct_definition_get_field_from_index(
+                                       file_stream->parent.stream_packet_context,
+                                       len_index);
+                       packet_index.packet_seq_num = bt_get_unsigned_int(field);
+               }
        } else {
                /* Use file size for packet size */
                packet_index.packet_size = filesize * CHAR_BIT;
@@ -1833,7 +1858,7 @@ int import_stream_packet_index(struct ctf_trace *td,
        struct ctf_packet_index *ctf_index = NULL;
        struct ctf_packet_index_file_hdr index_hdr;
        struct packet_index index;
-       uint32_t packet_index_len;
+       uint32_t packet_index_len, index_minor;
        int ret = 0;
        int first_packet = 1;
        size_t len;
@@ -1853,14 +1878,16 @@ int import_stream_packet_index(struct ctf_trace *td,
                goto error;
        }
        if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
-               fprintf(stderr, "[error] Incompatible index file %" PRIu64
-                               ".%" PRIu64 ", supported %d.%d\n",
-                               be64toh(index_hdr.index_major),
-                               be64toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
+               fprintf(stderr, "[error] Incompatible index file %" PRIu32
+                               ".%" PRIu32 ", supported %d.%d\n",
+                               be32toh(index_hdr.index_major),
+                               be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
                                CTF_INDEX_MINOR);
                ret = -1;
                goto error;
        }
+       index_minor = be32toh(index_hdr.index_minor);
+
        packet_index_len = be32toh(index_hdr.packet_index_len);
        if (packet_index_len == 0) {
                fprintf(stderr, "[error] Packet index length cannot be 0.\n");
@@ -1887,6 +1914,10 @@ int import_stream_packet_index(struct ctf_trace *td,
                index.events_discarded_len = 64;
                index.data_offset = -1;
                stream_id = be64toh(ctf_index->stream_id);
+               if (index_minor >= 1) {
+                       index.stream_instance_id = be64toh(ctf_index->stream_instance_id);
+                       index.packet_seq_num = be64toh(ctf_index->packet_seq_num);
+               }
 
                if (!first_packet) {
                        /* add index to packet array */
@@ -1962,6 +1993,11 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
                ret = 0;
                goto fd_is_dir_ok;
        }
+       if (!statbuf.st_size) {
+               /** Skip empty files. */
+               ret = 0;
+               goto fd_is_empty_file;
+       }
 
        file_stream = g_new0(struct ctf_file_stream, 1);
        file_stream->pos.last_offset = LAST_OFFSET_POISON;
@@ -1996,12 +2032,13 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
        index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
        if (!index_name) {
                fprintf(stderr, "[error] Cannot allocate index filename\n");
+               ret = -ENOMEM;
                goto error_def;
        }
        snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
                        INDEX_PATH, path);
 
-       if (faccessat(td->dirfd, index_name, O_RDONLY, flags) < 0) {
+       if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) {
                ret = create_stream_packet_index(td, file_stream);
                if (ret) {
                        fprintf(stderr, "[error] Stream index creation error.\n");
@@ -2054,6 +2091,7 @@ error_def:
                fprintf(stderr, "Error on ctf_fini_pos\n");
        }
        g_free(file_stream);
+fd_is_empty_file:
 fd_is_dir_ok:
 fstat_error:
        closeret = close(fd);
@@ -2245,13 +2283,17 @@ void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
 
 static
 int prepare_mmap_stream_definition(struct ctf_trace *td,
-               struct ctf_file_stream *file_stream)
+               struct ctf_file_stream *file_stream,
+               void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
+                       int whence))
 {
        struct ctf_stream_declaration *stream;
-       uint64_t stream_id = 0;
+       uint64_t stream_id;
        int ret;
 
-       file_stream->parent.stream_id = stream_id;
+       /* Ask for the first packet to get the stream_id. */
+       packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
+       stream_id = file_stream->parent.stream_id;
        if (stream_id >= td->streams->len) {
                fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
                                "in metadata.\n", stream_id);
@@ -2281,6 +2323,7 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td,
        struct ctf_file_stream *file_stream;
 
        file_stream = g_new0(struct ctf_file_stream, 1);
+       file_stream->parent.stream_id = -1ULL;
        file_stream->pos.last_offset = LAST_OFFSET_POISON;
        ctf_init_mmap_pos(&file_stream->pos, mmap_info);
 
@@ -2291,7 +2334,7 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td,
                goto error_def;
        }
 
-       ret = prepare_mmap_stream_definition(td, file_stream);
+       ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
        if (ret)
                goto error_index;
 
This page took 0.027245 seconds and 4 git commands to generate.