Introduce arena library and runtime
Subsystems (3)
Emil Tsalapatis
reviewerv8 cover Introduce arena library and runtime
Add a new subdirectory to tools/testing/selftests/bpf called libarena, along with programs useful for writing arena-based BPF code. This patchset adds the following:
1) libarena, a subdirectory where arena BPF code that is generally useful to BPF arena programs can be easily added and tested.
2) An ASAN runtime for BPF arena programs. BPF arenas allow for accessing memory after it has been freed or if it is out of bounds, making it more difficult to triage bugs combined to regular BPF. Use LLVM's recently added support for address-space based sanitization to selectively sanitize just the arena accesses.
3) A buddy memory allocator that can be reused by BPF programs to handle memory allocation/deletion. The allocator uses the ASAN runtime to add address sanitization if requested.
The patch includes testing for the new allocators and ASAN features that can be built from the top directory using "make libarena_test" and "make libarena_test_asan". The generated binaries reside in libarena/. The patch also adds test-progs-based selftests to the codebase for the libarena code, so the new tests are run by ./test_progs.
The patchset has the following stucture:
1-3: Create basic libarena scaffolding and refactor existing headers.
4-5: Add the ASAN runtime and associated scaffolding.
6-8: Add the new buddy memory allocator along with self-contained and prog-tests-based selftests.
HISTORY
=======
v7->v8 (https://lore.kernel.org/bpf/[email protected])
- Duplicate READ_ONCE/WRITE_ONCE instead of moving it to bpf_experimental.h to keep libarena self-contained (Kumar)
- Add libarena_asan test to test_progs and conditionally compile it if suppported (Kumar)
- Add stderr parsing for buddy tests when run under test_progs (Kumar)
- Move all arena-related headers into libarena and add its include/ subdirectory in the standard include path (Kumar)
- Remove silent-by-default ASAN, add help message on test_libarena explaining that -v emits the messages (Kumar)
- Add run_prog_args as a libarena helper
- Add explanation on the use of __weak for the spinlock qnodes
v6->v7 (https://lore.kernel.org/bpf/[email protected])
- Modify patch 1 to allow operations between PTR_TO_ARENA src_reg and dst_reg of any type. Adjust selftests accordingly (Alexei)
- Remove unnecessary include in patch 5 (Song)
- Removed unused definitions/assignments in patches 8/9, update patch descriptions
v5->v6 (https://lore.kernel.org/bpf/[email protected])
- Fix subreg_def management for SCALAR += PTR_TO_ARENA operations (AI)
- Add more selftests for the SCALAR += PTR_TO_ARENA patch (Sashiko)
- Adjust fls() operation to be in line with the kernel version (Sashiko)
- Address Sashiko selftests and debugging nits
- Add ASAN loadN and storeN _noabort variants and associated BTF anchor
- Remove unnecessary bit freeing of buddies during block splitting
v4->v5 (https://lore.kernel.org/bpf/[email protected])
Omitting various nits and fixups.
- Properly adjust subreg_def for scalar += ptr_to_arena calls (Sashiko)
- Remove extraneous definition from prog_tests/arena_spin_lock.c (Song)
- Trim extraneous comments from ASAN and buddy (Alexei)
- Remove asan_dummy call and replace with function pointer array (Alexei)
- Remove usersapi.h header and merge it into common.h (Alexei)
- Replace ASAN macros with function calls (Alexei)
- Embed buddy lock into the struct and move the buddy allocator to __arena_global (Alexei)
- Add commenting for buddy allocator constants (Alexei)
- Add default buddy allocator directly in common.bpf.c, so that the user does not need to define it.
- Expand test harnesses to dynamically find individual selftests. Now the selftests also reports each test individually (e.g., 5 entries for the buddy allocator instead of 1). This brings them to par with the rest of the test_progs.
v3->v4 (https://lore.kernel.org/bpf/[email protected])
- Add Acks by Song to patches 1-4.
- Expand the verifier's handling of scalar/arena operations to include all 3-operand operations in Patch 1 (Alexei)
- Add additional tests for arena/arena (allowed) and arena/pointer (not allowed) operations in Patch 2
- Remove ASAN version of the library from default compilation since it requires LLVM 22 and up (CI)
- Rework buddy allocator locking for clarity and add comments
- Fix From: email to be consistent with SOB
- Address (most) Sashiko comments
v2->v3 (https://lore.kernel.org/bpf/[email protected])
Nonexhaustive due to significant patch rework.
- Do not duplicate WRITE_ONCE macro (Mykyta, Kumar)
- Add SPDX headers (Alexei)
- Remove bump/stack allocators (Alexei)
- Integrate testing with test_progs (Kumar)
- Add short description of ASAN algorithm at the top of the file (Alexei)
v1->v2 (https://lore.kernel.org/bpf/[email protected]/)
- Added missing format string argument (AI)
- Fix outdated selftests prog name check (AI)
- Fixed stack allocation check for segment creation (AI)
- Fix errors in non-ASAN bump allocator selftests (AI)
- Propagate error value from individual selftests in selftest.c
- Removed embedded metadata from bump allocator as it was needlessly complicating its behavior
Emil Tsalapatis (8):
selftests/bpf: Add ifdef guard for WRITE_ONCE macro in bpf_atomic.h selftests/bpf: Add basic libarena scaffolding selftests/bpf: Move arena-related headers into libarena selftests/bpf: Add arena ASAN runtime to libarena selftests/bpf: Add ASAN support for libarena selftests selftests/bpf: Add buddy allocator for libarena selftests/bpf: Add selftests for libarena buddy allocator selftests/bpf: Reuse stderr parsing for libarena ASAN tests
tools/testing/selftests/bpf/.gitignore | 2 +
tools/testing/selftests/bpf/Makefile | 52 +-
tools/testing/selftests/bpf/bpf_arena_alloc.h | 2 +-
tools/testing/selftests/bpf/bpf_arena_list.h | 2 +-
.../selftests/bpf/bpf_arena_strsearch.h | 2 +-
.../testing/selftests/bpf/bpf_experimental.h | 84 +-
tools/testing/selftests/bpf/libarena/Makefile | 104 ++
.../selftests/bpf/libarena/include/asan.h | 103 ++
.../{ => libarena/include}/bpf_arena_common.h | 0
.../include}/bpf_arena_spin_lock.h | 11 +-
.../bpf/{ => libarena/include}/bpf_atomic.h | 4 +-
.../bpf/libarena/include/bpf_may_goto.h | 84 ++
.../selftests/bpf/libarena/include/buddy.h | 92 ++
.../selftests/bpf/libarena/include/common.h | 81 ++
.../bpf/libarena/include/selftest_helpers.h | 139 +++
.../bpf/libarena/include/test_progs_compat.h | 15 +
.../bpf/libarena/selftests/selftest.c | 196 ++++
.../libarena/selftests/st_asan_buddy.bpf.c | 259 +++++
.../bpf/libarena/selftests/st_asan_common.h | 47 +
.../bpf/libarena/selftests/st_buddy.bpf.c | 208 ++++
.../selftests/bpf/libarena/src/asan.bpf.c | 553 +++++++++++
.../selftests/bpf/libarena/src/buddy.bpf.c | 903 ++++++++++++++++++
.../selftests/bpf/libarena/src/common.bpf.c | 87 ++
.../bpf/prog_tests/arena_spin_lock.c | 7 -
.../selftests/bpf/prog_tests/libarena.c | 62 ++
.../selftests/bpf/prog_tests/libarena_asan.c | 89 ++
.../selftests/bpf/progs/arena_atomics.c | 2 +-
.../selftests/bpf/progs/arena_spin_lock.c | 2 +-
.../bpf/progs/compute_live_registers.c | 2 +-
.../selftests/bpf/progs/lpm_trie_bench.c | 2 +-
tools/testing/selftests/bpf/progs/stream.c | 2 +-
.../selftests/bpf/progs/verifier_arena.c | 2 +-
.../bpf/progs/verifier_arena_globals1.c | 2 +-
.../bpf/progs/verifier_arena_globals2.c | 2 +-
.../bpf/progs/verifier_arena_large.c | 2 +-
.../selftests/bpf/progs/verifier_ldsx.c | 2 +-
tools/testing/selftests/bpf/test_loader.c | 51 +-
tools/testing/selftests/bpf/test_progs.h | 2 +
38 files changed, 3140 insertions(+), 121 deletions(-)
create mode 100644 tools/testing/selftests/bpf/libarena/Makefile
create mode 100644 tools/testing/selftests/bpf/libarena/include/asan.h
rename tools/testing/selftests/bpf/{ => libarena/include}/bpf_arena_common.h (100%)
rename tools/testing/selftests/bpf/{progs => libarena/include}/bpf_arena_spin_lock.h (98%)
rename tools/testing/selftests/bpf/{ => libarena/include}/bpf_atomic.h (98%)
create mode 100644 tools/testing/selftests/bpf/libarena/include/bpf_may_goto.h
create mode 100644 tools/testing/selftests/bpf/libarena/include/buddy.h
create mode 100644 tools/testing/selftests/bpf/libarena/include/common.h
create mode 100644 tools/testing/selftests/bpf/libarena/include/selftest_helpers.h
create mode 100644 tools/testing/selftests/bpf/libarena/include/test_progs_compat.h
create mode 100644 tools/testing/selftests/bpf/libarena/selftests/selftest.c
create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_asan_buddy.bpf.c
create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h
create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c
create mode 100644 tools/testing/selftests/bpf/libarena/src/asan.bpf.c
create mode 100644 tools/testing/selftests/bpf/libarena/src/buddy.bpf.c
create mode 100644 tools/testing/selftests/bpf/libarena/src/common.bpf.c
create mode 100644 tools/testing/selftests/bpf/prog_tests/libarena.c
create mode 100644 tools/testing/selftests/bpf/prog_tests/libarena_asan.cSignature · 1 line
2.53.0
Emil Tsalapatis
reviewerPATCH v8 1/8 selftests/bpf: Add ifdef guard for WRITE_ONCE macro in bpf_atomic.h
The WRITE_ONCE macro is identically defined both in bpf_atomic.h and in bpf_arena_common.h. However, the bpf_atomic.h definition has no ifdef guard. If bpf_atomic.h is included after bpf_arena.common.h, compilation fails because of the duplicate definition.
Guard the definiton in bpf_atomic.h with and ifdef to let programs include the two headers in any order. Duplicating the definition is the simplest solution out of all the alternatives:
- Keeping one of the two existing definitions is not possible because both BPF atomics and arena programs need the macro, and the two features are independent. Using one should not require the header for the other.
- Factoring out the definition into a new header that only includes it is more churn than just duplicating it.
- Factoring out the definition into bpf_experimental.h requires all users of WRITE_ONCE to include the header. However, the arena library introduced in subsequent commits must be self-contained, while bpf_experimental.h is in the base selftests/bpf directory.
Both headers are moved to the arena library in a subsequent patch.
--- tools/testing/selftests/bpf/bpf_atomic.h | 2 ++ 1 file changed, 2 insertions(+)
tools/testing/selftests/bpf/bpf_atomic.h +2 -0
@@ -42,7 +42,9 @@ extern bool CONFIG_X86_64 __kconfig __weak;#define READ_ONCE (x) (*(volatile typeof(x) *)&(x)) +#ifndef WRITE_ONCE #define WRITE_ONCE (x, val) ((*(volatile typeof(x) *)&(x)) = (val)) +#endif #define cmpxchg (p, old, new) __sync_val_compare_and_swap((p), old, new)
Signature · 1 line
2.53.0
Re: [PATCH bpf-next v8 1/8] selftests/bpf: Add ifdef guard for WRITE_ONCE macro in bpf_atomic.h
Quoted 16 lines · Emil Tsalapatis
The
WRITE_ONCEmacro is identically defined both inbpf_atomic.hand inbpf_arena_common.h. However, thebpf_atomic.hdefinition has no ifdef guard. Ifbpf_atomic.his included afterbpf_arena.common.h, compilation fails because of the duplicate definition.Guard the definiton in
bpf_atomic.hwith and ifdef to let programs include the two headers in any order. Duplicating the definition is the simplest solution out of all the alternatives:- Keeping one of the two existing definitions is not possible because both BPF atomics and arena programs need the macro, and the two features are independent. Using one should not require the header for the other.
- Factoring out the definition into a new header that only includes it is more churn than just duplicating it.
Quoted 8 lines
- Factoring out the definition into
bpf_experimental.hrequires all users ofWRITE_ONCEto include the header. However, the arena library introduced in subsequent commits must be self-contained, whilebpf_experimental.his in the base selftests/bpf directory.Both headers are moved to the arena library in a subsequent patch.
Signed-off-by Emil Tsalapatis <[email protected]>
Fair enough:
Emil Tsalapatis
reviewerPATCH v8 2/8 selftests/bpf: Add basic libarena scaffolding
In reply to Emil TsalapatisAdd initial code for an arena-based BPF library. The current commit introduces a test runner and Makefile for the library. Library code can be added just by including the source file in the library's src/ subdirectory. Future commits will introduce the library code itself.
The current commit also includes a standalone test runner. This is to keep libarena self-contained and testable even when copied out of the kernel tree. Subsequent commits add integration with test_progs.
The code includes workarounds that are removed in subsequent patches, like the qnode definitions for selftest.c. This is to ensure bisectability.
--- tools/testing/selftests/bpf/.gitignore | 1 + tools/testing/selftests/bpf/Makefile | 27 +++ tools/testing/selftests/bpf/libarena/Makefile | 75 ++++++++ .../selftests/bpf/libarena/include/common.h | 66 ++++++++ .../bpf/libarena/include/selftest_helpers.h | 99 +++++++++++ .../bpf/libarena/selftests/selftest.c | 160 ++++++++++++++++++ .../selftests/bpf/libarena/src/common.bpf.c | 62 +++++++ 7 files changed, 490 insertions(+) create mode 100644 tools/testing/selftests/bpf/libarena/Makefile create mode 100644 tools/testing/selftests/bpf/libarena/include/common.h create mode 100644 tools/testing/selftests/bpf/libarena/include/selftest_helpers.h create mode 100644 tools/testing/selftests/bpf/libarena/selftests/selftest.c create mode 100644 tools/testing/selftests/bpf/libarena/src/common.bpf.c
tools/testing/selftests/bpf/.gitignore +1 -0
@@ -49,3 +49,4 @@ verification_cert.h *.BTF.base usdt_1 usdt_2 +libarena/test_libarena
tools/testing/selftests/bpf/Makefile +27 -0
@@ -153,6 +153,7 @@ override define CLEAN $(Q)$(RM) -r $(TEST_KMODS) $(Q)$(RM) -r $(EXTRA_CLEAN) $(Q)$(MAKE) -C test_kmods clean + $(Q)$(MAKE) -C libarena clean $(Q)$(MAKE) docs-clean endef
@@ -524,6 +525,7 @@ LINKED_BPF_OBJS := $(foreach skel,$(LINKED_SKELS),$($(skel)-deps)) LINKED_BPF_SRCS := $(patsubst %.bpf.o,%.c,$(LINKED_BPF_OBJS)) HEADERS_FOR_BPF_OBJS := $(wildcard $(BPFDIR)/*.bpf.h) \ + $(wildcard $(CURDIR)/libarena/include/*.[ch]) \ $(addprefix $(BPFDIR)/, bpf_core_read.h \ bpf_endian.h \ bpf_helpers.h \
@@ -739,6 +741,28 @@ $(VERIFY_SIG_HDR): $(VERIFICATION_CERT) echo "};"; \ echo "unsigned int test_progs_verification_cert_len = $$(wc -c < $<);") > $@ +LIBARENA_MAKE_ARGS = \ + BPFTOOL="$(BPFTOOL)" \ + INCLUDE_DIR="$(INCLUDE_DIR)" \ + LIBBPF_INCLUDE="$(HOST_INCLUDE_DIR)" \ + BPFOBJ="$(BPFOBJ)" \ + LDLIBS="$(LDLIBS) -lzstd" \ + CLANG="$(CLANG)" \ + BPF_CFLAGS="$(BPF_CFLAGS) $(CLANG_CFLAGS)" \ + BPF_TARGET_ENDIAN="$(BPF_TARGET_ENDIAN)" \ + Q="$(Q)" + +LIBARENA_BPF_DEPS := $(wildcard libarena/Makefile \ + libarena/include/* \ + libarena/src/* \ + libarena/selftests/* \ + libarena/*.bpf.o) + +LIBARENA_SKEL := libarena/libarena.skel.h + +$(LIBARENA_SKEL): $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) $(LIBARENA_BPF_DEPS) + +$(MAKE) -C libarena libarena.skel.h $(LIBARENA_MAKE_ARGS) + # Define test_progs test runner. TRUNNER_TESTS_DIR := prog_tests TRUNNER_BPF_PROGS_DIR := progs
@@ -931,3 +955,6 @@ override define INSTALL_RULE rsync -a $(OUTPUT)/$$DIR/*.bpf.o $(INSTALL_PATH)/$$DIR;\ done endef + +test_libarena: $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) + +$(MAKE) -C libarena $@ $(LIBARENA_MAKE_ARGS)
tools/testing/selftests/bpf/libarena/Makefile new file +75 -0
75 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/include/common.h new file +66 -0
66 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/include/selftest_helpers.h new file +99 -0
99 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/selftests/selftest.c new file +160 -0
160 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +62 -0
62 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 2/8] selftests/bpf: Add basic libarena scaffolding
Sashiko AI review found 1 potential issue(s): - [Low] Cross-compilation breakage for `test_libarena` due to missing target flags when using `$(CLANG)`. --
Sashiko AI review found 1 potential issue(s):
- [Low] Cross-compilation breakage for test_libarena due to missing target flags when using $(CLANG). --
commit 8ad4036d8952c8f966e33882412f2b6f18aee582
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Add basic libarena scaffolding
This commit introduces an arena-based BPF library scaffolding, including a test runner and Makefile. It sets up the standalone build for libarena and adds temporary workarounds for bisectability.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/Makefile new file +0
-0
[ ... ]
tools/testing/selftests/bpf/libarena/Makefile line 60
Quoted 5 lines
tools/testing/selftests/bpf/libarena/Makefile new file +5
-0+all: test_libarena + +test_libarena: selftest.c $(BPFOBJ) libarena.skel.h + $(call msg,BINARY,libarena,$@) + $(Q)$(CLANG) $(CFLAGS) $< $(BPFOBJ) $(LDLIBS) -o $@
Will this cause a cross-compilation breakage?
When cross-compiling, $(BPFOBJ) (libbpf.a) is built for the target architecture using $(CC). Because $(CLANG) is used here without target-specific flags (like --target=), selftest.c will be compiled into a host-architecture object.
Attempting to link this host object with the target-architecture libbpf.a will result in a linker error. Should user-space programs in selftests be compiled using $(CC) to correctly target the cross-compilation environment?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Re: [PATCH bpf-next v8 2/8] selftests/bpf: Add basic libarena scaffolding
In reply to Emil TsalapatisQuoted 211 lines · Emil Tsalapatis
Add initial code for an arena-based BPF library. The current commit introduces a test runner and
Makefilefor the library. Library code can be added just by including the source file in the library's src/ subdirectory. Future commits will introduce the library code itself.The current commit also includes a standalone test runner. This is to keep libarena self-contained and testable even when copied out of the kernel tree. Subsequent commits add integration with
test_progs.The code includes workarounds that are removed in subsequent patches, like the qnode definitions for
selftest.c. This is to ensure bisectability.Signed-off-by Emil Tsalapatis <[email protected]>--- tools/testing/selftests/bpf/.gitignore | 1 + tools/testing/selftests/bpf/Makefile | 27 +++ tools/testing/selftests/bpf/libarena/Makefile | 75 ++++++++ .../selftests/bpf/libarena/include/common.h | 66 ++++++++ .../bpf/libarena/include/selftest_helpers.h | 99 +++++++++++ .../bpf/libarena/selftests/selftest.c | 160 ++++++++++++++++++ .../selftests/bpf/libarena/src/common.bpf.c | 62 +++++++ 7 files changed, 490 insertions(+) create mode 100644 tools/testing/selftests/bpf/libarena/Makefile create mode 100644 tools/testing/selftests/bpf/libarena/include/common.h create mode 100644 tools/testing/selftests/bpf/libarena/include/selftest_helpers.h create mode 100644 tools/testing/selftests/bpf/libarena/selftests/selftest.c create mode 100644 tools/testing/selftests/bpf/libarena/src/common.bpf.ctools/testing/selftests/bpf/.gitignore +1
-0@@ -49,3 +49,4 @@ verification_cert.h *.BTF.base usdt_1 usdt_2 +libarena/test_libarenatools/testing/selftests/bpf/Makefile +27
-0@@ -153,6 +153,7 @@ override define CLEAN $(Q)$(RM) -r $(TEST_KMODS) $(Q)$(RM) -r $(EXTRA_CLEAN) $(Q)$(MAKE) -C test_kmods clean + $(Q)$(MAKE) -C libarena clean $(Q)$(MAKE) docs-clean endef@@ -524,6 +525,7 @@ LINKED_BPF_OBJS := $(foreach skel,$(LINKED_SKELS),$($(skel)-deps)) LINKED_BPF_SRCS := $(patsubst %.bpf.o,%.c,$(LINKED_BPF_OBJS)) HEADERS_FOR_BPF_OBJS := $(wildcard $(BPFDIR)/*.bpf.h) \ + $(wildcard $(CURDIR)/libarena/include/*.[ch]) \ $(addprefix $(BPFDIR)/, bpf_core_read.h \ bpf_endian.h \ bpf_helpers.h \@@ -739,6 +741,28 @@ $(VERIFY_SIG_HDR): $(VERIFICATION_CERT) echo "};"; \ echo "unsigned int test_progs_verification_cert_len = $$(wc -c < $<);") > $@ +LIBARENA_MAKE_ARGS = \ + BPFTOOL="$(BPFTOOL)" \ + INCLUDE_DIR="$(INCLUDE_DIR)" \ + LIBBPF_INCLUDE="$(HOST_INCLUDE_DIR)" \ + BPFOBJ="$(BPFOBJ)" \ + LDLIBS="$(LDLIBS) -lzstd" \ + CLANG="$(CLANG)" \ + BPF_CFLAGS="$(BPF_CFLAGS) $(CLANG_CFLAGS)" \ + BPF_TARGET_ENDIAN="$(BPF_TARGET_ENDIAN)" \ + Q="$(Q)" + +LIBARENA_BPF_DEPS := $(wildcard libarena/Makefile \ + libarena/include/* \ + libarena/src/* \ + libarena/selftests/* \ + libarena/*.bpf.o) + +LIBARENA_SKEL := libarena/libarena.skel.h + +$(LIBARENA_SKEL): $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) $(LIBARENA_BPF_DEPS) + +$(MAKE) -C libarena libarena.skel.h $(LIBARENA_MAKE_ARGS) + # Define test_progs test runner. TRUNNER_TESTS_DIR := prog_tests TRUNNER_BPF_PROGS_DIR := progs@@ -931,3 +955,6 @@ override define INSTALL_RULE rsync -a $(OUTPUT)/$$DIR/*.bpf.o $(INSTALL_PATH)/$$DIR;\ done endef + +test_libarena: $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) + +$(MAKE) -C libarena $@ $(LIBARENA_MAKE_ARGS)tools/testing/selftests/bpf/libarena/Makefile new file +75
-0@@ -0,0 +1,75 @@ +# SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +# Copyright (c) 2026 Meta Platforms, Inc. and affiliates. + +.PHONY: clean + +# Defaults for standalone builds + +CLANG ?= clang +BPFTOOL ?= bpftool +LDLIBS ?= -lbpf -lelf -lz -lrt -lpthread -lzstd + +ifeq ($(V),1) +Q = +msg = +else +Q ?= @ +msg = @printf ' %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))"; +endif + +IS_LITTLE_ENDIAN = $(shell $(CC) -dM -E - </dev/null | \ + grep 'define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__') +BPF_TARGET_ENDIAN ?= $(if $(IS_LITTLE_ENDIAN),--target=bpfel,--target=bpfeb) + +LIBARENA=$(abspath .) +BPFDIR=$(abspath $(LIBARENA)/..) + +INCLUDE_DIR ?= $(BPFDIR)/tools/include +LIBBPF_INCLUDE ?= $(INCLUDE_DIR) + +# Scan src/ and selftests/ to generate the final binaries +LIBARENA_SOURCES = $(wildcard $(LIBARENA)/src/*.bpf.c) $(wildcard $(LIBARENA)/selftests/*.bpf.c) +LIBARENA_OBJECTS = $(notdir $(LIBARENA_SOURCES:.bpf.c=.bpf.o)) + +INCLUDES = -I$(LIBARENA)/include -I$(BPFDIR) +ifneq ($(INCLUDE_DIR),) +INCLUDES += -I$(INCLUDE_DIR) +endif +ifneq ($(LIBBPF_INCLUDE),) +INCLUDES += -I$(LIBBPF_INCLUDE) +endif + +# ENABLE_ATOMICS_TESTS required because we use arena spinlocks +override BPF_CFLAGS += -DENABLE_ATOMICS_TESTS +override BPF_CFLAGS += -O2 -g +override BPF_CFLAGS += -Wno-incompatible-pointer-types-discards-qualifiers +# Required for suppressing harmless vmlinux.h-related warnings. +override BPF_CFLAGS += -Wno-missing-declarations +override BPF_CFLAGS += $(INCLUDES) + +CFLAGS = -O2 -no-pie +CFLAGS += $(INCLUDES) + +vpath %.bpf.c $(LIBARENA)/src $(LIBARENA)/selftests +vpath %.c $(LIBARENA)/src $(LIBARENA)/selftests + +all: test_libarena + +test_libarena: selftest.c $(BPFOBJ) libarena.skel.h + $(call msg,BINARY,libarena,$@) + $(Q)$(CLANG) $(CFLAGS) $< $(BPFOBJ) $(LDLIBS) -o $@ + +libarena.skel.h: libarena.bpf.o + $(call msg,GEN-SKEL,libarena,$@) + $(Q)$(BPFTOOL) gen skeleton $< name "libarena" > $@ + +libarena.bpf.o: $(LIBARENA_OBJECTS) + $(call msg,GEN-OBJ,libarena,$@) + $(Q)$(BPFTOOL) gen object $@ $^ + +%.bpf.o: %.bpf.c + $(call msg,CLNG-BPF,libarena,$@) + $(Q)$(CLANG) $(BPF_CFLAGS) $(BPF_TARGET_ENDIAN) -c $< -o $@ + +clean: + $(Q)rm -f *.skel.h *.bpf.o test_libarenatools/testing/selftests/bpf/libarena/include/common.h new file +30
-0@@ -0,0 +1,66 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#pragma once + +#ifdef __BPF__ + +#include <vmlinux.h> + +#include "../../bpf_arena_common.h" +#include "../../progs/bpf_arena_spin_lock.h" + +#include <asm-generic/errno.h> + +#ifndef __BPF_FEATURE_ADDR_SPACE_CAST +#error "Arena allocators require bpf_addr_space_cast feature" +#endif + +#define arena_stdout(fmt, ...) bpf_stream_printk(1, (fmt), ##__VA_ARGS__) +#define arena_stderr(fmt, ...) bpf_stream_printk(2, (fmt), ##__VA_ARGS__) + +#ifndef __maybe_unused +#define __maybe_unused __attribute__((__unused__)) +#endif + +#define private(name) SEC(".data." #name) __hidden __attribute__((aligned(8))) + +#define ARENA_PAGES (1UL << (32 - __builtin_ffs(__PAGE_SIZE) + 1)) + +struct { + __uint(type, BPF_MAP_TYPE_ARENA);
tools/testing/selftests/bpf/libarena/include/common.h line 40
Quoted 10 lines
tools/testing/selftests/bpf/libarena/include/common.h new file +10
-0+__uint (map_flags,BPF_F_MMAPABLE ); +__uint (max_entries,ARENA_PAGES );/* number of pages */ +#if defined(__TARGET_ARCH_arm64) || defined(__aarch64__) +__ulong (map_extra, (1ull <<32 ));/* start of mmap() region */ +#else +__ulong (map_extra, (1ull <<44 ));/* start of mmap() region */ +#endif +} arena __weak SEC(".maps"); + +extern const volatile u32 zero;
Within subsequent patches you're using this zero variable to initialize loop index variables. I assume this is to prevent the compiler from over-optimizing (e.g., unrolling the loops) by forcing a load from memory? If so, perhaps a comment is warranted? Someone may naively come along and swap this out with a literal, and that may intentionally not be the semantic we want here.
Quoted 338 lines
tools/testing/selftests/bpf/libarena/include/common.h new file +25
-0+int arena_fls (__u64 word); + +#else /* ! __BPF__ */ + +#include <stdint.h> + +#define __arena + +typedef uint8_t u8 ; +typedef uint16_t u16 ; +typedef uint32_t u32 ; +typedef uint64_t u64 ; +typedef int8_t s8 ; +typedef int16_t s16 ; +typedef int32_t s32 ; +typedef int64_t s64 ; + +/* Dummy "definition" for userspace. */ +#define arena_spinlock_t int + +#endif /* __BPF__ */ + +struct arena_get_base_args { + void __arena *arena_base; +};tools/testing/selftests/bpf/libarena/include/selftest_helpers.h new file +99
-0@@ -0,0 +1,99 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#pragma once + +#include <errno.h> +#include <stdlib.h> +#include <unistd.h> +#include <sys/mman.h> + +#include <bpf/libbpf.h> +#include <bpf/bpf.h> + +static inline int libarena_run_prog (int prog_fd) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +int ret; + + ret =bpf_prog_test_run_opts (prog_fd, &opts); +if (ret) +return ret; + +return opts.retval; +} + +static inline bool libarena_is_test_prog (const char *name) +{ +return strstr (name,"test_" ) == name; +} + +static inline int libarena_run_prog_args (int prog_fd,void *args,size_t argsize) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +int ret; + + opts.ctx_in = args; + opts.ctx_size_in = argsize; + + ret =bpf_prog_test_run_opts (prog_fd, &opts); + +return ret ?: opts.retval; +} + +static inline int libarena_get_arena_base (int arena_get_base_fd, +void **arena_base) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +struct arena_get_base_args args = { .arena_base =NULL }; +int ret; + + opts.ctx_in = &args; + opts.ctx_size_in =sizeof (args); + + ret =bpf_prog_test_run_opts (arena_get_base_fd, &opts); +if (ret) +return ret; +if (opts.retval) +return opts.retval; + + *arena_base = args.arena_base; +return 0 ; +} + +static inline int libarena_get_globals_pages (int arena_get_base_fd, +size_t arena_all_pages, +u64 *globals_pages) +{ +size_t pgsize =sysconf (_SC_PAGESIZE); +void *arena_base; +ssize_t i; +u8 *vec; +int ret; + + ret =libarena_get_arena_base (arena_get_base_fd, &arena_base); +if (ret) +return ret; + +if (!arena_base) +return -EINVAL ; + + vec =calloc (arena_all_pages,sizeof (*vec)); +if (!vec) +return -ENOMEM ; + +if (mincore (arena_base, arena_all_pages * pgsize, vec) <0 ) { + ret = -errno; +free (vec); +return ret; + } + + *globals_pages =0 ; +for (i = arena_all_pages -1 ; i >=0 ; i--) { +if (!(vec[i] &0x1 )) +break ; + *globals_pages +=1 ; + } + +free (vec); +return 0 ; +}tools/testing/selftests/bpf/libarena/selftests/selftest.c new file +160
-0@@ -0,0 +1,160 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ + +#define _GNU_SOURCE +#include <assert.h> +#include <errno.h> +#include <stdio.h> +#include <string.h> +#include <unistd.h> + +#include <bpf/libbpf.h> +#include <bpf/bpf.h> + +#include <sys/mman.h> +#include <sys/resource.h> +#include <sys/sysinfo.h> + +#include <common.h> +#include <selftest_helpers.h> + +struct arena_qnode { +unsigned long next; +int count; +int locked; +}; + +#include "../libarena.skel.h" +typedef struct libarena selftest ; +#define selftest__open libarena__open +#define selftest__open_and_load libarena__open_and_load +#define selftest__load libarena__load +#define selftest__attach libarena__attach +#define selftest__destroy libarena__destroy + +static bool verbose; +static int testno =1 ; + +static int +run_prog_verbose (int prog_fd) +{ +char buf[1024 ]; +int ret, err; + + ret =libarena_run_prog (prog_fd); + +if (ret) +fprintf (stderr,"error %d in %s\n" , ret, __func__); + +if (verbose) { +printf ("BPF stdout:\n" ); +while ((err =bpf_prog_stream_read (prog_fd,1 , buf,1024 ,NULL )) >0 ) +printf ("%.*s" , err, buf); + +if (err) +return err; + +printf ("BPF stderr:\n" ); +while ((err =bpf_prog_stream_read (prog_fd,2 , buf,1024 ,NULL )) >0 ) +printf ("%.*s" , err, buf); + +if (err) +return err; + } + +return ret; +} + +static int libbpf_print_fn (enum libbpf_print_level level, +const char *format,va_list args) +{ +if (level ==LIBBPF_DEBUG ) +return 0 ; +return vfprintf (stderr, format, args); +} + +static int run_test (selftest *skel,struct bpf_program *prog) +{ +int prog_fd; + + prog_fd =bpf_program__fd (prog); +if (prog_fd <0 ) +return prog_fd; + +return run_prog_verbose (prog_fd); +} + +static void +banner (const char *progpath) +{ +char *name =basename (progpath); + +printf ("%s\n" , name); + +printf ("=== %s ===\n" ,"libarena selftests" ); +} + +int main (int argc,char *argv[]) +{ +struct bpf_program *prog; +selftest *skel; +int err =0 ; +int ret; + +banner (argv[0 ]); + +for (int i =1 ; i < argc; i++) { +if (strcmp (argv[i],"-v" ) ==0 ||strcmp (argv[i],"--verbose" ) ==0 ) { + verbose = true; +continue ; + } + +fprintf (stderr,"usage: ./%s [-v] [--verbose]\n" , argv[0 ]); +fprintf (stderr,"verbose option prints out BPF streams," +" including ASAN stacks when applicable\n" ); + +return -EINVAL ; + } + +libbpf_set_print (libbpf_print_fn); + + skel =selftest__open_and_load (); +if (!skel) { +fprintf (stderr,"Failed to open and load skeleton\n" ); +return 1 ; + } + + ret =selftest__attach (skel); +if (ret) { +fprintf (stderr,"Failed to attach skeleton\n" ); +selftest__destroy (skel); +return 1 ; + } + + ret =libarena_run_prog (bpf_program__fd (skel->progs.arena_alloc_reserve)); +if (ret) { +fprintf (stderr,"Failed to initialize arena: %d\n" , ret); +selftest__destroy (skel); +return 1 ; + } + +bpf_object__for_each_program (prog, skel->obj) { +const char *name =bpf_program__name (prog); + +if (!libarena_is_test_prog (name)) +continue ; + + ret =run_test (skel, prog); +if (ret) +printf ("not ok %d - %s\n" , testno++, name); +else +printf ("ok %d - %s\n" , testno++, name); + +if (ret) + err = -EINVAL ; + } + +selftest__destroy (skel); + +return err; +}tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +36
-0@@ -0,0 +1,62 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#include <common.h> + +const volatile u32 zero =0 ; + +/* How many pages do we reserve at the beginning of the arena segment? */ +#define RESERVE_ALLOC (8) + +int arena_fls (__u64 word) +{ +unsigned int num =0 ; + +if (!word) +return 0 ; + +if (word &0xffffffff00000000ULL ) { + num +=32 ; + word >>=32 ; + } + +if (word &0xffff0000 ) { + num +=16 ; + word >>=16 ; + } + +if (word &0xff00 ) { + num +=8 ; + word >>=8 ; + } + +if (word &0xf0 ) { + num +=4 ; + word >>=4 ; + } +
tools/testing/selftests/bpf/libarena/src/common.bpf.c line 46
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +10
-0+if (word &0xc ) { + num +=2 ; + word >>=2 ; + } + +if (word &0x2 ) + num +=1 ; + +return num +1 ; +}
What's your reason for not using something like __builtin_clzll() instead here, for example:
int arena_fls(u64 word)
{
if (!word)
return 0;
return 64 - __builtin_clzll(word);
}I imagine that you've implemented it in this open-coded way for either verifier predicatability or toolchain portability reasons? The latter has no practical significance IMO given that you're already reliant on predefined toolchain preprocessor macros like __BPF_FEATURE_ADDR_SPACE_CAST anyway.
tools/testing/selftests/bpf/libarena/src/common.bpf.c line 54
Quoted 7 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +7
-0+SEC("syscall") +__weak int arena_get_base (struct arena_get_base_args *args) +{ + args->arena_base =arena_base (&arena); + +return 0 ; +}
Just an idea bu perhaps this kind of SYSCALL helper BPF program should be named arena_get_info() and take a struct arena_get_info_ctx argument instead? I think it'll make it more future proof. If we want to expose more details from the BPF arena in the future (e.g., total size, number of active pages, etc), we wouldn't need to create new SYSCALL helper BPF programs or break the existing signature. We can use a struct with a size field or reserved fields for future use.
tools/testing/selftests/bpf/libarena/src/common.bpf.c line 60
Quoted 5 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +5
-0+SEC("syscall") +__weak int arena_alloc_reserve (void ) +{ +return bpf_arena_reserve_pages (&arena,NULL ,RESERVE_ALLOC ); +}
What do you think about this SYSCALL helper BPF program taking a context argument which would allow userspace to define the number of pages that should be reserved? This would make things slightly more flexible and resuable?
Re: [PATCH bpf-next v8 2/8] selftests/bpf: Add basic libarena scaffolding
Quoted 42 lines · Matt Bobrowski
Quoted 28 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +28
-0+ +int arena_fls (__u64 word) +{ +unsigned int num =0 ; + +if (!word) +return 0 ; + +if (word &0xffffffff00000000ULL ) { + num +=32 ; + word >>=32 ; + } + +if (word &0xffff0000 ) { + num +=16 ; + word >>=16 ; + } + +if (word &0xff00 ) { + num +=8 ; + word >>=8 ; + } + +if (word &0xf0 ) { + num +=4 ; + word >>=4 ; + } +tools/testing/selftests/bpf/libarena/src/common.bpf.c line 46
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +10
-0+if (word &0xc ) { + num +=2 ; + word >>=2 ; + } + +if (word &0x2 ) + num +=1 ; + +return num +1 ; +}What's your reason for not using something like
__builtin_clzll()instead here, for example:
Quoted 7 lines
int
arena_fls(u64 word){ if (!word) return 0; return 64 - __builtin_clzll(word); }
Great suggestion. If it works, let's adopt __builtin_*
Emil Tsalapatis
reviewerRe: [PATCH bpf-next v8 2/8] selftests/bpf: Add basic libarena scaffolding
Quoted 48 lines · Alexei Starovoitov
Quoted 47 lines · Matt Bobrowski
Quoted 28 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +28
-0+ +int arena_fls (__u64 word) +{ +unsigned int num =0 ; + +if (!word) +return 0 ; + +if (word &0xffffffff00000000ULL ) { + num +=32 ; + word >>=32 ; + } + +if (word &0xffff0000 ) { + num +=16 ; + word >>=16 ; + } + +if (word &0xff00 ) { + num +=8 ; + word >>=8 ; + } + +if (word &0xf0 ) { + num +=4 ; + word >>=4 ; + } +tools/testing/selftests/bpf/libarena/src/common.bpf.c line 46
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c new file +10
-0+if (word &0xc ) { + num +=2 ; + word >>=2 ; + } + +if (word &0x2 ) + num +=1 ; + +return num +1 ; +}What's your reason for not using something like
__builtin_clzll()instead here, for example:int
arena_fls(u64 word){ if (!word) return 0;
Quoted 4 lines
Quoted 2 lines
return 64 - __builtin_clzll(word); }Great suggestion. If it works, let's adopt __builtin_*
Will do. Sending v9 right now.
Emil Tsalapatis
reviewerPATCH v8 3/8 selftests/bpf: Move arena-related headers into libarena
In reply to Emil TsalapatisThe BPF selftest headers include functionality that is specific to arenas and is required by libarena. Keep libarena self-contained by moving all functionality into its include/ directory. Also add libarena/include to the standard include paths for the selftests to make the moved headers easy to access by existing selftests.
Some functionality is required by libarena but not strictly arena-related. We still move it to the libarena/include path, which is an upgrade from directly accessing them from the selftests/bpf directory using relative paths.
A new bpf_may_goto.h file is split off of bpf_experimental.h. bpf_arena_spin_lock.h and bpf_arena_common.h are moved to libarena/include. bpf_atomic.h is also moved to libarena because it is necessary for arena spinlocks.
For bpf_arena_spin_lock.h, mark the spinlock state array as __weak to define the spinlock state array in the header while also being compatible with multi-compilation unit programs. While we're at it, we remove unnecessary definitions from existing test programs.
---
tools/testing/selftests/bpf/Makefile | 4 +-
tools/testing/selftests/bpf/bpf_arena_alloc.h | 2 +-
tools/testing/selftests/bpf/bpf_arena_list.h | 2 +-
.../selftests/bpf/bpf_arena_strsearch.h | 2 +-
.../testing/selftests/bpf/bpf_experimental.h | 84 +------------------
.../{ => libarena/include}/bpf_arena_common.h | 0
.../include}/bpf_arena_spin_lock.h | 11 ++-
.../bpf/{ => libarena/include}/bpf_atomic.h | 2 +-
.../bpf/libarena/include/bpf_may_goto.h | 84 +++++++++++++++++++
.../selftests/bpf/libarena/include/common.h | 4 +-
.../bpf/libarena/selftests/selftest.c | 6 --
.../bpf/prog_tests/arena_spin_lock.c | 7 --
.../selftests/bpf/progs/arena_atomics.c | 2 +-
.../selftests/bpf/progs/arena_spin_lock.c | 2 +-
.../bpf/progs/compute_live_registers.c | 2 +-
.../selftests/bpf/progs/lpm_trie_bench.c | 2 +-
tools/testing/selftests/bpf/progs/stream.c | 2 +-
.../selftests/bpf/progs/verifier_arena.c | 2 +-
.../bpf/progs/verifier_arena_globals1.c | 2 +-
.../bpf/progs/verifier_arena_globals2.c | 2 +-
.../bpf/progs/verifier_arena_large.c | 2 +-
.../selftests/bpf/progs/verifier_ldsx.c | 2 +-
22 files changed, 112 insertions(+), 116 deletions(-)
rename tools/testing/selftests/bpf/{ => libarena/include}/bpf_arena_common.h (100%)
rename tools/testing/selftests/bpf/{progs => libarena/include}/bpf_arena_spin_lock.h (98%)
rename tools/testing/selftests/bpf/{ => libarena/include}/bpf_atomic.h (99%)
create mode 100644 tools/testing/selftests/bpf/libarena/include/bpf_may_goto.htools/testing/selftests/bpf/Makefile +3 -1
@@ -56,7 +56,8 @@ CFLAGS += -g $(OPT_FLAGS) -rdynamic -std=gnu11 \ -Wno-unused-but-set-variable \ $(GENFLAGS) $(SAN_CFLAGS) $(LIBELF_CFLAGS) \ -I$(CURDIR) -I$(INCLUDE_DIR) -I$(GENDIR) -I$(LIBDIR) \ - -I$(TOOLSINCDIR) -I$(TOOLSARCHINCDIR) -I$(APIDIR) -I$(OUTPUT) + -I$(TOOLSINCDIR) -I$(TOOLSARCHINCDIR) -I$(APIDIR) -I$(OUTPUT) \ + -I$(CURDIR)/libarena/include LDFLAGS += $(SAN_LDFLAGS) LDLIBS += $(LIBELF_LIBS) -lz -lrt -lpthread
@@ -446,6 +447,7 @@ endif CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG),$(CLANG_TARGET_ARCH)) BPF_CFLAGS = -g -Wall -Werror -D__TARGET_ARCH_$(SRCARCH) $(MENDIAN) \ -I$(INCLUDE_DIR) -I$(CURDIR) -I$(APIDIR) \ + -I$(CURDIR)/libarena/include \ -I$(abspath $(OUTPUT)/../usr/include) \ -std=gnu11 \ -fno-strict-aliasing \
tools/testing/selftests/bpf/bpf_arena_alloc.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ /* Copyright (c) 2024 Meta Platforms, Inc. and affiliates. */ #pragma once -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #ifndef __round_mask#define __round_mask (x, y) ((__typeof__(x))((y)-1))
tools/testing/selftests/bpf/bpf_arena_list.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ /* Copyright (c) 2024 Meta Platforms, Inc. and affiliates. */ #pragma once -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> struct arena_list_node ;
tools/testing/selftests/bpf/bpf_arena_strsearch.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ /* Copyright (c) 2025 Meta Platforms, Inc. and affiliates. */ #pragma once -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> __noinline int bpf_arena_strlen(const char __arena *s __arg_arena) {
tools/testing/selftests/bpf/bpf_experimental.h +1 -83
96 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/include/bpf_arena_common.h renamed from tools/testing/selftests/bpf/bpf_arena_common.h +0 -0
tools/testing/selftests/bpf/libarena/include/bpf_arena_spin_lock.h renamed from tools/testing/selftests/bpf/progs/bpf_arena_spin_lock.h +8 -3
@@ -5,7 +5,7 @@#include <vmlinux.h> #include <bpf/bpf_helpers.h> -#include "bpf_atomic.h" +#include <bpf_atomic.h> #define arch_mcs_spin_lock_contended_label (l, label) smp_cond_load_acquire_label(l, VAL, label)#define arch_mcs_spin_unlock_contended (l) smp_store_release((l), 1)
@@ -107,7 +107,12 @@ struct arena_qnode {#define _Q_LOCKED_VAL (1U << _Q_LOCKED_OFFSET)#define _Q_PENDING_VAL (1U << _Q_PENDING_OFFSET) -struct arena_qnode __arena qnodes[_Q_MAX_CPUS][_Q_MAX_NODES]; +/* +* The qnodes are marked __weak so we can define them in the header +* while still ensuring all compilation units use the same struct +* instance. +*/ +struct arena_qnode __weak __arena __hidden qnodes[_Q_MAX_CPUS][_Q_MAX_NODES];static inline u32 encode_tail (int cpu,int idx) {
@@ -240,7 +245,7 @@ static __always_inline int arena_spin_trylock(arena_spinlock_t __arena *lock)return likely (atomic_try_cmpxchg_acquire (&lock->val, &val, _Q_LOCKED_VAL)); } -__noinline +__noinline __weak int arena_spin_lock_slowpath(arena_spinlock_t __arena __arg_arena *lock, u32 val) { struct arena_mcs_spinlock __arena *prev, *next, *node0, *node;
tools/testing/selftests/bpf/libarena/include/bpf_atomic.h renamed from tools/testing/selftests/bpf/bpf_atomic.h +1 -1
@@ -5,7 +5,7 @@#include <vmlinux.h> #include <bpf/bpf_helpers.h> -#include "bpf_experimental.h" +#include <bpf_may_goto.h> extern bool CONFIG_X86_64 __kconfig __weak;
tools/testing/selftests/bpf/libarena/include/bpf_may_goto.h new file +84 -0
84 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/include/common.h +2 -2
@@ -6,8 +6,8 @@#include <vmlinux.h> -#include "../../bpf_arena_common.h" -#include "../../progs/bpf_arena_spin_lock.h" +#include <bpf_arena_common.h> +#include <bpf_arena_spin_lock.h> #include <asm-generic/errno.h>
tools/testing/selftests/bpf/libarena/selftests/selftest.c +0 -6
@@ -18,12 +18,6 @@#include <common.h> #include <selftest_helpers.h> -struct arena_qnode { -unsigned long next; -int count; -int locked; -}; -#include "../libarena.skel.h" typedef struct libarena selftest ;#define selftest__open libarena__open
tools/testing/selftests/bpf/prog_tests/arena_spin_lock.c +0 -7
@@ -5,13 +5,6 @@#include <sys/sysinfo.h> struct __qspinlock {int val; }; -typedef struct __qspinlock arena_spinlock_t ; - -struct arena_qnode { -unsigned long next; -int count; -int locked; -};#include "arena_spin_lock.skel.h"
tools/testing/selftests/bpf/progs/arena_atomics.c +1 -1
@@ -5,7 +5,7 @@#include <bpf/bpf_tracing.h> #include <stdbool.h> #include <stdatomic.h> -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #include "../../../include/linux/filter.h" #include "bpf_misc.h"
tools/testing/selftests/bpf/progs/arena_spin_lock.c +1 -1
@@ -4,7 +4,7 @@#include <bpf/bpf_tracing.h> #include <bpf/bpf_helpers.h> #include "bpf_misc.h" -#include "bpf_arena_spin_lock.h" +#include <bpf_arena_spin_lock.h> struct { __uint(type, BPF_MAP_TYPE_ARENA);
tools/testing/selftests/bpf/progs/compute_live_registers.c +1 -1
@@ -3,7 +3,7 @@#include <linux/bpf.h> #include <bpf/bpf_helpers.h> #include "../../../include/linux/filter.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #include "bpf_misc.h" struct {
tools/testing/selftests/bpf/progs/lpm_trie_bench.c +1 -1
@@ -7,7 +7,7 @@#include <bpf/bpf_helpers.h> #include <bpf/bpf_core_read.h> #include "bpf_misc.h" -#include "bpf_atomic.h" +#include <bpf_atomic.h> #include "progs/lpm_trie.h" #define BPF_OBJ_NAME_LEN 16U
tools/testing/selftests/bpf/progs/stream.c +1 -1
@@ -5,7 +5,7 @@#include <bpf/bpf_helpers.h> #include "bpf_misc.h" #include "bpf_experimental.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> struct arr_elem {struct bpf_res_spin_lock lock;
tools/testing/selftests/bpf/progs/verifier_arena.c +1 -1
@@ -8,7 +8,7 @@#include <bpf/bpf_tracing.h> #include "bpf_misc.h" #include "bpf_experimental.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #define private (name) SEC(".bss." #name) __hidden __attribute__((aligned(8)))
tools/testing/selftests/bpf/progs/verifier_arena_globals1.c +1 -1
@@ -6,7 +6,7 @@#include <bpf/bpf_helpers.h> #include <bpf/bpf_tracing.h> #include "bpf_experimental.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #include "bpf_misc.h" #define ARENA_PAGES (1UL<< (32 - __builtin_ffs(__PAGE_SIZE) + 1))
tools/testing/selftests/bpf/progs/verifier_arena_globals2.c +1 -1
@@ -7,7 +7,7 @@#include <bpf/bpf_tracing.h> #include "bpf_misc.h" #include "bpf_experimental.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #define ARENA_PAGES (32)
tools/testing/selftests/bpf/progs/verifier_arena_large.c +1 -1
@@ -7,7 +7,7 @@#include <bpf/bpf_tracing.h> #include "bpf_misc.h" #include "bpf_experimental.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #define ARENA_SIZE (1ull << 32)
tools/testing/selftests/bpf/progs/verifier_ldsx.c +1 -1
@@ -3,7 +3,7 @@#include <linux/bpf.h> #include <bpf/bpf_helpers.h> #include "bpf_misc.h" -#include "bpf_arena_common.h" +#include <bpf_arena_common.h> #if (defined(__TARGET_ARCH_arm64) || defined(__TARGET_ARCH_x86) || \ (defined(__TARGET_ARCH_riscv) && __riscv_xlen == 64) || \
Signature · 1 line
2.53.0
Emil Tsalapatis
reviewerPATCH v8 4/8 selftests/bpf: Add arena ASAN runtime to libarena
In reply to Emil TsalapatisAdd an address sanitizer (ASAN) runtime to the arena library. The ASAN runtime implements the functions injected into BPF binaries by LLVM sanitization when ASAN is enabled during compilation.
The runtime also includes functions called explicitly by memory allocation code to mark memory as poisoned/unpoisoned to ASAN. This code is a no-op when sanitization is turned off.
--- .../selftests/bpf/libarena/include/asan.h | 103 ++++ .../selftests/bpf/libarena/include/common.h | 1 + .../selftests/bpf/libarena/src/asan.bpf.c | 553 ++++++++++++++++++ 3 files changed, 657 insertions(+) create mode 100644 tools/testing/selftests/bpf/libarena/include/asan.h create mode 100644 tools/testing/selftests/bpf/libarena/src/asan.bpf.c
tools/testing/selftests/bpf/libarena/include/asan.h new file +103 -0
@@ -0,0 +1,103 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#pragma once + +struct asan_init_args { +u64 arena_all_pages; +u64 arena_globals_pages; +}; + +int asan_init (struct asan_init_args *args); + +extern volatile u64 __asan_shadow_memory_dynamic_address; +extern volatile u32 asan_reported; +extern volatile bool asan_inited; +extern volatile bool asan_report_once; + +#ifdef __BPF__ + +#define ASAN_SHADOW_SHIFT 3 +#define ASAN_SHADOW_SCALE (1ULL << ASAN_SHADOW_SHIFT) +#define ASAN_GRANULE_MASK ((1ULL << ASAN_SHADOW_SHIFT) - 1) +#define ASAN_GRANULE (addr) ((s8)((u32)(u64)((addr)) & ASAN_GRANULE_MASK)) + +#define __noasan __attribute__((no_sanitize("address"))) + +#ifdef BPF_ARENA_ASAN + +typedef s8 __arena s8a; + +static inline +s8a *mem_to_shadow(void __arena __arg_arena *addr) +{ +return (s8a *)(((u32 )(u64 )addr >>ASAN_SHADOW_SHIFT ) + + __asan_shadow_memory_dynamic_address); +} + +__weak __noasan +bool asan_ready(void) +{ +return __asan_shadow_memory_dynamic_address; +} + +int asan_poison(void __arena *addr, s8 val, size_t size); +int asan_unpoison(void __arena *addr, size_t size); +bool asan_shadow_set(void __arena *addr); + +/* +* Dummy calls to ensure the ASAN runtime's BTF information is present +* in every object file when compiling the runtime and local BPF code +* separately. The runtime calls are injected into the LLVM IR file +*/ +#define DECLARE_ASAN_LOAD_STORE_SIZE (size) \ + void __asan_store##size(intptr_t addr); \ + void __asan_store##size##_noabort(intptr_t addr); \ + void __asan_load##size(intptr_t addr); \ + void __asan_load##size##_noabort(intptr_t addr); \ + void __asan_report_store##size(intptr_t addr); \ + void __asan_report_store##size##_noabort(intptr_t addr); \ + void __asan_report_load##size(intptr_t addr); \ + void __asan_report_load##size##_noabort(intptr_t addr); + +DECLARE_ASAN_LOAD_STORE_SIZE (1 ); +DECLARE_ASAN_LOAD_STORE_SIZE (2 ); +DECLARE_ASAN_LOAD_STORE_SIZE (4 ); +DECLARE_ASAN_LOAD_STORE_SIZE (8 ); + +void __asan_storeN (intptr_t addr,ssize_t size); +void __asan_storeN_noabort (intptr_t addr,ssize_t size); +void __asan_loadN (intptr_t addr,ssize_t size); +void __asan_loadN_noabort (intptr_t addr,ssize_t size); + +/* +* Force LLVM to emit BTF information for the stubs, +* because the ASAN pass in LLVM by itself doesn't. +*/ +#define ASAN_LOAD_STORE_SIZE (size) \ + __asan_store##size, \ + __asan_store##size##_noabort, \ + __asan_load##size, \ + __asan_load##size##_noabort, \ + __asan_report_store##size, \ + __asan_report_store##size##_noabort, \ + __asan_report_load##size, \ + __asan_report_load##size##_noabort + +__attribute__((used)) +static void (*__asan_btf_anchors[])(intptr_t ) = { +ASAN_LOAD_STORE_SIZE (1 ), +ASAN_LOAD_STORE_SIZE (2 ), +ASAN_LOAD_STORE_SIZE (4 ), +ASAN_LOAD_STORE_SIZE (8 ), +}; + +#else /* BPF_ARENA_ASAN */ + +static inline int asan_poison(void __arena *addr, s8 val, size_t size) { return 0; } +static inline int asan_unpoison(void __arena *addr, size_t size) { return 0; } +static inline bool asan_shadow_set(void __arena *addr) { return 0; } +__weak bool asan_ready (void ) {return true; } + +#endif /* BPF_ARENA_ASAN */ + +#endif /* __BPF__ */
tools/testing/selftests/bpf/libarena/include/common.h +1 -0
@@ -38,6 +38,7 @@ struct { } arena __weak SEC(".maps");extern const volatile u32 zero; +extern volatile u64 asan_violated;int arena_fls (__u64 word);
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +553 -0
553 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 4/8] selftests/bpf: Add arena ASAN runtime to libarena
Sashiko AI review found 5 potential issue(s): - [High] Silent failure and incomplete shadow map updates in `asan_memset` and `first_nonzero_byte` due to BPF loop limits. - [High] `__asan_memcpy`…
Sashiko AI review found 5 potential issue(s):
- [High] Silent failure and incomplete shadow map updates in asan_memset and first_nonzero_byte due to BPF loop limits.
- [High] __asan_memcpy, __asan_memmove, and __asan_memset stubs silently drop memory operations, causing uninitialized data usage.
- [High] Concurrent execution of asan_init corrupts the shadow map base address due to a TOCTOU race condition.
- [High] ASAN memory access hooks lack runtime initialization checks, leading to false positives and invalid memory access.
- [Medium] Missing BTF anchors for variable-sized and intrinsic ASAN memory stubs.
--
commit b77770f7adb86bf4a4f23e524cb1dfc5e9e8a79e
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Add arena ASAN runtime to libarena
This adds an address sanitizer (ASAN) runtime to the arena library. The ASAN runtime implements functions injected into BPF binaries by LLVM sanitization when ASAN is enabled.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/include/asan.h new file +0
-0
[ ... ]
Quoted 11 lines
tools/testing/selftests/bpf/libarena/include/asan.h new file +11
-0+/* +* Force LLVM to emit BTF information for the stubs, +* because the ASAN pass in LLVM by itself doesn't. +*/ +#define ASAN_LOAD_STORE_SIZE (size) \ + __asan_store##size, \ + __asan_store##size##_noabort, \ + __asan_load##size, \ + __asan_load##size##_noabort, \ + __asan_report_store##size, \ + __asan_report_store##size##_noabort, \
tools/testing/selftests/bpf/libarena/include/asan.h line 92
Quoted 10 lines
tools/testing/selftests/bpf/libarena/include/asan.h new file +10
-0+ __asan_report_load##size, \ + __asan_report_load##size##_noabort + +__attribute__((used)) +static void (*__asan_btf_anchors[])(intptr_t ) = { +ASAN_LOAD_STORE_SIZE (1 ), +ASAN_LOAD_STORE_SIZE (2 ), +ASAN_LOAD_STORE_SIZE (4 ), +ASAN_LOAD_STORE_SIZE (8 ), +};
Are there missing anchors for __asan_loadN, __asan_storeN, __asan_memcpy, __asan_memmove, and __asan_memset here? The LLVM ASAN pass can inject calls to these for variable-sized or intrinsic struct accesses, which could lead to BPF linking failures if their BTF information is stripped.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +0
-0
[ ... ]
tools/testing/selftests/bpf/libarena/src/asan.bpf.c line 121
Quoted 9 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +9
-0+__weak int asan_memset(s8a __arg_arena *dst, s8 val, size_t size) +{ +size_t i; + +for (i = zero; i < size && can_loop; i++) + dst[i] = val; + +return 0 ; +}
Does this silently leave the remainder of the shadow memory unpoisoned if the loop terminates early due to the can_loop BPF runtime limit? If a large allocation causes this to hit the budget, returning 0 might cause callers like asan_unpoison to proceed, leading to false positives on subsequent accesses to the remainder.
[ ... ]
tools/testing/selftests/bpf/libarena/src/asan.bpf.c line 176
Quoted 11 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +11
-0+static __always_inline u64 first_nonzero_byte(u64 addr, size_t size) +{ +while (size && can_loop) { +if (unlikely (*(s8a *)addr)) +return addr; + addr +=1 ; + size -=1 ; + } + +return SHADOW_ALL_ZEROES ; +}
Similarly, could this return SHADOW_ALL_ZEROES inappropriately if the loop terminates early from the can_loop limit? This might mask use-after-free bugs if the scan is incomplete.
[ ... ]
tools/testing/selftests/bpf/libarena/src/asan.bpf.c line 257
Quoted 5 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +5
-0+static __always_inline bool check_region_inline(intptr_t ptr, size_t size, +u32 flags) +{ +s8a *addr = (s8a *)(u64 )ptr; +bool is_poisoned, is_valid;
Should this function check if the ASAN runtime has been initialized, perhaps by calling asan_ready()? If a BPF program executes before userspace invokes asan_init, __asan_shadow_memory_dynamic_address would remain 0. This could cause the checks to read from offset 0 in user memory instead of the shadow map, leading to unpredictable false positives.
[ ... ]
Quoted 11 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +11
-0+/* +* We do not currently have memcpy/memmove/memset intrinsics +* in LLVM. Do not implement sanitization. +*/ +void *__asan_memcpy (void *d,const void *s,size_t n) +{ +arena_stderr ("ASAN: Unexpected %s call" , __func__); +return NULL ; +} + +void *__asan_memmove (void *d,const void *s,size_t n)
tools/testing/selftests/bpf/libarena/src/asan.bpf.c line 379
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +10
-0+{ +arena_stderr ("ASAN: Unexpected %s call" , __func__); +return NULL ; +} + +void *__asan_memset (void *p,int c,size_t n) +{ +arena_stderr ("ASAN: Unexpected %s call" , __func__); +return NULL ; +}
If the LLVM ASAN pass intercepts intrinsic memory operations and replaces them with these external calls, will the actual memory operations be completely dropped? Returning NULL here without performing the copy or set might leave the destination structs uninitialized, which could corrupt application data.
[ ... ]
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +10
-0+SEC("syscall") +__weak __noasan int asan_init(struct asan_init_args *args) +{ +u64 globals_pages = args->arena_globals_pages; +u64 all_pages = args->arena_all_pages; +u64 shadow_map, shadow_pgoff; +u64 shadow_pages; + +if (asan_inited) +return 0 ;
[ ... ]
Quoted 5 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +5
-0+ shadow_map = (u64 )bpf_arena_alloc_pages ( + &arena, (void __arena *)__asan_shadow_memory_dynamic_address, + shadow_pages,NUMA_NO_NODE ,0 ); +if (!shadow_map) { +arena_stderr ("Could not allocate shadow map\n" );
tools/testing/selftests/bpf/libarena/src/asan.bpf.c line 547
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/asan.bpf.c new file +10
-0+ + __asan_shadow_memory_dynamic_address =0 ; + +return -ENOMEM ; + } + + asan_inited = true; + +return 0 ; +}
Is there a TOCTOU race condition here that could corrupt the shadow map base address?
If two userspace threads bypass the if (asan_inited) check simultaneously, both could attempt bpf_arena_alloc_pages() at the same target address. The second thread's allocation would fail, taking the error path and setting __asan_shadow_memory_dynamic_address to 0, while the first thread might have already set asan_inited to true.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=4
Emil Tsalapatis
reviewerPATCH v8 5/8 selftests/bpf: Add ASAN support for libarena selftests
In reply to Emil TsalapatisExpand the arena library selftest infrastructure to support address sanitization. Add the compiler flags necessary to compile the library under ASAN when supported.
--- tools/testing/selftests/bpf/.gitignore | 1 + tools/testing/selftests/bpf/Makefile | 6 ++- tools/testing/selftests/bpf/libarena/Makefile | 29 +++++++++++- .../bpf/libarena/include/selftest_helpers.h | 33 +++++++++++++ .../bpf/libarena/selftests/selftest.c | 40 ++++++++++++++-- .../bpf/libarena/selftests/st_asan_common.h | 47 +++++++++++++++++++ .../selftests/bpf/libarena/src/common.bpf.c | 2 + 7 files changed, 153 insertions(+), 5 deletions(-) create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h
tools/testing/selftests/bpf/.gitignore +1 -0
@@ -50,3 +50,4 @@ verification_cert.h usdt_1 usdt_2 libarena/test_libarena +libarena/test_libarena_asan
tools/testing/selftests/bpf/Makefile +5 -1
@@ -788,7 +788,8 @@ TRUNNER_EXTRA_SOURCES := test_progs.c \ flow_dissector_load.h \ ip_check_defrag_frags.h \ bpftool_helpers.c \ - usdt_1.c usdt_2.c + usdt_1.c usdt_2.c \ + $(LIBARENA_SKEL) TRUNNER_LIB_SOURCES := find_bit.c TRUNNER_EXTRA_FILES := $(OUTPUT)/urandom_read \ $(OUTPUT)/liburandom_read.so \
@@ -960,3 +961,6 @@ endef test_libarena: $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) +$(MAKE) -C libarena $@ $(LIBARENA_MAKE_ARGS) + +test_libarena_asan: $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) + +$(MAKE) -C libarena $@ $(LIBARENA_MAKE_ARGS)
tools/testing/selftests/bpf/libarena/Makefile +28 -1
@@ -30,6 +30,7 @@ LIBBPF_INCLUDE ?= $(INCLUDE_DIR) # Scan src/ and selftests/ to generate the final binaries LIBARENA_SOURCES = $(wildcard $(LIBARENA)/src/*.bpf.c) $(wildcard $(LIBARENA)/selftests/*.bpf.c) LIBARENA_OBJECTS = $(notdir $(LIBARENA_SOURCES:.bpf.c=.bpf.o)) +LIBARENA_OBJECTS_ASAN = $(notdir $(LIBARENA_SOURCES:.bpf.c=_asan.bpf.o)) INCLUDES = -I$(LIBARENA)/include -I$(BPFDIR) ifneq ($(INCLUDE_DIR),)
@@ -39,6 +40,13 @@ ifneq ($(LIBBPF_INCLUDE),) INCLUDES += -I$(LIBBPF_INCLUDE) endif +ASAN_FLAGS = -fsanitize=kernel-address -fno-stack-protector -fno-builtin +ASAN_FLAGS += -mllvm -asan-instrument-address-spaces=1 -mllvm -asan-shadow-addr-space=1 +ASAN_FLAGS += -mllvm -asan-use-stack-safety=0 -mllvm -asan-stack=0 +ASAN_FLAGS += -mllvm -asan-kernel=1 +ASAN_FLAGS += -mllvm -asan-constructor-kind=none +ASAN_FLAGS += -mllvm -asan-destructor-kind=none + # ENABLE_ATOMICS_TESTS required because we use arena spinlocks override BPF_CFLAGS += -DENABLE_ATOMICS_TESTS override BPF_CFLAGS += -O2 -g
@@ -55,21 +63,40 @@ vpath %.c $(LIBARENA)/src $(LIBARENA)/selftests all: test_libarena +test_libarena_asan: selftest.c $(BPFOBJ) libarena_asan.skel.h + $(call msg,BINARY,libarena,$@) + $(Q)$(CLANG) $(CFLAGS) -DBPF_ARENA_ASAN $< $(BPFOBJ) $(LDLIBS) -o $@ + test_libarena: selftest.c $(BPFOBJ) libarena.skel.h $(call msg,BINARY,libarena,$@) $(Q)$(CLANG) $(CFLAGS) $< $(BPFOBJ) $(LDLIBS) -o $@ +skeletons: libarena.skel.h libarena_asan.skel.h +.PHONY: skeletons + +libarena_asan.skel.h: libarena_asan.bpf.o + $(call msg,GEN-SKEL,libarena,$@) + $(Q)$(BPFTOOL) gen skeleton $< name "libarena_asan" > $@ + libarena.skel.h: libarena.bpf.o $(call msg,GEN-SKEL,libarena,$@) $(Q)$(BPFTOOL) gen skeleton $< name "libarena" > $@ +libarena_asan.bpf.o: $(LIBARENA_OBJECTS_ASAN) + $(call msg,GEN-OBJ,libarena,$@) + $(Q)$(BPFTOOL) gen object $@ $^ + libarena.bpf.o: $(LIBARENA_OBJECTS) $(call msg,GEN-OBJ,libarena,$@) $(Q)$(BPFTOOL) gen object $@ $^ +%_asan.bpf.o: %.bpf.c + $(call msg,CLNG-BPF,libarena,$@) + $(Q)$(CLANG) $(BPF_CFLAGS) $(ASAN_FLAGS) -DBPF_ARENA_ASAN $(BPF_TARGET_ENDIAN) -c $< -o $@ + %.bpf.o: %.bpf.c $(call msg,CLNG-BPF,libarena,$@) $(Q)$(CLANG) $(BPF_CFLAGS) $(BPF_TARGET_ENDIAN) -c $< -o $@ clean: - $(Q)rm -f *.skel.h *.bpf.o test_libarena + $(Q)rm -f *.skel.h *.bpf.o *.linked*.o test_libarena test_libarena_asan
tools/testing/selftests/bpf/libarena/include/selftest_helpers.h +33 -0
@@ -27,6 +27,11 @@ static inline bool libarena_is_test_prog(const char *name)return strstr (name,"test_" ) == name; } +static inline bool libarena_is_asan_test_prog (const char *name) +{ +return strstr (name,"asan_test" ) == name; +} +static inline int libarena_run_prog_args (int prog_fd,void *args,size_t argsize) {LIBBPF_OPTS (bpf_test_run_opts, opts);
@@ -97,3 +102,31 @@ static inline int libarena_get_globals_pages(int arena_get_base_fd,free (vec);return 0 ; } + +static inline int libarena_asan_init (int arena_get_base_fd, +int asan_init_fd, +size_t arena_all_pages) +{ +LIBBPF_OPTS (bpf_test_run_opts, opts); +struct asan_init_args args; +u64 globals_pages; +int ret; + + ret =libarena_get_globals_pages (arena_get_base_fd, + arena_all_pages, &globals_pages); +if (ret) +return ret; + + args = (struct asan_init_args ){ + .arena_all_pages = arena_all_pages, + .arena_globals_pages = globals_pages, + }; + + opts.ctx_in = &args; + opts.ctx_size_in =sizeof (args); + + ret =bpf_prog_test_run_opts (asan_init_fd, &opts); +if (ret) +return ret; +return opts.retval; +}
tools/testing/selftests/bpf/libarena/selftests/selftest.c +37 -3
@@ -16,8 +16,18 @@#include <sys/sysinfo.h> #include <common.h> +#include <asan.h> #include <selftest_helpers.h> +#ifdef BPF_ARENA_ASAN +#include "../libarena_asan.skel.h" +typedef struct libarena_asan selftest ; +#define selftest__open libarena_asan__open +#define selftest__open_and_load libarena_asan__open_and_load +#define selftest__load libarena_asan__load +#define selftest__attach libarena_asan__attach +#define selftest__destroy libarena_asan__destroy +#else #include "../libarena.skel.h" typedef struct libarena selftest ;#define selftest__open libarena__open
@@ -25,6 +35,7 @@ typedef struct libarena selftest;#define selftest__load libarena__load#define selftest__attach libarena__attach#define selftest__destroy libarena__destroy +#endif static bool verbose;static int testno =1 ;
@@ -67,6 +78,26 @@ static int libbpf_print_fn(enum libbpf_print_level level,return vfprintf (stderr, format, args); } +static int init_arena (selftest *skel) +{ +int ret; + + ret =libarena_run_prog (bpf_program__fd (skel->progs.arena_alloc_reserve)); +if (ret) +return ret; + +#ifdef BPF_ARENA_ASAN + ret =libarena_asan_init ( +bpf_program__fd (skel->progs.arena_get_base), +bpf_program__fd (skel->progs.asan_init), + (1ULL <<32 ) /sysconf (_SC_PAGESIZE)); +if (ret) +return ret; +#endif + +return 0 ; +} +static int run_test (selftest *skel,struct bpf_program *prog) {int prog_fd;
@@ -82,10 +113,13 @@ static void banner(const char *progpath) {char *name =basename (progpath); +bool is_asan; +/* Check if our BPF programs are ASAN-capable using strstr on the prog name. */ printf ("%s\n" , name); + is_asan =strstr (name,"_asan" ); -printf ("=== %s ===\n" ,"libarena selftests" ); +printf ("=== %s %s===\n" ,"libarena selftests" , is_asan ?"(asan) " :"" ); }int main (int argc,char *argv[])
@@ -125,7 +159,7 @@ int main(int argc, char *argv[])return 1 ; } - ret =libarena_run_prog (bpf_program__fd (skel->progs.arena_alloc_reserve)); + ret =init_arena (skel);if (ret) {fprintf (stderr,"Failed to initialize arena: %d\n" , ret);selftest__destroy (skel);
@@ -135,7 +169,7 @@ int main(int argc, char *argv[])bpf_object__for_each_program (prog, skel->obj) {const char *name =bpf_program__name (prog); -if (!libarena_is_test_prog (name)) +if (!libarena_is_test_prog (name) && !libarena_is_asan_test_prog (name))continue ; ret =run_test (skel, prog);
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +47 -0
47 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/src/common.bpf.c +2 -0
@@ -2,6 +2,8 @@/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ #include <common.h> +#include <asan.h> +const volatile u32 zero =0 ;/* How many pages do we reserve at the beginning of the arena segment? */
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 5/8] selftests/bpf: Add ASAN support for libarena selftests
Sashiko AI review found 2 potential issue(s): - [Medium] The debug function `print_asan_map_state()` unsafely dereferences a potentially poisoned pointer, triggering a secondary ASAN violation.…
Sashiko AI review found 2 potential issue(s):
- [Medium] The debug function print_asan_map_state() unsafely dereferences a potentially poisoned pointer, triggering a secondary ASAN violation.
- [Medium] The global variable asan_violated is not reset on error paths, breaking test isolation and causing cascading failures. --
commit 0afb16788ca62f1167765c685d131935c9f37240
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Add ASAN support for libarena selftests
This commit expands the libarena selftest infrastructure to support address sanitization, adding the necessary compiler flags to compile the library under ASAN.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +0
-0
[ ... ]
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h line 14
Quoted 7 lines
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +7
-0+static inline void print_asan_map_state(void __arena *addr) +{ +arena_stdout ("%s:%d ASAN %p -> (val: %x gran: %x set: [%s])" , + __func__, __LINE__, addr, + *(s8a *)(addr),ASAN_GRANULE (addr), +asan_shadow_set (addr) ?"yes" :"no" ); +}
Does reading *(s8a *)(addr) risk triggering a secondary ASAN violation?
If addr points to unmapped memory outside the arena, the dereference could trigger a BPF exception and terminate the test before the debug output is printed. The __noasan attribute might be needed here to avoid interception by ASAN instrumentation.
Quoted 6 lines
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +6
-0+/* +* Emit an error and force the current function to exit if the ASAN +* violation state is unexpected. Reset the violation state after. +*/ +static inline int asan_validate_addr(bool cond, void __arena *addr) +{
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h line 31
Quoted 10 lines
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +10
-0+if ((asan_violated !=0 ) == cond) { + asan_violated =0 ; +return 0 ; + } + +arena_stdout ("%s:%d ASAN asan_violated %lx" , __func__, __LINE__, + (u64 )asan_violated); +print_asan_map_state (addr); +return -EINVAL ; +}
Should asan_violated be reset to 0 before returning -EINVAL here?
BPF global variables persist across executions on the same skeleton. If left non-zero, subsequent tests might fail their ASAN validation checks.
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h line 42
Quoted 11 lines
tools/testing/selftests/bpf/libarena/selftests/st_asan_common.h new file +11
-0+ +static inline int asan_validate (void ) +{ +if (!asan_violated) +return 0 ; + +arena_stdout ("%s:%d Found ASAN violation at %lx" , __func__, __LINE__, + asan_violated); + +return -EINVAL ; +}
Similarly, does asan_violated need to be reset to 0 here to prevent cascading failures in subsequent tests?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=5
Emil Tsalapatis
reviewerPATCH v8 6/8 selftests/bpf: Add buddy allocator for libarena
In reply to Emil TsalapatisAdd a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
--- tools/testing/selftests/bpf/libarena/Makefile | 2 + .../selftests/bpf/libarena/include/buddy.h | 92 ++ .../selftests/bpf/libarena/include/common.h | 14 + .../bpf/libarena/selftests/selftest.c | 1 + .../selftests/bpf/libarena/src/buddy.bpf.c | 903 ++++++++++++++++++ .../selftests/bpf/libarena/src/common.bpf.c | 23 + 6 files changed, 1035 insertions(+) create mode 100644 tools/testing/selftests/bpf/libarena/include/buddy.h create mode 100644 tools/testing/selftests/bpf/libarena/src/buddy.bpf.c
tools/testing/selftests/bpf/libarena/Makefile +2 -0
@@ -51,6 +51,8 @@ ASAN_FLAGS += -mllvm -asan-destructor-kind=none override BPF_CFLAGS += -DENABLE_ATOMICS_TESTS override BPF_CFLAGS += -O2 -g override BPF_CFLAGS += -Wno-incompatible-pointer-types-discards-qualifiers +# Required to define our own arena-based free() +override BPF_CFLAGS += -Wno-incompatible-library-redeclaration # Required for suppressing harmless vmlinux.h-related warnings. override BPF_CFLAGS += -Wno-missing-declarations override BPF_CFLAGS += $(INCLUDES)
tools/testing/selftests/bpf/libarena/include/buddy.h new file +92 -0
92 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/include/common.h +14 -0
@@ -42,6 +42,20 @@ extern volatile u64 asan_violated;int arena_fls (__u64 word); +u64 malloc_internal (size_t size); +#define malloc (size) ((void __arena *)malloc_internal((size))) +void free(void __arena *ptr); + +/* +* The verifier associates arenas with programs by checking LD.IMM +* instruction operands for an arena and populating the program state +* with the first instance it finds. This requires accessing our global +* arena variable, but subprogs do not necessarily do so while still +* using pointers from that arena. Insert an LD.IMM instruction to +* access the arena and help the verifier. +*/ +#define arena_subprog_init () do { asm volatile ("" :: "r"(&arena)); } while (0) +#else /* ! __BPF__ */ #include <stdint.h>
tools/testing/selftests/bpf/libarena/selftests/selftest.c +1 -0
@@ -17,6 +17,7 @@#include <common.h> #include <asan.h> +#include <buddy.h> #include <selftest_helpers.h> #ifdef BPF_ARENA_ASAN
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +903 -0
903 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/src/common.bpf.c +23 -0
@@ -1,11 +1,15 @@// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause /* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ #include <common.h> +#include <asan.h> +#include <buddy.h> #include <asan.h> const volatile u32 zero =0 ; +buddy_t buddy; +/* How many pages do we reserve at the beginning of the arena segment? */ #define RESERVE_ALLOC (8)
@@ -61,4 +65,23 @@ __weak int arena_alloc_reserve(void)return bpf_arena_reserve_pages (&arena,NULL ,RESERVE_ALLOC ); } +SEC("syscall") +__weak int arena_buddy_reset (void ) +{ +buddy_destroy (&buddy); + +return buddy_init (&buddy); +} + +__weak u64 malloc_internal (size_t size) +{ +return buddy_alloc_internal (&buddy, size); +} + +__weak void free(void __arg_arena __arena *ptr) +{ +buddy_free_internal (&buddy, (u64 )ptr); +} + + char _license[] SEC("license") = "GPL";
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
In v4, Alexei Starovoitov asked for a mathematical analysis of the memory savings from using indices instead of pointers here:
Quoted 6 lines
tools/testing/selftests/bpf/libarena/include/buddy.h new file +0
-0@@ -0,0 +1,92 @@
[ ... ]
tools/testing/selftests/bpf/libarena/include/buddy.h line 56
Quoted 4 lines
tools/testing/selftests/bpf/libarena/include/buddy.h new file +4
-0+struct buddy_header { +u32 prev_index;/* "Pointer" to the previous available allocation of the same size. */ +u32 next_index;/* Same for the next allocation. */ +};
In v4, Alexei Starovoitov asked for a mathematical analysis of the memory savings from using indices instead of pointers here:
https://lore.kernel.org/bpf/CAADnVQKnHXg0YnuLvzfXjszMaqugpMNWD5=ipffWS4GVNg6rFQ@mail.gmail.com/
The question was: "BUDDY_CHUNK_ITEMS is used like NULL? The header is u32 + u32. Is it really worth saving 8 bytes? Use two proper pointers? How many headers are there? ... if everything is a pointer the whole algorithm would be so much easier to understand. Is it worth it to keep indices vs pointers? Please do the math and explain the savings."
The rationale provided in the discussion focused on ASAN effectiveness and memory corruption detection, but didn't include the mathematical analysis of memory savings that was explicitly requested. Would it be helpful to document the quantitative analysis in the commit message or code comments to address the original question?
[ ... ]
---
AI reviewed your patch. Please fix the bug or email reply why it's not a bug.
See: https://github.com/kernel-patches/vmtest/blob/master/ci/claude/README.md
CI run summary: https://github.com/kernel-patches/bpf/actions/runs/24736048353
Emil Tsalapatis
reviewerRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
Quoted 25 lines · bot+bpf-ci
Quoted 6 lines
tools/testing/selftests/bpf/libarena/include/buddy.h new file +0
-0@@ -0,0 +1,92 @@[ ... ]
tools/testing/selftests/bpf/libarena/include/buddy.h line 56
Quoted 4 lines
tools/testing/selftests/bpf/libarena/include/buddy.h new file +4
-0+struct buddy_header { +u32 prev_index;/* "Pointer" to the previous available allocation of the same size. */ +u32 next_index;/* Same for the next allocation. */ +};In v4, Alexei Starovoitov asked for a mathematical analysis of the memory savings from using indices instead of pointers here:
https://lore.kernel.org/bpf/CAADnVQKnHXg0YnuLvzfXjszMaqugpMNWD5=ipffWS4GVNg6rFQ@mail.gmail.com/
The question was: "
BUDDY_CHUNK_ITEMSis used like NULL? The header is u32 + u32. Is it really worth saving 8 bytes? Use two proper pointers? How many headers are there? ... if everything is a pointer the whole algorithm would be so much easier to understand. Is it worth it to keep indices vs pointers? Please do the math and explain the savings."
Quoted 5 lines
The rationale provided in the discussion focused on ASAN effectiveness and memory corruption detection, but didn't include the mathematical analysis of memory savings that was explicitly requested. Would it be helpful to document the quantitative analysis in the commit message or code comments to address the original question?
No, this was resolved during discussion of the earlier version. Using pointers would mean storing the header at the very beginning of a 16 byte block and as a result defeat ASAN.
Quoted 9 lines
[ ... ]
---
AI reviewed your patch. Please fix the bug or email reply why it's not a bug.
See: https://github.com/kernel-patches/vmtest/blob/master/ci/claude/README.mdCI run summary: https://github.com/kernel-patches/bpf/actions/runs/24736048353
[email protected]
AI reviewRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
In reply to Emil TsalapatisSashiko AI review found 5 potential issue(s): - [High] Permanent physical memory leak in buddy_alloc_from_new_chunk() when allocator lock fails. - [Medium] Missing NULL pointer checks after…
Sashiko AI review found 5 potential issue(s):
- [High] Permanent physical memory leak in buddy_alloc_from_new_chunk() when allocator lock fails.
- [Medium] Missing NULL pointer checks after idx_to_header() can cause BPF program faults.
- [Medium] buddy_chunk_get() holds the global spinlock across expensive thread-local initialization, disabling preemption unnecessarily.
- [Medium] buddy_free_unlocked() lacks bounds checking, allowing arbitrary metadata corruption if given a bad pointer.
- [Medium] buddy_init() permanently leaks 1GiB of arena virtual address space on failure.
--
commit b2490ddf9769a03f5339f5d758f0fb5765e551bc
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Add buddy allocator for libarena
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Quoted 4 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +0
-0
[ ... ]
Quoted 2 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +2
-0+static buddy_chunk_t *buddy_chunk_get (buddy_t *buddy) +{
[ ... ]
Quoted 17 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +17
-0+ chunk = bpf_arena_alloc_pages(&arena, (void __arena *)vaddr, +BUDDY_CHUNK_PAGES ,NUMA_NO_NODE ,0 ); +if (!chunk) { +arena_stderr ("[ALLOC FAILED]" ); +return NULL ; + } + +if (buddy_lock (buddy)) { +/* +* We cannot reclaim the vaddr space, but that is ok - this +* operation should always succeed. The error path is to catch +* accidental deadlocks that will cause -ENOMEMs to the program as +* the allocator fails to refill itself, in which case vaddr usage +* is the least of our worries. +*/ + bpf_arena_free_pages(&arena, (void __arena *)vaddr, BUDDY_CHUNK_PAGES); +return NULL ;
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c line 438
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +10
-0+ } + +asan_poison (chunk,BUDDY_POISONED ,BUDDY_CHUNK_PAGES * __PAGE_SIZE); + +/* Unpoison the chunk itself. */ +asan_unpoison (chunk,sizeof (*chunk)); + +/* Mark all freelists as empty. */ +for (ord = zero; ord <BUDDY_CHUNK_NUM_ORDERS && can_loop; ord++) + chunk->freelists[ord] =BUDDY_CHUNK_ITEMS ;
Is it necessary to hold the global spinlock across this chunk initialization?
At this stage, the newly allocated physical chunk has not yet been linked into the globally visible buddy->first_chunk list, making it strictly thread-local.
Holding the lock here appears to unnecessarily disable preemption across these computationally expensive operations like the 1MiB memory poisoning and the unbounded while loop, while also serializing unrelated memory allocations on other CPUs.
[ ... ]
Quoted 12 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +12
-0+__weak int buddy_init(buddy_t __arg_arena *buddy) +{ +buddy_chunk_t *chunk; +int ret; + +if (!asan_ready ()) +return -EINVAL ; + +/* Reserve enough address space to ensure allocations are aligned. */ + ret =buddy_reserve_arena_vaddr (buddy); +if (ret) +return ret;
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c line 585
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +10
-0+ +_Static_assert (BUDDY_CHUNK_PAGES >0 , +"chunk must use one or more pages" ); + + chunk =buddy_chunk_get (buddy); + +if (buddy_lock (buddy)) { +bpf_arena_free_pages (&arena, chunk,BUDDY_CHUNK_PAGES ); +return -EINVAL ; + }
Does this leak the 1GiB of arena virtual address space if the initial chunk allocation fails or if the lock cannot be acquired?
If buddy_chunk_get() returns NULL due to memory pressure, or if buddy_lock() fails, the function returns an error without calling buddy_unreserve_arena_vaddr().
If the calling program handles the error and retries initialization, this could leak an additional 1GiB per attempt, rapidly exhausting the BPF arena's maximum 4GiB virtual address space.
[ ... ]
Quoted 2 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +2
-0+__weak u64 buddy_chunk_alloc(buddy_chunk_t __arg_arena *chunk, int order_req) +{
[ ... ]
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c line 660
Quoted 11 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +11
-0+ retidx = chunk->freelists[order]; + header =idx_to_header (chunk, retidx); +if (unlikely (!header)) +return (u64 )NULL ; + + chunk->freelists[order] = header->next_index; + +if (header->next_index !=BUDDY_CHUNK_ITEMS ) { + next_header =idx_to_header (chunk, header->next_index); + next_header->prev_index =BUDDY_CHUNK_ITEMS ; + }
Could next_header be NULL here?
The idx_to_header() function is designed to return NULL if an index is invalid or the block is improperly marked as allocated.
If the allocator state becomes corrupted and next_header is NULL, the subsequent dereference would cause a NULL pointer dereference within the arena, leading the BPF exception handler to terminate the program instead of returning an error gracefully.
[ ... ]
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c line 736
Quoted 6 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +6
-0+static u64 buddy_alloc_from_new_chunk (buddy_t *buddy,buddy_chunk_t *chunk,int order) +{ +u64 address; + +if (buddy_lock (buddy)) +return (u64 )NULL ;
Does this leak the newly allocated physical chunk if the lock fails?
The chunk passed to this function was newly allocated via buddy_chunk_get(). If the spinlock fails, the function returns NULL and the chunk pointer is dropped without being linked into buddy->first_chunk or freed via bpf_arena_free_pages().
This results in a permanent 1MiB physical memory leak per lock acquisition failure.
[ ... ]
Quoted 13 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +13
-0+static __always_inline int buddy_free_unlocked(buddy_t *buddy, u64 addr) +{ +buddy_header_t *header, *buddy_header; +u64 idx, buddy_idx, tmp_idx; +buddy_chunk_t *chunk; +bool allocated; +u8 order; +int ret; + +if (!buddy) +return -EINVAL ; + +if (addr & (BUDDY_MIN_ALLOC_BYTES -1 )) {
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c line 822
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +10
-0+arena_stderr ("Freeing unaligned address %llx\n" , addr); +return -EINVAL ; + } + +/* Get (chunk, idx) out of the address. */ + chunk = (void __arena *)(addr & ~BUDDY_CHUNK_OFFSET_MASK); + idx = (addr &BUDDY_CHUNK_OFFSET_MASK ) /BUDDY_MIN_ALLOC_BYTES ; + +/* Mark the block as unallocated so we can access the header. */ + ret =idx_set_allocated (chunk, idx, false);
Are we missing bounds checking on the block index here?
The first sizeof(buddy_chunk_t) bytes of each 1MiB chunk are reserved for internal metadata and permanently marked as allocated.
If a BPF program accidentally frees a pointer pointing into the metadata, it appears the allocator will successfully free its own internal tracking structures since it blindly marks the block as free with idx_set_allocated() without verifying that the index falls outside the reserved metadata area.
This would allow unintentional total corruption of the allocator's internal state, coalescing metadata blocks and handing them out to future malloc() callers.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=6
Re: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
In reply to Emil TsalapatisQuoted 7 lines · Emil Tsalapatis
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Signed-off-by Emil Tsalapatis <[email protected]>
The implementation of this BPF arena backed buddy allocator looks rather solid. I noticed that we have a single global lock being used here to synchronize metadata structure modifications. Have you thought about how this might be a high contention point, particularly when dealing with systems with incredibly high CPU core counts? Did you consider possibly making use of localized per-CPU caches for the most common/small allocation sizes or something like that? This is something that definitely crossed my mind when I was initially thinking about implementing something like this a while back. I understand that this is an initial implementation, so it doesn't necessarily carry all the bells and whistles, but I was curious to know whether this had also crossed your mind and what your thoughts were on it.
Quoted 1,088 lines
--- tools/testing/selftests/bpf/libarena/Makefile | 2 + .../selftests/bpf/libarena/include/buddy.h | 92 ++ .../selftests/bpf/libarena/include/common.h | 14 + .../bpf/libarena/selftests/selftest.c | 1 + .../selftests/bpf/libarena/src/buddy.bpf.c | 903 ++++++++++++++++++ .../selftests/bpf/libarena/src/common.bpf.c | 23 + 6 files changed, 1035 insertions(+) create mode 100644 tools/testing/selftests/bpf/libarena/include/buddy.h create mode 100644 tools/testing/selftests/bpf/libarena/src/buddy.bpf.ctools/testing/selftests/bpf/libarena/Makefile +2
-0@@ -51,6 +51,8 @@ ASAN_FLAGS += -mllvm -asan-destructor-kind=none override BPF_CFLAGS += -DENABLE_ATOMICS_TESTS override BPF_CFLAGS += -O2 -g override BPF_CFLAGS += -Wno-incompatible-pointer-types-discards-qualifiers +# Required to define our own arena-based free() +override BPF_CFLAGS += -Wno-incompatible-library-redeclaration # Required for suppressing harmless vmlinux.h-related warnings. override BPF_CFLAGS += -Wno-missing-declarations override BPF_CFLAGS += $(INCLUDES)tools/testing/selftests/bpf/libarena/include/buddy.h new file +92
-0@@ -0,0 +1,92 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#pragma once + +struct buddy_chunk ; +typedef struct buddy_chunk __arena buddy_chunk_t; + +struct buddy_header ; +typedef struct buddy_header __arena buddy_header_t; + +enum buddy_consts { +/* +* Minimum allocation is 1 << BUDDY_MIN_ALLOC_SHIFT. +* Larger sizes increase internal fragmentation, but smaller +* sizes increase the space overhead of the block metadata. +*/ +BUDDY_MIN_ALLOC_SHIFT =4 , +BUDDY_MIN_ALLOC_BYTES =1 <<BUDDY_MIN_ALLOC_SHIFT , + +/* +* How many orders the buddy allocator can serve. Minimum block +* size is 1 << BUDDY_MIN_ALLOC_SHIFT, maximum block size is +* 1 << (BUDDY_MIN_ALLOC_SHIFT + BUDDY_CHUNK_NUM_ORDERS - 1): +* Each block has size 1 << BUDDY_MIN_ALLOC_SHIFT, and the +* allocation orders are in [0, BUDDY_CHUNK_NUM_ORDERS). +* We keep two blocks of the maximum size to retain the +* property in the code that all blocks have a buddy. +* Higher values increase the maximum allocation size, +* but also the size of the metadata for each block. +*/ +BUDDY_CHUNK_NUM_ORDERS =1 <<4 , +BUDDY_CHUNK_BYTES =BUDDY_MIN_ALLOC_BYTES << (BUDDY_CHUNK_NUM_ORDERS ), + +/* Offset of the buddy header within a free block, see buddy.bpf.c for details */ +BUDDY_HEADER_OFF =8 , + +/* The maximum number of blocks a chunk may have to track. */ +BUDDY_CHUNK_ITEMS =1 << (BUDDY_CHUNK_NUM_ORDERS ), +BUDDY_CHUNK_OFFSET_MASK =BUDDY_CHUNK_BYTES -1 , + +/* +* Alignment for chunk allocations based on bpf_arena_alloc_pages. +* The arena allocation kfunc does not have an alignment argument, +* but that is required for all block calculations in the chunk to +* work. +*/ +BUDDY_VADDR_OFFSET =BUDDY_CHUNK_BYTES , + +/* Total arena virtual address space the allocator can consume. */ +BUDDY_VADDR_SIZE =BUDDY_CHUNK_BYTES <<10 +}; + +struct buddy_header { +u32 prev_index;/* "Pointer" to the previous available allocation of the same size. */ +u32 next_index;/* Same for the next allocation. */ +}; + +/* +* We bring memory into the allocator 1 MiB at a time. +*/ +struct buddy_chunk { +/* The order of the current allocation for a item. 4 bits per order. */ +u8 orders[BUDDY_CHUNK_ITEMS /2 ]; +/* +* Bit to denote whether chunk is allocated. Size of the allocated/free +* chunk found from the orders array. +*/ +u8 allocated[BUDDY_CHUNK_ITEMS /8 ]; +/* Freelists for O(1) allocation. */ +u64 freelists[BUDDY_CHUNK_NUM_ORDERS ]; +buddy_chunk_t *next; +}; + +struct buddy { +buddy_chunk_t *first_chunk;/* Pointer to the chunk linked list. */ +arena_spinlock_t lock;/* Allocator lock */ +u64 vaddr;/* Allocation into reserved vaddr */ +}; + +typedef struct buddy __arena buddy_t; + +#ifdef __BPF__ + +int buddy_init (buddy_t *buddy); +int buddy_destroy (buddy_t *buddy); +int buddy_free_internal (buddy_t *buddy,u64 free); +#define buddy_free (buddy, ptr) buddy_free_internal((buddy), (u64)(ptr)) +u64 buddy_alloc_internal (buddy_t *buddy,size_t size); +#define buddy_alloc (alloc, size) ((void __arena *)buddy_alloc_internal((alloc), (size))) + + +#endif /* __BPF__ */ tools/testing/selftests/bpf/libarena/include/common.h +14
-0@@ -42,6 +42,20 @@ extern volatile u64 asan_violated;int arena_fls (__u64 word); +u64 malloc_internal (size_t size); +#define malloc (size) ((void __arena *)malloc_internal((size))) +void free(void __arena *ptr); + +/* +* The verifier associates arenas with programs by checking LD.IMM +* instruction operands for an arena and populating the program state +* with the first instance it finds. This requires accessing our global +* arena variable, but subprogs do not necessarily do so while still +* using pointers from that arena. Insert an LD.IMM instruction to +* access the arena and help the verifier. +*/ +#define arena_subprog_init () do { asm volatile ("" :: "r"(&arena)); } while (0) +#else /* ! __BPF__ */ #include <stdint.h> tools/testing/selftests/bpf/libarena/selftests/selftest.c +1
-0@@ -17,6 +17,7 @@#include <common.h> #include <asan.h> +#include <buddy.h> #include <selftest_helpers.h> #ifdef BPF_ARENA_ASAN tools/testing/selftests/bpf/libarena/src/buddy.bpf.c new file +902
-0@@ -0,0 +1,903 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ + +#include <common.h> +#include <asan.h> +#include <buddy.h> + +/* +* Buddy allocator arena-based implementation. +* +* Memory is organized into chunks. These chunks +* cannot be coalesced or split. Allocating +* chunks allocates their memory eagerly. +* +* Internally, each chunk is organized into blocks. +* Blocks _can_ be coalesced/split, but only inside +* the chunk. Each block can be allocated or +* unallocated. If allocated, the entire block holds +* user data. If unallocated, the block is mostly +* invalid memory, with the exception of a header +* used for freelist tracking. +* +* The header is placed at an offset inside the block +* to prevent off-by-one errors from the previous block +* from trivially overwriting the header. Such an error +* is also not catchable by ASAN, since the header remains +* valid memory even after the block is freed. It is still +* theoretically possible for the header to be corrupted +* without being caught by ASAN, but harder. +* +* Since the allocator needs to track order information for +* both allocated and free blocks, and allocated blocks cannot +* store a header, the allocator also stores per-chunk order +* information in a reserved region at the beginning of the +* chunk. The header includes a bitmap with the order of blocks +* and their allocation state. It also includes the freelist +* heads for the allocation itself. +*/ + +enum { +BUDDY_POISONED = (s8 )0xef , + +/* Number of pages to be allocated per chunk. */ +BUDDY_CHUNK_PAGES =BUDDY_CHUNK_BYTES / __PAGE_SIZE +}; + +static inline int buddy_lock (buddy_t *buddy) +{ +return arena_spin_lock (&buddy->lock); +} + +static inline void buddy_unlock (buddy_t *buddy) +{ +arena_spin_unlock (&buddy->lock); +} + +/* +* Reserve part of the arena address space for the allocator. We use +* this to get aligned addresses for the chunks, since the arena +* page alloc kfuncs do not support aligning to a boundary (in this +* case 1 MiB, see buddy.h on how this is derived). +*/ +static int buddy_reserve_arena_vaddr (buddy_t *buddy) +{ + buddy->vaddr =0 ; + +return bpf_arena_reserve_pages (&arena, + (void __arena *)BUDDY_VADDR_OFFSET, +BUDDY_VADDR_SIZE / __PAGE_SIZE); +} + +/* +* Free up any unused address space. Used only during teardown. +*/ +static void buddy_unreserve_arena_vaddr (buddy_t *buddy) +{ +bpf_arena_free_pages ( + &arena, (void __arena *)(BUDDY_VADDR_OFFSET + buddy->vaddr), + (BUDDY_VADDR_SIZE - buddy->vaddr) / __PAGE_SIZE); + + buddy->vaddr =0 ; +} + +/* +* Carve out part of the reserved address space and hand it over +* to the buddy allocator. +* +* We are assuming the buddy allocator is the only allocator in the +* system, so there is no race between this function reserving a +* page range and some other allocator actually making the BPF call +* to really create and reserve it. +* +* However, bump allocation must still be atomic because this function +* is called without the buddy lock from multiple threads concurrently. +*/ +__weak int buddy_alloc_arena_vaddr(buddy_t __arg_arena *buddy, u64 *vaddrp) +{ +u64 vaddr, old, new; + +if (!buddy || !vaddrp) +return -EINVAL ; + +do { + vaddr = buddy->vaddr; + new = vaddr +BUDDY_CHUNK_BYTES ; + +if (new >BUDDY_VADDR_SIZE ) +return -EINVAL ; + + old =__sync_val_compare_and_swap (&buddy->vaddr, vaddr, new); + }while (old != vaddr && can_loop); + +if (old != vaddr) +return -EINVAL ; + + *vaddrp =BUDDY_VADDR_OFFSET + vaddr; + +return 0 ; +} + +static u64 arena_next_pow2 (__u64 n) +{ + n--; + n |= n >>1 ; + n |= n >>2 ; + n |= n >>4 ; + n |= n >>8 ; + n |= n >>16 ; + n |= n >>32 ; + n++; + +return n; +} + +__weak +int idx_set_allocated(buddy_chunk_t __arg_arena *chunk, u64 idx, bool allocated) +{ +bool already_allocated; + +if (unlikely (idx >=BUDDY_CHUNK_ITEMS )) { +arena_stderr ("setting state of invalid idx (%ld, max %d)\n" , idx, +BUDDY_CHUNK_ITEMS ); +return -EINVAL ; + } + + already_allocated = chunk->allocated[idx /8 ] & (1 << (idx %8 )); +if (unlikely (already_allocated == allocated)) { +arena_stderr ("Double %s of idx %ld for chunk %p" , + allocated ?"alloc" :"free" , + idx, chunk); +return -EINVAL ; + } + +if (allocated) + chunk->allocated[idx /8 ] |=1 << (idx %8 ); +else + chunk->allocated[idx /8 ] &= ~(1 << (idx %8 )); + +return 0 ; +} + +static int idx_is_allocated (buddy_chunk_t *chunk,u64 idx,bool *allocated) +{ +if (unlikely (idx >=BUDDY_CHUNK_ITEMS )) { +arena_stderr ("getting state of invalid idx (%llu, max %d)\n" , idx, +BUDDY_CHUNK_ITEMS ); +return -EINVAL ; + } + + *allocated = chunk->allocated[idx /8 ] & (1 << (idx %8 )); +return 0 ; +} + +__weak +int idx_set_order(buddy_chunk_t __arg_arena *chunk, u64 idx, u8 order) +{ +u8 prev_order; + +if (unlikely (order >=BUDDY_CHUNK_NUM_ORDERS )) { +arena_stderr ("setting invalid order %u\n" , order); +return -EINVAL ; + } + +if (unlikely (idx >=BUDDY_CHUNK_ITEMS )) { +arena_stderr ("setting order of invalid idx (%d, max %d)\n" , idx, +BUDDY_CHUNK_ITEMS ); +return -EINVAL ; + } + +/* +* We store two order instances per byte, one per nibble. +* Retain the existing nibble. +*/ + prev_order = chunk->orders[idx /2 ]; +if (idx &0x1 ) { + order &=0xf ; + order |= (prev_order &0xf0 ); + }else { + order <<=4 ; + order |= (prev_order &0xf ); + } + + chunk->orders[idx /2 ] = order; + +return 0 ; +} + +static u8 idx_get_order (buddy_chunk_t *chunk,u64 idx) +{ +u8 result; + +_Static_assert (BUDDY_CHUNK_NUM_ORDERS <=16 , +"order must fit in 4 bits" ); + +if (unlikely (idx >=BUDDY_CHUNK_ITEMS )) { +arena_stderr ("getting order of invalid idx %u\n" , idx); +return BUDDY_CHUNK_NUM_ORDERS ; + } + + result = chunk->orders[idx /2 ]; + +return (idx &0x1 ) ? (result &0xf ) : (result >>4 ); +} + +static void __arena *idx_to_addr(buddy_chunk_t *chunk, size_t idx) +{ +u64 address; + +if (unlikely (idx >=BUDDY_CHUNK_ITEMS )) { +arena_stderr ("translating invalid idx %u\n" , idx); +return NULL ; + } + +/* +* The data blocks start in the chunk after the metadata block. +* We find the actual address by indexing into the region at an +* BUDDY_MIN_ALLOC_BYTES granularity, the minimum allowed. +* The index number already accounts for the fact that the first +* blocks in the chunk are occupied by the metadata, so we do +* not need to offset it. +*/ + + address = (u64 )chunk + (idx *BUDDY_MIN_ALLOC_BYTES ); + + return (void __arena *)address; +} + +static buddy_header_t *idx_to_header (buddy_chunk_t *chunk,size_t idx) +{ +bool allocated; +u64 address; + +if (unlikely (idx_is_allocated (chunk, idx, &allocated))) { +arena_stderr ("accessing invalid idx 0x%lx\n" , idx); +return NULL ; + } + +if (unlikely (allocated)) { +arena_stderr ("accessing allocated idx 0x%lx as header\n" , idx); +return NULL ; + } + + address = (u64 )idx_to_addr (chunk, idx); +if (!address) +return NULL ; + +/* +* Offset the header within the block. This avoids accidental overwrites +* to the header because of off-by-one errors when using adjacent blocks. +* +* The offset has been chosen as a compromise between ASAN effectiveness +* and allocator granularity: +* 1) ASAN dictates valid data runs are 8-byte aligned. +* 2) We want to keep a low minimum allocation size (currently 16). +* +* As a result, we have only two possible positions for the header: Bytes +* 0 and 8. Keeping the header in byte 0 means off-by-ones from the previous +* block touch the header, and, since the header must be accessible, ASAN +* will not trigger. Keeping the header on byte 8 means off-by-one errors from +* the previous block are caught by ASAN. Negative offsets are rarer, so +* while accesses into the block from the next block are possible, they are +* less probable. +*/ + +return (buddy_header_t *)(address +BUDDY_HEADER_OFF ); +} + +static void header_add_freelist (buddy_chunk_t *chunk,buddy_header_t *header, +u64 idx,u8 order) +{ +buddy_header_t *tmp_header; + +idx_set_order (chunk, idx, order); + + header->next_index = chunk->freelists[order]; + header->prev_index =BUDDY_CHUNK_ITEMS ; + +if (header->next_index !=BUDDY_CHUNK_ITEMS ) { + tmp_header =idx_to_header (chunk, header->next_index); + tmp_header->prev_index = idx; + } + + chunk->freelists[order] = idx; +} + +static void header_remove_freelist (buddy_chunk_t *chunk, +buddy_header_t *header,u8 order) +{ +buddy_header_t *tmp_header; + +if (header->prev_index !=BUDDY_CHUNK_ITEMS ) { + tmp_header =idx_to_header (chunk, header->prev_index); + tmp_header->next_index = header->next_index; + } + +if (header->next_index !=BUDDY_CHUNK_ITEMS ) { + tmp_header =idx_to_header (chunk, header->next_index); + tmp_header->prev_index = header->prev_index; + } + +/* Pop off the list head if necessary. */ +if (idx_to_header (chunk, chunk->freelists[order]) == header) + chunk->freelists[order] = header->next_index; + + header->prev_index =BUDDY_CHUNK_ITEMS ; + header->next_index =BUDDY_CHUNK_ITEMS ; +} + +static u64 size_to_order (size_t size) +{ +u64 order; + +/* +* Legal sizes are [1, 4GiB] (the biggest possible arena). +* Of course, sizes close to GiB are practically impossible +* to fulfill and allocation will fail, but that's taken care +* of by the caller. +*/ + +if (unlikely (size ==0 || size > (1UL <<32 ))) { +arena_stderr ("illegal size request %lu\n" , size); +return 64 ; + } +/* +* To find the order of the allocation we find the first power of two +* >= the requested size, take the log2, then adjust it for the minimum +* allocation size by removing the minimum shift from it. Requests +* smaller than the minimum allocation size are rounded up. +*/ + order =arena_fls (arena_next_pow2 (size)) -1 ; +if (order <BUDDY_MIN_ALLOC_SHIFT ) +return 0 ; + +return order -BUDDY_MIN_ALLOC_SHIFT ; +} + +__weak +int add_leftovers_to_freelist(buddy_chunk_t __arg_arena *chunk, u32 cur_idx, +u64 min_order,u64 max_order) +{ +buddy_header_t *header; +u64 ord; +u32 idx; + +for (ord = min_order; ord < max_order && can_loop; ord++) { +/* Mark the buddy as free and add it to the freelists. */ + idx = cur_idx + (1 << ord); + + header =idx_to_header (chunk, idx); +if (unlikely (!header)) { +arena_stderr ("idx %u has no header" , idx); +return -EINVAL ; + } + +asan_unpoison (header,sizeof (*header)); + +header_add_freelist (chunk, header, idx, ord); + } + +return 0 ; +} + +static buddy_chunk_t *buddy_chunk_get (buddy_t *buddy) +{ +u64 order, ord, min_order, max_order; +buddy_chunk_t *chunk; +size_t left; +int power2; +u64 vaddr; +u32 idx; +int ret; + +/* +* Step 1: Allocate a properly aligned chunk, and +* prep it for insertion into the buddy allocator. +* We don't need the allocator lock until step 2. +*/ + + ret =buddy_alloc_arena_vaddr (buddy, &vaddr); +if (ret) +return NULL ; + +/* Addresses must be aligned to the chunk boundary. */ +if (vaddr %BUDDY_CHUNK_BYTES ) +return NULL ; + +/* Unreserve the address space. */ + bpf_arena_free_pages(&arena, (void __arena *)vaddr, +BUDDY_CHUNK_PAGES ); + + chunk = bpf_arena_alloc_pages(&arena, (void __arena *)vaddr, +BUDDY_CHUNK_PAGES ,NUMA_NO_NODE ,0 ); +if (!chunk) { +arena_stderr ("[ALLOC FAILED]" ); +return NULL ; + } + +if (buddy_lock (buddy)) { +/* +* We cannot reclaim the vaddr space, but that is ok - this +* operation should always succeed. The error path is to catch +* accidental deadlocks that will cause -ENOMEMs to the program as +* the allocator fails to refill itself, in which case vaddr usage +* is the least of our worries. +*/ + bpf_arena_free_pages(&arena, (void __arena *)vaddr, BUDDY_CHUNK_PAGES); +return NULL ; + } + +asan_poison (chunk,BUDDY_POISONED ,BUDDY_CHUNK_PAGES * __PAGE_SIZE); + +/* Unpoison the chunk itself. */ +asan_unpoison (chunk,sizeof (*chunk)); + +/* Mark all freelists as empty. */ +for (ord = zero; ord <BUDDY_CHUNK_NUM_ORDERS && can_loop; ord++) + chunk->freelists[ord] =BUDDY_CHUNK_ITEMS ; + +/* +* Initialize the chunk by carving out a page range to hold the metadata +* struct above, then dumping the rest of the pages into the allocator. +*/ + +_Static_assert (BUDDY_CHUNK_PAGES * __PAGE_SIZE >= +BUDDY_MIN_ALLOC_BYTES * +BUDDY_CHUNK_ITEMS , +"chunk must fit within the allocation" ); + +/* +* Step 2: Reserve a chunk for the chunk metadata, then breaks +* the rest of the full allocation into the different buckets. +* We allocating the memory by grabbing blocks of progressively +* smaller sizes from the allocator, which are guaranteed to be +* continuous. +* +* This operation also populates the allocator. +* +* Algorithm: +* +* - max_order: The last order allocation we made +* - left: How many bytes are left to allocate +* - cur_index: Current index into the top-level block we are +* allocating from. +* +* Step 3: +* - Find the largest power-of-2 allocation still smaller than left (infimum) +* - Reserve a chunk of that size, along with its buddy +* - For every order from [infimum + 1, last order), carve out a block +* and put it into the allocator. +* +* Example: Chunk size 0b1010000 (80 bytes) +* +* Step 1: +* +* idx infimum 1 << max_order +* 0 64 128 1 << 20 +* |________|_________|______________________| +* +* Blocks set aside: +* [0, 64) - Completely allocated +* [64, 128) - Will be further split in the next iteration +* +* Blocks added to the allocator: +* [128, 256) +* [256, 512) +* ... +* [1 << 18, 1 << 19) +* [1 << 19, 1 << 20) +* +* Step 2: +* +* idx infimum idx + 1 << max_order +* 64 80 96 64 + 1 << 6 = 128 +* |________|_________|______________________| +* +* Blocks set aside: +* [64, 80) - Completely allocated +* +* Blocks added to the allocator: +* [80, 96) - left == 0 so the buddy is unused and marked as freed +* [96, 128) +*/ + max_order =BUDDY_CHUNK_NUM_ORDERS ; + left =sizeof (*chunk); + idx =0 ; +while (left && can_loop) { + power2 =arena_fls (left) -1 ; +/* +* Note: The condition below only triggers to catch serious bugs +* early. There is no sane way to undo any block insertions from +* the allocated chunk, so just leak any leftover allocations, +* emit a diagnostic, unlock and exit. +* +*/ +if (unlikely (power2 >=BUDDY_CHUNK_NUM_ORDERS )) { +arena_stderr ( +"buddy chunk metadata require allocation of order %d\n" , + power2); +arena_stderr ( +"chunk has size of 0x%lx bytes (left %lx bytes)\n" , +sizeof (*chunk), left); +buddy_unlock (buddy); + +return NULL ; + } + +/* Round up allocations that are too small. */ + + left -= (power2 >=BUDDY_MIN_ALLOC_SHIFT ) ?1 << power2 : left; + order = (power2 >=BUDDY_MIN_ALLOC_SHIFT ) ? power2 -BUDDY_MIN_ALLOC_SHIFT :0 ; + +if (idx_set_allocated (chunk, idx, true)) { +buddy_unlock (buddy); +return NULL ; + } + +/* +* Starting an order above the one we allocated, populate +* the allocator with free blocks. If this is the last +* allocation (left == 0), also mark the buddy as free. +* +* See comment above about error handling: The error path +* is only there as a way to mitigate deeply buggy allocator +* states by emitting a diagnostic in add_leftovers_to_freelist() +* and leaking any memory not added in the freelists. +*/ + min_order = left ? order +1 : order; +if (add_leftovers_to_freelist (chunk, idx, min_order, max_order)) { +buddy_unlock (buddy); +return NULL ; + } + +/* Adjust the index. */ + idx +=1 << order; + max_order = order; + } + +buddy_unlock (buddy); + +return chunk; +} + +__weak int buddy_init(buddy_t __arg_arena *buddy) +{ +buddy_chunk_t *chunk; +int ret; + +if (!asan_ready ()) +return -EINVAL ; + +/* Reserve enough address space to ensure allocations are aligned. */ + ret =buddy_reserve_arena_vaddr (buddy); +if (ret) +return ret; + +_Static_assert (BUDDY_CHUNK_PAGES >0 , +"chunk must use one or more pages" ); + + chunk =buddy_chunk_get (buddy); + +if (buddy_lock (buddy)) { +bpf_arena_free_pages (&arena, chunk,BUDDY_CHUNK_PAGES ); +return -EINVAL ; + } + +/* Chunk is already properly unpoisoned if allocated. */ +if (chunk) + chunk->next = buddy->first_chunk; + +/* Put the chunk at the beginning of the list. */ + buddy->first_chunk = chunk; + +buddy_unlock (buddy); + +return chunk ?0 : -ENOMEM ; +} + +/* +* Destroy the allocator. This does not check whether there are any allocations +* currently in use, so any pages being accessed will start taking arena faults. +* We do not take a lock because we are freeing arena pages, and nobody should +* be using the allocator at that point in the execution. +*/ +__weak int buddy_destroy(buddy_t __arg_arena *buddy) +{ +buddy_chunk_t *chunk, *next; + +if (!buddy) +return -EINVAL ; + +/* +* Traverse all buddy chunks and free them back to the arena +* with the same granularity they were allocated with. +*/ +for (chunk = buddy->first_chunk; chunk && can_loop; chunk = next) { + next = chunk->next; + +/* Wholesale poison the entire block. */ +asan_poison (chunk,BUDDY_POISONED , +BUDDY_CHUNK_PAGES * __PAGE_SIZE); +bpf_arena_free_pages (&arena, chunk,BUDDY_CHUNK_PAGES ); + } + +/* Free up any part of the address space that did not get used. */ +buddy_unreserve_arena_vaddr (buddy); + +/* Clear all fields. */ + buddy->first_chunk =NULL ; + +return 0 ; +} + +__weak u64 buddy_chunk_alloc(buddy_chunk_t __arg_arena *chunk, int order_req) +{ +buddy_header_t *header, *tmp_header, *next_header; +u32 idx, tmpidx, retidx; +u64 address; +u64 order =0 ; +u64 i; + +for (order = order_req; order <BUDDY_CHUNK_NUM_ORDERS && can_loop; order++) { +if (chunk->freelists[order] !=BUDDY_CHUNK_ITEMS ) +break ; + } + +if (order >=BUDDY_CHUNK_NUM_ORDERS ) +return (u64 )NULL ; + + retidx = chunk->freelists[order]; + header =idx_to_header (chunk, retidx); +if (unlikely (!header)) +return (u64 )NULL ; + + chunk->freelists[order] = header->next_index; + +if (header->next_index !=BUDDY_CHUNK_ITEMS ) { + next_header =idx_to_header (chunk, header->next_index); + next_header->prev_index =BUDDY_CHUNK_ITEMS ; + } + + header->prev_index =BUDDY_CHUNK_ITEMS ; + header->next_index =BUDDY_CHUNK_ITEMS ; +if (idx_set_order (chunk, retidx, order_req)) +return (u64 )NULL ; + +if (idx_set_allocated (chunk, retidx, true)) +return (u64 )NULL ; + +/* +* Do not unpoison the address yet, will be done by the caller +* because the caller has the exact allocation size requested. +*/ + address = (u64 )idx_to_addr (chunk, retidx); +if (!address) +return (u64 )NULL ; + +/* If we allocated from a larger-order chunk, split the buddies. */ +for (i = order_req; i < order && can_loop; i++) { +/* +* Flip the bit for the current order (the bit is guaranteed +* to be 0, so just add 1 << i). +*/ + idx = retidx + (1 << i); + +/* Add the buddy of the allocation to the free list. */ + header =idx_to_header (chunk, idx); +/* Unpoison the buddy header */ +asan_unpoison (header,sizeof (*header)); + +if (idx_set_order (chunk, idx, i)) +return (u64 )NULL ; + +/* Push the header to the beginning of the freelists list. */ + tmpidx = chunk->freelists[i]; + + header->prev_index =BUDDY_CHUNK_ITEMS ; + header->next_index = tmpidx; + +if (tmpidx !=BUDDY_CHUNK_ITEMS ) { + tmp_header =idx_to_header (chunk, tmpidx); + tmp_header->prev_index = idx; + } + + chunk->freelists[i] = idx; + } + +return address; +} + +/* Scan the existing chunks for available memory. */ +static u64 buddy_alloc_from_existing_chunks (buddy_t *buddy,int order) +{ +buddy_chunk_t *chunk; +u64 address; + +for (chunk = buddy->first_chunk; chunk !=NULL && can_loop; + chunk = chunk->next) { + address =buddy_chunk_alloc (chunk, order); +if (address) +return address; + } + +return (u64 )NULL ; +} + +/* +* Try an allocation from a newly allocated chunk. Also +* incorporate the chunk into the linked list. +*/ +static u64 buddy_alloc_from_new_chunk (buddy_t *buddy,buddy_chunk_t *chunk,int order) +{ +u64 address; + +if (buddy_lock (buddy)) +return (u64 )NULL ; + + +/* +* Add the chunk into the allocator and try +* to allocate specifically from that chunk. +*/ + chunk->next = buddy->first_chunk; + buddy->first_chunk = chunk; + + address =buddy_chunk_alloc (buddy->first_chunk, order); + +buddy_unlock (buddy); + +return (u64 )address; +} +__weak +u64 buddy_alloc_internal(buddy_t __arg_arena *buddy, size_t size) +{ +buddy_chunk_t *chunk; +u64 address = (u64 )NULL ; +int order; + +if (!buddy) +return (u64 )NULL ; + + order =size_to_order (size); +if (order >=BUDDY_CHUNK_NUM_ORDERS || order <0 ) { +arena_stderr ("invalid order %d (sz %lu)\n" , order, size); +return (u64 )NULL ; + } + +if (buddy_lock (buddy)) +return (u64 )NULL ; + + address =buddy_alloc_from_existing_chunks (buddy, order); +buddy_unlock (buddy); +if (address) + goto done; + +/* Get a new chunk. */ + chunk =buddy_chunk_get (buddy); +if (chunk) + address =buddy_alloc_from_new_chunk (buddy, chunk, order); + +done: +/* If we failed to allocate memory, return NULL. */ +if (!address) +return (u64 )NULL ; + +/* +* Unpoison exactly the amount of bytes requested. If the +* data is smaller than the header, we must poison any +* unused bytes that were part of the header. +*/ +if (size <BUDDY_HEADER_OFF +sizeof (buddy_header_t)) + asan_poison((u8 __arena *)address + BUDDY_HEADER_OFF, +BUDDY_POISONED ,sizeof (buddy_header_t)); + + asan_unpoison((u8 __arena *)address, size); + +return address; +} + +static __always_inline int buddy_free_unlocked(buddy_t *buddy, u64 addr) +{ +buddy_header_t *header, *buddy_header; +u64 idx, buddy_idx, tmp_idx; +buddy_chunk_t *chunk; +bool allocated; +u8 order; +int ret; + +if (!buddy) +return -EINVAL ; + +if (addr & (BUDDY_MIN_ALLOC_BYTES -1 )) { +arena_stderr ("Freeing unaligned address %llx\n" , addr); +return -EINVAL ; + } + +/* Get (chunk, idx) out of the address. */ + chunk = (void __arena *)(addr & ~BUDDY_CHUNK_OFFSET_MASK); + idx = (addr &BUDDY_CHUNK_OFFSET_MASK ) /BUDDY_MIN_ALLOC_BYTES ; + +/* Mark the block as unallocated so we can access the header. */ + ret =idx_set_allocated (chunk, idx, false); +if (ret) +return ret; + + order =idx_get_order (chunk, idx); + header =idx_to_header (chunk, idx); + +/* The header is in the block itself, keep it unpoisoned. */ + asan_poison((u8 __arena *)addr, BUDDY_POISONED, + BUDDY_MIN_ALLOC_BYTES << order); +asan_unpoison (header,sizeof (*header)); + +/* +* Coalescing loop. Merge with free buddies of equal order. +* For every coalescing step, keep the left buddy and +* drop the right buddy's header. +*/ +for (; order <BUDDY_CHUNK_NUM_ORDERS && can_loop; order++) { + buddy_idx = idx ^ (1 << order); + +/* Check if the buddy is actually free. */ +idx_is_allocated (chunk, buddy_idx, &allocated); +if (allocated) +break ; + +/* +* If buddy is not the same order as the chunk +* being freed, then we're done coalescing. +*/ +if (idx_get_order (chunk, buddy_idx) != order) +break ; + + buddy_header =idx_to_header (chunk, buddy_idx); +header_remove_freelist (chunk, buddy_header, order); + +/* Keep the left header out of the two buddies, drop the other one. */ +if (buddy_idx < idx) { + tmp_idx = idx; + idx = buddy_idx; + buddy_idx = tmp_idx; + } + +/* Remove the buddy from the freelists so that we can merge it. */ +idx_set_order (chunk, buddy_idx, order); + + buddy_header =idx_to_header (chunk, buddy_idx); +asan_poison (buddy_header,BUDDY_POISONED , +sizeof (*buddy_header)); + } + +/* Header properly freed but not in any freelists yet .*/ +idx_set_order (chunk, idx, order); + + header =idx_to_header (chunk, idx); +header_add_freelist (chunk, header, idx, order); + +return 0 ; +} + +__weak int buddy_free_internal(buddy_t __arg_arena *buddy, u64 addr) +{ +int ret; + +if (!buddy) +return -EINVAL ; + +/* Freeing NULL is a valid no-op. */ +if (!addr) +return 0 ; + + ret =buddy_lock (buddy); +if (ret) +return ret; + + ret =buddy_free_unlocked (buddy, addr); + +buddy_unlock (buddy); + +return ret; +} + +__weak char _license[] SEC("license") = "GPL";tools/testing/selftests/bpf/libarena/src/common.bpf.c +4
-0@@ -1,11 +1,15 @@// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause /* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ #include <common.h> +#include <asan.h> +#include <buddy.h> #include <asan.h> const volatile u32 zero =0 ; +buddy_t buddy; +/* How many pages do we reserve at the beginning of the arena segment? */ #define RESERVE_ALLOC (8)
tools/testing/selftests/bpf/libarena/src/common.bpf.c __weak int arena_alloc_reserve(void) · line 74
Quoted 10 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c +7
-0@@ -61,4 +65,23 @@ __weak int arena_alloc_reserve(void)return bpf_arena_reserve_pages (&arena,NULL ,RESERVE_ALLOC ); } +SEC("syscall") +__weak int arena_buddy_reset (void ) +{ +buddy_destroy (&buddy); + +return buddy_init (&buddy); +}
Feel as though introducing a trivial helper buddy_reset() (wrapping this exact dance) within the buddy API would be appropriate here.
Quoted 15 lines
tools/testing/selftests/bpf/libarena/src/common.bpf.c +11
-0+__weak u64 malloc_internal (size_t size) +{ +return buddy_alloc_internal (&buddy, size); +} + +__weak void free(void __arg_arena __arena *ptr) +{ +buddy_free_internal (&buddy, (u64 )ptr); +} + + char _license[] SEC("license") = "GPL";Signature · 1 line
2.53.0
Kumar Kartikeya Dwivedi
maintainerRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
Quoted 10 lines · Matt Bobrowski
Quoted 7 lines · Emil Tsalapatis
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Signed-off-by Emil Tsalapatis <[email protected]>
Quoted 13 lines
The implementation of this BPF arena backed buddy allocator looks rather solid. I noticed that we have a single global lock being used here to synchronize metadata structure modifications. Have you thought about how this might be a high contention point, particularly when dealing with systems with incredibly high CPU core counts? Did you consider possibly making use of localized per-CPU caches for the most common/small allocation sizes or something like that? This is something that definitely crossed my mind when I was initially thinking about implementing something like this a while back. I understand that this is an initial implementation, so it doesn't necessarily carry all the bells and whistles, but I was curious to know whether this had also crossed your mind and what your thoughts were on it.
Yes, both reentrancy protection and a per-CPU caches are things Emil is planning to work on next.
Quoted 2 lines
[...]
Emil Tsalapatis
reviewerRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
Quoted 25 lines · Kumar Kartikeya Dwivedi
Quoted 10 lines · Matt Bobrowski
Quoted 7 lines · Emil Tsalapatis
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Signed-off-by Emil Tsalapatis <[email protected]>Quoted 13 lines
The implementation of this BPF arena backed buddy allocator looks rather solid. I noticed that we have a single global lock being used here to synchronize metadata structure modifications. Have you thought about how this might be a high contention point, particularly when dealing with systems with incredibly high CPU core counts? Did you consider possibly making use of localized per-CPU caches for the most common/small allocation sizes or something like that? This is something that definitely crossed my mind when I was initially thinking about implementing something like this a while back. I understand that this is an initial implementation, so it doesn't necessarily carry all the bells and whistles, but I was curious to know whether this had also crossed your mind and what your thoughts were on it.
Quoted 5 lines
Yes, both reentrancy protection and a per-CPU caches are things Emil is planning to work on next.
Quoted 2 lines
[...]
Can confirm. This is basically just the first version of the allocator just so we have some way to manage arena memory without hacks. The first thing to optimize is adding per-CPU caches to avoid contention. I've avoided adding them until now for two reasons:
1) We don't really have arena workloads we can test optimizations against. I am working on porting microbenchmarks from userspace allocators so we can concretely see the effect of any features we add. I'm also working on adding data structures to libarena, and since they may do allocations/frees during regular operations we can use them for benchmarking.
2) Until recently there's been limits to how complex an arena program could be. The allocator by itself would exhaust the BPF call stack, so adding more features would cause it to fail verification. With recent kernels this is not an issue so we can move forward with more features.
Re: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
Quoted 37 lines · Emil Tsalapatis
Quoted 25 lines · Kumar Kartikeya Dwivedi
Quoted 10 lines · Matt Bobrowski
Quoted 7 lines · Emil Tsalapatis
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Signed-off-by Emil Tsalapatis <[email protected]>Quoted 13 lines
The implementation of this BPF arena backed buddy allocator looks rather solid. I noticed that we have a single global lock being used here to synchronize metadata structure modifications. Have you thought about how this might be a high contention point, particularly when dealing with systems with incredibly high CPU core counts? Did you consider possibly making use of localized per-CPU caches for the most common/small allocation sizes or something like that? This is something that definitely crossed my mind when I was initially thinking about implementing something like this a while back. I understand that this is an initial implementation, so it doesn't necessarily carry all the bells and whistles, but I was curious to know whether this had also crossed your mind and what your thoughts were on it.
Quoted 5 lines
Yes, both reentrancy protection and a per-CPU caches are things Emil is planning to work on next.
Quoted 2 lines
[...]
Can confirm. This is basically just the first version of the allocator just so we have some way to manage arena memory without hacks. The first thing to optimize is adding per-CPU caches to avoid contention. I've avoided adding them until now for two reasons:
Quoted 6 lines
1) We don't really have arena workloads we can test optimizations against. I am working on porting microbenchmarks from userspace allocators so we can concretely see the effect of any features we add. I'm also working on adding data structures to libarena, and since they may do allocations/frees during regular operations we can use them for benchmarking.
Both sound like relatively good ideas to me. Notably, this point has sparked another thing that I was kinda curious about. Do you envision libarena being hosted outside of the Linux kernel source tree at some point? TBH, I think it'd be quite nice if it was. I definitely envision something like libarena being a submodule within numerous other BPF-enabled projects.
Also, I kindly request that you CC me on any future revisions and changes to libarena.
Emil Tsalapatis
reviewerRe: [PATCH bpf-next v8 6/8] selftests/bpf: Add buddy allocator for libarena
Quoted 45 lines · Matt Bobrowski
Quoted 37 lines · Emil Tsalapatis
Quoted 25 lines · Kumar Kartikeya Dwivedi
Quoted 10 lines · Matt Bobrowski
Quoted 7 lines · Emil Tsalapatis
Add a byte-oriented buddy allocator for libarena. The buddy allocator provides an alloc/free interface for small arena allocations ranging from 16 bytes to 512 KiB. Lower allocations values are rounded up to 16 bytes. The buddy allocator does not handle larger allocations that can instead use the existing bpf_arena_{alloc, free}_pages() kfunc.
Signed-off-by Emil Tsalapatis <[email protected]>Quoted 13 lines
The implementation of this BPF arena backed buddy allocator looks rather solid. I noticed that we have a single global lock being used here to synchronize metadata structure modifications. Have you thought about how this might be a high contention point, particularly when dealing with systems with incredibly high CPU core counts? Did you consider possibly making use of localized per-CPU caches for the most common/small allocation sizes or something like that? This is something that definitely crossed my mind when I was initially thinking about implementing something like this a while back. I understand that this is an initial implementation, so it doesn't necessarily carry all the bells and whistles, but I was curious to know whether this had also crossed your mind and what your thoughts were on it.
Quoted 5 lines
Yes, both reentrancy protection and a per-CPU caches are things Emil is planning to work on next.
Quoted 2 lines
[...]
Can confirm. This is basically just the first version of the allocator just so we have some way to manage arena memory without hacks. The first thing to optimize is adding per-CPU caches to avoid contention. I've avoided adding them until now for two reasons:
Quoted 6 lines
1) We don't really have arena workloads we can test optimizations against. I am working on porting microbenchmarks from userspace allocators so we can concretely see the effect of any features we add. I'm also working on adding data structures to libarena, and since they may do allocations/frees during regular operations we can use them for benchmarking.
Quoted 7 lines
Both sound like relatively good ideas to me. Notably, this point has sparked another thing that I was kinda curious about. Do you envision libarena being hosted outside of the Linux kernel source tree at some point? TBH, I think it'd be quite nice if it was. I definitely envision something like libarena being a submodule within numerous other BPF-enabled projects.
Exactly, that is the plan. After the change lands we can periodically sync the changes from the kernel tree to an external repo (e.g., Github). I am thinking of reusing libbpf's export process since it works pretty well, but the details are still open for discussion.
Quoted 2 lines
Also, I kindly request that you CC me on any future revisions and changes to libarena.
Gladly! I will be sending another version today (that also incorporates your feedback on patch 2/8).
Emil Tsalapatis
reviewerPATCH v8 7/8 selftests/bpf: Add selftests for libarena buddy allocator
In reply to Emil TsalapatisIntroduce selftests for the buddy allocator with and without ASAN. Add the libarena selftests both to the libarena test runner and to test_progs, so that they are a) available when libarena is pulled as a standalone library, and b) exercised along with all other test programs in this directory.
ASAN for libarena requires LLVM 22. Add logic in the top-level selftests Makefile to only compile the ASAN variant if the compiler supports it, otherwise skip the test.
--- tools/testing/selftests/bpf/Makefile | 17 +- .../bpf/libarena/include/selftest_helpers.h | 7 + .../bpf/libarena/selftests/selftest.c | 7 + .../libarena/selftests/st_asan_buddy.bpf.c | 241 ++++++++++++++++++ .../bpf/libarena/selftests/st_buddy.bpf.c | 208 +++++++++++++++ .../selftests/bpf/prog_tests/libarena.c | 62 +++++ .../selftests/bpf/prog_tests/libarena_asan.c | 87 +++++++ 7 files changed, 628 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_asan_buddy.bpf.c create mode 100644 tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c create mode 100644 tools/testing/selftests/bpf/prog_tests/libarena.c create mode 100644 tools/testing/selftests/bpf/prog_tests/libarena_asan.c
tools/testing/selftests/bpf/Makefile +16 -1
@@ -79,6 +79,12 @@ ifneq ($(shell $(CLANG) --target=bpf -mcpu=help 2>&1 | grep 'v4'),) CLANG_CPUV4 := 1 endif +# Check whether clang supports BPF address sanitizer (requires LLVM 22+) +CLANG_HAS_ARENA_ASAN := $(shell echo 'int x;' | \ + $(CLANG) --target=bpf -fsanitize=kernel-address \ + -mllvm -asan-shadow-addr-space=1 \ + -x c -c - -o /dev/null 2>/dev/null && echo 1) + # Order correspond to 'make run_tests' order TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_progs \ test_sockmap \
@@ -765,6 +771,14 @@ LIBARENA_SKEL := libarena/libarena.skel.h $(LIBARENA_SKEL): $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) $(LIBARENA_BPF_DEPS) +$(MAKE) -C libarena libarena.skel.h $(LIBARENA_MAKE_ARGS) +ifneq ($(CLANG_HAS_ARENA_ASAN),) +LIBARENA_ASAN_SKEL := libarena/libarena_asan.skel.h +CFLAGS += -DHAS_BPF_ARENA_ASAN + +$(LIBARENA_ASAN_SKEL): $(INCLUDE_DIR)/vmlinux.h $(BPFOBJ) $(LIBARENA_BPF_DEPS) + +$(MAKE) -C libarena libarena_asan.skel.h $(LIBARENA_MAKE_ARGS) +endif + # Define test_progs test runner. TRUNNER_TESTS_DIR := prog_tests TRUNNER_BPF_PROGS_DIR := progs
@@ -789,7 +803,8 @@ TRUNNER_EXTRA_SOURCES := test_progs.c \ ip_check_defrag_frags.h \ bpftool_helpers.c \ usdt_1.c usdt_2.c \ - $(LIBARENA_SKEL) + $(LIBARENA_SKEL) \ + $(LIBARENA_ASAN_SKEL) TRUNNER_LIB_SOURCES := find_bit.c TRUNNER_EXTRA_FILES := $(OUTPUT)/urandom_read \ $(OUTPUT)/liburandom_read.so \
tools/testing/selftests/bpf/libarena/include/selftest_helpers.h +7 -0
@@ -130,3 +130,10 @@ static inline int libarena_asan_init(int arena_get_base_fd,return ret;return opts.retval; } + +static inline bool libarena_must_setup_alloc (struct bpf_program *prog) +{ +const char *name =bpf_program__name (prog); + +return !strstr (name,"test_buddy" ); +}
tools/testing/selftests/bpf/libarena/selftests/selftest.c +7 -0
@@ -102,6 +102,13 @@ static int init_arena(selftest *skel)static int run_test (selftest *skel,struct bpf_program *prog) {int prog_fd; +int ret; + +if (libarena_must_setup_alloc (prog)) { + ret =libarena_run_prog (bpf_program__fd (skel->progs.arena_buddy_reset)); +if (ret) +return ret; + } prog_fd =bpf_program__fd (prog);if (prog_fd <0 )
tools/testing/selftests/bpf/libarena/selftests/st_asan_buddy.bpf.c new file +241 -0
241 lines not on this page · raw message
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c new file +208 -0
208 lines not on this page · raw message
tools/testing/selftests/bpf/prog_tests/libarena.c new file +62 -0
62 lines not on this page · raw message
tools/testing/selftests/bpf/prog_tests/libarena_asan.c new file +87 -0
87 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 7/8] selftests/bpf: Add selftests for libarena buddy allocator
Sashiko AI review found 1 potential issue(s): - [Low] Using the `%lx` format specifier for a pointer type without a cast causes a compiler warning in BPF selftests. --
Sashiko AI review found 1 potential issue(s):
- [Low] Using the %lx format specifier for a pointer type without a cast causes a compiler warning in BPF selftests. --
commit 5722468489c153ff642e633e17b799603b516db1
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Add selftests for libarena buddy allocator
Introduce selftests for the buddy allocator with and without ASAN. Add the libarena selftests both to the libarena test runner and to test_progs, and add logic in the Makefile to only compile the ASAN variant if the compiler supports it.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c new file +0
-0
[ ... ]
Quoted 3 lines
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c new file +3
-0+SEC("syscall") +__weak int test_buddy_alloc_multiple (void ) +{
[ ... ]
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c line 157
Quoted 12 lines
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c new file +12
-0+for (i =10 ; i <SEGARRLEN && can_loop; i++) { + idx = (i *17 ) %SEGARRLEN ; + + mem = segarr[idx].block; + sz = segarr[idx].sz; + poison = segarr[idx].poison; + +for (j = zero; j < sz && can_loop; j++) { +if (mem[j] != poison) { +buddy_destroy (&buddy); +arena_stdout ("%s:%d %lx %u vs %u" , __func__, + __LINE__, &mem[j], mem[j], poison);
Does passing a pointer to the %lx format specifier cause a compiler warning here?
Since &mem[j] is a pointer type (u8 __arena *), passing it to %lx without a cast usually triggers a format warning. Because BPF selftests are compiled with -Werror, this can break the build.
Should it be cast to an integer type like (unsigned long), similar to how it is handled later on in test_buddy_alignment()?
Quoted 11 lines
tools/testing/selftests/bpf/libarena/selftests/st_buddy.bpf.c new file +11
-0+return -EINVAL ; + } + } + +buddy_free (&buddy, mem); + } + +buddy_destroy (&buddy); + +return 0 ; +}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=7
Emil Tsalapatis
reviewerPATCH v8 8/8 selftests/bpf: Reuse stderr parsing for libarena ASAN tests
In reply to Emil TsalapatisAdd code to directly test the output of libarena ASAN tests. The code reuses testing infrastructure originally for BPF streams to verify that ASAN emits call stacks when the selftests trigger a memory error.
Since stderr() testing uses logic from test_progs, it is only available on the test_progs-based selftest runner. The standalone runner still uses internal ASAN state to verify access errors are triaged as expected.
--- .../bpf/libarena/include/test_progs_compat.h | 15 ++++++ .../libarena/selftests/st_asan_buddy.bpf.c | 18 +++++++ .../selftests/bpf/prog_tests/libarena_asan.c | 2 + tools/testing/selftests/bpf/test_loader.c | 51 ++++++++++++++----- tools/testing/selftests/bpf/test_progs.h | 2 + 5 files changed, 76 insertions(+), 12 deletions(-) create mode 100644 tools/testing/selftests/bpf/libarena/include/test_progs_compat.h
tools/testing/selftests/bpf/libarena/include/test_progs_compat.h new file +15 -0
@@ -0,0 +1,15 @@ +// SPDX-License-Identifier: LGPL-2.1 OR BSD-2-Clause +/* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ +#pragma once + +#ifdef __BPF__ + +/* Selftests use these tags for compatibility with test_progs. */ +#define __test_tag (tag) __attribute__((btf_decl_tag("comment:" XSTR(__COUNTER__) ":" tag))) +#define __stderr (msg) __test_tag("test_expect_stderr=" msg) +#define __stderr_unpriv (msg) __test_tag("test_expect_stderr_unpriv=" msg) + +#define XSTR (s) STR(s) +#define STR (s) #s + +#endif
tools/testing/selftests/bpf/libarena/selftests/st_asan_buddy.bpf.c +18 -0
@@ -6,6 +6,9 @@#include <asan.h> #include <buddy.h> +/* Required for parsing the ASAN call stacks. */ +#include <test_progs_compat.h> +extern buddy_t buddy;#ifdef BPF_ARENA_ASAN
@@ -142,6 +145,11 @@ static __always_inline int asan_test_buddy_blob_single(void) } SEC("syscall") +__stderr("Memory violation for address {{.*}} for write of size 1") +__stderr("CPU: {{[0-9]+}} UID: 0 PID: {{[0-9]+}} Comm: {{.*}}") +__stderr ("Call trace:\n" +"{{([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*}}")__weak int asan_test_buddy_oob (void ) {size_t sizes[] = {
@@ -175,6 +183,11 @@ __weak int asan_test_buddy_oob(void) } SEC("syscall") +__stderr("Memory violation for address {{.*}} for write of size 1") +__stderr("CPU: {{[0-9]+}} UID: 0 PID: {{[0-9]+}} Comm: {{.*}}") +__stderr ("Call trace:\n" +"{{([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*}}")__weak int asan_test_buddy_uaf (void ) {size_t sizes[] = {16 ,32 ,64 ,128 ,256 ,512 ,1024 ,16384 };
@@ -206,6 +219,11 @@ __weak int asan_test_buddy_uaf(void) } SEC("syscall") +__stderr("Memory violation for address {{.*}} for write of size 1") +__stderr("CPU: {{[0-9]+}} UID: 0 PID: {{[0-9]+}} Comm: {{.*}}") +__stderr ("Call trace:\n" +"{{([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*}}")__weak int asan_test_buddy_blob (void ) {const int iters =10 ;
tools/testing/selftests/bpf/prog_tests/libarena_asan.c +2 -0
@@ -25,6 +25,8 @@ static void run_libarena_asan_test(struct libarena_asan *skel, ret =libarena_run_prog (bpf_program__fd (prog));ASSERT_OK (ret, name); + +verify_test_stderr (skel->obj, prog); }static void run_test (void )
tools/testing/selftests/bpf/test_loader.c +39 -12
69 lines not on this page · raw message
tools/testing/selftests/bpf/test_progs.h +2 -0
@@ -563,5 +563,7 @@ struct expected_msgs {void validate_msgs (const char *log_buf,struct expected_msgs *msgs,void (*emit_fn)(const char *buf,bool force)); +void free_msgs (struct expected_msgs *msgs); +void verify_test_stderr (struct bpf_object *obj,struct bpf_program *prog);#endif /* __TEST_PROGS_H */
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH bpf-next v8 8/8] selftests/bpf: Reuse stderr parsing for libarena ASAN tests
Sashiko AI review found 1 potential issue(s): - [Medium] The `verify_test_stderr()` function ignores unprivileged stderr test tags (`__stderr_unpriv`), silently skipping their verification. --
Sashiko AI review found 1 potential issue(s):
- [Medium] The verify_test_stderr() function ignores unprivileged stderr test tags (__stderr_unpriv), silently skipping their verification. --
commit a614a51f0e77c17b24ea2c75a95abb7cf65988a1
Author: Emil Tsalapatis <[email protected]>
selftests/bpf: Reuse stderr parsing for libarena ASAN tests
This commit adds code to directly test the output of libarena ASAN tests by reusing testing infrastructure from BPF streams. It introduces a new verify_test_stderr() helper and test tags to validate stderr output against expected messages.
Quoted 5 lines
tools/testing/selftests/bpf/libarena/include/test_progs_compat.h new file +0
-0
[ ... ]
Quoted 2 lines
tools/testing/selftests/bpf/libarena/include/test_progs_compat.h new file +2
-0+#define __stderr (msg) __test_tag("test_expect_stderr=" msg) +#define __stderr_unpriv (msg) __test_tag("test_expect_stderr_unpriv=" msg)
[ ... ]
Quoted 4 lines
tools/testing/selftests/bpf/test_loader.c +0
-0
[ ... ]
tools/testing/selftests/bpf/test_loader.c static void emit_stderr(const char *stderr, bool force) · line 825
Quoted 8 lines
tools/testing/selftests/bpf/test_loader.c +8
-0+void verify_test_stderr (struct bpf_object *obj,struct bpf_program *prog) +{ +struct test_spec spec = {}; + +if (parse_test_spec (NULL , obj, prog, &spec)) +return ; + +verify_stderr (bpf_program__fd (prog), &spec.priv.stderr);
Does this code ignore unprivileged stderr test tags?
It appears that verify_test_stderr() hardcodes the use of &spec.priv.stderr. Since it lacks an unprivileged parameter to select the unprivileged spec, any expected messages specified via __stderr_unpriv() might be silently ignored.
Quoted 2 lines
tools/testing/selftests/bpf/test_loader.c +2
-0+free_test_spec (&spec); +}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=8