Skip to content

libbpf: Support kernel-side kfunc flavors

Ihor Solodrai bpf lkml sched-ext 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 12 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4libbpf: Fall back to kernel ___ flavors when resolving kfuncstools/lib/bpf/btf.c tools/lib/bpf/libbpf.c tools/lib/bpf/libbpf_internal.h+165 -21 reply
2/4selftests/bpf: Test kfunc flavor resolutiontools/testing/selftests/bpf/prog_tests/verifier.c tools/testing/selftests/bpf/progs/kfunc_flavors.c tools/testing/selftests/bpf/test_kmods/bpf_testmod.c +1 more+86 -00 replies
3/4resolve_btfids: Reject kfunc families that libbpf can't disambiguatetools/bpf/resolve_btfids/btf_colors.c tools/bpf/resolve_btfids/btf_colors.h tools/bpf/resolve_btfids/main.c+148 -01 reply
4/4docs/bpf: Describe how to change a kfunc's prototypeDocumentation/bpf/kfuncs.rst+83 -00 replies

Reviews trailers per patch

1 of 4 patches has a Reviewed-by or Acked-by.

PatchEduard Zingerman
1/4
2/4
3/4A-b
4/4

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH bpf-next v1 0/4] libbpf: Support kernel-side kfunc flavors

An incompatible change to a kfunc's prototype, such as an added parameter, breaks BPF programs built against the old one. libbpf ignores the ___<flavor> suffix of a kfunc declared in a BPF program, but makes an exact name look up on the kernel side, so the kernel can't keep the old prototype available under the kfunc's name.

sched_ext ran into this. cded46d97159 ("sched_ext: Make scx_bpf_dsq_insert*() return bool") kept the old prototype as scx_bpf_dsq_insert___compat, expecting libbpf to bind old binaries to it, and broke them. 2dbbdeda77a6 ("sched_ext: Fix scx_bpf_dsq_insert() backward binary compatibility") reversed the naming. A ___v2 kfunc declared as vmlinux.h spells it doesn't bind: 56bbc91219c0 ("sched_ext: Fix scx_bpf_dsq_move_to_local___v2 compat detection") fixed a compat macro that silently dropped enq_flags because of this.

With this series, if the kernel's bpf_foo kfunc is missing or its prototype is incompatible with the declaration, libbpf binds the bpf_foo___<flavor> that has a compatible prototype. So a changed kfunc can keep its name, and the old prototype stays available as foo___v1.

resolve_btfids fails the build if two of bpf_foo and its flavors have compatible prototypes, unless both have foo's exact prototype (aliases), so the fallback finds at most one match. This ensures at kernel / module build time that no ambigous kfunc flavors exist. Documentation/bpf/kfuncs.rst describes the rules.

Compatibility is determined by bpf_core_types_are_compat(), the check libbpf already applies to kfuncs. Of the 70 same-name kfunc prototype changes between v6.6 and bpf-next, it finds 8 incompatible (arity, return kind, callback prototype). The other 62 (const, typedefs, parameter names, integer widths, pointee struct names, annotation suffixes) were made in place without breaking old callers.

The flavors feature is backwards compatible: declarations that resolve today bind the same kernel function. The exact name lookup is attempted first. Declarations rejected today for an incompatible prototype, or left unresolved if __weak, may now bind to a flavor, for example scx_bpf_dsq_insert___v2 as vmlinux.h declares it. Older libbpf and light skeletons don't get the fallback.

---

Ihor Solodrai (4):
libbpf: Fall back to kernel ___ flavors when resolving kfuncs selftests/bpf: Test kfunc flavor resolution
resolve_btfids: Reject kfunc families that libbpf can't disambiguate docs/bpf: Describe how to change a kfunc's prototype

 Documentation/bpf/kfuncs.rst                  |  83 +++++++++++
 tools/bpf/resolve_btfids/btf_colors.c         |  11 ++
 tools/bpf/resolve_btfids/btf_colors.h         |   3 +
 tools/bpf/resolve_btfids/main.c               | 134 +++++++++++++++++
 tools/lib/bpf/btf.c                           |  26 ++++
 tools/lib/bpf/libbpf.c                        | 140 +++++++++++++++++-
 tools/lib/bpf/libbpf_internal.h               |   1 +
 .../selftests/bpf/prog_tests/verifier.c       |   3 +
 .../selftests/bpf/progs/kfunc_flavors.c       |  55 +++++++
 .../selftests/bpf/test_kmods/bpf_testmod.c    |  24 +++
 .../bpf/test_kmods/bpf_testmod_kfunc.h        |   4 +
 11 files changed, 482 insertions(+), 2 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/progs/kfunc_flavors.c

base-commit: 32b66b94c86f009b49668de7340f2ed65aad2dc5

Signature · 1 line
2.56.1