+++ /dev/null
-/*
- * variant.c
- *
- * BabelTrace - Variant Type Converter
- *
- * 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * 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 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 bt_definition *definition);
-
-int bt_variant_rw(struct bt_stream_pos *ppos, struct bt_definition *definition)
-{
- struct definition_variant *variant_definition =
- container_of(definition, struct definition_variant, p);
- struct bt_definition *field;
-
- field = bt_variant_get_current_field(variant_definition);
- if (!field) {
- return -EINVAL;
- }
- return generic_rw(ppos, field);
-}
-
-static
-void _untagged_variant_declaration_free(struct bt_declaration *declaration)
-{
- struct declaration_untagged_variant *untagged_variant_declaration =
- container_of(declaration, struct declaration_untagged_variant, p);
- unsigned long i;
-
- bt_free_declaration_scope(untagged_variant_declaration->scope);
- g_hash_table_destroy(untagged_variant_declaration->fields_by_tag);
-
- 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(untagged_variant_declaration->fields, true);
- g_free(untagged_variant_declaration);
-}
-
-struct declaration_untagged_variant *bt_untagged_bt_variant_declaration_new(
- struct declaration_scope *parent_scope)
-{
- struct declaration_untagged_variant *untagged_variant_declaration;
- struct bt_declaration *declaration;
-
- 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);
- untagged_variant_declaration->fields = g_array_sized_new(FALSE, TRUE,
- sizeof(struct declaration_field),
- DEFAULT_NR_STRUCT_FIELDS);
- 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
-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 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);
- bt_declaration_ref(&variant_declaration->p);
- variant->p.declaration = declaration;
- variant->declaration = variant_declaration;
- variant->p.ref = 1;
- /*
- * 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 bt_definition *definition)
-{
- struct definition_variant *variant =
- container_of(definition, struct definition_variant, p);
- unsigned long i;
-
- assert(variant->fields->len == variant->declaration->untagged_variant->fields->len);
- for (i = 0; i < variant->fields->len; i++) {
- struct bt_definition *field = g_ptr_array_index(variant->fields, i);
- bt_definition_unref(field);
- }
- 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 bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
- const char *field_name,
- struct bt_declaration *field_declaration)
-{
- struct declaration_field *field;
- unsigned long index;
-
- 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(untagged_variant_declaration->fields_by_tag,
- GUINT_TO_POINTER(field->name),
- GUINT_TO_POINTER(index));
- /*
- * Alignment of variant is based on the alignment of its currently
- * selected choice, so we leave variant alignment as-is (statically
- * speaking).
- */
-}
-
-struct declaration_field *
-bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag)
-{
- gpointer index;
- gboolean found;
-
- found = g_hash_table_lookup_extended(
- untagged_variant_declaration->fields_by_tag,
- (gconstpointer) GUINT_TO_POINTER(tag), NULL, &index);
-
- if (!found) {
- return NULL;
- }
-
- return &g_array_index(untagged_variant_declaration->fields, struct declaration_field, GPOINTER_TO_UINT(index));
-}
-
-/*
- * field returned only valid as long as the field structure is not appended to.
- */
-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 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);
- if (!g_hash_table_lookup_extended(variant_declaration->untagged_variant->fields_by_tag,
- (gconstpointer) GUINT_TO_POINTER(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 = GPOINTER_TO_UINT(value);
- variant->current_field = g_ptr_array_index(variant->fields, index);
- return variant->current_field;
-}