/*
-* variant.c
+ * variant.c
*
* BabelTrace - Variant Type Converter
*
- * Copyright 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>
+#include <babeltrace/types.h>
#include <errno.h>
static
-struct definition *_variant_definition_new(struct type *type,
- struct definition_scope *parent_scope);
+struct bt_definition *_variant_definition_new(struct bt_declaration *declaration,
+ struct definition_scope *parent_scope,
+ GQuark field_name, int index,
+ const char *root_name);
static
-void _variant_definition_free(struct definition *definition);
+void _variant_definition_free(struct bt_definition *definition);
-void variant_copy(struct stream_pos *dest, const struct format *fdest,
- struct stream_pos *src, const struct format *fsrc,
- struct definition *definition)
+int bt_variant_rw(struct bt_stream_pos *ppos, struct bt_definition *definition)
{
- struct definition_variant *variant =
+ struct definition_variant *variant_definition =
container_of(definition, struct definition_variant, p);
- struct type_variant *variant_type = variant->type;
- struct field *field;
- struct type *field_type;
-
- fsrc->variant_begin(src, variant_type);
- fdest->variant_begin(dest, variant_type);
-
- field = variant_get_current_field(variant);
- field_type = field->definition->type;
- field_type->copy(dest, fdest, src, fsrc, field->definition);
+ struct bt_definition *field;
- fsrc->variant_end(src, variant_type);
- fdest->variant_end(dest, variant_type);
+ field = bt_variant_get_current_field(variant_definition);
+ if (!field) {
+ return -EINVAL;
+ }
+ return generic_rw(ppos, field);
}
static
-void _variant_type_free(struct type *type)
+void _untagged_variant_declaration_free(struct bt_declaration *declaration)
{
- struct type_variant *variant_type =
- container_of(type, struct type_variant, p);
+ struct declaration_untagged_variant *untagged_variant_declaration =
+ container_of(declaration, struct declaration_untagged_variant, p);
unsigned long i;
- free_type_scope(variant_type->scope);
- g_hash_table_destroy(variant_type->fields_by_tag);
+ bt_free_declaration_scope(untagged_variant_declaration->scope);
+ g_hash_table_destroy(untagged_variant_declaration->fields_by_tag);
- for (i = 0; i < variant_type->fields->len; i++) {
- struct type_field *type_field =
- &g_array_index(variant_type->fields,
- struct type_field, i);
- type_unref(type_field->type);
+ for (i = 0; i < untagged_variant_declaration->fields->len; i++) {
+ struct declaration_field *declaration_field =
+ &g_array_index(untagged_variant_declaration->fields,
+ struct declaration_field, i);
+ bt_declaration_unref(declaration_field->declaration);
}
- g_array_free(variant_type->fields, true);
- g_free(variant_type);
+ g_array_free(untagged_variant_declaration->fields, true);
+ g_free(untagged_variant_declaration);
}
-struct type_variant *variant_type_new(const char *name,
- struct type_scope *parent_scope)
+struct declaration_untagged_variant *bt_untagged_bt_variant_declaration_new(
+ struct declaration_scope *parent_scope)
{
- struct type_variant *variant_type;
- struct type *type;
+ struct declaration_untagged_variant *untagged_variant_declaration;
+ struct bt_declaration *declaration;
- variant_type = g_new(struct type_variant, 1);
- type = &variant_type->p;
- variant_type->fields_by_tag = g_hash_table_new(g_direct_hash,
+ untagged_variant_declaration = g_new(struct declaration_untagged_variant, 1);
+ declaration = &untagged_variant_declaration->p;
+ untagged_variant_declaration->fields_by_tag = g_hash_table_new(g_direct_hash,
g_direct_equal);
- variant_type->fields = g_array_sized_new(FALSE, TRUE,
- sizeof(struct type_field),
+ untagged_variant_declaration->fields = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct declaration_field),
DEFAULT_NR_STRUCT_FIELDS);
- variant_type->scope = new_type_scope(parent_scope);
- type->id = CTF_TYPE_VARIANT;
- type->name = g_quark_from_string(name);
- type->alignment = 1;
- type->copy = variant_copy;
- type->type_free = _variant_type_free;
- type->definition_new = _variant_definition_new;
- type->definition_free = _variant_definition_free;
- type->ref = 1;
- return variant_type;
+ untagged_variant_declaration->scope = bt_new_declaration_scope(parent_scope);
+ declaration->id = CTF_TYPE_UNTAGGED_VARIANT;
+ declaration->alignment = 1;
+ declaration->declaration_free = _untagged_variant_declaration_free;
+ declaration->definition_new = NULL;
+ declaration->definition_free = NULL;
+ declaration->ref = 1;
+ return untagged_variant_declaration;
}
static
-struct definition *
- _variant_definition_new(struct type *type,
- struct definition_scope *parent_scope)
+void _variant_declaration_free(struct bt_declaration *declaration)
+{
+ struct declaration_variant *variant_declaration =
+ container_of(declaration, struct declaration_variant, p);
+
+ bt_declaration_unref(&variant_declaration->untagged_variant->p);
+ g_array_free(variant_declaration->tag_name, TRUE);
+ g_free(variant_declaration);
+}
+
+struct declaration_variant *
+ bt_variant_declaration_new(struct declaration_untagged_variant *untagged_variant, const char *tag)
{
- struct type_variant *variant_type =
- container_of(type, struct type_variant, p);
+ struct declaration_variant *variant_declaration;
+ struct bt_declaration *declaration;
+
+ variant_declaration = g_new(struct declaration_variant, 1);
+ declaration = &variant_declaration->p;
+ variant_declaration->untagged_variant = untagged_variant;
+ bt_declaration_ref(&untagged_variant->p);
+ variant_declaration->tag_name = g_array_new(FALSE, TRUE, sizeof(GQuark));
+ bt_append_scope_path(tag, variant_declaration->tag_name);
+ declaration->id = CTF_TYPE_VARIANT;
+ declaration->alignment = 1;
+ declaration->declaration_free = _variant_declaration_free;
+ declaration->definition_new = _variant_definition_new;
+ declaration->definition_free = _variant_definition_free;
+ declaration->ref = 1;
+ return variant_declaration;
+}
+
+static
+struct bt_definition *
+ _variant_definition_new(struct bt_declaration *declaration,
+ struct definition_scope *parent_scope,
+ GQuark field_name, int index,
+ const char *root_name)
+{
+ struct declaration_variant *variant_declaration =
+ container_of(declaration, struct declaration_variant, p);
struct definition_variant *variant;
unsigned long i;
+ int ret;
variant = g_new(struct definition_variant, 1);
- type_ref(&variant_type->p);
- variant->p.type = type;
- variant->type = variant_type;
+ bt_declaration_ref(&variant_declaration->p);
+ variant->p.declaration = declaration;
+ variant->declaration = variant_declaration;
variant->p.ref = 1;
- variant->scope = new_definition_scope(parent_scope);
- variant->fields = g_array_sized_new(FALSE, TRUE,
- sizeof(struct field),
- DEFAULT_NR_STRUCT_FIELDS);
- g_array_set_size(variant->fields, variant_type->fields->len);
- for (i = 0; i < variant_type->fields->len; i++) {
- struct type_field *type_field =
- &g_array_index(variant_type->fields,
- struct type_field, i);
- struct field *field = &g_array_index(variant->fields,
- struct field, i);
-
- field->name = type_field->name;
- field->definition =
- type_field->type->definition_new(type_field->type,
- variant->scope);
+ /*
+ * Use INT_MAX order to ensure that all fields of the parent
+ * scope are seen as being prior to this scope.
+ */
+ variant->p.index = root_name ? INT_MAX : index;
+ variant->p.name = field_name;
+ variant->p.path = bt_new_definition_path(parent_scope, field_name, root_name);
+ variant->p.scope = bt_new_definition_scope(parent_scope, field_name, root_name);
+
+ ret = bt_register_field_definition(field_name, &variant->p,
+ parent_scope);
+ assert(!ret);
+
+ variant->enum_tag = bt_lookup_path_definition(variant->p.scope->scope_path,
+ variant_declaration->tag_name,
+ parent_scope);
+
+ if (!variant->enum_tag)
+ goto error;
+ bt_definition_ref(variant->enum_tag);
+ variant->fields = g_ptr_array_sized_new(variant_declaration->untagged_variant->fields->len);
+ g_ptr_array_set_size(variant->fields, variant_declaration->untagged_variant->fields->len);
+ for (i = 0; i < variant_declaration->untagged_variant->fields->len; i++) {
+ struct declaration_field *declaration_field =
+ &g_array_index(variant_declaration->untagged_variant->fields,
+ struct declaration_field, i);
+ struct bt_definition **field =
+ (struct bt_definition **) &g_ptr_array_index(variant->fields, i);
+
+ /*
+ * All child definition are at index 0, because they are
+ * various choices of the same field.
+ */
+ *field = declaration_field->declaration->definition_new(declaration_field->declaration,
+ variant->p.scope,
+ declaration_field->name, 0, NULL);
+ if (!*field)
+ goto error;
}
variant->current_field = NULL;
return &variant->p;
+error:
+ bt_free_definition_scope(variant->p.scope);
+ bt_declaration_unref(&variant_declaration->p);
+ g_free(variant);
+ return NULL;
}
static
-void _variant_definition_free(struct definition *definition)
+void _variant_definition_free(struct bt_definition *definition)
{
struct definition_variant *variant =
container_of(definition, struct definition_variant, p);
unsigned long i;
- assert(variant->fields->len == variant->type->fields->len);
+ assert(variant->fields->len == variant->declaration->untagged_variant->fields->len);
for (i = 0; i < variant->fields->len; i++) {
- struct field *field = &g_array_index(variant->fields,
- struct field, i);
- definition_unref(field->definition);
+ struct bt_definition *field = g_ptr_array_index(variant->fields, i);
+ bt_definition_unref(field);
}
- free_definition_scope(variant->scope);
- type_unref(variant->p.type);
+ bt_definition_unref(variant->enum_tag);
+ bt_free_definition_scope(variant->p.scope);
+ bt_declaration_unref(variant->p.declaration);
+ g_ptr_array_free(variant->fields, TRUE);
g_free(variant);
}
-void variant_type_add_field(struct type_variant *variant_type,
- const char *tag_name,
- struct type *tag_type)
+void bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+ const char *field_name,
+ struct bt_declaration *field_declaration)
{
- struct type_field *field;
+ struct declaration_field *field;
unsigned long index;
- g_array_set_size(variant_type->fields, variant_type->fields->len + 1);
- index = variant_type->fields->len - 1; /* last field (new) */
- field = &g_array_index(variant_type->fields, struct type_field, index);
- field->name = g_quark_from_string(tag_name);
- type_ref(tag_type);
- field->type = tag_type;
+ g_array_set_size(untagged_variant_declaration->fields, untagged_variant_declaration->fields->len + 1);
+ index = untagged_variant_declaration->fields->len - 1; /* last field (new) */
+ field = &g_array_index(untagged_variant_declaration->fields, struct declaration_field, index);
+ field->name = g_quark_from_string(field_name);
+ bt_declaration_ref(field_declaration);
+ field->declaration = field_declaration;
/* Keep index in hash rather than pointer, because array can relocate */
- g_hash_table_insert(variant_type->fields_by_tag,
+ g_hash_table_insert(untagged_variant_declaration->fields_by_tag,
(gpointer) (unsigned long) field->name,
(gpointer) index);
/*
*/
}
-struct type_field *
-struct_type_get_field_from_tag(struct type_variant *variant_type, GQuark tag)
+struct declaration_field *
+bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag)
{
- unsigned long index;
-
- index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
- (gconstpointer) (unsigned long) tag);
- return &g_array_index(variant_type->fields, struct type_field, index);
-}
+ gpointer index;
+ gboolean found;
-/*
- * tag_instance is assumed to be an enumeration.
- */
-int variant_definition_set_tag(struct definition_variant *variant,
- struct definition *enum_tag)
-{
- struct definition_enum *_enum =
- container_of(variant->enum_tag, struct definition_enum, p);
- struct type_enum *enum_type = _enum->type;
- int missing_field = 0;
- unsigned long i;
+ found = g_hash_table_lookup_extended(
+ untagged_variant_declaration->fields_by_tag,
+ (gconstpointer) (unsigned long) tag, NULL, &index);
- /*
- * Strictly speaking, each enumerator must map to a field of the
- * variant. However, we are even stricter here by requiring that each
- * variant choice map to an enumerator too. We then validate that the
- * number of enumerators equals the number of variant choices.
- */
- if (variant->type->fields->len != enum_get_nr_enumerators(enum_type))
- return -EPERM;
-
- for (i = 0; i < variant->type->fields->len; i++) {
- struct type_field *field_type =
- &g_array_index(variant->type->fields,
- struct type_field, i);
- if (!enum_quark_to_range_set(enum_type, field_type->name)) {
- missing_field = 1;
- break;
- }
+ if (!found) {
+ return NULL;
}
- if (missing_field)
- return -EPERM;
- /*
- * Check the enumeration: it must map each value to one and only one
- * enumerator tag.
- * TODO: we should also check that each range map to one and only one
- * tag. For the moment, we will simply check this dynamically in
- * variant_type_get_current_field().
- */
-
- /* Set the enum tag field */
- variant->enum_tag = enum_tag;
- return 0;
+ return &g_array_index(untagged_variant_declaration->fields, struct declaration_field, (unsigned long)index);
}
/*
* field returned only valid as long as the field structure is not appended to.
*/
-struct field *variant_get_current_field(struct definition_variant *variant)
+struct bt_definition *bt_variant_get_current_field(struct definition_variant *variant)
{
struct definition_enum *_enum =
container_of(variant->enum_tag, struct definition_enum, p);
- struct type_variant *variant_type = variant->type;
+ struct declaration_variant *variant_declaration = variant->declaration;
unsigned long index;
GArray *tag_array;
GQuark tag;
+ gpointer orig_key, value;
tag_array = _enum->value;
+ if (!tag_array) {
+ /* Enumeration has unknown tag. */
+ fprintf(stderr, "[error] Enumeration used for variant has unknown tag.\n");
+ return NULL;
+ }
/*
* The 1 to 1 mapping from enumeration to value should have been already
* checked. (see TODO above)
*/
assert(tag_array->len == 1);
tag = g_array_index(tag_array, GQuark, 0);
- index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
- (gconstpointer) (unsigned long) tag);
- variant->current_field = &g_array_index(variant->fields, struct field, index);
+ if (!g_hash_table_lookup_extended(variant_declaration->untagged_variant->fields_by_tag,
+ (gconstpointer) (unsigned long) tag,
+ &orig_key,
+ &value)) {
+ /* Cannot find matching field. */
+ fprintf(stderr, "[error] Cannot find matching field for enum field \"%s\" in variant.\n",
+ g_quark_to_string(tag));
+ return NULL;
+ }
+ index = (unsigned long) value;
+ variant->current_field = g_ptr_array_index(variant->fields, index);
return variant->current_field;
}
projects / babeltrace.git / blobdiff