[babeltrace.git] / lib / trace-ir / resolve-field-path.c

/*
 * Copyright 2018 Philippe Proulx <pproulx@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.
 */

#define BT_LOG_TAG "RESOLVE-FIELD-PATH"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/trace-ir/field-class-internal.h>
#include <babeltrace/trace-ir/field-path-internal.h>
#include <babeltrace/trace-ir/field-path-const.h>
#include <babeltrace/trace-ir/resolve-field-path-internal.h>
#include <limits.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>

static
bool find_field_class_recursive(struct bt_field_class *fc,
		struct bt_field_class *tgt_fc, struct bt_field_path *field_path)
{
	bool found = false;

	if (tgt_fc == fc) {
		found = true;
		goto end;
	}

	switch (fc->type) {
	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	case 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);

			g_array_append_val(field_path->indexes, i);
			found = find_field_class_recursive(named_fc->fc,
				tgt_fc, field_path);
			if (found) {
				goto end;
			}

			g_array_set_size(field_path->indexes,
				field_path->indexes->len - 1);
		}

		break;
	}
	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
	{
		struct bt_field_class_array *array_fc = (void *) fc;

		found = find_field_class_recursive(array_fc->element_fc,
			tgt_fc, field_path);
		break;
	}
	default:
		break;
	}

end:
	return found;
}

static
int find_field_class(struct bt_field_class *root_fc,
		enum bt_scope root_scope, struct bt_field_class *tgt_fc,
		struct bt_field_path **ret_field_path)
{
	int ret = 0;
	struct bt_field_path *field_path = NULL;

	if (!root_fc) {
		goto end;
	}

	field_path = bt_field_path_create();
	if (!field_path) {
		ret = -1;
		goto end;
	}

	field_path->root = root_scope;
	if (!find_field_class_recursive(root_fc, tgt_fc, field_path)) {
		/* Not found here */
		BT_OBJECT_PUT_REF_AND_RESET(field_path);
	}

end:
	*ret_field_path = field_path;
	return ret;
}

static
struct bt_field_path *find_field_class_in_ctx(struct bt_field_class *fc,
		struct bt_resolve_field_path_context *ctx)
{
	struct bt_field_path *field_path = NULL;
	int ret;

	ret = find_field_class(ctx->packet_context, BT_SCOPE_PACKET_CONTEXT,
		fc, &field_path);
	if (ret || field_path) {
		goto end;
	}

	ret = find_field_class(ctx->event_common_context,
		BT_SCOPE_EVENT_COMMON_CONTEXT, fc, &field_path);
	if (ret || field_path) {
		goto end;
	}

	ret = find_field_class(ctx->event_specific_context,
		BT_SCOPE_EVENT_SPECIFIC_CONTEXT, fc, &field_path);
	if (ret || field_path) {
		goto end;
	}

	ret = find_field_class(ctx->event_payload, BT_SCOPE_EVENT_PAYLOAD,
		fc, &field_path);
	if (ret || field_path) {
		goto end;
	}

end:
	return field_path;
}

BT_ASSERT_PRE_FUNC
static inline
bool target_is_before_source(struct bt_field_path *src_field_path,
		struct bt_field_path *tgt_field_path)
{
	bool is_valid = true;
	uint64_t src_i = 0, tgt_i = 0;

	if (tgt_field_path->root < src_field_path->root) {
		goto end;
	}

	if (tgt_field_path->root > src_field_path->root) {
		is_valid = false;
		goto end;
	}

	BT_ASSERT(tgt_field_path->root == src_field_path->root);

	while (src_i < src_field_path->indexes->len &&
			tgt_i < tgt_field_path->indexes->len) {
		uint64_t src_index = bt_field_path_get_index_by_index_inline(
			src_field_path, src_i);
		uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
			tgt_field_path, tgt_i);

		if (tgt_index > src_index) {
			is_valid = false;
			goto end;
		}

		src_i++;
		tgt_i++;
	}

end:
	return is_valid;
}

BT_ASSERT_PRE_FUNC
static inline
struct bt_field_class *borrow_root_field_class(
		struct bt_resolve_field_path_context *ctx, enum bt_scope scope)
{
	switch (scope) {
	case BT_SCOPE_PACKET_CONTEXT:
		return ctx->packet_context;
	case BT_SCOPE_EVENT_COMMON_CONTEXT:
		return ctx->event_common_context;
	case BT_SCOPE_EVENT_SPECIFIC_CONTEXT:
		return ctx->event_specific_context;
	case BT_SCOPE_EVENT_PAYLOAD:
		return ctx->event_payload;
	default:
		abort();
	}

	return NULL;
}

BT_ASSERT_PRE_FUNC
static inline
struct bt_field_class *borrow_child_field_class(struct bt_field_class *parent_fc,
		uint64_t index, bool *advance)
{
	struct bt_field_class *child_fc = NULL;

	switch (parent_fc->type) {
	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	case BT_FIELD_CLASS_TYPE_VARIANT:
	{
		struct bt_named_field_class *named_fc =
			BT_FIELD_CLASS_NAMED_FC_AT_INDEX(parent_fc, index);

		child_fc = named_fc->fc;
		*advance = true;
		break;
	}
	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
	{
		struct bt_field_class_array *array_fc = (void *) parent_fc;

		child_fc = array_fc->element_fc;
		*advance = false;
		break;
	}
	default:
		break;
	}

	return child_fc;
}

BT_ASSERT_PRE_FUNC
static inline
bool target_field_path_in_different_scope_has_struct_fc_only(
		struct bt_field_path *src_field_path,
		struct bt_field_path *tgt_field_path,
		struct bt_resolve_field_path_context *ctx)
{
	bool is_valid = true;
	uint64_t i = 0;
	struct bt_field_class *fc;

	if (src_field_path->root == tgt_field_path->root) {
		goto end;
	}

	fc = borrow_root_field_class(ctx, tgt_field_path->root);

	while (i < tgt_field_path->indexes->len) {
		uint64_t index = bt_field_path_get_index_by_index_inline(
			tgt_field_path, i);
		bool advance;

		if (fc->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY ||
				fc->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY ||
				fc->type == BT_FIELD_CLASS_TYPE_VARIANT) {
			is_valid = false;
			goto end;
		}

		fc = borrow_child_field_class(fc, index, &advance);

		if (advance) {
			i++;
		}
	}

end:
	return is_valid;
}

BT_ASSERT_PRE_FUNC
static inline
bool lca_is_structure_field_class(struct bt_field_path *src_field_path,
		struct bt_field_path *tgt_field_path,
		struct bt_resolve_field_path_context *ctx)
{
	bool is_valid = true;
	struct bt_field_class *src_fc;
	struct bt_field_class *tgt_fc;
	struct bt_field_class *prev_fc = NULL;
	uint64_t src_i = 0, tgt_i = 0;

	if (src_field_path->root != tgt_field_path->root) {
		goto end;
	}

	src_fc = borrow_root_field_class(ctx, src_field_path->root);
	tgt_fc = borrow_root_field_class(ctx, tgt_field_path->root);
	BT_ASSERT(src_fc);
	BT_ASSERT(tgt_fc);

	while (src_i < src_field_path->indexes->len &&
			tgt_i < tgt_field_path->indexes->len) {
		bool advance;
		uint64_t src_index = bt_field_path_get_index_by_index_inline(
			src_field_path, src_i);
		uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
			tgt_field_path, tgt_i);

		if (src_fc != tgt_fc) {
			if (!prev_fc) {
				/*
				 * This is correct: the LCA is the root
				 * scope field class, which must be a
				 * structure field class.
				 */
				break;
			}

			if (prev_fc->type != BT_FIELD_CLASS_TYPE_STRUCTURE) {
				is_valid = false;
			}

			break;
		}

		prev_fc = src_fc;
		src_fc = borrow_child_field_class(src_fc, src_index, &advance);

		if (advance) {
			src_i++;
		}

		tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);

		if (advance) {
			tgt_i++;
		}
	}

end:
	return is_valid;
}

BT_ASSERT_PRE_FUNC
static inline
bool lca_to_target_has_struct_fc_only(struct bt_field_path *src_field_path,
		struct bt_field_path *tgt_field_path,
		struct bt_resolve_field_path_context *ctx)
{
	bool is_valid = true;
	struct bt_field_class *src_fc;
	struct bt_field_class *tgt_fc;
	uint64_t src_i = 0, tgt_i = 0;

	if (src_field_path->root != tgt_field_path->root) {
		goto end;
	}

	src_fc = borrow_root_field_class(ctx, src_field_path->root);
	tgt_fc = borrow_root_field_class(ctx, tgt_field_path->root);
	BT_ASSERT(src_fc);
	BT_ASSERT(tgt_fc);
	BT_ASSERT(src_fc == tgt_fc);

	/* Find LCA */
	while (src_i < src_field_path->indexes->len &&
			tgt_i < tgt_field_path->indexes->len) {
		bool advance;
		uint64_t src_index = bt_field_path_get_index_by_index_inline(
			src_field_path, src_i);
		uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
			tgt_field_path, tgt_i);

		if (src_i != tgt_i) {
			/* Next field class is different: LCA is `tgt_fc` */
			break;
		}

		src_fc = borrow_child_field_class(src_fc, src_index, &advance);

		if (advance) {
			src_i++;
		}

		tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);

		if (advance) {
			tgt_i++;
		}
	}

	/* Only structure field classes to the target */
	while (tgt_i < tgt_field_path->indexes->len) {
		bool advance;
		uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
			tgt_field_path, tgt_i);

		if (tgt_fc->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY ||
				tgt_fc->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY ||
				tgt_fc->type == BT_FIELD_CLASS_TYPE_VARIANT) {
			is_valid = false;
			goto end;
		}

		tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);

		if (advance) {
			tgt_i++;
		}
	}

end:
	return is_valid;
}

BT_ASSERT_PRE_FUNC
static inline
bool field_path_is_valid(struct bt_field_class *src_fc,
		struct bt_field_class *tgt_fc,
		struct bt_resolve_field_path_context *ctx)
{
	bool is_valid = true;
	struct bt_field_path *src_field_path = find_field_class_in_ctx(
		src_fc, ctx);
	struct bt_field_path *tgt_field_path = find_field_class_in_ctx(
		tgt_fc, ctx);

	if (!src_field_path) {
		BT_ASSERT_PRE_MSG("Cannot find requesting field class in "
			"resolving context: %!+F", src_fc);
		is_valid = false;
		goto end;
	}

	if (!tgt_field_path) {
		BT_ASSERT_PRE_MSG("Cannot find target field class in "
			"resolving context: %!+F", tgt_fc);
		is_valid = false;
		goto end;
	}

	/* Target must be before source */
	if (!target_is_before_source(src_field_path, tgt_field_path)) {
		BT_ASSERT_PRE_MSG("Target field class is located after "
			"requesting field class: %![req-fc-]+F, %![tgt-fc-]+F",
			src_fc, tgt_fc);
		is_valid = false;
		goto end;
	}

	/*
	 * If target is in a different scope than source, there are no
	 * array or variant field classes on the way to the target.
	 */
	if (!target_field_path_in_different_scope_has_struct_fc_only(
			src_field_path, tgt_field_path, ctx)) {
		BT_ASSERT_PRE_MSG("Target field class is located in a "
			"different scope than requesting field class, "
			"but within an array or a variant field class: "
			"%![req-fc-]+F, %![tgt-fc-]+F",
			src_fc, tgt_fc);
		is_valid = false;
		goto end;
	}

	/* Same scope: LCA must be a structure field class */
	if (!lca_is_structure_field_class(src_field_path, tgt_field_path, ctx)) {
		BT_ASSERT_PRE_MSG("Lowest common ancestor of target and "
			"requesting field classes is not a structure field class: "
			"%![req-fc-]+F, %![tgt-fc-]+F",
			src_fc, tgt_fc);
		is_valid = false;
		goto end;
	}

	/* Same scope: path from LCA to target has no array/variant FTs */
	if (!lca_to_target_has_struct_fc_only(src_field_path, tgt_field_path,
			ctx)) {
		BT_ASSERT_PRE_MSG("Path from lowest common ancestor of target "
			"and requesting field classes to target field class "
			"contains an array or a variant field class: "
			"%![req-fc-]+F, %![tgt-fc-]+F", src_fc, tgt_fc);
		is_valid = false;
		goto end;
	}

end:
	bt_object_put_ref(src_field_path);
	bt_object_put_ref(tgt_field_path);
	return is_valid;
}

static
struct bt_field_path *resolve_field_path(struct bt_field_class *src_fc,
		struct bt_field_class *tgt_fc,
		struct bt_resolve_field_path_context *ctx)
{
	BT_ASSERT_PRE(field_path_is_valid(src_fc, tgt_fc, ctx),
		"Invalid target field class: %![req-fc-]+F, %![tgt-fc-]+F",
		src_fc, tgt_fc);
	return find_field_class_in_ctx(tgt_fc, ctx);
}

BT_HIDDEN
int bt_resolve_field_paths(struct bt_field_class *fc,
		struct bt_resolve_field_path_context *ctx)
{
	int ret = 0;

	BT_ASSERT(fc);

	/* Resolving part for dynamic array and variant field classes */
	switch (fc->type) {
	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
	{
		struct bt_field_class_dynamic_array *dyn_array_fc = (void *) fc;

		if (dyn_array_fc->length_fc) {
			BT_ASSERT(!dyn_array_fc->length_field_path);
			dyn_array_fc->length_field_path = resolve_field_path(
				fc, dyn_array_fc->length_fc, ctx);
			if (!dyn_array_fc->length_field_path) {
				ret = -1;
				goto end;
			}
		}

		break;
	}
	case BT_FIELD_CLASS_TYPE_VARIANT:
	{
		struct bt_field_class_variant *var_fc = (void *) fc;

		if (var_fc->selector_fc) {
			BT_ASSERT(!var_fc->selector_field_path);
			var_fc->selector_field_path =
				resolve_field_path(fc,
					var_fc->selector_fc, ctx);
			if (!var_fc->selector_field_path) {
				ret = -1;
				goto end;
			}
		}
	}
	default:
		break;
	}

	/* Recursive part */
	switch (fc->type) {
	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	case 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);

			ret = bt_resolve_field_paths(named_fc->fc, ctx);
			if (ret) {
				goto end;
			}
		}

		break;
	}
	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
	{
		struct bt_field_class_array *array_fc = (void *) fc;

		ret = bt_resolve_field_paths(array_fc->element_fc, ctx);
		break;
	}
	default:
		break;
	}

end:
	return ret;
}
Commit	Line	Data
7b33a0e0 PP	1	/*
	2	* Copyright 2018 Philippe Proulx <pproulx@efficios.com>
	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a copy
	5	* of this software and associated documentation files (the "Software"), to deal
	6	* in the Software without restriction, including without limitation the rights
	7	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	8	* copies of the Software, and to permit persons to whom the Software is
	9	* furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	17	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	18	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	19	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	20	* SOFTWARE.
	21	*/
	22
	23	#define BT_LOG_TAG "RESOLVE-FIELD-PATH"
	24	#include <babeltrace/lib-logging-internal.h>
	25
	26	#include <babeltrace/assert-pre-internal.h>
	27	#include <babeltrace/assert-internal.h>
0f15f666	28	#include <babeltrace/trace-ir/field-class-internal.h>
108b91d0	29	#include <babeltrace/trace-ir/field-path-internal.h>
78cf9df6	30	#include <babeltrace/trace-ir/field-path-const.h>
108b91d0	31	#include <babeltrace/trace-ir/resolve-field-path-internal.h>
7b33a0e0 PP	32	#include <limits.h>
	33	#include <stdint.h>
	34	#include <inttypes.h>
	35	#include <glib.h>
	36
	37	static
939190b3 PP	38	bool find_field_class_recursive(struct bt_field_class *fc,
939190b3 PP	39	struct bt_field_class tgt_fc, struct bt_field_path field_path)
7b33a0e0 PP	40	{
	41	bool found = false;
	42
939190b3	43	if (tgt_fc == fc) {
7b33a0e0 PP	44	found = true;
	45	goto end;
	46	}
	47
af0c18e3 PP	48	switch (fc->type) {
	49	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	50	case BT_FIELD_CLASS_TYPE_VARIANT:
7b33a0e0	51	{
939190b3 PP	52	struct bt_field_class_named_field_class_container *container_fc =
939190b3 PP	53	(void *) fc;
7b33a0e0 PP	54	uint64_t i;
7b33a0e0 PP	55
939190b3 PP	56	for (i = 0; i < container_fc->named_fcs->len; i++) {
	57	struct bt_named_field_class *named_fc =
	58	BT_FIELD_CLASS_NAMED_FC_AT_INDEX(
	59	container_fc, i);
7b33a0e0 PP	60
7b33a0e0 PP	61	g_array_append_val(field_path->indexes, i);
939190b3 PP	62	found = find_field_class_recursive(named_fc->fc,
939190b3 PP	63	tgt_fc, field_path);
7b33a0e0 PP	64	if (found) {
	65	goto end;
	66	}
	67
	68	g_array_set_size(field_path->indexes,
	69	field_path->indexes->len - 1);
	70	}
	71
	72	break;
	73	}
af0c18e3 PP	74	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
af0c18e3 PP	75	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
7b33a0e0	76	{
939190b3	77	struct bt_field_class_array array_fc = (void ) fc;
7b33a0e0	78
939190b3 PP	79	found = find_field_class_recursive(array_fc->element_fc,
939190b3 PP	80	tgt_fc, field_path);
7b33a0e0 PP	81	break;
	82	}
	83	default:
	84	break;
	85	}
	86
	87	end:
	88	return found;
	89	}
	90
	91	static
939190b3 PP	92	int find_field_class(struct bt_field_class *root_fc,
939190b3 PP	93	enum bt_scope root_scope, struct bt_field_class *tgt_fc,
7b33a0e0 PP	94	struct bt_field_path **ret_field_path)
	95	{
	96	int ret = 0;
	97	struct bt_field_path *field_path = NULL;
	98
939190b3	99	if (!root_fc) {
7b33a0e0 PP	100	goto end;
	101	}
	102
	103	field_path = bt_field_path_create();
	104	if (!field_path) {
	105	ret = -1;
	106	goto end;
	107	}
	108
	109	field_path->root = root_scope;
939190b3	110	if (!find_field_class_recursive(root_fc, tgt_fc, field_path)) {
7b33a0e0	111	/* Not found here */
8138bfe1	112	BT_OBJECT_PUT_REF_AND_RESET(field_path);
7b33a0e0 PP	113	}
	114
	115	end:
	116	*ret_field_path = field_path;
	117	return ret;
	118	}
	119
	120	static
939190b3	121	struct bt_field_path find_field_class_in_ctx(struct bt_field_class fc,
7b33a0e0 PP	122	struct bt_resolve_field_path_context *ctx)
	123	{
	124	struct bt_field_path *field_path = NULL;
	125	int ret;
	126
939190b3 PP	127	ret = find_field_class(ctx->packet_context, BT_SCOPE_PACKET_CONTEXT,
939190b3 PP	128	fc, &field_path);
7b33a0e0 PP	129	if (ret \|\| field_path) {
	130	goto end;
	131	}
	132
939190b3 PP	133	ret = find_field_class(ctx->event_common_context,
939190b3 PP	134	BT_SCOPE_EVENT_COMMON_CONTEXT, fc, &field_path);
7b33a0e0 PP	135	if (ret \|\| field_path) {
	136	goto end;
	137	}
	138
939190b3 PP	139	ret = find_field_class(ctx->event_specific_context,
939190b3 PP	140	BT_SCOPE_EVENT_SPECIFIC_CONTEXT, fc, &field_path);
7b33a0e0 PP	141	if (ret \|\| field_path) {
	142	goto end;
	143	}
	144
939190b3 PP	145	ret = find_field_class(ctx->event_payload, BT_SCOPE_EVENT_PAYLOAD,
939190b3 PP	146	fc, &field_path);
7b33a0e0 PP	147	if (ret \|\| field_path) {
	148	goto end;
	149	}
	150
	151	end:
	152	return field_path;
	153	}
	154
	155	BT_ASSERT_PRE_FUNC
	156	static inline
	157	bool target_is_before_source(struct bt_field_path *src_field_path,
	158	struct bt_field_path *tgt_field_path)
	159	{
	160	bool is_valid = true;
	161	uint64_t src_i = 0, tgt_i = 0;
	162
	163	if (tgt_field_path->root < src_field_path->root) {
	164	goto end;
	165	}
	166
	167	if (tgt_field_path->root > src_field_path->root) {
	168	is_valid = false;
	169	goto end;
	170	}
	171
	172	BT_ASSERT(tgt_field_path->root == src_field_path->root);
	173
	174	while (src_i < src_field_path->indexes->len &&
	175	tgt_i < tgt_field_path->indexes->len) {
	176	uint64_t src_index = bt_field_path_get_index_by_index_inline(
	177	src_field_path, src_i);
	178	uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
	179	tgt_field_path, tgt_i);
	180
	181	if (tgt_index > src_index) {
	182	is_valid = false;
	183	goto end;
	184	}
	185
	186	src_i++;
	187	tgt_i++;
	188	}
	189
	190	end:
	191	return is_valid;
	192	}
	193
	194	BT_ASSERT_PRE_FUNC
	195	static inline
939190b3	196	struct bt_field_class *borrow_root_field_class(
7b33a0e0 PP	197	struct bt_resolve_field_path_context *ctx, enum bt_scope scope)
	198	{
	199	switch (scope) {
7b33a0e0 PP	200	case BT_SCOPE_PACKET_CONTEXT:
7b33a0e0 PP	201	return ctx->packet_context;
7b33a0e0 PP	202	case BT_SCOPE_EVENT_COMMON_CONTEXT:
	203	return ctx->event_common_context;
	204	case BT_SCOPE_EVENT_SPECIFIC_CONTEXT:
	205	return ctx->event_specific_context;
	206	case BT_SCOPE_EVENT_PAYLOAD:
	207	return ctx->event_payload;
	208	default:
	209	abort();
	210	}
	211
	212	return NULL;
	213	}
	214
	215	BT_ASSERT_PRE_FUNC
	216	static inline
939190b3	217	struct bt_field_class borrow_child_field_class(struct bt_field_class parent_fc,
7b33a0e0 PP	218	uint64_t index, bool *advance)
7b33a0e0 PP	219	{
939190b3	220	struct bt_field_class *child_fc = NULL;
7b33a0e0	221
af0c18e3 PP	222	switch (parent_fc->type) {
	223	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	224	case BT_FIELD_CLASS_TYPE_VARIANT:
7b33a0e0	225	{
939190b3 PP	226	struct bt_named_field_class *named_fc =
939190b3 PP	227	BT_FIELD_CLASS_NAMED_FC_AT_INDEX(parent_fc, index);
7b33a0e0	228
939190b3	229	child_fc = named_fc->fc;
7b33a0e0 PP	230	*advance = true;
	231	break;
	232	}
af0c18e3 PP	233	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
af0c18e3 PP	234	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
7b33a0e0	235	{
939190b3	236	struct bt_field_class_array array_fc = (void ) parent_fc;
7b33a0e0	237
939190b3	238	child_fc = array_fc->element_fc;
7b33a0e0 PP	239	*advance = false;
	240	break;
	241	}
	242	default:
	243	break;
	244	}
	245
939190b3	246	return child_fc;
7b33a0e0 PP	247	}
	248
	249	BT_ASSERT_PRE_FUNC
	250	static inline
939190b3	251	bool target_field_path_in_different_scope_has_struct_fc_only(
7b33a0e0 PP	252	struct bt_field_path *src_field_path,
	253	struct bt_field_path *tgt_field_path,
	254	struct bt_resolve_field_path_context *ctx)
	255	{
	256	bool is_valid = true;
	257	uint64_t i = 0;
939190b3	258	struct bt_field_class *fc;
7b33a0e0 PP	259
	260	if (src_field_path->root == tgt_field_path->root) {
	261	goto end;
	262	}
	263
939190b3	264	fc = borrow_root_field_class(ctx, tgt_field_path->root);
7b33a0e0 PP	265
	266	while (i < tgt_field_path->indexes->len) {
	267	uint64_t index = bt_field_path_get_index_by_index_inline(
	268	tgt_field_path, i);
	269	bool advance;
	270
af0c18e3 PP	271	if (fc->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY \|\|
	272	fc->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY \|\|
	273	fc->type == BT_FIELD_CLASS_TYPE_VARIANT) {
7b33a0e0 PP	274	is_valid = false;
	275	goto end;
	276	}
	277
939190b3	278	fc = borrow_child_field_class(fc, index, &advance);
7b33a0e0 PP	279
	280	if (advance) {
	281	i++;
	282	}
	283	}
	284
	285	end:
	286	return is_valid;
	287	}
	288
	289	BT_ASSERT_PRE_FUNC
	290	static inline
939190b3	291	bool lca_is_structure_field_class(struct bt_field_path *src_field_path,
7b33a0e0 PP	292	struct bt_field_path *tgt_field_path,
	293	struct bt_resolve_field_path_context *ctx)
	294	{
	295	bool is_valid = true;
939190b3 PP	296	struct bt_field_class *src_fc;
	297	struct bt_field_class *tgt_fc;
	298	struct bt_field_class *prev_fc = NULL;
7b33a0e0 PP	299	uint64_t src_i = 0, tgt_i = 0;
	300
	301	if (src_field_path->root != tgt_field_path->root) {
	302	goto end;
	303	}
	304
939190b3 PP	305	src_fc = borrow_root_field_class(ctx, src_field_path->root);
	306	tgt_fc = borrow_root_field_class(ctx, tgt_field_path->root);
	307	BT_ASSERT(src_fc);
	308	BT_ASSERT(tgt_fc);
7b33a0e0 PP	309
	310	while (src_i < src_field_path->indexes->len &&
	311	tgt_i < tgt_field_path->indexes->len) {
	312	bool advance;
	313	uint64_t src_index = bt_field_path_get_index_by_index_inline(
	314	src_field_path, src_i);
	315	uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
	316	tgt_field_path, tgt_i);
	317
939190b3 PP	318	if (src_fc != tgt_fc) {
939190b3 PP	319	if (!prev_fc) {
7b33a0e0 PP	320	/*
7b33a0e0 PP	321	* This is correct: the LCA is the root
66fd07a5 PP	322	* scope field class, which must be a
66fd07a5 PP	323	* structure field class.
7b33a0e0 PP	324	*/
	325	break;
	326	}
	327
af0c18e3	328	if (prev_fc->type != BT_FIELD_CLASS_TYPE_STRUCTURE) {
7b33a0e0 PP	329	is_valid = false;
	330	}
	331
	332	break;
	333	}
	334
939190b3 PP	335	prev_fc = src_fc;
939190b3 PP	336	src_fc = borrow_child_field_class(src_fc, src_index, &advance);
7b33a0e0 PP	337
	338	if (advance) {
	339	src_i++;
	340	}
	341
939190b3	342	tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);
7b33a0e0 PP	343
	344	if (advance) {
	345	tgt_i++;
	346	}
	347	}
	348
	349	end:
	350	return is_valid;
	351	}
	352
	353	BT_ASSERT_PRE_FUNC
	354	static inline
939190b3	355	bool lca_to_target_has_struct_fc_only(struct bt_field_path *src_field_path,
7b33a0e0 PP	356	struct bt_field_path *tgt_field_path,
	357	struct bt_resolve_field_path_context *ctx)
	358	{
	359	bool is_valid = true;
939190b3 PP	360	struct bt_field_class *src_fc;
939190b3 PP	361	struct bt_field_class *tgt_fc;
7b33a0e0 PP	362	uint64_t src_i = 0, tgt_i = 0;
	363
	364	if (src_field_path->root != tgt_field_path->root) {
	365	goto end;
	366	}
	367
939190b3 PP	368	src_fc = borrow_root_field_class(ctx, src_field_path->root);
	369	tgt_fc = borrow_root_field_class(ctx, tgt_field_path->root);
	370	BT_ASSERT(src_fc);
	371	BT_ASSERT(tgt_fc);
	372	BT_ASSERT(src_fc == tgt_fc);
7b33a0e0 PP	373
	374	/* Find LCA */
	375	while (src_i < src_field_path->indexes->len &&
	376	tgt_i < tgt_field_path->indexes->len) {
	377	bool advance;
	378	uint64_t src_index = bt_field_path_get_index_by_index_inline(
	379	src_field_path, src_i);
	380	uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
	381	tgt_field_path, tgt_i);
	382
	383	if (src_i != tgt_i) {
939190b3	384	/* Next field class is different: LCA is `tgt_fc` */
7b33a0e0 PP	385	break;
	386	}
	387
939190b3	388	src_fc = borrow_child_field_class(src_fc, src_index, &advance);
7b33a0e0 PP	389
	390	if (advance) {
	391	src_i++;
	392	}
	393
939190b3	394	tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);
7b33a0e0 PP	395
	396	if (advance) {
	397	tgt_i++;
	398	}
	399	}
	400
939190b3	401	/* Only structure field classes to the target */
7b33a0e0 PP	402	while (tgt_i < tgt_field_path->indexes->len) {
	403	bool advance;
	404	uint64_t tgt_index = bt_field_path_get_index_by_index_inline(
	405	tgt_field_path, tgt_i);
	406
af0c18e3 PP	407	if (tgt_fc->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY \|\|
	408	tgt_fc->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY \|\|
	409	tgt_fc->type == BT_FIELD_CLASS_TYPE_VARIANT) {
7b33a0e0 PP	410	is_valid = false;
	411	goto end;
	412	}
	413
939190b3	414	tgt_fc = borrow_child_field_class(tgt_fc, tgt_index, &advance);
7b33a0e0 PP	415
	416	if (advance) {
	417	tgt_i++;
	418	}
	419	}
	420
	421	end:
	422	return is_valid;
	423	}
	424
	425	BT_ASSERT_PRE_FUNC
	426	static inline
939190b3 PP	427	bool field_path_is_valid(struct bt_field_class *src_fc,
939190b3 PP	428	struct bt_field_class *tgt_fc,
7b33a0e0 PP	429	struct bt_resolve_field_path_context *ctx)
	430	{
	431	bool is_valid = true;
939190b3 PP	432	struct bt_field_path *src_field_path = find_field_class_in_ctx(
	433	src_fc, ctx);
	434	struct bt_field_path *tgt_field_path = find_field_class_in_ctx(
	435	tgt_fc, ctx);
7b33a0e0 PP	436
7b33a0e0 PP	437	if (!src_field_path) {
66fd07a5	438	BT_ASSERT_PRE_MSG("Cannot find requesting field class in "
939190b3	439	"resolving context: %!+F", src_fc);
7b33a0e0 PP	440	is_valid = false;
	441	goto end;
	442	}
	443
	444	if (!tgt_field_path) {
66fd07a5	445	BT_ASSERT_PRE_MSG("Cannot find target field class in "
939190b3	446	"resolving context: %!+F", tgt_fc);
7b33a0e0 PP	447	is_valid = false;
	448	goto end;
	449	}
	450
	451	/* Target must be before source */
	452	if (!target_is_before_source(src_field_path, tgt_field_path)) {
66fd07a5 PP	453	BT_ASSERT_PRE_MSG("Target field class is located after "
66fd07a5 PP	454	"requesting field class: %![req-fc-]+F, %![tgt-fc-]+F",
939190b3	455	src_fc, tgt_fc);
7b33a0e0 PP	456	is_valid = false;
	457	goto end;
	458	}
	459
	460	/*
	461	* If target is in a different scope than source, there are no
939190b3	462	* array or variant field classes on the way to the target.
7b33a0e0	463	*/
939190b3	464	if (!target_field_path_in_different_scope_has_struct_fc_only(
7b33a0e0	465	src_field_path, tgt_field_path, ctx)) {
66fd07a5 PP	466	BT_ASSERT_PRE_MSG("Target field class is located in a "
	467	"different scope than requesting field class, "
	468	"but within an array or a variant field class: "
939190b3 PP	469	"%![req-fc-]+F, %![tgt-fc-]+F",
939190b3 PP	470	src_fc, tgt_fc);
7b33a0e0 PP	471	is_valid = false;
	472	goto end;
	473	}
	474
66fd07a5	475	/* Same scope: LCA must be a structure field class */
939190b3	476	if (!lca_is_structure_field_class(src_field_path, tgt_field_path, ctx)) {
7b33a0e0	477	BT_ASSERT_PRE_MSG("Lowest common ancestor of target and "
66fd07a5	478	"requesting field classes is not a structure field class: "
939190b3 PP	479	"%![req-fc-]+F, %![tgt-fc-]+F",
939190b3 PP	480	src_fc, tgt_fc);
7b33a0e0 PP	481	is_valid = false;
	482	goto end;
	483	}
	484
	485	/* Same scope: path from LCA to target has no array/variant FTs */
939190b3	486	if (!lca_to_target_has_struct_fc_only(src_field_path, tgt_field_path,
7b33a0e0 PP	487	ctx)) {
7b33a0e0 PP	488	BT_ASSERT_PRE_MSG("Path from lowest common ancestor of target "
66fd07a5 PP	489	"and requesting field classes to target field class "
66fd07a5 PP	490	"contains an array or a variant field class: "
939190b3	491	"%![req-fc-]+F, %![tgt-fc-]+F", src_fc, tgt_fc);
7b33a0e0 PP	492	is_valid = false;
	493	goto end;
	494	}
	495
	496	end:
8138bfe1 PP	497	bt_object_put_ref(src_field_path);
8138bfe1 PP	498	bt_object_put_ref(tgt_field_path);
7b33a0e0 PP	499	return is_valid;
	500	}
	501
	502	static
939190b3 PP	503	struct bt_field_path resolve_field_path(struct bt_field_class src_fc,
939190b3 PP	504	struct bt_field_class *tgt_fc,
7b33a0e0 PP	505	struct bt_resolve_field_path_context *ctx)
7b33a0e0 PP	506	{
939190b3	507	BT_ASSERT_PRE(field_path_is_valid(src_fc, tgt_fc, ctx),
66fd07a5	508	"Invalid target field class: %![req-fc-]+F, %![tgt-fc-]+F",
939190b3 PP	509	src_fc, tgt_fc);
939190b3 PP	510	return find_field_class_in_ctx(tgt_fc, ctx);
7b33a0e0 PP	511	}
	512
	513	BT_HIDDEN
939190b3	514	int bt_resolve_field_paths(struct bt_field_class *fc,
7b33a0e0 PP	515	struct bt_resolve_field_path_context *ctx)
	516	{
	517	int ret = 0;
	518
939190b3	519	BT_ASSERT(fc);
7b33a0e0	520
939190b3	521	/* Resolving part for dynamic array and variant field classes */
af0c18e3 PP	522	switch (fc->type) {
af0c18e3 PP	523	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
7b33a0e0	524	{
939190b3	525	struct bt_field_class_dynamic_array dyn_array_fc = (void ) fc;
7b33a0e0	526
939190b3 PP	527	if (dyn_array_fc->length_fc) {
	528	BT_ASSERT(!dyn_array_fc->length_field_path);
	529	dyn_array_fc->length_field_path = resolve_field_path(
	530	fc, dyn_array_fc->length_fc, ctx);
	531	if (!dyn_array_fc->length_field_path) {
7b33a0e0 PP	532	ret = -1;
	533	goto end;
	534	}
	535	}
	536
	537	break;
	538	}
af0c18e3	539	case BT_FIELD_CLASS_TYPE_VARIANT:
7b33a0e0	540	{
939190b3 PP	541	struct bt_field_class_variant var_fc = (void ) fc;
	542
	543	if (var_fc->selector_fc) {
	544	BT_ASSERT(!var_fc->selector_field_path);
	545	var_fc->selector_field_path =
	546	resolve_field_path(fc,
	547	var_fc->selector_fc, ctx);
	548	if (!var_fc->selector_field_path) {
7b33a0e0 PP	549	ret = -1;
	550	goto end;
	551	}
	552	}
	553	}
	554	default:
	555	break;
	556	}
	557
	558	/* Recursive part */
af0c18e3 PP	559	switch (fc->type) {
	560	case BT_FIELD_CLASS_TYPE_STRUCTURE:
	561	case BT_FIELD_CLASS_TYPE_VARIANT:
7b33a0e0	562	{
939190b3 PP	563	struct bt_field_class_named_field_class_container *container_fc =
939190b3 PP	564	(void *) fc;
7b33a0e0 PP	565	uint64_t i;
7b33a0e0 PP	566
939190b3 PP	567	for (i = 0; i < container_fc->named_fcs->len; i++) {
	568	struct bt_named_field_class *named_fc =
	569	BT_FIELD_CLASS_NAMED_FC_AT_INDEX(
	570	container_fc, i);
7b33a0e0	571
939190b3	572	ret = bt_resolve_field_paths(named_fc->fc, ctx);
7b33a0e0 PP	573	if (ret) {
	574	goto end;
	575	}
	576	}
	577
	578	break;
	579	}
af0c18e3 PP	580	case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
af0c18e3 PP	581	case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
7b33a0e0	582	{
939190b3	583	struct bt_field_class_array array_fc = (void ) fc;
7b33a0e0	584
939190b3	585	ret = bt_resolve_field_paths(array_fc->element_fc, ctx);
7b33a0e0 PP	586	break;
	587	}
	588	default:
	589	break;
	590	}
	591
	592	end:
	593	return ret;
	594	}