tracing/user_events: Remote write ABI
Subsystems (8)
v9 cover tracing/user_events: Remote write ABI
As part of the discussions for user_events aligned with user space tracers, it was determined that user programs should register a aligned value to set or clear a bit when an event becomes enabled. Currently a shared page is being used that requires mmap(). Remove the shared page implementation and move to a user registered address implementation.
In this new model during the event registration from user programs 3 new values are specified. The first is the address to update when the event is either enabled or disabled. The second is the bit to set/clear to reflect the event being enabled. The third is the size of the value at the specified address.
This allows for a local 32/64-bit value in user programs to support both kernel and user tracers. As an example, setting bit 31 for kernel tracers when the event becomes enabled allows for user tracers to use the other bits for ref counts or other flags. The kernel side updates the bit atomically, user programs need to also update these values atomically.
User provided addresses must be aligned on a natural boundary, this allows for single page checking and prevents odd behaviors such as a enable value straddling 2 pages instead of a single page.
When page faults are encountered they are done asyncly via a workqueue. If the page faults back in, the write update is attempted again. If the page cannot fault-in, then we log and wait until the next time the event is enabled/disabled. This is to prevent possible infinite loops resulting from bad user processes unmapping or changing protection values after registering the address.
Change history
V9:
Updated documentation to include __packed attributed in example payload.
Removed boot argument for max events, since sysctl can now be set via kernel boot parameters.
V8:
Rebase to 6.2-rc8.
V7:
Rebase to 6.2-rc4.
Added flags to register ioctl, validates it's 0 for now. Future patches will enable other types of formats/options as needed.
V6:
Rebase to 6.2-rc2.
Fixed small typos, code style.
Changed from synchronize_rcu() to queue_rcu_work() to allow an rcu delay asyncly when mm is being removed and in an appropriate context for mmdrop().
V5:GFP_NOWAIT is still needed in user_event_enabler_dup(), due to rcu lock.
V4:
Rebase to 6.1-rc7.
Moved user_events_fork() out of task signal lock and dropped use of GFP_NOWAIT. All allocations are now GFP_KERNEL or GFP_KERNEL_ACCOUNT.
Added boot parameter user_events_max= to limit global events.
Added sysctl value kernel.user_events_max to limit global events.
Added cgroup tracking of memory allocated for events.
V3:
Rebase to 6.1-rc6.
Removed RFC tag on series.
Updated documentation to reflect ABI changes.
Added self-test for ABI specific clone/fork cases.
Moved user_event_mm removal into do_exit() to ensure RSS task accounting is done properly in async fault paths. Also lets us remove the delayed mmdrop(), saving memory in each user_event_mm struct.
Fixed timing window where task exits, but write could be in-progress. During exit we now take mmap_write_lock to ensure we drain writes.
V2:
Rebase to 6.1-rc5.
Added various comments based on feedback.
Added enable_size to register struct, allows 32/64 bit addresses as long as the enable_bit fits and the address is naturally aligned.
Changed user_event_enabler_write to accept a new flag indicating if a fault fixup should be done or not. This allows user_event_enabler_create to return back failures to the user ioctl reg call and retry to fault in data.
Added tracking fork/exec/exit of tasks to have the user_event_mm lifetime tied more to the task than the file. This came with extra requirements around when you can lock, such as softirq cases, as well as a RCU pattern to ensure fork/exec/exit take minimal lock times.
Changed enablers to use a single word-aligned value for saving the bit to set and any flags, such as faulting asyncly or being freed. This was required to ensure atomic bit set/test for fork cases where taking the event_mutex is not a good scalability decision.
Added unregister IOCTL, since file lifetime no longer limits the enable time for any events (the mm does).
Updated sample code to reflect the new remote write based ABI.
Updated self-test code to reflect the new remote write based ABI.
Beau Belgrave (11):
tracing/user_events: Split header into uapi and kernel tracing/user_events: Track fork/exec/exit for mm lifetime tracing/user_events: Use remote writes for event enablement tracing/user_events: Fixup enable faults asyncly tracing/user_events: Add ioctl for disabling addresses tracing/user_events: Update self-tests to write ABI tracing/user_events: Add ABI self-test tracing/user_events: Use write ABI in example tracing/user_events: Update documentation for ABI tracing/user_events: Charge event allocs to cgroups tracing/user_events: Limit global user_event count
Documentation/trace/user_events.rst | 179 ++-- fs/exec.c | 2 + include/linux/sched.h | 5 + include/linux/user_events.h | 101 ++- include/uapi/linux/user_events.h | 81 ++ kernel/exit.c | 2 + kernel/fork.c | 2 + kernel/trace/Kconfig | 5 +- kernel/trace/trace_events_user.c | 851 +++++++++++++++--- samples/user_events/example.c | 47 +- tools/testing/selftests/user_events/Makefile | 2 +- .../testing/selftests/user_events/abi_test.c | 226 +++++ .../testing/selftests/user_events/dyn_test.c | 2 +- .../selftests/user_events/ftrace_test.c | 162 ++-- .../testing/selftests/user_events/perf_test.c | 39 +- 15 files changed, 1306 insertions(+), 400 deletions(-) create mode 100644 include/uapi/linux/user_events.h create mode 100644 tools/testing/selftests/user_events/abi_test.c
base-commit: ceaa837f96adb69c0df0397937cd74991d5d821a
Signature · 1 line
2.25.1
PATCH v9 1/11 tracing/user_events: Split header into uapi and kernel
The UAPI parts need to be split out from the kernel parts of user_events now that other parts of the kernel will reference it. Do so by moving the existing include/linux/user_events.h into include/uapi/linux/user_events.h.
--- include/linux/user_events.h | 52 ++++---------------------------- include/uapi/linux/user_events.h | 48 +++++++++++++++++++++++++++++ kernel/trace/trace_events_user.c | 5 --- 3 files changed, 54 insertions(+), 51 deletions(-) create mode 100644 include/uapi/linux/user_events.h
include/linux/user_events.h +6 -46
@@ -1,54 +1,14 @@ -/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* SPDX-License-Identifier: GPL-2.0-only */ /* -* Copyright (c) 2021, Microsoft Corporation. +* Copyright (c) 2022, Microsoft Corporation. * * Authors: * Beau Belgrave <[email protected]> */ -#ifndef _UAPI_LINUX_USER_EVENTS_H -#define _UAPI_LINUX_USER_EVENTS_H -#include <linux/types.h> -#include <linux/ioctl.h> +#ifndef _LINUX_USER_EVENTS_H +#define _LINUX_USER_EVENTS_H -#ifdef __KERNEL__ -#include <linux/uio.h> -#else -#include <sys/uio.h> -#endif +#include <uapi/linux/user_events.h> -#define USER_EVENTS_SYSTEM "user_events" -#define USER_EVENTS_PREFIX "u:" - -/* Create dynamic location entry within a 32-bit value */ -#define DYN_LOC (offset, size) ((size) << 16 | (offset)) - -/* -* 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: Pointer to string with event name, description and flags */ -__u64 name_args; - -/* Output: Bitwise index of the event within the status page */ -__u32 status_bit; - -/* Output: Index of the event to use when writing data */ -__u32 write_index; -} __attribute__((__packed__ )); - -#define DIAG_IOC_MAGIC '*' - -/* Requests to register a user_event */ -#define DIAG_IOCSREG _IOWR(DIAG_IOC_MAGIC, 0, struct user_reg*) - -/* Requests to delete a user_event */ -#define DIAG_IOCSDEL _IOW(DIAG_IOC_MAGIC, 1, char*) - -#endif /* _UAPI_LINUX_USER_EVENTS_H */ +#endif /* _LINUX_USER_EVENTS_H */
include/uapi/linux/user_events.h new file +48 -0
48 lines not on this page · raw message
kernel/trace/trace_events_user.c +0 -5
@@ -19,12 +19,7 @@#include <linux/tracefs.h> #include <linux/types.h> #include <linux/uaccess.h> -/* Reminder to move to uapi when everything works */ -#ifdef CONFIG_COMPILE_TEST #include <linux/user_events.h> -#else -#include <uapi/linux/user_events.h> -#endif #include "trace.h" #include "trace_dynevent.h"
Signature · 1 line
2.25.1
PATCH v9 2/11 tracing/user_events: Track fork/exec/exit for mm lifetime
In reply to Beau BelgraveDuring tracefs discussions it was decided instead of requiring a mapping within a user-process to track the lifetime of memory descriptors we should hook the appropriate calls. Do this by adding the minimal stubs required for task fork, exec, and exit. Currently this is just a NOP. Future patches will implement these calls fully.
--- fs/exec.c | 2 ++ include/linux/sched.h | 5 +++++ include/linux/user_events.h | 18 ++++++++++++++++++ kernel/exit.c | 2 ++ kernel/fork.c | 2 ++ 5 files changed, 29 insertions(+)
fs/exec.c +2 -0
@@ -65,6 +65,7 @@#include <linux/syscall_user_dispatch.h> #include <linux/coredump.h> #include <linux/time_namespace.h> +#include <linux/user_events.h> #include <linux/uaccess.h> #include <asm/mmu_context.h>
@@ -1856,6 +1857,7 @@ static int bprm_execve(struct linux_binprm *bprm, current->fs->in_exec =0 ; current->in_execve =0 ;rseq_execve (current); +user_events_execve (current);acct_update_integrals (current);task_numa_free (current, false);return retval;
include/linux/sched.h +5 -0
@@ -69,6 +69,7 @@ struct sighand_struct;struct signal_struct ;struct task_delay_info ;struct task_group ; +struct user_event_mm ;/* * Task state bitmask. NOTE! These bits are also
@@ -1522,6 +1523,10 @@ struct task_struct {union rv_task_monitor rv[RV_PER_TASK_MONITORS ];#endif +#ifdef CONFIG_USER_EVENTS +struct user_event_mm *user_event_mm; +#endif +/* * New fields for task_struct should be added above here, so that * they are included in the randomized portion of task_struct.
include/linux/user_events.h +18 -0
@@ -11,4 +11,22 @@#include <uapi/linux/user_events.h> +#ifdef CONFIG_USER_EVENTS +struct user_event_mm { +}; +#endif + +static inline void user_events_fork (struct task_struct *t, +unsigned long clone_flags) +{ +} + +static inline void user_events_execve (struct task_struct *t) +{ +} + +static inline void user_events_exit (struct task_struct *t) +{ +} +#endif /* _LINUX_USER_EVENTS_H */
kernel/exit.c +2 -0
@@ -68,6 +68,7 @@#include <linux/kprobes.h> #include <linux/rethook.h> #include <linux/sysfs.h> +#include <linux/user_events.h> #include <linux/uaccess.h> #include <asm/unistd.h>
@@ -816,6 +817,7 @@ void __noreturn do_exit(long code)coredump_task_exit (tsk);ptrace_event (PTRACE_EVENT_EXIT , code); +user_events_exit (tsk);validate_creds_for_do_exit (tsk);
kernel/fork.c +2 -0
@@ -97,6 +97,7 @@#include <linux/io_uring.h> #include <linux/bpf.h> #include <linux/stackprotector.h> +#include <linux/user_events.h> #include <asm/pgalloc.h> #include <linux/uaccess.h>
@@ -2502,6 +2503,7 @@ static __latent_entropy struct task_struct *copy_process(trace_task_newtask (p, clone_flags);uprobe_copy_process (p, clone_flags); +user_events_fork (p, clone_flags);copy_oom_score_adj (clone_flags, p);
Signature · 1 line
2.25.1
PATCH v9 3/11 tracing/user_events: Use remote writes for event enablement
In reply to Beau BelgraveAs part of the discussions for user_events aligned with user space tracers, it was determined that user programs should register a aligned value to set or clear a bit when an event becomes enabled. Currently a shared page is being used that requires mmap(). Remove the shared page implementation and move to a user registered address implementation.
In this new model during the event registration from user programs 3 new values are specified. The first is the address to update when the event is either enabled or disabled. The second is the bit to set/clear to reflect the event being enabled. The third is the size of the value at the specified address.
This allows for a local 32/64-bit value in user programs to support both kernel and user tracers. As an example, setting bit 31 for kernel tracers when the event becomes enabled allows for user tracers to use the other bits for ref counts or other flags. The kernel side updates the bit atomically, user programs need to also update these values atomically.
User provided addresses must be aligned on a natural boundary, this allows for single page checking and prevents odd behaviors such as a enable value straddling 2 pages instead of a single page. Currently page faults are only logged, future patches will handle these.
--- include/linux/user_events.h | 53 ++- include/uapi/linux/user_events.h | 15 +- kernel/trace/Kconfig | 5 +- kernel/trace/trace_events_user.c | 586 ++++++++++++++++++++++++------- 4 files changed, 517 insertions(+), 142 deletions(-)
include/linux/user_events.h +52 -1
@@ -9,13 +9,63 @@ #ifndef _LINUX_USER_EVENTS_H #define _LINUX_USER_EVENTS_H +#include <linux/list.h> +#include <linux/refcount.h> +#include <linux/mm_types.h> +#include <linux/workqueue.h> #include <uapi/linux/user_events.h> #ifdef CONFIG_USER_EVENTS struct user_event_mm { + struct list_head link; + struct list_head enablers; + struct mm_struct *mm; + struct user_event_mm *next; + refcount_t refcnt; + refcount_t tasks; + struct rcu_work put_rwork; }; -#endif +extern void user_event_mm_dup(struct task_struct *t, + struct user_event_mm *old_mm); + +extern void user_event_mm_remove(struct task_struct *t); + +static inline void user_events_fork(struct task_struct *t, + unsigned long clone_flags) +{ + struct user_event_mm *old_mm; + + if (!t || !current->user_event_mm) + return; + + old_mm = current->user_event_mm; + + if (clone_flags & CLONE_VM) { + t->user_event_mm = old_mm; + refcount_inc(&old_mm->tasks); + return; + } + + user_event_mm_dup(t, old_mm); +} + +static inline void user_events_execve(struct task_struct *t) +{ + if (!t || !t->user_event_mm) + return; + + user_event_mm_remove(t); +} + +static inline void user_events_exit(struct task_struct *t) +{ + if (!t || !t->user_event_mm) + return; + + user_event_mm_remove(t); +} +#else static inline void user_events_fork(struct task_struct *t, unsigned long clone_flags) {
@@ -28,5 +78,6 @@ static inline void user_events_execve(struct task_struct *t)static inline void user_events_exit (struct task_struct *t) { } +#endif /* CONFIG_USER_EVENTS */ #endif /* _LINUX_USER_EVENTS_H */
include/uapi/linux/user_events.h +12 -3
@@ -27,12 +27,21 @@ 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 for future use, set to 0 */ +__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: Bitwise index of the event within the status page */ -__u32 status_bit; -/* Output: Index of the event to use when writing data */ __u32 write_index; } __attribute__((__packed__));
kernel/trace/Kconfig +3 -2
@@ -791,9 +791,10 @@ config USER_EVENTS can be used like an existing kernel trace event. User trace events are generated by writing to a tracefs file. User processes can determine if their tracing events should be - generated by memory mapping a tracefs file and checking for - an associated byte being non-zero. + generated by registering a value and bit with the kernel + that reflects when it is enabled or not. + See Documentation/trace/user_events.rst. If in doubt, say N. config HIST_TRIGGERS
kernel/trace/trace_events_user.c +450 -136
766 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v9 4/11 tracing/user_events: Fixup enable faults asyncly
In reply to Beau BelgraveWhen events are enabled within the various tracing facilities, such as ftrace/perf, the event_mutex is held. As events are enabled pages are accessed. We do not want page faults to occur under this lock. Instead queue the fault to a workqueue to be handled in a process context safe way without the lock.
The enable address is marked faulting while the async fault-in occurs. This ensures that we don't attempt to fault-in more than is necessary. Once the page has been faulted in, an address write is re-attempted. If the page couldn't fault-in, then we wait until the next time the event is enabled to prevent any potential infinite loops.
--- kernel/trace/trace_events_user.c | 120 +++++++++++++++++++++++++++++-- 1 file changed, 114 insertions(+), 6 deletions(-)
kernel/trace/trace_events_user.c +114 -6
@@ -99,9 +99,23 @@ struct user_event_enabler {/* Bits 0-5 are for the bit to update upon enable/disable (0-63 allowed) */ #define ENABLE_VAL_BIT_MASK 0x3F +/* Bit 6 is for faulting status of enablement */ +#define ENABLE_VAL_FAULTING_BIT 6 +/* Only duplicate the bit value */ #define ENABLE_VAL_DUP_MASK ENABLE_VAL_BIT_MASK +#define ENABLE_BITOPS (e) ((unsigned long *)&(e)->values) + +/* Used for asynchronous faulting in of pages */ +struct user_event_enabler_fault { +struct work_struct work; +struct user_event_mm *mm; +struct user_event_enabler *enabler; +}; + +static struct kmem_cache *fault_cache; +/* Global list of memory descriptors using user_events */ static LIST_HEAD (user_event_mms);static DEFINE_SPINLOCK (user_event_mms_lock);
@@ -263,7 +277,85 @@ static int user_event_mm_fault_in(struct user_event_mm *mm, unsigned long uaddr) }static int user_event_enabler_write (struct user_event_mm *mm, -struct user_event_enabler *enabler) +struct user_event_enabler *enabler, +bool fixup_fault); + +static void user_event_enabler_fault_fixup (struct work_struct *work) +{ +struct user_event_enabler_fault *fault =container_of ( + work, struct user_event_enabler_fault, work); +struct user_event_enabler *enabler = fault->enabler; +struct user_event_mm *mm = fault->mm; +unsigned long uaddr = enabler->addr; +int ret; + + ret =user_event_mm_fault_in (mm, uaddr); + +if (ret && ret != -ENOENT ) { +struct user_event *user = enabler->event; + +pr_warn ("user_events: Fault for mm: 0x%pK @ 0x%llx event: %s\n" , + mm->mm, (unsigned long long )uaddr,EVENT_NAME (user)); + } + +/* Prevent state changes from racing */ +mutex_lock (&event_mutex); + +/* +* If we managed to get the page, re-issue the write. We do not +* want to get into a possible infinite loop, which is why we only +* attempt again directly if the page came in. If we couldn't get +* the page here, then we will try again the next time the event is +* enabled/disabled. +*/ +clear_bit (ENABLE_VAL_FAULTING_BIT ,ENABLE_BITOPS (enabler)); + +if (!ret) { +mmap_read_lock (mm->mm); +user_event_enabler_write (mm, enabler, true); +mmap_read_unlock (mm->mm); + } + +mutex_unlock (&event_mutex); + +/* In all cases we no longer need the mm or fault */ +user_event_mm_put (mm); +kmem_cache_free (fault_cache, fault); +} + +static bool user_event_enabler_queue_fault (struct user_event_mm *mm, +struct user_event_enabler *enabler) +{ +struct user_event_enabler_fault *fault; + + fault =kmem_cache_zalloc (fault_cache,GFP_NOWAIT | __GFP_NOWARN); + +if (!fault) +return false; + +INIT_WORK (&fault->work, user_event_enabler_fault_fixup); + fault->mm =user_event_mm_get (mm); + fault->enabler = enabler; + +/* Don't try to queue in again while we have a pending fault */ +set_bit (ENABLE_VAL_FAULTING_BIT ,ENABLE_BITOPS (enabler)); + +if (!schedule_work (&fault->work)) { +/* Allow another attempt later */ +clear_bit (ENABLE_VAL_FAULTING_BIT ,ENABLE_BITOPS (enabler)); + +user_event_mm_put (mm); +kmem_cache_free (fault_cache, fault); + +return false; + } + +return true; +} + +static int user_event_enabler_write (struct user_event_mm *mm, +struct user_event_enabler *enabler, +bool fixup_fault) {unsigned long uaddr = enabler->addr;unsigned long *ptr;
@@ -278,11 +370,19 @@ static int user_event_enabler_write(struct user_event_mm *mm,if (refcount_read (&mm->tasks) ==0 )return -ENOENT ; +if (unlikely (test_bit (ENABLE_VAL_FAULTING_BIT ,ENABLE_BITOPS (enabler)))) +return -EBUSY ; + ret =pin_user_pages_remote (mm->mm, uaddr,1 ,FOLL_WRITE |FOLL_NOFAULT , &page,NULL ,NULL ); -if (ret <=0 ) { -pr_warn ("user_events: Enable write failed\n" ); +if (unlikely (ret <=0 )) { +if (!fixup_fault) +return -EFAULT ; + +if (!user_event_enabler_queue_fault (mm, enabler)) +pr_warn ("user_events: Unable to queue fault handler\n" ); +return -EFAULT ; }
@@ -314,7 +414,7 @@ static void user_event_enabler_update(struct user_event *user)list_for_each_entry_rcu (enabler, &mm->enablers, link)if (enabler->event == user) -user_event_enabler_write (mm, enabler); +user_event_enabler_write (mm, enabler, true);rcu_read_unlock ();mmap_read_unlock (mm->mm);
@@ -562,7 +662,7 @@ static struct user_event_enabler/* Attempt to reflect the current state within the process */ mmap_read_lock (user_mm->mm); - *write_result =user_event_enabler_write (user_mm, enabler); + *write_result =user_event_enabler_write (user_mm, enabler, false);mmap_read_unlock (user_mm->mm);/*
@@ -2201,16 +2301,24 @@ static int __init trace_events_user_init(void) {int ret; + fault_cache =KMEM_CACHE (user_event_enabler_fault,0 ); + +if (!fault_cache) +return -ENOMEM ; + init_group =user_event_group_create (&init_user_ns); -if (!init_group) +if (!init_group) { +kmem_cache_destroy (fault_cache);return -ENOMEM ; + } ret =create_user_tracefs ();if (ret) {pr_warn ("user_events could not register with tracefs\n" );user_event_group_destroy (init_group); +kmem_cache_destroy (fault_cache); init_group =NULL ;return ret; }
Signature · 1 line
2.25.1
PATCH v9 5/11 tracing/user_events: Add ioctl for disabling addresses
In reply to Beau BelgraveEnablements are now tracked by the lifetime of the task/mm. User processes need to be able to disable their addresses if tracing is requested to be turned off. Before unmapping the page would suffice. However, we now need a stronger contract. Add an ioctl to enable this.
A new flag bit is added, freeing, to user_event_enabler to ensure that if the event is attempted to be removed while a fault is being handled that the remove is delayed until after the fault is reattempted.
--- include/uapi/linux/user_events.h | 24 +++++++++ kernel/trace/trace_events_user.c | 93 +++++++++++++++++++++++++++++++- 2 files changed, 115 insertions(+), 2 deletions(-)
include/uapi/linux/user_events.h +24 -0
@@ -46,6 +46,27 @@ struct user_reg {__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 */
@@ -54,4 +75,7 @@ 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 */
kernel/trace/trace_events_user.c +91 -2
135 lines not on this page · raw message
Signature · 1 line
2.25.1
Steven Rostedt
maintainerRe: [PATCH v9 05/11] tracing/user_events: Add ioctl for disabling addresses
Quoted 29 lines · On Fri, 24 Mar 2023 15:30:22 -0700 Beau Belgrave <[email protected]>…
Enablements are now tracked by the lifetime of the task/mm. User processes need to be able to disable their addresses if tracing is requested to be turned off. Before unmapping the page would suffice. However, we now need a stronger contract. Add an ioctl to enable this.
A new flag bit is added, freeing, to
user_event_enablerto ensure that if the event is attempted to be removed while a fault is being handled that the remove is delayed until after the fault is reattempted.Signed-off-by Beau Belgrave <[email protected]>--- include/uapi/linux/user_events.h | 24 +++++++++ kernel/trace/trace_events_user.c | 93 +++++++++++++++++++++++++++++++- 2 files changed, 115 insertions(+), 2 deletions(-)include/uapi/linux/user_events.h +6
-0@@ -46,6 +46,27 @@ struct user_reg {__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 */
include/uapi/linux/user_events.h struct user_reg { · line 64
Quoted 10 lines
include/uapi/linux/user_events.h +10
-0+__u32 size; + +/* Input: Bit to unregister */ +__u8 disable_bit; + +/* Input: Reserved, set to 0 */ +__u8 __reserved; + +/* Input: Reserved, set to 0 */ +__u16 __reserved2;
These are reserved so they must be set to zero, such that old programs do not break when they become meaningful and something had it randomly set (due to being uninitialized).
Quoted 44 lines
include/uapi/linux/user_events.h +37
-0+ +/* Input: Address to unregister */ +__u64 disable_addr; +} __attribute__((__packed__)); +#define DIAG_IOC_MAGIC '*'@@ -2086,6 +2100,75 @@ static long user_events_ioctl_del(struct user_event_file_info *info,return ret; } +static long user_unreg_get (struct user_unreg __user *ureg, +struct user_unreg *kreg) +{ +u32 size; +long ret; + + ret =get_user (size, &ureg->size); + +if (ret) +return ret; + +if (size >PAGE_SIZE ) +return -E2BIG ; + + if (size < offsetofend(struct user_unreg, disable_addr)) +return -EINVAL ; + + ret =copy_struct_from_user (kreg,sizeof (*kreg), ureg, size); + +return ret; +} + +/* +* Unregisters an enablement address/bit within a task/user mm. +*/ +static long user_events_ioctl_unreg (unsigned long uarg) +{ +struct user_unreg __user *ureg = (struct user_unreg __user *)uarg; +struct user_event_mm *mm = current->user_event_mm; +struct user_event_enabler *enabler, *next; +struct user_unreg reg; +long ret;
include/uapi/linux/user_events.h static long user_events_ioctl_del(struct user_event_file_info *info, · line 2144
Quoted 10 lines
include/uapi/linux/user_events.h +10
-0+ + ret =user_unreg_get (ureg, ®); + +if (ret) +return ret; + +if (!mm) +return -ENOENT ; + + ret = -ENOENT ;
Probably should add:
if (reg.__reserved || reg.__reserved2) return -EINVAL;
here.
-- Steve
Quoted 43 lines
include/uapi/linux/user_events.h +33
-0+ +/* +* Flags freeing and faulting are used to indicate if the enabler is in +* use at all. When faulting is set a page-fault is occurring asyncly. +* During async fault if freeing is set, the enabler will be destroyed. +* If no async fault is happening, we can destroy it now since we hold +* the event_mutex during these checks. +*/ +mutex_lock (&event_mutex); + +list_for_each_entry_safe (enabler, next, &mm->enablers, link) +if (enabler->addr == reg.disable_addr && + (enabler->values &ENABLE_VAL_BIT_MASK ) == reg.disable_bit) { +set_bit (ENABLE_VAL_FREEING_BIT ,ENABLE_BITOPS (enabler)); + +if (!test_bit (ENABLE_VAL_FAULTING_BIT ,ENABLE_BITOPS (enabler))) +user_event_enabler_destroy (enabler); + +/* Removed at least one */ + ret =0 ; + } + +mutex_unlock (&event_mutex); + +return ret; +} +/* * Handles the ioctl from user mode to register or alter operations. */ @@ -2108,6 +2191,12 @@ static long user_events_ioctl(struct file *file, unsigned int cmd, ret =user_events_ioctl_del (info, uarg);mutex_unlock (&group->reg_mutex);break ; + +case DIAG_IOCSUNREG : +mutex_lock (&group->reg_mutex); + ret =user_events_ioctl_unreg (uarg); +mutex_unlock (&group->reg_mutex); +break ; }return ret;
Steven Rostedt
maintainerRe: [PATCH v9 05/11] tracing/user_events: Add ioctl for disabling addresses
Quoted 20 lines · On Tue, 28 Mar 2023 17:32:00 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 7 lines
kernel/trace/trace_events_user.c +7
-0+static long user_events_ioctl_unreg (unsigned long uarg) +{ +struct user_unreg __user *ureg = (struct user_unreg __user *)uarg; +struct user_event_mm *mm = current->user_event_mm; +struct user_event_enabler *enabler, *next; +struct user_unreg reg; +long ret;kernel/trace/trace_events_user.c static long user_events_ioctl_del(struct user_event_file_info *info, · line 2144
Quoted 10 lines
kernel/trace/trace_events_user.c +10
-0+ + ret =user_unreg_get (ureg, ®); + +if (ret) +return ret; + +if (!mm) +return -ENOENT ; + + ret = -ENOENT ;Probably should add:
Quoted 4 lines
if (reg.__reserved || reg.__reserved2) return -EINVAL;here.
I finished my review.
Can to send a v10 out with this update, and also update all the structs to have the fields tabbed out for easier reading.
Thanks!
-- Steve
Re: [PATCH v9 05/11] tracing/user_events: Add ioctl for disabling addresses
Quoted 23 lines · Steven Rostedt
Quoted 20 lines · On Tue, 28 Mar 2023 17:32:00 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 7 lines
kernel/trace/trace_events_user.c +7
-0+static long user_events_ioctl_unreg (unsigned long uarg) +{ +struct user_unreg __user *ureg = (struct user_unreg __user *)uarg; +struct user_event_mm *mm = current->user_event_mm; +struct user_event_enabler *enabler, *next; +struct user_unreg reg; +long ret;kernel/trace/trace_events_user.c static long user_events_ioctl_del(struct user_event_file_info *info, · line 2144
Quoted 10 lines
kernel/trace/trace_events_user.c +10
-0+ + ret =user_unreg_get (ureg, ®); + +if (ret) +return ret; + +if (!mm) +return -ENOENT ; + + ret = -ENOENT ;Probably should add:
Quoted 4 lines
Quoted 4 lines
if (reg.__reserved || reg.__reserved2) return -EINVAL;here.
Nice catch! Yes I'll add this.
Quoted 6 lines
I finished my review.
Can to send a v10 out with this update, and also update all the structs to have the fields tabbed out for easier reading.
Yep will do, I will have the tabbed out changes in a isolated patch in the v10 series.
Thanks,
-Beau
Quoted 3 lines
Thanks!
-- Steve
PATCH v9 6/11 tracing/user_events: Update self-tests to write ABI
In reply to Beau BelgraveABI has been changed to remote writes, update existing test cases to use this new ABI to ensure existing functionality continues to work.
--- .../testing/selftests/user_events/dyn_test.c | 2 +- .../selftests/user_events/ftrace_test.c | 162 ++++++++++-------- .../testing/selftests/user_events/perf_test.c | 39 ++--- 3 files changed, 105 insertions(+), 98 deletions(-)
tools/testing/selftests/user_events/dyn_test.c +1 -1
@@ -16,7 +16,7 @@#include "../kselftest_harness.h" -const char *dyn_file ="/sys/kernel/debug/tracing/dynamic_events" ; +const char *dyn_file ="/sys/kernel/tracing/dynamic_events" ;const char *clear ="!u:__test_event" ;static int Append (const char *value)
tools/testing/selftests/user_events/ftrace_test.c +88 -74
365 lines not on this page · raw message
tools/testing/selftests/user_events/perf_test.c +16 -23
@@ -18,10 +18,9 @@#include "../kselftest_harness.h" -const char *data_file ="/sys/kernel/debug/tracing/user_events_data" ; -const char *status_file ="/sys/kernel/debug/tracing/user_events_status" ; -const char *id_file ="/sys/kernel/debug/tracing/events/user_events/__test_event/id" ; -const char *fmt_file ="/sys/kernel/debug/tracing/events/user_events/__test_event/format" ; +const char *data_file ="/sys/kernel/tracing/user_events_data" ; +const char *id_file ="/sys/kernel/tracing/events/user_events/__test_event/id" ; +const char *fmt_file ="/sys/kernel/tracing/events/user_events/__test_event/format" ;struct event {__u32 index;
@@ -35,11 +34,6 @@ static long perf_event_open(struct perf_event_attr *pe, pid_t pid,return syscall (__NR_perf_event_open, pe, pid, cpu, group_fd, flags); } -static inline int status_check (char *status_page,int status_bit) -{ -return status_page[status_bit >>3 ] & (1 << (status_bit &7 )); -} -static int get_id (void ) {FILE *fp =fopen (id_file,"r" );
@@ -88,45 +82,38 @@ static int get_offset(void) }FIXTURE (user) { -int status_fd;int data_fd; +int check; };FIXTURE_SETUP (user) { - self->status_fd =open (status_file,O_RDONLY ); -ASSERT_NE (-1 , self->status_fd); - self->data_fd =open (data_file,O_RDWR );ASSERT_NE (-1 , self->data_fd); }FIXTURE_TEARDOWN (user) { -close (self->status_fd);close (self->data_fd); } TEST_F(user, perf_write) {struct perf_event_attr pe = {0 };struct user_reg reg = {0 }; -int page_size =sysconf (_SC_PAGESIZE); -char *status_page;struct event event;struct perf_event_mmap_page *perf_page; +int page_size =sysconf (_SC_PAGESIZE);int id, fd, offset;__u32 *val; reg.size =sizeof (reg); reg.name_args = (__u64 )"__test_event u32 field1; u32 field2" ; - - status_page =mmap (NULL , page_size,PROT_READ ,MAP_SHARED , - self->status_fd,0 ); -ASSERT_NE (MAP_FAILED , status_page); + reg.enable_bit =31 ; + reg.enable_addr = (__u64)&self->check; + reg.enable_size =sizeof (self->check);/* Register should work */ ASSERT_EQ (0 ,ioctl (self->data_fd,DIAG_IOCSREG , ®));ASSERT_EQ (0 , reg.write_index); -ASSERT_NE (0 , reg.status_bit); -ASSERT_EQ (0 ,status_check (status_page, reg.status_bit)); +ASSERT_EQ (0 , self->check);/* Id should be there */ id =get_id ();
@@ -149,7 +136,7 @@ TEST_F(user, perf_write) {ASSERT_NE (MAP_FAILED , perf_page);/* Status should be updated */ -ASSERT_NE (0 ,status_check (status_page, reg.status_bit)); +ASSERT_EQ (1 << reg.enable_bit, self->check); event.index = reg.write_index; event.field1 =0xc001 ;
@@ -165,6 +152,12 @@ TEST_F(user, perf_write) {/* Ensure correct */ ASSERT_EQ (event.field1, *val++);ASSERT_EQ (event.field2, *val++); + +munmap (perf_page, page_size *2 ); +close (fd); + +/* Status should be updated */ +ASSERT_EQ (0 , self->check); }int main (int argc,char **argv)
Signature · 1 line
2.25.1
PATCH v9 7/11 tracing/user_events: Add ABI self-test
In reply to Beau BelgraveAdd ABI specific self-test to ensure enablements work in various scenarios such as fork, VM_CLONE, and basic event enable/disable. Ensure ABI contracts/limits are also being upheld, such as bit limits and data size limits.
--- tools/testing/selftests/user_events/Makefile | 2 +- .../testing/selftests/user_events/abi_test.c | 226 ++++++++++++++++++ 2 files changed, 227 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/user_events/abi_test.c
tools/testing/selftests/user_events/Makefile +1 -1
@@ -2,7 +2,7 @@ CFLAGS += -Wl,-no-as-needed -Wall -I../../../../usr/include LDLIBS += -lrt -lpthread -lm -TEST_GEN_PROGS = ftrace_test dyn_test perf_test +TEST_GEN_PROGS = ftrace_test dyn_test perf_test abi_test TEST_FILES := settings
tools/testing/selftests/user_events/abi_test.c new file +226 -0
226 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v9 8/11 tracing/user_events: Use write ABI in example
In reply to Beau BelgraveThe ABI has changed to use a remote write approach. Update the example to show the expected use of this new ABI. Also remove debugfs path and use tracefs to ensure example works in more environments.
--- samples/user_events/example.c | 47 +++++++---------------------------- 1 file changed, 9 insertions(+), 38 deletions(-)
samples/user_events/example.c +9 -38
@@ -9,51 +9,28 @@#include <errno.h> #include <sys/ioctl.h> #include <sys/mman.h> +#include <sys/uio.h> #include <fcntl.h> #include <stdio.h> #include <unistd.h> -#include <asm/bitsperlong.h> -#include <endian.h> #include <linux/user_events.h> -#if __BITS_PER_LONG ==64 -#define endian_swap (x) htole64(x) -#else -#define endian_swap (x) htole32(x) -#endif +const char *data_file ="/sys/kernel/tracing/user_events_data" ; +int enabled =0 ; -/* Assumes debugfs is mounted */ -const char *data_file ="/sys/kernel/debug/tracing/user_events_data" ; -const char *status_file ="/sys/kernel/debug/tracing/user_events_status" ; - -static int event_status (long **status) -{ -int fd =open (status_file,O_RDONLY ); - - *status =mmap (NULL ,sysconf (_SC_PAGESIZE),PROT_READ , -MAP_SHARED , fd,0 ); - -close (fd); - -if (*status ==MAP_FAILED ) -return -1 ; - -return 0 ; -} - -static int event_reg (int fd,const char *command,long *index,long *mask, -int *write) +static int event_reg (int fd,const char *command,int *write,int *enabled) {struct user_reg reg = {0 }; reg.size =sizeof (reg); + reg.enable_bit =31 ; + reg.enable_size =sizeof (*enabled); + reg.enable_addr = (__u64 )enabled; reg.name_args = (__u64 )command;if (ioctl (fd,DIAG_IOCSREG , ®) ==-1 )return -1 ; - *index = reg.status_bit / __BITS_PER_LONG; - *mask =endian_swap (1L << (reg.status_bit % __BITS_PER_LONG)); *write = reg.write_index;return 0 ;
@@ -62,17 +39,12 @@ static int event_reg(int fd, const char *command, long *index, long *mask,int main (int argc,char **argv) {int data_fd, write; -long index, mask; -long *status_page;struct iovec io[2 ];__u32 count =0 ; -if (event_status (&status_page) ==-1 ) -return errno; - data_fd =open (data_file,O_RDWR ); -if (event_reg (data_fd,"test u32 count" , &index, &mask, &write) ==-1 ) +if (event_reg (data_fd,"test u32 count" , &write, &enabled) ==-1 )return errno;/* Setup iovec */
@@ -80,13 +52,12 @@ int main(int argc, char **argv) io[0 ].iov_len =sizeof (write); io[1 ].iov_base = &count; io[1 ].iov_len =sizeof (count); - ask:printf ("Press enter to check status...\n" );getchar ();/* Check if anyone is listening */ -if (status_page[index] & mask) { +if (enabled) {/* Yep, trace out our data */ writev (data_fd, (const struct iovec *)io,2 );
Signature · 1 line
2.25.1
PATCH v9 9/11 tracing/user_events: Update documentation for ABI
In reply to Beau BelgraveThe ABI for user_events has changed from mmap() based to remote writes. Update the documentation to reflect these changes, add new section for unregistering events since lifetime is now tied to tasks instead of files.
--- Documentation/trace/user_events.rst | 179 ++++++++++++++++------------ 1 file changed, 103 insertions(+), 76 deletions(-)
Documentation/trace/user_events.rst +103 -76
@@ -11,20 +11,19 @@ that can be viewed via existing tools, such as ftrace and perf. To enable this feature, build your kernel with CONFIG_USER_EVENTS=y. Programs can view status of the events via -/sys/kernel/debug/tracing/user_events_status and can both register and write -data out via /sys/kernel/debug/tracing/user_events_data. +/sys/kernel/tracing/user_events_status and can both register and write +data out via /sys/kernel/tracing/user_events_data. -Programs can also use /sys/kernel/debug/tracing/dynamic_events to register and +Programs can also use /sys/kernel/tracing/dynamic_events to register and delete user based events via the u: prefix. The format of the command to dynamic_events is the same as the ioctl with the u: prefix applied. Typically programs will register a set of events that they wish to expose to tools that can read trace_events (such as ftrace and perf). The registration -process gives back two ints to the program for each event. The first int is -the status bit. This describes which bit in little-endian format in the -/sys/kernel/debug/tracing/user_events_status file represents this event. The -second int is the write index which describes the data when a write() or -writev() is called on the /sys/kernel/debug/tracing/user_events_data file. +process tells the kernel which address and bit to reflect if any tool has +enabled the event and data should be written. The registration will give back +a write index which describes the data when a write() or writev() is called +on the /sys/kernel/tracing/user_events_data file. The structures referenced in this document are contained within the /include/uapi/linux/user_events.h file in the source tree.
@@ -35,29 +34,70 @@ filesystem and may be mounted at different paths than above.* Registering ----------- Registering within a user process is done via ioctl() out to the -/sys/kernel/debug/tracing/user_events_data file. The command to issue is +/sys/kernel/tracing/user_events_data file. The command to issue is DIAG_IOCSREG. This command takes a packed struct user_reg as an argument:: struct user_reg { - u32 size; - u64 name_args; - u32 status_bit; - u32 write_index; - }; + /* 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 for future use, set to 0 */ + __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__)); + +The struct user_reg requires all the above inputs to be set appropriately. + ++ size: This must be set to sizeof(struct user_reg). -The struct user_reg requires two inputs, the first is the size of the structure -to ensure forward and backward compatibility. The second is the command string -to issue for registering. Upon success two outputs are set, the status bit -and the write index. ++ enable_bit: The bit to reflect the event status at the address specified by + enable_addr. + ++ enable_size: The size of the value specified by enable_addr. + This must be 4 (32-bit) or 8 (64-bit). 64-bit values are only allowed to be + used on 64-bit kernels, however, 32-bit can be used on all kernels. + ++ flags: The flags to use, if any. For the initial version this must be 0. + Callers should first attempt to use flags and retry without flags to ensure + support for lower versions of the kernel. If a flag is not supported -EINVAL + is returned. + ++ enable_addr: The address of the value to use to reflect event status. This + must be naturally aligned and write accessible within the user program. + ++ name_args: The name and arguments to describe the event, see command format + for details. + +Upon successful registration the following is set. + ++ write_index: The index to use for this file descriptor that represents this + event when writing out data. The index is unique to this instance of the file + descriptor that was used for the registration. See writing data for details. User based events show up under tracefs like any other event under the subsystem named "user_events". This means tools that wish to attach to the -events need to use /sys/kernel/debug/tracing/events/user_events/[name]/enable +events need to use /sys/kernel/tracing/events/user_events/[name]/enable or perf record -e user_events:[name] when attaching/recording. -**NOTE:** *The write_index returned is only valid for the FD that was used* +**NOTE:** The event subsystem name by default is "user_events". Callers should +not assume it will always be "user_events". Operators reserve the right in the +future to change the subsystem name per-process to accomodate event isolation. Command Format ^^^^^^^^^^^^^^
@@ -94,9 +134,9 @@ Would be represented by the following field:: struct mytype myname 20 Deleting ------------ +-------- Deleting an event from within a user process is done via ioctl() out to the -/sys/kernel/debug/tracing/user_events_data file. The command to issue is +/sys/kernel/tracing/user_events_data file. The command to issue is DIAG_IOCSDEL. This command only requires a single string specifying the event to delete by
@@ -104,92 +144,79 @@ its name. Delete will only succeed if there are no references left to the event (in both user and kernel space). User programs should use a separate file to request deletes than the one used for registration due to this. -Status ------- -When tools attach/record user based events the status of the event is updated -in realtime. This allows user programs to only incur the cost of the write() or -writev() calls when something is actively attached to the event. - -User programs call mmap() on /sys/kernel/debug/tracing/user_events_status to -check the status for each event that is registered. The bit to check in the -file is given back after the register ioctl() via user_reg.status_bit. The bit -is always in little-endian format. Programs can check if the bit is set either -using a byte-wise index with a mask or a long-wise index with a little-endian -mask. +Unregistering +------------- +If after registering an event it is no longer wanted to be updated then it can +be disabled via ioctl() out to the /sys/kernel/tracing/user_events_data file. +The command to issue is DIAG_IOCSUNREG. This is different than deleting, where +deleting actually removes the event from the system. Unregistering simply tells +the kernel your process is no longer interested in updates to the event. -Currently the size of user_events_status is a single page, however, custom -kernel configurations can change this size to allow more user based events. In -all cases the size of the file is a multiple of a page size. +This command takes a packed struct user_unreg as an argument:: -For example, if the register ioctl() gives back a status_bit of 3 you would -check byte 0 (3 / 8) of the returned mmap data and then AND the result with 8 -(1 << (3 % 8)) to see if anything is attached to that event. + struct user_unreg { + /* Input: Size of the user_unreg structure being used */ + __u32 size; -A byte-wise index check is performed as follows:: + /* Input: Bit to unregister */ + __u8 disable_bit; - int index, mask; - char *status_page; + /* Input: Reserved, set to 0 */ + __u8 __reserved; - index = status_bit / 8; - mask = 1 << (status_bit % 8); - - ... + /* Input: Reserved, set to 0 */ + __u16 __reserved2; - if (status_page[index] & mask) { - /* Enabled */ - } + /* Input: Address to unregister */ + __u64 disable_addr; + } __attribute__((__packed__)); -A long-wise index check is performed as follows:: +The struct user_unreg requires all the above inputs to be set appropriately. - #include <asm/bitsperlong.h> - #include <endian.h> ++ size: This must be set to sizeof(struct user_unreg). - #if __BITS_PER_LONG == 64 - #define endian_swap(x) htole64(x) - #else - #define endian_swap(x) htole32(x) - #endif ++ disable_bit: This must be set to the bit to disable (same bit that was + previously registered via enable_bit). - long index, mask, *status_page; ++ disable_addr: This must be set to the address to disable (same address that was + previously registered via enable_addr). - index = status_bit / __BITS_PER_LONG; - mask = 1L << (status_bit % __BITS_PER_LONG); - mask = endian_swap(mask); +**NOTE:** Events are automatically unregistered when execve() is invoked. During +fork() the registered events will be retained and must be unregistered manually +in each process if wanted. - ... +Status +------ +When tools attach/record user based events the status of the event is updated +in realtime. This allows user programs to only incur the cost of the write() or +writev() calls when something is actively attached to the event. - if (status_page[index] & mask) { - /* Enabled */ - } +The kernel will update the specified bit that was registered for the event as +tools attach/detach from the event. User programs simply check if the bit is set +to see if something is attached or not. Administrators can easily check the status of all registered events by reading the user_events_status file directly via a terminal. The output is as follows:: - Byte:Name [# Comments] + Name [# Comments] ... Active: ActiveCount Busy: BusyCount - Max: MaxCount For example, on a system that has a single event the output looks like this:: - 1:test + test Active: 1 Busy: 0 - Max: 32768 If a user enables the user event via ftrace, the output would change to this:: - 1:test # Used by ftrace + test # Used by ftrace Active: 1 Busy: 1 - Max: 32768 - -**NOTE:** *A status bit of 0 will never be returned. This allows user programs -to have a bit that can be used on error cases.* Writing Data ------------
@@ -217,7 +244,7 @@ For example, if I have a struct like this:: int src; int dst; int flags; - }; + } __attribute__((__packed__)); It's advised for user programs to do the following::
Signature · 1 line
2.25.1
PATCH v9 10/11 tracing/user_events: Charge event allocs to cgroups
In reply to Beau BelgraveOperators need a way to limit how much memory cgroups use. User events need to be included into that accounting. Fix this by using GFP_KERNEL_ACCOUNT for allocations generated by user programs for user_event tracing.
--- kernel/trace/trace_events_user.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-)
kernel/trace/trace_events_user.c +10 -10
@@ -442,7 +442,7 @@ static bool user_event_enabler_dup(struct user_event_enabler *orig,if (unlikely (test_bit (ENABLE_VAL_FREEING_BIT ,ENABLE_BITOPS (orig))))return true; - enabler =kzalloc (sizeof (*enabler),GFP_NOWAIT ); + enabler =kzalloc (sizeof (*enabler),GFP_NOWAIT | __GFP_ACCOUNT);if (!enabler)return false;
@@ -502,7 +502,7 @@ static struct user_event_mm *user_event_mm_create(struct task_struct *t)struct user_event_mm *user_mm;unsigned long flags; - user_mm =kzalloc (sizeof (*user_mm),GFP_KERNEL ); + user_mm =kzalloc (sizeof (*user_mm),GFP_KERNEL_ACCOUNT );if (!user_mm)return NULL ;
@@ -662,7 +662,7 @@ static struct user_event_enablerif (!user_mm)return NULL ; - enabler =kzalloc (sizeof (*enabler),GFP_KERNEL ); + enabler =kzalloc (sizeof (*enabler),GFP_KERNEL_ACCOUNT );if (!enabler) goto out;
@@ -870,7 +870,7 @@ static int user_event_add_field(struct user_event *user, const char *type,struct ftrace_event_field *field;int validator_flags =0 ; - field =kmalloc (sizeof (*field),GFP_KERNEL ); + field =kmalloc (sizeof (*field),GFP_KERNEL_ACCOUNT );if (!field)return -ENOMEM ;
@@ -889,7 +889,7 @@ static int user_event_add_field(struct user_event *user, const char *type,if (strstr (type,"char" ) !=NULL ) validator_flags |=VALIDATOR_ENSURE_NULL ; - validator =kmalloc (sizeof (*validator),GFP_KERNEL ); + validator =kmalloc (sizeof (*validator),GFP_KERNEL_ACCOUNT );if (!validator) {kfree (field);
@@ -1175,7 +1175,7 @@ static int user_event_create_print_fmt(struct user_event *user) len =user_event_set_print_fmt (user,NULL ,0 ); - print_fmt =kmalloc (len,GFP_KERNEL ); + print_fmt =kmalloc (len,GFP_KERNEL_ACCOUNT );if (!print_fmt)return -ENOMEM ;
@@ -1508,7 +1508,7 @@ static int user_event_create(const char *raw_command) raw_command +=USER_EVENTS_PREFIX_LEN ; raw_command =skip_spaces (raw_command); - name =kstrdup (raw_command,GFP_KERNEL ); + name =kstrdup (raw_command,GFP_KERNEL_ACCOUNT );if (!name)return -ENOMEM ;
@@ -1704,7 +1704,7 @@ static int user_event_parse(struct user_event_group *group, char *name,return 0 ; } - user =kzalloc (sizeof (*user),GFP_KERNEL ); + user =kzalloc (sizeof (*user),GFP_KERNEL_ACCOUNT );if (!user)return -ENOMEM ;
@@ -1874,7 +1874,7 @@ static int user_events_open(struct inode *node, struct file *file)if (!group)return -ENOENT ; - info =kzalloc (sizeof (*info),GFP_KERNEL ); + info =kzalloc (sizeof (*info),GFP_KERNEL_ACCOUNT );if (!info)return -ENOMEM ;
@@ -1927,7 +1927,7 @@ static int user_events_ref_add(struct user_event_file_info *info, size =struct_size (refs, events, count +1 ); - new_refs =kzalloc (size,GFP_KERNEL ); + new_refs =kzalloc (size,GFP_KERNEL_ACCOUNT );if (!new_refs)return -ENOMEM ;
Signature · 1 line
2.25.1
PATCH v9 11/11 tracing/user_events: Limit global user_event count
In reply to Beau BelgraveOperators want to be able to ensure enough tracepoints exist on the system for kernel components as well as for user components. Since there are only up to 64K events, by default allow up to half to be used by user events.
Add a kernel sysctl parameter (kernel.user_events_max) to set a global limit that is honored among all groups on the system. This ensures hard limits can be setup to prevent user processes from consuming all event IDs on the system.
--- kernel/trace/trace_events_user.c | 47 ++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+)
kernel/trace/trace_events_user.c +47 -0
@@ -20,6 +20,7 @@#include <linux/types.h> #include <linux/uaccess.h> #include <linux/highmem.h> +#include <linux/init.h> #include <linux/user_events.h> #include "trace.h" #include "trace_dynevent.h"
@@ -61,6 +62,12 @@ struct user_event_group {/* Group for init_user_ns mapping, top-most group */ static struct user_event_group *init_group; +/* Max allowed events for the whole system */ +static unsigned int max_user_events =32768 ; + +/* Current number of events on the whole system */ +static unsigned int current_user_events; +/* * Stores per-event properties, as users register events * within a file a user_event might be created if it does not
@@ -1241,6 +1248,8 @@ static int destroy_user_event(struct user_event *user) {int ret =0 ; +lockdep_assert_held (&event_mutex); +/* Must destroy fields before call removal */ user_event_destroy_fields (user);
@@ -1257,6 +1266,11 @@ static int destroy_user_event(struct user_event *user)kfree (EVENT_NAME (user));kfree (user); +if (current_user_events >0 ) + current_user_events--; +else +pr_alert ("BUG: Bad current_user_events\n" ); +return ret; }
@@ -1744,6 +1758,11 @@ static int user_event_parse(struct user_event_group *group, char *name,mutex_lock (&event_mutex); +if (current_user_events >= max_user_events) { + ret = -EMFILE ; + goto put_user_lock; + } + ret =user_event_trace_register (user);if (ret)
@@ -1755,6 +1774,7 @@ static int user_event_parse(struct user_event_group *group, char *name,dyn_event_init (&user->devent, &user_event_dops);dyn_event_add (&user->devent, &user->call);hash_add (group->register_table, &user->node, key); + current_user_events++;mutex_unlock (&event_mutex);
@@ -2386,6 +2406,31 @@ static int create_user_tracefs(void)return -ENODEV ; } +static int set_max_user_events_sysctl (struct ctl_table *table,int write, +void *buffer,size_t *lenp,loff_t *ppos) +{ +int ret; + +mutex_lock (&event_mutex); + + ret =proc_douintvec (table, write, buffer, lenp, ppos); + +mutex_unlock (&event_mutex); + +return ret; +} + +static struct ctl_table user_event_sysctls[] = { + { + .procname ="user_events_max" , + .data = &max_user_events, + .maxlen =sizeof (unsigned int ), + .mode =0644 , + .proc_handler = set_max_user_events_sysctl, + }, + {} +}; +static int __init trace_events_user_init (void ) {int ret;
@@ -2415,6 +2460,8 @@ static int __init trace_events_user_init(void)if (dyn_event_register (&user_event_dops))pr_warn ("user_events could not register with dyn_events\n" ); +register_sysctl_init ("kernel" , user_event_sysctls); +return 0 ; }
Signature · 1 line
2.25.1
Quoted 23 lines · On Fri, 24 Mar 2023 15:30:17 -0700 Beau Belgrave <[email protected]>…
As part of the discussions for
user_eventsaligned with user space tracers, it was determined that user programs should register a aligned value to set or clear a bit when an event becomes enabled. Currently a shared page is being used that requiresmmap(). Remove the shared page implementation and move to a user registered address implementation.In this new model during the event registration from user programs 3 new values are specified. The first is the address to update when the event is either enabled or disabled. The second is the bit to set/clear to reflect the event being enabled. The third is the size of the value at the specified address.
This allows for a local 32/64-bit value in user programs to support both kernel and user tracers. As an example, setting bit 31 for kernel tracers when the event becomes enabled allows for user tracers to use the other bits for ref counts or other flags. The kernel side updates the bit atomically, user programs need to also update these values atomically.
User provided addresses must be aligned on a natural boundary, this allows for single page checking and prevents odd behaviors such as a enable value straddling 2 pages instead of a single page.
Quoted 6 lines
When page faults are encountered they are done asyncly via a workqueue. If the page faults back in, the write update is attempted again. If the page cannot fault-in, then we log and wait until the next time the event is enabled/disabled. This is to prevent possible infinite loops resulting from bad user processes unmapping or changing protection values after registering the address.
This series looks good to me.
for the series.
Thank you!
Quoted 125 lines
Change history
V9:
Updated documentation to include__packedattributed in example payload.Removed boot argument for max events, since sysctl can now be set via kernel boot parameters.
V8:
Rebase to 6.2-rc8.V7:
Rebase to 6.2-rc4.Added flags to register ioctl, validates it's 0 for now. Future patches will enable other types of formats/options as needed.
V6:
Rebase to 6.2-rc2.Fixed small typos, code style.
Changed from
synchronize_rcu()toqueue_rcu_work()to allow an rcu delay asyncly when mm is being removed and in an appropriate context formmdrop().V5:
GFP_NOWAITis still needed inuser_event_enabler_dup(), due to rcu lock.V4:
Rebase to 6.1-rc7.Moved
user_events_fork()out of task signal lock and dropped use ofGFP_NOWAIT. All allocations are nowGFP_KERNELorGFP_KERNEL_ACCOUNT.Added boot parameter user_events_max= to limit global events.
Added sysctl value kernel.user_events_max to limit global events.
Added cgroup tracking of memory allocated for events.
V3:
Rebase to 6.1-rc6.Removed RFC tag on series.
Updated documentation to reflect ABI changes.
Added self-test for ABI specific clone/fork cases.
Moved
user_event_mmremoval intodo_exit()to ensure RSS task accounting is done properly in async fault paths. Also lets us remove the delayedmmdrop(), saving memory in eachuser_event_mmstruct.Fixed timing window where task exits, but write could be in-progress. During exit we now take
mmap_write_lockto ensure we drain writes.V2:
Rebase to 6.1-rc5.Added various comments based on feedback.
Added
enable_sizeto register struct, allows 32/64 bit addresses as long as theenable_bitfits and the address is naturally aligned.Changed
user_event_enabler_writeto accept a new flag indicating if a fault fixup should be done or not. This allowsuser_event_enabler_createto return back failures to the user ioctl reg call and retry to fault in data.Added tracking fork/exec/exit of tasks to have the
user_event_mmlifetime tied more to the task than the file. This came with extra requirements around when you can lock, such as softirq cases, as well as a RCU pattern to ensure fork/exec/exit take minimal lock times.Changed enablers to use a single word-aligned value for saving the bit to set and any flags, such as faulting asyncly or being freed. This was required to ensure atomic bit set/test for fork cases where taking the
event_mutexis not a good scalability decision.Added unregister IOCTL, since file lifetime no longer limits the enable time for any events (the mm does).
Updated sample code to reflect the new remote write based ABI.
Updated self-test code to reflect the new remote write based ABI.
Beau Belgrave (11):
tracing/user_events: Split header into uapi and kernel tracing/user_events: Track fork/exec/exit for mm lifetime tracing/user_events: Use remote writes for event enablement tracing/user_events: Fixup enable faults asyncly tracing/user_events: Add ioctl for disabling addresses tracing/user_events: Update self-tests to write ABI tracing/user_events: Add ABI self-test tracing/user_events: Use write ABI in example tracing/user_events: Update documentation for ABI tracing/user_events: Charge event allocs to cgroups tracing/user_events: Limit globaluser_eventcountDocumentation/trace/user_events.rst | 179 ++-- fs/exec.c | 2 + include/linux/sched.h | 5 + include/linux/user_events.h | 101 ++- include/uapi/linux/user_events.h | 81 ++ kernel/exit.c | 2 + kernel/fork.c | 2 + kernel/trace/Kconfig | 5 +- kernel/trace/trace_events_user.c | 851 +++++++++++++++--- samples/user_events/example.c | 47 +- tools/testing/selftests/user_events/Makefile | 2 +- .../testing/selftests/user_events/abi_test.c | 226 +++++ .../testing/selftests/user_events/dyn_test.c | 2 +- .../selftests/user_events/ftrace_test.c | 162 ++-- .../testing/selftests/user_events/perf_test.c | 39 +- 15 files changed, 1306 insertions(+), 400 deletions(-) create mode 100644 include/uapi/linux/user_events.h create mode 100644 tools/testing/selftests/user_events/abi_test.cbase-commit:
ceaa837f96adb69c0df0397937cd74991d5d821aSignature · 1 line
2.25.1
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>