Skip to content

bpf: Allow arena pointers in by-value returns

Yonghong Song bpf 4 versions – Applied

Status from this message: This series was applied to bpf/bpf-next.git (master)

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest12 patches 2 repliesApplied 12/12
  2. v311 patches 7 repliesSuperseded
  3. v210 patches 8 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v12 patches3 repliesSuperseded

Changes in v4 from the cover letter

- v3: https://lore.kernel.org/bpf/[email protected]/
- Generate type string(s) for those verifier rejected kfunc's.
- For global function, disable returning arena pointer if main prog.
- Add additional tests for rejected kfunc type string(s).

Patches in v4 All 12 applied

#Subject and filesSizeRepliesApplied
1/12bpf: Record each half of a paired return value in verifier diagnosticskernel/bpf/verifier.c+42 -140 repliesApplied
2/12bpf: Drop the recursion depth argument of btf_type_is_scalar_struct()include/linux/bpf_verifier.h kernel/bpf/btf.c kernel/bpf/verifier.c+17 -110 repliesApplied
3/12bpf: Add btf_type_is_arena_ptr()include/linux/btf.h kernel/bpf/btf.c+23 -400 repliesApplied
4/12bpf: Let the by-value struct walk take the kinds of member it acceptsinclude/linux/bpf_verifier.h kernel/bpf/btf.c kernel/bpf/verifier.c+38 -130 repliesApplied
5/12bpf: Let a by-value struct nest arrays and structs freelykernel/bpf/verifier.c+11 -60 repliesApplied
6/12bpf: Report which member makes a kfunc return type unsupportedkernel/bpf/verifier.c+94 -90 repliesApplied
7/12bpf: Allow a global function to return arena pointers by valuekernel/bpf/btf.c tools/testing/selftests/bpf/progs/exceptions_fail.c+23 -70 repliesApplied
8/12bpf: Allow arena pointers in a by-value kfunc returnkernel/bpf/verifier.c tools/testing/selftests/bpf/progs/aggregate_ret_kfunc.c+14 -100 repliesApplied
9/12selftests/bpf: Check the member named for an unsupported kfunc return typetools/testing/selftests/bpf/progs/aggregate_ret_kfunc.c tools/testing/selftests/bpf/test_kmods/bpf_testmod.c tools/testing/selftests/bpf/test_kmods/bpf_testmod_kfunc.h+164 -00 repliesApplied
10/12selftests/bpf: Test global functions returning arena pointers by valuetools/testing/selftests/bpf/progs/aggregate_ret_func.c tools/testing/selftests/bpf/progs/verifier_arena.c+194 -00 repliesApplied
11/12selftests/bpf: Test kfuncs returning arena pointers by valuetools/testing/selftests/bpf/prog_tests/aggregate_ret.c tools/testing/selftests/bpf/progs/aggregate_ret_kfunc_arena.c tools/testing/selftests/bpf/test_kmods/bpf_testmod.c +1 more+225 -00 repliesApplied
12/12docs/bpf: Document arena pointers in a by-value returnDocumentation/bpf/kfuncs.rst+24 -152 repliesApplied

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v4 yet.

Read the v4 thread

Cover letter [PATCH bpf-next v4 00/12] bpf: Allow arena pointers in by-value returns

A function returning a struct by value may only return one whose members are all scalars. That is stricter than it needs to be: an arena pointer is safe to hand over as raw register bits, and both a global function and a kfunc can already return one on its own.

This patch set allows returning arena pointer(s) (as member(s) of a struct) for global functions and kfuncs. Any other pointer member stays rejected, as it would be laundered into a scalar and escape provenance and reference tracking.

Patch 1 fixes a diagnostics bug. Patches 2-4 are refactoring with no functional change. Patch 5 checked (nested) arrays until non-array type to be checked by struct or other types. Patch 6 improves the diagnostics for an unsupported return type, and patches 7-8 allow arena pointer members. Patches 9-11 are selftests. Patch 12 updates the kfunc's doc.

Changelog:
v3 -> v4:
- v3: https://lore.kernel.org/bpf/[email protected]/
- Generate type string(s) for those verifier rejected kfunc's.
- For global function, disable returning arena pointer if main prog.
- Add additional tests for rejected kfunc type string(s).
v2 -> v3:
- v2: https://lore.kernel.org/bpf/[email protected]/
- Fix two more verifier diagnostics.
- Fix btf_member_path_str() by detecting anonymous union/struct.
- Fix a few arena tests with non-zero arena pointers.
- Update kfuncs doc for supporting return value with arena pointers.
v1 -> v2:
- v1: https://lore.kernel.org/bpf/[email protected]/
- Add nested struct field names for diagnostics, and report the nesting depth for a type nested past the walk limit.
- Allow to return arena pointers for global functions and kfuncs.
- Necessary selftests for newly supported arena pointers.

Yonghong Song (12):
bpf: Record each half of a paired return value in verifier diagnostics
bpf: Drop the recursion depth argument of btf_type_is_scalar_struct()
bpf: Add btf_type_is_arena_ptr()
bpf: Let the by-value struct walk take the kinds of member it accepts
bpf: Let a by-value struct nest arrays and structs freely
bpf: Report which member makes a kfunc return type unsupported
bpf: Allow a global function to return arena pointers by value
bpf: Allow arena pointers in a by-value kfunc return selftests/bpf: Check the member named for an unsupported kfunc return
type
selftests/bpf: Test global functions returning arena pointers by value selftests/bpf: Test kfuncs returning arena pointers by value docs/bpf: Document arena pointers in a by-value return

 Documentation/bpf/kfuncs.rst                  |  39 +--
 include/linux/bpf_verifier.h                  |  11 +-
 include/linux/btf.h                           |   1 +
 kernel/bpf/btf.c                              |  90 ++++---
 kernel/bpf/verifier.c                         | 228 ++++++++++++++----
 .../selftests/bpf/prog_tests/aggregate_ret.c  |  42 ++++
 .../selftests/bpf/progs/aggregate_ret_func.c  | 146 +++++++++++
 .../selftests/bpf/progs/aggregate_ret_kfunc.c |  84 ++++++-
 .../bpf/progs/aggregate_ret_kfunc_arena.c     | 121 ++++++++++
 .../selftests/bpf/progs/exceptions_fail.c     |   2 +-
 .../selftests/bpf/progs/verifier_arena.c      |  48 ++++
 .../selftests/bpf/test_kmods/bpf_testmod.c    |  72 ++++++
 .../bpf/test_kmods/bpf_testmod_kfunc.h        |  72 ++++++
 13 files changed, 850 insertions(+), 106 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/progs/aggregate_ret_kfunc_arena.c
Signature · 1 line
2.53.0-Meta