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

/*
 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_CONDITION_ON_EVENT_INTERNAL_H
#define LTTNG_CONDITION_ON_EVENT_INTERNAL_H

#include <lttng/condition/condition-internal.h>
#include <common/buffer-view.h>
#include <common/macros.h>
#include <common/optional.h>
#include <lttng/condition/evaluation-internal.h>
#include <common/dynamic-array.h>
#include <lttng/event-field-value.h>

struct lttng_capture_descriptor {
	struct lttng_event_expr *event_expression;
	struct lttng_bytecode *bytecode;
};

struct lttng_condition_on_event {
	struct lttng_condition parent;
	struct lttng_event_rule *rule;

	LTTNG_OPTIONAL(uint64_t) error_count;
	/*
	 * Internal use only.
	 * Error accounting counter index.
	 */
	LTTNG_OPTIONAL(uint64_t) error_counter_index;

	/* Array of `struct lttng_capture_descriptor *`. */
	struct lttng_dynamic_pointer_array capture_descriptors;
};

struct lttng_evaluation_on_event {
	struct lttng_evaluation parent;

	/* MessagePack-encoded captured event field values. */
	struct lttng_dynamic_buffer capture_payload;

	/*
	 * The content of this array event field value is the decoded
	 * version of `capture_payload` above.
	 *
	 * This is a cache: it's not serialized/deserialized in
	 * communications from/to the library and the session daemon.
	 */
	struct lttng_event_field_value *captured_values;
};

LTTNG_HIDDEN
ssize_t lttng_condition_on_event_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_condition **condition);

LTTNG_HIDDEN
enum lttng_condition_status
lttng_condition_on_event_borrow_rule_mutable(
		const struct lttng_condition *condition,
		struct lttng_event_rule **rule);

LTTNG_HIDDEN
void lttng_condition_on_event_set_error_counter_index(
		struct lttng_condition *condition, uint64_t error_counter_index);

LTTNG_HIDDEN
uint64_t lttng_condition_on_event_get_error_counter_index(
		const struct lttng_condition *condition);

LTTNG_HIDDEN
uint64_t lttng_condition_on_event_get_error_count(
		const struct lttng_condition *condition);

LTTNG_HIDDEN
void lttng_condition_on_event_set_error_count(struct lttng_condition *condition,
		uint64_t error_count);

LTTNG_HIDDEN
struct lttng_evaluation *lttng_evaluation_on_event_create(
		const struct lttng_condition_on_event *condition,
		const char *capture_payload, size_t capture_payload_size,
		bool decode_capture_payload);

LTTNG_HIDDEN
ssize_t lttng_evaluation_on_event_create_from_payload(
		const struct lttng_condition_on_event *condition,
		struct lttng_payload_view *view,
		struct lttng_evaluation **_evaluation);

LTTNG_HIDDEN
enum lttng_error_code
lttng_condition_on_event_generate_capture_descriptor_bytecode(
		struct lttng_condition *condition);

LTTNG_HIDDEN
const struct lttng_bytecode *
lttng_condition_on_event_get_capture_bytecode_at_index(
		const struct lttng_condition *condition, unsigned int index);

#endif /* LTTNG_CONDITION_ON_EVENT_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_CONDITION_ON_EVENT_INTERNAL_H
	9	#define LTTNG_CONDITION_ON_EVENT_INTERNAL_H
	10
	11	#include <lttng/condition/condition-internal.h>
	12	#include <common/buffer-view.h>
	13	#include <common/macros.h>
	14	#include <common/optional.h>
	15	#include <lttng/condition/evaluation-internal.h>
	16	#include <common/dynamic-array.h>
	17	#include <lttng/event-field-value.h>
	18
	19	struct lttng_capture_descriptor {
	20	struct lttng_event_expr *event_expression;
	21	struct lttng_bytecode *bytecode;
	22	};
	23
	24	struct lttng_condition_on_event {
	25	struct lttng_condition parent;
	26	struct lttng_event_rule *rule;
	27
	28	LTTNG_OPTIONAL(uint64_t) error_count;
	29	/*
	30	* Internal use only.
	31	* Error accounting counter index.
	32	*/
	33	LTTNG_OPTIONAL(uint64_t) error_counter_index;
	34
	35	/* Array of `struct lttng_capture_descriptor `. /
	36	struct lttng_dynamic_pointer_array capture_descriptors;
	37	};
	38
	39	struct lttng_evaluation_on_event {
	40	struct lttng_evaluation parent;
	41
	42	/* MessagePack-encoded captured event field values. */
	43	struct lttng_dynamic_buffer capture_payload;
	44
	45	/*
	46	* The content of this array event field value is the decoded
	47	* version of `capture_payload` above.
	48	*
	49	* This is a cache: it's not serialized/deserialized in
	50	* communications from/to the library and the session daemon.
	51	*/
	52	struct lttng_event_field_value *captured_values;
	53	};
	54
	55	LTTNG_HIDDEN
	56	ssize_t lttng_condition_on_event_create_from_payload(
	57	struct lttng_payload_view *view,
	58	struct lttng_condition **condition);
	59
	60	LTTNG_HIDDEN
	61	enum lttng_condition_status
	62	lttng_condition_on_event_borrow_rule_mutable(
	63	const struct lttng_condition *condition,
	64	struct lttng_event_rule **rule);
	65
	66	LTTNG_HIDDEN
	67	void lttng_condition_on_event_set_error_counter_index(
	68	struct lttng_condition *condition, uint64_t error_counter_index);
	69
	70	LTTNG_HIDDEN
	71	uint64_t lttng_condition_on_event_get_error_counter_index(
	72	const struct lttng_condition *condition);
	73
	74	LTTNG_HIDDEN
	75	uint64_t lttng_condition_on_event_get_error_count(
	76	const struct lttng_condition *condition);
	77
	78	LTTNG_HIDDEN
	79	void lttng_condition_on_event_set_error_count(struct lttng_condition *condition,
	80	uint64_t error_count);
	81
	82	LTTNG_HIDDEN
	83	struct lttng_evaluation *lttng_evaluation_on_event_create(
	84	const struct lttng_condition_on_event *condition,
	85	const char *capture_payload, size_t capture_payload_size,
	86	bool decode_capture_payload);
	87
	88	LTTNG_HIDDEN
	89	ssize_t lttng_evaluation_on_event_create_from_payload(
	90	const struct lttng_condition_on_event *condition,
	91	struct lttng_payload_view *view,
	92	struct lttng_evaluation **_evaluation);
	93
	94	LTTNG_HIDDEN
	95	enum lttng_error_code
	96	lttng_condition_on_event_generate_capture_descriptor_bytecode(
	97	struct lttng_condition *condition);
	98
	99	LTTNG_HIDDEN
	100	const struct lttng_bytecode *
	101	lttng_condition_on_event_get_capture_bytecode_at_index(
	102	const struct lttng_condition *condition, unsigned int index);
	103
	104	#endif /* LTTNG_CONDITION_ON_EVENT_INTERNAL_H */