*
* BabelTrace - Structure Type Converter
*
- * Copyright 2010 - 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>
+#include <babeltrace/types.h>
+#include <errno.h>
#ifndef max
#define max(a, b) ((a) < (b) ? (b) : (a))
#endif
-void struct_copy(struct stream_pos *dest, const struct format *fdest,
- struct stream_pos *src, const struct format *fsrc,
- const struct type_class *type_class)
-{
- struct type_class_struct *struct_class =
- container_of(type_class, struct type_class_struct, p);
- unsigned int i;
-
- fsrc->struct_begin(src, struct_class);
- fdest->struct_begin(dest, struct_class);
-
- for (i = 0; i < struct_class->fields->len; i++) {
- struct field *field = &g_array_index(struct_class->fields,
- struct field, i);
- struct type_class *field_class = field->type_class;
+static
+struct bt_definition *_struct_definition_new(struct bt_declaration *declaration,
+ struct definition_scope *parent_scope,
+ GQuark field_name, int index,
+ const char *root_name);
+static
+void _struct_definition_free(struct bt_definition *definition);
- field_class->copy(dest, fdest, src, fsrc, field_class);
+int bt_struct_rw(struct bt_stream_pos *ppos, struct bt_definition *definition)
+{
+ struct definition_struct *struct_definition =
+ container_of(definition, struct definition_struct, p);
+ unsigned long i;
+ int ret;
+ for (i = 0; i < struct_definition->fields->len; i++) {
+ struct bt_definition *field =
+ g_ptr_array_index(struct_definition->fields, i);
+ ret = generic_rw(ppos, field);
+ if (ret)
+ return ret;
}
- fsrc->struct_end(src, struct_class);
- fdest->struct_end(dest, struct_class);
+ return 0;
}
-void struct_type_free(struct type_class_struct *struct_class)
+static
+void _struct_declaration_free(struct bt_declaration *declaration)
{
- unsigned int i;
+ struct declaration_struct *struct_declaration =
+ container_of(declaration, struct declaration_struct, p);
+ unsigned long i;
- g_hash_table_destroy(struct_class->fields_by_name);
+ bt_free_declaration_scope(struct_declaration->scope);
+ g_hash_table_destroy(struct_declaration->fields_by_name);
- for (i = 0; i < struct_class->fields->len; i++) {
- struct field *field = &g_array_index(struct_class->fields,
- struct field, i);
- type_unref(field->type_class);
+ for (i = 0; i < struct_declaration->fields->len; i++) {
+ struct declaration_field *declaration_field =
+ &g_array_index(struct_declaration->fields,
+ struct declaration_field, i);
+ bt_declaration_unref(declaration_field->declaration);
}
- g_array_free(struct_class->fields, true);
- g_free(struct_class);
+ g_array_free(struct_declaration->fields, true);
+ g_free(struct_declaration);
}
-static void _struct_type_free(struct type_class *type_class)
+struct declaration_struct *
+ bt_struct_declaration_new(struct declaration_scope *parent_scope,
+ uint64_t min_align)
{
- struct type_class_struct *struct_class =
- container_of(type_class, struct type_class_struct, p);
- struct_type_free(struct_class);
+ struct declaration_struct *struct_declaration;
+ struct bt_declaration *declaration;
+
+ struct_declaration = g_new(struct declaration_struct, 1);
+ declaration = &struct_declaration->p;
+ struct_declaration->fields_by_name = g_hash_table_new(g_direct_hash,
+ g_direct_equal);
+ struct_declaration->fields = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct declaration_field),
+ DEFAULT_NR_STRUCT_FIELDS);
+ struct_declaration->scope = bt_new_declaration_scope(parent_scope);
+ declaration->id = CTF_TYPE_STRUCT;
+ declaration->alignment = max(1, min_align);
+ declaration->declaration_free = _struct_declaration_free;
+ declaration->definition_new = _struct_definition_new;
+ declaration->definition_free = _struct_definition_free;
+ declaration->ref = 1;
+ return struct_declaration;
}
-struct type_class_struct *struct_type_new(const char *name)
+static
+struct bt_definition *
+ _struct_definition_new(struct bt_declaration *declaration,
+ struct definition_scope *parent_scope,
+ GQuark field_name, int index,
+ const char *root_name)
{
- struct type_class_struct *struct_class;
- struct type_class *type_class;
+ struct declaration_struct *struct_declaration =
+ container_of(declaration, struct declaration_struct, p);
+ struct definition_struct *_struct;
+ int i;
int ret;
- struct_class = g_new(struct type_class_struct, 1);
- type_class = &struct_class->p;
-
- struct_class->fields_by_name = g_hash_table_new(g_direct_hash,
- g_direct_equal);
- struct_class->fields = g_array_sized_new(false, false,
- sizeof(struct field),
- DEFAULT_NR_STRUCT_FIELDS);
- type_class->name = g_quark_from_string(name);
- type_class->alignment = 1;
- type_class->copy = struct_copy;
- type_class->free = _struct_type_free;
- type_class->ref = 1;
-
- if (type_class->name) {
- ret = register_type(type_class);
- if (ret)
- goto error_register;
+ _struct = g_new(struct definition_struct, 1);
+ bt_declaration_ref(&struct_declaration->p);
+ _struct->p.declaration = declaration;
+ _struct->declaration = struct_declaration;
+ _struct->p.ref = 1;
+ /*
+ * Use INT_MAX order to ensure that all fields of the parent
+ * scope are seen as being prior to this scope.
+ */
+ _struct->p.index = root_name ? INT_MAX : index;
+ _struct->p.name = field_name;
+ _struct->p.path = bt_new_definition_path(parent_scope, field_name, root_name);
+ _struct->p.scope = bt_new_definition_scope(parent_scope, field_name, root_name);
+
+ ret = bt_register_field_definition(field_name, &_struct->p,
+ parent_scope);
+ assert(!ret || ret == -EPERM);
+
+ _struct->fields = g_ptr_array_sized_new(DEFAULT_NR_STRUCT_FIELDS);
+ g_ptr_array_set_size(_struct->fields, struct_declaration->fields->len);
+ for (i = 0; i < struct_declaration->fields->len; i++) {
+ struct declaration_field *declaration_field =
+ &g_array_index(struct_declaration->fields,
+ struct declaration_field, i);
+ struct bt_definition **field =
+ (struct bt_definition **) &g_ptr_array_index(_struct->fields, i);
+
+ *field = declaration_field->declaration->definition_new(declaration_field->declaration,
+ _struct->p.scope,
+ declaration_field->name, i, NULL);
+ if (!*field)
+ goto error;
}
- return struct_class;
+ return &_struct->p;
-error_register:
- g_free(struct_class);
+error:
+ for (i--; i >= 0; i--) {
+ struct bt_definition *field = g_ptr_array_index(_struct->fields, i);
+ bt_definition_unref(field);
+ }
+ bt_free_definition_scope(_struct->p.scope);
+ bt_declaration_unref(&struct_declaration->p);
+ g_free(_struct);
return NULL;
}
-void struct_type_add_field(struct type_class_struct *struct_class,
+static
+void _struct_definition_free(struct bt_definition *definition)
+{
+ struct definition_struct *_struct =
+ container_of(definition, struct definition_struct, p);
+ unsigned long i;
+
+ assert(_struct->fields->len == _struct->declaration->fields->len);
+ for (i = 0; i < _struct->fields->len; i++) {
+ struct bt_definition *field = g_ptr_array_index(_struct->fields, i);
+ bt_definition_unref(field);
+ }
+ bt_free_definition_scope(_struct->p.scope);
+ bt_declaration_unref(_struct->p.declaration);
+ g_ptr_array_free(_struct->fields, TRUE);
+ g_free(_struct);
+}
+
+void bt_struct_declaration_add_field(struct declaration_struct *struct_declaration,
const char *field_name,
- struct type_class *type_class)
+ struct bt_declaration *field_declaration)
{
- struct field *field;
+ struct declaration_field *field;
unsigned long index;
- g_array_set_size(struct_class->fields, struct_class->fields->len + 1);
- index = struct_class->fields->len - 1; /* last field (new) */
- field = &g_array_index(struct_class->fields, struct field, index);
+ g_array_set_size(struct_declaration->fields, struct_declaration->fields->len + 1);
+ index = struct_declaration->fields->len - 1; /* last field (new) */
+ field = &g_array_index(struct_declaration->fields, struct declaration_field, index);
field->name = g_quark_from_string(field_name);
- type_ref(type_class);
- field->type_class = type_class;
+ bt_declaration_ref(field_declaration);
+ field->declaration = field_declaration;
/* Keep index in hash rather than pointer, because array can relocate */
- g_hash_table_insert(struct_class->fields_by_name,
+ g_hash_table_insert(struct_declaration->fields_by_name,
(gpointer) (unsigned long) field->name,
(gpointer) index);
/*
- * Alignment of structure is the max alignment of types contained
+ * Alignment of structure is the max alignment of declarations contained
* therein.
*/
- struct_class->p.alignment = max(struct_class->p.alignment,
- type_class->alignment);
+ struct_declaration->p.alignment = max(struct_declaration->p.alignment,
+ field_declaration->alignment);
}
-unsigned long
-struct_type_lookup_field_index(struct type_class_struct *struct_class,
- GQuark field_name)
+/*
+ * bt_struct_declaration_lookup_field_index - returns field index
+ *
+ * Returns the index of a field in a structure, or -1 if it does not
+ * exist.
+ */
+int bt_struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
+ GQuark field_name)
{
- unsigned long index;
+ gpointer index;
+ gboolean found;
- index = (unsigned long) g_hash_table_lookup(struct_class->fields_by_name,
- (gconstpointer) (unsigned long) field_name);
- return index;
+ found = g_hash_table_lookup_extended(struct_declaration->fields_by_name,
+ (gconstpointer) (unsigned long) field_name,
+ NULL, &index);
+ if (!found)
+ return -1;
+ return (int) (unsigned long) index;
}
/*
* field returned only valid as long as the field structure is not appended to.
*/
-struct field *
-struct_type_get_field_from_index(struct type_class_struct *struct_class,
- unsigned long index)
+struct declaration_field *
+ bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
+ int index)
+{
+ if (index < 0)
+ return NULL;
+ return &g_array_index(struct_declaration->fields, struct declaration_field, index);
+}
+
+/*
+ * field returned only valid as long as the field structure is not appended to.
+ */
+struct bt_definition *
+bt_struct_definition_get_field_from_index(const struct definition_struct *_struct,
+ int index)
+{
+ if (index < 0)
+ return NULL;
+ return g_ptr_array_index(_struct->fields, index);
+}
+
+uint64_t bt_struct_declaration_len(const struct declaration_struct *struct_declaration)
{
- return &g_array_index(struct_class->fields, struct field, index);
+ return struct_declaration->fields->len;
}