[lttng-tools.git] / include / lttng / event-expr-internal.h

/*
 * Copyright (C) 2020 Philippe Proulx <pproulx@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_EVENT_EXPR_INTERNAL_H
#define LTTNG_EVENT_EXPR_INTERNAL_H

#include <common/macros.h>
#include <lttng/event-expr.h>

struct lttng_bytecode;
struct mi_writer;

struct lttng_event_expr {
	enum lttng_event_expr_type type;
};

/*
 * `LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD` and
 * `LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD`.
 */
struct lttng_event_expr_field {
	struct lttng_event_expr parent;
	char *name;
};

/* `LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD` */
struct lttng_event_expr_app_specific_context_field {
	struct lttng_event_expr parent;
	char *provider_name;
	char *type_name;
};

/* `LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT` */
struct lttng_event_expr_array_field_element {
	struct lttng_event_expr parent;

	/* Owned by this */
	struct lttng_event_expr *array_field_expr;

	unsigned int index;
};

/*
 * Returns whether or not `expr` is an l-value (locator value).
 */
static inline
bool lttng_event_expr_is_lvalue(const struct lttng_event_expr *expr)
{
	LTTNG_ASSERT(expr);
	return expr->type == LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD ||
			expr->type == LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD ||
			expr->type == LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD ||
			expr->type == LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT;
}

LTTNG_HIDDEN
int lttng_event_expr_to_bytecode(const struct lttng_event_expr *expr,
		struct lttng_bytecode **bytecode_out);

LTTNG_HIDDEN
enum lttng_error_code lttng_event_expr_mi_serialize(
		const struct lttng_event_expr *expression,
		struct mi_writer *writer);

#endif /* LTTNG_EVENT_EXPR_INTERNAL_H */
Commit	Line	Data
48c47564 PP	1	/*
	2	* Copyright (C) 2020 Philippe Proulx <pproulx@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_EVENT_EXPR_INTERNAL_H
	9	#define LTTNG_EVENT_EXPR_INTERNAL_H
	10
1aa9c49c	11	#include <common/macros.h>
48c47564 PP	12	#include <lttng/event-expr.h>
48c47564 PP	13
1aa9c49c	14	struct lttng_bytecode;
6a751b95	15	struct mi_writer;
1aa9c49c	16
48c47564 PP	17	struct lttng_event_expr {
	18	enum lttng_event_expr_type type;
	19	};
	20
	21	/*
	22	* `LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD` and
	23	* `LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD`.
	24	*/
	25	struct lttng_event_expr_field {
	26	struct lttng_event_expr parent;
	27	char *name;
	28	};
	29
	30	/* `LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD` */
	31	struct lttng_event_expr_app_specific_context_field {
	32	struct lttng_event_expr parent;
	33	char *provider_name;
	34	char *type_name;
	35	};
	36
	37	/* `LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT` */
	38	struct lttng_event_expr_array_field_element {
	39	struct lttng_event_expr parent;
	40
	41	/* Owned by this */
	42	struct lttng_event_expr *array_field_expr;
	43
	44	unsigned int index;
	45	};
	46
	47	/*
	48	* Returns whether or not `expr` is an l-value (locator value).
	49	*/
	50	static inline
	51	bool lttng_event_expr_is_lvalue(const struct lttng_event_expr *expr)
	52	{
a0377dfe	53	LTTNG_ASSERT(expr);
48c47564 PP	54	return expr->type == LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD \|\|
	55	expr->type == LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD \|\|
	56	expr->type == LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD \|\|
	57	expr->type == LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT;
	58	}
	59
1aa9c49c JR	60	LTTNG_HIDDEN
	61	int lttng_event_expr_to_bytecode(const struct lttng_event_expr *expr,
	62	struct lttng_bytecode **bytecode_out);
	63
6a751b95 JR	64	LTTNG_HIDDEN
	65	enum lttng_error_code lttng_event_expr_mi_serialize(
	66	const struct lttng_event_expr *expression,
	67	struct mi_writer *writer);
	68
48c47564	69	#endif /* LTTNG_EVENT_EXPR_INTERNAL_H */