user_events: Enable user processes to create and write to trace events
Subsystems (3)
PATCH v5 1/12 user_events: Add UABI header for user access to user_events
In reply to Beau BelgraveDefine the basic structs and ioctl commands that allow user processes to interact with user_events.
--- include/uapi/linux/user_events.h | 68 ++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 include/uapi/linux/user_events.h
include/uapi/linux/user_events.h new file +68 -0
@@ -0,0 +1,68 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* +* Copyright (c) 2021, 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> + +#ifdef __KERNEL__ +#include <linux/uio.h> +#else +#include <sys/uio.h> +#endif + +#define USER_EVENTS_SYSTEM "user_events" +#define USER_EVENTS_PREFIX "u:" + +/* Bits 0-6 are for known probe types, Bit 7 is for unknown probes */ +#define EVENT_BIT_FTRACE 0 +#define EVENT_BIT_PERF 1 +#define EVENT_BIT_OTHER 7 + +#define EVENT_STATUS_FTRACE (1 << EVENT_BIT_FTRACE) +#define EVENT_STATUS_PERF (1 << EVENT_BIT_PERF) +#define EVENT_STATUS_OTHER (1 << EVENT_BIT_OTHER) + +/* Use raw iterator for attached BPF program(s), no affect on ftrace/perf */ +#define FLAG_BPF_ITER (1 << 0) + +struct user_reg { +__u32 size; +__u64 name_args; +__u32 status_index; +__u32 write_index; +}; + +#define DIAG_IOC_MAGIC '*' +#define DIAG_IOCSREG _IOWR(DIAG_IOC_MAGIC, 0, struct user_reg*) +#define DIAG_IOCSDEL _IOW(DIAG_IOC_MAGIC, 1, char*) + +enum { +USER_BPF_DATA_KERNEL , +USER_BPF_DATA_USER , +USER_BPF_DATA_ITER , +}; + +struct user_bpf_iter { +__u32 iov_offset; +__u32 nr_segs; +const struct iovec *iov; +}; + +struct user_bpf_context { +__u32 data_type; +__u32 data_len; +union { +void *kdata; +void *udata; +struct user_bpf_iter *iter; + }; +}; + +#endif /* _UAPI_LINUX_USER_EVENTS_H */
Signature · 1 line
2.17.1
PATCH v5 2/12 user_events: Add minimal support for trace_event into ftrace
In reply to Beau BelgraveMinimal support for interacting with dynamic events, trace_event and ftrace. Core outline of flow between user process, ioctl and trace_event APIs.
--- kernel/trace/Kconfig | 15 + kernel/trace/Makefile | 1 + kernel/trace/trace_events_user.c | 1159 ++++++++++++++++++++++++++++++ 3 files changed, 1175 insertions(+) create mode 100644 kernel/trace/trace_events_user.c
kernel/trace/Kconfig +15 -0
@@ -724,6 +724,21 @@ config SYNTH_EVENTS If in doubt, say N. +config USER_EVENTS + bool "User trace events" + select TRACING + select DYNAMIC_EVENTS + default n + help + User trace events are user-defined trace events that + 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. + + If in doubt, say N. + config HIST_TRIGGERS bool "Histogram triggers" depends on ARCH_HAVE_NMI_SAFE_CMPXCHG
kernel/trace/Makefile +1 -0
@@ -82,6 +82,7 @@ obj-$(CONFIG_PROBE_EVENTS) += trace_eprobe.o obj-$(CONFIG_TRACE_EVENT_INJECT) += trace_events_inject.o obj-$(CONFIG_SYNTH_EVENTS) += trace_events_synth.o obj-$(CONFIG_HIST_TRIGGERS) += trace_events_hist.o +obj-$(CONFIG_USER_EVENTS) += trace_events_user.o obj-$(CONFIG_BPF_EVENTS) += bpf_trace.o obj-$(CONFIG_KPROBE_EVENTS) += trace_kprobe.o obj-$(CONFIG_TRACEPOINTS) += error_report-traces.o
kernel/trace/trace_events_user.c new file +1159 -0
1,159 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v5 3/12 user_events: Add print_fmt generation support for basic types
In reply to Beau BelgraveAddes print_fmt format generation for basic types that are supported for user processes. Only supports sizes that are the same on 32 and 64 bit.
--- kernel/trace/trace_events_user.c | 107 ++++++++++++++++++++++++++++++- 1 file changed, 105 insertions(+), 2 deletions(-)
kernel/trace/trace_events_user.c +105 -2
@@ -344,6 +344,106 @@ static int user_event_parse_fields(struct user_event *user, char *args)static struct trace_event_fields user_event_fields_array[1 ]; +static const char *user_field_format (const char *type) +{ +if (strcmp (type,"s64" ) ==0 ) +return "%lld" ; +if (strcmp (type,"u64" ) ==0 ) +return "%llu" ; +if (strcmp (type,"s32" ) ==0 ) +return "%d" ; +if (strcmp (type,"u32" ) ==0 ) +return "%u" ; +if (strcmp (type,"int" ) ==0 ) +return "%d" ; +if (strcmp (type,"unsigned int" ) ==0 ) +return "%u" ; +if (strcmp (type,"s16" ) ==0 ) +return "%d" ; +if (strcmp (type,"u16" ) ==0 ) +return "%u" ; +if (strcmp (type,"short" ) ==0 ) +return "%d" ; +if (strcmp (type,"unsigned short" ) ==0 ) +return "%u" ; +if (strcmp (type,"s8" ) ==0 ) +return "%d" ; +if (strcmp (type,"u8" ) ==0 ) +return "%u" ; +if (strcmp (type,"char" ) ==0 ) +return "%d" ; +if (strcmp (type,"unsigned char" ) ==0 ) +return "%u" ; +if (strstr (type,"char[" ) !=0 ) +return "%s" ; + +/* Unknown, likely struct, allowed treat as 64-bit */ +return "%llu" ; +} + +static bool user_field_is_dyn_string (const char *type) +{ +if (str_has_prefix (type,"__data_loc " ) || +str_has_prefix (type,"__rel_loc " )) +if (strstr (type,"char[" ) !=0 ) +return true; + +return false; +} + +#define LEN_OR_ZERO (len ? len - pos : 0) +static int user_event_set_print_fmt (struct user_event *user,char *buf,int len) +{ +struct ftrace_event_field *field, *next; +struct list_head *head = &user->fields; +int pos =0 , depth =0 ; + + pos +=snprintf (buf + pos,LEN_OR_ZERO ,"\"" ); + +list_for_each_entry_safe_reverse (field, next, head, link) { +if (depth !=0 ) + pos +=snprintf (buf + pos,LEN_OR_ZERO ," " ); + + pos +=snprintf (buf + pos,LEN_OR_ZERO ,"%s=%s" , + field->name,user_field_format (field->type)); + + depth++; + } + + pos +=snprintf (buf + pos,LEN_OR_ZERO ,"\"" ); + +list_for_each_entry_safe_reverse (field, next, head, link) { +if (user_field_is_dyn_string (field->type)) + pos +=snprintf (buf + pos,LEN_OR_ZERO , +", __get_str(%s)" , field->name); +else + pos +=snprintf (buf + pos,LEN_OR_ZERO , +", REC->%s" , field->name); + } + +return pos +1 ; +} +#undef LEN_OR_ZERO + +static int user_event_create_print_fmt (struct user_event *user) +{ +char *print_fmt; +int len; + + len =user_event_set_print_fmt (user,NULL ,0 ); + + print_fmt =kmalloc (len,GFP_KERNEL ); + +if (!print_fmt) +return -ENOMEM ; + +user_event_set_print_fmt (user, print_fmt, len); + + user->call.print_fmt = print_fmt; + +return 0 ; +} +static enum print_line_t user_event_print_trace (struct trace_iterator *iter,int flags,struct trace_event *event)
@@ -377,6 +477,7 @@ static int destroy_user_event(struct user_event *user)clear_bit (user->index, page_bitmap);hash_del (&user->node); +kfree (user->call.print_fmt);kfree (EVENT_NAME (user));kfree (user);
@@ -656,8 +757,10 @@ static int user_event_parse(char *name, char *args, char *flags,if (ret) goto put_user; -/* Minimal print format */ - user->call.print_fmt ="\"\"" ; + ret =user_event_create_print_fmt (user); + +if (ret) + goto put_user; user->call.data = user; user->call.class = &user->class;
Signature · 1 line
2.17.1
v5 cover user_events: Enable user processes to create and write to trace events
User mode processes that wish to use trace events to get data into ftrace, perf, eBPF, etc are limited to uprobes today. The user events features enables an ABI for user mode processes to create and write to trace events that are isolated from kernel level trace events. This enables a faster path for tracing from user mode data as well as opens managed code to participate in trace events, where stub locations are dynamic.
User processes often want to trace only when it's useful. To enable this a set of pages are mapped into the user process space that indicate the current state of the user events that have been registered. User processes can check if their event is hooked to a trace/probe, and if it is, emit the event data out via the write() syscall.
Two new files are introduced into tracefs to accomplish this:user_events_status - This file is mmap'd into participating user mode processes to indicate event status.
user_events_data - This file is opened and register/delete ioctl's are issued to create/open/delete trace events that can be used for tracing.
The typical scenario is on process start to mmap user_events_status. Processes then register the events they plan to use via the REG ioctl. The ioctl reads and updates the passed in user_reg struct. The status_index of the struct is used to know the byte in the status page to check for that event. The write_index of the struct is used to describe that event when writing out to the fd that was used for the ioctl call. The data must always include this index first when writing out data for an event. Data can be written either by write() or by writev().
For example, in memory:
int index;
char data[];
Psuedo code example of typical usage:
struct user_reg reg;
int page_fd = open("user_events_status", O_RDWR);
char *page_data = mmap(NULL, PAGE_SIZE, PROT_READ, MAP_SHARED, page_fd, 0); close(page_fd);
int data_fd = open("user_events_data", O_RDWR);
reg.size = sizeof(reg);
reg.name_args = (__u64)"test";
ioctl(data_fd, DIAG_IOCSREG, ®);
int status_id = reg.status_index;
int write_id = reg.write_index;
struct iovec io[2];
io[0].iov_base = &write_id;
io[0].iov_len = sizeof(write_id);
io[1].iov_base = payload;
io[1].iov_len = sizeof(payload);
if (page_data[status_id])
writev(data_fd, io, 2);
User events are also exposed via the dynamic_events tracefs file for both create and delete. Current status is exposed via the user_events_status tracefs file.
Simple example to register a user event via dynamic_events:
echo u:test >> dynamic_events
cat dynamic_events
u:test
If an event is hooked to a probe, the probe hooked shows up:
echo 1 > events/user_events/test/enable cat user_events_status 1:test # Used by ftrace Active: 1 Busy: 1 Max: 4096
If an event is not hooked to a probe, no probe status shows up:
echo 0 > events/user_events/test/enable cat user_events_status 1:test Active: 1 Busy: 0 Max: 4096
Users can describe the trace event format via the following format:
name[:FLAG1[,FLAG2...] [field1[;field2...]]
Each field has the following format:
type name
Example for char array with a size of 20 named msg:
echo 'u:detailed char[20] msg' >> dynamic_events cat dynamic_events
u:detailed char[20] msg
Data offsets are based on the data written out via write() and will be updated to reflect the correct offset in the trace_event fields. For dynamic data it is recommended to use the new __rel_loc data type. This type will be the same as __data_loc, but the offset is relative to this entry. This allows user_events to not worry about what common fields are being inserted before the data.
The above format is valid for both the ioctl and the dynamic_events file.
V2:
Fixed kmalloc vs kzalloc for register_page.
Renamed user_event_mmap to user_event_status.
Renamed user_event prefix from ue to u.
Added seq_* operations to user_event_status to enable cat output. Aligned field parsing to synth_events format (+ size specifier for custom/user types).
Added uapi header user_events.h to align kernel and user ABI definitions.
V3:
Updated ABI to handle single FD into many events via an int header. Added iovec/writev support to enable int header without payload changes. Updated bpf context to describe if data is coming from user, kernel or raw iovec.
Added flag support for registering event, allows forcing BPF to always recieve the direct iovecs for sensitive code paths that do not want copies.
V4:
Moved to struct user_reg for registering events via ioctl.
Added unit tests for ftrace, dyn_events and perf integration. Added print_fmt generation and proper dyn_events matching statements. Reduced time in preemption disabled paths.
Added documentation file.
Pre-fault in data when preemption is enabled and use no-fault copy in probes. Fixed MIPs missing PAGE_READONLY define.
V5:
Rebase to linux-trace for-next branch.
Added sample code into samples/user_events.
Switched to str_has_prefix in various locations.
Allow hex in array sizes and ensure reasonable sizes are used. Moved lifetime of name buffer when parsing to the caller for failure paths. Fixed documentation nits and index.
Ensure event isn't busy before freeing through dyn_events. Properly handle failure case for ftrace and perf in fault cases for buffers. Ensure write data is over min size and null terminated for dynamic arrays.
Beau Belgrave (12):
user_events: Add UABI header for user access to user_events
user_events: Add minimal support for trace_event into ftrace
user_events: Add print_fmt generation support for basic types
user_events: Handle matching arguments from dyn_events
user_events: Add basic perf and eBPF support
user_events: Add self-test for ftrace integration
user_events: Add self-test for dynamic_events integration
user_events: Add self-test for perf_event integration
user_events: Optimize writing events by only copying data once
user_events: Add documentation file
user_events: Add sample code for typical usage
user_events: Validate user payloads for size and null termination
Documentation/trace/index.rst | 1 + Documentation/trace/user_events.rst | 195 ++ include/uapi/linux/user_events.h | 68 + kernel/trace/Kconfig | 15 + kernel/trace/Makefile | 1 + kernel/trace/trace_events_user.c | 1563 +++++++++++++++++ samples/user_events/Makefile | 5 + samples/user_events/example.c | 91 + tools/testing/selftests/user_events/Makefile | 9 + .../testing/selftests/user_events/dyn_test.c | 130 ++ .../selftests/user_events/ftrace_test.c | 280 +++ .../testing/selftests/user_events/perf_test.c | 168 ++ tools/testing/selftests/user_events/settings | 1 + 13 files changed, 2527 insertions(+) create mode 100644 Documentation/trace/user_events.rst create mode 100644 include/uapi/linux/user_events.h create mode 100644 kernel/trace/trace_events_user.c create mode 100644 samples/user_events/Makefile create mode 100644 samples/user_events/example.c create mode 100644 tools/testing/selftests/user_events/Makefile create mode 100644 tools/testing/selftests/user_events/dyn_test.c create mode 100644 tools/testing/selftests/user_events/ftrace_test.c create mode 100644 tools/testing/selftests/user_events/perf_test.c create mode 100644 tools/testing/selftests/user_events/settings
base-commit: 67d4f6e3bf5dddced226fbf19704cdbbb0c98847
Signature · 1 line
2.17.1
PATCH v5 4/12 user_events: Handle matching arguments from dyn_events
Ensures that when dynamic events requests a match with arguments that they match what is in the user_event.
--- kernel/trace/trace_events_user.c | 77 +++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-)
kernel/trace/trace_events_user.c +76 -1
@@ -39,6 +39,7 @@#define MAX_EVENT_DESC 512#define EVENT_NAME (user_event) ((user_event)->tracepoint.name)#define MAX_FIELD_ARRAY_SIZE (2 * PAGE_SIZE) +#define MAX_FIELD_ARG_NAME 256static char *register_page_data;
@@ -679,13 +680,87 @@ static int user_event_free(struct dyn_event *ev)return destroy_user_event (user); } +static bool user_field_match (struct ftrace_event_field *field,int argc, +const char **argv,int *iout) +{ +char *field_name, *arg_name; +int len, pos, i = *iout; +bool colon = false, match = false; + +if (i >= argc) +return false; + + len =MAX_FIELD_ARG_NAME ; + field_name =kmalloc (len,GFP_KERNEL ); + arg_name =kmalloc (len,GFP_KERNEL ); + +if (!arg_name || !field_name) + goto out; + + pos =0 ; + +for (; i < argc; ++i) { +if (i != *iout) + pos +=snprintf (arg_name + pos, len - pos," " ); + + pos +=snprintf (arg_name + pos, len - pos, argv[i]); + +if (strchr (argv[i],';' )) { + ++i; + colon = true; +break ; + } + } + + pos =0 ; + + pos +=snprintf (field_name + pos, len - pos, field->type); + pos +=snprintf (field_name + pos, len - pos," " ); + pos +=snprintf (field_name + pos, len - pos, field->name); + +if (colon) + pos +=snprintf (field_name + pos, len - pos,";" ); + + *iout = i; + + match =strcmp (arg_name, field_name) ==0 ; +out: +kfree (arg_name); +kfree (field_name); + +return match; +} + +static bool user_fields_match (struct user_event *user,int argc, +const char **argv) +{ +struct ftrace_event_field *field, *next; +struct list_head *head = &user->fields; +int i =0 ; + +list_for_each_entry_safe_reverse (field, next, head, link) +if (!user_field_match (field, argc, argv, &i)) +return false; + +if (i != argc) +return false; + +return true; +} +static bool user_event_match (const char *system,const char *event,int argc,const char **argv,struct dyn_event *ev) { struct user_event *user = container_of(ev, struct user_event, devent); +bool match; -return strcmp (EVENT_NAME (user), event) ==0 && + match =strcmp (EVENT_NAME (user), event) ==0 && (!system ||strcmp (system,USER_EVENTS_SYSTEM ) ==0 ); + +if (match && argc >0 ) + match =user_fields_match (user, argc, argv); + +return match; }static struct dyn_event_operations user_event_dops = {
Signature · 1 line
2.17.1
PATCH v5 11/12 user_events: Add sample code for typical usage
In reply to Beau BelgraveAdd sample code for user_events typical usage to show how to register and monitor status, as well as to write out data.
--- samples/user_events/Makefile | 5 ++ samples/user_events/example.c | 91 +++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) create mode 100644 samples/user_events/Makefile create mode 100644 samples/user_events/example.c
samples/user_events/Makefile new file +5 -0
@@ -0,0 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0 +CFLAGS += -Wl,-no-as-needed -Wall -I../../usr/include + +example: example.o +example.o: example.c
samples/user_events/example.c new file +91 -0
91 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v5 7/12 user_events: Add self-test for dynamic_events integration
In reply to Beau BelgraveTests matching deletes, creation of basic and complex types. Ensures common patterns work correctly when interacting with dynamic_events file.
--- tools/testing/selftests/user_events/Makefile | 2 +- .../testing/selftests/user_events/dyn_test.c | 130 ++++++++++++++++++ 2 files changed, 131 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/user_events/dyn_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 +TEST_GEN_PROGS = ftrace_test dyn_test TEST_FILES := settings
tools/testing/selftests/user_events/dyn_test.c new file +130 -0
130 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v5 12/12 user_events: Validate user payloads for size and null termination
In reply to Beau BelgraveAdd validation to ensure data is at or greater than the min size for the fields of the event. If a dynamic array is used and is a type of char, ensure null termination of the array exists. Add unit test cases for the above scenarios.
--- kernel/trace/trace_events_user.c | 147 ++++++++++++++++-- .../selftests/user_events/ftrace_test.c | 75 +++++++++ 2 files changed, 207 insertions(+), 15 deletions(-)
kernel/trace/trace_events_user.c +132 -15
@@ -58,9 +58,11 @@ struct user_event {struct dyn_event devent;struct hlist_node node;struct list_head fields; +struct list_head validators;atomic_t refcnt;int index;int flags; +int min_size; };struct user_event_refs {
@@ -69,8 +71,17 @@ struct user_event_refs {struct user_event *events[]; }; +#define VALIDATOR_ENSURE_NULL (1 << 0) +#define VALIDATOR_REL (1 << 1) + +struct user_event_validator { +struct list_head link; +int offset; +int flags; +}; +typedef void (*user_event_func_t ) (struct user_event *user,struct iov_iter *i, -void *tpdata); +void *tpdata,bool *faulted);static int user_event_parse (char *name,char *args,char *flags,struct user_event **newuser);
@@ -187,6 +198,17 @@ static int user_field_size(const char *type)return -EINVAL ; } +static void user_event_destroy_validators (struct user_event *user) +{ +struct user_event_validator *validator, *next; +struct list_head *head = &user->validators; + +list_for_each_entry_safe (validator, next, head, link) { +list_del (&validator->link); +kfree (validator); + } +} +static void user_event_destroy_fields (struct user_event *user) {struct ftrace_event_field *field, *next;
@@ -202,13 +224,43 @@ static int user_event_add_field(struct user_event *user, const char *type, const char *name, int offset, int size, int is_signed, int filter_type) { + struct user_event_validator *validator;struct ftrace_event_field *field; +int validator_flags =0 ; field =kmalloc (sizeof (*field),GFP_KERNEL );if (!field)return -ENOMEM ; +if (str_has_prefix (type,"__data_loc " )) + goto add_validator; + +if (str_has_prefix (type,"__rel_loc " )) { + validator_flags |=VALIDATOR_REL ; + goto add_validator; + } + + goto add_field; + +add_validator: +if (strstr (type,"char[" ) !=0 ) + validator_flags |=VALIDATOR_ENSURE_NULL ; + + validator =kmalloc (sizeof (*validator),GFP_KERNEL ); + +if (!validator) { +kfree (field); +return -ENOMEM ; + } + + validator->flags = validator_flags; + validator->offset = offset; + +/* Want sequential access when validating */ +list_add_tail (&validator->link, &user->validators); + +add_field: field->type = type; field->name = name; field->offset = offset;
@@ -218,6 +270,12 @@ static int user_event_add_field(struct user_event *user, const char *type,list_add (&field->link, &user->fields); +/* +* Min size from user writes that are required, this does not include +* the size of trace_entry (common fields). +*/ + user->min_size = (offset + size) -sizeof (struct trace_entry ); +return 0 ; }
@@ -481,6 +539,7 @@ static int destroy_user_event(struct user_event *user)clear_bit (user->index, page_bitmap);hash_del (&user->node); +user_event_destroy_validators (user);kfree (user->call.print_fmt);kfree (EVENT_NAME (user));kfree (user);
@@ -502,15 +561,49 @@ static struct user_event *find_user_event(char *name, u32 *outkey)return NULL ; } +static int user_event_validate (struct user_event *user,void *data,int len) +{ +struct list_head *head = &user->validators; +struct user_event_validator *validator; +void *pos, *end = data + len; +u16 *val, offset, size; + +list_for_each_entry (validator, head, link) { + pos = data + validator->offset; + val = pos; + +/* Already done min_size check, no bounds check here */ + offset = *val++; + size = *val++; + +if (likely (validator->flags &VALIDATOR_REL )) + pos = ((void *)val) + offset; +else + pos = data + offset; + + pos += size; + +if (unlikely (pos > end)) +return -EFAULT ; + +if (likely (validator->flags &VALIDATOR_ENSURE_NULL )) +if (unlikely (*(char *)(pos -1 ) !=0 )) +return -EFAULT ; + } + +return 0 ; +} +/* * Writes the user supplied payload out to a trace file. */ static void user_event_ftrace (struct user_event *user,struct iov_iter *i, -void *tpdata) +void *tpdata,bool *faulted) {struct trace_event_file *file;struct trace_entry *entry;struct trace_event_buffer event_buffer; +size_t size =sizeof (*entry) + i->count; file = (struct trace_event_file *)tpdata;
@@ -520,19 +613,25 @@ static void user_event_ftrace(struct user_event *user, struct iov_iter *i,return ;/* Allocates and fills trace_entry, + 1 of this is data payload */ - entry =trace_event_buffer_reserve (&event_buffer, file, -sizeof (*entry) + i->count); + entry =trace_event_buffer_reserve (&event_buffer, file, size);if (unlikely (!entry))return ; -if (unlikely (!copy_nofault (entry +1 , i->count, i))) { -__trace_event_discard_commit (event_buffer.buffer, - event_buffer.event); -return ; - } +if (unlikely (!copy_nofault (entry +1 , i->count, i))) + goto discard; + +if (!list_empty (&user->validators) && +unlikely (user_event_validate (user, entry, size))) + goto discard;trace_event_buffer_commit (&event_buffer); + +return ; +discard: + *faulted = true; +__trace_event_discard_commit (event_buffer.buffer, + event_buffer.event); }#ifdef CONFIG_PERF_EVENTS
@@ -587,7 +686,7 @@ static void user_event_bpf(struct user_event *user, struct iov_iter *i)* Writes the user supplied payload out to perf ring buffer or eBPF program. */ static void user_event_perf (struct user_event *user,struct iov_iter *i, -void *tpdata) +void *tpdata,bool *faulted) {struct hlist_head *perf_head;
@@ -610,14 +709,21 @@ static void user_event_perf(struct user_event *user, struct iov_iter *i,perf_fetch_caller_regs (regs); -if (unlikely (!copy_nofault (perf_entry +1 , i->count, i))) { -perf_swevent_put_recursion_context (context); -return ; - } +if (unlikely (!copy_nofault (perf_entry +1 , i->count, i))) + goto discard; + +if (!list_empty (&user->validators) && +unlikely (user_event_validate (user, perf_entry, size))) + goto discard;perf_trace_buf_submit (perf_entry, size, context, user->call.event.type,1 , regs, perf_head,NULL ); + +return ; +discard: + *faulted = true; + perf_swevent_put_recursion_context(context); } }#endif
@@ -932,6 +1038,7 @@ static int user_event_parse(char *name, char *args, char *flags,INIT_LIST_HEAD (&user->class.fields);INIT_LIST_HEAD (&user->fields); +INIT_LIST_HEAD (&user->validators); user->tracepoint.name = name;
@@ -980,6 +1087,7 @@ static int user_event_parse(char *name, char *args, char *flags,return 0 ; put_user:user_event_destroy_fields (user); +user_event_destroy_validators (user);kfree (user);return ret; }
@@ -1032,6 +1140,9 @@ static ssize_t user_events_write_core(struct file *file, struct iov_iter *i)if (unlikely (user ==NULL ))return -ENOENT ; +if (unlikely (i->count < user->min_size)) +return -EINVAL ; + tp = &user->tracepoint;if (likely (atomic_read (&tp->key.enabled) >0 )) {
@@ -1039,10 +1150,13 @@ static ssize_t user_events_write_core(struct file *file, struct iov_iter *i)user_event_func_t probe_func;struct iov_iter copy;void *tpdata; +bool faulted;if (unlikely (iov_iter_fault_in_readable (i, i->count)))return -EFAULT ; + faulted = false; +rcu_read_lock_sched ();pagefault_disable ();
@@ -1053,12 +1167,15 @@ static ssize_t user_events_write_core(struct file *file, struct iov_iter *i) copy = *i; probe_func = probe_func_ptr->func; tpdata = probe_func_ptr->data; -probe_func (user, ©, tpdata); +probe_func (user, ©, tpdata, &faulted); }while ((++probe_func_ptr)->func); }pagefault_enable ();rcu_read_unlock_sched (); + +if (unlikely (faulted)) +return -EFAULT ; }return ret;
tools/testing/selftests/user_events/ftrace_test.c +75 -0
99 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v5 9/12 user_events: Optimize writing events by only copying data once
In reply to Beau BelgravePass iterator through to probes to allow copying data directly to the probe buffers instead of taking multiple copies. Enables eBPF user and raw iterator types out to programs for no-copy scenarios.
--- kernel/trace/trace_events_user.c | 102 ++++++++++++++++++++++--------- 1 file changed, 74 insertions(+), 28 deletions(-)
kernel/trace/trace_events_user.c +74 -28
@@ -41,6 +41,10 @@#define MAX_FIELD_ARRAY_SIZE (2 * PAGE_SIZE)#define MAX_FIELD_ARG_NAME 256 +#define MAX_BPF_COPY_SIZE PAGE_SIZE +#define MAX_STACK_BPF_DATA 512 +#define copy_nofault copy_from_iter_nocache +static char *register_page_data;static DEFINE_MUTEX (reg_mutex);
@@ -65,8 +69,7 @@ struct user_event_refs {struct user_event *events[]; }; -typedef void (*user_event_func_t ) (struct user_event *user, -void *data,u32 datalen, +typedef void (*user_event_func_t ) (struct user_event *user,struct iov_iter *i,void *tpdata); static int user_event_parse(char *name, char *args, char *flags,
@@ -502,7 +505,7 @@ static struct user_event *find_user_event(char *name, u32 *outkey)/* * Writes the user supplied payload out to a trace file. */ -static void user_event_ftrace (struct user_event *user,void *data,u32 datalen, +static void user_event_ftrace (struct user_event *user,struct iov_iter *i,void *tpdata) {struct trace_event_file *file;
@@ -518,41 +521,85 @@ static void user_event_ftrace(struct user_event *user, void *data, u32 datalen,/* Allocates and fills trace_entry, + 1 of this is data payload */ entry =trace_event_buffer_reserve (&event_buffer, file, -sizeof (*entry) + datalen); +sizeof (*entry) + i->count);if (unlikely (!entry))return ; -memcpy (entry +1 , data, datalen); +if (unlikely (!copy_nofault (entry +1 , i->count, i))) { +__trace_event_discard_commit (event_buffer.buffer, + event_buffer.event); +return ; + }trace_event_buffer_commit (&event_buffer); }#ifdef CONFIG_PERF_EVENTS +static void user_event_bpf (struct user_event *user,struct iov_iter *i) +{ +struct user_bpf_context context; +struct user_bpf_iter bpf_i; +char fast_data[MAX_STACK_BPF_DATA ]; +void *temp =NULL ; + +if ((user->flags &FLAG_BPF_ITER ) &&iter_is_iovec (i)) { +/* Raw iterator */ + context.data_type =USER_BPF_DATA_ITER ; + context.data_len = i->count; + context.iter = &bpf_i; + + bpf_i.iov_offset = i->iov_offset; + bpf_i.iov = i->iov; + bpf_i.nr_segs = i->nr_segs; + }else if (i->nr_segs ==1 &&iter_is_iovec (i)) { +/* Single buffer from user */ + context.data_type =USER_BPF_DATA_USER ; + context.data_len = i->count; + context.udata = i->iov->iov_base + i->iov_offset; + }else { +/* Multi buffer from user */ +struct iov_iter copy = *i; +size_t copy_size =min (i->count,MAX_BPF_COPY_SIZE ); + + context.data_type =USER_BPF_DATA_KERNEL ; + context.kdata = fast_data; + +if (unlikely (copy_size >sizeof (fast_data))) { + temp =kmalloc (copy_size,GFP_NOWAIT ); + +if (temp) + context.kdata = temp; +else + copy_size =sizeof (fast_data); + } + + context.data_len =copy_nofault (context.kdata, + copy_size, ©); + } + +trace_call_bpf (&user->call, &context); + +kfree (temp); +} +/* * Writes the user supplied payload out to perf ring buffer or eBPF program. */ -static void user_event_perf (struct user_event *user,void *data,u32 datalen, +static void user_event_perf (struct user_event *user,struct iov_iter *i,void *tpdata) {struct hlist_head *perf_head; -if (bpf_prog_array_valid (&user->call)) { -struct user_bpf_context context = {0 }; - - context.data_len = datalen; - context.data_type =USER_BPF_DATA_KERNEL ; - context.kdata = data; - -trace_call_bpf (&user->call, &context); - } +if (bpf_prog_array_valid (&user->call)) +user_event_bpf (user, i); perf_head =this_cpu_ptr (user->call.perf_events);if (perf_head && !hlist_empty (perf_head)) {struct trace_entry *perf_entry;struct pt_regs *regs; -size_t size =sizeof (*perf_entry) + datalen; +size_t size =sizeof (*perf_entry) + i->count;int context; perf_entry = perf_trace_buf_alloc(ALIGN(size, 8),
@@ -563,7 +610,10 @@ static void user_event_perf(struct user_event *user, void *data, u32 datalen,perf_fetch_caller_regs (regs); -memcpy (perf_entry +1 , data, datalen); +if (unlikely (!copy_nofault (perf_entry +1 , i->count, i))) { +perf_swevent_put_recursion_context (context); +return ; + } perf_trace_buf_submit(perf_entry, size, context, user->call.event.type, 1, regs,
@@ -987,32 +1037,28 @@ static ssize_t user_events_write_core(struct file *file, struct iov_iter *i)if (likely (atomic_read (&tp->key.enabled) >0 )) {struct tracepoint_func *probe_func_ptr;user_event_func_t probe_func; +struct iov_iter copy;void *tpdata; -void *kdata; -u32 datalen; - kdata =kmalloc (i->count,GFP_KERNEL ); - -if (unlikely (!kdata)) -return -ENOMEM ; - - datalen =copy_from_iter (kdata, i->count, i); +if (unlikely (iov_iter_fault_in_readable (i, i->count))) +return -EFAULT ;rcu_read_lock_sched (); +pagefault_disable (); probe_func_ptr =rcu_dereference_sched (tp->funcs);if (probe_func_ptr) {do { + copy = *i; probe_func = probe_func_ptr->func; tpdata = probe_func_ptr->data; -probe_func (user, kdata, datalen, tpdata); +probe_func (user, ©, tpdata); }while ((++probe_func_ptr)->func); } +pagefault_enable ();rcu_read_unlock_sched (); - -kfree (kdata); }return ret;
Signature · 1 line
2.17.1
PATCH v5 5/12 user_events: Add basic perf and eBPF support
In reply to Beau BelgraveAdds support to write out user_event data to perf_probe/perf files as well as to any attached eBPF program.
--- kernel/trace/trace_events_user.c | 63 ++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+)
kernel/trace/trace_events_user.c +63 -0
@@ -528,6 +528,50 @@ static void user_event_ftrace(struct user_event *user, void *data, u32 datalen,trace_event_buffer_commit (&event_buffer); } +#ifdef CONFIG_PERF_EVENTS +/* +* Writes the user supplied payload out to perf ring buffer or eBPF program. +*/ +static void user_event_perf (struct user_event *user,void *data,u32 datalen, +void *tpdata) +{ +struct hlist_head *perf_head; + +if (bpf_prog_array_valid (&user->call)) { +struct user_bpf_context context = {0 }; + + context.data_len = datalen; + context.data_type =USER_BPF_DATA_KERNEL ; + context.kdata = data; + +trace_call_bpf (&user->call, &context); + } + + perf_head =this_cpu_ptr (user->call.perf_events); + +if (perf_head && !hlist_empty (perf_head)) { +struct trace_entry *perf_entry; +struct pt_regs *regs; +size_t size =sizeof (*perf_entry) + datalen; +int context; + + perf_entry =perf_trace_buf_alloc (ALIGN (size,8 ), + ®s, &context); + +if (unlikely (!perf_entry)) +return ; + +perf_fetch_caller_regs (regs); + +memcpy (perf_entry +1 , data, datalen); + +perf_trace_buf_submit (perf_entry, size, context, + user->call.event.type,1 , regs, + perf_head,NULL ); + } +} +#endif +/* * Update the register page that is shared between user processes. */
@@ -550,6 +594,10 @@ static void update_reg_page_for(struct user_event *user)if (probe_func == user_event_ftrace) status |=EVENT_STATUS_FTRACE ; +#ifdef CONFIG_PERF_EVENTS + else if (probe_func == user_event_perf) + status |= EVENT_STATUS_PERF; +#endif else status |= EVENT_STATUS_OTHER; }while ((++probe_func_ptr)->func);
@@ -591,7 +639,19 @@ static int user_event_reg(struct trace_event_call *call,#ifdef CONFIG_PERF_EVENTS case TRACE_REG_PERF_REGISTER : + ret =tracepoint_probe_register (call->tp, + call->class->perf_probe, + data); +if (!ret) + goto inc; +break ; +case TRACE_REG_PERF_UNREGISTER : +tracepoint_probe_unregister (call->tp, + call->class->perf_probe, + data); + goto dec; +case TRACE_REG_PERF_OPEN :case TRACE_REG_PERF_CLOSE :case TRACE_REG_PERF_ADD :
@@ -849,6 +909,9 @@ static int user_event_parse(char *name, char *args, char *flags, user->class.get_fields = user_event_get_fields; user->class.reg = user_event_reg; user->class.probe = user_event_ftrace; +#ifdef CONFIG_PERF_EVENTS + user->class.perf_probe = user_event_perf; +#endif mutex_lock (&event_mutex); ret =user_event_trace_register (user);
Signature · 1 line
2.17.1
PATCH v5 6/12 user_events: Add self-test for ftrace integration
In reply to Beau BelgraveTests basic functionality of registering/deregistering, status and writing data out via ftrace mechanisms within user_events.
--- tools/testing/selftests/user_events/Makefile | 9 + .../selftests/user_events/ftrace_test.c | 205 ++++++++++++++++++ tools/testing/selftests/user_events/settings | 1 + 3 files changed, 215 insertions(+) create mode 100644 tools/testing/selftests/user_events/Makefile create mode 100644 tools/testing/selftests/user_events/ftrace_test.c create mode 100644 tools/testing/selftests/user_events/settings
tools/testing/selftests/user_events/Makefile new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0 +CFLAGS += -Wl,-no-as-needed -Wall -I../../../../usr/include +LDLIBS += -lrt -lpthread -lm + +TEST_GEN_PROGS = ftrace_test + +TEST_FILES := settings + +include ../lib.mk
tools/testing/selftests/user_events/ftrace_test.c new file +205 -0
205 lines not on this page · raw message
tools/testing/selftests/user_events/settings new file +1 -0
@@ -0,0 +1 @@ +timeout=90
Signature · 1 line
2.17.1
PATCH v5 8/12 user_events: Add self-test for perf_event integration
In reply to Beau BelgraveTests perf can be attached to and written out correctly. Ensures attach updates status bits in user programs.
--- tools/testing/selftests/user_events/Makefile | 2 +- .../testing/selftests/user_events/perf_test.c | 168 ++++++++++++++++++ 2 files changed, 169 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/user_events/perf_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 +TEST_GEN_PROGS = ftrace_test dyn_test perf_test TEST_FILES := settings
tools/testing/selftests/user_events/perf_test.c new file +168 -0
168 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v5 10/12 user_events: Add documentation file
In reply to Beau BelgraveAdd a documentation file about user_events with example code, etc. explaining how it may be used.
--- Documentation/trace/index.rst | 1 + Documentation/trace/user_events.rst | 195 ++++++++++++++++++++++++++++ 2 files changed, 196 insertions(+) create mode 100644 Documentation/trace/user_events.rst
Documentation/trace/index.rst +1 -0
@@ -30,3 +30,4 @@ Linux Tracing Technologies stm sys-t coresight/index + user_events
Documentation/trace/user_events.rst new file +195 -0
195 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [PATCH v5 12/12] user_events: Validate user payloads for size and null termination
In reply to Beau BelgraveQuoted 4 lines · Beau Belgrave
kernel/trace/trace_events_user.c +4
-0+static int user_event_validate (struct user_event *user,void *data,int len) +{ +struct list_head *head = &user->validators; +struct user_event_validator *validator;
kernel/trace/trace_events_user.c static struct user_event *find_user_event(char *name, u32 *outkey) · line 577
Quoted 10 lines
kernel/trace/trace_events_user.c +10
-0+void *pos, *end = data + len; +u16 *val, offset, size; + +list_for_each_entry (validator, head, link) { + pos = data + validator->offset; + val = pos; + +/* Already done min_size check, no bounds check here */ + offset = *val++; + size = *val++;
I believe I have these backwards, size should come first for both dyn and rel data. Is this correct?
tools/testing/selftests/user_events/ftrace_test.c const char *status_file = "/sys/kernel/debug/tracing/user_events_status"; · line 28
Quoted 13 lines
tools/testing/selftests/user_events/ftrace_test.c +5
-0@@ -21,6 +21,11 @@ const char *status_file = "/sys/kernel/debug/tracing/user_events_status";const char *enable_file ="/sys/kernel/debug/tracing/events/user_events/__test_event/enable" ;const char *trace_file ="/sys/kernel/debug/tracing/trace" ; +struct rel_loc { +__u16 offset; +__u16 size; +} __packed; +
Same here.
Thanks,
-Beau
Steven Rostedt
maintainerRe: [PATCH v5 12/12] user_events: Validate user payloads for size and null termination
Quoted 10 lines · On Tue, 16 Nov 2021 13:11:50 -0800 Beau Belgrave <[email protected]>…
Quoted 9 lines · Beau Belgrave
kernel/trace/trace_events_user.c +9
-0+static int user_event_validate (struct user_event *user,void *data,int len) +{ +struct list_head *head = &user->validators; +struct user_event_validator *validator; +void *pos, *end = data + len; +u16 *val, offset, size; + +list_for_each_entry (validator, head, link) { + pos = data + validator->offset;
Quoted 8 lines
kernel/trace/trace_events_user.c static struct user_event *find_user_event(char *name, u32 *outkey) · line 577
Quoted 5 lines
kernel/trace/trace_events_user.c +5
-0+ val = pos; + +/* Already done min_size check, no bounds check here */ + offset = *val++; + size = *val++;I believe I have these backwards, size should come first for both dyn and rel data. Is this correct?
it's size << 16 | offset;
Quoted 9 lines
Quoted 9 lines
tools/testing/selftests/user_events/ftrace_test.c +0
-0@@ -21,6 +21,11 @@ const char *status_file = "/sys/kernel/debug/tracing/user_events_status";const char *enable_file ="/sys/kernel/debug/tracing/events/user_events/__test_event/enable" ;const char *trace_file ="/sys/kernel/debug/tracing/trace" ;
Quoted 7 lines
tools/testing/selftests/user_events/ftrace_test.c const char *status_file = "/sys/kernel/debug/tracing/user_events_status"; · line 28
Quoted 5 lines
tools/testing/selftests/user_events/ftrace_test.c +5
-0+struct rel_loc { +__u16 offset; +__u16 size; +} __packed; +Same here.
I would not use pointer arithmetic or the above structure, as I'm not sure they work the same for both big and little endian. It's best to just use u32 and '|' (or) the two unsigned shorts into one integer.
-- Steve
Steven Rostedt
maintainerRe: [PATCH v5 02/12] user_events: Add minimal support for trace_event into ftrace
In reply to Beau BelgraveQuoted 37 lines · On Mon, 15 Nov 2021 16:50:37 -0800 Beau Belgrave <[email protected]>…
kernel/trace/trace_events_user.c new file +31
-0@@ -0,0 +1,1159 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* +* Copyright (c) 2021, Microsoft Corporation. +* +* Authors: +* Beau Belgrave <[email protected]> +*/ + +#include <linux/bitmap.h> +#include <linux/cdev.h> +#include <linux/hashtable.h> +#include <linux/list.h> +#include <linux/io.h> +#include <linux/uio.h> +#include <linux/ioctl.h> +#include <linux/jhash.h> +#include <linux/trace_events.h> +#include <linux/tracefs.h> +#include <linux/types.h> +#include <linux/uaccess.h> +#include <uapi/linux/user_events.h> +#include "trace.h" +#include "trace_dynevent.h" + +#define USER_EVENTS_PREFIX_LEN (sizeof(USER_EVENTS_PREFIX)-1) + +#define FIELD_DEPTH_TYPE 0 +#define FIELD_DEPTH_NAME 1 +#define FIELD_DEPTH_SIZE 2 + +/*
kernel/trace/trace_events_user.c line 41
Quoted 10 lines
kernel/trace/trace_events_user.c new file +10
-0+* Limits how many trace_event calls user processes can create: +* Must be multiple of PAGE_SIZE. +*/ +#define MAX_PAGES 1 +#define MAX_EVENTS (MAX_PAGES * PAGE_SIZE) + +/* Limit how long of an event name plus args within the subsystem. */ +#define MAX_EVENT_DESC 512 +#define EVENT_NAME (user_event) ((user_event)->tracepoint.name) +#define MAX_FIELD_ARRAY_SIZE (2 * PAGE_SIZE)
You really want to allow field sizes to be larger than a page?
Quoted 32 lines
kernel/trace/trace_events_user.c new file +32
-0+ +static char *register_page_data; + +static DEFINE_MUTEX (reg_mutex); +static DEFINE_HASHTABLE(register_table, 4); +static DECLARE_BITMAP(page_bitmap, MAX_EVENTS); + +struct user_event { +struct tracepoint tracepoint; +struct trace_event_call call; +struct trace_event_class class; +struct dyn_event devent; +struct hlist_node node; +struct list_head fields; +atomic_t refcnt; +int index; +int flags; +}; + +struct user_event_refs { +struct rcu_head rcu; +int count; +struct user_event *events[]; +}; + +typedef void (*user_event_func_t ) (struct user_event *user, +void *data,u32 datalen, +void *tpdata); + +static int user_event_parse (char *name,char *args,char *flags, +struct user_event **newuser); +
[..]
Quoted 9 lines
kernel/trace/trace_events_user.c new file +9
-0+ +/* +* Validates the user payload and writes via iterator. +*/ +static ssize_t user_events_write_core (struct file *file,struct iov_iter *i) +{ +struct user_event_refs *refs; +struct user_event *user =NULL ; +struct tracepoint *tp;
kernel/trace/trace_events_user.c line 735
Quoted 10 lines
kernel/trace/trace_events_user.c new file +10
-0+ssize_t ret = i->count; +int idx; + +if (unlikely (copy_from_iter (&idx,sizeof (idx), i) !=sizeof (idx))) +return -EFAULT ; + +rcu_read_lock_sched (); + + refs =rcu_dereference_sched (file->private_data); +
Still need a comment here that states:
/*
* The refs->events array is protected by RCU, and new items may be
* added. But the user retrieved from indexing into the events array
* shall be immutable while the file is opened.
*/
Or something like that, because once again, I had to figure out how this all worked. It's not obvious.
kernel/trace/trace_events_user.c line 745
Quoted 10 lines
kernel/trace/trace_events_user.c new file +10
-0+if (likely (refs && idx < refs->count)) + user = refs->events[idx]; + +rcu_read_unlock_sched (); + +if (unlikely (user ==NULL )) +return -ENOENT ; + + tp = &user->tracepoint; +
Probably also should have a comment here that states that this is racy, but we don't care. That is, the enabled can be less than 1 after the if statement, but that means it was just disabled and it's OK if a few events slip in after it is.
Quoted 63 lines
kernel/trace/trace_events_user.c new file +63
-0+if (likely (atomic_read (&tp->key.enabled) >0 )) { +struct tracepoint_func *probe_func_ptr; +user_event_func_t probe_func; +void *tpdata; +void *kdata; +u32 datalen; + + kdata =kmalloc (i->count,GFP_KERNEL ); + +if (unlikely (!kdata)) +return -ENOMEM ; + + datalen =copy_from_iter (kdata, i->count, i); + +rcu_read_lock_sched (); + + probe_func_ptr =rcu_dereference_sched (tp->funcs); + +if (probe_func_ptr) { +do { + probe_func = probe_func_ptr->func; + tpdata = probe_func_ptr->data; +probe_func (user, kdata, datalen, tpdata); + }while ((++probe_func_ptr)->func); + } + +rcu_read_unlock_sched (); + +kfree (kdata); + } + +return ret; +} + +static ssize_t user_events_write (struct file *file,const char __user *ubuf, +size_t count,loff_t *ppos) +{ +struct iovec iov; +struct iov_iter i; + +if (unlikely (*ppos !=0 )) +return -EFAULT ; + +if (unlikely (import_single_range (READ , (char *)ubuf, count, &iov, &i))) +return -EFAULT ; + +return user_events_write_core (file, &i); +} + +static ssize_t user_events_write_iter (struct kiocb *kp,struct iov_iter *i) +{ +return user_events_write_core (kp->ki_filp, i); +} + +static int user_events_ref_add (struct file *file,struct user_event *user) +{ +struct user_event_refs *refs, *new_refs; +int i, size, count =0 ; + + refs =rcu_dereference_protected (file->private_data, +lockdep_is_held (®_mutex)); + +if (refs) {
kernel/trace/trace_events_user.c line 816
Quoted 10 lines
kernel/trace/trace_events_user.c new file +8
-0+ count = refs->count; + +for (i =0 ; i < count; ++i) +if (refs->events[i] == user) +return i; + } + + size =sizeof (*refs) + (sizeof (struct user_event *) * (count +1 ));
Use:
size = struct_size(refs, events, count + 1);
Quoted 130 lines
kernel/trace/trace_events_user.c new file +130
-0+ + new_refs =kzalloc (size,GFP_KERNEL ); + +if (!new_refs) +return -ENOMEM ; + + new_refs->count = count +1 ; + +for (i =0 ; i < count; ++i) + new_refs->events[i] = refs->events[i]; + + new_refs->events[i] = user; + +atomic_inc (&user->refcnt); + +rcu_assign_pointer (file->private_data, new_refs); + +if (refs) +kfree_rcu (refs, rcu); + +return i; +} + +static long user_reg_get (struct user_reg __user *ureg,struct user_reg *kreg) +{ +u32 size; +long ret; + + ret =get_user (size, &ureg->size); + +if (ret) +return ret; + +if (size >PAGE_SIZE ) +return -E2BIG ; + +return copy_struct_from_user (kreg,sizeof (*kreg), ureg, size); +} + +/* +* Registers a user_event on behalf of a user process. +*/ +static long user_events_ioctl_reg (struct file *file,unsigned long uarg) +{ +struct user_reg __user *ureg = (struct user_reg __user *)uarg; +struct user_reg reg; +struct user_event *user; +char *name; +long ret; + + ret =user_reg_get (ureg, ®); + +if (ret) +return ret; + + name =strndup_user ((const char __user *)(uintptr_t )reg.name_args, +MAX_EVENT_DESC ); + +if (IS_ERR (name)) { + ret =PTR_ERR (name); +return ret; + } + + ret =user_event_parse_cmd (name, &user); + +if (ret) { +kfree (name); +return ret; + } + + ret =user_events_ref_add (file, user); + +/* Positive number is index and valid */ +if (ret <0 ) +return ret; + +put_user ((u32 )ret, &ureg->write_index); +put_user (user->index, &ureg->status_index); + +return 0 ; +} + +/* +* Deletes a user_event on behalf of a user process. +*/ +static long user_events_ioctl_del (struct file *file,unsigned long uarg) +{ +void __user *ubuf = (void __user *)uarg; +char *name; +long ret; + + name =strndup_user (ubuf,MAX_EVENT_DESC ); + +if (IS_ERR (name)) +return PTR_ERR (name); + + ret =delete_user_event (name); + +kfree (name); + +return ret; +} + +/* +* Handles the ioctl from user mode to register or alter operations. +*/ +static long user_events_ioctl (struct file *file,unsigned int cmd, +unsigned long uarg) +{ +long ret = -ENOTTY ; + +switch (cmd) { +case DIAG_IOCSREG : +mutex_lock (®_mutex); + ret =user_events_ioctl_reg (file, uarg); +mutex_unlock (®_mutex); +break ; + +case DIAG_IOCSDEL : +mutex_lock (®_mutex); + ret =user_events_ioctl_del (file, uarg); +mutex_unlock (®_mutex); +break ; + } + +return ret; +} + +/* +* Handles the final close of the file from user mode.
kernel/trace/trace_events_user.c line 956
Quoted 10 lines
kernel/trace/trace_events_user.c new file +10
-0+*/ +static int user_events_release (struct inode *node,struct file *file) +{ +struct user_event_refs *refs; +struct user_event *user; +int i; + +rcu_read_lock_sched (); + refs =rcu_dereference_sched (file->private_data); +rcu_read_unlock_sched ();
This looks totally wrong. What is RCU protecting here?
kernel/trace/trace_events_user.c line 960
Quoted 4 lines
kernel/trace/trace_events_user.c new file +4
-0+ +if (!refs) + goto out; +
How can't refs->events not change here?
Shouldn't reg_mutex be held throughout this function?
kernel/trace/trace_events_user.c line 972
Quoted 12 lines
kernel/trace/trace_events_user.c new file +12
-0+for (i =0 ; i < refs->count; ++i) { + user = refs->events[i]; + +if (user) +atomic_dec (&user->refcnt); + } + +kfree_rcu (refs, rcu); +out: +return 0 ; +} +
-- Steve
Re: [PATCH v5 12/12] user_events: Validate user payloads for size and null termination
In reply to Steven RostedtQuoted 42 lines · Steven Rostedt
Quoted 10 lines · On Tue, 16 Nov 2021 13:11:50 -0800 Beau Belgrave <[email protected]>…
Quoted 9 lines · Beau Belgrave
kernel/trace/trace_events_user.c +9
-0+static int user_event_validate (struct user_event *user,void *data,int len) +{ +struct list_head *head = &user->validators; +struct user_event_validator *validator; +void *pos, *end = data + len; +u16 *val, offset, size; + +list_for_each_entry (validator, head, link) { + pos = data + validator->offset;Quoted 8 lines
kernel/trace/trace_events_user.c static struct user_event *find_user_event(char *name, u32 *outkey) · line 577
Quoted 5 lines
kernel/trace/trace_events_user.c +5
-0+ val = pos; + +/* Already done min_size check, no bounds check here */ + offset = *val++; + size = *val++;I believe I have these backwards, size should come first for both dyn and rel data. Is this correct?
it's size << 16 | offset;
Quoted 9 lines
Quoted 9 lines
tools/testing/selftests/user_events/ftrace_test.c +0
-0@@ -21,6 +21,11 @@ const char *status_file = "/sys/kernel/debug/tracing/user_events_status";const char *enable_file ="/sys/kernel/debug/tracing/events/user_events/__test_event/enable" ;const char *trace_file ="/sys/kernel/debug/tracing/trace" ;Quoted 7 lines
tools/testing/selftests/user_events/ftrace_test.c const char *status_file = "/sys/kernel/debug/tracing/user_events_status"; · line 28
Quoted 5 lines
tools/testing/selftests/user_events/ftrace_test.c +5
-0+struct rel_loc { +__u16 offset; +__u16 size; +} __packed; +Same here.
Quoted 5 lines
I would not use pointer arithmetic or the above structure, as I'm not sure they work the same for both big and little endian. It's best to just use u32 and '|' (or) the two unsigned shorts into one integer.
-- Steve
Got it, totally makes sense now, thank you!
-Beau
Re: [PATCH v5 02/12] user_events: Add minimal support for trace_event into ftrace
In reply to Steven RostedtQuoted 44 lines · Steven Rostedt
Quoted 41 lines · On Mon, 15 Nov 2021 16:50:37 -0800 Beau Belgrave <[email protected]>…
kernel/trace/trace_events_user.c new file +35
-0@@ -0,0 +1,1159 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* +* Copyright (c) 2021, Microsoft Corporation. +* +* Authors: +* Beau Belgrave <[email protected]> +*/ + +#include <linux/bitmap.h> +#include <linux/cdev.h> +#include <linux/hashtable.h> +#include <linux/list.h> +#include <linux/io.h> +#include <linux/uio.h> +#include <linux/ioctl.h> +#include <linux/jhash.h> +#include <linux/trace_events.h> +#include <linux/tracefs.h> +#include <linux/types.h> +#include <linux/uaccess.h> +#include <uapi/linux/user_events.h> +#include "trace.h" +#include "trace_dynevent.h" + +#define USER_EVENTS_PREFIX_LEN (sizeof(USER_EVENTS_PREFIX)-1) + +#define FIELD_DEPTH_TYPE 0 +#define FIELD_DEPTH_NAME 1 +#define FIELD_DEPTH_SIZE 2 + +/* +* Limits how many trace_event calls user processes can create: +* Must be multiple of PAGE_SIZE. +*/ +#define MAX_PAGES 1
Quoted 9 lines
kernel/trace/trace_events_user.c line 41
Quoted 6 lines
kernel/trace/trace_events_user.c new file +6
-0+#define MAX_EVENTS (MAX_PAGES * PAGE_SIZE) + +/* Limit how long of an event name plus args within the subsystem. */ +#define MAX_EVENT_DESC 512 +#define EVENT_NAME (user_event) ((user_event)->tracepoint.name) +#define MAX_FIELD_ARRAY_SIZE (2 * PAGE_SIZE)You really want to allow field sizes to be larger than a page?
I picked this based on your previous comments that it's likely a bug if something gets quite large. I'm happy with any upper limit, we will be using __rel_loc now that it's available for our large data.
Would you prefer this to be maybe like 1024 or 2048? I don't know if some user scenario will require a large field or what is a realistic upper bound for those scenarios. So no hard data to base this off of from my side.
Quoted 57 lines
Quoted 32 lines
kernel/trace/trace_events_user.c new file +32
-0+ +static char *register_page_data; + +static DEFINE_MUTEX (reg_mutex); +static DEFINE_HASHTABLE(register_table, 4); +static DECLARE_BITMAP(page_bitmap, MAX_EVENTS); + +struct user_event { +struct tracepoint tracepoint; +struct trace_event_call call; +struct trace_event_class class; +struct dyn_event devent; +struct hlist_node node; +struct list_head fields; +atomic_t refcnt; +int index; +int flags; +}; + +struct user_event_refs { +struct rcu_head rcu; +int count; +struct user_event *events[]; +}; + +typedef void (*user_event_func_t ) (struct user_event *user, +void *data,u32 datalen, +void *tpdata); + +static int user_event_parse (char *name,char *args,char *flags, +struct user_event **newuser); +[..]
Quoted 9 lines
kernel/trace/trace_events_user.c new file +9
-0+ +/* +* Validates the user payload and writes via iterator. +*/ +static ssize_t user_events_write_core (struct file *file,struct iov_iter *i) +{ +struct user_event_refs *refs; +struct user_event *user =NULL ; +struct tracepoint *tp;kernel/trace/trace_events_user.c line 735
Quoted 10 lines
kernel/trace/trace_events_user.c new file +10
-0+ssize_t ret = i->count; +int idx; + +if (unlikely (copy_from_iter (&idx,sizeof (idx), i) !=sizeof (idx))) +return -EFAULT ; + +rcu_read_lock_sched (); + + refs =rcu_dereference_sched (file->private_data); +Still need a comment here that states:
Quoted 9 lines
/*
* Therefs->eventsarray is protected by RCU, and new items may be
* added. But the user retrieved from indexing into the events array
* shall be immutable while the file is opened.
*/Or something like that, because once again, I had to figure out how this all worked. It's not obvious.
Sorry about that, I'll ensure to add it.
Quoted 7 lines
Quoted 7 lines
kernel/trace/trace_events_user.c new file +7
-0+if (likely (refs && idx < refs->count)) + user = refs->events[idx]; + +rcu_read_unlock_sched (); + +if (unlikely (user ==NULL )) +return -ENOENT ;
Quoted 9 lines
kernel/trace/trace_events_user.c line 745
Quoted 3 lines
kernel/trace/trace_events_user.c new file +3
-0+ + tp = &user->tracepoint; +Probably also should have a comment here that states that this is racy, but we don't care. That is, the enabled can be less than 1 after the if statement, but that means it was just disabled and it's OK if a few events slip in after it is.
Got it will do.
Quoted 72 lines
Quoted 70 lines
kernel/trace/trace_events_user.c new file +70
-0+if (likely (atomic_read (&tp->key.enabled) >0 )) { +struct tracepoint_func *probe_func_ptr; +user_event_func_t probe_func; +void *tpdata; +void *kdata; +u32 datalen; + + kdata =kmalloc (i->count,GFP_KERNEL ); + +if (unlikely (!kdata)) +return -ENOMEM ; + + datalen =copy_from_iter (kdata, i->count, i); + +rcu_read_lock_sched (); + + probe_func_ptr =rcu_dereference_sched (tp->funcs); + +if (probe_func_ptr) { +do { + probe_func = probe_func_ptr->func; + tpdata = probe_func_ptr->data; +probe_func (user, kdata, datalen, tpdata); + }while ((++probe_func_ptr)->func); + } + +rcu_read_unlock_sched (); + +kfree (kdata); + } + +return ret; +} + +static ssize_t user_events_write (struct file *file,const char __user *ubuf, +size_t count,loff_t *ppos) +{ +struct iovec iov; +struct iov_iter i; + +if (unlikely (*ppos !=0 )) +return -EFAULT ; + +if (unlikely (import_single_range (READ , (char *)ubuf, count, &iov, &i))) +return -EFAULT ; + +return user_events_write_core (file, &i); +} + +static ssize_t user_events_write_iter (struct kiocb *kp,struct iov_iter *i) +{ +return user_events_write_core (kp->ki_filp, i); +} + +static int user_events_ref_add (struct file *file,struct user_event *user) +{ +struct user_event_refs *refs, *new_refs; +int i, size, count =0 ; + + refs =rcu_dereference_protected (file->private_data, +lockdep_is_held (®_mutex)); + +if (refs) { + count = refs->count; + +for (i =0 ; i < count; ++i) +if (refs->events[i] == user) +return i; + } +
Quoted 7 lines
kernel/trace/trace_events_user.c line 816
Quoted 1 line
kernel/trace/trace_events_user.c new file +1
-0+ size =sizeof (*refs) + (sizeof (struct user_event *) * (count +1 ));Use:
size = struct_size(refs, events, count + 1);
Will do.
Quoted 5 lines
Quoted 5 lines
+ * Handles the final close of the file from user mode.
+ */kernel/trace/trace_events_user.c new file +3
-0+static int user_events_release (struct inode *node,struct file *file) +{ +struct user_event_refs *refs;
Quoted 9 lines
kernel/trace/trace_events_user.c line 956
Quoted 6 lines
kernel/trace/trace_events_user.c new file +6
-0+struct user_event *user; +int i; + +rcu_read_lock_sched (); + refs =rcu_dereference_sched (file->private_data); +rcu_read_unlock_sched ();This looks totally wrong. What is RCU protecting here?
There seems to be a timing window where refs gets changed on one core and release happens immediately on another. The release seems to be able to read an old version of that value unless some barrier is imposed.
I've kept with rcu_read_lock_sched() vs READ_ONCE here to try to make that clear.
Do you agree that the timing window is possible?
Quoted 9 lines
kernel/trace/trace_events_user.c line 960
Quoted 4 lines
kernel/trace/trace_events_user.c new file +4
-0+ +if (!refs) + goto out; +How can't
refs->eventsnot change here?Shouldn't
reg_mutexbe held throughout this function?
refs lifetime is limited to file lifetime. When release is called no other reference to the file exists.
So the events array cannot be change since it's isolated to that single file instance (it's not shared).
refs->events is the local array so when user mode writes to an event it uses the index of the events in the first 4 bytes.
The underlying event within the refs->events cannot close down since it's ref counted, which happens below as quoted.
The comment you want me to add higher up in the thread will likely help bring clarity here. Perhaps I'll add another comment at this level as well.
Quoted 6 lines
Quoted 6 lines
kernel/trace/trace_events_user.c new file +6
-0+for (i =0 ; i < refs->count; ++i) { + user = refs->events[i]; + +if (user) +atomic_dec (&user->refcnt); + }
Quoted 8 lines
kernel/trace/trace_events_user.c line 972
Quoted 6 lines
kernel/trace/trace_events_user.c new file +6
-0+ +kfree_rcu (refs, rcu); +out: +return 0 ; +} +-- Steve
Thanks,
-Beau
kernel test robot
build botRe: [PATCH v5 09/12] user_events: Optimize writing events by only copying data once
In reply to Beau BelgraveThank you for the patch! Perhaps something to improve:
Hi Beau,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on 67d4f6e3bf5dddced226fbf19704cdbbb0c98847]
url: https://github.com/0day-ci/linux/commits/Beau-Belgrave/user_events-Enable-user-processes-to-create-and-write-to-trace-events/20211116-090533 base: 67d4f6e3bf5dddced226fbf19704cdbbb0c98847 config: hexagon-randconfig-r031-20211116 (https://download.01.org/0day-ci/archive/20211127/202111272346.r2ZhQ5KM-lkp(a)intel.com/config) compiler: clang version 14.0.0 (https://github.com/llvm/llvm-project fbe72e41b99dc7994daac300d208a955be3e4a0a)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/0day-ci/linux/commit/5d08d02e133130c59d164c17756a0aa0abb5418c
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Beau-Belgrave/user_events-Enable-user-processes-to-create-and-write-to-trace-events/20211116-090533 git checkout 5d08d02e133130c59d164c17756a0aa0abb5418c
# save the config file to linux build tree
mkdir build_dir
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon SHELL=/bin/bash drivers/gpio/ kernel/trace/
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
>> kernel/trace/trace_events_user.c:563:22: warning: comparison of distinct pointer types ('typeof (i->count) *' (aka 'unsigned int *') and 'typeof ((1UL << 16)) *' (aka 'unsigned long *')) [-Wcompare-distinct-pointer-types]
size_t copy_size = min(i->count, MAX_BPF_COPY_SIZE);
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/linux/minmax.h:45:19: note: expanded from macro 'min'
#define min(x, y) __careful_cmp(x, y, <)
^~~~~~~~~~~~~~~~~~~~~~
include/linux/minmax.h:36:24: note: expanded from macro '__careful_cmp'
__builtin_choose_expr(__safe_cmp(x, y), \
^~~~~~~~~~~~~~~~
include/linux/minmax.h:26:4: note: expanded from macro '__safe_cmp'
(__typecheck(x, y) && __no_side_effects(x, y))
^~~~~~~~~~~~~~~~~
include/linux/minmax.h:20:28: note: expanded from macro '__typecheck'
(!!(sizeof((typeof(x) *)1 == (typeof(y) *)1)))
~~~~~~~~~~~~~~ ^ ~~~~~~~~~~~~~~1 warning generated.
vim +563 kernel/trace/trace_events_user.c
537
538 #ifdef CONFIG_PERF_EVENTS
539 static void user_event_bpf(struct user_event *user, struct iov_iter *i)
540 {
541 struct user_bpf_context context;
542 struct user_bpf_iter bpf_i;
543 char fast_data[MAX_STACK_BPF_DATA];
544 void *temp = NULL;
545
546 if ((user->flags & FLAG_BPF_ITER) && iter_is_iovec(i)) {
547 /* Raw iterator */
548 context.data_type = USER_BPF_DATA_ITER;
549 context.data_len = i->count;
550 context.iter = &bpf_i;
551
552 bpf_i.iov_offset = i->iov_offset;
553 bpf_i.iov = i->iov;
554 bpf_i.nr_segs = i->nr_segs;
555 } else if (i->nr_segs == 1 && iter_is_iovec(i)) {
556 /* Single buffer from user */
557 context.data_type = USER_BPF_DATA_USER;
558 context.data_len = i->count;
559 context.udata = i->iov->iov_base + i->iov_offset;
560 } else {
561 /* Multi buffer from user */
562 struct iov_iter copy = *i;
> 563 size_t copy_size = min(i->count, MAX_BPF_COPY_SIZE);
564
565 context.data_type = USER_BPF_DATA_KERNEL;
566 context.kdata = fast_data;
567
568 if (unlikely(copy_size > sizeof(fast_data))) {
569 temp = kmalloc(copy_size, GFP_NOWAIT);
570
571 if (temp)
572 context.kdata = temp;
573 else
574 copy_size = sizeof(fast_data);
575 }
576
577 context.data_len = copy_nofault(context.kdata,
578 copy_size, ©);
579 }
580
581 trace_call_bpf(&user->call, &context);
582
583 kfree(temp);
584 }
585
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org