X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Ftrace-ir%2Ffield-class.c;h=cd9eeaba7d091eec45e8c611d2d52dc9c60a1b2c;hb=1353b066072e6c389ff35853bac83f65597e7a6a;hp=30f85dbf4ed8adf8c80e8eef12a1895c6d20ae56;hpb=bdb288b3e94e412a33c8647d44f6cfac66ca0665;p=babeltrace.git diff --git a/src/lib/trace-ir/field-class.c b/src/lib/trace-ir/field-class.c index 30f85dbf..cd9eeaba 100644 --- a/src/lib/trace-ir/field-class.c +++ b/src/lib/trace-ir/field-class.c @@ -1,33 +1,15 @@ /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 2013, 2014 Jérémie Galarneau - * - * 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. */ #define BT_LOG_TAG "LIB/FIELD-CLASS" #include "lib/logging.h" -#include "lib/assert-pre.h" +#include "lib/assert-cond.h" #include -#include -#include #include #include #include "lib/object.h" @@ -37,6 +19,7 @@ #include "compat/glib.h" #include #include +#include #include #include "clock-class.h" @@ -45,33 +28,157 @@ #include "field-path.h" #include "utils.h" #include "lib/func-status.h" +#include "lib/integer-range-set.h" +#include "lib/value.h" +BT_EXPORT enum bt_field_class_type bt_field_class_get_type( const struct bt_field_class *fc) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); return fc->type; } static -void init_field_class(struct bt_field_class *fc, enum bt_field_class_type type, +int init_field_class(struct bt_field_class *fc, enum bt_field_class_type type, bt_object_release_func release_func) { + int ret = 0; + BT_ASSERT(fc); - BT_ASSERT(bt_field_class_has_known_type(fc)); BT_ASSERT(release_func); bt_object_init_shared(&fc->base, release_func); fc->type = type; + fc->user_attributes = bt_value_map_create(); + if (!fc->user_attributes) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to create a map value object."); + ret = -1; + goto end; + } + +end: + return ret; +} + +static +void finalize_field_class(struct bt_field_class *fc) +{ + BT_OBJECT_PUT_REF_AND_RESET(fc->user_attributes); +} + +static +void destroy_bit_array_field_class(struct bt_object *obj) +{ + BT_ASSERT(obj); + BT_LIB_LOGD("Destroying bit array field class object: %!+F", obj); + finalize_field_class((void *) obj); + g_free(obj); +} + +BT_EXPORT +struct bt_field_class *bt_field_class_bit_array_create( + struct bt_trace_class *trace_class, uint64_t length) +{ + struct bt_field_class_bit_array *ba_fc = NULL; + + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_ASSERT_PRE("valid-length", length > 0 && length <= 64, + "Unsupported length for bit array field class " + "(minimum is 1, maximum is 64): length=%" PRIu64, length); + BT_LOGD("Creating default bit array field class object."); + ba_fc = g_new0(struct bt_field_class_bit_array, 1); + if (!ba_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one bit array field class."); + goto error; + } + + if (init_field_class((void *) ba_fc, BT_FIELD_CLASS_TYPE_BIT_ARRAY, + destroy_bit_array_field_class)) { + goto error; + } + + ba_fc->length = length; + BT_LIB_LOGD("Created bit array field class object: %!+F", ba_fc); + goto end; + +error: + BT_OBJECT_PUT_REF_AND_RESET(ba_fc); + +end: + return (void *) ba_fc; +} + +BT_EXPORT +uint64_t bt_field_class_bit_array_get_length(const struct bt_field_class *fc) +{ + const struct bt_field_class_bit_array *ba_fc = (const void *) fc; + + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "bit-array", + BT_FIELD_CLASS_TYPE_BIT_ARRAY, "Field class"); + return ba_fc->length; +} + +static +void destroy_bool_field_class(struct bt_object *obj) +{ + BT_ASSERT(obj); + BT_LIB_LOGD("Destroying boolean field class object: %!+F", obj); + finalize_field_class((void *) obj); + g_free(obj); +} + +BT_EXPORT +struct bt_field_class *bt_field_class_bool_create( + bt_trace_class *trace_class) +{ + struct bt_field_class_bool *bool_fc = NULL; + + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_LOGD("Creating default boolean field class object."); + bool_fc = g_new0(struct bt_field_class_bool, 1); + if (!bool_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one boolean field class."); + goto error; + } + + if (init_field_class((void *) bool_fc, BT_FIELD_CLASS_TYPE_BOOL, + destroy_bool_field_class)) { + goto error; + } + + BT_LIB_LOGD("Created boolean field class object: %!+F", bool_fc); + goto end; + +error: + BT_OBJECT_PUT_REF_AND_RESET(bool_fc); + +end: + return (void *) bool_fc; } static -void init_integer_field_class(struct bt_field_class_integer *fc, +int init_integer_field_class(struct bt_field_class_integer *fc, enum bt_field_class_type type, bt_object_release_func release_func) { - init_field_class((void *) fc, type, release_func); + int ret; + + ret = init_field_class((void *) fc, type, release_func); + if (ret) { + goto end; + } + fc->range = 64; fc->base = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL; + +end: + return ret; } static @@ -79,6 +186,7 @@ void destroy_integer_field_class(struct bt_object *obj) { BT_ASSERT(obj); BT_LIB_LOGD("Destroying integer field class object: %!+F", obj); + finalize_field_class((void *) obj); g_free(obj); } @@ -88,7 +196,7 @@ struct bt_field_class *create_integer_field_class(bt_trace_class *trace_class, { struct bt_field_class_integer *int_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); BT_LOGD("Creating default integer field class object: type=%s", bt_common_field_class_type_string(type)); int_fc = g_new0(struct bt_field_class_integer, 1); @@ -98,7 +206,11 @@ struct bt_field_class *create_integer_field_class(bt_trace_class *trace_class, goto error; } - init_integer_field_class(int_fc, type, destroy_integer_field_class); + if (init_integer_field_class(int_fc, type, + destroy_integer_field_class)) { + goto error; + } + BT_LIB_LOGD("Created integer field class object: %!+F", int_fc); goto end; @@ -109,31 +221,37 @@ end: return (void *) int_fc; } -struct bt_field_class *bt_field_class_unsigned_integer_create( +BT_EXPORT +struct bt_field_class *bt_field_class_integer_unsigned_create( bt_trace_class *trace_class) { + BT_ASSERT_PRE_NO_ERROR(); + return create_integer_field_class(trace_class, BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER); } -struct bt_field_class *bt_field_class_signed_integer_create( +BT_EXPORT +struct bt_field_class *bt_field_class_integer_signed_create( bt_trace_class *trace_class) { + BT_ASSERT_PRE_NO_ERROR(); + return create_integer_field_class(trace_class, BT_FIELD_CLASS_TYPE_SIGNED_INTEGER); } +BT_EXPORT uint64_t bt_field_class_integer_get_field_value_range( const struct bt_field_class *fc) { const struct bt_field_class_integer *int_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_INT("field-class", fc, "Field class"); return int_fc->range; } -BT_ASSERT_PRE_FUNC static bool size_is_valid_for_enumeration_field_class(struct bt_field_class *fc, uint64_t size) @@ -142,18 +260,20 @@ bool size_is_valid_for_enumeration_field_class(struct bt_field_class *fc, return true; } +BT_EXPORT void bt_field_class_integer_set_field_value_range( struct bt_field_class *fc, uint64_t size) { struct bt_field_class_integer *int_fc = (void *) fc; - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_IS_INT(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class"); - BT_ASSERT_PRE(size <= 64, + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_INT("field-class", fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_HOT(fc); + BT_ASSERT_PRE("valid-n", + size >= 1 && size <= 64, "Unsupported size for integer field class's field value range " - "(maximum is 64): size=%" PRIu64, size); - BT_ASSERT_PRE( + "(minimum is 1, maximum is 64): size=%" PRIu64, size); + BT_ASSERT_PRE("valid-n-for-enumeration-field-class", int_fc->common.type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || int_fc->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || size_is_valid_for_enumeration_field_class(fc, size), @@ -164,25 +284,27 @@ void bt_field_class_integer_set_field_value_range( BT_LIB_LOGD("Set integer field class's field value range: %!+F", fc); } +BT_EXPORT enum bt_field_class_integer_preferred_display_base bt_field_class_integer_get_preferred_display_base(const struct bt_field_class *fc) { const struct bt_field_class_integer *int_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_INT("field-class", fc, "Field class"); return int_fc->base; } +BT_EXPORT void bt_field_class_integer_set_preferred_display_base( struct bt_field_class *fc, enum bt_field_class_integer_preferred_display_base base) { struct bt_field_class_integer *int_fc = (void *) fc; - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_IS_INT(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class"); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_INT("field-class", fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_HOT(fc); int_fc->base = base; BT_LIB_LOGD("Set integer field class's preferred display base: %!+F", fc); } @@ -195,11 +317,10 @@ void finalize_enumeration_field_class_mapping( if (mapping->label) { g_string_free(mapping->label, TRUE); + mapping->label = NULL; } - if (mapping->ranges) { - g_array_free(mapping->ranges, TRUE); - } + BT_OBJECT_PUT_REF_AND_RESET(mapping->range_set); } static @@ -209,6 +330,7 @@ void destroy_enumeration_field_class(struct bt_object *obj) BT_ASSERT(fc); BT_LIB_LOGD("Destroying enumeration field class object: %!+F", fc); + finalize_field_class((void *) obj); if (fc->mappings) { uint64_t i; @@ -236,7 +358,7 @@ struct bt_field_class *create_enumeration_field_class( { struct bt_field_class_enumeration *enum_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); BT_LOGD("Creating default enumeration field class object: type=%s", bt_common_field_class_type_string(type)); enum_fc = g_new0(struct bt_field_class_enumeration, 1); @@ -246,8 +368,11 @@ struct bt_field_class *create_enumeration_field_class( goto error; } - init_integer_field_class((void *) enum_fc, type, - destroy_enumeration_field_class); + if (init_integer_field_class((void *) enum_fc, type, + destroy_enumeration_field_class)) { + goto error; + } + enum_fc->mappings = g_array_new(FALSE, TRUE, sizeof(struct bt_field_class_enumeration_mapping)); if (!enum_fc->mappings) { @@ -271,105 +396,154 @@ end: return (void *) enum_fc; } -struct bt_field_class *bt_field_class_unsigned_enumeration_create( +BT_EXPORT +struct bt_field_class *bt_field_class_enumeration_unsigned_create( bt_trace_class *trace_class) { + BT_ASSERT_PRE_NO_ERROR(); + return create_enumeration_field_class(trace_class, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION); } -struct bt_field_class *bt_field_class_signed_enumeration_create( +BT_EXPORT +struct bt_field_class *bt_field_class_enumeration_signed_create( bt_trace_class *trace_class) { + BT_ASSERT_PRE_NO_ERROR(); + return create_enumeration_field_class(trace_class, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION); } +BT_EXPORT uint64_t bt_field_class_enumeration_get_mapping_count( const struct bt_field_class *fc) { const struct bt_field_class_enumeration *enum_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_IS_ENUM(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_ENUM("field-class", fc, "Field class"); return (uint64_t) enum_fc->mappings->len; } -const struct bt_field_class_unsigned_enumeration_mapping * -bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const( +BT_EXPORT +const struct bt_field_class_enumeration_unsigned_mapping * +bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const( const struct bt_field_class *fc, uint64_t index) { const struct bt_field_class_enumeration *enum_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, - "Field class"); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "unsigned-enumeration", + BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class"); return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index); } -const struct bt_field_class_signed_enumeration_mapping * -bt_field_class_signed_enumeration_borrow_mapping_by_index_const( +BT_EXPORT +const struct bt_field_class_enumeration_signed_mapping * +bt_field_class_enumeration_signed_borrow_mapping_by_index_const( const struct bt_field_class *fc, uint64_t index) { const struct bt_field_class_enumeration *enum_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, - "Field class"); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "signed-enumeration", + BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field class"); return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index); } -const char *bt_field_class_enumeration_mapping_get_label( - const struct bt_field_class_enumeration_mapping *mapping) +static +const struct bt_field_class_enumeration_mapping * +borrow_enumeration_field_class_mapping_by_label( + const struct bt_field_class_enumeration *fc, const char *label, + const char *api_func) { - BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping"); - return mapping->label->str; + struct bt_field_class_enumeration_mapping *mapping = NULL; + uint64_t i; + + BT_ASSERT_DBG(fc); + BT_ASSERT_PRE_DEV_NON_NULL_FROM_FUNC(api_func, "label", label, + "Label"); + + for (i = 0; i < fc->mappings->len; i++) { + struct bt_field_class_enumeration_mapping *this_mapping = + BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i); + + if (strcmp(this_mapping->label->str, label) == 0) { + mapping = this_mapping; + goto end; + } + } + +end: + return mapping; } -uint64_t bt_field_class_enumeration_mapping_get_range_count( - const struct bt_field_class_enumeration_mapping *mapping) +BT_EXPORT +const struct bt_field_class_enumeration_signed_mapping * +bt_field_class_enumeration_signed_borrow_mapping_by_label_const( + const struct bt_field_class *fc, const char *label) { - BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping"); - return (uint64_t) mapping->ranges->len; + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "signed-enumeration", + BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field class"); + return (const void *) borrow_enumeration_field_class_mapping_by_label( + (const void *) fc, label, __func__); } -static inline -void get_enumeration_field_class_mapping_range_at_index( - const struct bt_field_class_enumeration_mapping *mapping, - uint64_t index, uint64_t *lower, uint64_t *upper) +BT_EXPORT +const struct bt_field_class_enumeration_unsigned_mapping * +bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const( + const struct bt_field_class *fc, const char *label) { - const struct bt_field_class_enumeration_mapping_range *range; + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "unsigned-enumeration", + BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class"); + return (const void *) borrow_enumeration_field_class_mapping_by_label( + (const void *) fc, label, __func__); +} - BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Ranges"); - BT_ASSERT_PRE_DEV_NON_NULL(lower, "Range's lower (output)"); - BT_ASSERT_PRE_DEV_NON_NULL(upper, "Range's upper (output)"); - BT_ASSERT_PRE_DEV_VALID_INDEX(index, mapping->ranges->len); - range = BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(mapping, index); - *lower = range->lower.u; - *upper = range->upper.u; +BT_EXPORT +const char *bt_field_class_enumeration_mapping_get_label( + const struct bt_field_class_enumeration_mapping *mapping) +{ + BT_ASSERT_PRE_DEV_NON_NULL("enumeration-field-class-mapping", + mapping, "Enumeration field class mapping"); + return mapping->label->str; } -void bt_field_class_unsigned_enumeration_mapping_get_range_by_index( - const struct bt_field_class_unsigned_enumeration_mapping *ranges, - uint64_t index, uint64_t *lower, uint64_t *upper) +BT_EXPORT +const struct bt_integer_range_set_unsigned * +bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const( + const struct bt_field_class_enumeration_unsigned_mapping *u_mapping) { - get_enumeration_field_class_mapping_range_at_index( - (const void *) ranges, index, lower, upper); + const struct bt_field_class_enumeration_mapping *mapping = + (const void *) u_mapping; + + BT_ASSERT_PRE_DEV_NON_NULL("enumeration-field-class-mapping", + mapping, "Enumeration field class mapping"); + return (const void *) mapping->range_set; } -void bt_field_class_signed_enumeration_mapping_get_range_by_index( - const struct bt_field_class_signed_enumeration_mapping *ranges, - uint64_t index, int64_t *lower, int64_t *upper) +BT_EXPORT +const struct bt_integer_range_set_signed * +bt_field_class_enumeration_signed_mapping_borrow_ranges_const( + const struct bt_field_class_enumeration_signed_mapping *s_mapping) { - get_enumeration_field_class_mapping_range_at_index( - (const void *) ranges, index, - (uint64_t *) lower, (uint64_t *) upper); + const struct bt_field_class_enumeration_mapping *mapping = + (const void *) s_mapping; + + BT_ASSERT_PRE_DEV_NON_NULL("enumeration-field-class-mapping", + mapping, "Enumeration field class mapping"); + return (const void *) mapping->range_set; } +BT_EXPORT enum bt_field_class_enumeration_get_mapping_labels_for_value_status -bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( +bt_field_class_enumeration_unsigned_get_mapping_labels_for_value( const struct bt_field_class *fc, uint64_t value, bt_field_class_enumeration_mapping_label_array *label_array, uint64_t *count) @@ -377,11 +551,13 @@ bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( const struct bt_field_class_enumeration *enum_fc = (const void *) fc; uint64_t i; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)"); - BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, - "Field class"); + BT_ASSERT_PRE_DEV_NO_ERROR(); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_NON_NULL("label-array-output", label_array, + "Label array (output)"); + BT_ASSERT_PRE_DEV_NON_NULL("count-output", count, "Count (output)"); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "unsigned-enumeration", + BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class"); g_ptr_array_set_size(enum_fc->label_buf, 0); for (i = 0; i < enum_fc->mappings->len; i++) { @@ -389,10 +565,10 @@ bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( const struct bt_field_class_enumeration_mapping *mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i); - for (j = 0; j < mapping->ranges->len; j++) { - const struct bt_field_class_enumeration_mapping_range *range = - BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX( - mapping, j); + for (j = 0; j < mapping->range_set->ranges->len; j++) { + const struct bt_integer_range *range = (const void *) + BT_INTEGER_RANGE_SET_RANGE_AT_INDEX( + mapping->range_set, j); if (value >= range->lower.u && value <= range->upper.u) { @@ -408,8 +584,9 @@ bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( return BT_FUNC_STATUS_OK; } +BT_EXPORT enum bt_field_class_enumeration_get_mapping_labels_for_value_status -bt_field_class_signed_enumeration_get_mapping_labels_for_value( +bt_field_class_enumeration_signed_get_mapping_labels_for_value( const struct bt_field_class *fc, int64_t value, bt_field_class_enumeration_mapping_label_array *label_array, uint64_t *count) @@ -417,11 +594,13 @@ bt_field_class_signed_enumeration_get_mapping_labels_for_value( const struct bt_field_class_enumeration *enum_fc = (const void *) fc; uint64_t i; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)"); - BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, - "Field class"); + BT_ASSERT_PRE_DEV_NO_ERROR(); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_NON_NULL("label-array-output", label_array, + "Label array (output)"); + BT_ASSERT_PRE_DEV_NON_NULL("count-output", count, "Count (output)"); + BT_ASSERT_PRE_DEV_FC_HAS_TYPE("field-class", fc, "signed-enumeration", + BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field class"); g_ptr_array_set_size(enum_fc->label_buf, 0); for (i = 0; i < enum_fc->mappings->len; i++) { @@ -429,10 +608,10 @@ bt_field_class_signed_enumeration_get_mapping_labels_for_value( const struct bt_field_class_enumeration_mapping *mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i); - for (j = 0; j < mapping->ranges->len; j++) { - const struct bt_field_class_enumeration_mapping_range *range = - BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX( - mapping, j); + for (j = 0; j < mapping->range_set->ranges->len; j++) { + const struct bt_integer_range *range = (const void *) + BT_INTEGER_RANGE_SET_RANGE_AT_INDEX( + mapping->range_set, j); if (value >= range->lower.i && value <= range->upper.i) { @@ -448,122 +627,97 @@ bt_field_class_signed_enumeration_get_mapping_labels_for_value( return BT_FUNC_STATUS_OK; } -static inline -enum bt_field_class_enumeration_map_range_status -add_mapping_to_enumeration_field_class( - struct bt_field_class *fc, - const char *label, uint64_t lower, uint64_t upper) +static +bool enumeration_field_class_has_mapping_with_label( + const struct bt_field_class_enumeration *enum_fc, + const char *label) { - int ret = BT_FUNC_STATUS_OK; uint64_t i; - struct bt_field_class_enumeration *enum_fc = (void *) fc; - struct bt_field_class_enumeration_mapping *mapping = NULL; - struct bt_field_class_enumeration_mapping_range *range; + bool exists = false; - BT_ASSERT(fc); - BT_ASSERT_PRE_NON_NULL(label, "Label"); + BT_ASSERT(enum_fc); + BT_ASSERT(label); - /* Find existing mapping identified by this label */ for (i = 0; i < enum_fc->mappings->len; i++) { struct bt_field_class_enumeration_mapping *mapping_candidate = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i); if (strcmp(mapping_candidate->label->str, label) == 0) { - mapping = mapping_candidate; - break; + exists = true; + goto end; } } - if (!mapping) { - /* Create new mapping for this label */ - g_array_set_size(enum_fc->mappings, enum_fc->mappings->len + 1); - mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, - enum_fc->mappings->len - 1); - mapping->ranges = g_array_new(FALSE, TRUE, - sizeof(struct bt_field_class_enumeration_mapping_range)); - if (!mapping->ranges) { - finalize_enumeration_field_class_mapping(mapping); - g_array_set_size(enum_fc->mappings, - enum_fc->mappings->len - 1); - ret = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; - } +end: + return exists; +} - mapping->label = g_string_new(label); - if (!mapping->label) { - finalize_enumeration_field_class_mapping(mapping); - g_array_set_size(enum_fc->mappings, - enum_fc->mappings->len - 1); - ret = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; - } +static inline +enum bt_field_class_enumeration_add_mapping_status +add_mapping_to_enumeration_field_class(struct bt_field_class *fc, + const char *label, const struct bt_integer_range_set *range_set, + const char *api_func) +{ + enum bt_field_class_enumeration_add_mapping_status status = + BT_FUNC_STATUS_OK; + struct bt_field_class_enumeration *enum_fc = (void *) fc; + struct bt_field_class_enumeration_mapping mapping = { 0 }; + + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT(fc); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "label", label, "Label"); + BT_ASSERT_PRE_INT_RANGE_SET_NON_NULL_FROM_FUNC(api_func, range_set); + BT_ASSERT_PRE_FROM_FUNC(api_func, + "enumeration-field-class-mapping-label-is-unique", + !enumeration_field_class_has_mapping_with_label( + enum_fc, label), + "Duplicate mapping name in enumeration field class: " + "%![enum-fc-]+F, label=\"%s\"", fc, label); + mapping.range_set = range_set; + bt_object_get_ref(mapping.range_set); + mapping.label = g_string_new(label); + if (!mapping.label) { + finalize_enumeration_field_class_mapping(&mapping); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; } - /* Add range */ - BT_ASSERT(mapping); - g_array_set_size(mapping->ranges, mapping->ranges->len + 1); - range = BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(mapping, - mapping->ranges->len - 1); - range->lower.u = lower; - range->upper.u = upper; + g_array_append_val(enum_fc->mappings, mapping); BT_LIB_LOGD("Added mapping to enumeration field class: " - "%![fc-]+F, label=\"%s\", lower-unsigned=%" PRIu64 ", " - "upper-unsigned=%" PRIu64, fc, label, lower, upper); + "%![fc-]+F, label=\"%s\"", fc, label); end: - return ret; + return status; } -enum bt_field_class_enumeration_map_range_status -bt_field_class_unsigned_enumeration_map_range( +BT_EXPORT +enum bt_field_class_enumeration_add_mapping_status +bt_field_class_enumeration_unsigned_add_mapping( struct bt_field_class *fc, const char *label, - uint64_t range_lower, uint64_t range_upper) + const struct bt_integer_range_set_unsigned *range_set) { - struct bt_field_class_enumeration *enum_fc = (void *) fc; + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "unsigned-enumeration-field-class", + BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class"); + return add_mapping_to_enumeration_field_class(fc, label, + (const void *) range_set, __func__); +} - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, - "Field class"); - BT_ASSERT_PRE(range_lower <= range_upper, - "Range's upper bound is less than lower bound: " - "upper=%" PRIu64 ", lower=%" PRIu64, - range_lower, range_upper); - BT_ASSERT_PRE(bt_util_value_is_in_range_unsigned(enum_fc->common.range, - range_lower), - "Range's lower bound is outside the enumeration field class's value range: " - "%![fc-]+F, lower=%" PRIu64, fc, range_lower); - BT_ASSERT_PRE(bt_util_value_is_in_range_unsigned(enum_fc->common.range, - range_upper), - "Range's upper bound is outside the enumeration field class's value range: " - "%![fc-]+F, upper=%" PRIu64, fc, range_upper); - return add_mapping_to_enumeration_field_class(fc, label, range_lower, - range_upper); -} - -enum bt_field_class_enumeration_map_range_status -bt_field_class_signed_enumeration_map_range( +BT_EXPORT +enum bt_field_class_enumeration_add_mapping_status +bt_field_class_enumeration_signed_add_mapping( struct bt_field_class *fc, const char *label, - int64_t range_lower, int64_t range_upper) + const struct bt_integer_range_set_signed *range_set) { - struct bt_field_class_enumeration *enum_fc = (void *) fc; - - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, - "Field class"); - BT_ASSERT_PRE(range_lower <= range_upper, - "Range's upper bound is less than lower bound: " - "upper=%" PRId64 ", lower=%" PRId64, - range_lower, range_upper); - BT_ASSERT_PRE(bt_util_value_is_in_range_signed(enum_fc->common.range, - range_lower), - "Range's lower bound is outside the enumeration field class's value range: " - "%![fc-]+F, lower=%" PRId64, fc, range_lower); - BT_ASSERT_PRE(bt_util_value_is_in_range_signed(enum_fc->common.range, - range_upper), - "Range's upper bound is outside the enumeration field class's value range: " - "%![fc-]+F, upper=%" PRId64, fc, range_upper); - return add_mapping_to_enumeration_field_class(fc, label, range_lower, - range_upper); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "signed-enumeration-field-class", + BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field class"); + return add_mapping_to_enumeration_field_class(fc, label, + (const void *) range_set, __func__); } static @@ -571,23 +725,29 @@ void destroy_real_field_class(struct bt_object *obj) { BT_ASSERT(obj); BT_LIB_LOGD("Destroying real field class object: %!+F", obj); + finalize_field_class((void *) obj); g_free(obj); } -struct bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class) +static +struct bt_field_class *create_real_field_class(bt_trace_class *trace_class, + enum bt_field_class_type type) { struct bt_field_class_real *real_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); - BT_LOGD_STR("Creating default real field class object."); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_LOGD("Creating default real field class object: type=%s", + bt_common_field_class_type_string(type)); real_fc = g_new0(struct bt_field_class_real, 1); if (!real_fc) { BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one real field class."); goto error; } - init_field_class((void *) real_fc, BT_FIELD_CLASS_TYPE_REAL, - destroy_real_field_class); + if (init_field_class((void *) real_fc, type, destroy_real_field_class)) { + goto error; + } + BT_LIB_LOGD("Created real field class object: %!+F", real_fc); goto end; @@ -598,41 +758,43 @@ end: return (void *) real_fc; } -bt_bool bt_field_class_real_is_single_precision(const struct bt_field_class *fc) +BT_EXPORT +struct bt_field_class *bt_field_class_real_single_precision_create( + bt_trace_class *trace_class) { - const struct bt_field_class_real *real_fc = (const void *) fc; + BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class"); - return real_fc->is_single_precision; + return create_real_field_class(trace_class, + BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL); } -void bt_field_class_real_set_is_single_precision(struct bt_field_class *fc, - bt_bool is_single_precision) +BT_EXPORT +struct bt_field_class *bt_field_class_real_double_precision_create( + bt_trace_class *trace_class) { - struct bt_field_class_real *real_fc = (void *) fc; + BT_ASSERT_PRE_NO_ERROR(); - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class"); - BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class"); - real_fc->is_single_precision = (bool) is_single_precision; - BT_LIB_LOGD("Set real field class's \"is single precision\" property: " - "%!+F", fc); + return create_real_field_class(trace_class, + BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL); } static int init_named_field_classes_container( struct bt_field_class_named_field_class_container *fc, enum bt_field_class_type type, - bt_object_release_func release_func) + bt_object_release_func fc_release_func, + GDestroyNotify named_fc_destroy_func) { int ret = 0; - init_field_class((void *) fc, type, release_func); - fc->named_fcs = g_array_new(FALSE, TRUE, - sizeof(struct bt_named_field_class)); + ret = init_field_class((void *) fc, type, fc_release_func); + if (ret) { + goto end; + } + + fc->named_fcs = g_ptr_array_new_with_free_func(named_fc_destroy_func); if (!fc->named_fcs) { - BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray."); + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); ret = -1; goto end; } @@ -656,35 +818,56 @@ void finalize_named_field_class(struct bt_named_field_class *named_fc) "addr=%p, name=\"%s\", %![fc-]+F", named_fc, named_fc->name ? named_fc->name->str : NULL, named_fc->fc); + BT_OBJECT_PUT_REF_AND_RESET(named_fc->user_attributes); if (named_fc->name) { g_string_free(named_fc->name, TRUE); + named_fc->name = NULL; } BT_LOGD_STR("Putting named field class's field class."); BT_OBJECT_PUT_REF_AND_RESET(named_fc->fc); } +static +void destroy_named_field_class(gpointer ptr) +{ + struct bt_named_field_class *named_fc = ptr; + + if (ptr) { + BT_OBJECT_PUT_REF_AND_RESET(named_fc->user_attributes); + finalize_named_field_class(ptr); + g_free(ptr); + } +} + +static +void destroy_variant_with_selector_field_option(gpointer ptr) +{ + struct bt_field_class_variant_with_selector_field_option *opt = ptr; + + if (ptr) { + finalize_named_field_class(&opt->common); + BT_OBJECT_PUT_REF_AND_RESET(opt->range_set); + g_free(ptr); + } +} + static void finalize_named_field_classes_container( struct bt_field_class_named_field_class_container *fc) { - uint64_t i; - BT_ASSERT(fc); if (fc->named_fcs) { - for (i = 0; i < fc->named_fcs->len; i++) { - finalize_named_field_class( - &g_array_index(fc->named_fcs, - struct bt_named_field_class, i)); - } + g_ptr_array_free(fc->named_fcs, TRUE); + fc->named_fcs = NULL; - g_array_free(fc->named_fcs, TRUE); } if (fc->name_to_index) { g_hash_table_destroy(fc->name_to_index); + fc->name_to_index = NULL; } } @@ -693,17 +876,20 @@ void destroy_structure_field_class(struct bt_object *obj) { BT_ASSERT(obj); BT_LIB_LOGD("Destroying structure field class object: %!+F", obj); + finalize_field_class((void *) obj); finalize_named_field_classes_container((void *) obj); g_free(obj); } +BT_EXPORT struct bt_field_class *bt_field_class_structure_create( bt_trace_class *trace_class) { int ret; struct bt_field_class_structure *struct_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); BT_LOGD_STR("Creating default structure field class object."); struct_fc = g_new0(struct bt_field_class_structure, 1); if (!struct_fc) { @@ -713,8 +899,10 @@ struct bt_field_class *bt_field_class_structure_create( } ret = init_named_field_classes_container((void *) struct_fc, - BT_FIELD_CLASS_TYPE_STRUCTURE, destroy_structure_field_class); + BT_FIELD_CLASS_TYPE_STRUCTURE, destroy_structure_field_class, + destroy_named_field_class); if (ret) { + /* init_named_field_classes_container() logs errors */ goto error; } @@ -729,71 +917,165 @@ end: } static -int append_named_field_class_to_container_field_class( - struct bt_field_class_named_field_class_container *container_fc, +int init_named_field_class(struct bt_named_field_class *named_fc, const char *name, struct bt_field_class *fc) { - int ret = BT_FUNC_STATUS_OK; - struct bt_named_field_class *named_fc; - GString *name_str; + int status = BT_FUNC_STATUS_OK; - BT_ASSERT(container_fc); - BT_ASSERT_PRE_DEV_FC_HOT(container_fc, "Field class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE(!bt_g_hash_table_contains(container_fc->name_to_index, - name), - "Duplicate member/option name in structure/variant field class: " - "%![container-fc-]+F, name=\"%s\"", container_fc, name); - name_str = g_string_new(name); - if (!name_str) { + BT_ASSERT(named_fc); + BT_ASSERT(name); + BT_ASSERT(fc); + named_fc->name = g_string_new(name); + if (!named_fc->name) { BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); - ret = BT_FUNC_STATUS_MEMORY_ERROR; + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + named_fc->user_attributes = bt_value_map_create(); + if (!named_fc->user_attributes) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to create a map value object."); + status = BT_FUNC_STATUS_MEMORY_ERROR; goto end; } - g_array_set_size(container_fc->named_fcs, - container_fc->named_fcs->len + 1); - named_fc = &g_array_index(container_fc->named_fcs, - struct bt_named_field_class, container_fc->named_fcs->len - 1); - named_fc->name = name_str; named_fc->fc = fc; - bt_object_get_no_null_check(fc); - g_hash_table_insert(container_fc->name_to_index, named_fc->name->str, - GUINT_TO_POINTER(container_fc->named_fcs->len - 1)); + bt_object_get_ref_no_null_check(named_fc->fc); - /* - * Freeze the field class, but not the named field class (the - * user can still modify it, if possible, until the container - * itself is frozen). - */ - bt_field_class_freeze(fc); +end: + return status; +} + +static +struct bt_named_field_class *create_named_field_class(const char *name, + struct bt_field_class *fc) +{ + struct bt_named_field_class *named_fc = g_new0( + struct bt_named_field_class, 1); + + if (!named_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate a named field class."); + goto error; + } + + if (init_named_field_class(named_fc, name, fc)) { + /* init_named_field_class() logs errors */ + goto error; + } + + goto end; + +error: + destroy_named_field_class(named_fc); + named_fc = NULL; end: - return ret; + return named_fc; +} + +static +struct bt_field_class_variant_with_selector_field_option * +create_variant_with_selector_field_option( + const char *name, struct bt_field_class *fc, + const struct bt_integer_range_set *range_set) +{ + struct bt_field_class_variant_with_selector_field_option *opt = g_new0( + struct bt_field_class_variant_with_selector_field_option, 1); + + BT_ASSERT(range_set); + + if (!opt) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate a named field class."); + goto error; + } + + if (init_named_field_class(&opt->common, name, fc)) { + goto error; + } + + opt->range_set = range_set; + bt_object_get_ref_no_null_check(opt->range_set); + bt_integer_range_set_freeze(range_set); + goto end; + +error: + destroy_variant_with_selector_field_option(opt); + opt = NULL; + +end: + return opt; +} + +static +int append_named_field_class_to_container_field_class( + struct bt_field_class_named_field_class_container *container_fc, + struct bt_named_field_class *named_fc, const char *api_func, + const char *unique_entry_precond_id) +{ + BT_ASSERT(container_fc); + BT_ASSERT(named_fc); + BT_ASSERT_PRE_DEV_FC_HOT_FROM_FUNC(api_func, container_fc); + BT_ASSERT_PRE_FROM_FUNC(api_func, unique_entry_precond_id, + !bt_g_hash_table_contains(container_fc->name_to_index, + named_fc->name->str), + "Duplicate member/option name in structure/variant field class: " + "%![container-fc-]+F, name=\"%s\"", container_fc, + named_fc->name->str); + + /* + * Freeze the contained field class, but not the named field + * class itself, as it's still possible afterwards to modify + * properties of the member/option object. + */ + bt_field_class_freeze(named_fc->fc); + g_ptr_array_add(container_fc->named_fcs, named_fc); + g_hash_table_insert(container_fc->name_to_index, named_fc->name->str, + GUINT_TO_POINTER(container_fc->named_fcs->len - 1)); + return BT_FUNC_STATUS_OK; } +BT_EXPORT enum bt_field_class_structure_append_member_status bt_field_class_structure_append_member( struct bt_field_class *fc, const char *name, struct bt_field_class *member_fc) { + enum bt_field_class_structure_append_member_status status; + struct bt_named_field_class *named_fc = NULL; - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); - return append_named_field_class_to_container_field_class((void *) fc, - name, member_fc); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); + named_fc = create_named_field_class(name, member_fc); + if (!named_fc) { + /* create_named_field_class() logs errors */ + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + status = append_named_field_class_to_container_field_class((void *) fc, + named_fc, __func__, + "structure-field-class-member-name-is-unique"); + if (status == BT_FUNC_STATUS_OK) { + /* Moved to the container */ + named_fc = NULL; + } + +end: + return status; } +BT_EXPORT uint64_t bt_field_class_structure_get_member_count( const struct bt_field_class *fc) { struct bt_field_class_structure *struct_fc = (void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); return (uint64_t) struct_fc->common.named_fcs->len; } @@ -801,295 +1083,950 @@ static struct bt_named_field_class * borrow_named_field_class_from_container_field_class_at_index( struct bt_field_class_named_field_class_container *fc, - uint64_t index) + uint64_t index, const char *api_func) { - BT_ASSERT(fc); - BT_ASSERT_PRE_DEV_VALID_INDEX(index, fc->named_fcs->len); - return BT_FIELD_CLASS_NAMED_FC_AT_INDEX(fc, index); + BT_ASSERT_DBG(fc); + BT_ASSERT_PRE_DEV_VALID_INDEX_FROM_FUNC(api_func, index, + fc->named_fcs->len); + return fc->named_fcs->pdata[index]; } +BT_EXPORT const struct bt_field_class_structure_member * bt_field_class_structure_borrow_member_by_index_const( const struct bt_field_class *fc, uint64_t index) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); return (const void *) borrow_named_field_class_from_container_field_class_at_index( - (void *) fc, index); + (void *) fc, index, __func__); } +BT_EXPORT struct bt_field_class_structure_member * bt_field_class_structure_borrow_member_by_index( struct bt_field_class *fc, uint64_t index) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); return (void *) borrow_named_field_class_from_container_field_class_at_index( - (void *) fc, index); + (void *) fc, index, __func__); } static struct bt_named_field_class * borrow_named_field_class_from_container_field_class_by_name( struct bt_field_class_named_field_class_container *fc, - const char *name) + const char *name, const char *api_func) { struct bt_named_field_class *named_fc = NULL; gpointer orig_key; gpointer value; - BT_ASSERT(fc); - BT_ASSERT_PRE_DEV_NON_NULL(name, "Name"); + BT_ASSERT_DBG(fc); + BT_ASSERT_PRE_DEV_NAME_NON_NULL_FROM_FUNC(api_func, name); if (!g_hash_table_lookup_extended(fc->name_to_index, name, &orig_key, &value)) { goto end; } - named_fc = BT_FIELD_CLASS_NAMED_FC_AT_INDEX(fc, - GPOINTER_TO_UINT(value)); + named_fc = fc->named_fcs->pdata[GPOINTER_TO_UINT(value)]; end: return named_fc; } +BT_EXPORT const struct bt_field_class_structure_member * bt_field_class_structure_borrow_member_by_name_const( const struct bt_field_class *fc, const char *name) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); return (const void *) borrow_named_field_class_from_container_field_class_by_name( - (void *) fc, name); + (void *) fc, name, __func__); } +BT_EXPORT struct bt_field_class_structure_member * bt_field_class_structure_borrow_member_by_name( struct bt_field_class *fc, const char *name) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_STRUCT("field-class", fc, "Field class"); return (void *) borrow_named_field_class_from_container_field_class_by_name( - (void *) fc, name); + (void *) fc, name, __func__); } +BT_EXPORT const char *bt_field_class_structure_member_get_name( const struct bt_field_class_structure_member *member) { const struct bt_named_field_class *named_fc = (const void *) member; - BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member"); + BT_ASSERT_PRE_DEV_STRUCT_FC_MEMBER_NON_NULL(member); return named_fc->name->str; } +BT_EXPORT const struct bt_field_class * bt_field_class_structure_member_borrow_field_class_const( const struct bt_field_class_structure_member *member) { const struct bt_named_field_class *named_fc = (const void *) member; - BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member"); + BT_ASSERT_PRE_DEV_STRUCT_FC_MEMBER_NON_NULL(member); return named_fc->fc; } +BT_EXPORT struct bt_field_class * bt_field_class_structure_member_borrow_field_class( struct bt_field_class_structure_member *member) { struct bt_named_field_class *named_fc = (void *) member; - BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member"); + BT_ASSERT_PRE_DEV_STRUCT_FC_MEMBER_NON_NULL(member); return named_fc->fc; } static -void destroy_variant_field_class(struct bt_object *obj) +void destroy_option_field_class(struct bt_object *obj) { - struct bt_field_class_variant *fc = (void *) obj; + struct bt_field_class_option *fc = (void *) obj; BT_ASSERT(fc); - BT_LIB_LOGD("Destroying variant field class object: %!+F", fc); - finalize_named_field_classes_container((void *) fc); - BT_LOGD_STR("Putting selector field path."); - BT_OBJECT_PUT_REF_AND_RESET(fc->selector_field_path); - BT_LOGD_STR("Putting selector field class."); - BT_OBJECT_PUT_REF_AND_RESET(fc->selector_fc); - g_free(fc); -} + BT_LIB_LOGD("Destroying option field class object: %!+F", fc); + finalize_field_class((void *) obj); + BT_LOGD_STR("Putting content field class."); + BT_OBJECT_PUT_REF_AND_RESET(fc->content_fc); + + if (fc->common.type != BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD) { + struct bt_field_class_option_with_selector_field *with_sel_fc = + (void *) obj; + + BT_LOGD_STR("Putting selector field path."); + BT_OBJECT_PUT_REF_AND_RESET(with_sel_fc->selector_field_path); + BT_LOGD_STR("Putting selector field class."); + BT_OBJECT_PUT_REF_AND_RESET(with_sel_fc->selector_fc); + + if (fc->common.type != BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD) { + struct bt_field_class_option_with_selector_field_integer *with_int_sel_fc = + (void *) obj; + + BT_LOGD_STR("Putting integer range set."); + BT_OBJECT_PUT_REF_AND_RESET(with_int_sel_fc->range_set); + } + } + + g_free(fc); +} + +static +struct bt_field_class *create_option_field_class( + struct bt_trace_class *trace_class, + enum bt_field_class_type fc_type, + struct bt_field_class *content_fc, + struct bt_field_class *selector_fc, + const char *api_func) +{ + struct bt_field_class_option *opt_fc = NULL; + + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_TC_NON_NULL_FROM_FUNC(api_func, trace_class); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "content-field-class", + content_fc, "Content field class"); + BT_LIB_LOGD("Creating option field class: " + "type=%s, %![content-fc-]+F, %![sel-fc-]+F", + bt_common_field_class_type_string(fc_type), + content_fc, selector_fc); + + if (fc_type != BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD) { + struct bt_field_class_option_with_selector_field *opt_with_sel_fc = NULL; + + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, + "selector-field-class", selector_fc, + "Selector field class"); + + if (fc_type == BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD) { + BT_ASSERT_PRE_FC_HAS_TYPE_FROM_FUNC(api_func, + "selector-field-class", selector_fc, + "boolean-field-class", BT_FIELD_CLASS_TYPE_BOOL, + "Selector field class"); + opt_with_sel_fc = (void *) g_new0( + struct bt_field_class_option_with_selector_field_bool, 1); + } else { + BT_ASSERT_PRE_FC_IS_INT_FROM_FUNC(api_func, + "selector-field-class", + selector_fc, "Selector field class"); + opt_with_sel_fc = (void *) g_new0( + struct bt_field_class_option_with_selector_field_integer, 1); + } + + if (!opt_with_sel_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one option with selector field class."); + goto error; + } + + opt_with_sel_fc->selector_fc = selector_fc; + bt_object_get_ref_no_null_check(opt_with_sel_fc->selector_fc); + opt_fc = (void *) opt_with_sel_fc; + } else { + opt_fc = g_new0(struct bt_field_class_option, 1); + if (!opt_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one option field class."); + goto error; + } + } + + BT_ASSERT(opt_fc); + + if (init_field_class((void *) opt_fc, fc_type, + destroy_option_field_class)) { + goto error; + } + + opt_fc->content_fc = content_fc; + bt_object_get_ref_no_null_check(opt_fc->content_fc); + bt_field_class_freeze(opt_fc->content_fc); + + if (selector_fc) { + bt_field_class_freeze(selector_fc); + } + + BT_LIB_LOGD("Created option field class object: " + "%![opt-fc-]+F, %![sel-fc-]+F", opt_fc, selector_fc); + goto end; + +error: + BT_OBJECT_PUT_REF_AND_RESET(opt_fc); + +end: + return (void *) opt_fc; +} + +BT_EXPORT +struct bt_field_class *bt_field_class_option_without_selector_create( + struct bt_trace_class *trace_class, + struct bt_field_class *content_fc) +{ + return create_option_field_class(trace_class, + BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD, + content_fc, NULL, __func__); +} + +BT_EXPORT +struct bt_field_class *bt_field_class_option_with_selector_field_bool_create( + struct bt_trace_class *trace_class, + struct bt_field_class *content_fc, + struct bt_field_class *selector_fc) +{ + BT_ASSERT_PRE_NO_ERROR(); + + return create_option_field_class(trace_class, + BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD, + content_fc, selector_fc, __func__); +} + +BT_EXPORT +struct bt_field_class * +bt_field_class_option_with_selector_field_integer_unsigned_create( + struct bt_trace_class *trace_class, + struct bt_field_class *content_fc, + struct bt_field_class *selector_fc, + const struct bt_integer_range_set_unsigned *u_range_set) +{ + struct bt_field_class_option_with_selector_field_integer *fc; + const struct bt_integer_range_set *range_set = + (const void *) u_range_set; + + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_INT_RANGE_SET_NON_NULL(range_set); + BT_ASSERT_PRE_INT_RANGE_SET_NOT_EMPTY(range_set); + fc = (void *) create_option_field_class(trace_class, + BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, + content_fc, selector_fc, __func__); + + if (!fc) { + goto end; + } + + fc->range_set = range_set; + bt_object_get_ref_no_null_check(fc->range_set); + bt_integer_range_set_freeze(range_set); + +end: + return (void *) fc; +} + +BT_EXPORT +struct bt_field_class * +bt_field_class_option_with_selector_field_integer_signed_create( + struct bt_trace_class *trace_class, + struct bt_field_class *content_fc, + struct bt_field_class *selector_fc, + const struct bt_integer_range_set_signed *i_range_set) +{ + struct bt_field_class_option_with_selector_field_integer *fc; + const struct bt_integer_range_set *range_set = + (const void *) i_range_set; + + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_INT_RANGE_SET_NON_NULL(range_set); + BT_ASSERT_PRE_INT_RANGE_SET_NOT_EMPTY(range_set); + fc = (void *) create_option_field_class(trace_class, + BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + content_fc, selector_fc, __func__); + + if (!fc) { + goto end; + } + + fc->range_set = range_set; + bt_object_get_ref_no_null_check(fc->range_set); + bt_integer_range_set_freeze(range_set); + +end: + return (void *) fc; +} + +BT_EXPORT +const struct bt_field_class *bt_field_class_option_borrow_field_class_const( + const struct bt_field_class *fc) +{ + struct bt_field_class_option *opt_fc = (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_OPTION("field-class", fc, "Field class"); + return opt_fc->content_fc; +} + +BT_EXPORT +struct bt_field_class *bt_field_class_option_borrow_field_class( + struct bt_field_class *fc) +{ + struct bt_field_class_option *opt_fc = (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_OPTION("field-class", fc, "Field class"); + return opt_fc->content_fc; +} + +BT_EXPORT +const struct bt_field_path * +bt_field_class_option_with_selector_field_borrow_selector_field_path_const( + const struct bt_field_class *fc) +{ + const struct bt_field_class_option_with_selector_field *opt_fc = + (const void *) fc; + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_OPTION_WITH_SEL("field-class", fc, "Field class"); + return opt_fc->selector_field_path; +} + +BT_EXPORT +void bt_field_class_option_with_selector_field_bool_set_selector_is_reversed( + struct bt_field_class *fc, bt_bool sel_is_reversed) +{ + struct bt_field_class_option_with_selector_field_bool *opt_fc = (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "option-field-class-with-boolean-selector-field", + BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD, + "Field class"); + BT_ASSERT_PRE_DEV_FC_HOT(fc); + opt_fc->sel_is_reversed = sel_is_reversed; +} + +BT_EXPORT +bt_bool bt_field_class_option_with_selector_field_bool_selector_is_reversed( + const struct bt_field_class *fc) +{ + struct bt_field_class_option_with_selector_field_bool *opt_fc = (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "option-field-class-with-boolean-selector-field", + BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD, + "Field class"); + return opt_fc->sel_is_reversed; +} + +BT_EXPORT +const struct bt_integer_range_set_unsigned * +bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const( + const struct bt_field_class *fc) +{ + struct bt_field_class_option_with_selector_field_integer *opt_fc = + (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_OPTION_WITH_INT_SEL("field-class", fc, + "Field class"); + return (const void *) opt_fc->range_set; +} + +BT_EXPORT +const struct bt_integer_range_set_signed * +bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const( + const struct bt_field_class *fc) +{ + struct bt_field_class_option_with_selector_field_integer *opt_fc = + (void *) fc; + + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_IS_OPTION_WITH_INT_SEL("field-class", fc, + "Field class"); + return (const void *) opt_fc->range_set; +} + +static +void finalize_variant_field_class(struct bt_field_class_variant *var_fc) +{ + BT_ASSERT(var_fc); + BT_LIB_LOGD("Finalizing variant field class object: %!+F", var_fc); + finalize_field_class((void *) var_fc); + finalize_named_field_classes_container((void *) var_fc); +} + +static +void destroy_variant_field_class(struct bt_object *obj) +{ + struct bt_field_class_variant *fc = (void *) obj; + + BT_ASSERT(fc); + finalize_variant_field_class(fc); + g_free(fc); +} + +static +void destroy_variant_with_selector_field_field_class(struct bt_object *obj) +{ + struct bt_field_class_variant_with_selector_field *fc = (void *) obj; + + BT_ASSERT(fc); + finalize_variant_field_class(&fc->common); + BT_LOGD_STR("Putting selector field path."); + BT_OBJECT_PUT_REF_AND_RESET(fc->selector_field_path); + BT_LOGD_STR("Putting selector field class."); + BT_OBJECT_PUT_REF_AND_RESET(fc->selector_fc); + g_free(fc); +} + +BT_EXPORT struct bt_field_class *bt_field_class_variant_create( - bt_trace_class *trace_class) + bt_trace_class *trace_class, bt_field_class *selector_fc) { int ret; struct bt_field_class_variant *var_fc = NULL; + struct bt_field_class_variant_with_selector_field *var_with_sel_fc = NULL; + enum bt_field_class_type fc_type; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); - BT_LOGD_STR("Creating default variant field class object."); - var_fc = g_new0(struct bt_field_class_variant, 1); - if (!var_fc) { - BT_LIB_LOGE_APPEND_CAUSE( - "Failed to allocate one variant field class."); - goto error; + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + + if (selector_fc) { + BT_ASSERT_PRE_FC_IS_INT("selector-field-class", selector_fc, + "Selector field class"); } - ret = init_named_field_classes_container((void *) var_fc, - BT_FIELD_CLASS_TYPE_VARIANT, destroy_variant_field_class); - if (ret) { - goto error; + BT_LIB_LOGD("Creating default variant field class: %![sel-fc-]+F", + selector_fc); + + if (selector_fc) { + var_with_sel_fc = g_new0( + struct bt_field_class_variant_with_selector_field, 1); + if (!var_with_sel_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one variant field class with selector."); + goto error; + } + + if (bt_field_class_type_is(selector_fc->type, + BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER)) { + fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD; + } else { + fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD; + } + + ret = init_named_field_classes_container( + (void *) var_with_sel_fc, fc_type, + destroy_variant_with_selector_field_field_class, + destroy_variant_with_selector_field_option); + if (ret) { + /* init_named_field_classes_container() logs errors */ + goto error; + } + + var_with_sel_fc->selector_fc = selector_fc; + bt_object_get_ref_no_null_check(var_with_sel_fc->selector_fc); + bt_field_class_freeze(selector_fc); + var_fc = (void *) var_with_sel_fc; + BT_LIB_LOGD("Created default variant field class with selector object: " + "%![var-fc-]+F, %![sel-fc-]+F", var_fc, selector_fc); + } else { + var_fc = g_new0(struct bt_field_class_variant, 1); + if (!var_fc) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to allocate one variant field class without selector."); + goto error; + } + + ret = init_named_field_classes_container((void *) var_fc, + BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD, + destroy_variant_field_class, destroy_named_field_class); + if (ret) { + /* init_named_field_classes_container() logs errors */ + goto error; + } + BT_LIB_LOGD("Created default variant field class without selector object: " + "%![var-fc-]+F", var_fc); } - BT_LIB_LOGD("Created variant field class object: %!+F", var_fc); + BT_ASSERT(var_fc); goto end; error: BT_OBJECT_PUT_REF_AND_RESET(var_fc); + BT_OBJECT_PUT_REF_AND_RESET(var_with_sel_fc); end: return (void *) var_fc; } -enum bt_field_class_variant_set_selector_field_class_status -bt_field_class_variant_set_selector_field_class( - struct bt_field_class *fc, - struct bt_field_class *selector_fc) +#define VAR_FC_OPT_NAME_IS_UNIQUE_ID \ + "variant-field-class-option-name-is-unique" + +BT_EXPORT +enum bt_field_class_variant_without_selector_append_option_status +bt_field_class_variant_without_selector_append_option(struct bt_field_class *fc, + const char *name, struct bt_field_class *option_fc) { - struct bt_field_class_variant *var_fc = (void *) fc; + enum bt_field_class_variant_without_selector_append_option_status status; + struct bt_named_field_class *named_fc = NULL; - BT_ASSERT_PRE_NON_NULL(fc, "Variant field class"); - BT_ASSERT_PRE_NON_NULL(selector_fc, "Selector field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); - BT_ASSERT_PRE_FC_IS_ENUM(selector_fc, "Selector field class"); - BT_ASSERT_PRE_DEV_FC_HOT(fc, "Variant field class"); - var_fc->selector_fc = selector_fc; - bt_object_get_no_null_check(selector_fc); - bt_field_class_freeze(selector_fc); - return BT_FUNC_STATUS_OK; + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_NAME_NON_NULL(name); + BT_ASSERT_PRE_NON_NULL("option-field-class", option_fc, + "Option field class"); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-without-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD, + "Field class"); + named_fc = create_named_field_class(name, option_fc); + if (!named_fc) { + /* create_named_field_class() logs errors */ + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + status = append_named_field_class_to_container_field_class((void *) fc, + named_fc, __func__, VAR_FC_OPT_NAME_IS_UNIQUE_ID); + if (status == BT_FUNC_STATUS_OK) { + /* Moved to the container */ + named_fc = NULL; + } + +end: + if (named_fc) { + destroy_named_field_class(named_fc); + } + + return status; } -enum bt_field_class_variant_append_option_status -bt_field_class_variant_append_option( - struct bt_field_class *fc, - const char *name, struct bt_field_class *option_fc) +static +int ranges_overlap(GPtrArray *var_fc_opts, const struct bt_integer_range_set *range_set, + bool is_signed, bool *has_overlap) +{ + int status = BT_FUNC_STATUS_OK; + struct bt_integer_range_set *full_range_set; + uint64_t i; + + *has_overlap = false; + + /* + * Build a single range set with all the ranges and test for + * overlaps. + */ + if (is_signed) { + full_range_set = (void *) bt_integer_range_set_signed_create(); + } else { + full_range_set = (void *) bt_integer_range_set_unsigned_create(); + } + + if (!full_range_set) { + BT_LOGE_STR("Failed to create a range set."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + /* Add existing option ranges */ + for (i = 0; i < var_fc_opts->len; i++) { + struct bt_field_class_variant_with_selector_field_option *opt = + var_fc_opts->pdata[i]; + uint64_t j; + + for (j = 0; j < opt->range_set->ranges->len; j++) { + struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX( + opt->range_set, j); + + if (is_signed) { + status = bt_integer_range_set_signed_add_range( + (void *) full_range_set, range->lower.i, + range->upper.i); + } else { + status = bt_integer_range_set_unsigned_add_range( + (void *) full_range_set, range->lower.u, + range->upper.u); + } + + if (status) { + goto end; + } + } + } + + /* Add new ranges */ + for (i = 0; i < range_set->ranges->len; i++) { + struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX( + range_set, i); + + if (is_signed) { + status = bt_integer_range_set_signed_add_range( + (void *) full_range_set, range->lower.i, + range->upper.i); + } else { + status = bt_integer_range_set_unsigned_add_range( + (void *) full_range_set, range->lower.u, + range->upper.u); + } + + if (status) { + goto end; + } + } + + /* Check overlaps */ + if (is_signed) { + *has_overlap = bt_integer_range_set_signed_has_overlaps(full_range_set); + } else { + *has_overlap = bt_integer_range_set_unsigned_has_overlaps( + full_range_set); + } + +end: + bt_object_put_ref(full_range_set); + return status; +} + +static +int append_option_to_variant_with_selector_field_field_class( + struct bt_field_class *fc, const char *name, + struct bt_field_class *option_fc, + const struct bt_integer_range_set *range_set, + enum bt_field_class_type expected_type, + const char *api_func) +{ + int status; + struct bt_field_class_variant_with_selector_field *var_fc = (void *) fc; + struct bt_field_class_variant_with_selector_field_option *opt = NULL; + bool has_overlap; + + BT_ASSERT(fc); + BT_ASSERT_PRE_NAME_NON_NULL_FROM_FUNC(api_func, name); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "option-field-class", + option_fc, "Option field class"); + BT_ASSERT_PRE_INT_RANGE_SET_NON_NULL_FROM_FUNC(api_func, range_set); + BT_ASSERT_PRE_INT_RANGE_SET_NOT_EMPTY_FROM_FUNC(api_func, range_set); + status = ranges_overlap(var_fc->common.common.named_fcs, range_set, + expected_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + &has_overlap); + if (status) { + /* ranges_overlap() logs errors */ + goto end; + } + + BT_ASSERT_PRE_FROM_FUNC(api_func, "ranges-do-not-overlap", + !has_overlap, + "Integer range set's ranges and existing ranges have an overlap: " + "%!+R", range_set); + opt = create_variant_with_selector_field_option(name, option_fc, range_set); + if (!opt) { + /* create_variant_with_selector_field_option() logs errors */ + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + status = append_named_field_class_to_container_field_class((void *) fc, + &opt->common, __func__, VAR_FC_OPT_NAME_IS_UNIQUE_ID); + if (status == BT_FUNC_STATUS_OK) { + /* Moved to the container */ + opt = NULL; + } + +end: + if (opt) { + destroy_variant_with_selector_field_option(opt); + } + + return status; +} + +BT_EXPORT +enum bt_field_class_variant_with_selector_field_integer_append_option_status +bt_field_class_variant_with_selector_field_integer_unsigned_append_option( + struct bt_field_class *fc, const char *name, + struct bt_field_class *option_fc, + const struct bt_integer_range_set_unsigned *range_set) +{ + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-unsigned-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); + return append_option_to_variant_with_selector_field_field_class(fc, + name, option_fc, (const void *) range_set, + BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, + __func__); +} + +BT_EXPORT +enum bt_field_class_variant_with_selector_field_integer_append_option_status +bt_field_class_variant_with_selector_field_integer_signed_append_option( + struct bt_field_class *fc, const char *name, + struct bt_field_class *option_fc, + const struct bt_integer_range_set_signed *range_set) +{ + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-signed-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); + return append_option_to_variant_with_selector_field_field_class(fc, + name, option_fc, (const void *) range_set, + BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + __func__); +} + +BT_EXPORT +uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class *fc) { + const struct bt_field_class_variant *var_fc = (const void *) fc; - BT_ASSERT_PRE_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); - return append_named_field_class_to_container_field_class((void *) fc, - name, option_fc); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT("field-class", fc, "Field class"); + return (uint64_t) var_fc->common.named_fcs->len; } +BT_EXPORT const struct bt_field_class_variant_option * bt_field_class_variant_borrow_option_by_name_const( const struct bt_field_class *fc, const char *name) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, - "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT("field-class", fc, "Field class"); return (const void *) borrow_named_field_class_from_container_field_class_by_name( - (void *) fc, name); + (void *) fc, name, __func__); +} + +BT_EXPORT +const struct bt_field_class_variant_option * +bt_field_class_variant_borrow_option_by_index_const( + const struct bt_field_class *fc, uint64_t index) +{ + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT("field-class", fc, "Field class"); + return (const void *) + borrow_named_field_class_from_container_field_class_at_index( + (void *) fc, index, __func__); } +BT_EXPORT struct bt_field_class_variant_option * bt_field_class_variant_borrow_option_by_name( struct bt_field_class *fc, const char *name) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT("field-class", fc, "Field class"); return (void *) borrow_named_field_class_from_container_field_class_by_name( - (void *) fc, name); + (void *) fc, name, __func__); } -uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class *fc) +BT_EXPORT +struct bt_field_class_variant_option * +bt_field_class_variant_borrow_option_by_index( + struct bt_field_class *fc, uint64_t index) { - const struct bt_field_class_variant *var_fc = (const void *) fc; + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT("field-class", fc, "Field class"); + return (void *) + borrow_named_field_class_from_container_field_class_at_index( + (void *) fc, index, __func__); +} - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); - return (uint64_t) var_fc->common.named_fcs->len; +BT_EXPORT +const struct bt_field_class_variant_with_selector_field_integer_unsigned_option * +bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const( + const struct bt_field_class *fc, const char *name) +{ + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-unsigned-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); + return (const void *) + borrow_named_field_class_from_container_field_class_by_name( + (void *) fc, name, __func__); } -const struct bt_field_class_variant_option * -bt_field_class_variant_borrow_option_by_index_const( +BT_EXPORT +const struct bt_field_class_variant_with_selector_field_integer_unsigned_option * +bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const( const struct bt_field_class *fc, uint64_t index) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-unsigned-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); return (const void *) borrow_named_field_class_from_container_field_class_at_index( - (void *) fc, index); + (void *) fc, index, __func__); } -struct bt_field_class_variant_option * -bt_field_class_variant_borrow_option_by_index( - struct bt_field_class *fc, uint64_t index) +BT_EXPORT +const struct bt_field_class_variant_with_selector_field_integer_signed_option * +bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const( + const struct bt_field_class *fc, const char *name) { - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class"); - return (void *) + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-signed-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); + return (const void *) + borrow_named_field_class_from_container_field_class_by_name( + (void *) fc, name, __func__); +} + +BT_EXPORT +const struct bt_field_class_variant_with_selector_field_integer_signed_option * +bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const( + const struct bt_field_class *fc, uint64_t index) +{ + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "variant-field-class-with-signed-integer-selector-field", + BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, + "Field class"); + return (const void *) borrow_named_field_class_from_container_field_class_at_index( - (void *) fc, index); + (void *) fc, index, __func__); } +BT_EXPORT const char *bt_field_class_variant_option_get_name( const struct bt_field_class_variant_option *option) { const struct bt_named_field_class *named_fc = (const void *) option; - BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option"); + BT_ASSERT_PRE_DEV_VAR_FC_OPT_NON_NULL(option); return named_fc->name->str; } +BT_EXPORT const struct bt_field_class * bt_field_class_variant_option_borrow_field_class_const( const struct bt_field_class_variant_option *option) { const struct bt_named_field_class *named_fc = (const void *) option; - BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option"); + BT_ASSERT_PRE_DEV_VAR_FC_OPT_NON_NULL(option); return named_fc->fc; } +BT_EXPORT struct bt_field_class * bt_field_class_variant_option_borrow_field_class( struct bt_field_class_variant_option *option) { struct bt_named_field_class *named_fc = (void *) option; - BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option"); + BT_ASSERT_PRE_DEV_VAR_FC_OPT_NON_NULL(option); return named_fc->fc; } +BT_EXPORT +const struct bt_integer_range_set_unsigned * +bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const( + const struct bt_field_class_variant_with_selector_field_integer_unsigned_option *option) +{ + const struct bt_field_class_variant_with_selector_field_option *opt = + (const void *) option; + + BT_ASSERT_PRE_DEV_VAR_FC_OPT_NON_NULL(option); + return (const void *) opt->range_set; +} + +BT_EXPORT +const struct bt_integer_range_set_signed * +bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const( + const struct bt_field_class_variant_with_selector_field_integer_signed_option *option) +{ + const struct bt_field_class_variant_with_selector_field_option *opt = + (const void *) option; + + BT_ASSERT_PRE_DEV_VAR_FC_OPT_NON_NULL(option); + return (const void *) opt->range_set; +} + +BT_EXPORT const struct bt_field_path * -bt_field_class_variant_borrow_selector_field_path_const( +bt_field_class_variant_with_selector_field_borrow_selector_field_path_const( const struct bt_field_class *fc) { - const struct bt_field_class_variant *var_fc = (const void *) fc; + const struct bt_field_class_variant_with_selector_field *var_fc = + (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL("field-class", fc, "Field class"); return var_fc->selector_field_path; } static -void init_array_field_class(struct bt_field_class_array *fc, +int init_array_field_class(struct bt_field_class_array *fc, enum bt_field_class_type type, bt_object_release_func release_func, struct bt_field_class *element_fc) { + int ret; + BT_ASSERT(element_fc); - init_field_class((void *) fc, type, release_func); + ret = init_field_class((void *) fc, type, release_func); + if (ret) { + goto end; + } + fc->element_fc = element_fc; - bt_object_get_no_null_check(element_fc); + bt_object_get_ref_no_null_check(fc->element_fc); bt_field_class_freeze(element_fc); + +end: + return ret; } static @@ -1097,6 +2034,7 @@ void finalize_array_field_class(struct bt_field_class_array *array_fc) { BT_ASSERT(array_fc); BT_LOGD_STR("Putting element field class."); + finalize_field_class((void *) array_fc); BT_OBJECT_PUT_REF_AND_RESET(array_fc->element_fc); } @@ -1109,24 +2047,31 @@ void destroy_static_array_field_class(struct bt_object *obj) g_free(obj); } +BT_EXPORT struct bt_field_class * -bt_field_class_static_array_create(bt_trace_class *trace_class, +bt_field_class_array_static_create(bt_trace_class *trace_class, struct bt_field_class *element_fc, uint64_t length) { - struct bt_field_class_static_array *array_fc = NULL; + struct bt_field_class_array_static *array_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); - BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_ASSERT_PRE_NON_NULL("element-field-class", element_fc, + "Element field class"); BT_LOGD_STR("Creating default static array field class object."); - array_fc = g_new0(struct bt_field_class_static_array, 1); + array_fc = g_new0(struct bt_field_class_array_static, 1); if (!array_fc) { BT_LIB_LOGE_APPEND_CAUSE( "Failed to allocate one static array field class."); goto error; } - init_array_field_class((void *) array_fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY, - destroy_static_array_field_class, element_fc); + if (init_array_field_class((void *) array_fc, + BT_FIELD_CLASS_TYPE_STATIC_ARRAY, + destroy_static_array_field_class, element_fc)) { + goto error; + } + array_fc->length = length; BT_LIB_LOGD("Created static array field class object: %!+F", array_fc); goto end; @@ -1138,33 +2083,37 @@ end: return (void *) array_fc; } +BT_EXPORT const struct bt_field_class * bt_field_class_array_borrow_element_field_class_const( const struct bt_field_class *fc) { const struct bt_field_class_array *array_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_ARRAY("field-class", fc, "Field class"); return array_fc->element_fc; } +BT_EXPORT struct bt_field_class * bt_field_class_array_borrow_element_field_class(struct bt_field_class *fc) { struct bt_field_class_array *array_fc = (void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class"); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_DEV_FC_IS_ARRAY("field-class", fc, "Field class"); return array_fc->element_fc; } -uint64_t bt_field_class_static_array_get_length(const struct bt_field_class *fc) +BT_EXPORT +uint64_t bt_field_class_array_static_get_length(const struct bt_field_class *fc) { - const struct bt_field_class_static_array *array_fc = (const void *) fc; + const struct bt_field_class_array_static *array_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY, + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "static-array-field-class", BT_FIELD_CLASS_TYPE_STATIC_ARRAY, "Field class"); return (uint64_t) array_fc->length; } @@ -1172,7 +2121,7 @@ uint64_t bt_field_class_static_array_get_length(const struct bt_field_class *fc) static void destroy_dynamic_array_field_class(struct bt_object *obj) { - struct bt_field_class_dynamic_array *fc = (void *) obj; + struct bt_field_class_array_dynamic *fc = (void *) obj; BT_ASSERT(fc); BT_LIB_LOGD("Destroying dynamic array field class object: %!+F", fc); @@ -1184,25 +2133,42 @@ void destroy_dynamic_array_field_class(struct bt_object *obj) g_free(fc); } -struct bt_field_class *bt_field_class_dynamic_array_create( - bt_trace_class *trace_class, - struct bt_field_class *element_fc) +BT_EXPORT +struct bt_field_class *bt_field_class_array_dynamic_create( + struct bt_trace_class *trace_class, + struct bt_field_class *element_fc, + struct bt_field_class *length_fc) { - struct bt_field_class_dynamic_array *array_fc = NULL; + struct bt_field_class_array_dynamic *array_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); - BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_ASSERT_PRE_NON_NULL("element-field-class", element_fc, + "Element field class"); BT_LOGD_STR("Creating default dynamic array field class object."); - array_fc = g_new0(struct bt_field_class_dynamic_array, 1); + array_fc = g_new0(struct bt_field_class_array_dynamic, 1); if (!array_fc) { BT_LIB_LOGE_APPEND_CAUSE( "Failed to allocate one dynamic array field class."); goto error; } - init_array_field_class((void *) array_fc, - BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, - destroy_dynamic_array_field_class, element_fc); + if (init_array_field_class((void *) array_fc, + length_fc ? + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD : + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD, + destroy_dynamic_array_field_class, element_fc)) { + goto error; + } + + if (length_fc) { + BT_ASSERT_PRE_FC_IS_UNSIGNED_INT("length-field-class", + length_fc, "Length field class"); + array_fc->length_fc = length_fc; + bt_object_get_ref_no_null_check(array_fc->length_fc); + bt_field_class_freeze(length_fc); + } + BT_LIB_LOGD("Created dynamic array field class object: %!+F", array_fc); goto end; @@ -1213,33 +2179,18 @@ end: return (void *) array_fc; } -enum bt_field_class_dynamic_array_set_length_field_class_status -bt_field_class_dynamic_array_set_length_field_class( - struct bt_field_class *fc, - struct bt_field_class *length_fc) -{ - struct bt_field_class_dynamic_array *array_fc = (void *) fc; - - BT_ASSERT_PRE_NON_NULL(fc, "Dynamic array field class"); - BT_ASSERT_PRE_NON_NULL(length_fc, "Length field class"); - BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, - "Field class"); - BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(length_fc, "Length field class"); - BT_ASSERT_PRE_DEV_FC_HOT(fc, "Dynamic array field class"); - array_fc->length_fc = length_fc; - bt_object_get_no_null_check(length_fc); - bt_field_class_freeze(length_fc); - return BT_FUNC_STATUS_OK; -} - +BT_EXPORT const struct bt_field_path * -bt_field_class_dynamic_array_borrow_length_field_path_const( +bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const( const struct bt_field_class *fc) { - const struct bt_field_class_dynamic_array *seq_fc = (const void *) fc; + const struct bt_field_class_array_dynamic *seq_fc = (const void *) fc; - BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class"); - BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + BT_ASSERT_PRE_FC_HAS_TYPE("field-class", fc, + "dynamic-array-field-class-with-length-field", + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD, "Field class"); return seq_fc->length_field_path; } @@ -1249,14 +2200,17 @@ void destroy_string_field_class(struct bt_object *obj) { BT_ASSERT(obj); BT_LIB_LOGD("Destroying string field class object: %!+F", obj); + finalize_field_class((void *) obj); g_free(obj); } +BT_EXPORT struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class) { struct bt_field_class_string *string_fc = NULL; - BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(trace_class); BT_LOGD_STR("Creating default string field class object."); string_fc = g_new0(struct bt_field_class_string, 1); if (!string_fc) { @@ -1265,8 +2219,11 @@ struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class) goto error; } - init_field_class((void *) string_fc, BT_FIELD_CLASS_TYPE_STRING, - destroy_string_field_class); + if (init_field_class((void *) string_fc, BT_FIELD_CLASS_TYPE_STRING, + destroy_string_field_class)) { + goto error; + } + BT_LIB_LOGD("Created string field class object: %!+F", string_fc); goto end; @@ -1277,7 +2234,6 @@ end: return (void *) string_fc; } -BT_HIDDEN void _bt_field_class_freeze(const struct bt_field_class *c_fc) { struct bt_field_class *fc = (void *) c_fc; @@ -1287,85 +2243,185 @@ void _bt_field_class_freeze(const struct bt_field_class *c_fc) * their owner. */ BT_ASSERT(fc); + bt_value_freeze(fc->user_attributes); fc->frozen = true; - switch (fc->type) { - case BT_FIELD_CLASS_TYPE_STRUCTURE: - case BT_FIELD_CLASS_TYPE_VARIANT: - { + if (fc->type == BT_FIELD_CLASS_TYPE_STRUCTURE || + bt_field_class_type_is(fc->type, + BT_FIELD_CLASS_TYPE_VARIANT)) { struct bt_field_class_named_field_class_container *container_fc = (void *) fc; uint64_t i; for (i = 0; i < container_fc->named_fcs->len; i++) { - struct bt_named_field_class *named_fc = - BT_FIELD_CLASS_NAMED_FC_AT_INDEX( - container_fc, i); - - bt_named_field_class_freeze(named_fc); + bt_named_field_class_freeze( + container_fc->named_fcs->pdata[i]); } - - break; - } - default: - break; } } -BT_HIDDEN void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc) { BT_ASSERT(named_fc); + BT_ASSERT(named_fc->fc->frozen); + BT_LIB_LOGD("Freezing named field class's user attributes: %!+v", + named_fc->user_attributes); + bt_value_freeze(named_fc->user_attributes); ((struct bt_named_field_class *) named_fc)->frozen = true; - bt_field_class_freeze(named_fc->fc); } -BT_HIDDEN void bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc) { struct bt_field_class *fc = (void *) c_fc; BT_ASSERT(fc); - BT_ASSERT_PRE(!fc->part_of_trace_class, - "Field class is already part of a trace: %!+F", fc); + BT_ASSERT_PRE("field-class-is-not-part-of-trace-class", + !fc->part_of_trace_class, + "Field class is already part of a trace class: %!+F", fc); fc->part_of_trace_class = true; - switch (fc->type) { - case BT_FIELD_CLASS_TYPE_STRUCTURE: - case BT_FIELD_CLASS_TYPE_VARIANT: - { + if (fc->type == BT_FIELD_CLASS_TYPE_STRUCTURE || + bt_field_class_type_is(fc->type, + BT_FIELD_CLASS_TYPE_VARIANT)) { struct bt_field_class_named_field_class_container *container_fc = (void *) fc; uint64_t i; for (i = 0; i < container_fc->named_fcs->len; i++) { struct bt_named_field_class *named_fc = - BT_FIELD_CLASS_NAMED_FC_AT_INDEX( - container_fc, i); + container_fc->named_fcs->pdata[i]; bt_field_class_make_part_of_trace_class(named_fc->fc); } - - break; - } - case BT_FIELD_CLASS_TYPE_STATIC_ARRAY: - case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY: - { + } else if (bt_field_class_type_is(fc->type, + BT_FIELD_CLASS_TYPE_ARRAY)) { struct bt_field_class_array *array_fc = (void *) fc; bt_field_class_make_part_of_trace_class(array_fc->element_fc); - break; - } - default: - break; } } +BT_EXPORT +const struct bt_value *bt_field_class_borrow_user_attributes_const( + const struct bt_field_class *fc) +{ + BT_ASSERT_PRE_DEV_FC_NON_NULL(fc); + return fc->user_attributes; +} + +BT_EXPORT +struct bt_value *bt_field_class_borrow_user_attributes( + struct bt_field_class *field_class) +{ + return (void *) bt_field_class_borrow_user_attributes_const( + (void *) field_class); +} + + +BT_EXPORT +void bt_field_class_set_user_attributes( + struct bt_field_class *fc, + const struct bt_value *user_attributes) +{ + BT_ASSERT_PRE_FC_NON_NULL(fc); + BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); + BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); + BT_ASSERT_PRE_DEV_FC_HOT(fc); + bt_object_put_ref_no_null_check(fc->user_attributes); + fc->user_attributes = (void *) user_attributes; + bt_object_get_ref_no_null_check(fc->user_attributes); +} + +static +const struct bt_value *bt_named_field_class_borrow_user_attributes_const( + const struct bt_named_field_class *named_fc) +{ + return named_fc->user_attributes; +} + +static +void set_named_field_class_user_attributes( + struct bt_named_field_class *named_fc, + const struct bt_value *user_attributes, const char *api_func) +{ + BT_ASSERT_PRE_USER_ATTRS_NON_NULL_FROM_FUNC(api_func, user_attributes); + BT_ASSERT_PRE_USER_ATTRS_NON_NULL_FROM_FUNC(api_func, user_attributes); + bt_object_put_ref_no_null_check(named_fc->user_attributes); + named_fc->user_attributes = (void *) user_attributes; + bt_object_get_ref_no_null_check(named_fc->user_attributes); +} + +BT_EXPORT +const struct bt_value * +bt_field_class_structure_member_borrow_user_attributes_const( + const struct bt_field_class_structure_member *member) +{ + BT_ASSERT_PRE_STRUCT_FC_MEMBER_NON_NULL(member); + return bt_named_field_class_borrow_user_attributes_const( + (const void *) member); +} + +BT_EXPORT +struct bt_value * +bt_field_class_structure_member_borrow_user_attributes( + struct bt_field_class_structure_member *member) +{ + BT_ASSERT_PRE_STRUCT_FC_MEMBER_NON_NULL(member); + return (void *) bt_named_field_class_borrow_user_attributes_const( + (void *) member); +} + +BT_EXPORT +void bt_field_class_structure_member_set_user_attributes( + struct bt_field_class_structure_member *member, + const struct bt_value *user_attributes) +{ + BT_ASSERT_PRE_STRUCT_FC_MEMBER_NON_NULL(member); + BT_ASSERT_PRE_DEV_HOT("structure-field-class-member", + (struct bt_named_field_class *) member, + "Structure field class member", "."); + set_named_field_class_user_attributes((void *) member, + user_attributes, __func__); +} + +BT_EXPORT +const struct bt_value *bt_field_class_variant_option_borrow_user_attributes_const( + const struct bt_field_class_variant_option *option) +{ + BT_ASSERT_PRE_VAR_FC_OPT_NON_NULL(option); + return bt_named_field_class_borrow_user_attributes_const( + (const void *) option); +} + +BT_EXPORT +struct bt_value *bt_field_class_variant_option_borrow_user_attributes( + struct bt_field_class_variant_option *option) +{ + BT_ASSERT_PRE_VAR_FC_OPT_NON_NULL(option); + return (void *) bt_named_field_class_borrow_user_attributes_const( + (void *) option); +} + +BT_EXPORT +void bt_field_class_variant_option_set_user_attributes( + struct bt_field_class_variant_option *option, + const struct bt_value *user_attributes) +{ + BT_ASSERT_PRE_VAR_FC_OPT_NON_NULL(option); + BT_ASSERT_PRE_DEV_HOT("variant-field-class-option", + (struct bt_named_field_class *) option, + "Variant field class option", "."); + set_named_field_class_user_attributes((void *) option, + user_attributes, __func__); +} + +BT_EXPORT void bt_field_class_get_ref(const struct bt_field_class *field_class) { bt_object_get_ref(field_class); } +BT_EXPORT void bt_field_class_put_ref(const struct bt_field_class *field_class) { bt_object_put_ref(field_class);