BPF Standard Streams
Subsystems (8)
Kumar Kartikeya Dwivedi
maintainerv5 cover BPF Standard Streams
This set introduces a standard output interface with two streams, namely stdout and stderr, for BPF programs. The idea is that these streams will be written to by BPF programs and the kernel, and serve as standard interfaces for informing user space of any BPF runtime violations. Users can also utilize them for printing normal messages for debugging usage, as is the case with bpf_printk() and trace pipe interface.
BPF programs and the kernel can use these streams to output messages. User space can dump these messages using bpftool.
The stream interface itself is implemented using a lockless list, so that we can queue messages from any context. Every printk statement into the stream leads to memory allocation. Allocation itself relies on try_alloc_pages() to construct a bespoke bump allocator to carve out elements. If this fails, we finally give up and drop the message.
See commit logs for more details.
Two scenarios are covered:
- Deadlocks and timeouts in rqspinlock.
- Timeouts for may_goto.
In each we provide the stack trace and source information for the offending BPF programs. Both the C source line and the file and line numbers are printed. The output format is as follows:
ERROR: AA or ABBA deadlock detected for bpf_res_spin_lock
Attempted lock = 0xff11000108f3a5e0
Total held locks = 1
Held lock[ 0] = 0xff11000108f3a5e0
CPU: 48 UID: 0 PID: 786 Comm: test_progs Call trace: bpf_stream_stage_dump_stack+0xb0/0xd0 bpf_prog_report_rqspinlock_violation+0x10b/0x130 bpf_res_spin_lock+0x8c/0xa0 bpf_prog_3699ea119d1f6ed8_foo+0xe5/0x140 if (!bpf_res_spin_lock(&v2->lock)) @ stream_bpftool.c:62 bpf_prog_9b324ec4a1b2a5c0_stream_bpftool_dump_prog_stream+0x7e/0x2d0 foo(stream); @ stream_bpftool.c:93 bpf_prog_test_run_syscall+0x102/0x240 __sys_bpf+0xd68/0x2bf0 __x64_sys_bpf+0x1e/0x30 do_syscall_64+0x68/0x140 entry_SYSCALL_64_after_hwframe+0x76/0x7e
ERROR: Timeout detected for may_goto instruction
CPU: 48 UID: 0 PID: 786 Comm: test_progs Call trace: bpf_stream_stage_dump_stack+0xb0/0xd0 bpf_prog_report_may_goto_violation+0x6a/0x90 bpf_check_timed_may_goto+0x4d/0xa0 arch_bpf_timed_may_goto+0x21/0x40 bpf_prog_3699ea119d1f6ed8_foo+0x12f/0x140 while (can_loop) @ stream_bpftool.c:71 bpf_prog_9b324ec4a1b2a5c0_stream_bpftool_dump_prog_stream+0x7e/0x2d0 foo(stream); @ stream_bpftool.c:93 bpf_prog_test_run_syscall+0x102/0x240 __sys_bpf+0xd68/0x2bf0 __x64_sys_bpf+0x1e/0x30 do_syscall_64+0x68/0x140 entry_SYSCALL_64_after_hwframe+0x76/0x7e
Changelog:
----------
v4 -> v5
v4: https://lore.kernel.org/bpf/[email protected]
* Add acks from Emil.
* Address various nits.
* Add extra failure tests.
* Make deadlock test a little more robust to catch problems.
v3 -> v4
v3: https://lore.kernel.org/bpf/[email protected]
* Switch to alloc_pages_nolock(), avoid incorrect memcg accounting. (Alexei)
* We will figure out proper accounting later.
* Drop error limit logic, restrict stream capacity to 100,000 bytes. (Alexei)
* Remove extra invocation of is_bpf_text_address(). (Jiri)
* Avoid emitting NULL byte into the stream text, adjust regex in selftests. (Alexei)
* Add comment around rcu_read_lock() for bpf_prog_ksym_find. (Alexei)
* Tighten stream capacity check selftest.
* Add acks from Andrii.
v2 -> v3
v2: https://lore.kernel.org/bpf/[email protected]
* Fix bug when handling single element stream stage. (Eduard)
* Move to mutex for protection of stream read and copy_to_user(). (Alexei)
* Split bprintf refactor into its own patch. (Alexei)
* Move kfunc definition to common_btf_ids to avoid initcall proliferation. (Alexei)
* Return line number by reference in bpf_prog_get_file_line. (Alexei)
* Remove NULL checks for BTF name pointer. (Alexei)
* Add WARN_ON_ONCE(!rcu_read_lock_held()) in bpf_prog_ksym_find. (Eduard)
* Remove hardcoded stream stage from macros. (Alexei, Eduard)
* Move refactoring hunks to their own patch. (Alexei)
* Add empty opts parameter for future extensibility to libbpf API. (Andrii, Eduard)
* Add BPF_STREAM_{STDOUT,STDERR} to UAPI. (Andrii)
* Add code to match on backtrace output. (Eduard)
* Fix misc nits.
* Add acks.
v1 -> v2
v1: https://lore.kernel.org/bpf/[email protected]
* Drop arena page fault prints, will be done as follow up. (Alexei)
* Defer Andrii's request to reuse code and Alan's suggestion of error counts to follow up.
* Drop bpf_dynptr_from_mem_slice patch.
* Drop some acks due to heavy reworking.
* Fix KASAN splat in bpf_prog_get_file_line. (Eduard)
* Collapse bpf_prog_ksym_find and is_bpf_text_address into single call. (Eduard)
* Add missing RCU read lock in bpf_prog_ksym_find.
* Fix incorrect error handling in dump_stack_cb.
* Simplify libbpf macro. (Eduard, Andrii)
* Introduce bpf_prog_stream_read() libbpf API. (Eduard, Alexei, Andrii)
* Drop BPF prog from the bpftool, use libbpf API.
* Rework selftests.
RFC v1 -> v1
RFC v1: https://lore.kernel.org/bpf/[email protected]
* Rebase on bpf-next/master.
* Change output in dump_stack to also print source line. (Alexei)
* Simplify API to single pop() operation. (Eduard, Alexei)
* Add kdoc for bpf_dynptr_from_mem_slice.
* Fix -EINVAL returned from prog_dump_stream. (Eduard)
* Split dump_stack() patch into multiple commits.
* Add macro wrapping stream staging API.
* Change bpftool command from dump to tracelog. (Quentin)
* Add bpftool documentation and bash completion. (Quentin)
* Change license of bpftool to Dual BSD/GPL.
* Simplify memory allocator. (Alexei)
* No overflow into second page.
* Remove bpf_mem_alloc() fallback.
* Symlink bpftool BPF program and exercise as selftest. (Eduard)
* Verify output after dumping from ringbuf. (Eduard)
* More failure cases to check API invariants.
* Remove patches for dynptr lifetime fixes (split into separate set).
* Limit maximum error messages, and add stream capacity. (Eduard)
Kumar Kartikeya Dwivedi (12):
bpf: Refactor bprintf buffer support
bpf: Introduce BPF standard streams
bpf: Add function to extract program source info
bpf: Ensure RCU lock is held around bpf_prog_ksym_find
bpf: Add function to find program from stack trace
bpf: Add dump_stack() analogue to print to BPF stderr
bpf: Report may_goto timeout to BPF stderr
bpf: Report rqspinlock deadlocks/timeout to BPF stderr
libbpf: Add bpf_stream_printk() macro
libbpf: Introduce bpf_prog_stream_read() API
bpftool: Add support for dumping streams selftests/bpf: Add tests for prog streams
arch/x86/net/bpf_jit_comp.c | 1 - include/linux/bpf.h | 73 ++- include/uapi/linux/bpf.h | 24 + kernel/bpf/Makefile | 2 +- kernel/bpf/core.c | 110 +++- kernel/bpf/helpers.c | 38 +- kernel/bpf/rqspinlock.c | 23 + kernel/bpf/stream.c | 526 ++++++++++++++++++ kernel/bpf/syscall.c | 25 + kernel/bpf/verifier.c | 1 + .../bpftool/Documentation/bpftool-prog.rst | 7 + tools/bpf/bpftool/bash-completion/bpftool | 16 +- tools/bpf/bpftool/prog.c | 49 +- tools/include/uapi/linux/bpf.h | 24 + tools/lib/bpf/bpf.c | 20 + tools/lib/bpf/bpf.h | 21 + tools/lib/bpf/bpf_helpers.h | 16 + tools/lib/bpf/libbpf.map | 1 + .../testing/selftests/bpf/prog_tests/stream.c | 141 +++++ tools/testing/selftests/bpf/progs/stream.c | 79 +++ .../testing/selftests/bpf/progs/stream_fail.c | 33 ++ 21 files changed, 1206 insertions(+), 24 deletions(-) create mode 100644 kernel/bpf/stream.c create mode 100644 tools/testing/selftests/bpf/prog_tests/stream.c create mode 100644 tools/testing/selftests/bpf/progs/stream.c create mode 100644 tools/testing/selftests/bpf/progs/stream_fail.c
base-commit: 38d95beb4b24301362f8bdae7fbdb82d74b803ca
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 1/12 bpf: Refactor bprintf buffer support
Refactor code to be able to get and put bprintf buffers and use bpf_printf_prepare independently. This will be used in the next patch to implement BPF streams support, particularly as a staging buffer for strings that need to be formatted and then allocated and pushed into a stream.
--- include/linux/bpf.h | 15 ++++++++++++++- kernel/bpf/helpers.c | 26 +++++++++++--------------- 2 files changed, 25 insertions(+), 16 deletions(-)
include/linux/bpf.h +14 -1
@@ -3550,6 +3550,16 @@ bool btf_id_set_contains(const struct btf_id_set *set, u32 id);#define MAX_BPRINTF_VARARGS 12#define MAX_BPRINTF_BUF 1024 +/* Per-cpu temp buffers used by printf-like helpers to store the bprintf binary +* arguments representation. +*/ +#define MAX_BPRINTF_BIN_ARGS 512 + +struct bpf_bprintf_buffers { +char bin_args[MAX_BPRINTF_BIN_ARGS ]; +char buf[MAX_BPRINTF_BUF ]; +}; +struct bpf_bprintf_data {u32 *bin_args;char *buf;
@@ -3557,9 +3567,12 @@ struct bpf_bprintf_data {bool get_buf; }; -int bpf_bprintf_prepare (char *fmt,u32 fmt_size,const u64 *raw_args, +int bpf_bprintf_prepare (const char *fmt,u32 fmt_size,const u64 *raw_args,u32 num_args,struct bpf_bprintf_data *data);void bpf_bprintf_cleanup (struct bpf_bprintf_data *data); +int bpf_try_get_buffers (struct bpf_bprintf_buffers **bufs); +void bpf_put_buffers (void ); +#ifdef CONFIG_BPF_LSM void bpf_cgroup_atype_get (u32 attach_btf_id,int cgroup_atype);
kernel/bpf/helpers.c +11 -15
@@ -764,22 +764,13 @@ static int bpf_trace_copy_string(char *buf, void *unsafe_ptr, char fmt_ptype,return -EINVAL ; } -/* Per-cpu temp buffers used by printf-like helpers to store the bprintf binary -* arguments representation. -*/ -#define MAX_BPRINTF_BIN_ARGS 512 -/* Support executing three nested bprintf helper calls on a given CPU */ #define MAX_BPRINTF_NEST_LEVEL 3 -struct bpf_bprintf_buffers { -char bin_args[MAX_BPRINTF_BIN_ARGS ]; -char buf[MAX_BPRINTF_BUF ]; -}; static DEFINE_PER_CPU(struct bpf_bprintf_buffers[MAX_BPRINTF_NEST_LEVEL], bpf_bprintf_bufs); static DEFINE_PER_CPU(int, bpf_bprintf_nest_level); -static int try_get_buffers (struct bpf_bprintf_buffers **bufs) +int bpf_try_get_buffers (struct bpf_bprintf_buffers **bufs) {int nest_level;
@@ -795,16 +786,21 @@ static int try_get_buffers(struct bpf_bprintf_buffers **bufs)return 0 ; } -void bpf_bprintf_cleanup (struct bpf_bprintf_data *data) +void bpf_put_buffers (void ) { -if (!data->bin_args && !data->buf) -return ;if (WARN_ON_ONCE (this_cpu_read (bpf_bprintf_nest_level) ==0 ))return ;this_cpu_dec (bpf_bprintf_nest_level);preempt_enable (); } +void bpf_bprintf_cleanup (struct bpf_bprintf_data *data) +{ +if (!data->bin_args && !data->buf) +return ; +bpf_put_buffers (); +} +/* * bpf_bprintf_prepare - Generic pass on format strings for bprintf-like helpers *
@@ -819,7 +815,7 @@ void bpf_bprintf_cleanup(struct bpf_bprintf_data *data)* In argument preparation mode, if 0 is returned, safe temporary buffers are * allocated and bpf_bprintf_cleanup should be called to free them after use. */ -int bpf_bprintf_prepare (char *fmt,u32 fmt_size,const u64 *raw_args, +int bpf_bprintf_prepare (const char *fmt,u32 fmt_size,const u64 *raw_args,u32 num_args,struct bpf_bprintf_data *data) {bool get_buffers = (data->get_bin_args && num_args) || data->get_buf;
@@ -835,7 +831,7 @@ int bpf_bprintf_prepare(char *fmt, u32 fmt_size, const u64 *raw_args,return -EINVAL ; fmt_size = fmt_end - fmt; -if (get_buffers &&try_get_buffers (&buffers)) +if (get_buffers &&bpf_try_get_buffers (&buffers))return -EBUSY ;if (data->get_bin_args) {
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 2/12 bpf: Introduce BPF standard streams
In reply to Kumar Kartikeya DwivediAdd support for a stream API to the kernel and expose related kfuncs to BPF programs. Two streams are exposed, BPF_STDOUT and BPF_STDERR. These can be used for printing messages that can be consumed from user space, thus it's similar in spirit to existing trace_pipe interface.
The kernel will use the BPF_STDERR stream to notify the program of any errors encountered at runtime. BPF programs themselves may use both streams for writing debug messages. BPF library-like code may use BPF_STDERR to print warnings or errors on misuse at runtime.
The implementation of a stream is as follows. Everytime a message is emitted from the kernel (directly, or through a BPF program), a record is allocated by bump allocating from per-cpu region backed by a page obtained using alloc_pages_nolock(). This ensures that we can allocate memory from any context. The eventual plan is to discard this scheme in favor of Alexei's kmalloc_nolock() [0].
This record is then locklessly inserted into a list (llist_add()) so that the printing side doesn't require holding any locks, and works in any context. Each stream has a maximum capacity of 4MB of text, and each printed message is accounted against this limit.
Messages from a program are emitted using the bpf_stream_vprintk kfunc, which takes a stream_id argument in addition to working otherwise similar to bpf_trace_vprintk.
The bprintf buffer helpers are extracted out to be reused for printing the string into them before copying it into the stream, so that we can (with the defined max limit) format a string and know its true length before performing allocations of the stream element.
For consuming elements from a stream, we expose a bpf(2) syscall command named BPF_PROG_STREAM_READ_BY_FD, which allows reading data from the stream of a given prog_fd into a user space buffer. The main logic is implemented in bpf_stream_read(). The log messages are queued in bpf_stream::log by the bpf_stream_vprintk kfunc, and then pulled and ordered correctly in the stream backlog.
For this purpose, we hold a lock around bpf_stream_backlog_peek(), as llist_del_first() (if we maintained a second lockless list for the backlog) wouldn't be safe from multiple threads anyway. Then, if we fail to find something in the backlog log, we splice out everything from the lockless log, and place it in the backlog log, and then return the head of the backlog. Once the full length of the element is consumed, we will pop it and free it.
The lockless list bpf_stream::log is a LIFO stack. Elements obtained using a llist_del_all() operation are in LIFO order, thus would break the chronological ordering if printed directly. Hence, this batch of messages is first reversed. Then, it is stashed into a separate list in the stream, i.e. the backlog_log. The head of this list is the actual message that should always be returned to the caller. All of this is done in bpf_stream_backlog_fill().
From the kernel side, the writing into the stream will be a bit more involved than the typical printk. First, the kernel typically may print a collection of messages into the stream, and parallel writers into the stream may suffer from interleaving of messages. To ensure each group of messages is visible atomically, we can lift the advantage of using a lockless list for pushing in messages.
To enable this, we add a bpf_stream_stage() macro, and require kernel users to use bpf_stream_printk statements for the passed expression to write into the stream. Underneath the macro, we have a message staging API, where a bpf_stream_stage object on the stack accumulates the messages being printed into a local llist_head, and then a commit operation splices the whole batch into the stream's lockless log list.
This is especially pertinent for rqspinlock deadlock messages printed to program streams. After this change, we see each deadlock invocation as a non-interleaving contiguous message without any confusion on the reader's part, improving their user experience in debugging the fault.
While programs cannot benefit from this staged stream writing API, they could just as well hold an rqspinlock around their print statements to serialize messages, hence this is kept kernel-internal for now.
Overall, this infrastructure provides NMI-safe any context printing of messages to two dedicated streams.
Later patches will add support for printing splats in case of BPF arena page faults, rqspinlock deadlocks, and cond_break timeouts, and integration of this facility into bpftool for dumping messages to user space.
[0]: https://lore.kernel.org/bpf/[email protected]
--- include/linux/bpf.h | 52 ++++ include/uapi/linux/bpf.h | 24 ++ kernel/bpf/Makefile | 2 +- kernel/bpf/core.c | 5 + kernel/bpf/helpers.c | 1 + kernel/bpf/stream.c | 478 +++++++++++++++++++++++++++++++++ kernel/bpf/syscall.c | 25 ++ kernel/bpf/verifier.c | 1 + tools/include/uapi/linux/bpf.h | 24 ++ 9 files changed, 611 insertions(+), 1 deletion(-) create mode 100644 kernel/bpf/stream.c
include/linux/bpf.h +52 -0
@@ -1538,6 +1538,37 @@ struct btf_mod_pair {struct bpf_kfunc_desc_tab ; +enum bpf_stream_id { +BPF_STDOUT =1 , +BPF_STDERR =2 , +}; + +struct bpf_stream_elem { +struct llist_node node; +int total_len; +int consumed_len; +char str[]; +}; + +enum { +/* 100k bytes */ +BPF_STREAM_MAX_CAPACITY =100000ULL , +}; + +struct bpf_stream { +atomic_t capacity; +struct llist_head log;/* list of in-flight stream elements in LIFO order */ + +struct mutex lock;/* lock protecting backlog_{head,tail} */ +struct llist_node *backlog_head;/* list of in-flight stream elements in FIFO order */ +struct llist_node *backlog_tail;/* tail of the list above */ +}; + +struct bpf_stream_stage { +struct llist_head log; +int len; +}; +struct bpf_prog_aux {atomic64_t refcnt;u32 used_map_cnt;
@@ -1646,6 +1677,7 @@ struct bpf_prog_aux {struct work_struct work;struct rcu_head rcu; }; +struct bpf_stream stream[2 ]; };struct bpf_prog {
@@ -2408,6 +2440,7 @@ int generic_map_delete_batch(struct bpf_map *map,struct bpf_map *bpf_map_get_curr_or_next (u32 *id);struct bpf_prog *bpf_prog_get_curr_or_next (u32 *id); +int bpf_map_alloc_pages (const struct bpf_map *map,int nid,unsigned long nr_pages,struct page **page_array);#ifdef CONFIG_MEMCG
@@ -3573,6 +3606,25 @@ void bpf_bprintf_cleanup(struct bpf_bprintf_data *data);int bpf_try_get_buffers (struct bpf_bprintf_buffers **bufs);void bpf_put_buffers (void ); +void bpf_prog_stream_init (struct bpf_prog *prog); +void bpf_prog_stream_free (struct bpf_prog *prog); +int bpf_prog_stream_read (struct bpf_prog *prog,enum bpf_stream_id stream_id,void __user *buf,int len); +void bpf_stream_stage_init (struct bpf_stream_stage *ss); +void bpf_stream_stage_free (struct bpf_stream_stage *ss); +__printf(2, 3) +int bpf_stream_stage_printk (struct bpf_stream_stage *ss,const char *fmt, ...); +int bpf_stream_stage_commit (struct bpf_stream_stage *ss,struct bpf_prog *prog, +enum bpf_stream_id stream_id); + +#define bpf_stream_printk (ss, ...) bpf_stream_stage_printk(&ss, __VA_ARGS__) + +#define bpf_stream_stage (ss, prog, stream_id, expr) \ + ({ \ + bpf_stream_stage_init(&ss); \ + (expr); \ + bpf_stream_stage_commit(&ss, prog, stream_id); \ + bpf_stream_stage_free(&ss); \ + })#ifdef CONFIG_BPF_LSM void bpf_cgroup_atype_get (u32 attach_btf_id,int cgroup_atype);
include/uapi/linux/bpf.h +24 -0
@@ -906,6 +906,17 @@ union bpf_iter_link_info {* A new file descriptor (a nonnegative integer), or -1 if an * error occurred (in which case, *errno* is set appropriately). * +* BPF_PROG_STREAM_READ_BY_FD +* Description +* Read data of a program's BPF stream. The program is identified +* by *prog_fd*, and the stream is identified by the *stream_id*. +* The data is copied to a buffer pointed to by *stream_buf*, and +* filled less than or equal to *stream_buf_len* bytes. +* +* Return +* Number of bytes read from the stream on success, or -1 if an +* error occurred (in which case, *errno* is set appropriately). +* * NOTES * eBPF objects (maps and programs) can be shared between processes. *
@@ -961,6 +972,7 @@ enum bpf_cmd {BPF_LINK_DETACH ,BPF_PROG_BIND_MAP ,BPF_TOKEN_CREATE , +BPF_PROG_STREAM_READ_BY_FD , __MAX_BPF_CMD, };
@@ -1463,6 +1475,11 @@ struct bpf_stack_build_id {#define BPF_OBJ_NAME_LEN 16U +enum { +BPF_STREAM_STDOUT =1 , +BPF_STREAM_STDERR =2 , +}; +union bpf_attr {struct {/* anonymous struct used by BPF_MAP_CREATE command */ __u32 map_type;/* one of enum bpf_map_type */
@@ -1849,6 +1866,13 @@ union bpf_attr {__u32 bpffs_fd; } token_create; +struct { +__aligned_u64 stream_buf; +__u32 stream_buf_len; +__u32 stream_id; +__u32 prog_fd; + } prog_stream_read; + } __attribute__((aligned(8)));/* The description below is an attempt at providing documentation to eBPF
kernel/bpf/Makefile +1 -1
@@ -14,7 +14,7 @@ obj-$(CONFIG_BPF_SYSCALL) += bpf_local_storage.o bpf_task_storage.o obj-${CONFIG_BPF_LSM} += bpf_inode_storage.o obj-$(CONFIG_BPF_SYSCALL) += disasm.o mprog.o obj-$(CONFIG_BPF_JIT) += trampoline.o -obj-$(CONFIG_BPF_SYSCALL) += btf.o memalloc.o rqspinlock.o +obj-$(CONFIG_BPF_SYSCALL) += btf.o memalloc.o rqspinlock.o stream.o ifeq ($(CONFIG_MMU)$(CONFIG_64BIT),yy) obj-$(CONFIG_BPF_SYSCALL) += arena.o range_tree.o endif
kernel/bpf/core.c +5 -0
@@ -134,6 +134,10 @@ struct bpf_prog *bpf_prog_alloc_no_stats(unsigned int size, gfp_t gfp_extra_flagmutex_init (&fp->aux->ext_mutex);mutex_init (&fp->aux->dst_mutex); +#ifdef CONFIG_BPF_SYSCALL +bpf_prog_stream_init (fp); +#endif +return fp; }
@@ -2862,6 +2866,7 @@ static void bpf_prog_free_deferred(struct work_struct *work) aux = container_of(work, struct bpf_prog_aux, work);#ifdef CONFIG_BPF_SYSCALL bpf_free_kfunc_btf_tab (aux->kfunc_btf_tab); +bpf_prog_stream_free (aux->prog);#endif #ifdef CONFIG_CGROUP_BPF if (aux->cgroup_atype !=CGROUP_BPF_ATTACH_TYPE_INVALID )
kernel/bpf/helpers.c +1 -0
@@ -3778,6 +3778,7 @@ BTF_ID_FLAGS(func, bpf_strnstr);#if defined(CONFIG_BPF_LSM ) && defined(CONFIG_CGROUPS ) BTF_ID_FLAGS(func, bpf_cgroup_read_xattr, KF_RCU)#endif +BTF_ID_FLAGS(func, bpf_stream_vprintk, KF_TRUSTED_ARGS)BTF_KFUNCS_END (common_btf_ids) static const struct btf_kfunc_id_set common_kfunc_set = {
kernel/bpf/stream.c new file +478 -0
478 lines not on this page · raw message
kernel/bpf/syscall.c +25 -0
@@ -5936,6 +5936,28 @@ static int token_create(union bpf_attr *attr)return bpf_token_create (attr); } +#define BPF_PROG_STREAM_READ_BY_FD_LAST_FIELD prog_stream_read.prog_fd + +static int prog_stream_read (union bpf_attr *attr) +{ +char __user *buf =u64_to_user_ptr (attr->prog_stream_read.stream_buf); +u32 len = attr->prog_stream_read.stream_buf_len; +struct bpf_prog *prog; +int ret; + +if (CHECK_ATTR (BPF_PROG_STREAM_READ_BY_FD )) +return -EINVAL ; + + prog =bpf_prog_get (attr->prog_stream_read.prog_fd); +if (IS_ERR (prog)) +return PTR_ERR (prog); + + ret =bpf_prog_stream_read (prog, attr->prog_stream_read.stream_id, buf, len); +bpf_prog_put (prog); + +return ret; +} +static int __sys_bpf (enum bpf_cmd cmd,bpfptr_t uattr,unsigned int size) {union bpf_attr attr;
@@ -6072,6 +6094,9 @@ static int __sys_bpf(enum bpf_cmd cmd, bpfptr_t uattr, unsigned int size)case BPF_TOKEN_CREATE : err =token_create (&attr);break ; +case BPF_PROG_STREAM_READ_BY_FD : + err =prog_stream_read (&attr); +break ;default : err = -EINVAL ;break ;
kernel/bpf/verifier.c +1 -0
@@ -46,6 +46,7 @@ static const struct bpf_verifier_ops * const bpf_verifier_ops[] = {enum bpf_features {BPF_FEAT_RDONLY_CAST_TO_VOID =0 , +BPF_FEAT_STREAMS =1 , __MAX_BPF_FEAT, };
tools/include/uapi/linux/bpf.h +24 -0
@@ -906,6 +906,17 @@ union bpf_iter_link_info {* A new file descriptor (a nonnegative integer), or -1 if an * error occurred (in which case, *errno* is set appropriately). * +* BPF_PROG_STREAM_READ_BY_FD +* Description +* Read data of a program's BPF stream. The program is identified +* by *prog_fd*, and the stream is identified by the *stream_id*. +* The data is copied to a buffer pointed to by *stream_buf*, and +* filled less than or equal to *stream_buf_len* bytes. +* +* Return +* Number of bytes read from the stream on success, or -1 if an +* error occurred (in which case, *errno* is set appropriately). +* * NOTES * eBPF objects (maps and programs) can be shared between processes. *
@@ -961,6 +972,7 @@ enum bpf_cmd {BPF_LINK_DETACH ,BPF_PROG_BIND_MAP ,BPF_TOKEN_CREATE , +BPF_PROG_STREAM_READ_BY_FD , __MAX_BPF_CMD, };
@@ -1463,6 +1475,11 @@ struct bpf_stack_build_id {#define BPF_OBJ_NAME_LEN 16U +enum { +BPF_STREAM_STDOUT =1 , +BPF_STREAM_STDERR =2 , +}; +union bpf_attr {struct {/* anonymous struct used by BPF_MAP_CREATE command */ __u32 map_type;/* one of enum bpf_map_type */
@@ -1849,6 +1866,13 @@ union bpf_attr {__u32 bpffs_fd; } token_create; +struct { +__aligned_u64 stream_buf; +__u32 stream_buf_len; +__u32 stream_id; +__u32 prog_fd; + } prog_stream_read; + } __attribute__((aligned(8)));/* The description below is an attempt at providing documentation to eBPF
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 3/12 bpf: Add function to extract program source info
In reply to Kumar Kartikeya DwivediPrepare a function for use in future patches that can extract the file info, line info, and the source line number for a given BPF program provided it's program counter.
Only the basename of the file path is provided, given it can be excessively long in some cases.
This will be used in later patches to print source info to the BPF stream.
--- include/linux/bpf.h | 3 +++ kernel/bpf/core.c | 47 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+)
include/linux/bpf.h +3 -0
@@ -3660,4 +3660,7 @@ static inline bool bpf_is_subprog(const struct bpf_prog *prog) return prog->aux->func_idx != 0; } +int bpf_prog_get_file_line (struct bpf_prog *prog,unsigned long ip,const char **filep, +const char **linep,int *nump); +#endif /* _LINUX_BPF_H */
kernel/bpf/core.c +47 -0
50 lines not on this page · raw message
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 4/12 bpf: Ensure RCU lock is held around bpf_prog_ksym_find
In reply to Kumar Kartikeya DwivediAdd a warning to ensure RCU lock is held around tree lookup, and then fix one of the invocations in bpf_stack_walker. The program has an active stack frame and won't disappear. Use the opportunity to remove unneeded invocation of is_bpf_text_address.
--- kernel/bpf/core.c | 5 ++++- kernel/bpf/helpers.c | 11 +++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-)
kernel/bpf/core.c +4 -1
@@ -782,7 +782,10 @@ bool is_bpf_text_address(unsigned long addr)struct bpf_prog *bpf_prog_ksym_find (unsigned long addr) { -struct bpf_ksym *ksym =bpf_ksym_find (addr); +struct bpf_ksym *ksym; + +WARN_ON_ONCE (!rcu_read_lock_held ()); + ksym =bpf_ksym_find (addr);return ksym && ksym->prog ? container_of(ksym, struct bpf_prog_aux, ksym)->prog :
kernel/bpf/helpers.c +9 -2
@@ -2935,9 +2935,16 @@ static bool bpf_stack_walker(void *cookie, u64 ip, u64 sp, u64 bp)struct bpf_throw_ctx *ctx = cookie;struct bpf_prog *prog; -if (!is_bpf_text_address (ip)) -return !ctx->cnt; +/* +* The RCU read lock is held to safely traverse the latch tree, but we +* don't need its protection when accessing the prog, since it has an +* active stack frame on the current stack trace, and won't disappear. +*/ +rcu_read_lock (); prog =bpf_prog_ksym_find (ip); +rcu_read_unlock (); +if (!prog) +return !ctx->cnt; ctx->cnt++;if (bpf_is_subprog (prog))return true;
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 5/12 bpf: Add function to find program from stack trace
In reply to Kumar Kartikeya DwivediIn preparation of figuring out the closest program that led to the current point in the kernel, implement a function that scans through the stack trace and finds out the closest BPF program when walking down the stack trace.
Special care needs to be taken to skip over kernel and BPF subprog frames. We basically scan until we find a BPF main prog frame. The assumption is that if a program calls into us transitively, we'll hit it along the way. If not, we end up returning NULL.
Contextually the function will be used in places where we know the program may have called into us.
Due to reliance on arch_bpf_stack_walk(), this function only works on x86 with CONFIG_UNWINDER_ORC, arm64, and s390. Remove the warning from arch_bpf_stack_walk as well since we call it outside bpf_throw() context.
--- arch/x86/net/bpf_jit_comp.c | 1 - include/linux/bpf.h | 1 + kernel/bpf/core.c | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 34 insertions(+), 1 deletion(-)
arch/x86/net/bpf_jit_comp.c +0 -1
@@ -3845,7 +3845,6 @@ void arch_bpf_stack_walk(bool (*consume_fn)(void *cookie, u64 ip, u64 sp, u64 bp }return ;#endif -WARN (1 ,"verification of programs using bpf_throw should have failed\n" ); } void bpf_arch_poke_desc_update(struct bpf_jit_poke_descriptor *poke,
include/linux/bpf.h +1 -0
@@ -3662,5 +3662,6 @@ static inline bool bpf_is_subprog(const struct bpf_prog *prog)int bpf_prog_get_file_line (struct bpf_prog *prog,unsigned long ip,const char **filep,const char **linep,int *nump); +struct bpf_prog *bpf_prog_find_from_stack (void );#endif /* _LINUX_BPF_H */
kernel/bpf/core.c +33 -0
@@ -3262,4 +3262,37 @@ int bpf_prog_get_file_line(struct bpf_prog *prog, unsigned long ip, const char * return 0; } +struct walk_stack_ctx { +struct bpf_prog *prog; +}; + +static bool find_from_stack_cb (void *cookie,u64 ip,u64 sp,u64 bp) +{ +struct walk_stack_ctx *ctxp = cookie; +struct bpf_prog *prog; + +/* +* The RCU read lock is held to safely traverse the latch tree, but we +* don't need its protection when accessing the prog, since it has an +* active stack frame on the current stack trace, and won't disappear. +*/ +rcu_read_lock (); + prog =bpf_prog_ksym_find (ip); +rcu_read_unlock (); +if (!prog) +return true; +if (bpf_is_subprog (prog)) +return true; + ctxp->prog = prog; +return false; +} + +struct bpf_prog *bpf_prog_find_from_stack (void ) +{ +struct walk_stack_ctx ctx = {}; + +arch_bpf_stack_walk (find_from_stack_cb, &ctx); +return ctx.prog; +} +#endif
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 6/12 bpf: Add dump_stack() analogue to print to BPF stderr
In reply to Kumar Kartikeya DwivediIntroduce a kernel function which is the analogue of dump_stack() printing some useful information and the stack trace. This is not exposed to BPF programs yet, but can be made available in the future.
When we have a program counter for a BPF program in the stack trace, also additionally output the filename and line number to make the trace helpful. The rest of the trace can be passed into ./decode_stacktrace.sh to obtain the line numbers for kernel symbols.
--- include/linux/bpf.h | 2 ++ kernel/bpf/stream.c | 48 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+)
include/linux/bpf.h +2 -0
@@ -3615,8 +3615,10 @@ __printf(2, 3)int bpf_stream_stage_printk (struct bpf_stream_stage *ss,const char *fmt, ...);int bpf_stream_stage_commit (struct bpf_stream_stage *ss,struct bpf_prog *prog,enum bpf_stream_id stream_id); +int bpf_stream_stage_dump_stack (struct bpf_stream_stage *ss);#define bpf_stream_printk (ss, ...) bpf_stream_stage_printk(&ss, __VA_ARGS__) +#define bpf_stream_dump_stack (ss) bpf_stream_stage_dump_stack(&ss)#define bpf_stream_stage (ss, prog, stream_id, expr) \ ({ \
kernel/bpf/stream.c +48 -0
57 lines not on this page · raw message
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 7/12 bpf: Report may_goto timeout to BPF stderr
In reply to Kumar Kartikeya DwivediBegin reporting may_goto timeouts to BPF program's stderr stream.
--- kernel/bpf/core.c | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)
kernel/bpf/core.c +19 -1
@@ -3168,6 +3168,22 @@ u64 __weak arch_bpf_timed_may_goto(void)return 0 ; } +static noinline void bpf_prog_report_may_goto_violation(void) +{ +#ifdef CONFIG_BPF_SYSCALL +struct bpf_stream_stage ss; +struct bpf_prog *prog; + + prog =bpf_prog_find_from_stack (); +if (!prog) +return ; +bpf_stream_stage (ss, prog,BPF_STDERR , ({ +bpf_stream_printk (ss,"ERROR: Timeout detected for may_goto instruction\n" ); +bpf_stream_dump_stack (ss); + })); +#endif +} +u64 bpf_check_timed_may_goto (struct bpf_timed_may_goto *p) {u64 time =ktime_get_mono_fast_ns ();
@@ -3178,8 +3194,10 @@ u64 bpf_check_timed_may_goto(struct bpf_timed_may_goto *p)return BPF_MAX_TIMED_LOOPS ; }/* Check if we've exhausted our time slice, and zero count. */ -if (time - p->timestamp >= (NSEC_PER_SEC /4 )) +if (unlikely (time - p->timestamp >= (NSEC_PER_SEC /4 ))) { +bpf_prog_report_may_goto_violation ();return 0 ; + }/* Refresh the count for the stack frame. */ return BPF_MAX_TIMED_LOOPS ; }
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 8/12 bpf: Report rqspinlock deadlocks/timeout to BPF stderr
In reply to Kumar Kartikeya DwivediBegin reporting rqspinlock deadlocks and timeout to BPF program's stderr.
--- kernel/bpf/rqspinlock.c | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
kernel/bpf/rqspinlock.c +23 -0
@@ -666,6 +666,27 @@ EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath);__bpf_kfunc_start_defs (); +static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; + + prog =bpf_prog_find_from_stack (); +if (!prog) +return ; +bpf_stream_stage (ss, prog,BPF_STDERR , ({ +bpf_stream_printk (ss,"ERROR: %s for bpf_res_spin_lock%s\n" , str, irqsave ?"_irqsave" :"" ); +bpf_stream_printk (ss,"Attempted lock = 0x%px\n" , lock); +bpf_stream_printk (ss,"Total held locks = %d\n" , rqh->cnt); +for (int i =0 ; i <min (RES_NR_HELD , rqh->cnt); i++) +bpf_stream_printk (ss,"Held lock[%2d] = 0x%px\n" , i, rqh->locks[i]); +bpf_stream_dump_stack (ss); + })); +} + +#define REPORT_STR (ret) ({ (ret) == -ETIMEDOUT ? "Timeout detected" : "AA or ABBA deadlock detected"; }) + __bpf_kfunc int bpf_res_spin_lock(struct bpf_res_spin_lock *lock) {int ret;
@@ -676,6 +697,7 @@ __bpf_kfunc int bpf_res_spin_lock(struct bpf_res_spin_lock *lock)preempt_disable (); ret =res_spin_lock ((rqspinlock_t *)lock);if (unlikely (ret)) { +bpf_prog_report_rqspinlock_violation (REPORT_STR (ret), lock, false);preempt_enable ();return ret; }
@@ -698,6 +720,7 @@ __bpf_kfunc int bpf_res_spin_lock_irqsave(struct bpf_res_spin_lock *lock, unsignlocal_irq_save (flags); ret =res_spin_lock ((rqspinlock_t *)lock);if (unlikely (ret)) { +bpf_prog_report_rqspinlock_violation (REPORT_STR (ret), lock, true);local_irq_restore (flags);preempt_enable ();return ret;
Signature · 1 line
2.47.1
Re: [PATCH bpf-next v5 08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr
Quoted 6 lines · Kumar Kartikeya Dwivedi
kernel/bpf/rqspinlock.c +6
-0+static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; +
kernel/bpf/rqspinlock.c EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath); · line 684
Quoted 10 lines
kernel/bpf/rqspinlock.c +10
-0+ prog =bpf_prog_find_from_stack (); +if (!prog) +return ; + bpf_stream_stage(ss, prog, BPF_STDERR, ({ + bpf_stream_printk(ss, "ERROR: %s for bpf_res_spin_lock%s\n", str, irqsave ? "_irqsave" : ""); + bpf_stream_printk(ss, "Attempted lock = 0x%px\n", lock); + bpf_stream_printk(ss, "Total held locks = %d\n", rqh->cnt); + for (int i = 0; i < min(RES_NR_HELD, rqh->cnt); i++) + bpf_stream_printk(ss, "Held lock[%2d] = 0x%px\n", i, rqh->locks[i]); + bpf_stream_dump_stack(ss);
Please don't include %px in stuff going back to userspace in standard error reporting. That's a kernel address leak:
https://docs.kernel.org/process/deprecated.html#p-format-specifier
I don't see any justification here, please remove the lock address or use regular %p to get a hashed value.
Signature · 1 line
Kees Cook
Re: [PATCH bpf-next v5 08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr
Quoted 23 lines · Kees Cook
Quoted 6 lines · Kumar Kartikeya Dwivedi
kernel/bpf/rqspinlock.c +6
-0+static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; +kernel/bpf/rqspinlock.c EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath); · line 684
Quoted 10 lines
kernel/bpf/rqspinlock.c +10
-0+ prog =bpf_prog_find_from_stack (); +if (!prog) +return ; + bpf_stream_stage(ss, prog, BPF_STDERR, ({ + bpf_stream_printk(ss, "ERROR: %s for bpf_res_spin_lock%s\n", str, irqsave ? "_irqsave" : ""); + bpf_stream_printk(ss, "Attempted lock = 0x%px\n", lock); + bpf_stream_printk(ss, "Total held locks = %d\n", rqh->cnt); + for (int i = 0; i < min(RES_NR_HELD, rqh->cnt); i++) + bpf_stream_printk(ss, "Held lock[%2d] = 0x%px\n", i, rqh->locks[i]); + bpf_stream_dump_stack(ss);Please don't include %px in stuff going back to userspace in standard error reporting. That's a kernel address leak:
https://docs.kernel.org/process/deprecated.html#p-format-specifier
Quoted 2 lines
I don't see any justification here, please remove the lock address or use regular %p to get a hashed value.
There is no leak here.
The prog was loaded by root and error is read by root.
Re: [PATCH bpf-next v5 08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr
Quoted 24 lines · Alexei Starovoitov
Quoted 23 lines · Kees Cook
Quoted 6 lines · Kumar Kartikeya Dwivedi
kernel/bpf/rqspinlock.c +6
-0+static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; +kernel/bpf/rqspinlock.c EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath); · line 684
Quoted 10 lines
kernel/bpf/rqspinlock.c +10
-0+ prog =bpf_prog_find_from_stack (); +if (!prog) +return ; + bpf_stream_stage(ss, prog, BPF_STDERR, ({ + bpf_stream_printk(ss, "ERROR: %s for bpf_res_spin_lock%s\n", str, irqsave ? "_irqsave" : ""); + bpf_stream_printk(ss, "Attempted lock = 0x%px\n", lock); + bpf_stream_printk(ss, "Total held locks = %d\n", rqh->cnt); + for (int i = 0; i < min(RES_NR_HELD, rqh->cnt); i++) + bpf_stream_printk(ss, "Held lock[%2d] = 0x%px\n", i, rqh->locks[i]); + bpf_stream_dump_stack(ss);Please don't include %px in stuff going back to userspace in standard error reporting. That's a kernel address leak:
https://docs.kernel.org/process/deprecated.html#p-format-specifier
Quoted 5 lines
Quoted 2 lines
I don't see any justification here, please remove the lock address or use regular %p to get a hashed value.
There is no leak here.
The prog was loaded by root and error is read by root.
uid has nothing to do with it. Leaking addresses needs the right capability set. Is that always true here?
Signature · 1 line
Kees Cook
Re: [PATCH bpf-next v5 08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr
Quoted 26 lines · Kees Cook
Quoted 24 lines · Alexei Starovoitov
Quoted 23 lines · Kees Cook
Quoted 6 lines · Kumar Kartikeya Dwivedi
kernel/bpf/rqspinlock.c +6
-0+static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; +kernel/bpf/rqspinlock.c EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath); · line 684
Quoted 10 lines
kernel/bpf/rqspinlock.c +10
-0+ prog =bpf_prog_find_from_stack (); +if (!prog) +return ; + bpf_stream_stage(ss, prog, BPF_STDERR, ({ + bpf_stream_printk(ss, "ERROR: %s for bpf_res_spin_lock%s\n", str, irqsave ? "_irqsave" : ""); + bpf_stream_printk(ss, "Attempted lock = 0x%px\n", lock); + bpf_stream_printk(ss, "Total held locks = %d\n", rqh->cnt); + for (int i = 0; i < min(RES_NR_HELD, rqh->cnt); i++) + bpf_stream_printk(ss, "Held lock[%2d] = 0x%px\n", i, rqh->locks[i]); + bpf_stream_dump_stack(ss);Please don't include %px in stuff going back to userspace in standard error reporting. That's a kernel address leak:
https://docs.kernel.org/process/deprecated.html#p-format-specifier
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines
I don't see any justification here, please remove the lock address or use regular %p to get a hashed value.
There is no leak here.
The prog was loaded by root and error is read by root.uid has nothing to do with it. Leaking addresses needs the right capability set. Is that always true here?
yes. For bpf prog to use this kfunc it needs CAP_BPF and CAP_PERMON. What's allowed under them is described in include/uapi/linux/capability.h
Re: [PATCH bpf-next v5 08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr
Quoted 30 lines · Alexei Starovoitov
Quoted 29 lines · Kees Cook
Quoted 27 lines · Alexei Starovoitov
Quoted 25 lines · Kees Cook
Quoted 6 lines · Kumar Kartikeya Dwivedi
kernel/bpf/rqspinlock.c +6
-0+static void bpf_prog_report_rqspinlock_violation (const char *str,void *lock,bool irqsave) +{ +struct rqspinlock_held *rqh =this_cpu_ptr (&rqspinlock_held_locks); +struct bpf_stream_stage ss; +struct bpf_prog *prog; +kernel/bpf/rqspinlock.c EXPORT_SYMBOL_GPL(resilient_queued_spin_lock_slowpath); · line 684
Quoted 10 lines
kernel/bpf/rqspinlock.c +10
-0+ prog =bpf_prog_find_from_stack (); +if (!prog) +return ; + bpf_stream_stage(ss, prog, BPF_STDERR, ({ + bpf_stream_printk(ss, "ERROR: %s for bpf_res_spin_lock%s\n", str, irqsave ? "_irqsave" : ""); + bpf_stream_printk(ss, "Attempted lock = 0x%px\n", lock); + bpf_stream_printk(ss, "Total held locks = %d\n", rqh->cnt); + for (int i = 0; i < min(RES_NR_HELD, rqh->cnt); i++) + bpf_stream_printk(ss, "Held lock[%2d] = 0x%px\n", i, rqh->locks[i]); + bpf_stream_dump_stack(ss);Please don't include %px in stuff going back to userspace in standard error reporting. That's a kernel address leak:
https://docs.kernel.org/process/deprecated.html#p-format-specifierI don't see any justification here, please remove the lock address or use regular %p to get a hashed value.
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines
There is no leak here.
The prog was loaded by root and error is read by root.uid has nothing to do with it. Leaking addresses needs the right capability set. Is that always true here?
yes. For bpf prog to use this kfunc it needs
CAP_BPFandCAP_PERMON. What's allowed under them is described ininclude/uapi/linux/capability.h
Okay, thanks! That wasn't detailed in the commit log (for folks like me with less familiarity with BPF), so I just got worried when I saw "stderr" mentioned. :)
Signature · 1 line
Kees Cook
Kumar Kartikeya Dwivedi
maintainerPATCH v5 9/12 libbpf: Add bpf_stream_printk() macro
In reply to Kumar Kartikeya DwivediAdd a convenience macro to print data to the BPF streams. BPF_STDOUT and BPF_STDERR stream IDs in the vmlinux.h can be passed to the macro to print to the respective streams.
--- tools/lib/bpf/bpf_helpers.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
tools/lib/bpf/bpf_helpers.h +16 -0
@@ -314,6 +314,22 @@ enum libbpf_tristate { ___param, sizeof(___param)); \ }) +extern int bpf_stream_vprintk(int stream_id, const char *fmt__str, const void *args, + __u32 len__sz, void *aux__prog) __weak __ksym; + +#define bpf_stream_printk(stream_id, fmt, args...) \ +({ \ + static const char ___fmt[] = fmt; \ + unsigned long long ___param[___bpf_narg(args)]; \ + \ + _Pragma("GCC diagnostic push") \ + _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \ + ___bpf_fill(___param, args); \ + _Pragma("GCC diagnostic pop") \ + \ + bpf_stream_vprintk(stream_id, ___fmt, ___param, sizeof(___param), NULL);\ +}) +/* Use __bpf_printk when bpf_printk call has 3 or fewer fmt args * Otherwise use __bpf_vprintk */
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 10/12 libbpf: Introduce bpf_prog_stream_read() API
In reply to Kumar Kartikeya DwivediIntroduce a libbpf API so that users can read data from a given BPF stream for a BPF prog fd. For now, only the low-level syscall wrapper is provided, we can add a bpf_program__* accessor as a follow up if needed.
--- tools/lib/bpf/bpf.c | 20 ++++++++++++++++++++ tools/lib/bpf/bpf.h | 21 +++++++++++++++++++++ tools/lib/bpf/libbpf.map | 1 + 3 files changed, 42 insertions(+)
tools/lib/bpf/bpf.c +20 -0
@@ -1375,3 +1375,23 @@ int bpf_token_create(int bpffs_fd, struct bpf_token_create_opts *opts) fd =sys_bpf_fd (BPF_TOKEN_CREATE , &attr, attr_sz);return libbpf_err_errno (fd); } + +int bpf_prog_stream_read (int prog_fd,__u32 stream_id,void *buf,__u32 buf_len, +struct bpf_prog_stream_read_opts *opts) +{ + const size_t attr_sz = offsetofend(union bpf_attr, prog_stream_read); +union bpf_attr attr; +int err; + +if (!OPTS_VALID (opts, bpf_prog_stream_read_opts)) +return libbpf_err (-EINVAL ); + +memset (&attr,0 , attr_sz); + attr.prog_stream_read.stream_buf =ptr_to_u64 (buf); + attr.prog_stream_read.stream_buf_len = buf_len; + attr.prog_stream_read.stream_id = stream_id; + attr.prog_stream_read.prog_fd = prog_fd; + + err =sys_bpf (BPF_PROG_STREAM_READ_BY_FD , &attr, attr_sz); +return libbpf_err_errno (err); +}
tools/lib/bpf/bpf.h +21 -0
@@ -709,6 +709,27 @@ struct bpf_token_create_opts { LIBBPF_API int bpf_token_create(int bpffs_fd,struct bpf_token_create_opts *opts); +struct bpf_prog_stream_read_opts { +size_t sz; + size_t :0; +}; +#define bpf_prog_stream_read_opts__last_field sz +/** +* @brief **bpf_prog_stream_read** reads data from the BPF stream of a given BPF +* program. +* +* @param prog_fd FD for the BPF program whose BPF stream is to be read. +* @param stream_id ID of the BPF stream to be read. +* @param buf Buffer to read data into from the BPF stream. +* @param buf_len Maximum number of bytes to read from the BPF stream. +* @param opts optional options, can be NULL +* +* @return The number of bytes read, on success; negative error code, otherwise +* (errno is also set to the error code) +*/ +LIBBPF_API int bpf_prog_stream_read(int prog_fd, __u32 stream_id, void *buf, __u32 buf_len, +struct bpf_prog_stream_read_opts *opts); + #ifdef __cplusplus }/* extern "C" */ #endif
tools/lib/bpf/libbpf.map +1 -0
@@ -437,6 +437,7 @@ LIBBPF_1.6.0 { bpf_linker__add_fd; bpf_linker__new_fd; bpf_object__prepare; + bpf_prog_stream_read; bpf_program__attach_cgroup_opts; bpf_program__func_info; bpf_program__func_info_cnt;
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 11/12 bpftool: Add support for dumping streams
In reply to Kumar Kartikeya DwivediAdd support for printing the BPF stream contents of a program in bpftool. The new bpftool prog tracelog command is extended to take stdout and stderr arguments, and then the prog specification.
The bpf_prog_stream_read() API added in previous patch is simply reused to grab data and then it is dumped to the respective file. The stdout data is sent to stdout, and stderr is printed to stderr.
--- .../bpftool/Documentation/bpftool-prog.rst | 7 +++ tools/bpf/bpftool/bash-completion/bpftool | 16 +++++- tools/bpf/bpftool/prog.c | 49 ++++++++++++++++++- 3 files changed, 70 insertions(+), 2 deletions(-)
tools/bpf/bpftool/Documentation/bpftool-prog.rst +7 -0
@@ -35,6 +35,7 @@ PROG COMMANDS | **bpftool** **prog attach** *PROG* *ATTACH_TYPE* [*MAP*] | **bpftool** **prog detach** *PROG* *ATTACH_TYPE* [*MAP*] | **bpftool** **prog tracelog** +| **bpftool** **prog tracelog** [ { **stdout** | **stderr** } *PROG* ] | **bpftool** **prog run** *PROG* **data_in** *FILE* [**data_out** *FILE* [**data_size_out** *L*]] [**ctx_in** *FILE* [**ctx_out** *FILE* [**ctx_size_out** *M*]]] [**repeat** *N*] | **bpftool** **prog profile** *PROG* [**duration** *DURATION*] *METRICs* | **bpftool** **prog help**
@@ -179,6 +180,12 @@ bpftool prog tracelog purposes. For streaming data from BPF programs to user space, one can use perf events (see also **bpftool-map**\ (8)). +bpftool prog tracelog { stdout | stderr } *PROG* + Dump the BPF stream of the program. BPF programs can write to these streams + at runtime with the **bpf_stream_vprintk**\ () kfunc. The kernel may write + error messages to the standard error stream. This facility should be used + only for debugging purposes. + bpftool prog run *PROG* data_in *FILE* [data_out *FILE* [data_size_out *L*]] [ctx_in *FILE* [ctx_out *FILE* [ctx_size_out *M*]]] [repeat *N*] Run BPF program *PROG* in the kernel testing infrastructure for BPF, meaning that the program works on the data and context provided by the
tools/bpf/bpftool/bash-completion/bpftool +15 -1
@@ -518,7 +518,21 @@ _bpftool() esac ;; tracelog) - return 0 + case $prev in + $command) + COMPREPLY+=( $( compgen -W "stdout stderr" -- \ + "$cur" ) ) + return 0 + ;; + stdout|stderr) + COMPREPLY=( $( compgen -W "$PROG_TYPE" -- \ + "$cur" ) ) + return 0 + ;; + *) + return 0 + ;; + esac ;; profile) case $cword in
tools/bpf/bpftool/prog.c +48 -1
67 lines not on this page · raw message
Signature · 1 line
2.47.1
Kumar Kartikeya Dwivedi
maintainerPATCH v5 12/12 selftests/bpf: Add tests for prog streams
In reply to Kumar Kartikeya DwivediAdd selftests to stress test the various facets of the stream API, memory allocation pattern, and ensuring dumping support is tested and functional.
--- .../testing/selftests/bpf/prog_tests/stream.c | 141 ++++++++++++++++++ tools/testing/selftests/bpf/progs/stream.c | 79 ++++++++++ .../testing/selftests/bpf/progs/stream_fail.c | 33 ++++ 3 files changed, 253 insertions(+) create mode 100644 tools/testing/selftests/bpf/prog_tests/stream.c create mode 100644 tools/testing/selftests/bpf/progs/stream.c create mode 100644 tools/testing/selftests/bpf/progs/stream_fail.c
tools/testing/selftests/bpf/prog_tests/stream.c new file +141 -0
@@ -0,0 +1,141 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (c) 2025 Meta Platforms, Inc. and affiliates. */ +#include <test_progs.h> +#include <sys/mman.h> +#include <regex.h> + +#include "stream.skel.h" +#include "stream_fail.skel.h" + +void test_stream_failure (void ) +{ +RUN_TESTS (stream_fail); +} + +void test_stream_success (void ) +{ +RUN_TESTS (stream); +return ; +} + +struct { +int prog_off; +const char *errstr; +} stream_error_arr[] = { + { + offsetof(struct stream, progs.stream_cond_break), +"ERROR: Timeout detected for may_goto instruction\n" +"CPU: [0-9]+ UID: 0 PID: [0-9]+ Comm: .*\n" +"Call trace:\n" +"([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*" , + }, + { + offsetof(struct stream, progs.stream_deadlock), +"ERROR: AA or ABBA deadlock detected for bpf_res_spin_lock\n" +"Attempted lock = (0x[0-9a-fA-F]+)\n" +"Total held locks = 1\n" +"Held lock\\[ 0\\] = \\1\n" // Lock address must match +"CPU: [0-9]+ UID: 0 PID: [0-9]+ Comm: .*\n" +"Call trace:\n" +"([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*" , + }, +}; + +static int match_regex (const char *pattern,const char *string) +{ +int err, rc; +regex_t re; + + err =regcomp (&re, pattern,REG_EXTENDED |REG_NEWLINE ); +if (err) +return -1 ; + rc =regexec (&re, string,0 ,NULL ,0 ); +regfree (&re); +return rc ==0 ?1 :0 ; +} + +void test_stream_errors (void ) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +LIBBPF_OPTS (bpf_prog_stream_read_opts, ropts); +struct stream *skel; +int ret, prog_fd; +char buf[1024 ]; + + skel =stream__open_and_load (); +if (!ASSERT_OK_PTR (skel,"stream__open_and_load" )) +return ; + +for (int i =0 ; i <ARRAY_SIZE (stream_error_arr); i++) { +struct bpf_program **prog; + + prog = (struct bpf_program **)(((char *)skel) + stream_error_arr[i].prog_off); + prog_fd =bpf_program__fd (*prog); + ret =bpf_prog_test_run_opts (prog_fd, &opts); +ASSERT_OK (ret,"ret" ); +ASSERT_OK (opts.retval,"retval" ); + +#if !defined(__x86_64__) +ASSERT_TRUE (1 ,"Timed may_goto unsupported, skip." ); +if (i ==0 ) { + ret =bpf_prog_stream_read (prog_fd,2 , buf,sizeof (buf), &ropts); +ASSERT_EQ (ret,0 ,"stream read" ); +continue ; + } +#endif + + ret =bpf_prog_stream_read (prog_fd,BPF_STREAM_STDERR , buf,sizeof (buf), &ropts); +ASSERT_GT (ret,0 ,"stream read" ); +ASSERT_LE (ret,1023 ,"len for buf" ); + buf[ret] ='\0' ; + + ret =match_regex (stream_error_arr[i].errstr, buf); +if (!ASSERT_TRUE (ret ==1 ,"regex match" )) +fprintf (stderr,"Output from stream:\n%s\n" , buf); + } + +stream__destroy (skel); +} + +void test_stream_syscall (void ) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +LIBBPF_OPTS (bpf_prog_stream_read_opts, ropts); +struct stream *skel; +int ret, prog_fd; +char buf[64 ]; + + skel =stream__open_and_load (); +if (!ASSERT_OK_PTR (skel,"stream__open_and_load" )) +return ; + + prog_fd =bpf_program__fd (skel->progs.stream_syscall); + ret =bpf_prog_test_run_opts (prog_fd, &opts); +ASSERT_OK (ret,"ret" ); +ASSERT_OK (opts.retval,"retval" ); + +ASSERT_LT (bpf_prog_stream_read (0 ,BPF_STREAM_STDOUT , buf,sizeof (buf), &ropts),0 ,"error" ); + ret = -errno; +ASSERT_EQ (ret, -EINVAL ,"bad prog_fd" ); + +ASSERT_LT (bpf_prog_stream_read (prog_fd,0 , buf,sizeof (buf), &ropts),0 ,"error" ); + ret = -errno; +ASSERT_EQ (ret, -ENOENT ,"bad stream id" ); + +ASSERT_LT (bpf_prog_stream_read (prog_fd,BPF_STREAM_STDOUT ,NULL ,sizeof (buf),NULL ),0 ,"error" ); + ret = -errno; +ASSERT_EQ (ret, -EFAULT ,"bad stream buf" ); + + ret =bpf_prog_stream_read (prog_fd,BPF_STREAM_STDOUT , buf,2 ,NULL ); +ASSERT_EQ (ret,2 ,"bytes" ); + ret =bpf_prog_stream_read (prog_fd,BPF_STREAM_STDOUT , buf,2 ,NULL ); +ASSERT_EQ (ret,1 ,"bytes" ); + ret =bpf_prog_stream_read (prog_fd,BPF_STREAM_STDOUT , buf,1 , &ropts); +ASSERT_EQ (ret,0 ,"no bytes stdout" ); + ret =bpf_prog_stream_read (prog_fd,BPF_STREAM_STDERR , buf,1 , &ropts); +ASSERT_EQ (ret,0 ,"no bytes stderr" ); + +stream__destroy (skel); +}
tools/testing/selftests/bpf/progs/stream.c new file +79 -0
79 lines not on this page · raw message
tools/testing/selftests/bpf/progs/stream_fail.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (c) 2025 Meta Platforms, Inc. and affiliates. */ +#include <vmlinux.h> +#include <bpf/bpf_tracing.h> +#include <bpf/bpf_helpers.h> +#include <bpf/bpf_core_read.h> +#include "bpf_misc.h" + +SEC("syscall") +__failure __msg("Possibly NULL pointer passed") +int stream_vprintk_null_arg(void *ctx) +{ +bpf_stream_vprintk (BPF_STDOUT ,"" ,NULL ,0 ,NULL ); +return 0 ; +} + +SEC("syscall") +__failure __msg("R3 type=scalar expected=") +int stream_vprintk_scalar_arg(void *ctx) +{ +bpf_stream_vprintk (BPF_STDOUT ,"" , (void *)46 ,0 ,NULL ); +return 0 ; +} + +SEC("syscall") +__failure __msg("arg#1 doesn't point to a const string") +int stream_vprintk_string_arg(void *ctx) +{ +bpf_stream_vprintk (BPF_STDOUT , ctx,NULL ,0 ,NULL ); +return 0 ; +} + +char _license[] SEC("license") = "GPL";
Signature · 1 line
2.47.1
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 8 lines · On Thu, 3 Jul 2025 13:48:06 -0700 you wrote:
This set introduces a standard output interface with two streams, namely stdout and stderr, for BPF programs. The idea is that these streams will be written to by BPF programs and the kernel, and serve as standard interfaces for informing user space of any BPF runtime violations. Users can also utilize them for printing normal messages for debugging usage, as is the case with
bpf_printk()and trace pipe interface.[...]
Here is the summary with links:
- [bpf-next,v5,01/12] bpf: Refactor bprintf buffer support
https://git.kernel.org/bpf/bpf-next/c/0426729f46cd - [bpf-next,v5,02/12] bpf: Introduce BPF standard streams https://git.kernel.org/bpf/bpf-next/c/5ab154f1463a - [bpf-next,v5,03/12] bpf: Add function to extract program source info https://git.kernel.org/bpf/bpf-next/c/0e521efaf363 - [bpf-next,v5,04/12] bpf: Ensure RCU lock is held around bpf_prog_ksym_find https://git.kernel.org/bpf/bpf-next/c/d09032686009 - [bpf-next,v5,05/12] bpf: Add function to find program from stack trace https://git.kernel.org/bpf/bpf-next/c/f0c53fd4a742 - [bpf-next,v5,06/12] bpf: Add dump_stack() analogue to print to BPF stderr https://git.kernel.org/bpf/bpf-next/c/d7c431cafcb4 - [bpf-next,v5,07/12] bpf: Report may_goto timeout to BPF stderr https://git.kernel.org/bpf/bpf-next/c/e8d013302252 - [bpf-next,v5,08/12] bpf: Report rqspinlock deadlocks/timeout to BPF stderr https://git.kernel.org/bpf/bpf-next/c/ecec5b5743bf - [bpf-next,v5,09/12] libbpf: Add bpf_stream_printk() macro https://git.kernel.org/bpf/bpf-next/c/21a3afc76a31 - [bpf-next,v5,10/12] libbpf: Introduce bpf_prog_stream_read() API https://git.kernel.org/bpf/bpf-next/c/3bbc1ba9cc0d - [bpf-next,v5,11/12] bpftool: Add support for dumping streams https://git.kernel.org/bpf/bpf-next/c/876f5ebd58a9 - [bpf-next,v5,12/12] selftests/bpf: Add tests for prog streams https://git.kernel.org/bpf/bpf-next/c/5697683e133d
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html