X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Ftrace-ir%2Ffield-class.h;h=29c4f72a92921004690eed2004eb412b939e8c93;hb=dbea6be211679c4c88748186f7a8430de377b301;hp=6947c937513eadb37a217896eac22b6d54fb1999;hpb=91d8147391efdc4d42cc4e1c171a65c0372a008f;p=babeltrace.git diff --git a/src/lib/trace-ir/field-class.h b/src/lib/trace-ir/field-class.h index 6947c937..29c4f72a 100644 --- a/src/lib/trace-ir/field-class.h +++ b/src/lib/trace-ir/field-class.h @@ -1,77 +1,24 @@ -#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H -#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H - /* + * 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. */ -#include "lib/assert-pre.h" +#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H +#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H + +#include "lib/assert-cond.h" #include #include #include "common/macros.h" +#include "common/common.h" #include "lib/object.h" #include +#include #include #include -#define BT_ASSERT_PRE_FC_IS_INT(_fc, _name) \ - BT_ASSERT_PRE( \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, \ - _name " is not an integer field class: %![fc-]+F", (_fc)) - -#define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name) \ - BT_ASSERT_PRE( \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, \ - _name " is not an unsigned integer field class: %![fc-]+F", (_fc)) - -#define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name) \ - BT_ASSERT_PRE( \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, \ - _name " is not an enumeration field class: %![fc-]+F", (_fc)) - -#define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name) \ - BT_ASSERT_PRE( \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \ - ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, \ - _name " is not an array field class: %![fc-]+F", (_fc)) - -#define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name) \ - BT_ASSERT_PRE(((const struct bt_field_class *) (_fc))->type == (_type), \ - _name " has the wrong type: expected-type=%s, " \ - "%![fc-]+F", bt_common_field_class_type_string(_type), (_fc)) - -#define BT_ASSERT_PRE_FC_HOT(_fc, _name) \ - BT_ASSERT_PRE_HOT((const struct bt_field_class *) (_fc), \ - (_name), ": %!+F", (_fc)) - -#define BT_FIELD_CLASS_NAMED_FC_AT_INDEX(_fc, _index) \ - (&g_array_index(((struct bt_field_class_named_field_class_container *) (_fc))->named_fcs, \ - struct bt_named_field_class, (_index))) - #define BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(_fc, _index) \ (&g_array_index(((struct bt_field_class_enumeration *) (_fc))->mappings, \ struct bt_field_class_enumeration_mapping, (_index))) @@ -80,21 +27,30 @@ (&g_array_index((_mapping)->ranges, \ struct bt_field_class_enumeration_mapping_range, (_index))) -struct bt_field; -struct bt_field_class; - struct bt_field_class { struct bt_object base; enum bt_field_class_type type; bool frozen; + /* Owned by this */ + struct bt_value *user_attributes; + /* - * Only used in developer mode, this flag indicates whether or - * not this field class is part of a trace class. + * This flag indicates whether or not this field class is part + * of a trace class. */ bool part_of_trace_class; }; +struct bt_field_class_bool { + struct bt_field_class common; +}; + +struct bt_field_class_bit_array { + struct bt_field_class common; + uint64_t length; +}; + struct bt_field_class_integer { struct bt_field_class common; @@ -111,27 +67,15 @@ struct bt_field_class_integer { enum bt_field_class_integer_preferred_display_base base; }; -struct bt_field_class_enumeration_mapping_range { - union { - uint64_t u; - int64_t i; - } lower; - - union { - uint64_t u; - int64_t i; - } upper; -}; - struct bt_field_class_enumeration_mapping { GString *label; - /* Array of `struct bt_field_class_enumeration_mapping_range` */ - GArray *ranges; + /* Owner by this */ + const struct bt_integer_range_set *range_set; }; -struct bt_field_class_unsigned_enumeration_mapping; -struct bt_field_class_signed_enumeration_mapping; +struct bt_field_class_enumeration_unsigned_mapping; +struct bt_field_class_enumeration_signed_mapping; struct bt_field_class_enumeration { struct bt_field_class_integer common; @@ -142,9 +86,9 @@ struct bt_field_class_enumeration { /* * This is an array of `const char *` which acts as a temporary * (potentially growing) buffer for - * bt_field_class_unsigned_enumeration_get_mapping_labels_by_value() + * bt_field_class_enumeration_unsigned_get_mapping_labels_for_value() * and - * bt_field_class_signed_enumeration_get_mapping_labels_by_value(). + * bt_field_class_enumeration_signed_get_mapping_labels_for_value(). * * The actual strings are owned by the mappings above. */ @@ -153,7 +97,6 @@ struct bt_field_class_enumeration { struct bt_field_class_real { struct bt_field_class common; - bool is_single_precision; }; struct bt_field_class_string { @@ -164,6 +107,9 @@ struct bt_field_class_string { struct bt_named_field_class { GString *name; + /* Owned by this */ + struct bt_value *user_attributes; + /* Owned by this */ struct bt_field_class *fc; @@ -172,22 +118,20 @@ struct bt_named_field_class { struct bt_field_class_structure_member; struct bt_field_class_variant_option; +struct bt_field_class_variant_with_selector_field_integer_unsigned_option; +struct bt_field_class_variant_with_selector_field_integer_signed_option; -/* - * This is the base field class for a container of named field classes. - * Structure and variant field classes inherit this. - */ struct bt_field_class_named_field_class_container { struct bt_field_class common; /* * Key: `const char *`, not owned by this (owned by named field - * type objects contained in `named_fcs` below). + * class objects contained in `named_fcs` below). */ GHashTable *name_to_index; - /* Array of `struct bt_named_field_class` */ - GArray *named_fcs; + /* Array of `struct bt_named_field_class *` */ + GPtrArray *named_fcs; }; struct bt_field_class_structure { @@ -201,39 +145,85 @@ struct bt_field_class_array { struct bt_field_class *element_fc; }; -struct bt_field_class_static_array { +struct bt_field_class_array_static { struct bt_field_class_array common; uint64_t length; }; -struct bt_field_class_dynamic_array { +struct bt_field_class_array_dynamic { struct bt_field_class_array common; - /* Weak: never dereferenced, only use to find it elsewhere */ + /* Owned by this */ struct bt_field_class *length_fc; /* Owned by this */ struct bt_field_path *length_field_path; }; -struct bt_field_class_variant { - struct bt_field_class_named_field_class_container common; +struct bt_field_class_option { + struct bt_field_class common; + + /* Owned by this */ + struct bt_field_class *content_fc; +}; + +struct bt_field_class_option_with_selector_field { + struct bt_field_class_option common; - /* Weak: never dereferenced, only use to find it elsewhere */ + /* Owned by this */ struct bt_field_class *selector_fc; /* Owned by this */ struct bt_field_path *selector_field_path; }; -static inline -bool bt_field_class_has_known_type(const struct bt_field_class *fc) -{ - return fc->type >= BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER && - fc->type <= BT_FIELD_CLASS_TYPE_VARIANT; -} +struct bt_field_class_option_with_selector_field_bool { + struct bt_field_class_option_with_selector_field common; + + /* Owned by this */ + bool sel_is_reversed; +}; + +struct bt_field_class_option_with_selector_field_integer { + struct bt_field_class_option_with_selector_field common; + + /* Owned by this */ + const struct bt_integer_range_set *range_set; +}; + +/* Variant FC (with selector) option: named field class + range set */ +struct bt_field_class_variant_with_selector_field_option { + struct bt_named_field_class common; + + /* Owned by this */ + const struct bt_integer_range_set *range_set; +}; + +struct bt_field_class_variant { + /* + * Depending on the variant field class type, the contained + * named field classes are of type + * `struct bt_named_field_class *` if the variant field class + * doesn't have a selector, or + * `struct bt_field_class_variant_with_selector_field_option *` + * if it has. + */ + struct bt_field_class_named_field_class_container common; +}; + +struct bt_field_class_variant_with_selector_field { + struct bt_field_class_variant common; + + /* + * Owned by this, but never dereferenced: only use to find it + * elsewhere. + */ + const struct bt_field_class *selector_fc; + + /* Owned by this */ + struct bt_field_path *selector_field_path; +}; -BT_HIDDEN void _bt_field_class_freeze(const struct bt_field_class *field_class); #ifdef BT_DEV_MODE @@ -242,7 +232,6 @@ void _bt_field_class_freeze(const struct bt_field_class *field_class); # define bt_field_class_freeze(_fc) ((void) _fc) #endif -BT_HIDDEN void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc); #ifdef BT_DEV_MODE @@ -257,14 +246,7 @@ void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc); * are used at a single location within trace objects even if they are * shared objects for other purposes. */ -BT_HIDDEN -void _bt_field_class_make_part_of_trace_class( +void bt_field_class_make_part_of_trace_class( const struct bt_field_class *field_class); -#ifdef BT_DEV_MODE -# define bt_field_class_make_part_of_trace_class _bt_field_class_make_part_of_trace_class -#else -# define bt_field_class_make_part_of_trace_class(_fc) ((void) _fc) -#endif - #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H */