[lttng-tools.git] / src / common / event-rule / event-rule.cpp

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

#include <common/error.hpp>
#include <common/hashtable/hashtable.hpp>
#include <common/hashtable/utils.hpp>
#include <common/macros.hpp>
#include <common/mi-lttng.hpp>
#include <common/payload-view.hpp>
#include <common/payload.hpp>

#include <lttng/event-rule/event-rule-internal.hpp>
#include <lttng/event-rule/jul-logging-internal.hpp>
#include <lttng/event-rule/kernel-kprobe-internal.hpp>
#include <lttng/event-rule/kernel-syscall-internal.hpp>
#include <lttng/event-rule/kernel-tracepoint-internal.hpp>
#include <lttng/event-rule/kernel-uprobe-internal.hpp>
#include <lttng/event-rule/log4j-logging-internal.hpp>
#include <lttng/event-rule/python-logging-internal.hpp>
#include <lttng/event-rule/user-tracepoint-internal.hpp>

#include <stdbool.h>

enum lttng_event_rule_type lttng_event_rule_get_type(const struct lttng_event_rule *event_rule)
{
	return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
}

enum lttng_domain_type lttng_event_rule_get_domain_type(const struct lttng_event_rule *event_rule)
{
	enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;

	switch (lttng_event_rule_get_type(event_rule)) {
	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
		domain_type = LTTNG_DOMAIN_UST;
		break;
	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
		domain_type = LTTNG_DOMAIN_JUL;
		break;
	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
		domain_type = LTTNG_DOMAIN_LOG4J;
		break;
	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
		domain_type = LTTNG_DOMAIN_PYTHON;
		break;
	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
		domain_type = LTTNG_DOMAIN_KERNEL;
		break;
	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
		domain_type = LTTNG_DOMAIN_NONE;
		break;
	}

	return domain_type;
}

static void lttng_event_rule_release(struct urcu_ref *ref)
{
	struct lttng_event_rule *event_rule =
		lttng::utils::container_of(ref, &lttng_event_rule::ref);

	LTTNG_ASSERT(event_rule->destroy);
	event_rule->destroy(event_rule);
}

void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
{
	lttng_event_rule_put(event_rule);
}

bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
{
	bool valid;

	if (!event_rule) {
		valid = false;
		goto end;
	}

	if (!event_rule->validate) {
		/* Sub-class guarantees that it can never be invalid. */
		valid = true;
		goto end;
	}

	valid = event_rule->validate(event_rule);
end:
	return valid;
}

int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
			       struct lttng_payload *payload)
{
	int ret;
	struct lttng_event_rule_comm event_rule_comm = {};

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

	event_rule_comm.event_rule_type = (int8_t) event_rule->type;

	ret = lttng_dynamic_buffer_append(
		&payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
	if (ret) {
		goto end;
	}

	ret = event_rule->serialize(event_rule, payload);
	if (ret) {
		goto end;
	}
end:
	return ret;
}

bool lttng_event_rule_is_equal(const struct lttng_event_rule *a, const struct lttng_event_rule *b)
{
	bool is_equal = false;

	if (!a || !b) {
		goto end;
	}

	if (a->type != b->type) {
		goto end;
	}

	if (a == b) {
		is_equal = true;
		goto end;
	}

	is_equal = a->equal ? a->equal(a, b) : true;
end:
	return is_equal;
}

ssize_t lttng_event_rule_create_from_payload(struct lttng_payload_view *view,
					     struct lttng_event_rule **event_rule)
{
	ssize_t ret, consumed = 0;
	event_rule_create_from_payload_cb create_from_payload = nullptr;
	const struct lttng_event_rule_comm *event_rule_comm;
	const struct lttng_payload_view event_rule_comm_view =
		lttng_payload_view_from_view(view, 0, sizeof(*event_rule_comm));

	if (!view || !event_rule) {
		ret = -1;
		goto end;
	}

	if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
		ret = -1;
		goto end;
	}

	DBG("Deserializing event_rule from payload");
	event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
	consumed += sizeof(*event_rule_comm);

	switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
		create_from_payload = lttng_event_rule_kernel_kprobe_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
		create_from_payload = lttng_event_rule_kernel_uprobe_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
		create_from_payload = lttng_event_rule_kernel_syscall_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
		create_from_payload = lttng_event_rule_kernel_tracepoint_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
		create_from_payload = lttng_event_rule_user_tracepoint_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
		create_from_payload = lttng_event_rule_jul_logging_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
		create_from_payload = lttng_event_rule_log4j_logging_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
		create_from_payload = lttng_event_rule_python_logging_create_from_payload;
		break;
	default:
		ERR("Attempted to create event rule of unknown type (%i)",
		    (int) event_rule_comm->event_rule_type);
		ret = -1;
		goto end;
	}

	LTTNG_ASSERT(create_from_payload);

	{
		struct lttng_payload_view child_view =
			lttng_payload_view_from_view(view, consumed, -1);

		ret = create_from_payload(&child_view, event_rule);
		if (ret < 0) {
			goto end;
		}

		consumed += ret;
	}

	if (!lttng_event_rule_validate(*event_rule)) {
		ret = -1;
		goto end;
	}

	ret = consumed;
end:
	return ret;
}

void lttng_event_rule_init(struct lttng_event_rule *event_rule, enum lttng_event_rule_type type)
{
	urcu_ref_init(&event_rule->ref);
	event_rule->type = type;
}

bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
{
	return urcu_ref_get_unless_zero(&event_rule->ref);
}

void lttng_event_rule_put(struct lttng_event_rule *event_rule)
{
	if (!event_rule) {
		return;
	}

	LTTNG_ASSERT(event_rule->ref.refcount);
	urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
}

enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(struct lttng_event_rule *rule,
					  const struct lttng_credentials *creds)
{
	LTTNG_ASSERT(rule->generate_filter_bytecode);
	return rule->generate_filter_bytecode(rule, creds);
}

const char *lttng_event_rule_get_filter(const struct lttng_event_rule *rule)
{
	LTTNG_ASSERT(rule->get_filter);
	return rule->get_filter(rule);
}

const struct lttng_bytecode *
lttng_event_rule_get_filter_bytecode(const struct lttng_event_rule *rule)
{
	LTTNG_ASSERT(rule->get_filter_bytecode);
	return rule->get_filter_bytecode(rule);
}

enum lttng_event_rule_generate_exclusions_status
lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
				     struct lttng_event_exclusion **exclusions)
{
	LTTNG_ASSERT(rule->generate_exclusions);
	return rule->generate_exclusions(rule, exclusions);
}

struct lttng_event *lttng_event_rule_generate_lttng_event(const struct lttng_event_rule *rule)
{
	LTTNG_ASSERT(rule->generate_lttng_event);
	return rule->generate_lttng_event(rule);
}

bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
{
	bool targets_agent_domain = false;
	enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);

	switch (type) {
	case LTTNG_DOMAIN_JUL:
	case LTTNG_DOMAIN_LOG4J:
	case LTTNG_DOMAIN_PYTHON:
		targets_agent_domain = true;
		break;
	case LTTNG_DOMAIN_UST:
	case LTTNG_DOMAIN_KERNEL:
		targets_agent_domain = false;
		break;
	default:
		abort();
	};

	return targets_agent_domain;
}

const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
{
	switch (type) {
	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
		return "unknown";
	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
		return "kernel syscall";
	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
		return "kernel kprobe";
	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
		return "kernel uprobe";
	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
		return "kernel tracepoint";
	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
		return "user tracepoint";
	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
		return "jul logging";
	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
		return "log4j logging";
	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
		return "python logging";

	default:
		abort();
	}
}

unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
{
	LTTNG_ASSERT(rule->hash);
	return rule->hash(rule);
}

enum lttng_error_code lttng_event_rule_mi_serialize(const struct lttng_event_rule *rule,
						    struct mi_writer *writer)
{
	int ret;
	enum lttng_error_code ret_code;

	LTTNG_ASSERT(rule);
	LTTNG_ASSERT(writer);
	LTTNG_ASSERT(rule->mi_serialize);

	/* Open event rule element. */
	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_event_rule);
	if (ret) {
		goto mi_error;
	}

	/* Serialize underlying event rule. */
	ret_code = rule->mi_serialize(rule, writer);
	if (ret_code != LTTNG_OK) {
		goto end;
	}

	/* Close event rule element. */
	ret = mi_lttng_writer_close_element(writer);
	if (ret) {
		goto mi_error;
	}

	ret_code = LTTNG_OK;
	goto end;

mi_error:
	ret_code = LTTNG_ERR_MI_IO_FAIL;
end:
	return ret_code;
}
Commit	Line	Data
7a3dcaf6 JR	1	/*
	2	* Copyright (C) 2019 Jonathan Rajotte
	3	* <jonathan.rajotte-julien@efficios.com>
	4	*
	5	* SPDX-License-Identifier: LGPL-2.1-only
	6	*
	7	*/
	8
c9e313bc SM	9	#include <common/error.hpp>
	10	#include <common/hashtable/hashtable.hpp>
	11	#include <common/hashtable/utils.hpp>
	12	#include <common/macros.hpp>
	13	#include <common/mi-lttng.hpp>
	14	#include <common/payload-view.hpp>
	15	#include <common/payload.hpp>
28ab034a	16
c9e313bc SM	17	#include <lttng/event-rule/event-rule-internal.hpp>
	18	#include <lttng/event-rule/jul-logging-internal.hpp>
	19	#include <lttng/event-rule/kernel-kprobe-internal.hpp>
	20	#include <lttng/event-rule/kernel-syscall-internal.hpp>
	21	#include <lttng/event-rule/kernel-tracepoint-internal.hpp>
	22	#include <lttng/event-rule/kernel-uprobe-internal.hpp>
	23	#include <lttng/event-rule/log4j-logging-internal.hpp>
	24	#include <lttng/event-rule/python-logging-internal.hpp>
	25	#include <lttng/event-rule/user-tracepoint-internal.hpp>
28ab034a	26
7a3dcaf6 JR	27	#include <stdbool.h>
7a3dcaf6 JR	28
28ab034a	29	enum lttng_event_rule_type lttng_event_rule_get_type(const struct lttng_event_rule *event_rule)
7a3dcaf6 JR	30	{
	31	return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
	32	}
	33
28ab034a	34	enum lttng_domain_type lttng_event_rule_get_domain_type(const struct lttng_event_rule *event_rule)
7a3dcaf6 JR	35	{
	36	enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
	37
	38	switch (lttng_event_rule_get_type(event_rule)) {
0a23a07d JR	39	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
	40	domain_type = LTTNG_DOMAIN_UST;
	41	break;
b47b01d8 JR	42	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
	43	domain_type = LTTNG_DOMAIN_JUL;
	44	break;
138d6838 JR	45	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
	46	domain_type = LTTNG_DOMAIN_LOG4J;
	47	break;
6530ec7d JR	48	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
	49	domain_type = LTTNG_DOMAIN_PYTHON;
	50	break;
4f7da553	51	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
85522de5	52	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
46fd07ac	53	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
af0818ef	54	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
7a3dcaf6 JR	55	domain_type = LTTNG_DOMAIN_KERNEL;
	56	break;
	57	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
	58	domain_type = LTTNG_DOMAIN_NONE;
	59	break;
	60	}
	61
	62	return domain_type;
	63	}
	64
	65	static void lttng_event_rule_release(struct urcu_ref *ref)
	66	{
	67	struct lttng_event_rule *event_rule =
28ab034a	68	lttng::utils::container_of(ref, &lttng_event_rule::ref);
7a3dcaf6	69
a0377dfe	70	LTTNG_ASSERT(event_rule->destroy);
7a3dcaf6 JR	71	event_rule->destroy(event_rule);
	72	}
	73
	74	void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
	75	{
	76	lttng_event_rule_put(event_rule);
	77	}
	78
7a3dcaf6 JR	79	bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
	80	{
	81	bool valid;
	82
	83	if (!event_rule) {
	84	valid = false;
	85	goto end;
	86	}
	87
	88	if (!event_rule->validate) {
	89	/* Sub-class guarantees that it can never be invalid. */
	90	valid = true;
	91	goto end;
	92	}
	93
	94	valid = event_rule->validate(event_rule);
	95	end:
	96	return valid;
	97	}
	98
7a3dcaf6	99	int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
28ab034a	100	struct lttng_payload *payload)
7a3dcaf6 JR	101	{
	102	int ret;
	103	struct lttng_event_rule_comm event_rule_comm = {};
	104
	105	if (!event_rule) {
	106	ret = -1;
	107	goto end;
	108	}
	109
	110	event_rule_comm.event_rule_type = (int8_t) event_rule->type;
	111
	112	ret = lttng_dynamic_buffer_append(
28ab034a	113	&payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
7a3dcaf6 JR	114	if (ret) {
	115	goto end;
	116	}
	117
	118	ret = event_rule->serialize(event_rule, payload);
	119	if (ret) {
	120	goto end;
	121	}
	122	end:
	123	return ret;
	124	}
	125
28ab034a	126	bool lttng_event_rule_is_equal(const struct lttng_event_rule a, const struct lttng_event_rule b)
7a3dcaf6 JR	127	{
	128	bool is_equal = false;
	129
	130	if (!a \|\| !b) {
	131	goto end;
	132	}
	133
	134	if (a->type != b->type) {
	135	goto end;
	136	}
	137
	138	if (a == b) {
	139	is_equal = true;
	140	goto end;
	141	}
	142
	143	is_equal = a->equal ? a->equal(a, b) : true;
	144	end:
	145	return is_equal;
	146	}
	147
28ab034a JG	148	ssize_t lttng_event_rule_create_from_payload(struct lttng_payload_view *view,
28ab034a JG	149	struct lttng_event_rule **event_rule)
7a3dcaf6 JR	150	{
7a3dcaf6 JR	151	ssize_t ret, consumed = 0;
cd9adb8b	152	event_rule_create_from_payload_cb create_from_payload = nullptr;
3e6e0df2 JG	153	const struct lttng_event_rule_comm *event_rule_comm;
3e6e0df2 JG	154	const struct lttng_payload_view event_rule_comm_view =
28ab034a	155	lttng_payload_view_from_view(view, 0, sizeof(*event_rule_comm));
7a3dcaf6 JR	156
	157	if (!view \|\| !event_rule) {
	158	ret = -1;
	159	goto end;
	160	}
	161
3e6e0df2 JG	162	if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
	163	ret = -1;
	164	goto end;
	165	}
	166
683d081a	167	DBG("Deserializing event_rule from payload");
3e6e0df2	168	event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
7a3dcaf6 JR	169	consumed += sizeof(*event_rule_comm);
	170
	171	switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
85522de5 JR	172	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
85522de5 JR	173	create_from_payload = lttng_event_rule_kernel_kprobe_create_from_payload;
7a3dcaf6	174	break;
46fd07ac JR	175	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
46fd07ac JR	176	create_from_payload = lttng_event_rule_kernel_uprobe_create_from_payload;
7a3dcaf6	177	break;
4f7da553	178	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
28ab034a	179	create_from_payload = lttng_event_rule_kernel_syscall_create_from_payload;
7a3dcaf6	180	break;
af0818ef	181	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
28ab034a	182	create_from_payload = lttng_event_rule_kernel_tracepoint_create_from_payload;
af0818ef	183	break;
0a23a07d	184	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
28ab034a	185	create_from_payload = lttng_event_rule_user_tracepoint_create_from_payload;
0a23a07d	186	break;
b47b01d8	187	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
28ab034a	188	create_from_payload = lttng_event_rule_jul_logging_create_from_payload;
b47b01d8	189	break;
138d6838	190	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
28ab034a	191	create_from_payload = lttng_event_rule_log4j_logging_create_from_payload;
138d6838	192	break;
6530ec7d	193	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
28ab034a	194	create_from_payload = lttng_event_rule_python_logging_create_from_payload;
6530ec7d	195	break;
7a3dcaf6 JR	196	default:
7a3dcaf6 JR	197	ERR("Attempted to create event rule of unknown type (%i)",
28ab034a	198	(int) event_rule_comm->event_rule_type);
7a3dcaf6 JR	199	ret = -1;
	200	goto end;
	201	}
	202
a0377dfe	203	LTTNG_ASSERT(create_from_payload);
7a3dcaf6 JR	204
	205	{
	206	struct lttng_payload_view child_view =
28ab034a	207	lttng_payload_view_from_view(view, consumed, -1);
7a3dcaf6 JR	208
	209	ret = create_from_payload(&child_view, event_rule);
	210	if (ret < 0) {
	211	goto end;
	212	}
	213
	214	consumed += ret;
	215	}
	216
	217	if (!lttng_event_rule_validate(*event_rule)) {
	218	ret = -1;
	219	goto end;
	220	}
	221
	222	ret = consumed;
	223	end:
	224	return ret;
	225	}
	226
28ab034a	227	void lttng_event_rule_init(struct lttng_event_rule *event_rule, enum lttng_event_rule_type type)
7a3dcaf6 JR	228	{
	229	urcu_ref_init(&event_rule->ref);
	230	event_rule->type = type;
	231	}
	232
7a3dcaf6 JR	233	bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
	234	{
	235	return urcu_ref_get_unless_zero(&event_rule->ref);
	236	}
	237
7a3dcaf6 JR	238	void lttng_event_rule_put(struct lttng_event_rule *event_rule)
	239	{
	240	if (!event_rule) {
	241	return;
	242	}
	243
a0377dfe	244	LTTNG_ASSERT(event_rule->ref.refcount);
7a3dcaf6 JR	245	urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
	246	}
	247
28ab034a JG	248	enum lttng_error_code
	249	lttng_event_rule_generate_filter_bytecode(struct lttng_event_rule *rule,
	250	const struct lttng_credentials *creds)
7a3dcaf6	251	{
a0377dfe	252	LTTNG_ASSERT(rule->generate_filter_bytecode);
58daac01	253	return rule->generate_filter_bytecode(rule, creds);
7a3dcaf6 JR	254	}
7a3dcaf6 JR	255
7a3dcaf6 JR	256	const char lttng_event_rule_get_filter(const struct lttng_event_rule rule)
7a3dcaf6 JR	257	{
a0377dfe	258	LTTNG_ASSERT(rule->get_filter);
7a3dcaf6 JR	259	return rule->get_filter(rule);
	260	}
	261
28ab034a JG	262	const struct lttng_bytecode *
28ab034a JG	263	lttng_event_rule_get_filter_bytecode(const struct lttng_event_rule *rule)
7a3dcaf6	264	{
a0377dfe	265	LTTNG_ASSERT(rule->get_filter_bytecode);
7a3dcaf6 JR	266	return rule->get_filter_bytecode(rule);
	267	}
	268
993578ff JR	269	enum lttng_event_rule_generate_exclusions_status
993578ff JR	270	lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
28ab034a	271	struct lttng_event_exclusion **exclusions)
7a3dcaf6	272	{
a0377dfe	273	LTTNG_ASSERT(rule->generate_exclusions);
993578ff	274	return rule->generate_exclusions(rule, exclusions);
7a3dcaf6 JR	275	}
7a3dcaf6 JR	276
28ab034a	277	struct lttng_event lttng_event_rule_generate_lttng_event(const struct lttng_event_rule rule)
44760c20	278	{
a0377dfe	279	LTTNG_ASSERT(rule->generate_lttng_event);
44760c20 JR	280	return rule->generate_lttng_event(rule);
	281	}
	282
44760c20 JR	283	bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
	284	{
	285	bool targets_agent_domain = false;
	286	enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);
	287
	288	switch (type) {
	289	case LTTNG_DOMAIN_JUL:
	290	case LTTNG_DOMAIN_LOG4J:
	291	case LTTNG_DOMAIN_PYTHON:
	292	targets_agent_domain = true;
	293	break;
	294	case LTTNG_DOMAIN_UST:
	295	case LTTNG_DOMAIN_KERNEL:
	296	targets_agent_domain = false;
	297	break;
	298	default:
	299	abort();
	300	};
	301
	302	return targets_agent_domain;
	303	}
	304
7a3dcaf6 JR	305	const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
	306	{
	307	switch (type) {
	308	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
	309	return "unknown";
4f7da553 JR	310	case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
4f7da553 JR	311	return "kernel syscall";
85522de5 JR	312	case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
85522de5 JR	313	return "kernel kprobe";
46fd07ac JR	314	case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
46fd07ac JR	315	return "kernel uprobe";
af0818ef JR	316	case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
af0818ef JR	317	return "kernel tracepoint";
0a23a07d JR	318	case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
0a23a07d JR	319	return "user tracepoint";
b47b01d8 JR	320	case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
b47b01d8 JR	321	return "jul logging";
138d6838 JR	322	case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
138d6838 JR	323	return "log4j logging";
6530ec7d JR	324	case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
	325	return "python logging";
	326
7a3dcaf6 JR	327	default:
	328	abort();
	329	}
	330	}
959e3c66	331
959e3c66 JR	332	unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
959e3c66 JR	333	{
a0377dfe	334	LTTNG_ASSERT(rule->hash);
959e3c66 JR	335	return rule->hash(rule);
959e3c66 JR	336	}
6a751b95	337
28ab034a JG	338	enum lttng_error_code lttng_event_rule_mi_serialize(const struct lttng_event_rule *rule,
28ab034a JG	339	struct mi_writer *writer)
6a751b95 JR	340	{
	341	int ret;
	342	enum lttng_error_code ret_code;
	343
a0377dfe FD	344	LTTNG_ASSERT(rule);
	345	LTTNG_ASSERT(writer);
	346	LTTNG_ASSERT(rule->mi_serialize);
6a751b95 JR	347
	348	/* Open event rule element. */
	349	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_event_rule);
	350	if (ret) {
	351	goto mi_error;
	352	}
	353
	354	/* Serialize underlying event rule. */
	355	ret_code = rule->mi_serialize(rule, writer);
	356	if (ret_code != LTTNG_OK) {
	357	goto end;
	358	}
	359
	360	/* Close event rule element. */
	361	ret = mi_lttng_writer_close_element(writer);
	362	if (ret) {
	363	goto mi_error;
	364	}
	365
	366	ret_code = LTTNG_OK;
	367	goto end;
	368
	369	mi_error:
	370	ret_code = LTTNG_ERR_MI_IO_FAIL;
	371	end:
	372	return ret_code;
	373	}