From: Jonathan Rajotte Date: Thu, 5 Nov 2020 00:18:17 +0000 (-0500) Subject: Rename uprobe files to userspace-probe X-Git-Tag: v2.13.0-rc1~221 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=e957bf98e634c79b13281d0a2fe144be0245d310 Rename uprobe files to userspace-probe Signed-off-by: Jonathan Rajotte Signed-off-by: Jérémie Galarneau Change-Id: Ide5aeca0d56b8a368fa26bf7cc082098e349d8d9 --- diff --git a/include/Makefile.am b/include/Makefile.am index dc09f385f..8dae80973 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -150,7 +150,7 @@ lttngeventruleinclude_HEADERS= \ lttng/event-rule/event-rule.h \ lttng/event-rule/kernel-probe.h \ lttng/event-rule/syscall.h \ - lttng/event-rule/uprobe.h \ + lttng/event-rule/userspace-probe.h \ lttng/event-rule/tracepoint.h noinst_HEADERS = \ @@ -190,7 +190,7 @@ noinst_HEADERS = \ lttng/event-rule/event-rule-internal.h \ lttng/event-rule/kernel-probe-internal.h \ lttng/event-rule/syscall-internal.h \ - lttng/event-rule/uprobe-internal.h \ + lttng/event-rule/userspace-probe-internal.h \ lttng/event-rule/tracepoint-internal.h \ version.h \ version.i diff --git a/include/lttng/event-rule/uprobe-internal.h b/include/lttng/event-rule/uprobe-internal.h deleted file mode 100644 index 41d42eb76..000000000 --- a/include/lttng/event-rule/uprobe-internal.h +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright (C) 2019 Jonathan Rajotte - * - * SPDX-License-Identifier: LGPL-2.1-only - * - */ - -#ifndef LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H -#define LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H - -#include -#include -#include -#include - -struct lttng_event_rule_userspace_probe { - struct lttng_event_rule parent; - char *name; - struct lttng_userspace_probe_location *location; -}; - -struct lttng_event_rule_userspace_probe_comm { - /* Includes terminator `\0`. */ - uint32_t name_len; - /* Includes terminator `\0`. */ - uint32_t location_len; - /* - * Payload is composed of, in that order: - * - name (null terminated), - * - user space probe location object. - */ - char payload[]; -} LTTNG_PACKED; - -LTTNG_HIDDEN -ssize_t lttng_event_rule_userspace_probe_create_from_payload( - struct lttng_payload_view *view, - struct lttng_event_rule **rule); - -LTTNG_HIDDEN -struct lttng_userspace_probe_location * -lttng_event_rule_userspace_probe_get_location_mutable( - const struct lttng_event_rule *rule); - -#endif /* LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H */ diff --git a/include/lttng/event-rule/uprobe.h b/include/lttng/event-rule/uprobe.h deleted file mode 100644 index f4020a16a..000000000 --- a/include/lttng/event-rule/uprobe.h +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (C) 2019 Jonathan Rajotte - * - * SPDX-License-Identifier: LGPL-2.1-only - * - */ - -#ifndef LTTNG_EVENT_RULE_USERSPACE_PROBE_H -#define LTTNG_EVENT_RULE_USERSPACE_PROBE_H - -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * Create a newly allocated user space probe event rule. - * - * Returns a new event rule on success, NULL on failure. This event rule must be - * destroyed using lttng_event_rule_destroy(). - */ -extern struct lttng_event_rule *lttng_event_rule_userspace_probe_create(void); - -/* - * Set the location of a user space probe event rule. - * - * The location is copied internally. - * - * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID - * if invalid parameters are passed. - */ -extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_location( - struct lttng_event_rule *rule, - const struct lttng_userspace_probe_location *location); - -/* - * Get the location of a user space probe event rule. - * - * The caller does not assume the ownership of the returned location. - * The location shall only be used for the duration of the event - * rule's lifetime, or before a different location is set. - * - * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's location - * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is - * passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a location was not set prior to - * this call. - */ -extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_get_location( - const struct lttng_event_rule *rule, - const struct lttng_userspace_probe_location **location); - -/* - * Set the name of a user space probe event rule. - * - * The name is copied internally. - * - * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID - * if invalid parameters are passed. - */ -extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_name( - struct lttng_event_rule *rule, const char *name); - -/* - * Get the name of a user space probe event rule. - * - * The caller does not assume the ownership of the returned name. - * The name shall only only be used for the duration of the event - * rule's lifetime, or before a different name is set. - * - * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's name on - * success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is passed, - * or LTTNG_EVENT_RULE_STATUS_UNSET if a name was not set prior to this call. - */ -extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_get_name( - const struct lttng_event_rule *rule, const char **name); - -#ifdef __cplusplus -} -#endif - -#endif /* LTTNG_EVENT_RULE_USERSPACE_PROBE_H */ diff --git a/include/lttng/event-rule/userspace-probe-internal.h b/include/lttng/event-rule/userspace-probe-internal.h new file mode 100644 index 000000000..8ba5b2bf2 --- /dev/null +++ b/include/lttng/event-rule/userspace-probe-internal.h @@ -0,0 +1,45 @@ +/* + * Copyright (C) 2019 Jonathan Rajotte + * + * SPDX-License-Identifier: LGPL-2.1-only + * + */ + +#ifndef LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H +#define LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H + +#include +#include +#include +#include + +struct lttng_event_rule_userspace_probe { + struct lttng_event_rule parent; + char *name; + struct lttng_userspace_probe_location *location; +}; + +struct lttng_event_rule_userspace_probe_comm { + /* Includes terminator `\0`. */ + uint32_t name_len; + /* Includes terminator `\0`. */ + uint32_t location_len; + /* + * Payload is composed of, in that order: + * - name (null terminated), + * - user space probe location object. + */ + char payload[]; +} LTTNG_PACKED; + +LTTNG_HIDDEN +ssize_t lttng_event_rule_userspace_probe_create_from_payload( + struct lttng_payload_view *view, + struct lttng_event_rule **rule); + +LTTNG_HIDDEN +struct lttng_userspace_probe_location * +lttng_event_rule_userspace_probe_get_location_mutable( + const struct lttng_event_rule *rule); + +#endif /* LTTNG_EVENT_RULE_USERSPACE_PROBE_INTERNAL_H */ diff --git a/include/lttng/event-rule/userspace-probe.h b/include/lttng/event-rule/userspace-probe.h new file mode 100644 index 000000000..f4020a16a --- /dev/null +++ b/include/lttng/event-rule/userspace-probe.h @@ -0,0 +1,83 @@ +/* + * Copyright (C) 2019 Jonathan Rajotte + * + * SPDX-License-Identifier: LGPL-2.1-only + * + */ + +#ifndef LTTNG_EVENT_RULE_USERSPACE_PROBE_H +#define LTTNG_EVENT_RULE_USERSPACE_PROBE_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * Create a newly allocated user space probe event rule. + * + * Returns a new event rule on success, NULL on failure. This event rule must be + * destroyed using lttng_event_rule_destroy(). + */ +extern struct lttng_event_rule *lttng_event_rule_userspace_probe_create(void); + +/* + * Set the location of a user space probe event rule. + * + * The location is copied internally. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_location( + struct lttng_event_rule *rule, + const struct lttng_userspace_probe_location *location); + +/* + * Get the location of a user space probe event rule. + * + * The caller does not assume the ownership of the returned location. + * The location shall only be used for the duration of the event + * rule's lifetime, or before a different location is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's location + * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is + * passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a location was not set prior to + * this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_get_location( + const struct lttng_event_rule *rule, + const struct lttng_userspace_probe_location **location); + +/* + * Set the name of a user space probe event rule. + * + * The name is copied internally. + * + * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_name( + struct lttng_event_rule *rule, const char *name); + +/* + * Get the name of a user space probe event rule. + * + * The caller does not assume the ownership of the returned name. + * The name shall only only be used for the duration of the event + * rule's lifetime, or before a different name is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's name on + * success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is passed, + * or LTTNG_EVENT_RULE_STATUS_UNSET if a name was not set prior to this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_userspace_probe_get_name( + const struct lttng_event_rule *rule, const char **name); + +#ifdef __cplusplus +} +#endif + +#endif /* LTTNG_EVENT_RULE_USERSPACE_PROBE_H */ diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index bc5a83d48..84032d1ec 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -43,7 +43,7 @@ #include #include #include -#include +#include #include #include #include diff --git a/src/bin/lttng-sessiond/kernel.c b/src/bin/lttng-sessiond/kernel.c index 9a1f37191..fe7271ed9 100644 --- a/src/bin/lttng-sessiond/kernel.c +++ b/src/bin/lttng-sessiond/kernel.c @@ -32,7 +32,7 @@ #include #include #include -#include +#include #include "lttng-sessiond.h" #include "lttng-syscall.h" diff --git a/src/bin/lttng-sessiond/trace-kernel.c b/src/bin/lttng-sessiond/trace-kernel.c index aa6152144..9d019752b 100644 --- a/src/bin/lttng-sessiond/trace-kernel.c +++ b/src/bin/lttng-sessiond/trace-kernel.c @@ -24,7 +24,7 @@ #include #include #include -#include +#include #include #include #include diff --git a/src/common/Makefile.am b/src/common/Makefile.am index 3c076c8ff..154ab0faf 100644 --- a/src/common/Makefile.am +++ b/src/common/Makefile.am @@ -64,7 +64,7 @@ libcommon_la_SOURCES = \ event-rule/event-rule.c \ event-rule/kernel-probe.c \ event-rule/syscall.c \ - event-rule/uprobe.c \ + event-rule/userspace-probe.c \ event-rule/tracepoint.c \ filter.c filter.h \ fd-handle.c fd-handle.h \ diff --git a/src/common/event-rule/event-rule.c b/src/common/event-rule/event-rule.c index 8afc18417..dfb8febfe 100644 --- a/src/common/event-rule/event-rule.c +++ b/src/common/event-rule/event-rule.c @@ -17,7 +17,7 @@ #include #include #include -#include +#include #include enum lttng_event_rule_type lttng_event_rule_get_type( diff --git a/src/common/event-rule/uprobe.c b/src/common/event-rule/uprobe.c deleted file mode 100644 index b8f8edee5..000000000 --- a/src/common/event-rule/uprobe.c +++ /dev/null @@ -1,437 +0,0 @@ -/* - * Copyright (C) 2019 Jonathan Rajotte - * - * SPDX-License-Identifier: LGPL-2.1-only - * - */ - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#define IS_UPROBE_EVENT_RULE(rule) \ - (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE) - -static void lttng_event_rule_userspace_probe_destroy(struct lttng_event_rule *rule) -{ - struct lttng_event_rule_userspace_probe *uprobe; - - uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); - - lttng_userspace_probe_location_destroy(uprobe->location); - free(uprobe->name); - free(uprobe); -} - -static bool lttng_event_rule_userspace_probe_validate( - const struct lttng_event_rule *rule) -{ - bool valid = false; - struct lttng_event_rule_userspace_probe *uprobe; - - if (!rule) { - goto end; - } - - uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, 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_userspace_probe_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_userspace_probe *uprobe; - struct lttng_event_rule_userspace_probe_comm uprobe_comm = {}; - struct lttng_event_rule_userspace_probe_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_userspace_probe, 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_userspace_probe_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_userspace_probe_is_equal(const struct lttng_event_rule *_a, - const struct lttng_event_rule *_b) -{ - bool is_equal = false; - struct lttng_event_rule_userspace_probe *a, *b; - - a = container_of(_a, struct lttng_event_rule_userspace_probe, parent); - b = container_of(_b, struct lttng_event_rule_userspace_probe, parent); - - /* uprobe is invalid if this is not true. */ - assert(a->name); - assert(b->name); - if (strcmp(a->name, b->name)) { - goto end; - } - - assert(a->location); - 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_userspace_probe_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_userspace_probe_get_filter( - const struct lttng_event_rule *rule) -{ - /* Unsupported. */ - return NULL; -} - -static const struct lttng_bytecode * -lttng_event_rule_userspace_probe_get_filter_bytecode(const struct lttng_event_rule *rule) -{ - /* Unsupported. */ - return NULL; -} - -static enum lttng_event_rule_generate_exclusions_status -lttng_event_rule_userspace_probe_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_userspace_probe_hash( - const struct lttng_event_rule *rule) -{ - unsigned long hash; - struct lttng_event_rule_userspace_probe *urule = - container_of(rule, typeof(*urule), parent); - - hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE, - lttng_ht_seed); - hash ^= hash_key_str(urule->name, lttng_ht_seed); - hash ^= lttng_userspace_probe_location_hash(urule->location); - - return hash; -} - -struct lttng_event_rule *lttng_event_rule_userspace_probe_create(void) -{ - struct lttng_event_rule *rule = NULL; - struct lttng_event_rule_userspace_probe *urule; - - urule = zmalloc(sizeof(struct lttng_event_rule_userspace_probe)); - if (!urule) { - goto end; - } - - rule = &urule->parent; - lttng_event_rule_init(&urule->parent, LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE); - urule->parent.validate = lttng_event_rule_userspace_probe_validate; - urule->parent.serialize = lttng_event_rule_userspace_probe_serialize; - urule->parent.equal = lttng_event_rule_userspace_probe_is_equal; - urule->parent.destroy = lttng_event_rule_userspace_probe_destroy; - urule->parent.generate_filter_bytecode = - lttng_event_rule_userspace_probe_generate_filter_bytecode; - urule->parent.get_filter = lttng_event_rule_userspace_probe_get_filter; - urule->parent.get_filter_bytecode = - lttng_event_rule_userspace_probe_get_filter_bytecode; - urule->parent.generate_exclusions = - lttng_event_rule_userspace_probe_generate_exclusions; - urule->parent.hash = lttng_event_rule_userspace_probe_hash; - -end: - return rule; -} - -LTTNG_HIDDEN -ssize_t lttng_event_rule_userspace_probe_create_from_payload( - struct lttng_payload_view *view, - struct lttng_event_rule **_event_rule) -{ - ssize_t ret, offset = 0; - const struct lttng_event_rule_userspace_probe_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; - struct lttng_event_rule_userspace_probe *uprobe; - 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(¤t_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; - rule = lttng_event_rule_userspace_probe_create(); - if (!rule) { - ERR("Failed to create event rule uprobe"); - ret = -1; - goto end; - } - - /* 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(¤t_buffer_view)) { - ret = -1; - goto end; - } - - name = current_buffer_view.data; - if (!lttng_buffer_view_contains_string(¤t_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(¤t_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( - ¤t_payload_view, &location); - if (ret < 0) { - ret = -1; - goto end; - } - } - - assert(ret == uprobe_comm->location_len); - - /* Skip after the location. */ - offset += uprobe_comm->location_len; - - uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); - uprobe->location = location; - - status = lttng_event_rule_userspace_probe_set_name(rule, name); - if (status != LTTNG_EVENT_RULE_STATUS_OK) { - ret = -1; - goto end; - } - - if (!lttng_event_rule_userspace_probe_validate(rule)) { - 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_userspace_probe_set_location( - struct lttng_event_rule *rule, - const struct lttng_userspace_probe_location *location) -{ - struct lttng_userspace_probe_location *location_copy = NULL; - struct lttng_event_rule_userspace_probe *uprobe; - 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; - } - - uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); - location_copy = lttng_userspace_probe_location_copy(location); - if (!location_copy) { - status = LTTNG_EVENT_RULE_STATUS_ERROR; - goto end; - } - - if (uprobe->location) { - lttng_userspace_probe_location_destroy(uprobe->location); - } - - uprobe->location = location_copy; - location_copy = NULL; -end: - lttng_userspace_probe_location_destroy(location_copy); - return status; -} - -enum lttng_event_rule_status lttng_event_rule_userspace_probe_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_userspace_probe_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_userspace_probe_get_location_mutable( - const struct lttng_event_rule *rule) -{ - struct lttng_event_rule_userspace_probe *uprobe; - - assert(rule); - uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); - - return uprobe->location; -} - -enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_name( - struct lttng_event_rule *rule, const char *name) -{ - char *name_copy = NULL; - struct lttng_event_rule_userspace_probe *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_userspace_probe, 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_userspace_probe_get_name( - const struct lttng_event_rule *rule, const char **name) -{ - struct lttng_event_rule_userspace_probe *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_userspace_probe, parent); - if (!uprobe->name) { - status = LTTNG_EVENT_RULE_STATUS_UNSET; - goto end; - } - - *name = uprobe->name; -end: - return status; -} diff --git a/src/common/event-rule/userspace-probe.c b/src/common/event-rule/userspace-probe.c new file mode 100644 index 000000000..66db5a6e4 --- /dev/null +++ b/src/common/event-rule/userspace-probe.c @@ -0,0 +1,437 @@ +/* + * Copyright (C) 2019 Jonathan Rajotte + * + * SPDX-License-Identifier: LGPL-2.1-only + * + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define IS_UPROBE_EVENT_RULE(rule) \ + (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE) + +static void lttng_event_rule_userspace_probe_destroy(struct lttng_event_rule *rule) +{ + struct lttng_event_rule_userspace_probe *uprobe; + + uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); + + lttng_userspace_probe_location_destroy(uprobe->location); + free(uprobe->name); + free(uprobe); +} + +static bool lttng_event_rule_userspace_probe_validate( + const struct lttng_event_rule *rule) +{ + bool valid = false; + struct lttng_event_rule_userspace_probe *uprobe; + + if (!rule) { + goto end; + } + + uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, 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_userspace_probe_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_userspace_probe *uprobe; + struct lttng_event_rule_userspace_probe_comm uprobe_comm = {}; + struct lttng_event_rule_userspace_probe_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_userspace_probe, 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_userspace_probe_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_userspace_probe_is_equal(const struct lttng_event_rule *_a, + const struct lttng_event_rule *_b) +{ + bool is_equal = false; + struct lttng_event_rule_userspace_probe *a, *b; + + a = container_of(_a, struct lttng_event_rule_userspace_probe, parent); + b = container_of(_b, struct lttng_event_rule_userspace_probe, parent); + + /* uprobe is invalid if this is not true. */ + assert(a->name); + assert(b->name); + if (strcmp(a->name, b->name)) { + goto end; + } + + assert(a->location); + 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_userspace_probe_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_userspace_probe_get_filter( + const struct lttng_event_rule *rule) +{ + /* Unsupported. */ + return NULL; +} + +static const struct lttng_bytecode * +lttng_event_rule_userspace_probe_get_filter_bytecode(const struct lttng_event_rule *rule) +{ + /* Unsupported. */ + return NULL; +} + +static enum lttng_event_rule_generate_exclusions_status +lttng_event_rule_userspace_probe_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_userspace_probe_hash( + const struct lttng_event_rule *rule) +{ + unsigned long hash; + struct lttng_event_rule_userspace_probe *urule = + container_of(rule, typeof(*urule), parent); + + hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE, + lttng_ht_seed); + hash ^= hash_key_str(urule->name, lttng_ht_seed); + hash ^= lttng_userspace_probe_location_hash(urule->location); + + return hash; +} + +struct lttng_event_rule *lttng_event_rule_userspace_probe_create(void) +{ + struct lttng_event_rule *rule = NULL; + struct lttng_event_rule_userspace_probe *urule; + + urule = zmalloc(sizeof(struct lttng_event_rule_userspace_probe)); + if (!urule) { + goto end; + } + + rule = &urule->parent; + lttng_event_rule_init(&urule->parent, LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE); + urule->parent.validate = lttng_event_rule_userspace_probe_validate; + urule->parent.serialize = lttng_event_rule_userspace_probe_serialize; + urule->parent.equal = lttng_event_rule_userspace_probe_is_equal; + urule->parent.destroy = lttng_event_rule_userspace_probe_destroy; + urule->parent.generate_filter_bytecode = + lttng_event_rule_userspace_probe_generate_filter_bytecode; + urule->parent.get_filter = lttng_event_rule_userspace_probe_get_filter; + urule->parent.get_filter_bytecode = + lttng_event_rule_userspace_probe_get_filter_bytecode; + urule->parent.generate_exclusions = + lttng_event_rule_userspace_probe_generate_exclusions; + urule->parent.hash = lttng_event_rule_userspace_probe_hash; + +end: + return rule; +} + +LTTNG_HIDDEN +ssize_t lttng_event_rule_userspace_probe_create_from_payload( + struct lttng_payload_view *view, + struct lttng_event_rule **_event_rule) +{ + ssize_t ret, offset = 0; + const struct lttng_event_rule_userspace_probe_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; + struct lttng_event_rule_userspace_probe *uprobe; + 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(¤t_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; + rule = lttng_event_rule_userspace_probe_create(); + if (!rule) { + ERR("Failed to create event rule uprobe"); + ret = -1; + goto end; + } + + /* 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(¤t_buffer_view)) { + ret = -1; + goto end; + } + + name = current_buffer_view.data; + if (!lttng_buffer_view_contains_string(¤t_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(¤t_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( + ¤t_payload_view, &location); + if (ret < 0) { + ret = -1; + goto end; + } + } + + assert(ret == uprobe_comm->location_len); + + /* Skip after the location. */ + offset += uprobe_comm->location_len; + + uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); + uprobe->location = location; + + status = lttng_event_rule_userspace_probe_set_name(rule, name); + if (status != LTTNG_EVENT_RULE_STATUS_OK) { + ret = -1; + goto end; + } + + if (!lttng_event_rule_userspace_probe_validate(rule)) { + 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_userspace_probe_set_location( + struct lttng_event_rule *rule, + const struct lttng_userspace_probe_location *location) +{ + struct lttng_userspace_probe_location *location_copy = NULL; + struct lttng_event_rule_userspace_probe *uprobe; + 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; + } + + uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); + location_copy = lttng_userspace_probe_location_copy(location); + if (!location_copy) { + status = LTTNG_EVENT_RULE_STATUS_ERROR; + goto end; + } + + if (uprobe->location) { + lttng_userspace_probe_location_destroy(uprobe->location); + } + + uprobe->location = location_copy; + location_copy = NULL; +end: + lttng_userspace_probe_location_destroy(location_copy); + return status; +} + +enum lttng_event_rule_status lttng_event_rule_userspace_probe_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_userspace_probe_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_userspace_probe_get_location_mutable( + const struct lttng_event_rule *rule) +{ + struct lttng_event_rule_userspace_probe *uprobe; + + assert(rule); + uprobe = container_of(rule, struct lttng_event_rule_userspace_probe, parent); + + return uprobe->location; +} + +enum lttng_event_rule_status lttng_event_rule_userspace_probe_set_name( + struct lttng_event_rule *rule, const char *name) +{ + char *name_copy = NULL; + struct lttng_event_rule_userspace_probe *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_userspace_probe, 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_userspace_probe_get_name( + const struct lttng_event_rule *rule, const char **name) +{ + struct lttng_event_rule_userspace_probe *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_userspace_probe, parent); + if (!uprobe->name) { + status = LTTNG_EVENT_RULE_STATUS_UNSET; + goto end; + } + + *name = uprobe->name; +end: + return status; +} diff --git a/tests/unit/test_event_rule.c b/tests/unit/test_event_rule.c index 6cc9d5cd6..b45dc7ba2 100644 --- a/tests/unit/test_event_rule.c +++ b/tests/unit/test_event_rule.c @@ -24,8 +24,8 @@ #include #include #include -#include -#include +#include +#include #include #include #include