[lttng-tools.git] / include / lttng / error-query-internal.h

/*
 * error-query-internal.h
 *
 * Copyright (C) 2021 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.1-only
 *
 */

#ifndef LTTNG_ERROR_QUERY_INTERNAL_H
#define LTTNG_ERROR_QUERY_INTERNAL_H

#include <lttng/lttng.h>
#include <common/macros.h>
#include <common/payload.h>
#include <common/payload-view.h>

#ifdef __cplusplus
extern "C" {
#endif

struct mi_writer;

enum lttng_error_query_target_type {
	LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER,
	LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION,
	LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION,
};

enum lttng_error_query_target_type lttng_error_query_get_target_type(
		const struct lttng_error_query *query);

const struct lttng_trigger *lttng_error_query_trigger_borrow_target(
		const struct lttng_error_query *query);

const struct lttng_trigger *lttng_error_query_condition_borrow_target(
		const struct lttng_error_query *query);

const struct lttng_trigger *lttng_error_query_action_borrow_trigger_target(
		const struct lttng_error_query *query);

struct lttng_action *lttng_error_query_action_borrow_action_target(
		const struct lttng_error_query *query,
		struct lttng_trigger *trigger);

int lttng_error_query_serialize(const struct lttng_error_query *query,
		struct lttng_payload *payload);

ssize_t lttng_error_query_create_from_payload(struct lttng_payload_view *view,
		struct lttng_error_query **query);

int lttng_error_query_result_serialize(
		const struct lttng_error_query_result *result,
		struct lttng_payload *payload);

ssize_t lttng_error_query_result_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_error_query_result **result);

int lttng_error_query_results_serialize(
		const struct lttng_error_query_results *results,
		struct lttng_payload *payload);

ssize_t lttng_error_query_results_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_error_query_results **results);

struct lttng_error_query_result *
lttng_error_query_result_counter_create(
		const char *name, const char *description, uint64_t value);

void lttng_error_query_result_destroy(struct lttng_error_query_result *result);

struct lttng_error_query_results *lttng_error_query_results_create(void);

/* Ownership of `result` is transferred on success. */
int lttng_error_query_results_add_result(
		struct lttng_error_query_results *results,
		struct lttng_error_query_result *result);

enum lttng_error_code lttng_error_query_results_mi_serialize(
		const struct lttng_error_query_results *results,
		struct mi_writer *writer);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_ERROR_QUERY_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* error-query-internal.h
	3	*
	4	* Copyright (C) 2021 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	*
	6	* SPDX-License-Identifier: GPL-2.1-only
	7	*
	8	*/
	9
	10	#ifndef LTTNG_ERROR_QUERY_INTERNAL_H
	11	#define LTTNG_ERROR_QUERY_INTERNAL_H
	12
	13	#include <lttng/lttng.h>
	14	#include <common/macros.h>
	15	#include <common/payload.h>
	16	#include <common/payload-view.h>
	17
	18	#ifdef __cplusplus
	19	extern "C" {
	20	#endif
	21
	22	struct mi_writer;
	23
	24	enum lttng_error_query_target_type {
	25	LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER,
	26	LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION,
	27	LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION,
	28	};
	29
	30	enum lttng_error_query_target_type lttng_error_query_get_target_type(
	31	const struct lttng_error_query *query);
	32
	33	const struct lttng_trigger *lttng_error_query_trigger_borrow_target(
	34	const struct lttng_error_query *query);
	35
	36	const struct lttng_trigger *lttng_error_query_condition_borrow_target(
	37	const struct lttng_error_query *query);
	38
	39	const struct lttng_trigger *lttng_error_query_action_borrow_trigger_target(
	40	const struct lttng_error_query *query);
	41
	42	struct lttng_action *lttng_error_query_action_borrow_action_target(
	43	const struct lttng_error_query *query,
	44	struct lttng_trigger *trigger);
	45
	46	int lttng_error_query_serialize(const struct lttng_error_query *query,
	47	struct lttng_payload *payload);
	48
	49	ssize_t lttng_error_query_create_from_payload(struct lttng_payload_view *view,
	50	struct lttng_error_query **query);
	51
	52	int lttng_error_query_result_serialize(
	53	const struct lttng_error_query_result *result,
	54	struct lttng_payload *payload);
	55
	56	ssize_t lttng_error_query_result_create_from_payload(
	57	struct lttng_payload_view *view,
	58	struct lttng_error_query_result **result);
	59
	60	int lttng_error_query_results_serialize(
	61	const struct lttng_error_query_results *results,
	62	struct lttng_payload *payload);
	63
	64	ssize_t lttng_error_query_results_create_from_payload(
	65	struct lttng_payload_view *view,
	66	struct lttng_error_query_results **results);
	67
	68	struct lttng_error_query_result *
	69	lttng_error_query_result_counter_create(
	70	const char name, const char description, uint64_t value);
	71
	72	void lttng_error_query_result_destroy(struct lttng_error_query_result *result);
	73
	74	struct lttng_error_query_results *lttng_error_query_results_create(void);
	75
	76	/* Ownership of `result` is transferred on success. */
	77	int lttng_error_query_results_add_result(
	78	struct lttng_error_query_results *results,
	79	struct lttng_error_query_result *result);
	80
	81	enum lttng_error_code lttng_error_query_results_mi_serialize(
	82	const struct lttng_error_query_results *results,
	83	struct mi_writer *writer);
	84
	85	#ifdef __cplusplus
	86	}
	87	#endif
	88
	89	#endif /* LTTNG_ERROR_QUERY_INTERNAL_H */