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

/*
 * 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/payload-view.h>
#include <common/payload.h>
#include <common/runas.h>
#include <lttng/event-rule/event-rule-internal.h>
#include <lttng/event-rule/kernel-uprobe-internal.h>
#include <lttng/userspace-probe-internal.h>

#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,
		const struct lttng_credentials *creds)
{
	/* Nothing to do. */
	return LTTNG_OK;
}

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

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

static enum lttng_event_rule_generate_exclusions_status
lttng_event_rule_kernel_uprobe_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_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 = 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;
}

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

LTTNG_HIDDEN
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
58daac01	8	#include <common/credentials.h>
df08d338	9	#include <common/error.h>
6a751b95 JR	10	#include <common/hashtable/hashtable.h>
6a751b95 JR	11	#include <common/hashtable/utils.h>
df08d338	12	#include <common/macros.h>
6a751b95	13	#include <common/mi-lttng.h>
df08d338	14	#include <common/payload-view.h>
6a751b95	15	#include <common/payload.h>
df08d338 JR	16	#include <common/runas.h>
df08d338 JR	17	#include <lttng/event-rule/event-rule-internal.h>
46fd07ac	18	#include <lttng/event-rule/kernel-uprobe-internal.h>
df08d338 JR	19	#include <lttng/userspace-probe-internal.h>
	20
	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(
58daac01 JR	144	struct lttng_event_rule *rule,
58daac01 JR	145	const struct lttng_credentials *creds)
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(
df08d338 JR	152	const struct lttng_event_rule *rule)
	153	{
	154	/* Unsupported. */
	155	return NULL;
	156	}
	157
2b00d462	158	static const struct lttng_bytecode *
46fd07ac	159	lttng_event_rule_kernel_uprobe_get_filter_bytecode(const struct lttng_event_rule *rule)
df08d338 JR	160	{
	161	/* Unsupported. */
	162	return NULL;
	163	}
	164
993578ff	165	static enum lttng_event_rule_generate_exclusions_status
46fd07ac	166	lttng_event_rule_kernel_uprobe_generate_exclusions(const struct lttng_event_rule *rule,
993578ff	167	struct lttng_event_exclusion **exclusions)
df08d338 JR	168	{
df08d338 JR	169	/* Unsupported. */
993578ff JR	170	*exclusions = NULL;
993578ff JR	171	return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE;
df08d338 JR	172	}
df08d338 JR	173
959e3c66	174	static unsigned long
46fd07ac	175	lttng_event_rule_kernel_uprobe_hash(
959e3c66 JR	176	const struct lttng_event_rule *rule)
	177	{
	178	unsigned long hash;
46fd07ac	179	struct lttng_event_rule_kernel_uprobe *urule =
959e3c66 JR	180	container_of(rule, typeof(*urule), parent);
959e3c66 JR	181
46fd07ac	182	hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE,
959e3c66 JR	183	lttng_ht_seed);
	184	hash ^= hash_key_str(urule->name, lttng_ht_seed);
	185	hash ^= lttng_userspace_probe_location_hash(urule->location);
	186
	187	return hash;
	188	}
	189
10685de6 JR	190	static
10685de6 JR	191	int userspace_probe_set_location(
46fd07ac	192	struct lttng_event_rule_kernel_uprobe *uprobe,
10685de6 JR	193	const struct lttng_userspace_probe_location *location)
	194	{
	195	int ret;
	196	struct lttng_userspace_probe_location *location_copy = NULL;
	197
	198	if (!uprobe \|\| !location \|\| uprobe->location) {
	199	ret = -1;
	200	goto end;
	201	}
	202
	203	location_copy = lttng_userspace_probe_location_copy(location);
	204	if (!location_copy) {
	205	ret = -1;
	206	goto end;
	207	}
	208
	209	uprobe->location = location_copy;
	210	location_copy = NULL;
	211	ret = 0;
	212	end:
	213	lttng_userspace_probe_location_destroy(location_copy);
	214	return ret;
	215	}
	216
6a751b95 JR	217	static enum lttng_error_code lttng_event_rule_kernel_uprobe_mi_serialize(
	218	const struct lttng_event_rule rule, struct mi_writer writer)
	219	{
	220	int ret;
	221	enum lttng_error_code ret_code;
	222	enum lttng_event_rule_status status;
	223	const char *event_name = NULL;
	224	const struct lttng_userspace_probe_location *location = NULL;
	225
a0377dfe FD	226	LTTNG_ASSERT(rule);
	227	LTTNG_ASSERT(writer);
	228	LTTNG_ASSERT(IS_UPROBE_EVENT_RULE(rule));
6a751b95 JR	229
	230	status = lttng_event_rule_kernel_uprobe_get_event_name(
	231	rule, &event_name);
a0377dfe FD	232	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
a0377dfe FD	233	LTTNG_ASSERT(event_name);
6a751b95 JR	234
6a751b95 JR	235	status = lttng_event_rule_kernel_uprobe_get_location(rule, &location);
a0377dfe FD	236	LTTNG_ASSERT(status == LTTNG_EVENT_RULE_STATUS_OK);
a0377dfe FD	237	LTTNG_ASSERT(location);
6a751b95 JR	238
	239	/* Open event rule kernel uprobe element. */
	240	ret = mi_lttng_writer_open_element(
	241	writer, mi_lttng_element_event_rule_kernel_uprobe);
	242	if (ret) {
	243	goto mi_error;
	244	}
	245
	246	/* Event name. */
	247	ret = mi_lttng_writer_write_element_string(writer,
	248	mi_lttng_element_event_rule_event_name, event_name);
	249	if (ret) {
	250	goto mi_error;
	251	}
	252
	253	/* Probe location. */
	254	ret_code = lttng_userspace_probe_location_mi_serialize(location, writer);
	255	if (ret_code != LTTNG_OK) {
	256	goto end;
	257	}
	258
	259	/* Close event rule kernel uprobe element. */
	260	ret = mi_lttng_writer_close_element(writer);
	261	if (ret) {
	262	goto mi_error;
	263	}
	264
	265	ret_code = LTTNG_OK;
	266	goto end;
	267
	268	mi_error:
	269	ret_code = LTTNG_ERR_MI_IO_FAIL;
	270	end:
	271	return ret_code;
	272	}
	273
46fd07ac	274	struct lttng_event_rule *lttng_event_rule_kernel_uprobe_create(
10685de6	275	const struct lttng_userspace_probe_location *location)
df08d338 JR	276	{
df08d338 JR	277	struct lttng_event_rule *rule = NULL;
46fd07ac	278	struct lttng_event_rule_kernel_uprobe *urule;
df08d338	279
46fd07ac	280	urule = zmalloc(sizeof(struct lttng_event_rule_kernel_uprobe));
df08d338 JR	281	if (!urule) {
	282	goto end;
	283	}
	284
	285	rule = &urule->parent;
46fd07ac JR	286	lttng_event_rule_init(&urule->parent, LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE);
	287	urule->parent.validate = lttng_event_rule_kernel_uprobe_validate;
	288	urule->parent.serialize = lttng_event_rule_kernel_uprobe_serialize;
	289	urule->parent.equal = lttng_event_rule_kernel_uprobe_is_equal;
	290	urule->parent.destroy = lttng_event_rule_kernel_uprobe_destroy;
df08d338	291	urule->parent.generate_filter_bytecode =
46fd07ac JR	292	lttng_event_rule_kernel_uprobe_generate_filter_bytecode;
46fd07ac JR	293	urule->parent.get_filter = lttng_event_rule_kernel_uprobe_get_filter;
df08d338	294	urule->parent.get_filter_bytecode =
46fd07ac	295	lttng_event_rule_kernel_uprobe_get_filter_bytecode;
df08d338	296	urule->parent.generate_exclusions =
46fd07ac JR	297	lttng_event_rule_kernel_uprobe_generate_exclusions;
46fd07ac JR	298	urule->parent.hash = lttng_event_rule_kernel_uprobe_hash;
6a751b95	299	urule->parent.mi_serialize = lttng_event_rule_kernel_uprobe_mi_serialize;
1f1567a5	300
10685de6 JR	301	if (userspace_probe_set_location(urule, location)) {
	302	lttng_event_rule_destroy(rule);
	303	rule = NULL;
	304	}
	305
df08d338 JR	306	end:
	307	return rule;
	308	}
	309
	310	LTTNG_HIDDEN
46fd07ac	311	ssize_t lttng_event_rule_kernel_uprobe_create_from_payload(
df08d338 JR	312	struct lttng_payload_view *view,
	313	struct lttng_event_rule **_event_rule)
	314	{
	315	ssize_t ret, offset = 0;
46fd07ac	316	const struct lttng_event_rule_kernel_uprobe_comm *uprobe_comm;
df08d338 JR	317	const char *name;
	318	struct lttng_buffer_view current_buffer_view;
	319	struct lttng_event_rule *rule = NULL;
10685de6	320	struct lttng_userspace_probe_location *location = NULL;
df08d338 JR	321	enum lttng_event_rule_status status;
	322
	323	if (!_event_rule) {
	324	ret = -1;
	325	goto end;
	326	}
	327
df08d338 JR	328	current_buffer_view = lttng_buffer_view_from_view(
df08d338 JR	329	&view->buffer, offset, sizeof(*uprobe_comm));
3e6e0df2 JG	330	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
3e6e0df2 JG	331	ERR("Failed to initialize from malformed event rule uprobe: buffer too short to contain header");
df08d338 JR	332	ret = -1;
	333	goto end;
	334	}
	335
3e6e0df2	336	uprobe_comm = (typeof(uprobe_comm)) current_buffer_view.data;
df08d338 JR	337
	338	/* Skip to payload. */
	339	offset += current_buffer_view.size;
	340
	341	/* Map the name. */
	342	current_buffer_view = lttng_buffer_view_from_view(
	343	&view->buffer, offset, uprobe_comm->name_len);
3e6e0df2	344	if (!lttng_buffer_view_is_valid(&current_buffer_view)) {
df08d338 JR	345	ret = -1;
	346	goto end;
	347	}
	348
3e6e0df2	349	name = current_buffer_view.data;
df08d338 JR	350	if (!lttng_buffer_view_contains_string(&current_buffer_view, name,
	351	uprobe_comm->name_len)) {
	352	ret = -1;
	353	goto end;
	354	}
	355
	356	/* Skip after the name. */
	357	offset += uprobe_comm->name_len;
	358
	359	/* Map the location. */
3e6e0df2 JG	360	{
	361	struct lttng_payload_view current_payload_view =
	362	lttng_payload_view_from_view(view, offset,
	363	uprobe_comm->location_len);
	364
	365	if (!lttng_payload_view_is_valid(&current_payload_view)) {
	366	ERR("Failed to initialize from malformed event rule uprobe: buffer too short to contain location");
	367	ret = -1;
	368	goto end;
	369	}
	370
	371	ret = lttng_userspace_probe_location_create_from_payload(
	372	&current_payload_view, &location);
	373	if (ret < 0) {
	374	ret = -1;
	375	goto end;
	376	}
df08d338 JR	377	}
df08d338 JR	378
a0377dfe	379	LTTNG_ASSERT(ret == uprobe_comm->location_len);
df08d338 JR	380
	381	/* Skip after the location. */
	382	offset += uprobe_comm->location_len;
	383
46fd07ac	384	rule = lttng_event_rule_kernel_uprobe_create(location);
10685de6 JR	385	if (!rule) {
	386	ERR("Failed to create event rule uprobe.");
	387	ret = -1;
	388	goto end;
	389	}
df08d338	390
46fd07ac	391	status = lttng_event_rule_kernel_uprobe_set_event_name(rule, name);
df08d338 JR	392	if (status != LTTNG_EVENT_RULE_STATUS_OK) {
	393	ret = -1;
	394	goto end;
	395	}
	396
46fd07ac	397	if (!lttng_event_rule_kernel_uprobe_validate(rule)) {
df08d338 JR	398	ret = -1;
	399	goto end;
	400	}
	401
	402	*_event_rule = rule;
	403	rule = NULL;
	404	ret = offset;
	405	end:
10685de6	406	lttng_userspace_probe_location_destroy(location);
df08d338 JR	407	lttng_event_rule_destroy(rule);
	408	return ret;
	409	}
	410
df08d338	411
46fd07ac	412	enum lttng_event_rule_status lttng_event_rule_kernel_uprobe_get_location(
df08d338 JR	413	const struct lttng_event_rule *rule,
	414	const struct lttng_userspace_probe_location **location)
	415	{
	416	enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK;
	417
	418	if (!rule \|\| !IS_UPROBE_EVENT_RULE(rule) \|\| !location) {
	419	status = LTTNG_EVENT_RULE_STATUS_INVALID;
	420	goto end;
	421	}
	422
46fd07ac	423	*location = lttng_event_rule_kernel_uprobe_get_location_mutable(rule);
df08d338 JR	424	if (!*location) {
	425	status = LTTNG_EVENT_RULE_STATUS_UNSET;
	426	goto end;
	427	}
	428
	429	end:
	430	return status;
	431	}
	432
	433	LTTNG_HIDDEN
	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	}