allow printing domains when no procname are present, handle various / patterns
[babeltrace.git] / formats / ctf / ctf.c
index f9f9e47fde8947812b40034077431f04584a7000..20f2dae0bd6efe28c2ca3b70da43ba0929f9063f 100644 (file)
 extern int yydebug;
 
 static
-struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+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);
 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),
+               FILE *metadata_fp);
+
+static
 void ctf_close_trace(struct trace_descriptor *descriptor);
 
 static
@@ -88,6 +94,7 @@ rw_dispatch write_dispatch_table[] = {
 static
 struct format ctf_format = {
        .open_trace = ctf_open_trace,
+       .open_mmap_trace = ctf_open_mmap_trace,
        .close_trace = ctf_close_trace,
 };
 
@@ -127,8 +134,16 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
        uint64_t id = 0;
        int ret;
 
+       /* We need to check for EOF here for empty files. */
+       if (unlikely(pos->offset == EOF))
+               return EOF;
+
        ctf_pos_get_event(pos);
 
+       /*
+        * This is the EOF check after we've advanced the position in
+        * ctf_pos_get_event.
+        */
        if (unlikely(pos->offset == EOF))
                return EOF;
        assert(pos->offset < pos->content_size);
@@ -408,6 +423,7 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
                        /* empty packet */
                        pos->offset = index->data_offset;
                        offset = 0;
+                       whence = SEEK_CUR;
                        goto read_next_packet;
                } else {
                        pos->offset = EOF;
@@ -590,9 +606,10 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
         * \0). This is the allocated size, not the actual string size.
         */
        out = open_memstream(buf, &size);
-       if (out == NULL)
+       if (out == NULL) {
+               perror("Metadata open_memstream");
                return -errno;
-
+       }
        for (;;) {
                ret = ctf_open_trace_metadata_packet_read(td, in, out);
                if (ret) {
@@ -607,6 +624,10 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
        fclose(in);
        /* open for reading */
        *fp = fmemopen(*buf, strlen(*buf), "rb");
+       if (!*fp) {
+               perror("Metadata fmemopen");
+               return -errno;
+       }
        return 0;
 }
 
@@ -644,6 +665,7 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td,
                fp = fdopen(metadata_stream->pos.fd, "r");
                if (!fp) {
                        fprintf(stdout, "[error] Unable to open metadata stream.\n");
+                       perror("Metadata stream open");
                        ret = -errno;
                        goto end_stream;
                }
@@ -891,16 +913,14 @@ int create_stream_packet_index(struct ctf_trace *td,
                                return ret;
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
+                               uint64_t magic;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               if (defint->value._unsigned != CTF_MAGIC) {
+                               magic = get_unsigned_int(field);
+                               if (magic != CTF_MAGIC) {
                                        fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
-                                                       defint->value._unsigned,
+                                                       magic,
                                                        file_stream->pos.packet_index->len,
                                                        (ssize_t) pos->mmap_offset);
                                        return -EINVAL;
@@ -919,16 +939,12 @@ int create_stream_packet_index(struct ctf_trace *td,
                                assert(field->declaration->id == CTF_TYPE_ARRAY);
                                defarray = container_of(field, struct definition_array, p);
                                assert(array_len(defarray) == UUID_LEN);
-                               assert(defarray->declaration->elem->id == CTF_TYPE_INTEGER);
 
                                for (i = 0; i < UUID_LEN; i++) {
                                        struct definition *elem;
-                                       struct definition_integer *defint;
 
                                        elem = array_index(defarray, i);
-                                       assert(elem);
-                                       defint = container_of(elem, struct definition_integer, p);
-                                       uuidval[i] = defint->value._unsigned;
+                                       uuidval[i] = get_unsigned_int(elem);
                                }
                                ret = uuid_compare(td->uuid, uuidval);
                                if (ret) {
@@ -940,14 +956,10 @@ int create_stream_packet_index(struct ctf_trace *td,
 
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               stream_id = defint->value._unsigned;
+                               stream_id = get_unsigned_int(field);
                        }
                }
 
@@ -981,14 +993,10 @@ int create_stream_packet_index(struct ctf_trace *td,
                        /* read content size from header */
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               packet_index.content_size = defint->value._unsigned;
+                               packet_index.content_size = get_unsigned_int(field);
                        } else {
                                /* Use file size for packet size */
                                packet_index.content_size = filestats.st_size * CHAR_BIT;
@@ -997,14 +1005,10 @@ int create_stream_packet_index(struct ctf_trace *td,
                        /* read packet size from header */
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               packet_index.packet_size = defint->value._unsigned;
+                               packet_index.packet_size = get_unsigned_int(field);
                        } else {
                                /* Use content size if non-zero, else file size */
                                packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
@@ -1013,27 +1017,19 @@ int create_stream_packet_index(struct ctf_trace *td,
                        /* read timestamp begin from header */
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               packet_index.timestamp_begin = defint->value._unsigned;
+                               packet_index.timestamp_begin = get_unsigned_int(field);
                        }
 
                        /* read timestamp end from header */
                        len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
                        if (len_index >= 0) {
-                               struct definition_integer *defint;
                                struct definition *field;
 
                                field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
-                               assert(field->declaration->id == CTF_TYPE_INTEGER);
-                               defint = container_of(field, struct definition_integer, p);
-                               assert(defint->declaration->signedness == FALSE);
-                               packet_index.timestamp_end = defint->value._unsigned;
+                               packet_index.timestamp_end = get_unsigned_int(field);
                        }
                } else {
                        /* Use file size for packet size */
@@ -1107,8 +1103,10 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
        struct ctf_file_stream *file_stream;
 
        ret = openat(td->dirfd, path, flags);
-       if (ret < 0)
+       if (ret < 0) {
+               perror("File stream openat()");
                goto error;
+       }
        file_stream = g_new0(struct ctf_file_stream, 1);
 
        if (move_pos_slow) {
@@ -1142,8 +1140,98 @@ 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 *path, int flags,
+int ctf_open_trace_read(struct ctf_trace *td, 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)
 {
@@ -1165,9 +1253,17 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags,
        td->dirfd = open(path, 0);
        if (td->dirfd < 0) {
                fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n");
-               ret = -ENOENT;
+               perror("Trace directory open");
+               ret = -errno;
                goto error_dirfd;
        }
+       strncpy(td->collection_path, collection_path, PATH_MAX);
+       td->collection_path[PATH_MAX - 1] = '\0';
+       strncpy(td->path, path, PATH_MAX);
+       td->path[PATH_MAX - 1] = '\0';
+       init_domain_name(td);
+       init_proc_name(td);
+       init_vpid(td);
 
        /*
         * Keep the metadata file separate.
@@ -1223,7 +1319,7 @@ error:
 }
 
 static
-struct trace_descriptor *ctf_open_trace(const char *path, int flags,
+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)
 {
@@ -1238,7 +1334,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, move_pos_slow, metadata_fp);
+               ret = ctf_open_trace_read(td, collection_path, path, flags, move_pos_slow, metadata_fp);
                if (ret)
                        goto error;
                break;
@@ -1256,6 +1352,153 @@ error:
        return NULL;
 }
 
+
+void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
+               struct mmap_stream *mmap_info)
+{
+       pos->mmap_offset = 0;
+       pos->packet_size = 0;
+       pos->content_size = 0;
+       pos->content_size_loc = NULL;
+       pos->fd = mmap_info->fd;
+       pos->base = 0;
+       pos->offset = 0;
+       pos->dummy = false;
+       pos->cur_index = 0;
+       pos->packet_index = NULL;
+       pos->prot = PROT_READ;
+       pos->flags = MAP_PRIVATE;
+       pos->parent.rw_table = read_dispatch_table;
+       pos->parent.event_cb = ctf_read_event;
+}
+
+static
+int prepare_mmap_stream_definition(struct ctf_trace *td,
+               struct ctf_file_stream *file_stream)
+{
+       struct ctf_stream_class *stream;
+       uint64_t stream_id = 0;
+       int ret;
+
+       file_stream->parent.stream_id = stream_id;
+       if (stream_id >= td->streams->len) {
+               fprintf(stdout, "[error] Stream %" PRIu64 " is not declared "
+                               "in metadata.\n", stream_id);
+               ret = -EINVAL;
+               goto end;
+       }
+       stream = g_ptr_array_index(td->streams, stream_id);
+       if (!stream) {
+               fprintf(stdout, "[error] Stream %" PRIu64 " is not declared "
+                               "in metadata.\n", stream_id);
+               ret = -EINVAL;
+               goto end;
+       }
+       file_stream->parent.stream_class = stream;
+       ret = create_stream_definitions(td, &file_stream->parent);
+end:
+       return ret;
+}
+
+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,
+                       int whence))
+{
+       int ret;
+       struct ctf_file_stream *file_stream;
+
+       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;
+
+       ret = create_trace_definitions(td, &file_stream->parent);
+       if (ret) {
+               goto error_def;
+       }
+
+       ret = prepare_mmap_stream_definition(td, file_stream);
+       if (ret)
+               goto error_index;
+
+       /* Add stream file to stream class */
+       g_ptr_array_add(file_stream->parent.stream_class->streams,
+                       &file_stream->parent);
+       return 0;
+
+error_index:
+       if (file_stream->parent.trace_packet_header)
+               definition_unref(&file_stream->parent.trace_packet_header->p);
+error_def:
+       g_free(file_stream);
+       return ret;
+}
+
+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,
+                       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);
+       if (ret) {
+               goto error;
+       }
+
+       /*
+        * 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);
+               if (ret) {
+                       fprintf(stdout, "[error] Open file mmap stream error.\n");
+                       goto error;
+               }
+       }
+
+       return 0;
+
+error:
+       return ret;
+}
+
+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),
+               FILE *metadata_fp)
+{
+       struct ctf_trace *td;
+       int ret;
+
+       if (!metadata_fp) {
+               fprintf(stderr, "[error] No metadata file pointer associated, "
+                               "required for mmap parsing\n");
+               goto error;
+       }
+       if (!move_pos_slow) {
+               fprintf(stderr, "[error] move_pos_slow 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);
+       if (ret)
+               goto error_free;
+
+       return &td->parent;
+
+error_free:
+       g_free(td);
+error:
+       return NULL;
+}
+
 static
 void ctf_close_file_stream(struct ctf_file_stream *file_stream)
 {
This page took 0.03095 seconds and 4 git commands to generate.