/*
- * BabelTrace - Enumeration Type
+ * enum.c
*
- * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * BabelTrace - Enumeration Type
*
- * 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 <babeltrace/compiler.h>
-#include <babeltrace/types.h>
+#include <babeltrace/format.h>
#include <stdint.h>
#include <glib.h>
-struct enum_table {
- GHashTable *value_to_quark; /* Tuples (value, GQuark) */
- GHashTable *quark_to_value; /* Tuples (GQuark, value) */
-};
+static
+struct declaration *_enum_declaration_new(struct type *type,
+ struct declaration_scope *parent_scope);
+static
+void _enum_declaration_free(struct declaration *declaration);
-#if (__WORDSIZE == 32)
-GQuark enum_uint_to_quark(const struct type_class_enum *enum_class, uint64_t v)
+static
+void enum_range_set_free(void *ptr)
{
- gconstpointer q = g_hash_table_lookup(enum_class->table.value_to_quark,
- &v);
- return (GQuark) (unsigned long) q;
+ g_array_unref(ptr);
}
-GQuark enum_int_to_quark(const struct type_class_enum *enum_class, uint64_t v)
+/*
+ * Returns a GArray or NULL.
+ * Caller must release the GArray with g_array_unref().
+ */
+GArray *enum_uint_to_quark_set(const struct type_enum *enum_type,
+ uint64_t v)
{
- gconstpointer q = g_hash_table_lookup(enum_class->table.value_to_quark,
- &v);
- return (GQuark) (unsigned long) q;
-}
+ struct enum_range_to_quark *iter;
+ GArray *qs, *ranges = NULL;
-uint64_t enum_quark_to_uint(const struct type_class_enum *enum_class,
- size_t len, int byte_order, GQuark q)
-{
- gconstpointer v = g_hash_table_lookup(enum_class->table.quark_to_value,
- (gconstpointer) q);
- return *(const uint64_t *) v;
+ /* Single values lookup */
+ qs = g_hash_table_lookup(enum_type->table.value_to_quark_set, &v);
+
+ /* Range lookup */
+ cds_list_for_each_entry(iter, &enum_type->table.range_to_quark, node) {
+ if (iter->range.start._unsigned > v || iter->range.end._unsigned < v)
+ continue;
+ if (!ranges) {
+ size_t qs_len = 0;
+
+ if (qs)
+ qs_len = qs->len;
+ ranges = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct enum_range),
+ qs_len + 1);
+ g_array_set_size(ranges, qs_len + 1);
+ if (qs)
+ memcpy(ranges->data, qs->data,
+ sizeof(struct enum_range) * qs_len);
+ g_array_index(ranges, struct enum_range, qs_len) = iter->range;
+ } else {
+ g_array_set_size(ranges, ranges->len + 1);
+ g_array_index(ranges, struct enum_range, ranges->len) = iter->range;
+ }
+ }
+ if (!ranges) {
+ ranges = qs;
+ g_array_ref(ranges);
+ }
+ return ranges;
}
-int64_t enum_quark_to_int(const struct type_class_enum *enum_class,
- size_t len, int byte_order, GQuark q)
+/*
+ * Returns a GArray or NULL.
+ * Caller must release the GArray with g_array_unref().
+ */
+GArray *enum_int_to_quark_set(const struct type_enum *enum_type, uint64_t v)
{
- gconstpointer v = g_hash_table_lookup(enum_class->table.quark_to_value,
- (gconstpointer) q);
- return *(const int64_t *) v;
+ struct enum_range_to_quark *iter;
+ GArray *qs, *ranges = NULL;
+
+ /* Single values lookup */
+ qs = g_hash_table_lookup(enum_type->table.value_to_quark_set, &v);
+
+ /* Range lookup */
+ cds_list_for_each_entry(iter, &enum_type->table.range_to_quark, node) {
+ if (iter->range.start._signed > v || iter->range.end._signed < v)
+ continue;
+ if (!ranges) {
+ size_t qs_len = 0;
+
+ if (qs)
+ qs_len = qs->len;
+ ranges = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct enum_range),
+ qs_len + 1);
+ g_array_set_size(ranges, qs_len + 1);
+ if (qs)
+ memcpy(ranges->data, qs->data,
+ sizeof(struct enum_range) * qs_len);
+ g_array_index(ranges, struct enum_range, qs_len) = iter->range;
+ } else {
+ g_array_set_size(ranges, ranges->len + 1);
+ g_array_index(ranges, struct enum_range, ranges->len) = iter->range;
+ }
+ }
+ if (!ranges) {
+ ranges = qs;
+ g_array_ref(ranges);
+ }
+ return ranges;
}
+#if (__WORDSIZE == 32)
+static
guint enum_val_hash(gconstpointer key)
{
int64_t ukey = *(const int64_t *)key;
return (guint)ukey ^ (guint)(ukey >> 32);
}
+static
gboolean enum_val_equal(gconstpointer a, gconstpointer b)
{
int64_t ua = *(const int64_t *)a;
return ua == ub;
}
+static
void enum_val_free(void *ptr)
{
g_free(ptr);
}
-void enum_signed_insert(struct type_class_enum *enum_class, int64_t v, GQuark q)
+static
+void enum_signed_insert_value_to_quark_set(struct type_enum *enum_type,
+ int64_t v, GQuark q)
{
- int64_t *valuep = g_new(int64_t, 1);
+ int64_t *valuep;
+ GArray *array;
- g_hash_table_insert(enum_class->table>value_to_quark, valuep,
- (gpointer) (unsigned long) q);
- g_hash_table_insert(enum_class->table.quark_to_value,
- (gpointer) (unsigned long) q,
- valuep);
+ array = g_hash_table_lookup(enum_type->table.value_to_quark_set, &v);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE, sizeof(GQuark), 1);
+ g_array_set_size(array, 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ valuep = g_new(int64_t, 1);
+ *valuep = v;
+ g_hash_table_insert(enum_type->table.value_to_quark_set, valuep, array);
+ } else {
+ g_array_set_size(array, array->len + 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ }
}
-void enum_unsigned_insert(struct type_class_enum *enum_class, uint64_t v, GQuark q)
+static
+void enum_unsigned_insert_value_to_quark_set(struct type_enum *enum_type,
+ uint64_t v, GQuark q)
{
- uint64_t *valuep = g_new(uint64_t, 1);
+ uint64_t *valuep;
+ GArray *array;
- g_hash_table_insert(enum_class->table.value_to_quark, valuep,
- (gpointer) (unsigned long) q);
- g_hash_table_insert(enum_class->table.quark_to_value,
- (gpointer) (unsigned long) q,
- valuep);
+ array = g_hash_table_lookup(enum_type->table.value_to_quark_set, &v);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE, sizeof(GQuark), 1);
+ g_array_set_size(array, 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ valuep = g_new(uint64_t, 1);
+ *valuep = v;
+ g_hash_table_insert(enum_type->table.value_to_quark_set, valuep, array);
+ } else {
+ g_array_set_size(array, array->len + 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ }
}
-#else /* __WORDSIZE != 32 */
-GQuark enum_uint_to_quark(const struct type_class_enum *enum_class, uint64_t v)
+#else /* __WORDSIZE != 32 */
+static
+guint enum_val_hash(gconstpointer key)
{
- gconstpointer q = g_hash_table_lookup(enum_class->table.value_to_quark,
- (gconstpointer) v);
- return (GQuark) (unsigned long) q;
+ return g_direct_hash(key);
}
-GQuark enum_int_to_quark(const struct type_class_enum *enum_class, uint64_t v)
+static
+gboolean enum_val_equal(gconstpointer a, gconstpointer b)
{
- gconstpointer q = g_hash_table_lookup(enum_class->table.value_to_quark,
- (gconstpointer) v);
- return (GQuark) (unsigned long) q;
+ return g_direct_equal(a, b);
}
-uint64_t enum_quark_to_uint(const struct type_class_enum *enum_class,
- size_t len, int byte_order, GQuark q)
+static
+void enum_val_free(void *ptr)
{
- gconstpointer v = g_hash_table_lookup(enum_class->table.quark_to_value,
- (gconstpointer) (unsigned long) q);
- return *(const uint64_t *) v;
}
-int64_t enum_quark_to_int(const struct type_class_enum *enum_class,
- size_t len, int byte_order, GQuark q)
+static
+void enum_signed_insert_value_to_quark_set(struct type_enum *enum_type,
+ int64_t v, GQuark q)
{
- gconstpointer v = g_hash_table_lookup(enum_class->table.quark_to_value,
- (gconstpointer) (unsigned long) q);
- return *(const int64_t *) v;
+ GArray *array;
+
+ array = g_hash_table_lookup(enum_type->table.value_to_quark_set,
+ (gconstpointer) v);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE, sizeof(GQuark), 1);
+ g_array_set_size(array, 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ g_hash_table_insert(enum_type->table.value_to_quark_set,
+ (gpointer) v, array);
+ } else {
+ g_array_set_size(array, array->len + 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ }
}
-guint enum_val_hash(gconstpointer key)
+static
+void enum_unsigned_insert_value_to_quark_set(struct type_enum *enum_type,
+ uint64_t v, GQuark q)
{
- return g_direct_hash(key);
+ GArray *array;
+
+ array = g_hash_table_lookup(enum_type->table.value_to_quark_set,
+ (gconstpointer) v);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE, sizeof(GQuark), 1);
+ g_array_set_size(array, 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ g_hash_table_insert(enum_type->table.value_to_quark_set,
+ (gpointer) v, array);
+ } else {
+ g_array_set_size(array, array->len + 1);
+ g_array_index(array, GQuark, array->len - 1) = q;
+ }
}
+#endif /* __WORDSIZE != 32 */
-gboolean enum_val_equal(gconstpointer a, gconstpointer b)
+GArray *enum_quark_to_range_set(const struct type_enum *enum_type,
+ GQuark q)
{
- return g_direct_equal(a, b);
+ return g_hash_table_lookup(enum_type->table.quark_to_range_set,
+ (gconstpointer) (unsigned long) q);
}
-void enum_val_free(void *ptr)
+static
+void enum_signed_insert_range_to_quark(struct type_enum *enum_type,
+ int64_t start, int64_t end, GQuark q)
{
+ struct enum_range_to_quark *rtoq;
+
+ rtoq = g_new(struct enum_range_to_quark, 1);
+ cds_list_add(&rtoq->node, &enum_type->table.range_to_quark);
+ rtoq->range.start._signed = start;
+ rtoq->range.end._signed = end;
+ rtoq->quark = q;
}
-void enum_signed_insert(struct type_class_enum *enum_class,
- int64_t v, GQuark q)
+static
+void enum_unsigned_insert_range_to_quark(struct type_enum *enum_type,
+ uint64_t start, uint64_t end, GQuark q)
{
- g_hash_table_insert(enum_class->table.value_to_quark, (gpointer) v,
- (gpointer) (unsigned long) q);
- g_hash_table_insert(enum_class->table.quark_to_value,
- (gpointer) (unsigned long) q,
- valuep);
+ struct enum_range_to_quark *rtoq;
+
+ rtoq = g_new(struct enum_range_to_quark, 1);
+ cds_list_add(&rtoq->node, &enum_type->table.range_to_quark);
+ rtoq->range.start._unsigned = start;
+ rtoq->range.end._unsigned = end;
+ rtoq->quark = q;
}
-void enum_unsigned_insert(struct type_class_enum *enum_class,
- uint64_t v, GQuark q)
+void enum_signed_insert(struct type_enum *enum_type,
+ int64_t start, int64_t end, GQuark q)
{
- g_hash_table_insert(enum_class->table.value_to_quark, (gpointer) v,
- (gpointer) (unsigned long) q);
- g_hash_table_insert(enum_class->table.quark_to_value,
- (gpointer) (unsigned long) q,
- valuep);
+ GArray *array;
+ struct enum_range *range;
+
+ if (start == end) {
+ enum_signed_insert_value_to_quark_set(enum_type, start, q);
+ } else {
+ if (start > end) {
+ uint64_t tmp;
+
+ tmp = start;
+ start = end;
+ end = tmp;
+ }
+ enum_signed_insert_range_to_quark(enum_type, start, end, q);
+ }
+
+ array = g_hash_table_lookup(enum_type->table.quark_to_range_set,
+ (gconstpointer) (unsigned long) q);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct enum_range), 1);
+ g_hash_table_insert(enum_type->table.quark_to_range_set,
+ (gpointer) (unsigned long) q,
+ array);
+ }
+ g_array_set_size(array, array->len + 1);
+ range = &g_array_index(array, struct enum_range, array->len - 1);
+ range->start._signed = start;
+ range->end._signed = end;
}
-#endif /* __WORDSIZE != 32 */
-size_t enum_copy(unsigned char *dest, const struct format *fdest,
- const unsigned char *src, const struct format *fsrc,
- const struct type_class *type_class)
+void enum_unsigned_insert(struct type_enum *enum_type,
+ uint64_t start, uint64_t end, GQuark q)
{
- struct type_class_enum *enum_class =
- container_of(type_class, struct type_class_enum, p);
- struct type_class_bitfield *bitfield_class = &enum_class->p;
- struct type_class_integer *int_class = &bitfield_class->p;
- GQuark v;
+ GArray *array;
+ struct enum_range *range;
+
- v = fsrc->enum_read(src, enum_class)
- return fdest->enum_write(dest, enum_class, v);
-}
-
-void enum_type_free(struct type_class_enum *enum_class)
-{
- g_hash_table_destroy(enum_class->table.value_to_quark);
- g_hash_table_destroy(enum_class->table.quark_to_value);
- g_free(enum_class);
-}
-
-static
-void _enum_type_free(struct type_class *type_class)
-{
- struct type_class_enum *enum_class =
- container_of(type_class, struct type_class_enum, p);
- enum_type_free(enum_class);
-}
-
-struct type_class_enum *enum_type_new(const char *name,
- size_t start_offset,
- size_t len, int byte_order,
- int signedness,
- size_t alignment)
-{
- struct type_class_bitfield *bitfield_class;
- struct type_class_integer *int_class;
- int ret;
-
- enum_class = g_new(struct type_class_bitfield, 1);
- enum_class->table.value_to_quark = g_hash_table(enum_val_hash,
- enum_val_equal);
- enum_class->table.quark_to_value = g_hash_table_new_full(g_direct_hash,
- g_direct_equal,
- NULL, enum_val_free);
- bitfield_class = &enum_class->p;
- bitfield_class->start_offset = start_offset;
- int_class = &bitfield_class->p;
- int_class->p.name = g_quark_from_string(name);
- int_class->p.alignment = alignment;
- int_class->p.copy = enum_copy;
- int_class->p.free = _enum_type_free;
- int_class->len = len;
- int_class->byte_order = byte_order;
- int_class->signedness = signedness;
- bitfield_class->start_offset = start_offset;
- if (int_class->p.name) {
- ret = register_type(&int_class->p);
- if (ret) {
- g_hash_table_destroy(enum_class->table.value_to_quark);
- g_hash_table_destroy(enum_class->table.quark_to_value);
- g_free(enum_class);
- return NULL;
+ if (start == end) {
+ enum_unsigned_insert_value_to_quark_set(enum_type, start, q);
+ } else {
+ if (start > end) {
+ uint64_t tmp;
+
+ tmp = start;
+ start = end;
+ end = tmp;
}
+ enum_unsigned_insert_range_to_quark(enum_type, start, end, q);
+ }
+
+ array = g_hash_table_lookup(enum_type->table.quark_to_range_set,
+ (gconstpointer) (unsigned long) q);
+ if (!array) {
+ array = g_array_sized_new(FALSE, TRUE,
+ sizeof(struct enum_range), 1);
+ g_hash_table_insert(enum_type->table.quark_to_range_set,
+ (gpointer) (unsigned long) q,
+ array);
}
- return enum_class;
+ g_array_set_size(array, array->len + 1);
+ range = &g_array_index(array, struct enum_range, array->len - 1);
+ range->start._unsigned = start;
+ range->end._unsigned = end;
+}
+
+size_t enum_get_nr_enumerators(struct type_enum *enum_type)
+{
+ return g_hash_table_size(enum_type->table.quark_to_range_set);
+}
+
+void enum_copy(struct stream_pos *dest, const struct format *fdest,
+ struct stream_pos *src, const struct format *fsrc,
+ struct declaration *declaration)
+{
+ struct declaration_enum *_enum =
+ container_of(declaration, struct declaration_enum, p);
+ struct type_enum *enum_type= _enum->type;
+ GArray *array;
+ GQuark v;
+
+ array = fsrc->enum_read(src, enum_type);
+ assert(array);
+ /* unref previous array */
+ if (_enum->value)
+ g_array_unref(_enum->value);
+ _enum->value = array;
+ /*
+ * Arbitrarily choose the first one.
+ * TODO: use direct underlying type read/write intead. Not doing it for
+ * now to test enum read and write code.
+ */
+ v = g_array_index(array, GQuark, 0);
+ return fdest->enum_write(dest, enum_type, v);
+}
+
+static
+void _enum_type_free(struct type *type)
+{
+ struct type_enum *enum_type =
+ container_of(type, struct type_enum, p);
+ struct enum_range_to_quark *iter, *tmp;
+
+ g_hash_table_destroy(enum_type->table.value_to_quark_set);
+ cds_list_for_each_entry_safe(iter, tmp, &enum_type->table.range_to_quark, node) {
+ cds_list_del(&iter->node);
+ g_free(iter);
+ }
+ g_hash_table_destroy(enum_type->table.quark_to_range_set);
+ type_unref(&enum_type->integer_type->p);
+ g_free(enum_type);
+}
+
+struct type_enum *
+ _enum_type_new(const char *name, struct type_integer *integer_type)
+{
+ struct type_enum *enum_type;
+
+ enum_type = g_new(struct type_enum, 1);
+
+ enum_type->table.value_to_quark_set = g_hash_table_new_full(enum_val_hash,
+ enum_val_equal,
+ enum_val_free,
+ enum_range_set_free);
+ CDS_INIT_LIST_HEAD(&enum_type->table.range_to_quark);
+ enum_type->table.quark_to_range_set = g_hash_table_new_full(g_int_hash,
+ g_int_equal,
+ NULL, enum_range_set_free);
+ type_ref(&integer_type->p);
+ enum_type->integer_type = integer_type;
+ enum_type->p.name = g_quark_from_string(name);
+ enum_type->p.alignment = 1;
+ enum_type->p.copy = enum_copy;
+ enum_type->p.type_free = _enum_type_free;
+ enum_type->p.declaration_new = _enum_declaration_new;
+ enum_type->p.declaration_free = _enum_declaration_free;
+ enum_type->p.ref = 1;
+ return enum_type;
+}
+
+static
+struct declaration *
+ _enum_declaration_new(struct type *type,
+ struct declaration_scope *parent_scope)
+{
+ struct type_enum *enum_type =
+ container_of(type, struct type_enum, p);
+ struct declaration_enum *_enum;
+ struct declaration *declaration_integer_parent;
+
+ _enum = g_new(struct declaration_enum, 1);
+ type_ref(&enum_type->p);
+ _enum->p.type = type;
+ _enum->type = enum_type;
+ _enum->p.ref = 1;
+ _enum->value = NULL;
+ declaration_integer_parent =
+ enum_type->integer_type->p.declaration_new(&enum_type->integer_type->p,
+ parent_scope);
+ _enum->integer = container_of(declaration_integer_parent,
+ struct declaration_integer, p);
+ return &_enum->p;
+}
+
+static
+void _enum_declaration_free(struct declaration *declaration)
+{
+ struct declaration_enum *_enum =
+ container_of(declaration, struct declaration_enum, p);
+
+ declaration_unref(&_enum->integer->p);
+ type_unref(_enum->p.type);
+ if (_enum->value)
+ g_array_unref(_enum->value);
+ g_free(_enum);
}