/*
+ * declarations.c
+ *
* BabelTrace - Converter
*
* Types registry.
*
- * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
+ * 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:
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*/
-#include <ctf/ctf-types.h>
+#include <babeltrace/format.h>
#include <glib.h>
#include <errno.h>
+static
+struct definition *
+ lookup_typedef_declaration_scope(GQuark declaration_name,
+ struct declaration_scope *scope)
+{
+ return g_hash_table_lookup(scope->typedef_declarations,
+ (gconstpointer) (unsigned long) declaration_name);
+}
+
+struct definition *lookup_typedef_declaration(GQuark declaration_name,
+ struct declaration_scope *scope)
+{
+ struct definition *definition;
+
+ while (scope) {
+ definition = lookup_typedef_declaration_scope(declaration_name,
+ scope);
+ if (definition)
+ return definition;
+ scope = scope->parent_scope;
+ }
+ return NULL;
+}
+
+int register_typedef_declaration(GQuark name, struct declaration *declaration,
+ struct declaration_scope *scope)
+{
+ if (!name)
+ return -EPERM;
+
+ /* Only lookup in local scope */
+ if (lookup_typedef_declaration_scope(name, scope))
+ return -EEXIST;
+
+ g_hash_table_insert(scope->typedef_declarations,
+ (gpointer) (unsigned long) name,
+ declaration);
+ declaration_ref(declaration);
+ return 0;
+}
+
+static
+struct definition *
+ lookup_field_definition_scope(GQuark field_name,
+ struct definition_scope *scope)
+{
+ return g_hash_table_lookup(scope->definitions,
+ (gconstpointer) (unsigned long) field_name);
+}
+
/*
- * Type hash table contains the registered types. Type registration is typically
- * performed by a type plugin.
- * TODO: support plugin unload (unregistration of types).
+ * Returns the index at which the paths differ.
+ * If the value returned equals len, it means the paths are identical
+ * from index 0 to len-1.
*/
-GHashTable *types;
+static int compare_paths(GArray *a, GArray *b, int len)
+{
+ int i;
-struct type_class *ctf_lookup_type(GQuark qname)
+ assert(len <= a->len);
+ assert(len <= b->len);
+
+ for (i = 0; i < len; i++) {
+ GQuark qa, qb;
+
+ qa = g_array_index(a, GQuark, i);
+ qb = g_array_index(b, GQuark, i);
+ if (qa != qb)
+ return i;
+ }
+ return i;
+}
+
+static int is_path_child_of(GArray *path, GArray *maybe_parent)
{
- return g_hash_table_lookup(type_classes,
- (gconstpointer) (unsigned long) qname)
+ if (path->len <= maybe_parent->len)
+ return 0;
+ if (compare_paths(path, maybe_parent, maybe_parent->len)
+ == maybe_parent->len)
+ return 1;
+ else
+ return 0;
}
-static void free_type(struct type_class *type_class)
+static struct definition_scope *
+ get_definition_scope(struct definition *definition)
{
- type_class->free(type_class);
+ switch (definition->declaration->id) {
+ case CTF_TYPE_STRUCT:
+ {
+ struct definition_struct *def =
+ container_of(definition, struct definition_struct, p);
+ return def->scope;
+ }
+ case CTF_TYPE_VARIANT:
+ {
+ struct definition_variant *def =
+ container_of(definition, struct definition_variant, p);
+ return def->scope;
+ }
+ case CTF_TYPE_ARRAY:
+ {
+ struct definition_array *def =
+ container_of(definition, struct definition_array, p);
+ return def->scope;
+ }
+ case CTF_TYPE_SEQUENCE:
+ {
+ struct definition_sequence *def =
+ container_of(definition, struct definition_sequence, p);
+ return def->scope;
+ }
+
+ case CTF_TYPE_INTEGER:
+ case CTF_TYPE_FLOAT:
+ case CTF_TYPE_ENUM:
+ case CTF_TYPE_STRING:
+ case CTF_TYPE_UNKNOWN:
+ default:
+ return NULL;
+ }
}
-int ctf_register_type(struct type_class *type_class)
+/*
+ * OK, here is the fun. We want to lookup a field that is:
+ * - either in the same dynamic scope:
+ * - either in the current scope, but prior to the current field.
+ * - or in a parent scope (or parent of parent ...) still in a field
+ * prior to the current field position within the parents.
+ * - or in a different dynamic scope:
+ * - either in a upper dynamic scope (walk down a targeted scope from
+ * the dynamic scope root)
+ * - or in a lower dynamic scope (failure)
+ * The dynamic scope roots are linked together, so we can access the
+ * parent dynamic scope from the child dynamic scope by walking up to
+ * the parent.
+ * If we cannot find such a field that is prior to our current path, we
+ * return NULL.
+ *
+ * cur_path: the path leading to the variant definition.
+ * lookup_path: the path leading to the enum we want to look for.
+ * scope: the definition scope containing the variant definition.
+ */
+struct definition *
+ lookup_definition(GArray *cur_path,
+ GArray *lookup_path,
+ struct definition_scope *scope)
{
- if (ctf_lookup_type_class(type_class->name))
+ struct definition *definition, *lookup_definition;
+ GQuark last;
+ int index;
+
+ while (scope) {
+ /* going up in the hierarchy. Check where we come from. */
+ assert(is_path_child_of(cur_path, scope->scope_path));
+ assert(cur_path->len - scope->scope_path->len == 1);
+ last = g_array_index(cur_path, GQuark, cur_path->len - 1);
+ definition = lookup_field_definition_scope(last, scope);
+ assert(definition);
+ index = definition->index;
+lookup:
+ if (is_path_child_of(lookup_path, scope->scope_path)) {
+ /* Means we can lookup the field in this scope */
+ last = g_array_index(lookup_path, GQuark,
+ scope->scope_path->len);
+ lookup_definition = lookup_field_definition_scope(last, scope);
+ if (!lookup_definition || ((index != -1) && lookup_definition->index >= index))
+ return NULL;
+ /* Found it! And it is prior to the current field. */
+ if (lookup_path->len - scope->scope_path->len == 1) {
+ /* Direct child */
+ return lookup_definition;
+ } else {
+ scope = get_definition_scope(lookup_definition);
+ /* Check if the definition has a sub-scope */
+ if (!scope)
+ return NULL;
+ /*
+ * Don't compare index anymore, because we are
+ * going within a scope that has been validated
+ * to be entirely prior to the current scope.
+ */
+ cur_path = NULL;
+ index = -1;
+ goto lookup;
+ }
+ } else {
+ assert(index != -1);
+ /* lookup_path is within an upper scope */
+ cur_path = scope->scope_path;
+ scope = scope->parent_scope;
+ }
+ }
+ return NULL;
+}
+
+int register_field_definition(GQuark field_name, struct definition *definition,
+ struct definition_scope *scope)
+{
+ if (!field_name)
+ return -EPERM;
+
+ /* Only lookup in local scope */
+ if (lookup_field_definition_scope(field_name, scope))
return -EEXIST;
- g_hash_table_insert(type_classes,
- (gconstpointer) (unsigned long) type_class->name,
- type_class);
+ g_hash_table_insert(scope->definitions,
+ (gpointer) (unsigned long) field_name,
+ definition);
+ definition_ref(definition);
return 0;
}
-int ctf_init_types(void)
+void declaration_ref(struct declaration *declaration)
+{
+ declaration->ref++;
+}
+
+void declaration_unref(struct declaration *declaration)
+{
+ if (!--declaration->ref)
+ declaration->declaration_free(declaration);
+}
+
+void definition_ref(struct definition *definition)
{
- type_classes = g_hash_table_new_full(g_direct_hash, g_direct_equal,
- NULL, free_type);
- if (!type_classes)
- return -ENOMEM;
+ definition->ref++;
+}
+
+void definition_unref(struct definition *definition)
+{
+ if (!--definition->ref)
+ definition->declaration->definition_free(definition);
+}
+
+struct declaration_scope *
+ new_declaration_scope(struct declaration_scope *parent_scope)
+{
+ struct declaration_scope *scope = g_new(struct declaration_scope, 1);
+
+ scope->typedef_declarations = g_hash_table_new_full(g_direct_hash,
+ g_direct_equal, NULL,
+ (GDestroyNotify) definition_unref);
+ scope->struct_declarations = g_hash_table_new_full(g_direct_hash,
+ g_direct_equal, NULL,
+ (GDestroyNotify) declaration_unref);
+ scope->variant_declarations = g_hash_table_new_full(g_direct_hash,
+ g_direct_equal, NULL,
+ (GDestroyNotify) declaration_unref);
+ scope->enum_declarations = g_hash_table_new_full(g_direct_hash,
+ g_direct_equal, NULL,
+ (GDestroyNotify) declaration_unref);
+ scope->parent_scope = parent_scope;
+ return scope;
+}
+
+void free_declaration_scope(struct declaration_scope *scope)
+{
+ g_hash_table_destroy(scope->enum_declarations);
+ g_hash_table_destroy(scope->variant_declarations);
+ g_hash_table_destroy(scope->struct_declarations);
+ g_hash_table_destroy(scope->typedef_declarations);
+ g_free(scope);
+}
+
+static
+struct declaration_struct *lookup_struct_declaration_scope(GQuark struct_name,
+ struct declaration_scope *scope)
+{
+ return g_hash_table_lookup(scope->struct_declarations,
+ (gconstpointer) (unsigned long) struct_name);
+}
+
+struct declaration_struct *lookup_struct_declaration(GQuark struct_name,
+ struct declaration_scope *scope)
+{
+ struct declaration_struct *declaration;
+
+ while (scope) {
+ declaration = lookup_struct_declaration_scope(struct_name, scope);
+ if (declaration)
+ return declaration;
+ scope = scope->parent_scope;
+ }
+ return NULL;
+}
+
+int register_struct_declaration(GQuark struct_name,
+ struct declaration_struct *struct_declaration,
+ struct declaration_scope *scope)
+{
+ if (!struct_name)
+ return -EPERM;
+
+ /* Only lookup in local scope */
+ if (lookup_struct_declaration_scope(struct_name, scope))
+ return -EEXIST;
+
+ g_hash_table_insert(scope->struct_declarations,
+ (gpointer) (unsigned long) struct_name,
+ struct_declaration);
+ declaration_ref(&struct_declaration->p);
+ return 0;
+}
+
+static
+struct declaration_variant *
+ lookup_variant_declaration_scope(GQuark variant_name,
+ struct declaration_scope *scope)
+{
+ return g_hash_table_lookup(scope->variant_declarations,
+ (gconstpointer) (unsigned long) variant_name);
+}
+
+struct declaration_variant *
+ lookup_variant_declaration(GQuark variant_name,
+ struct declaration_scope *scope)
+{
+ struct declaration_variant *declaration;
+
+ while (scope) {
+ declaration = lookup_variant_declaration_scope(variant_name, scope);
+ if (declaration)
+ return declaration;
+ scope = scope->parent_scope;
+ }
+ return NULL;
+}
+
+int register_variant_declaration(GQuark variant_name,
+ struct declaration_variant *variant_declaration,
+ struct declaration_scope *scope)
+{
+ if (!variant_name)
+ return -EPERM;
+
+ /* Only lookup in local scope */
+ if (lookup_variant_declaration_scope(variant_name, scope))
+ return -EEXIST;
+
+ g_hash_table_insert(scope->variant_declarations,
+ (gpointer) (unsigned long) variant_name,
+ variant_declaration);
+ declaration_ref(&variant_declaration->p);
return 0;
}
-int ctf_finalize_types(void)
+static
+struct declaration_enum *
+ lookup_enum_declaration_scope(GQuark enum_name,
+ struct declaration_scope *scope)
+{
+ return g_hash_table_lookup(scope->enum_declarations,
+ (gconstpointer) (unsigned long) enum_name);
+}
+
+struct declaration_enum *
+ lookup_enum_declaration(GQuark enum_name,
+ struct declaration_scope *scope)
+{
+ struct declaration_enum *declaration;
+
+ while (scope) {
+ declaration = lookup_enum_declaration_scope(enum_name, scope);
+ if (declaration)
+ return declaration;
+ scope = scope->parent_scope;
+ }
+ return NULL;
+}
+
+int register_enum_declaration(GQuark enum_name,
+ struct declaration_enum *enum_declaration,
+ struct declaration_scope *scope)
+{
+ if (!enum_name)
+ return -EPERM;
+
+ /* Only lookup in local scope */
+ if (lookup_enum_declaration_scope(enum_name, scope))
+ return -EEXIST;
+
+ g_hash_table_insert(scope->enum_declarations,
+ (gpointer) (unsigned long) enum_name,
+ enum_declaration);
+ declaration_ref(&enum_declaration->p);
+ return 0;
+}
+
+static struct definition_scope *
+ _new_definition_scope(struct definition_scope *parent_scope,
+ int scope_path_len)
+{
+ struct definition_scope *scope = g_new(struct definition_scope, 1);
+
+ scope->definitions = g_hash_table_new_full(g_direct_hash,
+ g_direct_equal, NULL,
+ (GDestroyNotify) definition_unref);
+ scope->parent_scope = parent_scope;
+ scope->scope_path = g_array_sized_new(FALSE, TRUE, sizeof(GQuark),
+ scope_path_len);
+ g_array_set_size(scope->scope_path, scope_path_len);
+ return scope;
+}
+
+struct definition_scope *
+ new_definition_scope(struct definition_scope *parent_scope,
+ GQuark field_name)
+{
+ struct definition_scope *scope;
+ int scope_path_len = 1;
+
+ if (parent_scope)
+ scope_path_len += parent_scope->scope_path->len;
+ scope = _new_definition_scope(parent_scope, scope_path_len);
+ if (parent_scope)
+ memcpy(scope->scope_path, parent_scope->scope_path,
+ sizeof(GQuark) * (scope_path_len - 1));
+ g_array_index(scope->scope_path, GQuark, scope_path_len - 1) =
+ field_name;
+ return scope;
+}
+
+void set_dynamic_definition_scope(struct definition_scope *scope,
+ GQuark root_name)
+{
+ g_array_set_size(scope->scope_path, 1);
+ g_array_index(scope->scope_path, GQuark, 0) = root_name;
+}
+
+void free_definition_scope(struct definition_scope *scope)
{
- g_hash_table_destroy(type_classes);
+ g_array_free(scope->scope_path, TRUE);
+ g_hash_table_destroy(scope->definitions);
+ g_free(scope);
}
projects / babeltrace.git / blobdiff