[babeltrace.git] / src / lib / trace-ir / field-class.h

#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include "lib/assert-pre.h"
#include <babeltrace2/trace-ir/clock-class.h>
#include <babeltrace2/trace-ir/field-class.h>
#include "common/macros.h"
#include "common/common.h"
#include "lib/object.h"
#include <babeltrace2/types.h>
#include <stdint.h>
#include <glib.h>

#define _BT_ASSERT_PRE_FC_IS_INT_COND(_fc)				\
	(((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)

#define _BT_ASSERT_PRE_FC_IS_INT_FMT(_name)				\
	_name " is not an integer field class: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc)			\
	(((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)

#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name)			\
	_name " is not an unsigned integer field class: %![fc-]+F"


#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc)			\
	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)

#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name)			\
	_name " is not a signed integer field class: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc)				\
	(((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)

#define _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name)				\
	_name " is not an enumeration field class: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc)				\
	(((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)

#define _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name)				\
	_name " is not an array field class: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc)				\
	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \
	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)

#define _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name)				\
	_name " is not a variant field class: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc)			\
	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)

#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name)		\
	_name " is not a variant field class with a selector: %![fc-]+F"

#define _BT_ASSERT_PRE_FC_HAS_ID_COND(_fc, _type)			\
	(((const struct bt_field_class *) (_fc))->type == (_type))

#define _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name)				\
	_name " has the wrong type: expected-type=%s, %![fc-]+F"

#define BT_ASSERT_PRE_FC_IS_INT(_fc, _name)				\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name)			\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_SIGNED_INT(_fc, _name)			\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name)				\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name)				\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_VARIANT(_fc, _name)				\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL(_fc, _name)		\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))

#define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name)			\
	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)),	\
		_BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),			\
		bt_common_field_class_type_string(_type), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_INT(_fc, _name)				\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_UNSIGNED_INT(_fc, _name)		\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_SIGNED_INT(_fc, _name)			\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_ENUM(_fc, _name)			\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_ARRAY(_fc, _name)			\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),		\
		_BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT(_fc, _name)			\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),	\
		_BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(_fc, _name)		\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
		_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))

#define BT_ASSERT_PRE_DEV_FC_HAS_ID(_fc, _type, _name)			\
	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
		_BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),			\
		bt_common_field_class_type_string(_type), (_fc))

#define BT_ASSERT_PRE_DEV_FC_HOT(_fc, _name)				\
	BT_ASSERT_PRE_DEV_HOT((const struct bt_field_class *) (_fc),	\
		(_name), ": %!+F", (_fc))

#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)))

#define BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(_mapping, _index)	\
	(&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;

	/*
	 * 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;

	/*
	 * Value range of fields built from this integer field class:
	 * this is an equivalent integer size in bits. More formally,
	 * `range` is `n` in:
	 *
	 * Unsigned range: [0, 2^n - 1]
	 * Signed range: [-2^(n - 1), 2^(n - 1) - 1]
	 */
	uint64_t range;

	enum bt_field_class_integer_preferred_display_base base;
};

struct bt_field_class_enumeration_mapping {
	GString *label;

	/* Owner by this */
	const struct bt_integer_range_set *range_set;
};

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;

	/* Array of `struct bt_field_class_enumeration_mapping *` */
	GArray *mappings;

	/*
	 * This is an array of `const char *` which acts as a temporary
	 * (potentially growing) buffer for
	 * bt_field_class_enumeration_unsigned_get_mapping_labels_for_value()
	 * and
	 * bt_field_class_enumeration_signed_get_mapping_labels_for_value().
	 *
	 * The actual strings are owned by the mappings above.
	 */
	GPtrArray *label_buf;
};

struct bt_field_class_real {
	struct bt_field_class common;
	bool is_single_precision;
};

struct bt_field_class_string {
	struct bt_field_class common;
};

/* A named field class is a (name, field class) pair */
struct bt_named_field_class {
	GString *name;

	/* Owned by this */
	struct bt_field_class *fc;

	bool frozen;
};

struct bt_field_class_structure_member;
struct bt_field_class_variant_option;
struct bt_field_class_variant_with_selector_unsigned_option;
struct bt_field_class_variant_with_selector_signed_option;

struct bt_field_class_named_field_class_container {
	struct bt_field_class common;

	/*
	 * Key: `const char *`, not owned by this (owned by named field
	 * class objects contained in `named_fcs` below).
	 */
	GHashTable *name_to_index;

	/* Array of `struct bt_named_field_class *` */
	GPtrArray *named_fcs;
};

struct bt_field_class_structure {
	struct bt_field_class_named_field_class_container common;
};

struct bt_field_class_array {
	struct bt_field_class common;

	/* Owned by this */
	struct bt_field_class *element_fc;
};

struct bt_field_class_array_static {
	struct bt_field_class_array common;
	uint64_t length;
};

struct bt_field_class_array_dynamic {
	struct bt_field_class_array common;

	/* Owned by this */
	struct bt_field_class *length_fc;

	/* Owned by this */
	struct bt_field_path *length_field_path;
};

struct bt_field_class_option {
	struct bt_field_class common;

	/* Owned by this */
	struct bt_field_class *content_fc;

	/* Owned by this */
	struct bt_field_class *selector_fc;

	/* Owned by this */
	struct bt_field_path *selector_field_path;
};

/* Variant FC (with selector) option: named field class + range set */
struct bt_field_class_variant_with_selector_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_option *`
	 * if it has.
	 */
	struct bt_field_class_named_field_class_container common;
};

struct bt_field_class_variant_with_selector {
	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
# define bt_field_class_freeze		_bt_field_class_freeze
#else
# 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
# define bt_named_field_class_freeze		_bt_named_field_class_freeze
#else
# define bt_named_field_class_freeze(_named_fc)	((void) _named_fc)
#endif

/*
 * This function recursively marks `field_class` and its children as
 * being part of a trace. This is used to validate that all field classes
 * 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(
		const struct bt_field_class *field_class);

#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H */
Commit	Line	Data
5cd6d0e5 PP	1	#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
	2	#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
	3
	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5cd6d0e5 PP	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5cd6d0e5 PP	7	*
5cd6d0e5 PP	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
578e048b	27	#include "lib/assert-pre.h"
3fadfbc0 MJ	28	#include <babeltrace2/trace-ir/clock-class.h>
3fadfbc0 MJ	29	#include <babeltrace2/trace-ir/field-class.h>
91d81473	30	#include "common/macros.h"
45c51519	31	#include "common/common.h"
578e048b	32	#include "lib/object.h"
3fadfbc0	33	#include <babeltrace2/types.h>
5cd6d0e5 PP	34	#include <stdint.h>
	35	#include <glib.h>
	36
bdb288b3 PP	37	#define _BT_ASSERT_PRE_FC_IS_INT_COND(_fc) \
	38	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER \|\| \
	39	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER \|\| \
	40	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION \|\| \
	41	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
	42
	43	#define _BT_ASSERT_PRE_FC_IS_INT_FMT(_name) \
	44	_name " is not an integer field class: %![fc-]+F"
	45
	46	#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc) \
	47	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER \|\| \
	48	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION)
	49
	50	#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name) \
	51	_name " is not an unsigned integer field class: %![fc-]+F"
	52
45c51519 PP	53
	54	#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc) \
	55	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER \|\| \
	56	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
	57
	58	#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name) \
	59	_name " is not a signed integer field class: %![fc-]+F"
	60
bdb288b3 PP	61	#define _BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc) \
	62	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION \|\| \
	63	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
	64
	65	#define _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name) \
	66	_name " is not an enumeration field class: %![fc-]+F"
	67
	68	#define _BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc) \
	69	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY \|\| \
	70	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)
	71
	72	#define _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name) \
	73	_name " is not an array field class: %![fc-]+F"
	74
45c51519 PP	75	#define _BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc) \
	76	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR \|\| \
	77	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR \|\| \
	78	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
	79
	80	#define _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name) \
	81	_name " is not a variant field class: %![fc-]+F"
	82
	83	#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc) \
	84	(((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR \|\| \
	85	((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
	86
	87	#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name) \
	88	_name " is not a variant field class with a selector: %![fc-]+F"
	89
bdb288b3 PP	90	#define _BT_ASSERT_PRE_FC_HAS_ID_COND(_fc, _type) \
	91	(((const struct bt_field_class *) (_fc))->type == (_type))
	92
	93	#define _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name) \
	94	_name " has the wrong type: expected-type=%s, %![fc-]+F"
	95
5cd6d0e5	96	#define BT_ASSERT_PRE_FC_IS_INT(_fc, _name) \
bdb288b3	97	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc), \
45c51519	98	_BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
5cd6d0e5 PP	99
5cd6d0e5 PP	100	#define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name) \
bdb288b3	101	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc), \
45c51519 PP	102	_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
	103
	104	#define BT_ASSERT_PRE_FC_IS_SIGNED_INT(_fc, _name) \
	105	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc), \
	106	_BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
5cd6d0e5 PP	107
5cd6d0e5 PP	108	#define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name) \
bdb288b3	109	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc), \
45c51519	110	_BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
5cd6d0e5 PP	111
5cd6d0e5 PP	112	#define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name) \
bdb288b3	113	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc), \
45c51519 PP	114	_BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
	115
	116	#define BT_ASSERT_PRE_FC_IS_VARIANT(_fc, _name) \
	117	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc), \
	118	_BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
	119
	120	#define BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL(_fc, _name) \
	121	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
	122	_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
5cd6d0e5	123
864cad70	124	#define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name) \
bdb288b3	125	BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
45c51519 PP	126	_BT_ASSERT_PRE_FC_HAS_ID_FMT(_name), \
45c51519 PP	127	bt_common_field_class_type_string(_type), (_fc))
5cd6d0e5	128
bdb288b3 PP	129	#define BT_ASSERT_PRE_DEV_FC_IS_INT(_fc, _name) \
bdb288b3 PP	130	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc), \
45c51519	131	_BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
bdb288b3 PP	132
	133	#define BT_ASSERT_PRE_DEV_FC_IS_UNSIGNED_INT(_fc, _name) \
	134	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc), \
45c51519 PP	135	_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
	136
	137	#define BT_ASSERT_PRE_DEV_FC_IS_SIGNED_INT(_fc, _name) \
	138	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc), \
	139	_BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
bdb288b3 PP	140
	141	#define BT_ASSERT_PRE_DEV_FC_IS_ENUM(_fc, _name) \
	142	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc), \
45c51519	143	_BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
bdb288b3 PP	144
	145	#define BT_ASSERT_PRE_DEV_FC_IS_ARRAY(_fc, _name) \
	146	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc), \
45c51519 PP	147	_BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
	148
	149	#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT(_fc, _name) \
	150	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc), \
	151	_BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
	152
	153	#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(_fc, _name) \
	154	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
	155	_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
bdb288b3 PP	156
	157	#define BT_ASSERT_PRE_DEV_FC_HAS_ID(_fc, _type, _name) \
	158	BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
45c51519 PP	159	_BT_ASSERT_PRE_FC_HAS_ID_FMT(_name), \
45c51519 PP	160	bt_common_field_class_type_string(_type), (_fc))
bdb288b3 PP	161
	162	#define BT_ASSERT_PRE_DEV_FC_HOT(_fc, _name) \
	163	BT_ASSERT_PRE_DEV_HOT((const struct bt_field_class *) (_fc), \
5cd6d0e5 PP	164	(_name), ": %!+F", (_fc))
5cd6d0e5 PP	165
5cd6d0e5 PP	166	#define BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(_fc, _index) \
	167	(&g_array_index(((struct bt_field_class_enumeration *) (_fc))->mappings, \
	168	struct bt_field_class_enumeration_mapping, (_index)))
	169
	170	#define BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(_mapping, _index) \
	171	(&g_array_index((_mapping)->ranges, \
	172	struct bt_field_class_enumeration_mapping_range, (_index)))
	173
	174	struct bt_field;
	175	struct bt_field_class;
	176
	177	struct bt_field_class {
	178	struct bt_object base;
864cad70	179	enum bt_field_class_type type;
5cd6d0e5 PP	180	bool frozen;
	181
	182	/*
bdb288b3 PP	183	* This flag indicates whether or not this field class is part
bdb288b3 PP	184	* of a trace class.
5cd6d0e5	185	*/
862ca4ed	186	bool part_of_trace_class;
5cd6d0e5 PP	187	};
5cd6d0e5 PP	188
5cebbe7f PP	189	struct bt_field_class_bool {
	190	struct bt_field_class common;
	191	};
	192
1094efa4 PP	193	struct bt_field_class_bit_array {
	194	struct bt_field_class common;
	195	uint64_t length;
	196	};
	197
5cd6d0e5 PP	198	struct bt_field_class_integer {
	199	struct bt_field_class common;
	200
	201	/*
	202	* Value range of fields built from this integer field class:
	203	* this is an equivalent integer size in bits. More formally,
	204	* `range` is `n` in:
	205	*
	206	* Unsigned range: [0, 2^n - 1]
	207	* Signed range: [-2^(n - 1), 2^(n - 1) - 1]
	208	*/
	209	uint64_t range;
	210
	211	enum bt_field_class_integer_preferred_display_base base;
	212	};
	213
5cd6d0e5 PP	214	struct bt_field_class_enumeration_mapping {
	215	GString *label;
	216
45c51519 PP	217	/* Owner by this */
45c51519 PP	218	const struct bt_integer_range_set *range_set;
5cd6d0e5 PP	219	};
5cd6d0e5 PP	220
9c08c816 PP	221	struct bt_field_class_enumeration_unsigned_mapping;
9c08c816 PP	222	struct bt_field_class_enumeration_signed_mapping;
8f3ccfbc	223
5cd6d0e5 PP	224	struct bt_field_class_enumeration {
	225	struct bt_field_class_integer common;
	226
	227	/* Array of `struct bt_field_class_enumeration_mapping ` /
	228	GArray *mappings;
	229
	230	/*
	231	* This is an array of `const char *` which acts as a temporary
	232	* (potentially growing) buffer for
9c08c816	233	* bt_field_class_enumeration_unsigned_get_mapping_labels_for_value()
5cd6d0e5	234	* and
9c08c816	235	* bt_field_class_enumeration_signed_get_mapping_labels_for_value().
5cd6d0e5 PP	236	*
	237	* The actual strings are owned by the mappings above.
	238	*/
	239	GPtrArray *label_buf;
	240	};
	241
	242	struct bt_field_class_real {
	243	struct bt_field_class common;
	244	bool is_single_precision;
	245	};
	246
	247	struct bt_field_class_string {
	248	struct bt_field_class common;
	249	};
	250
	251	/* A named field class is a (name, field class) pair */
	252	struct bt_named_field_class {
	253	GString *name;
	254
	255	/* Owned by this */
	256	struct bt_field_class *fc;
1e6fd1d7 PP	257
1e6fd1d7 PP	258	bool frozen;
5cd6d0e5 PP	259	};
5cd6d0e5 PP	260
1e6fd1d7 PP	261	struct bt_field_class_structure_member;
1e6fd1d7 PP	262	struct bt_field_class_variant_option;
9c08c816 PP	263	struct bt_field_class_variant_with_selector_unsigned_option;
9c08c816 PP	264	struct bt_field_class_variant_with_selector_signed_option;
1e6fd1d7	265
5cd6d0e5 PP	266	struct bt_field_class_named_field_class_container {
	267	struct bt_field_class common;
	268
	269	/*
	270	* Key: `const char *`, not owned by this (owned by named field
45c51519	271	* class objects contained in `named_fcs` below).
5cd6d0e5 PP	272	*/
	273	GHashTable *name_to_index;
	274
45c51519 PP	275	/* Array of `struct bt_named_field_class ` /
45c51519 PP	276	GPtrArray *named_fcs;
5cd6d0e5 PP	277	};
	278
	279	struct bt_field_class_structure {
	280	struct bt_field_class_named_field_class_container common;
	281	};
	282
	283	struct bt_field_class_array {
	284	struct bt_field_class common;
	285
	286	/* Owned by this */
	287	struct bt_field_class *element_fc;
	288	};
	289
9c08c816	290	struct bt_field_class_array_static {
5cd6d0e5 PP	291	struct bt_field_class_array common;
	292	uint64_t length;
	293	};
	294
9c08c816	295	struct bt_field_class_array_dynamic {
5cd6d0e5 PP	296	struct bt_field_class_array common;
5cd6d0e5 PP	297
b38aea74	298	/* Owned by this */
5cd6d0e5 PP	299	struct bt_field_class *length_fc;
	300
	301	/* Owned by this */
	302	struct bt_field_path *length_field_path;
	303	};
	304
b38aea74 PP	305	struct bt_field_class_option {
	306	struct bt_field_class common;
	307
	308	/* Owned by this */
	309	struct bt_field_class *content_fc;
	310
	311	/* Owned by this */
	312	struct bt_field_class *selector_fc;
	313
	314	/* Owned by this */
	315	struct bt_field_path *selector_field_path;
	316	};
	317
45c51519 PP	318	/* Variant FC (with selector) option: named field class + range set */
	319	struct bt_field_class_variant_with_selector_option {
	320	struct bt_named_field_class common;
	321
	322	/* Owned by this */
	323	const struct bt_integer_range_set *range_set;
	324	};
	325
5cd6d0e5	326	struct bt_field_class_variant {
45c51519 PP	327	/*
	328	* Depending on the variant field class type, the contained
	329	* named field classes are of type
	330	* `struct bt_named_field_class *` if the variant field class
	331	* doesn't have a selector, or
	332	* `struct bt_field_class_variant_with_selector_option *`
	333	* if it has.
	334	*/
5cd6d0e5	335	struct bt_field_class_named_field_class_container common;
45c51519	336	};
5cd6d0e5	337
45c51519 PP	338	struct bt_field_class_variant_with_selector {
	339	struct bt_field_class_variant common;
	340
	341	/*
	342	* Owned by this, but never dereferenced: only use to find it
	343	* elsewhere.
	344	*/
	345	const struct bt_field_class *selector_fc;
5cd6d0e5 PP	346
	347	/* Owned by this */
	348	struct bt_field_path *selector_field_path;
	349	};
	350
5cd6d0e5	351	BT_HIDDEN
40f4ba76	352	void _bt_field_class_freeze(const struct bt_field_class *field_class);
5cd6d0e5 PP	353
	354	#ifdef BT_DEV_MODE
	355	# define bt_field_class_freeze _bt_field_class_freeze
	356	#else
1d7f91d1	357	# define bt_field_class_freeze(_fc) ((void) _fc)
5cd6d0e5 PP	358	#endif
5cd6d0e5 PP	359
1e6fd1d7 PP	360	BT_HIDDEN
	361	void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc);
	362
	363	#ifdef BT_DEV_MODE
	364	# define bt_named_field_class_freeze _bt_named_field_class_freeze
	365	#else
1d7f91d1	366	# define bt_named_field_class_freeze(_named_fc) ((void) _named_fc)
1e6fd1d7 PP	367	#endif
1e6fd1d7 PP	368
5cd6d0e5 PP	369	/*
	370	* This function recursively marks `field_class` and its children as
	371	* being part of a trace. This is used to validate that all field classes
	372	* are used at a single location within trace objects even if they are
	373	* shared objects for other purposes.
	374	*/
	375	BT_HIDDEN
bdb288b3	376	void bt_field_class_make_part_of_trace_class(
862ca4ed	377	const struct bt_field_class *field_class);
5cd6d0e5	378
5cd6d0e5	379	#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H */