Use inheritance for trace descriptor and positions
[babeltrace.git] / formats / ctf / ctf.c
index 54aaed7e426749b80f246bf6eccc5210809c9cad..614adc028d40071da0c98a4b14128887906095e6 100644 (file)
 
 /*
  * We currently simply map a page to read the packet header and packet
- * context to get the packet length and content length.
+ * context to get the packet length and content length. (in bits)
  */
-#define MAX_PACKET_HEADER_LEN  getpagesize()
+#define MAX_PACKET_HEADER_LEN  (getpagesize() * CHAR_BIT)
+#define WRITE_PACKET_LEN       (getpagesize() * 8 * CHAR_BIT)
 #define UUID_LEN 16    /* uuid by value len */
 
 extern int yydebug;
 
-struct trace_descriptor {
-       struct ctf_trace ctf_trace;
-};
-
 struct trace_descriptor *ctf_open_trace(const char *path, int flags);
 void ctf_close_trace(struct trace_descriptor *descriptor);
 
@@ -80,33 +77,118 @@ static struct format ctf_format = {
        .close_trace = ctf_close_trace,
 };
 
-void move_pos_slow(struct stream_pos *pos, size_t offset)
+void ctf_init_pos(struct ctf_stream_pos *pos, int fd)
+{
+       pos->fd = fd;
+       pos->mmap_offset = 0;
+       pos->packet_size = 0;
+       pos->content_size = 0;
+       pos->content_size_loc = NULL;
+       pos->base = NULL;
+       pos->offset = 0;
+       pos->dummy = false;
+       pos->packet_index = g_array_new(FALSE, TRUE,
+                                       sizeof(struct packet_index));
+       pos->cur_index = 0;
+       if (fd >= 0) {
+               int flags = fcntl(fd, F_GETFL, 0);
+
+               switch (flags & O_ACCMODE) {
+               case O_RDONLY:
+                       pos->prot = PROT_READ;
+                       pos->flags = MAP_PRIVATE;
+                       break;
+               case O_WRONLY:
+               case O_RDWR:
+                       pos->prot = PROT_WRITE; /* Write has priority */
+                       pos->flags = MAP_SHARED;
+                       ctf_move_pos_slow(pos, 0);      /* position for write */
+                       break;
+               default:
+                       assert(0);
+               }
+
+       }
+}
+
+void ctf_fini_pos(struct ctf_stream_pos *pos)
 {
        int ret;
 
-       /*
-        * The caller should never ask for move_pos across packets,
-        * except to get exactly at the beginning of the next packet.
-        */
-       assert(pos->offset + offset == pos->content_size);
+       if (pos->prot == PROT_WRITE && pos->content_size_loc)
+               *pos->content_size_loc = pos->offset;
+       if (pos->base) {
+               /* unmap old base */
+               ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
+               if (ret) {
+                       fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
+                               strerror(errno));
+                       assert(0);
+               }
+       }
+       (void) g_array_free(pos->packet_index, TRUE);
+}
+
+void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset)
+{
+       int ret;
+       off_t off;
+       struct packet_index *index;
+
+
+       if (pos->prot == PROT_WRITE && pos->content_size_loc)
+               *pos->content_size_loc = pos->offset;
 
        if (pos->base) {
                /* unmap old base */
-               ret = munmap(pos->base, pos->packet_size);
+               ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
                if (ret) {
-                       fprintf(stdout, "Unable to unmap old base: %s.\n",
+                       fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
                                strerror(errno));
                        assert(0);
                }
        }
 
-       pos->mmap_offset += pos->packet_size / CHAR_BIT;
+       /*
+        * 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) {
+               /* The writer will add padding */
+               assert(pos->offset + offset == pos->packet_size);
+
+               /*
+                * Don't increment for initial stream move (only condition where
+                * pos->offset can be 0.
+                */
+               if (pos->offset)
+                       pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
+               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);
+       } else {
+               /* The reader will expect us to skip padding */
+               assert(pos->offset + offset == pos->content_size);
+
+               /*
+                * Don't increment for initial stream move (only condition where
+                * pos->offset can be 0).
+                */
+               if (pos->offset)
+                       ++pos->cur_index;
+               index = &g_array_index(pos->packet_index, struct packet_index,
+                                      pos->cur_index);
+               pos->mmap_offset = index->offset;
+
+               /* Lookup context/packet size in index */
+               pos->content_size = index->content_size;
+               pos->packet_size = index->packet_size;
+       }
        /* map new base. Need mapping length from header. */
-       pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN, PROT_READ,
-                        MAP_PRIVATE, pos->fd, pos->mmap_offset);
-       pos->content_size = 0;  /* Unknown at this point */
-       pos->packet_size = 0;   /* Unknown at this point */
-
+       pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot,
+                        pos->flags, pos->fd, pos->mmap_offset);
+       pos->offset = 0;
 }
 
 /*
@@ -114,58 +196,57 @@ void move_pos_slow(struct stream_pos *pos, size_t offset)
  * (without any header nor packets nor padding).
  */
 static
-int ctf_open_trace_metadata_read(struct trace_descriptor *td)
+int ctf_open_trace_metadata_read(struct ctf_trace *td)
 {
        struct ctf_scanner *scanner;
        FILE *fp;
        int ret = 0;
 
-       td->ctf_trace.metadata.pos.fd = openat(td->ctf_trace.dirfd,
-                       "metadata", O_RDONLY);
-       if (td->ctf_trace.metadata.pos.fd < 0) {
+       td->metadata.pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
+       if (td->metadata.pos.fd < 0) {
                fprintf(stdout, "Unable to open metadata.\n");
-               return td->ctf_trace.metadata.pos.fd;
+               return td->metadata.pos.fd;
        }
 
        if (babeltrace_debug)
                yydebug = 1;
 
-       fp = fdopen(td->ctf_trace.metadata.pos.fd, "r");
+       fp = fdopen(td->metadata.pos.fd, "r");
        if (!fp) {
-               fprintf(stdout, "Unable to open metadata stream.\n");
+               fprintf(stdout, "[error] Unable to open metadata stream.\n");
                ret = -errno;
                goto end_stream;
        }
 
        scanner = ctf_scanner_alloc(fp);
        if (!scanner) {
-               fprintf(stdout, "Error allocating scanner\n");
+               fprintf(stdout, "[error] Error allocating scanner\n");
                ret = -ENOMEM;
                goto end_scanner_alloc;
        }
        ret = ctf_scanner_append_ast(scanner);
        if (ret) {
-               fprintf(stdout, "Error creating AST\n");
+               fprintf(stdout, "[error] Error creating AST\n");
                goto end;
        }
 
        if (babeltrace_debug) {
                ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root);
                if (ret) {
-                       fprintf(stdout, "Error visiting AST for XML output\n");
+                       fprintf(stdout, "[error] Error visiting AST for XML output\n");
                        goto end;
                }
        }
 
        ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root);
        if (ret) {
-               fprintf(stdout, "Error in CTF semantic validation %d\n", ret);
+               fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret);
                goto end;
        }
        ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root,
-                       &td->ctf_trace, BYTE_ORDER);
+                       td, BYTE_ORDER);
        if (ret) {
-               fprintf(stdout, "Error in CTF metadata constructor %d\n", ret);
+               fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret);
                goto end;
        }
 end:
@@ -173,18 +254,18 @@ end:
 end_scanner_alloc:
        fclose(fp);
 end_stream:
-       close(td->ctf_trace.metadata.pos.fd);
+       close(td->metadata.pos.fd);
        return ret;
 }
 
 
 static
-int create_stream_packet_index(struct trace_descriptor *td,
+int create_stream_packet_index(struct ctf_trace *td,
                               struct ctf_file_stream *file_stream)
 {
        struct ctf_stream *stream;
        int len_index;
-       struct stream_pos *pos;
+       struct ctf_stream_pos *pos;
        struct stat filestats;
        struct packet_index packet_index;
        int first_packet = 1;
@@ -201,52 +282,58 @@ int create_stream_packet_index(struct trace_descriptor *td,
 
                if (pos->base) {
                        /* unmap old base */
-                       ret = munmap(pos->base, pos->packet_size);
+                       ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
                        if (ret) {
-                               fprintf(stdout, "Unable to unmap old base: %s.\n",
+                               fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
                                        strerror(errno));
                                return ret;
                        }
+                       pos->base = NULL;
                }
                /* map new base. Need mapping length from header. */
-               pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN, PROT_READ,
+               pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
                                 MAP_PRIVATE, pos->fd, pos->mmap_offset);
                pos->content_size = MAX_PACKET_HEADER_LEN;      /* Unknown at this point */
                pos->packet_size = MAX_PACKET_HEADER_LEN;       /* Unknown at this point */
                pos->offset = 0;        /* Position of the packet header */
 
+               packet_index.offset = pos->mmap_offset;
+               packet_index.content_size = 0;
+               packet_index.packet_size = 0;
+
                /* read and check header, set stream id (and check) */
-               if (td->ctf_trace.packet_header) {
+               if (td->packet_header) {
                        /* Read packet header */
-                       td->ctf_trace.packet_header->p.declaration->copy(NULL, NULL,
-                               pos, &ctf_format, &td->ctf_trace.packet_header->p);
+                       td->packet_header->p.declaration->copy(NULL, NULL,
+                               &pos->parent, &ctf_format, &td->packet_header->p);
 
-                       len_index = struct_declaration_lookup_field_index(td->ctf_trace.packet_header->declaration, g_quark_from_static_string("magic"));
+                       len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("magic"));
                        if (len_index >= 0) {
                                struct definition_integer *defint;
                                struct field *field;
 
-                               field = struct_definition_get_field_from_index(td->ctf_trace.packet_header, len_index);
+                               field = struct_definition_get_field_from_index(td->packet_header, len_index);
                                assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
                                defint = container_of(field->definition, struct definition_integer, p);
                                assert(defint->declaration->signedness == FALSE);
                                if (defint->value._unsigned != CTF_MAGIC) {
-                                       fprintf(stdout, "[error] Invalid magic number %" PRIX64 ".\n",
-                                                       defint->value._unsigned);
+                                       fprintf(stdout, "[error] Invalid magic number %" PRIX64 " at packet %u (file offset %zd).\n",
+                                                       defint->value._unsigned,
+                                                       file_stream->pos.packet_index->len,
+                                                       (ssize_t) pos->mmap_offset);
                                        return -EINVAL;
                                }
                        }
 
                        /* check uuid */
-                       len_index = struct_declaration_lookup_field_index(td->ctf_trace.packet_header->declaration, g_quark_from_static_string("trace_uuid"));
+                       len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("trace_uuid"));
                        if (len_index >= 0) {
                                struct definition_array *defarray;
                                struct field *field;
                                uint64_t i;
                                uint8_t uuidval[UUID_LEN];
 
-
-                               field = struct_definition_get_field_from_index(td->ctf_trace.packet_header, len_index);
+                               field = struct_definition_get_field_from_index(td->packet_header, len_index);
                                assert(field->definition->declaration->id == CTF_TYPE_ARRAY);
                                defarray = container_of(field->definition, struct definition_array, p);
                                assert(array_len(defarray) == UUID_LEN);
@@ -261,7 +348,7 @@ int create_stream_packet_index(struct trace_descriptor *td,
                                        defint = container_of(elem, struct definition_integer, p);
                                        uuidval[i] = defint->value._unsigned;
                                }
-                               ret = uuid_compare(td->ctf_trace.uuid, uuidval);
+                               ret = uuid_compare(td->uuid, uuidval);
                                if (ret) {
                                        fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n");
                                        return -EINVAL;
@@ -269,12 +356,12 @@ int create_stream_packet_index(struct trace_descriptor *td,
                        }
 
 
-                       len_index = struct_declaration_lookup_field_index(td->ctf_trace.packet_header->declaration, g_quark_from_static_string("stream_id"));
+                       len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("stream_id"));
                        if (len_index >= 0) {
                                struct definition_integer *defint;
                                struct field *field;
 
-                               field = struct_definition_get_field_from_index(td->ctf_trace.packet_header, len_index);
+                               field = struct_definition_get_field_from_index(td->packet_header, len_index);
                                assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
                                defint = container_of(field->definition, struct definition_integer, p);
                                assert(defint->declaration->signedness == FALSE);
@@ -288,11 +375,11 @@ int create_stream_packet_index(struct trace_descriptor *td,
                }
                if (first_packet) {
                        file_stream->stream_id = stream_id;
-                       if (stream_id >= td->ctf_trace.streams->len) {
+                       if (stream_id >= td->streams->len) {
                                fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
                                return -EINVAL;
                        }
-                       stream = g_ptr_array_index(td->ctf_trace.streams, stream_id);
+                       stream = g_ptr_array_index(td->streams, stream_id);
                        if (!stream) {
                                fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
                                return -EINVAL;
@@ -304,7 +391,7 @@ int create_stream_packet_index(struct trace_descriptor *td,
                if (stream->packet_context) {
                        /* Read packet context */
                        stream->packet_context->p.declaration->copy(NULL, NULL,
-                                       pos, &ctf_format, &stream->packet_context->p);
+                                       &pos->parent, &ctf_format, &stream->packet_context->p);
 
                        /* read content size from header */
                        len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("content_size"));
@@ -316,10 +403,10 @@ int create_stream_packet_index(struct trace_descriptor *td,
                                assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
                                defint = container_of(field->definition, struct definition_integer, p);
                                assert(defint->declaration->signedness == FALSE);
-                               pos->content_size = defint->value._unsigned;
+                               packet_index.content_size = defint->value._unsigned;
                        } else {
                                /* Use file size for packet size */
-                               pos->content_size = filestats.st_size * CHAR_BIT;
+                               packet_index.content_size = filestats.st_size * CHAR_BIT;
                        }
 
                        /* read packet size from header */
@@ -332,25 +419,22 @@ int create_stream_packet_index(struct trace_descriptor *td,
                                assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
                                defint = container_of(field->definition, struct definition_integer, p);
                                assert(defint->declaration->signedness == FALSE);
-                               pos->packet_size = defint->value._unsigned;
+                               packet_index.packet_size = defint->value._unsigned;
                        } else {
                                /* Use content size if non-zero, else file size */
-                               pos->packet_size = pos->content_size ? : filestats.st_size * CHAR_BIT;
+                               packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
                        }
                } else {
                        /* Use file size for packet size */
-                       pos->content_size = filestats.st_size * CHAR_BIT;
+                       packet_index.content_size = filestats.st_size * CHAR_BIT;
                        /* Use content size if non-zero, else file size */
-                       pos->packet_size = pos->content_size ? : filestats.st_size * CHAR_BIT;
+                       packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
                }
 
-               packet_index.offset = pos->mmap_offset;
-               packet_index.content_size = pos->content_size;
-               packet_index.packet_size = pos->packet_size;
                /* add index to packet array */
                g_array_append_val(file_stream->pos.packet_index, packet_index);
 
-               pos->mmap_offset += pos->packet_size / CHAR_BIT;
+               pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
        }
 
        return 0;
@@ -361,18 +445,16 @@ int create_stream_packet_index(struct trace_descriptor *td,
  * description (metadata).
  */
 static
-int ctf_open_file_stream_read(struct trace_descriptor *td, const char *path, int flags)
+int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags)
 {
        int ret;
        struct ctf_file_stream *file_stream;
 
-       ret = openat(td->ctf_trace.dirfd, path, flags);
+       ret = openat(td->dirfd, path, flags);
        if (ret < 0)
                goto error;
        file_stream = g_new0(struct ctf_file_stream, 1);
-       file_stream->pos.fd = ret;
-       file_stream->pos.packet_index = g_array_new(FALSE, TRUE,
-                                               sizeof(struct packet_index));
+       ctf_init_pos(&file_stream->pos, ret);
        ret = create_stream_packet_index(td, file_stream);
        if (ret)
                goto error_index;
@@ -381,7 +463,7 @@ int ctf_open_file_stream_read(struct trace_descriptor *td, const char *path, int
        return 0;
 
 error_index:
-       (void) g_array_free(file_stream->pos.packet_index, TRUE);
+       ctf_fini_pos(&file_stream->pos);
        close(file_stream->pos.fd);
        g_free(file_stream);
 error:
@@ -389,31 +471,31 @@ error:
 }
 
 static
-int ctf_open_trace_read(struct trace_descriptor *td, const char *path, int flags)
+int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags)
 {
        int ret;
        struct dirent *dirent;
        struct dirent *diriter;
        size_t dirent_len;
 
-       td->ctf_trace.flags = flags;
+       td->flags = flags;
 
        /* Open trace directory */
-       td->ctf_trace.dir = opendir(path);
-       if (!td->ctf_trace.dir) {
+       td->dir = opendir(path);
+       if (!td->dir) {
                fprintf(stdout, "[error] Unable to open trace directory.\n");
                ret = -ENOENT;
                goto error;
        }
 
-       td->ctf_trace.dirfd = open(path, 0);
-       if (td->ctf_trace.dirfd < 0) {
+       td->dirfd = open(path, 0);
+       if (td->dirfd < 0) {
                fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n");
                ret = -ENOENT;
                goto error_dirfd;
        }
 
-       td->ctf_trace.streams = g_ptr_array_new();
+       td->streams = g_ptr_array_new();
 
        /*
         * Keep the metadata file separate.
@@ -431,12 +513,12 @@ int ctf_open_trace_read(struct trace_descriptor *td, const char *path, int flags
         */
 
        dirent_len = offsetof(struct dirent, d_name) +
-                       fpathconf(td->ctf_trace.dirfd, _PC_NAME_MAX) + 1;
+                       fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
 
        dirent = malloc(dirent_len);
 
        for (;;) {
-               ret = readdir_r(td->ctf_trace.dir, dirent, &diriter);
+               ret = readdir_r(td->dir, dirent, &diriter);
                if (ret) {
                        fprintf(stdout, "[error] Readdir error.\n");
                        goto readdir_error;
@@ -460,16 +542,16 @@ int ctf_open_trace_read(struct trace_descriptor *td, const char *path, int flags
 readdir_error:
        free(dirent);
 error_metadata:
-       g_ptr_array_free(td->ctf_trace.streams, TRUE);
-       close(td->ctf_trace.dirfd);
+       g_ptr_array_free(td->streams, TRUE);
+       close(td->dirfd);
 error_dirfd:
-       closedir(td->ctf_trace.dir);
+       closedir(td->dir);
 error:
        return ret;
 }
 
 static
-int ctf_open_trace_write(struct trace_descriptor *td, const char *path, int flags)
+int ctf_open_trace_write(struct ctf_trace *td, const char *path, int flags)
 {
        int ret;
 
@@ -478,9 +560,9 @@ int ctf_open_trace_write(struct trace_descriptor *td, const char *path, int flag
                return ret;
 
        /* Open trace directory */
-       td->ctf_trace.dir = opendir(path);
-       if (!td->ctf_trace.dir) {
-               fprintf(stdout, "Unable to open trace directory.\n");
+       td->dir = opendir(path);
+       if (!td->dir) {
+               fprintf(stdout, "[error] Unable to open trace directory.\n");
                ret = -ENOENT;
                goto error;
        }
@@ -494,28 +576,32 @@ error:
 
 struct trace_descriptor *ctf_open_trace(const char *path, int flags)
 {
-       struct trace_descriptor *td;
+       struct ctf_trace *td;
        int ret;
 
-       td = g_new0(struct trace_descriptor, 1);
+       td = g_new0(struct ctf_trace, 1);
 
-       switch (flags) {
+       switch (flags & O_ACCMODE) {
        case O_RDONLY:
                ret = ctf_open_trace_read(td, path, flags);
                if (ret)
                        goto error;
                break;
        case O_WRONLY:
+               fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n");
+               goto error;
+#if 0
                ret = ctf_open_trace_write(td, path, flags);
                if (ret)
                        goto error;
+#endif //0
                break;
        default:
-               fprintf(stdout, "Incorrect open flags.\n");
+               fprintf(stdout, "[error] Incorrect open flags.\n");
                goto error;
        }
 
-       return td;
+       return &td->parent;
 error:
        g_free(td);
        return NULL;
@@ -524,30 +610,31 @@ error:
 static
 void ctf_close_file_stream(struct ctf_file_stream *file_stream)
 {
-       (void) g_array_free(file_stream->pos.packet_index, TRUE);
+       ctf_fini_pos(&file_stream->pos);
        close(file_stream->pos.fd);
 }
 
-void ctf_close_trace(struct trace_descriptor *td)
+void ctf_close_trace(struct trace_descriptor *tdp)
 {
+       struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
        int i;
 
-       if (td->ctf_trace.streams) {
-               for (i = 0; i < td->ctf_trace.streams->len; i++) {
+       if (td->streams) {
+               for (i = 0; i < td->streams->len; i++) {
                        struct ctf_stream *stream;
                        int j;
 
-                       stream = g_ptr_array_index(td->ctf_trace.streams, i);
+                       stream = g_ptr_array_index(td->streams, i);
                        for (j = 0; j < stream->files->len; j++) {
                                struct ctf_file_stream *file_stream;
-                               file_stream = g_ptr_array_index(td->ctf_trace.streams, j);
+                               file_stream = g_ptr_array_index(td->streams, j);
                                ctf_close_file_stream(file_stream);
                        }
 
                }
-               g_ptr_array_free(td->ctf_trace.streams, TRUE);
+               g_ptr_array_free(td->streams, TRUE);
        }
-       closedir(td->ctf_trace.dir);
+       closedir(td->dir);
        g_free(td);
 }
 
This page took 0.033718 seconds and 4 git commands to generate.