Fix: Make sure we have all the metadata streams before adding new traces
[babeltrace.git] / types / sequence.c
index c379f98364c139e30891e167ee9c2757c21e6224..6c61ef7a0c55b70761cbf98f1830eb3553d0ae3a 100644 (file)
@@ -3,7 +3,9 @@
  *
  * BabelTrace - Sequence Type Converter
  *
- * 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
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 #include <babeltrace/compiler.h>
 #include <babeltrace/format.h>
-
-#ifndef max
-#define max(a, b)      ((a) < (b) ? (b) : (a))
-#endif
+#include <babeltrace/types.h>
+#include <inttypes.h>
 
 static
-struct declaration *_sequence_declaration_new(struct type *type,
-                                       struct declaration_scope *parent_scope);
+struct bt_definition *_sequence_definition_new(struct bt_declaration *declaration,
+                                       struct definition_scope *parent_scope,
+                                       GQuark field_name, int index,
+                                       const char *root_name);
 static
-void _sequence_declaration_free(struct declaration *declaration);
+void _sequence_definition_free(struct bt_definition *definition);
 
-void sequence_copy(struct stream_pos *dest, const struct format *fdest, 
-                  struct stream_pos *src, const struct format *fsrc,
-                  struct declaration *declaration)
+int bt_sequence_rw(struct bt_stream_pos *pos, struct bt_definition *definition)
 {
-       struct declaration_sequence *sequence =
-               container_of(declaration, struct declaration_sequence, p);
-       struct type_sequence *sequence_type = sequence->type;
-       uint64_t i;
+       struct definition_sequence *sequence_definition =
+               container_of(definition, struct definition_sequence, p);
+       const struct declaration_sequence *sequence_declaration =
+               sequence_definition->declaration;
+       uint64_t len, oldlen, i;
+       int ret;
 
-       fsrc->sequence_begin(src, sequence_type);
-       fdest->sequence_begin(dest, sequence_type);
+       len = sequence_definition->length->value._unsigned;
+       /*
+        * Yes, large sequences could be _painfully slow_ to parse due
+        * to memory allocation for each event read. At least, never
+        * shrink the sequence. Note: the sequence GArray len should
+        * never be used as indicator of the current sequence length.
+        * One should always look at the sequence->len->value._unsigned
+        * value for that.
+        */
+       oldlen = sequence_definition->elems->len;
+       if (oldlen < len)
+               g_ptr_array_set_size(sequence_definition->elems, len);
 
-       sequence->len->p.type->copy(dest, fdest, src, fsrc,
-                                   &sequence->len->p);
+       for (i = oldlen; i < len; i++) {
+               struct bt_definition **field;
+               GString *str;
+               GQuark name;
 
-       for (i = 0; i < sequence->len->value._unsigned; i++) {
-               struct declaration *elem =
-                       sequence->current_element.declaration;
-               elem->type->copy(dest, fdest, src, fsrc, elem);
+               str = g_string_new("");
+               g_string_printf(str, "[%" PRIu64 "]", i);
+               name = g_quark_from_string(str->str);
+               (void) g_string_free(str, TRUE);
+
+               field = (struct bt_definition **) &g_ptr_array_index(sequence_definition->elems, i);
+               *field = sequence_declaration->elem->definition_new(sequence_declaration->elem,
+                                         sequence_definition->p.scope,
+                                         name, i, NULL);
+       }
+       for (i = 0; i < len; i++) {
+               struct bt_definition **field;
+
+               field = (struct bt_definition **) &g_ptr_array_index(sequence_definition->elems, i);
+               ret = generic_rw(pos, *field);
+               if (ret)
+                       return ret;
        }
-       fsrc->sequence_end(src, sequence_type);
-       fdest->sequence_end(dest, sequence_type);
+       return 0;
 }
 
 static
-void _sequence_type_free(struct type *type)
+void _sequence_declaration_free(struct bt_declaration *declaration)
 {
-       struct type_sequence *sequence_type =
-               container_of(type, struct type_sequence, p);
+       struct declaration_sequence *sequence_declaration =
+               container_of(declaration, struct declaration_sequence, p);
 
-       free_type_scope(sequence_type->scope);
-       type_unref(&sequence_type->len_type->p);
-       type_unref(sequence_type->elem);
-       g_free(sequence_type);
+       bt_free_declaration_scope(sequence_declaration->scope);
+       g_array_free(sequence_declaration->length_name, TRUE);
+       bt_declaration_unref(sequence_declaration->elem);
+       g_free(sequence_declaration);
 }
 
-struct type_sequence *
-       sequence_type_new(const char *name, struct type_integer *len_type,
-                         struct type *elem_type,
-                         struct type_scope *parent_scope)
+struct declaration_sequence *
+       bt_sequence_declaration_new(const char *length,
+                         struct bt_declaration *elem_declaration,
+                         struct declaration_scope *parent_scope)
 {
-       struct type_sequence *sequence_type;
-       struct type *type;
-
-       sequence_type = g_new(struct type_sequence, 1);
-       type = &sequence_type->p;
-       assert(!len_type->signedness);
-       type_ref(&len_type->p);
-       sequence_type->len_type = len_type;
-       type_ref(elem_type);
-       sequence_type->elem = elem_type;
-       sequence_type->scope = new_type_scope(parent_scope);
-       type->name = g_quark_from_string(name);
-       type->alignment = max(len_type->p.alignment, elem_type->alignment);
-       type->copy = sequence_copy;
-       type->type_free = _sequence_type_free;
-       type->declaration_new = _sequence_declaration_new;
-       type->declaration_free = _sequence_declaration_free;
-       type->ref = 1;
-       return sequence_type;
+       struct declaration_sequence *sequence_declaration;
+       struct bt_declaration *declaration;
+
+       sequence_declaration = g_new(struct declaration_sequence, 1);
+       declaration = &sequence_declaration->p;
+
+       sequence_declaration->length_name = g_array_new(FALSE, TRUE, sizeof(GQuark));
+       bt_append_scope_path(length, sequence_declaration->length_name);
+
+       bt_declaration_ref(elem_declaration);
+       sequence_declaration->elem = elem_declaration;
+       sequence_declaration->scope = bt_new_declaration_scope(parent_scope);
+       declaration->id = CTF_TYPE_SEQUENCE;
+       declaration->alignment = elem_declaration->alignment;
+       declaration->declaration_free = _sequence_declaration_free;
+       declaration->definition_new = _sequence_definition_new;
+       declaration->definition_free = _sequence_definition_free;
+       declaration->ref = 1;
+       return sequence_declaration;
 }
 
 static
-struct declaration *_sequence_declaration_new(struct type *type,
-                               struct declaration_scope *parent_scope)
+struct bt_definition *_sequence_definition_new(struct bt_declaration *declaration,
+                               struct definition_scope *parent_scope,
+                               GQuark field_name, int index,
+                               const char *root_name)
 {
-       struct type_sequence *sequence_type =
-               container_of(type, struct type_sequence, p);
-       struct declaration_sequence *sequence;
-       struct declaration *len_parent;
-
-       sequence = g_new(struct declaration_sequence, 1);
-       type_ref(&sequence_type->p);
-       sequence->p.type = type;
-       sequence->type = sequence_type;
+       struct declaration_sequence *sequence_declaration =
+               container_of(declaration, struct declaration_sequence, p);
+       struct definition_sequence *sequence;
+       struct bt_definition *len_parent;
+       int ret;
+
+       sequence = g_new(struct definition_sequence, 1);
+       bt_declaration_ref(&sequence_declaration->p);
+       sequence->p.declaration = declaration;
+       sequence->declaration = sequence_declaration;
        sequence->p.ref = 1;
-       sequence->scope = new_declaration_scope(parent_scope);
-       len_parent = sequence_type->len_type->p.declaration_new(&sequence_type->len_type->p,
-                                                               parent_scope);
-       sequence->len =
-               container_of(len_parent, struct declaration_integer, p);
-       sequence->current_element.declaration =
-               sequence_type->elem->declaration_new(sequence_type->elem,
-                                                    parent_scope);
+       /*
+        * Use INT_MAX order to ensure that all fields of the parent
+        * scope are seen as being prior to this scope.
+        */
+       sequence->p.index = root_name ? INT_MAX : index;
+       sequence->p.name = field_name;
+       sequence->p.path = bt_new_definition_path(parent_scope, field_name, root_name);
+       sequence->p.scope = bt_new_definition_scope(parent_scope, field_name, root_name);
+       ret = bt_register_field_definition(field_name, &sequence->p,
+                                       parent_scope);
+       assert(!ret);
+       len_parent = bt_lookup_path_definition(sequence->p.scope->scope_path,
+                                           sequence_declaration->length_name,
+                                           parent_scope);
+       if (!len_parent) {
+               printf("[error] Lookup for sequence length field failed.\n");
+               goto error;
+       }
+       sequence->length =
+               container_of(len_parent, struct definition_integer, p);
+       if (sequence->length->declaration->signedness) {
+               printf("[error] Sequence length field should be unsigned.\n");
+               goto error;
+       }
+       bt_definition_ref(len_parent);
+
+       sequence->string = NULL;
+       sequence->elems = NULL;
+
+       if (sequence_declaration->elem->id == CTF_TYPE_INTEGER) {
+               struct declaration_integer *integer_declaration =
+                       container_of(sequence_declaration->elem, struct declaration_integer, p);
+
+               if (integer_declaration->encoding == CTF_STRING_UTF8
+                     || integer_declaration->encoding == CTF_STRING_ASCII) {
+
+                       sequence->string = g_string_new("");
+
+                       if (integer_declaration->len == CHAR_BIT
+                           && integer_declaration->p.alignment == CHAR_BIT) {
+                               return &sequence->p;
+                       }
+               }
+       }
+
+       sequence->elems = g_ptr_array_new();
        return &sequence->p;
+
+error:
+       bt_free_definition_scope(sequence->p.scope);
+       bt_declaration_unref(&sequence_declaration->p);
+       g_free(sequence);
+       return NULL;
 }
 
 static
-void _sequence_declaration_free(struct declaration *declaration)
+void _sequence_definition_free(struct bt_definition *definition)
 {
-       struct declaration_sequence *sequence =
-               container_of(declaration, struct declaration_sequence, p);
-       struct declaration *len_declaration = &sequence->len->p;
-       struct declaration *elem_declaration =
-               sequence->current_element.declaration;
-
-       len_declaration->type->declaration_free(len_declaration);
-       elem_declaration->type->declaration_free(elem_declaration);
-       free_declaration_scope(sequence->scope);
-       type_unref(sequence->p.type);
+       struct definition_sequence *sequence =
+               container_of(definition, struct definition_sequence, p);
+       struct bt_definition *len_definition = &sequence->length->p;
+       uint64_t i;
+
+       if (sequence->string)
+               (void) g_string_free(sequence->string, TRUE);
+       if (sequence->elems) {
+               for (i = 0; i < sequence->elems->len; i++) {
+                       struct bt_definition *field;
+
+                       field = g_ptr_array_index(sequence->elems, i);
+                       field->declaration->definition_free(field);
+               }
+               (void) g_ptr_array_free(sequence->elems, TRUE);
+       }
+       bt_definition_unref(len_definition);
+       bt_free_definition_scope(sequence->p.scope);
+       bt_declaration_unref(sequence->p.declaration);
        g_free(sequence);
 }
+
+uint64_t bt_sequence_len(struct definition_sequence *sequence)
+{
+       return sequence->length->value._unsigned;
+}
+
+struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i)
+{
+       if (!sequence->elems)
+               return NULL;
+       if (i >= sequence->length->value._unsigned)
+               return NULL;
+       assert(i < sequence->elems->len);
+       return g_ptr_array_index(sequence->elems, i);
+}
This page took 0.027314 seconds and 4 git commands to generate.