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

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

#include <common/credentials.h>
#include <common/error.h>
#include <common/hashtable/hashtable.h>
#include <common/hashtable/utils.h>
#include <common/macros.h>
#include <common/mi-lttng.h>
#include <common/optional.h>
#include <common/payload-view.h>
#include <common/payload.h>
#include <common/runas.h>
#include <common/string-utils/string-utils.h>
#include <lttng/event-rule/event-rule-internal.h>
#include <lttng/event-rule/kernel-tracepoint-internal.h>
#include <lttng/event.h>

#define IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \
	(lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT)

static void lttng_event_rule_kernel_tracepoint_destroy(struct lttng_event_rule *rule)
{
	struct lttng_event_rule_kernel_tracepoint *tracepoint;

	if (rule == NULL) {
		return;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);

	free(tracepoint->pattern);
	free(tracepoint->filter_expression);
	free(tracepoint->internal_filter.filter);
	free(tracepoint->internal_filter.bytecode);
	free(tracepoint);
}

static bool lttng_event_rule_kernel_tracepoint_validate(
		const struct lttng_event_rule *rule)
{
	bool valid = false;
	struct lttng_event_rule_kernel_tracepoint *tracepoint;

	if (!rule) {
		goto end;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);

	/* Required field. */
	if (!tracepoint->pattern) {
		ERR("Invalid kernel tracepoint event rule: a pattern must be set.");
		goto end;
	}

	valid = true;
end:
	return valid;
}

static int lttng_event_rule_kernel_tracepoint_serialize(
		const struct lttng_event_rule *rule,
		struct lttng_payload *payload)
{
	int ret;
	size_t pattern_len, filter_expression_len;
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	struct lttng_event_rule_kernel_tracepoint_comm tracepoint_comm;

	if (!rule || !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule)) {
		ret = -1;
		goto end;
	}

	DBG("Serializing kernel tracepoint event rule.");
	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);

	pattern_len = strlen(tracepoint->pattern) + 1;

	if (tracepoint->filter_expression != NULL) {
		filter_expression_len =
				strlen(tracepoint->filter_expression) + 1;
	} else {
		filter_expression_len = 0;
	}

	tracepoint_comm.pattern_len = pattern_len;
	tracepoint_comm.filter_expression_len = filter_expression_len;

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

	ret = lttng_dynamic_buffer_append(
			&payload->buffer, tracepoint->pattern, pattern_len);
	if (ret) {
		goto end;
	}

	ret = lttng_dynamic_buffer_append(&payload->buffer, tracepoint->filter_expression,
			filter_expression_len);
	if (ret) {
		goto end;
	}

end:
	return ret;
}

static bool lttng_event_rule_kernel_tracepoint_is_equal(
		const struct lttng_event_rule *_a,
		const struct lttng_event_rule *_b)
{
	bool is_equal = false;
	struct lttng_event_rule_kernel_tracepoint *a, *b;

	a = container_of(_a, struct lttng_event_rule_kernel_tracepoint, parent);
	b = container_of(_b, struct lttng_event_rule_kernel_tracepoint, parent);

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

	/* Long check. */
	LTTNG_ASSERT(a->pattern);
	LTTNG_ASSERT(b->pattern);
	if (strcmp(a->pattern, b->pattern)) {
		goto end;
	}

	if (a->filter_expression && b->filter_expression) {
		if (strcmp(a->filter_expression, b->filter_expression)) {
			goto end;
		}
	} else if (!!a->filter_expression != !!b->filter_expression) {
		/* One is set; not the other. */
		goto end;
	}

	is_equal = true;
end:
	return is_equal;
}

static enum lttng_error_code
lttng_event_rule_kernel_tracepoint_generate_filter_bytecode(
		struct lttng_event_rule *rule,
		const struct lttng_credentials *creds)
{
	int ret;
	enum lttng_error_code ret_code;
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	enum lttng_event_rule_status status;
	const char *filter;
	struct lttng_bytecode *bytecode = NULL;

	LTTNG_ASSERT(rule);

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);

	status = lttng_event_rule_kernel_tracepoint_get_filter(rule, &filter);
	if (status == LTTNG_EVENT_RULE_STATUS_UNSET) {
		filter = NULL;
	} else if (status != LTTNG_EVENT_RULE_STATUS_OK) {
		ret_code = LTTNG_ERR_FILTER_INVAL;
		goto end;
	}

	if (filter && filter[0] == '\0') {
		ret_code = LTTNG_ERR_FILTER_INVAL;
		goto error;
	}

	if (filter) {
		tracepoint->internal_filter.filter = strdup(filter);
		if (tracepoint->internal_filter.filter == NULL) {
			ret_code = LTTNG_ERR_NOMEM;
			goto error;
		}
	} else {
		tracepoint->internal_filter.filter = NULL;
	}

	if (tracepoint->internal_filter.filter == NULL) {
		ret_code = LTTNG_OK;
		goto end;
	}

	ret = run_as_generate_filter_bytecode(
			tracepoint->internal_filter.filter, creds,
			&bytecode);
	if (ret) {
		ret_code = LTTNG_ERR_FILTER_INVAL;
		goto end;
	}

	tracepoint->internal_filter.bytecode = bytecode;
	bytecode = NULL;
	ret_code = LTTNG_OK;

error:
end:
	free(bytecode);
	return ret_code;
}

static const char *lttng_event_rule_kernel_tracepoint_get_internal_filter(
		const struct lttng_event_rule *rule)
{
	struct lttng_event_rule_kernel_tracepoint *tracepoint;

	LTTNG_ASSERT(rule);
	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	return tracepoint->internal_filter.filter;
}

static const struct lttng_bytecode *
lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode(
		const struct lttng_event_rule *rule)
{
	struct lttng_event_rule_kernel_tracepoint *tracepoint;

	LTTNG_ASSERT(rule);
	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	return tracepoint->internal_filter.bytecode;
}

static enum lttng_event_rule_generate_exclusions_status
lttng_event_rule_kernel_tracepoint_generate_exclusions(
		const struct lttng_event_rule *rule,
		struct lttng_event_exclusion **_exclusions)
{
	/* Unsupported. */
	*_exclusions = NULL;
	return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE;
}

static unsigned long lttng_event_rule_kernel_tracepoint_hash(
		const struct lttng_event_rule *rule)
{
	unsigned long hash;
	struct lttng_event_rule_kernel_tracepoint *tp_rule =
			container_of(rule, typeof(*tp_rule), parent);

	hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT,
			lttng_ht_seed);
	hash ^= hash_key_str(tp_rule->pattern, lttng_ht_seed);

	if (tp_rule->filter_expression) {
		hash ^= hash_key_str(tp_rule->filter_expression, lttng_ht_seed);
	}

	return hash;
}

static enum lttng_error_code lttng_event_rule_kernel_tracepoint_mi_serialize(
		const struct lttng_event_rule *rule, struct mi_writer *writer)
{
	int ret;
	enum lttng_error_code ret_code;
	enum lttng_event_rule_status status;
	const char *filter = NULL;
	const char *name_pattern = NULL;

	LTTNG_ASSERT(rule);
	LTTNG_ASSERT(writer);
	LTTNG_ASSERT(IS_KERNEL_TRACEPOINT_EVENT_RULE(rule));

	status = lttng_event_rule_kernel_tracepoint_get_name_pattern(
			rule, &name_pattern);
	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
	LTTNG_ASSERT(name_pattern);

	status = lttng_event_rule_kernel_tracepoint_get_filter(rule, &filter);
	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK ||
			status == LTTNG_EVENT_RULE_STATUS_UNSET);

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

	/* Name pattern. */
	ret = mi_lttng_writer_write_element_string(writer,
			mi_lttng_element_event_rule_name_pattern, name_pattern);
	if (ret) {
		goto mi_error;
	}

	/* Filter. */
	if (filter != NULL) {
		ret = mi_lttng_writer_write_element_string(writer,
				mi_lttng_element_event_rule_filter_expression,
				filter);
		if (ret) {
			goto mi_error;
		}
	}

	/* Close event rule kernel tracepoint 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;
}

struct lttng_event_rule *lttng_event_rule_kernel_tracepoint_create(void)
{
	struct lttng_event_rule *rule = NULL;
	struct lttng_event_rule_kernel_tracepoint *tp_rule;
	enum lttng_event_rule_status status;

	tp_rule = (lttng_event_rule_kernel_tracepoint *) zmalloc(sizeof(struct lttng_event_rule_kernel_tracepoint));
	if (!tp_rule) {
		goto end;
	}

	rule = &tp_rule->parent;
	lttng_event_rule_init(&tp_rule->parent, LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT);
	tp_rule->parent.validate = lttng_event_rule_kernel_tracepoint_validate;
	tp_rule->parent.serialize = lttng_event_rule_kernel_tracepoint_serialize;
	tp_rule->parent.equal = lttng_event_rule_kernel_tracepoint_is_equal;
	tp_rule->parent.destroy = lttng_event_rule_kernel_tracepoint_destroy;
	tp_rule->parent.generate_filter_bytecode =
			lttng_event_rule_kernel_tracepoint_generate_filter_bytecode;
	tp_rule->parent.get_filter =
			lttng_event_rule_kernel_tracepoint_get_internal_filter;
	tp_rule->parent.get_filter_bytecode =
			lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode;
	tp_rule->parent.generate_exclusions =
			lttng_event_rule_kernel_tracepoint_generate_exclusions;
	tp_rule->parent.hash = lttng_event_rule_kernel_tracepoint_hash;
	tp_rule->parent.mi_serialize = lttng_event_rule_kernel_tracepoint_mi_serialize;

	/* Not necessary for now. */
	tp_rule->parent.generate_lttng_event = NULL;

	/* Default pattern is '*'. */
	status = lttng_event_rule_kernel_tracepoint_set_name_pattern(rule, "*");
	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
		lttng_event_rule_destroy(rule);
		rule = NULL;
	}

end:
	return rule;
}

ssize_t lttng_event_rule_kernel_tracepoint_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_event_rule **_event_rule)
{
	ssize_t ret, offset = 0;
	enum lttng_event_rule_status status;
	const struct lttng_event_rule_kernel_tracepoint_comm *tracepoint_comm;
	const char *pattern;
	const char *filter_expression = NULL;
	struct lttng_buffer_view current_buffer_view;
	struct lttng_event_rule *rule = NULL;

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

	current_buffer_view = lttng_buffer_view_from_view(
			&view->buffer, offset, sizeof(*tracepoint_comm));
	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
		ERR("Failed to initialize from malformed event rule kernel tracepoint: buffer too short to contain header.");
		ret = -1;
		goto end;
	}

	tracepoint_comm = (typeof(tracepoint_comm)) current_buffer_view.data;

	/* Skip to payload. */
	offset += current_buffer_view.size;

	/* Map the pattern. */
	current_buffer_view = lttng_buffer_view_from_view(
			&view->buffer, offset, tracepoint_comm->pattern_len);

	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
		ret = -1;
		goto end;
	}

	pattern = current_buffer_view.data;
	if (!lttng_buffer_view_contains_string(&current_buffer_view, pattern,
			tracepoint_comm->pattern_len)) {
		ret = -1;
		goto end;
	}

	/* Skip after the pattern. */
	offset += tracepoint_comm->pattern_len;

	if (!tracepoint_comm->filter_expression_len) {
		goto skip_filter_expression;
	}

	/* Map the filter_expression. */
	current_buffer_view = lttng_buffer_view_from_view(&view->buffer, offset,
			tracepoint_comm->filter_expression_len);
	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
		ret = -1;
		goto end;
	}

	filter_expression = current_buffer_view.data;
	if (!lttng_buffer_view_contains_string(&current_buffer_view,
			filter_expression,
			tracepoint_comm->filter_expression_len)) {
		ret = -1;
		goto end;
	}

	/* Skip after the pattern. */
	offset += tracepoint_comm->filter_expression_len;

skip_filter_expression:

	rule = lttng_event_rule_kernel_tracepoint_create();
	if (!rule) {
		ERR("Failed to create event rule kernel tracepoint.");
		ret = -1;
		goto end;
	}

	status = lttng_event_rule_kernel_tracepoint_set_name_pattern(rule, pattern);
	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
		ERR("Failed to set event rule kernel tracepoint pattern.");
		ret = -1;
		goto end;
	}

	if (filter_expression) {
		status = lttng_event_rule_kernel_tracepoint_set_filter(
				rule, filter_expression);
		if (status != LTTNG_EVENT_RULE_STATUS_OK) {
			ERR("Failed to set event rule kernel tracepoint pattern.");
			ret = -1;
			goto end;
		}
	}

	*_event_rule = rule;
	rule = NULL;
	ret = offset;
end:
	lttng_event_rule_destroy(rule);
	return ret;
}

enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_name_pattern(
		struct lttng_event_rule *rule, const char *pattern)
{
	char *pattern_copy = NULL;
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) || !pattern ||
			strlen(pattern) == 0) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	pattern_copy = strdup(pattern);
	if (!pattern_copy) {
		status = LTTNG_EVENT_RULE_STATUS_ERROR;
		goto end;
	}

	/* Normalize the pattern. */
	strutils_normalize_star_glob_pattern(pattern_copy);

	free(tracepoint->pattern);

	tracepoint->pattern = pattern_copy;
	pattern_copy = NULL;
end:
	return status;
}

enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_name_pattern(
		const struct lttng_event_rule *rule, const char **pattern)
{
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) || !pattern) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	if (!tracepoint->pattern) {
		status = LTTNG_EVENT_RULE_STATUS_UNSET;
		goto end;
	}

	*pattern = tracepoint->pattern;
end:
	return status;
}

enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_filter(
		struct lttng_event_rule *rule, const char *expression)
{
	char *expression_copy = NULL;
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) || !expression ||
			strlen(expression) == 0) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	expression_copy = strdup(expression);
	if (!expression_copy) {
		PERROR("Failed to copy filter expression");
		status = LTTNG_EVENT_RULE_STATUS_ERROR;
		goto end;
	}

	if (tracepoint->filter_expression) {
		free(tracepoint->filter_expression);
	}

	tracepoint->filter_expression = expression_copy;
	expression_copy = NULL;
end:
	return status;
}

enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_filter(
		const struct lttng_event_rule *rule, const char **expression)
{
	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) || !expression) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	tracepoint = container_of(
			rule, struct lttng_event_rule_kernel_tracepoint, parent);
	if (!tracepoint->filter_expression) {
		status = LTTNG_EVENT_RULE_STATUS_UNSET;
		goto end;
	}

	*expression = tracepoint->filter_expression;
end:
	return status;
}
Commit	Line	Data
af0818ef JR	1	/*
	2	* Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
af0818ef JR	8	#include <common/credentials.h>
af0818ef JR	9	#include <common/error.h>
6a751b95 JR	10	#include <common/hashtable/hashtable.h>
6a751b95 JR	11	#include <common/hashtable/utils.h>
af0818ef	12	#include <common/macros.h>
6a751b95	13	#include <common/mi-lttng.h>
af0818ef	14	#include <common/optional.h>
af0818ef	15	#include <common/payload-view.h>
6a751b95	16	#include <common/payload.h>
af0818ef	17	#include <common/runas.h>
af0818ef JR	18	#include <common/string-utils/string-utils.h>
	19	#include <lttng/event-rule/event-rule-internal.h>
	20	#include <lttng/event-rule/kernel-tracepoint-internal.h>
	21	#include <lttng/event.h>
	22
	23	#define IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \
	24	(lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT)
	25
	26	static void lttng_event_rule_kernel_tracepoint_destroy(struct lttng_event_rule *rule)
	27	{
	28	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	29
	30	if (rule == NULL) {
	31	return;
	32	}
	33
	34	tracepoint = container_of(
	35	rule, struct lttng_event_rule_kernel_tracepoint, parent);
	36
	37	free(tracepoint->pattern);
	38	free(tracepoint->filter_expression);
	39	free(tracepoint->internal_filter.filter);
	40	free(tracepoint->internal_filter.bytecode);
	41	free(tracepoint);
	42	}
	43
	44	static bool lttng_event_rule_kernel_tracepoint_validate(
	45	const struct lttng_event_rule *rule)
	46	{
	47	bool valid = false;
	48	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	49
	50	if (!rule) {
	51	goto end;
	52	}
	53
	54	tracepoint = container_of(
	55	rule, struct lttng_event_rule_kernel_tracepoint, parent);
	56
	57	/* Required field. */
	58	if (!tracepoint->pattern) {
	59	ERR("Invalid kernel tracepoint event rule: a pattern must be set.");
	60	goto end;
	61	}
	62
	63	valid = true;
	64	end:
	65	return valid;
	66	}
	67
	68	static int lttng_event_rule_kernel_tracepoint_serialize(
	69	const struct lttng_event_rule *rule,
	70	struct lttng_payload *payload)
	71	{
	72	int ret;
	73	size_t pattern_len, filter_expression_len;
	74	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	75	struct lttng_event_rule_kernel_tracepoint_comm tracepoint_comm;
	76
	77	if (!rule \|\| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule)) {
	78	ret = -1;
	79	goto end;
	80	}
	81
82	DBG("Serializing kernel tracepoint event rule.");
83	tracepoint = container_of(
84	rule, struct lttng_event_rule_kernel_tracepoint, parent);
85
86	pattern_len = strlen(tracepoint->pattern) + 1;
87
88	if (tracepoint->filter_expression != NULL) {
89	filter_expression_len =
90	strlen(tracepoint->filter_expression) + 1;
91	} else {
92	filter_expression_len = 0;
93	}
94
95	tracepoint_comm.pattern_len = pattern_len;
96	tracepoint_comm.filter_expression_len = filter_expression_len;
97
98	ret = lttng_dynamic_buffer_append(&payload->buffer, &tracepoint_comm,
99	sizeof(tracepoint_comm));
100	if (ret) {
101	goto end;
102	}
103
104	ret = lttng_dynamic_buffer_append(
105	&payload->buffer, tracepoint->pattern, pattern_len);
106	if (ret) {
107	goto end;
108	}
109
110	ret = lttng_dynamic_buffer_append(&payload->buffer, tracepoint->filter_expression,
111	filter_expression_len);
112	if (ret) {
113	goto end;
114	}
115
116	end:
117	return ret;
118	}
119
120	static bool lttng_event_rule_kernel_tracepoint_is_equal(
121	const struct lttng_event_rule *_a,
122	const struct lttng_event_rule *_b)
123	{
124	bool is_equal = false;
125	struct lttng_event_rule_kernel_tracepoint a, b;
126
127	a = container_of(_a, struct lttng_event_rule_kernel_tracepoint, parent);
128	b = container_of(_b, struct lttng_event_rule_kernel_tracepoint, parent);
129
130	if (!!a->filter_expression != !!b->filter_expression) {
131	goto end;
132	}
133
134	/* Long check. */
a0377dfe FD	135	LTTNG_ASSERT(a->pattern);
a0377dfe FD	136	LTTNG_ASSERT(b->pattern);
af0818ef JR	137	if (strcmp(a->pattern, b->pattern)) {
	138	goto end;
	139	}
	140
	141	if (a->filter_expression && b->filter_expression) {
	142	if (strcmp(a->filter_expression, b->filter_expression)) {
	143	goto end;
	144	}
	145	} else if (!!a->filter_expression != !!b->filter_expression) {
	146	/* One is set; not the other. */
	147	goto end;
	148	}
	149
	150	is_equal = true;
	151	end:
	152	return is_equal;
	153	}
	154
	155	static enum lttng_error_code
	156	lttng_event_rule_kernel_tracepoint_generate_filter_bytecode(
	157	struct lttng_event_rule *rule,
	158	const struct lttng_credentials *creds)
	159	{
	160	int ret;
	161	enum lttng_error_code ret_code;
	162	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	163	enum lttng_event_rule_status status;
	164	const char *filter;
	165	struct lttng_bytecode *bytecode = NULL;
	166
a0377dfe	167	LTTNG_ASSERT(rule);
af0818ef JR	168
	169	tracepoint = container_of(
	170	rule, struct lttng_event_rule_kernel_tracepoint, parent);
	171
	172	status = lttng_event_rule_kernel_tracepoint_get_filter(rule, &filter);
	173	if (status == LTTNG_EVENT_RULE_STATUS_UNSET) {
	174	filter = NULL;
	175	} else if (status != LTTNG_EVENT_RULE_STATUS_OK) {
	176	ret_code = LTTNG_ERR_FILTER_INVAL;
	177	goto end;
	178	}
	179
	180	if (filter && filter[0] == '\0') {
	181	ret_code = LTTNG_ERR_FILTER_INVAL;
	182	goto error;
	183	}
	184
	185	if (filter) {
	186	tracepoint->internal_filter.filter = strdup(filter);
	187	if (tracepoint->internal_filter.filter == NULL) {
	188	ret_code = LTTNG_ERR_NOMEM;
	189	goto error;
	190	}
	191	} else {
	192	tracepoint->internal_filter.filter = NULL;
	193	}
	194
	195	if (tracepoint->internal_filter.filter == NULL) {
	196	ret_code = LTTNG_OK;
	197	goto end;
	198	}
	199
	200	ret = run_as_generate_filter_bytecode(
	201	tracepoint->internal_filter.filter, creds,
	202	&bytecode);
	203	if (ret) {
	204	ret_code = LTTNG_ERR_FILTER_INVAL;
	205	goto end;
	206	}
	207
	208	tracepoint->internal_filter.bytecode = bytecode;
	209	bytecode = NULL;
	210	ret_code = LTTNG_OK;
	211
	212	error:
	213	end:
	214	free(bytecode);
	215	return ret_code;
	216	}
	217
	218	static const char *lttng_event_rule_kernel_tracepoint_get_internal_filter(
	219	const struct lttng_event_rule *rule)
	220	{
	221	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	222
a0377dfe	223	LTTNG_ASSERT(rule);
af0818ef JR	224	tracepoint = container_of(
	225	rule, struct lttng_event_rule_kernel_tracepoint, parent);
	226	return tracepoint->internal_filter.filter;
	227	}
	228
	229	static const struct lttng_bytecode *
	230	lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode(
	231	const struct lttng_event_rule *rule)
	232	{
	233	struct lttng_event_rule_kernel_tracepoint *tracepoint;
	234
a0377dfe	235	LTTNG_ASSERT(rule);
af0818ef JR	236	tracepoint = container_of(
	237	rule, struct lttng_event_rule_kernel_tracepoint, parent);
	238	return tracepoint->internal_filter.bytecode;
	239	}
	240
	241	static enum lttng_event_rule_generate_exclusions_status
	242	lttng_event_rule_kernel_tracepoint_generate_exclusions(
	243	const struct lttng_event_rule *rule,
	244	struct lttng_event_exclusion **_exclusions)
	245	{
	246	/* Unsupported. */
	247	*_exclusions = NULL;
	248	return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE;
	249	}
	250
	251	static unsigned long lttng_event_rule_kernel_tracepoint_hash(
	252	const struct lttng_event_rule *rule)
	253	{
	254	unsigned long hash;
	255	struct lttng_event_rule_kernel_tracepoint *tp_rule =
	256	container_of(rule, typeof(*tp_rule), parent);
	257
	258	hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT,
	259	lttng_ht_seed);
	260	hash ^= hash_key_str(tp_rule->pattern, lttng_ht_seed);
	261
	262	if (tp_rule->filter_expression) {
	263	hash ^= hash_key_str(tp_rule->filter_expression, lttng_ht_seed);
	264	}
	265
	266	return hash;
	267	}
	268
6a751b95 JR	269	static enum lttng_error_code lttng_event_rule_kernel_tracepoint_mi_serialize(
	270	const struct lttng_event_rule rule, struct mi_writer writer)
	271	{
	272	int ret;
	273	enum lttng_error_code ret_code;
	274	enum lttng_event_rule_status status;
	275	const char *filter = NULL;
	276	const char *name_pattern = NULL;
	277
a0377dfe FD	278	LTTNG_ASSERT(rule);
	279	LTTNG_ASSERT(writer);
	280	LTTNG_ASSERT(IS_KERNEL_TRACEPOINT_EVENT_RULE(rule));
6a751b95 JR	281
	282	status = lttng_event_rule_kernel_tracepoint_get_name_pattern(
	283	rule, &name_pattern);
a0377dfe FD	284	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
a0377dfe FD	285	LTTNG_ASSERT(name_pattern);
6a751b95 JR	286
6a751b95 JR	287	status = lttng_event_rule_kernel_tracepoint_get_filter(rule, &filter);
a0377dfe	288	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK \|\|
6a751b95 JR	289	status == LTTNG_EVENT_RULE_STATUS_UNSET);
	290
	291	/* Open event rule kernel tracepoint element. */
	292	ret = mi_lttng_writer_open_element(
	293	writer, mi_lttng_element_event_rule_kernel_tracepoint);
	294	if (ret) {
	295	goto mi_error;
	296	}
	297
	298	/* Name pattern. */
	299	ret = mi_lttng_writer_write_element_string(writer,
	300	mi_lttng_element_event_rule_name_pattern, name_pattern);
	301	if (ret) {
	302	goto mi_error;
	303	}
	304
	305	/* Filter. */
	306	if (filter != NULL) {
	307	ret = mi_lttng_writer_write_element_string(writer,
	308	mi_lttng_element_event_rule_filter_expression,
	309	filter);
	310	if (ret) {
	311	goto mi_error;
	312	}
	313	}
	314
	315	/* Close event rule kernel tracepoint element. */
	316	ret = mi_lttng_writer_close_element(writer);
	317	if (ret) {
	318	goto mi_error;
	319	}
	320
	321	ret_code = LTTNG_OK;
	322	goto end;
	323
	324	mi_error:
	325	ret_code = LTTNG_ERR_MI_IO_FAIL;
	326	end:
	327	return ret_code;
	328	}
	329
af0818ef JR	330	struct lttng_event_rule *lttng_event_rule_kernel_tracepoint_create(void)
	331	{
	332	struct lttng_event_rule *rule = NULL;
	333	struct lttng_event_rule_kernel_tracepoint *tp_rule;
	334	enum lttng_event_rule_status status;
	335
a6bc4ca9	336	tp_rule = (lttng_event_rule_kernel_tracepoint *) zmalloc(sizeof(struct lttng_event_rule_kernel_tracepoint));
af0818ef JR	337	if (!tp_rule) {
	338	goto end;
	339	}
	340
	341	rule = &tp_rule->parent;
	342	lttng_event_rule_init(&tp_rule->parent, LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT);
	343	tp_rule->parent.validate = lttng_event_rule_kernel_tracepoint_validate;
	344	tp_rule->parent.serialize = lttng_event_rule_kernel_tracepoint_serialize;
	345	tp_rule->parent.equal = lttng_event_rule_kernel_tracepoint_is_equal;
	346	tp_rule->parent.destroy = lttng_event_rule_kernel_tracepoint_destroy;
	347	tp_rule->parent.generate_filter_bytecode =
	348	lttng_event_rule_kernel_tracepoint_generate_filter_bytecode;
	349	tp_rule->parent.get_filter =
	350	lttng_event_rule_kernel_tracepoint_get_internal_filter;
	351	tp_rule->parent.get_filter_bytecode =
	352	lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode;
	353	tp_rule->parent.generate_exclusions =
	354	lttng_event_rule_kernel_tracepoint_generate_exclusions;
	355	tp_rule->parent.hash = lttng_event_rule_kernel_tracepoint_hash;
6a751b95	356	tp_rule->parent.mi_serialize = lttng_event_rule_kernel_tracepoint_mi_serialize;
af0818ef JR	357
	358	/* Not necessary for now. */
	359	tp_rule->parent.generate_lttng_event = NULL;
	360
	361	/* Default pattern is ''. /
	362	status = lttng_event_rule_kernel_tracepoint_set_name_pattern(rule, "*");
	363	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
	364	lttng_event_rule_destroy(rule);
	365	rule = NULL;
	366	}
	367
	368	end:
	369	return rule;
	370	}
	371
af0818ef JR	372	ssize_t lttng_event_rule_kernel_tracepoint_create_from_payload(
	373	struct lttng_payload_view *view,
	374	struct lttng_event_rule **_event_rule)
	375	{
	376	ssize_t ret, offset = 0;
	377	enum lttng_event_rule_status status;
	378	const struct lttng_event_rule_kernel_tracepoint_comm *tracepoint_comm;
	379	const char *pattern;
	380	const char *filter_expression = NULL;
	381	struct lttng_buffer_view current_buffer_view;
	382	struct lttng_event_rule *rule = NULL;
	383
	384	if (!_event_rule) {
	385	ret = -1;
	386	goto end;
	387	}
	388
	389	current_buffer_view = lttng_buffer_view_from_view(
	390	&view->buffer, offset, sizeof(*tracepoint_comm));
	391	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
	392	ERR("Failed to initialize from malformed event rule kernel tracepoint: buffer too short to contain header.");
	393	ret = -1;
	394	goto end;
	395	}
	396
	397	tracepoint_comm = (typeof(tracepoint_comm)) current_buffer_view.data;
	398
	399	/* Skip to payload. */
	400	offset += current_buffer_view.size;
	401
	402	/* Map the pattern. */
	403	current_buffer_view = lttng_buffer_view_from_view(
	404	&view->buffer, offset, tracepoint_comm->pattern_len);
	405
	406	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
	407	ret = -1;
	408	goto end;
	409	}
	410
	411	pattern = current_buffer_view.data;
	412	if (!lttng_buffer_view_contains_string(&current_buffer_view, pattern,
	413	tracepoint_comm->pattern_len)) {
	414	ret = -1;
	415	goto end;
	416	}
	417
	418	/* Skip after the pattern. */
	419	offset += tracepoint_comm->pattern_len;
	420
	421	if (!tracepoint_comm->filter_expression_len) {
	422	goto skip_filter_expression;
	423	}
	424
	425	/* Map the filter_expression. */
	426	current_buffer_view = lttng_buffer_view_from_view(&view->buffer, offset,
	427	tracepoint_comm->filter_expression_len);
	428	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
	429	ret = -1;
	430	goto end;
	431	}
	432
	433	filter_expression = current_buffer_view.data;
	434	if (!lttng_buffer_view_contains_string(&current_buffer_view,
	435	filter_expression,
436	tracepoint_comm->filter_expression_len)) {
437	ret = -1;
438	goto end;
439	}
440
441	/* Skip after the pattern. */
442	offset += tracepoint_comm->filter_expression_len;
443
444	skip_filter_expression:
445
446	rule = lttng_event_rule_kernel_tracepoint_create();
447	if (!rule) {
448	ERR("Failed to create event rule kernel tracepoint.");
449	ret = -1;
450	goto end;
451	}
452
453	status = lttng_event_rule_kernel_tracepoint_set_name_pattern(rule, pattern);
454	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
455	ERR("Failed to set event rule kernel tracepoint pattern.");
456	ret = -1;
457	goto end;
458	}
459
460	if (filter_expression) {
461	status = lttng_event_rule_kernel_tracepoint_set_filter(
462	rule, filter_expression);
463	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
464	ERR("Failed to set event rule kernel tracepoint pattern.");
465	ret = -1;
466	goto end;
467	}
468	}
469
470	*_event_rule = rule;
471	rule = NULL;
472	ret = offset;
473	end:
474	lttng_event_rule_destroy(rule);
475	return ret;
476	}
477
478	enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_name_pattern(
479	struct lttng_event_rule rule, const char pattern)
480	{
481	char *pattern_copy = NULL;
482	struct lttng_event_rule_kernel_tracepoint *tracepoint;
483	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
484
485	if (!rule \|\| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \|\| !pattern \|\|
486	strlen(pattern) == 0) {
487	status = LTTNG_EVENT_RULE_STATUS_INVALID;
488	goto end;
489	}
490
491	tracepoint = container_of(
492	rule, struct lttng_event_rule_kernel_tracepoint, parent);
493	pattern_copy = strdup(pattern);
494	if (!pattern_copy) {
495	status = LTTNG_EVENT_RULE_STATUS_ERROR;
496	goto end;
497	}
498
499	/* Normalize the pattern. */
500	strutils_normalize_star_glob_pattern(pattern_copy);
501
502	free(tracepoint->pattern);
503
504	tracepoint->pattern = pattern_copy;
505	pattern_copy = NULL;
506	end:
507	return status;
508	}
509
510	enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_name_pattern(
511	const struct lttng_event_rule rule, const char *pattern)
512	{
513	struct lttng_event_rule_kernel_tracepoint *tracepoint;
514	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
515
516	if (!rule \|\| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \|\| !pattern) {
517	status = LTTNG_EVENT_RULE_STATUS_INVALID;
518	goto end;
519	}
520
521	tracepoint = container_of(
522	rule, struct lttng_event_rule_kernel_tracepoint, parent);
523	if (!tracepoint->pattern) {
524	status = LTTNG_EVENT_RULE_STATUS_UNSET;
525	goto end;
526	}
527
528	*pattern = tracepoint->pattern;
529	end:
530	return status;
531	}
532
533	enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_filter(
534	struct lttng_event_rule rule, const char expression)
535	{
536	char *expression_copy = NULL;
537	struct lttng_event_rule_kernel_tracepoint *tracepoint;
538	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
539
540	if (!rule \|\| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \|\| !expression \|\|
541	strlen(expression) == 0) {
542	status = LTTNG_EVENT_RULE_STATUS_INVALID;
543	goto end;
544	}
545
546	tracepoint = container_of(
547	rule, struct lttng_event_rule_kernel_tracepoint, parent);
548	expression_copy = strdup(expression);
549	if (!expression_copy) {
550	PERROR("Failed to copy filter expression");
551	status = LTTNG_EVENT_RULE_STATUS_ERROR;
552	goto end;
553	}
554
555	if (tracepoint->filter_expression) {
556	free(tracepoint->filter_expression);
557	}
558
559	tracepoint->filter_expression = expression_copy;
560	expression_copy = NULL;
561	end:
562	return status;
563	}
564
565	enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_filter(
566	const struct lttng_event_rule rule, const char *expression)
567	{
568	struct lttng_event_rule_kernel_tracepoint *tracepoint;
569	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
570
571	if (!rule \|\| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \|\| !expression) {
572	status = LTTNG_EVENT_RULE_STATUS_INVALID;
573	goto end;
574	}
575
576	tracepoint = container_of(
577	rule, struct lttng_event_rule_kernel_tracepoint, parent);
578	if (!tracepoint->filter_expression) {
579	status = LTTNG_EVENT_RULE_STATUS_UNSET;
580	goto end;
581	}
582
583	*expression = tracepoint->filter_expression;
584	end:
585	return status;
586	}