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

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

#include <assert.h>
#include <common/error.h>
#include <common/macros.h>
#include <common/payload.h>
#include <common/payload-view.h>
#include <common/hashtable/hashtable.h>
#include <common/hashtable/utils.h>
#include <lttng/event-rule/event-rule-internal.h>
#include <lttng/event-rule/kprobe-internal.h>
#include <lttng/event-rule/syscall-internal.h>
#include <lttng/event-rule/tracepoint-internal.h>
#include <lttng/event-rule/uprobe-internal.h>
#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;
}

LTTNG_HIDDEN
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_TRACEPOINT:
	{
		enum lttng_event_rule_status status;
		status = lttng_event_rule_tracepoint_get_domain_type(event_rule, &domain_type);
		assert(status == LTTNG_EVENT_RULE_STATUS_OK);
		break;
	}
	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
	case LTTNG_EVENT_RULE_TYPE_KPROBE:
	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
	case LTTNG_EVENT_RULE_TYPE_UPROBE:
		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 =
			container_of(ref, typeof(*event_rule), ref);

	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);
}

LTTNG_HIDDEN
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;
}

LTTNG_HIDDEN
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;
}

LTTNG_HIDDEN
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;
}

LTTNG_HIDDEN
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 = NULL;
	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_TRACEPOINT:
		create_from_payload =
				lttng_event_rule_tracepoint_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_KPROBE:
		create_from_payload = lttng_event_rule_kprobe_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
		/* TODO */
		break;
	case LTTNG_EVENT_RULE_TYPE_UPROBE:
		create_from_payload = lttng_event_rule_uprobe_create_from_payload;
		break;
	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
		create_from_payload =
				lttng_event_rule_syscall_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;
	}

	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;
}

LTTNG_HIDDEN
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;
}

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

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

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

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

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

LTTNG_HIDDEN
const struct lttng_filter_bytecode *lttng_event_rule_get_filter_bytecode(
		const struct lttng_event_rule *rule)
{
	assert(rule->get_filter_bytecode);
	return rule->get_filter_bytecode(rule);
}

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

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

LTTNG_HIDDEN
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_TRACEPOINT:
		return "tracepoint";
	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
		return "syscall";
	case LTTNG_EVENT_RULE_TYPE_KPROBE:
		return "probe";
	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
		return "function";
	case LTTNG_EVENT_RULE_TYPE_UPROBE:
		return "userspace-probe";
	default:
		abort();
	}
}

LTTNG_HIDDEN
unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
{
	assert(rule->hash);
	return rule->hash(rule);
}
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
	9	#include <assert.h>
	10	#include <common/error.h>
	11	#include <common/macros.h>
	12	#include <common/payload.h>
	13	#include <common/payload-view.h>
959e3c66 JR	14	#include <common/hashtable/hashtable.h>
959e3c66 JR	15	#include <common/hashtable/utils.h>
7a3dcaf6	16	#include <lttng/event-rule/event-rule-internal.h>
077192fd	17	#include <lttng/event-rule/kprobe-internal.h>
e6a39346	18	#include <lttng/event-rule/syscall-internal.h>
6d420eff	19	#include <lttng/event-rule/tracepoint-internal.h>
df08d338	20	#include <lttng/event-rule/uprobe-internal.h>
7a3dcaf6 JR	21	#include <stdbool.h>
	22
	23	enum lttng_event_rule_type lttng_event_rule_get_type(
	24	const struct lttng_event_rule *event_rule)
	25	{
	26	return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
	27	}
	28
	29	LTTNG_HIDDEN
	30	enum lttng_domain_type lttng_event_rule_get_domain_type(
	31	const struct lttng_event_rule *event_rule)
	32	{
	33	enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
	34
	35	switch (lttng_event_rule_get_type(event_rule)) {
	36	case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
6d420eff JR	37	{
	38	enum lttng_event_rule_status status;
	39	status = lttng_event_rule_tracepoint_get_domain_type(event_rule, &domain_type);
	40	assert(status == LTTNG_EVENT_RULE_STATUS_OK);
7a3dcaf6	41	break;
6d420eff	42	}
7a3dcaf6 JR	43	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
	44	case LTTNG_EVENT_RULE_TYPE_KPROBE:
	45	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
	46	case LTTNG_EVENT_RULE_TYPE_UPROBE:
	47	domain_type = LTTNG_DOMAIN_KERNEL;
	48	break;
	49	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
	50	domain_type = LTTNG_DOMAIN_NONE;
	51	break;
	52	}
	53
	54	return domain_type;
	55	}
	56
	57	static void lttng_event_rule_release(struct urcu_ref *ref)
	58	{
	59	struct lttng_event_rule *event_rule =
	60	container_of(ref, typeof(*event_rule), ref);
	61
	62	assert(event_rule->destroy);
	63	event_rule->destroy(event_rule);
	64	}
	65
	66	void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
	67	{
	68	lttng_event_rule_put(event_rule);
	69	}
	70
	71	LTTNG_HIDDEN
	72	bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
	73	{
	74	bool valid;
	75
	76	if (!event_rule) {
	77	valid = false;
	78	goto end;
	79	}
	80
	81	if (!event_rule->validate) {
	82	/* Sub-class guarantees that it can never be invalid. */
	83	valid = true;
	84	goto end;
	85	}
	86
	87	valid = event_rule->validate(event_rule);
	88	end:
	89	return valid;
	90	}
	91
	92	LTTNG_HIDDEN
	93	int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
	94	struct lttng_payload *payload)
	95	{
	96	int ret;
	97	struct lttng_event_rule_comm event_rule_comm = {};
	98
	99	if (!event_rule) {
	100	ret = -1;
	101	goto end;
	102	}
	103
	104	event_rule_comm.event_rule_type = (int8_t) event_rule->type;
	105
	106	ret = lttng_dynamic_buffer_append(
107	&payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
108	if (ret) {
109	goto end;
110	}
111
112	ret = event_rule->serialize(event_rule, payload);
113	if (ret) {
114	goto end;
115	}
116	end:
117	return ret;
118	}
119
120	LTTNG_HIDDEN
121	bool lttng_event_rule_is_equal(const struct lttng_event_rule *a,
122	const struct lttng_event_rule *b)
123	{
124	bool is_equal = false;
125
126	if (!a \|\| !b) {
127	goto end;
128	}
129
130	if (a->type != b->type) {
131	goto end;
132	}
133
134	if (a == b) {
135	is_equal = true;
136	goto end;
137	}
138
139	is_equal = a->equal ? a->equal(a, b) : true;
140	end:
141	return is_equal;
142	}
143
144	LTTNG_HIDDEN
145	ssize_t lttng_event_rule_create_from_payload(
146	struct lttng_payload_view *view,
147	struct lttng_event_rule **event_rule)
148	{
149	ssize_t ret, consumed = 0;
7a3dcaf6	150	event_rule_create_from_payload_cb create_from_payload = NULL;
3e6e0df2 JG	151	const struct lttng_event_rule_comm *event_rule_comm;
	152	const struct lttng_payload_view event_rule_comm_view =
	153	lttng_payload_view_from_view(
	154	view, 0, sizeof(*event_rule_comm));
7a3dcaf6 JR	155
	156	if (!view \|\| !event_rule) {
	157	ret = -1;
	158	goto end;
	159	}
	160
3e6e0df2 JG	161	if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
	162	ret = -1;
	163	goto end;
	164	}
	165
683d081a	166	DBG("Deserializing event_rule from payload");
3e6e0df2	167	event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
7a3dcaf6 JR	168	consumed += sizeof(*event_rule_comm);
	169
	170	switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
	171	case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
6d420eff JR	172	create_from_payload =
6d420eff JR	173	lttng_event_rule_tracepoint_create_from_payload;
7a3dcaf6 JR	174	break;
7a3dcaf6 JR	175	case LTTNG_EVENT_RULE_TYPE_KPROBE:
077192fd	176	create_from_payload = lttng_event_rule_kprobe_create_from_payload;
7a3dcaf6 JR	177	break;
	178	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
	179	/* TODO */
	180	break;
	181	case LTTNG_EVENT_RULE_TYPE_UPROBE:
df08d338	182	create_from_payload = lttng_event_rule_uprobe_create_from_payload;
7a3dcaf6 JR	183	break;
7a3dcaf6 JR	184	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
e6a39346 JR	185	create_from_payload =
e6a39346 JR	186	lttng_event_rule_syscall_create_from_payload;
7a3dcaf6 JR	187	break;
	188	default:
	189	ERR("Attempted to create event rule of unknown type (%i)",
	190	(int) event_rule_comm->event_rule_type);
	191	ret = -1;
	192	goto end;
	193	}
	194
	195	assert(create_from_payload);
	196
	197	{
	198	struct lttng_payload_view child_view =
	199	lttng_payload_view_from_view(
	200	view, consumed, -1);
	201
	202	ret = create_from_payload(&child_view, event_rule);
	203	if (ret < 0) {
	204	goto end;
	205	}
	206
	207	consumed += ret;
	208	}
	209
	210	if (!lttng_event_rule_validate(*event_rule)) {
	211	ret = -1;
	212	goto end;
	213	}
	214
	215	ret = consumed;
	216	end:
	217	return ret;
	218	}
	219
	220	LTTNG_HIDDEN
	221	void lttng_event_rule_init(struct lttng_event_rule *event_rule,
	222	enum lttng_event_rule_type type)
	223	{
	224	urcu_ref_init(&event_rule->ref);
	225	event_rule->type = type;
	226	}
	227
	228	LTTNG_HIDDEN
	229	bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
	230	{
	231	return urcu_ref_get_unless_zero(&event_rule->ref);
	232	}
	233
	234	LTTNG_HIDDEN
	235	void lttng_event_rule_put(struct lttng_event_rule *event_rule)
	236	{
	237	if (!event_rule) {
	238	return;
	239	}
	240
	241	assert(event_rule->ref.refcount);
	242	urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
	243	}
	244
	245	LTTNG_HIDDEN
	246	enum lttng_error_code lttng_event_rule_generate_filter_bytecode(
58daac01 JR	247	struct lttng_event_rule *rule,
58daac01 JR	248	const struct lttng_credentials *creds)
7a3dcaf6 JR	249	{
7a3dcaf6 JR	250	assert(rule->generate_filter_bytecode);
58daac01	251	return rule->generate_filter_bytecode(rule, creds);
7a3dcaf6 JR	252	}
	253
	254	LTTNG_HIDDEN
	255	const char lttng_event_rule_get_filter(const struct lttng_event_rule rule)
	256	{
	257	assert(rule->get_filter);
	258	return rule->get_filter(rule);
	259	}
	260
	261	LTTNG_HIDDEN
	262	const struct lttng_filter_bytecode *lttng_event_rule_get_filter_bytecode(
	263	const struct lttng_event_rule *rule)
	264	{
	265	assert(rule->get_filter_bytecode);
	266	return rule->get_filter_bytecode(rule);
	267	}
	268
	269	LTTNG_HIDDEN
993578ff JR	270	enum lttng_event_rule_generate_exclusions_status
	271	lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
	272	struct lttng_event_exclusion **exclusions)
7a3dcaf6 JR	273	{
7a3dcaf6 JR	274	assert(rule->generate_exclusions);
993578ff	275	return rule->generate_exclusions(rule, exclusions);
7a3dcaf6 JR	276	}
	277
	278	LTTNG_HIDDEN
44760c20 JR	279	struct lttng_event *lttng_event_rule_generate_lttng_event(
	280	const struct lttng_event_rule *rule)
	281	{
	282	assert(rule->generate_lttng_event);
	283	return rule->generate_lttng_event(rule);
	284	}
	285
	286	LTTNG_HIDDEN
	287	bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
	288	{
	289	bool targets_agent_domain = false;
	290	enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);
	291
	292	switch (type) {
	293	case LTTNG_DOMAIN_JUL:
	294	case LTTNG_DOMAIN_LOG4J:
	295	case LTTNG_DOMAIN_PYTHON:
	296	targets_agent_domain = true;
	297	break;
	298	case LTTNG_DOMAIN_UST:
	299	case LTTNG_DOMAIN_KERNEL:
	300	targets_agent_domain = false;
	301	break;
	302	default:
	303	abort();
	304	};
	305
	306	return targets_agent_domain;
	307	}
	308
7a3dcaf6 JR	309	const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
	310	{
	311	switch (type) {
	312	case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
	313	return "unknown";
	314	case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
	315	return "tracepoint";
	316	case LTTNG_EVENT_RULE_TYPE_SYSCALL:
	317	return "syscall";
	318	case LTTNG_EVENT_RULE_TYPE_KPROBE:
	319	return "probe";
	320	case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
	321	return "function";
	322	case LTTNG_EVENT_RULE_TYPE_UPROBE:
	323	return "userspace-probe";
	324	default:
	325	abort();
	326	}
	327	}
959e3c66 JR	328
	329	LTTNG_HIDDEN
	330	unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
	331	{
	332	assert(rule->hash);
	333	return rule->hash(rule);
	334	}