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

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

#include <common/credentials.hpp>
#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 <common/runas.hpp>
#include <lttng/event-rule/event-rule-internal.hpp>
#include <lttng/event-rule/kernel-uprobe-internal.hpp>
#include <lttng/userspace-probe-internal.hpp>

#define IS_UPROBE_EVENT_RULE(rule) \
	(lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE)

static void lttng_event_rule_kernel_uprobe_destroy(struct lttng_event_rule *rule)
{
	struct lttng_event_rule_kernel_uprobe *uprobe;

	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);

	lttng_userspace_probe_location_destroy(uprobe->location);
	free(uprobe->name);
	free(uprobe);
}

static bool lttng_event_rule_kernel_uprobe_validate(
		const struct lttng_event_rule *rule)
{
	bool valid = false;
	struct lttng_event_rule_kernel_uprobe *uprobe;

	if (!rule) {
		goto end;
	}

	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);

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

	if (!uprobe->location) {
		ERR("Invalid uprobe event rule: a location must be set.");
		goto end;
	}

	valid = true;
end:
	return valid;
}

static int lttng_event_rule_kernel_uprobe_serialize(
		const struct lttng_event_rule *rule,
		struct lttng_payload *payload)
{
	int ret;
	size_t name_len, header_offset, size_before_probe;
	struct lttng_event_rule_kernel_uprobe *uprobe;
	struct lttng_event_rule_kernel_uprobe_comm uprobe_comm = {};
	struct lttng_event_rule_kernel_uprobe_comm *header;

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

	header_offset = payload->buffer.size;

	DBG("Serializing uprobe event rule.");
	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);

	name_len = strlen(uprobe->name) + 1;

	uprobe_comm.name_len = name_len;

	ret = lttng_dynamic_buffer_append(
			&payload->buffer, &uprobe_comm, sizeof(uprobe_comm));
	if (ret) {
		goto end;
	}
	ret = lttng_dynamic_buffer_append(
			&payload->buffer, uprobe->name, name_len);
	if (ret) {
		goto end;
	}

	size_before_probe = payload->buffer.size;

	/* This serialize return the size taken in the buffer. */
	ret = lttng_userspace_probe_location_serialize(
			uprobe->location, payload);
	if (ret < 0) {
		goto end;
	}

	/* Update the header regarding the probe size. */
	header = (struct lttng_event_rule_kernel_uprobe_comm
					*) ((char *) payload->buffer.data +
			header_offset);
	header->location_len = payload->buffer.size - size_before_probe;

	ret = 0;

end:
	return ret;
}

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

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

	/* uprobe is invalid if this is not true. */
	LTTNG_ASSERT(a->name);
	LTTNG_ASSERT(b->name);
	if (strcmp(a->name, b->name)) {
		goto end;
	}

	LTTNG_ASSERT(a->location);
	LTTNG_ASSERT(b->location);
	is_equal = lttng_userspace_probe_location_is_equal(
			a->location, b->location);
end:
	return is_equal;
}

static enum lttng_error_code lttng_event_rule_kernel_uprobe_generate_filter_bytecode(
		struct lttng_event_rule *rule __attribute__((unused)),
		const struct lttng_credentials *creds __attribute__((unused)))
{
	/* Nothing to do. */
	return LTTNG_OK;
}

static const char *lttng_event_rule_kernel_uprobe_get_filter(
		const struct lttng_event_rule *rule __attribute__((unused)))
{
	/* Unsupported. */
	return NULL;
}

static const struct lttng_bytecode *
lttng_event_rule_kernel_uprobe_get_filter_bytecode(
		const struct lttng_event_rule *rule __attribute__((unused)))
{
	/* Unsupported. */
	return NULL;
}

static enum lttng_event_rule_generate_exclusions_status
lttng_event_rule_kernel_uprobe_generate_exclusions(
		const struct lttng_event_rule *rule __attribute__((unused)),
		struct lttng_event_exclusion **exclusions)
{
	/* Unsupported. */
	*exclusions = NULL;
	return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE;
}

static unsigned long
lttng_event_rule_kernel_uprobe_hash(
		const struct lttng_event_rule *rule)
{
	unsigned long hash;
	struct lttng_event_rule_kernel_uprobe *urule =
			container_of(rule, typeof(*urule), parent);

	hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE,
			lttng_ht_seed);
	hash ^= hash_key_str(urule->name, lttng_ht_seed);
	hash ^= lttng_userspace_probe_location_hash(urule->location);

	return hash;
}

static
int userspace_probe_set_location(
		struct lttng_event_rule_kernel_uprobe *uprobe,
		const struct lttng_userspace_probe_location *location)
{
	int ret;
	struct lttng_userspace_probe_location *location_copy = NULL;

	if (!uprobe || !location || uprobe->location) {
		ret = -1;
		goto end;
	}

	location_copy = lttng_userspace_probe_location_copy(location);
	if (!location_copy) {
		ret = -1;
		goto end;
	}

	uprobe->location = location_copy;
	location_copy = NULL;
	ret = 0;
end:
	lttng_userspace_probe_location_destroy(location_copy);
	return ret;
}

static enum lttng_error_code lttng_event_rule_kernel_uprobe_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 *event_name = NULL;
	const struct lttng_userspace_probe_location *location = NULL;

	LTTNG_ASSERT(rule);
	LTTNG_ASSERT(writer);
	LTTNG_ASSERT(IS_UPROBE_EVENT_RULE(rule));

	status = lttng_event_rule_kernel_uprobe_get_event_name(
			rule, &event_name);
	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
	LTTNG_ASSERT(event_name);

	status = lttng_event_rule_kernel_uprobe_get_location(rule, &location);
	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
	LTTNG_ASSERT(location);

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

	/* Event name. */
	ret = mi_lttng_writer_write_element_string(writer,
			mi_lttng_element_event_rule_event_name, event_name);
	if (ret) {
		goto mi_error;
	}

	/* Probe location. */
	ret_code = lttng_userspace_probe_location_mi_serialize(location, writer);
	if (ret_code != LTTNG_OK) {
		goto end;
	}

	/* Close event rule kernel uprobe 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_uprobe_create(
		const struct lttng_userspace_probe_location *location)
{
	struct lttng_event_rule *rule = NULL;
	struct lttng_event_rule_kernel_uprobe *urule;

	urule = (lttng_event_rule_kernel_uprobe *) zmalloc(sizeof(struct lttng_event_rule_kernel_uprobe));
	if (!urule) {
		goto end;
	}

	rule = &urule->parent;
	lttng_event_rule_init(&urule->parent, LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE);
	urule->parent.validate = lttng_event_rule_kernel_uprobe_validate;
	urule->parent.serialize = lttng_event_rule_kernel_uprobe_serialize;
	urule->parent.equal = lttng_event_rule_kernel_uprobe_is_equal;
	urule->parent.destroy = lttng_event_rule_kernel_uprobe_destroy;
	urule->parent.generate_filter_bytecode =
			lttng_event_rule_kernel_uprobe_generate_filter_bytecode;
	urule->parent.get_filter = lttng_event_rule_kernel_uprobe_get_filter;
	urule->parent.get_filter_bytecode =
			lttng_event_rule_kernel_uprobe_get_filter_bytecode;
	urule->parent.generate_exclusions =
			lttng_event_rule_kernel_uprobe_generate_exclusions;
	urule->parent.hash = lttng_event_rule_kernel_uprobe_hash;
	urule->parent.mi_serialize = lttng_event_rule_kernel_uprobe_mi_serialize;

	if (userspace_probe_set_location(urule, location)) {
		lttng_event_rule_destroy(rule);
		rule = NULL;
	}

end:
	return rule;
}

ssize_t lttng_event_rule_kernel_uprobe_create_from_payload(
		struct lttng_payload_view *view,
		struct lttng_event_rule **_event_rule)
{
	ssize_t ret, offset = 0;
	const struct lttng_event_rule_kernel_uprobe_comm *uprobe_comm;
	const char *name;
	struct lttng_buffer_view current_buffer_view;
	struct lttng_event_rule *rule = NULL;
	struct lttng_userspace_probe_location *location = NULL;
	enum lttng_event_rule_status status;

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

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

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

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

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

	name = current_buffer_view.data;
	if (!lttng_buffer_view_contains_string(&current_buffer_view, name,
			uprobe_comm->name_len)) {
		ret = -1;
		goto end;
	}

	/* Skip after the name. */
	offset += uprobe_comm->name_len;

	/* Map the location. */
	{
		struct lttng_payload_view current_payload_view =
				lttng_payload_view_from_view(view, offset,
						uprobe_comm->location_len);

		if (!lttng_payload_view_is_valid(&current_payload_view)) {
			ERR("Failed to initialize from malformed event rule uprobe: buffer too short to contain location");
			ret = -1;
			goto end;
		}

		ret = lttng_userspace_probe_location_create_from_payload(
				&current_payload_view, &location);
		if (ret < 0) {
			ret = -1;
			goto end;
		}
	}

	LTTNG_ASSERT(ret == uprobe_comm->location_len);

	/* Skip after the location. */
	offset += uprobe_comm->location_len;

	rule = lttng_event_rule_kernel_uprobe_create(location);
	if (!rule) {
		ERR("Failed to create event rule uprobe.");
		ret = -1;
		goto end;
	}

	status = lttng_event_rule_kernel_uprobe_set_event_name(rule, name);
	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
		ret = -1;
		goto end;
	}

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

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


enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_get_location(
		const struct lttng_event_rule *rule,
		const struct lttng_userspace_probe_location **location)
{
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_UPROBE_EVENT_RULE(rule) || !location) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	*location = lttng_event_rule_kernel_uprobe_get_location_mutable(rule);
	if (!*location) {
		status = LTTNG_EVENT_RULE_STATUS_UNSET;
		goto end;
	}

end:
	return status;
}

struct lttng_userspace_probe_location *
lttng_event_rule_kernel_uprobe_get_location_mutable(
		const struct lttng_event_rule *rule)
{
	struct lttng_event_rule_kernel_uprobe *uprobe;

	LTTNG_ASSERT(rule);
	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);

	return uprobe->location;
}

enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_set_event_name(
		struct lttng_event_rule *rule, const char *name)
{
	char *name_copy = NULL;
	struct lttng_event_rule_kernel_uprobe *uprobe;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

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

	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
	name_copy = strdup(name);
	if (!name_copy) {
		status = LTTNG_EVENT_RULE_STATUS_ERROR;
		goto end;
	}

	if (uprobe->name) {
		free(uprobe->name);
	}

	uprobe->name = name_copy;
	name_copy = NULL;
end:
	return status;
}

enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_get_event_name(
		const struct lttng_event_rule *rule, const char **name)
{
	struct lttng_event_rule_kernel_uprobe *uprobe;
	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;

	if (!rule || !IS_UPROBE_EVENT_RULE(rule) || !name) {
		status = LTTNG_EVENT_RULE_STATUS_INVALID;
		goto end;
	}

	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
	if (!uprobe->name) {
		status = LTTNG_EVENT_RULE_STATUS_UNSET;
		goto end;
	}

	*name = uprobe->name;
end:
	return status;
}
Commit	Line	Data
df08d338 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
c9e313bc SM	8	#include <common/credentials.hpp>
	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>
	16	#include <common/runas.hpp>
	17	#include <lttng/event-rule/event-rule-internal.hpp>
	18	#include <lttng/event-rule/kernel-uprobe-internal.hpp>
	19	#include <lttng/userspace-probe-internal.hpp>
df08d338 JR	20
df08d338 JR	21	#define IS_UPROBE_EVENT_RULE(rule) \
46fd07ac	22	(lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE)
df08d338	23
46fd07ac	24	static void lttng_event_rule_kernel_uprobe_destroy(struct lttng_event_rule *rule)
df08d338	25	{
46fd07ac	26	struct lttng_event_rule_kernel_uprobe *uprobe;
df08d338	27
46fd07ac	28	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	29
	30	lttng_userspace_probe_location_destroy(uprobe->location);
	31	free(uprobe->name);
	32	free(uprobe);
	33	}
	34
46fd07ac	35	static bool lttng_event_rule_kernel_uprobe_validate(
df08d338 JR	36	const struct lttng_event_rule *rule)
	37	{
	38	bool valid = false;
46fd07ac	39	struct lttng_event_rule_kernel_uprobe *uprobe;
df08d338 JR	40
	41	if (!rule) {
	42	goto end;
	43	}
	44
46fd07ac	45	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	46
	47	/* Required field. */
	48	if (!uprobe->name) {
	49	ERR("Invalid uprobe event rule: a pattern must be set.");
	50	goto end;
	51	}
	52
	53	if (!uprobe->location) {
	54	ERR("Invalid uprobe event rule: a location must be set.");
	55	goto end;
	56	}
	57
	58	valid = true;
	59	end:
	60	return valid;
	61	}
	62
46fd07ac	63	static int lttng_event_rule_kernel_uprobe_serialize(
df08d338 JR	64	const struct lttng_event_rule *rule,
	65	struct lttng_payload *payload)
	66	{
	67	int ret;
	68	size_t name_len, header_offset, size_before_probe;
46fd07ac JR	69	struct lttng_event_rule_kernel_uprobe *uprobe;
	70	struct lttng_event_rule_kernel_uprobe_comm uprobe_comm = {};
	71	struct lttng_event_rule_kernel_uprobe_comm *header;
df08d338 JR	72
	73	if (!rule \|\| !IS_UPROBE_EVENT_RULE(rule)) {
	74	ret = -1;
	75	goto end;
	76	}
	77
	78	header_offset = payload->buffer.size;
	79
	80	DBG("Serializing uprobe event rule.");
46fd07ac	81	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	82
	83	name_len = strlen(uprobe->name) + 1;
	84
	85	uprobe_comm.name_len = name_len;
	86
	87	ret = lttng_dynamic_buffer_append(
	88	&payload->buffer, &uprobe_comm, sizeof(uprobe_comm));
	89	if (ret) {
	90	goto end;
	91	}
	92	ret = lttng_dynamic_buffer_append(
	93	&payload->buffer, uprobe->name, name_len);
	94	if (ret) {
	95	goto end;
	96	}
	97
	98	size_before_probe = payload->buffer.size;
	99
	100	/* This serialize return the size taken in the buffer. */
	101	ret = lttng_userspace_probe_location_serialize(
	102	uprobe->location, payload);
	103	if (ret < 0) {
	104	goto end;
	105	}
	106
	107	/* Update the header regarding the probe size. */
46fd07ac	108	header = (struct lttng_event_rule_kernel_uprobe_comm
df08d338 JR	109	) ((char ) payload->buffer.data +
	110	header_offset);
	111	header->location_len = payload->buffer.size - size_before_probe;
	112
	113	ret = 0;
	114
	115	end:
	116	return ret;
	117	}
	118
46fd07ac	119	static bool lttng_event_rule_kernel_uprobe_is_equal(const struct lttng_event_rule *_a,
df08d338 JR	120	const struct lttng_event_rule *_b)
	121	{
	122	bool is_equal = false;
46fd07ac	123	struct lttng_event_rule_kernel_uprobe a, b;
df08d338	124
46fd07ac JR	125	a = container_of(_a, struct lttng_event_rule_kernel_uprobe, parent);
46fd07ac JR	126	b = container_of(_b, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	127
df08d338 JR	128	/* uprobe is invalid if this is not true. */
a0377dfe FD	129	LTTNG_ASSERT(a->name);
a0377dfe FD	130	LTTNG_ASSERT(b->name);
df08d338 JR	131	if (strcmp(a->name, b->name)) {
	132	goto end;
	133	}
	134
a0377dfe FD	135	LTTNG_ASSERT(a->location);
a0377dfe FD	136	LTTNG_ASSERT(b->location);
df08d338 JR	137	is_equal = lttng_userspace_probe_location_is_equal(
	138	a->location, b->location);
	139	end:
	140	return is_equal;
	141	}
	142
46fd07ac	143	static enum lttng_error_code lttng_event_rule_kernel_uprobe_generate_filter_bytecode(
f46376a1 MJ	144	struct lttng_event_rule *rule __attribute__((unused)),
f46376a1 MJ	145	const struct lttng_credentials *creds __attribute__((unused)))
df08d338 JR	146	{
	147	/* Nothing to do. */
	148	return LTTNG_OK;
	149	}
	150
46fd07ac	151	static const char *lttng_event_rule_kernel_uprobe_get_filter(
f46376a1	152	const struct lttng_event_rule *rule __attribute__((unused)))
df08d338 JR	153	{
	154	/* Unsupported. */
	155	return NULL;
	156	}
	157
2b00d462	158	static const struct lttng_bytecode *
f46376a1 MJ	159	lttng_event_rule_kernel_uprobe_get_filter_bytecode(
f46376a1 MJ	160	const struct lttng_event_rule *rule __attribute__((unused)))
df08d338 JR	161	{
	162	/* Unsupported. */
	163	return NULL;
	164	}
	165
993578ff	166	static enum lttng_event_rule_generate_exclusions_status
f46376a1 MJ	167	lttng_event_rule_kernel_uprobe_generate_exclusions(
f46376a1 MJ	168	const struct lttng_event_rule *rule __attribute__((unused)),
993578ff	169	struct lttng_event_exclusion **exclusions)
df08d338 JR	170	{
df08d338 JR	171	/* Unsupported. */
993578ff JR	172	*exclusions = NULL;
993578ff JR	173	return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE;
df08d338 JR	174	}
df08d338 JR	175
959e3c66	176	static unsigned long
46fd07ac	177	lttng_event_rule_kernel_uprobe_hash(
959e3c66 JR	178	const struct lttng_event_rule *rule)
	179	{
	180	unsigned long hash;
46fd07ac	181	struct lttng_event_rule_kernel_uprobe *urule =
959e3c66 JR	182	container_of(rule, typeof(*urule), parent);
959e3c66 JR	183
46fd07ac	184	hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE,
959e3c66 JR	185	lttng_ht_seed);
	186	hash ^= hash_key_str(urule->name, lttng_ht_seed);
	187	hash ^= lttng_userspace_probe_location_hash(urule->location);
	188
	189	return hash;
	190	}
	191
10685de6 JR	192	static
10685de6 JR	193	int userspace_probe_set_location(
46fd07ac	194	struct lttng_event_rule_kernel_uprobe *uprobe,
10685de6 JR	195	const struct lttng_userspace_probe_location *location)
	196	{
	197	int ret;
	198	struct lttng_userspace_probe_location *location_copy = NULL;
	199
	200	if (!uprobe \|\| !location \|\| uprobe->location) {
	201	ret = -1;
	202	goto end;
	203	}
	204
	205	location_copy = lttng_userspace_probe_location_copy(location);
	206	if (!location_copy) {
	207	ret = -1;
	208	goto end;
	209	}
	210
	211	uprobe->location = location_copy;
	212	location_copy = NULL;
	213	ret = 0;
	214	end:
	215	lttng_userspace_probe_location_destroy(location_copy);
	216	return ret;
	217	}
	218
6a751b95 JR	219	static enum lttng_error_code lttng_event_rule_kernel_uprobe_mi_serialize(
	220	const struct lttng_event_rule rule, struct mi_writer writer)
	221	{
	222	int ret;
	223	enum lttng_error_code ret_code;
	224	enum lttng_event_rule_status status;
	225	const char *event_name = NULL;
	226	const struct lttng_userspace_probe_location *location = NULL;
	227
a0377dfe FD	228	LTTNG_ASSERT(rule);
	229	LTTNG_ASSERT(writer);
	230	LTTNG_ASSERT(IS_UPROBE_EVENT_RULE(rule));
6a751b95 JR	231
	232	status = lttng_event_rule_kernel_uprobe_get_event_name(
	233	rule, &event_name);
a0377dfe FD	234	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
a0377dfe FD	235	LTTNG_ASSERT(event_name);
6a751b95 JR	236
6a751b95 JR	237	status = lttng_event_rule_kernel_uprobe_get_location(rule, &location);
a0377dfe FD	238	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
a0377dfe FD	239	LTTNG_ASSERT(location);
6a751b95 JR	240
	241	/* Open event rule kernel uprobe element. */
	242	ret = mi_lttng_writer_open_element(
	243	writer, mi_lttng_element_event_rule_kernel_uprobe);
	244	if (ret) {
	245	goto mi_error;
	246	}
	247
	248	/* Event name. */
	249	ret = mi_lttng_writer_write_element_string(writer,
	250	mi_lttng_element_event_rule_event_name, event_name);
	251	if (ret) {
	252	goto mi_error;
	253	}
	254
	255	/* Probe location. */
	256	ret_code = lttng_userspace_probe_location_mi_serialize(location, writer);
	257	if (ret_code != LTTNG_OK) {
	258	goto end;
	259	}
	260
	261	/* Close event rule kernel uprobe element. */
	262	ret = mi_lttng_writer_close_element(writer);
	263	if (ret) {
	264	goto mi_error;
	265	}
	266
	267	ret_code = LTTNG_OK;
	268	goto end;
	269
	270	mi_error:
	271	ret_code = LTTNG_ERR_MI_IO_FAIL;
	272	end:
	273	return ret_code;
	274	}
	275
46fd07ac	276	struct lttng_event_rule *lttng_event_rule_kernel_uprobe_create(
10685de6	277	const struct lttng_userspace_probe_location *location)
df08d338 JR	278	{
df08d338 JR	279	struct lttng_event_rule *rule = NULL;
46fd07ac	280	struct lttng_event_rule_kernel_uprobe *urule;
df08d338	281
a6bc4ca9	282	urule = (lttng_event_rule_kernel_uprobe *) zmalloc(sizeof(struct lttng_event_rule_kernel_uprobe));
df08d338 JR	283	if (!urule) {
	284	goto end;
	285	}
	286
	287	rule = &urule->parent;
46fd07ac JR	288	lttng_event_rule_init(&urule->parent, LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE);
	289	urule->parent.validate = lttng_event_rule_kernel_uprobe_validate;
	290	urule->parent.serialize = lttng_event_rule_kernel_uprobe_serialize;
	291	urule->parent.equal = lttng_event_rule_kernel_uprobe_is_equal;
	292	urule->parent.destroy = lttng_event_rule_kernel_uprobe_destroy;
df08d338	293	urule->parent.generate_filter_bytecode =
46fd07ac JR	294	lttng_event_rule_kernel_uprobe_generate_filter_bytecode;
46fd07ac JR	295	urule->parent.get_filter = lttng_event_rule_kernel_uprobe_get_filter;
df08d338	296	urule->parent.get_filter_bytecode =
46fd07ac	297	lttng_event_rule_kernel_uprobe_get_filter_bytecode;
df08d338	298	urule->parent.generate_exclusions =
46fd07ac JR	299	lttng_event_rule_kernel_uprobe_generate_exclusions;
46fd07ac JR	300	urule->parent.hash = lttng_event_rule_kernel_uprobe_hash;
6a751b95	301	urule->parent.mi_serialize = lttng_event_rule_kernel_uprobe_mi_serialize;
1f1567a5	302
10685de6 JR	303	if (userspace_probe_set_location(urule, location)) {
	304	lttng_event_rule_destroy(rule);
	305	rule = NULL;
	306	}
	307
df08d338 JR	308	end:
	309	return rule;
	310	}
	311
46fd07ac	312	ssize_t lttng_event_rule_kernel_uprobe_create_from_payload(
df08d338 JR	313	struct lttng_payload_view *view,
	314	struct lttng_event_rule **_event_rule)
	315	{
	316	ssize_t ret, offset = 0;
46fd07ac	317	const struct lttng_event_rule_kernel_uprobe_comm *uprobe_comm;
df08d338 JR	318	const char *name;
	319	struct lttng_buffer_view current_buffer_view;
	320	struct lttng_event_rule *rule = NULL;
10685de6	321	struct lttng_userspace_probe_location *location = NULL;
df08d338 JR	322	enum lttng_event_rule_status status;
	323
	324	if (!_event_rule) {
	325	ret = -1;
	326	goto end;
	327	}
	328
df08d338 JR	329	current_buffer_view = lttng_buffer_view_from_view(
df08d338 JR	330	&view->buffer, offset, sizeof(*uprobe_comm));
3e6e0df2 JG	331	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
3e6e0df2 JG	332	ERR("Failed to initialize from malformed event rule uprobe: buffer too short to contain header");
df08d338 JR	333	ret = -1;
	334	goto end;
	335	}
	336
3e6e0df2	337	uprobe_comm = (typeof(uprobe_comm)) current_buffer_view.data;
df08d338 JR	338
	339	/* Skip to payload. */
	340	offset += current_buffer_view.size;
	341
	342	/* Map the name. */
	343	current_buffer_view = lttng_buffer_view_from_view(
	344	&view->buffer, offset, uprobe_comm->name_len);
3e6e0df2	345	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
df08d338 JR	346	ret = -1;
	347	goto end;
	348	}
	349
3e6e0df2	350	name = current_buffer_view.data;
df08d338 JR	351	if (!lttng_buffer_view_contains_string(&current_buffer_view, name,
	352	uprobe_comm->name_len)) {
	353	ret = -1;
	354	goto end;
	355	}
	356
	357	/* Skip after the name. */
	358	offset += uprobe_comm->name_len;
	359
	360	/* Map the location. */
3e6e0df2 JG	361	{
	362	struct lttng_payload_view current_payload_view =
	363	lttng_payload_view_from_view(view, offset,
	364	uprobe_comm->location_len);
	365
	366	if (!lttng_payload_view_is_valid(&current_payload_view)) {
	367	ERR("Failed to initialize from malformed event rule uprobe: buffer too short to contain location");
	368	ret = -1;
	369	goto end;
	370	}
	371
	372	ret = lttng_userspace_probe_location_create_from_payload(
	373	&current_payload_view, &location);
	374	if (ret < 0) {
	375	ret = -1;
	376	goto end;
	377	}
df08d338 JR	378	}
df08d338 JR	379
a0377dfe	380	LTTNG_ASSERT(ret == uprobe_comm->location_len);
df08d338 JR	381
	382	/* Skip after the location. */
	383	offset += uprobe_comm->location_len;
	384
46fd07ac	385	rule = lttng_event_rule_kernel_uprobe_create(location);
10685de6 JR	386	if (!rule) {
	387	ERR("Failed to create event rule uprobe.");
	388	ret = -1;
	389	goto end;
	390	}
df08d338	391
46fd07ac	392	status = lttng_event_rule_kernel_uprobe_set_event_name(rule, name);
df08d338 JR	393	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
	394	ret = -1;
	395	goto end;
	396	}
	397
46fd07ac	398	if (!lttng_event_rule_kernel_uprobe_validate(rule)) {
df08d338 JR	399	ret = -1;
	400	goto end;
	401	}
	402
	403	*_event_rule = rule;
	404	rule = NULL;
	405	ret = offset;
	406	end:
10685de6	407	lttng_userspace_probe_location_destroy(location);
df08d338 JR	408	lttng_event_rule_destroy(rule);
	409	return ret;
	410	}
	411
df08d338	412
46fd07ac	413	enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_get_location(
df08d338 JR	414	const struct lttng_event_rule *rule,
	415	const struct lttng_userspace_probe_location **location)
	416	{
	417	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
	418
	419	if (!rule \|\| !IS_UPROBE_EVENT_RULE(rule) \|\| !location) {
	420	status = LTTNG_EVENT_RULE_STATUS_INVALID;
	421	goto end;
	422	}
	423
46fd07ac	424	*location = lttng_event_rule_kernel_uprobe_get_location_mutable(rule);
df08d338 JR	425	if (!*location) {
	426	status = LTTNG_EVENT_RULE_STATUS_UNSET;
	427	goto end;
	428	}
	429
	430	end:
	431	return status;
	432	}
	433
df08d338	434	struct lttng_userspace_probe_location *
46fd07ac	435	lttng_event_rule_kernel_uprobe_get_location_mutable(
df08d338 JR	436	const struct lttng_event_rule *rule)
df08d338 JR	437	{
46fd07ac	438	struct lttng_event_rule_kernel_uprobe *uprobe;
df08d338	439
a0377dfe	440	LTTNG_ASSERT(rule);
46fd07ac	441	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	442
	443	return uprobe->location;
	444	}
	445
46fd07ac	446	enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_set_event_name(
df08d338 JR	447	struct lttng_event_rule rule, const char name)
	448	{
	449	char *name_copy = NULL;
46fd07ac	450	struct lttng_event_rule_kernel_uprobe *uprobe;
df08d338 JR	451	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
	452
	453	if (!rule \|\| !IS_UPROBE_EVENT_RULE(rule) \|\| !name \|\|
	454	strlen(name) == 0) {
	455	status = LTTNG_EVENT_RULE_STATUS_INVALID;
	456	goto end;
	457	}
	458
46fd07ac	459	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	460	name_copy = strdup(name);
	461	if (!name_copy) {
	462	status = LTTNG_EVENT_RULE_STATUS_ERROR;
	463	goto end;
	464	}
	465
	466	if (uprobe->name) {
	467	free(uprobe->name);
	468	}
	469
	470	uprobe->name = name_copy;
	471	name_copy = NULL;
	472	end:
	473	return status;
	474	}
	475
46fd07ac	476	enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_get_event_name(
df08d338 JR	477	const struct lttng_event_rule rule, const char *name)
df08d338 JR	478	{
46fd07ac	479	struct lttng_event_rule_kernel_uprobe *uprobe;
df08d338 JR	480	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
	481
	482	if (!rule \|\| !IS_UPROBE_EVENT_RULE(rule) \|\| !name) {
	483	status = LTTNG_EVENT_RULE_STATUS_INVALID;
	484	goto end;
	485	}
	486
46fd07ac	487	uprobe = container_of(rule, struct lttng_event_rule_kernel_uprobe, parent);
df08d338 JR	488	if (!uprobe->name) {
	489	status = LTTNG_EVENT_RULE_STATUS_UNSET;
	490	goto end;
	491	}
	492
	493	*name = uprobe->name;
	494	end:
	495	return status;
	496	}