mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2025-01-06 05:06:29 +00:00
64805e4039
Currently user_events supports 1 event with the same name and must have
the exact same format when referenced by multiple programs. This opens
an opportunity for malicious or poorly thought through programs to
create events that others use with different formats. Another scenario
is user programs wishing to use the same event name but add more fields
later when the software updates. Various versions of a program may be
running side-by-side, which is prevented by the current single format
requirement.
Add a new register flag (USER_EVENT_REG_MULTI_FORMAT) which indicates
the user program wishes to use the same user_event name, but may have
several different formats of the event. When this flag is used, create
the underlying tracepoint backing the user_event with a unique name
per-version of the format. It's important that existing ABI users do
not get this logic automatically, even if one of the multi format
events matches the format. This ensures existing programs that create
events and assume the tracepoint name will match exactly continue to
work as expected. Add logic to only check multi-format events with
other multi-format events and single-format events to only check
single-format events during find.
Change system name of the multi-format event tracepoint to ensure that
multi-format events are isolated completely from single-format events.
This prevents single-format names from conflicting with multi-format
events if they end with the same suffix as the multi-format events.
Add a register_name (reg_name) to the user_event struct which allows for
split naming of events. We now have the name that was used to register
within user_events as well as the unique name for the tracepoint. Upon
registering events ensure matches based on first the reg_name, followed
by the fields and format of the event. This allows for multiple events
with the same registered name to have different formats. The underlying
tracepoint will have a unique name in the format of {reg_name}.{unique_id}.
For example, if both "test u32 value" and "test u64 value" are used with
the USER_EVENT_REG_MULTI_FORMAT the system would have 2 unique
tracepoints. The dynamic_events file would then show the following:
u:test u64 count
u:test u32 count
The actual tracepoint names look like this:
test.0
test.1
Both would be under the new user_events_multi system name to prevent the
older ABI from being used to squat on multi-formatted events and block
their use.
Deleting events via "!u:test u64 count" would only delete the first
tracepoint that matched that format. When the delete ABI is used all
events with the same name will be attempted to be deleted. If
per-version deletion is required, user programs should either not use
persistent events or delete them via dynamic_events.
Link: https://lore.kernel.org/linux-trace-kernel/20240222001807.1463-3-beaub@linux.microsoft.com
Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
95 lines
2.5 KiB
C
95 lines
2.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
|
|
/*
|
|
* Copyright (c) 2021-2022, Microsoft Corporation.
|
|
*
|
|
* Authors:
|
|
* Beau Belgrave <beaub@linux.microsoft.com>
|
|
*/
|
|
#ifndef _UAPI_LINUX_USER_EVENTS_H
|
|
#define _UAPI_LINUX_USER_EVENTS_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/ioctl.h>
|
|
|
|
#define USER_EVENTS_SYSTEM "user_events"
|
|
#define USER_EVENTS_MULTI_SYSTEM "user_events_multi"
|
|
#define USER_EVENTS_PREFIX "u:"
|
|
|
|
/* Create dynamic location entry within a 32-bit value */
|
|
#define DYN_LOC(offset, size) ((size) << 16 | (offset))
|
|
|
|
/* List of supported registration flags */
|
|
enum user_reg_flag {
|
|
/* Event will not delete upon last reference closing */
|
|
USER_EVENT_REG_PERSIST = 1U << 0,
|
|
|
|
/* Event will be allowed to have multiple formats */
|
|
USER_EVENT_REG_MULTI_FORMAT = 1U << 1,
|
|
|
|
/* This value or above is currently non-ABI */
|
|
USER_EVENT_REG_MAX = 1U << 2,
|
|
};
|
|
|
|
/*
|
|
* Describes an event registration and stores the results of the registration.
|
|
* This structure is passed to the DIAG_IOCSREG ioctl, callers at a minimum
|
|
* must set the size and name_args before invocation.
|
|
*/
|
|
struct user_reg {
|
|
|
|
/* Input: Size of the user_reg structure being used */
|
|
__u32 size;
|
|
|
|
/* Input: Bit in enable address to use */
|
|
__u8 enable_bit;
|
|
|
|
/* Input: Enable size in bytes at address */
|
|
__u8 enable_size;
|
|
|
|
/* Input: Flags to use, if any */
|
|
__u16 flags;
|
|
|
|
/* Input: Address to update when enabled */
|
|
__u64 enable_addr;
|
|
|
|
/* Input: Pointer to string with event name, description and flags */
|
|
__u64 name_args;
|
|
|
|
/* Output: Index of the event to use when writing data */
|
|
__u32 write_index;
|
|
} __attribute__((__packed__));
|
|
|
|
/*
|
|
* Describes an event unregister, callers must set the size, address and bit.
|
|
* This structure is passed to the DIAG_IOCSUNREG ioctl to disable bit updates.
|
|
*/
|
|
struct user_unreg {
|
|
/* Input: Size of the user_unreg structure being used */
|
|
__u32 size;
|
|
|
|
/* Input: Bit to unregister */
|
|
__u8 disable_bit;
|
|
|
|
/* Input: Reserved, set to 0 */
|
|
__u8 __reserved;
|
|
|
|
/* Input: Reserved, set to 0 */
|
|
__u16 __reserved2;
|
|
|
|
/* Input: Address to unregister */
|
|
__u64 disable_addr;
|
|
} __attribute__((__packed__));
|
|
|
|
#define DIAG_IOC_MAGIC '*'
|
|
|
|
/* Request to register a user_event */
|
|
#define DIAG_IOCSREG _IOWR(DIAG_IOC_MAGIC, 0, struct user_reg *)
|
|
|
|
/* Request to delete a user_event */
|
|
#define DIAG_IOCSDEL _IOW(DIAG_IOC_MAGIC, 1, char *)
|
|
|
|
/* Requests to unregister a user_event */
|
|
#define DIAG_IOCSUNREG _IOW(DIAG_IOC_MAGIC, 2, struct user_unreg*)
|
|
|
|
#endif /* _UAPI_LINUX_USER_EVENTS_H */
|