Skip to content

libbpf, selftests/bpf: Support cross-endian usage

Tony Ambardar bpf linux-kselftest 6 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. v6 Latest8 patches 1 replyApplied 8/8
  2. v58 patches 7 repliesSuperseded
  3. v48 patches 19 repliesSuperseded
Earlier versions · 3
VersionPostedPatchesRepliesStatus
v38 patches1 replySuperseded
v28 patches14 repliesSuperseded
v18 patches2 repliesSuperseded

Changelog from the cover letter

---------
v5 -> v6: (comments from Andrii, Alexei, Eduard)
- clarify info_blob_bswap() by making it explicitly conditional on non-native target endianness, and merge a pair of related debug statements
- reformat debug statement in bpf_object_bswap_progs() on single line
- update existing info setup functions to validate and parse info section metadata prior to any byte-swapping, and drop earlier added validation checks
- rework cross-endian BTF.ext handling by using callback functions to byte-swap different types of info records, but after initial parsing
- fix a bug always outputting BTF.ext raw data in native endianness
- include v5 "Acked-by:" from Alexei, Yonghong

Patches in v6 All 8 applied

#Subject and filesSizeRepliesApplied
1/8libbpf: Improve log message formattingtools/lib/bpf/btf.c tools/lib/bpf/btf_dump.c tools/lib/bpf/btf_relocate.c +2 more+8 -80 repliesApplied
2/8libbpf: Fix header comment typos for BTF.exttools/lib/bpf/libbpf_internal.h+2 -20 repliesApplied
3/8libbpf: Fix output .symtab byte-order during linkingtools/lib/bpf/linker.c+2 -00 repliesApplied
4/8libbpf: Support BTF.ext loading and output in either endiannesstools/lib/bpf/btf.c tools/lib/bpf/btf.h tools/lib/bpf/libbpf.map +1 more+258 -571 replyApplied
5/8libbpf: Support opening bpf objects of either endiannesstools/lib/bpf/libbpf.c tools/lib/bpf/libbpf_internal.h+53 -90 repliesApplied
6/8libbpf: Support linking bpf objects of either endiannesstools/lib/bpf/linker.c+62 -160 repliesApplied
7/8libbpf: Support creating light skeleton of either endiannesstools/lib/bpf/bpf_gen_internal.h tools/lib/bpf/gen_loader.c tools/lib/bpf/libbpf.c +1 more+139 -530 repliesApplied
8/8selftests/bpf: Support cross-endian buildingtools/testing/selftests/bpf/Makefile+4 -30 repliesApplied

Reviews trailers per patch

2 of 8 patches have a Reviewed-by or Acked-by.

PatchAlexei StarovoitovYonghong Song
1/8
2/8
3/8
4/8
5/8
6/8
7/8A-b
8/8A-b

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

Read the v6 thread

Cover letter [PATCH bpf-next v6 0/8] libbpf, selftests/bpf: Support cross-endian usage

Hello all,

This patch series targets a long-standing BPF usability issue - the lack of general cross-compilation support - by enabling cross-endian usage of libbpf and bpftool, as well as supporting cross-endian build targets for selftests/bpf.

Benefits include improved BPF development and testing for embedded systems based on e.g. big-endian MIPS, more build options e.g for s390x systems, and better accessibility to the very latest test tools e.g. 'test_progs'.

The series touches many functional areas: BTF.ext handling; object access, introspection, and linking; generation of normal and "light" skeletons.

Initial development and testing used mips64, since this arch makes switching the build byte-order trivial and is thus very handy for A/B testing. However, it lacks some key features (bpf2bpf call, kfuncs, etc) making for poor selftests/bpf coverage.

Final testing takes the kernel and selftests/bpf cross-built from x86_64 to s390x, and runs the result under QEMU/s390x. That same configuration could also be used on kernel-patches/bpf CI for regression testing endian support or perhaps load-sharing s390x builds across x86_64 systems.

This thread includes some background regarding testing on QEMU/s390x and the generally favourable results:
https://lore.kernel.org/bpf/ZsEcsaa3juxxQBUf@kodidev-ubuntu/

Earlier versions and related discussion of the series are here:

v1: https://lore.kernel.org/bpf/[email protected]/
v2: https://lore.kernel.org/bpf/[email protected]/
v3: https://lore.kernel.org/bpf/[email protected]/
v4: https://lore.kernel.org/bpf/[email protected]/
v5: https://lore.kernel.org/bpf/[email protected]/

Feedback and suggestions are welcome!

Best regards,
Tony

Changelog:
---------
v5 -> v6: (comments from Andrii, Alexei, Eduard)
- clarify info_blob_bswap() by making it explicitly conditional on non-native target endianness, and merge a pair of related debug statements
- reformat debug statement in bpf_object_bswap_progs() on single line
- update existing info setup functions to validate and parse info section metadata prior to any byte-swapping, and drop earlier added validation checks
- rework cross-endian BTF.ext handling by using callback functions to byte-swap different types of info records, but after initial parsing
- fix a bug always outputting BTF.ext raw data in native endianness
- include v5 "Acked-by:" from Alexei, Yonghong

v4 -> v5: (feedback from Andrii and Eduard)
- add separate functions to byte-swap info metadata and records, and ensure ordering so record bswaps occur when metadata is native endian
- use new and existing macros to iterate through info sections/records, and check embedded record sizes match that of info structs used
- drop use of <cough> evil callbacks
- move setting swapped_endian flag to after byte-swapping functions are called during initialization, allowing funcs to infer endianness and drop a 'bool native' call parameter
- simplify byte-swapping macro used to generate light skeleton, and use internal lib funcs to swap info records instead of assuming all __u32
- change info bswap library funcs to void return
- rework/consolidate new debug statements to reduce their number
- remove some unneeded handling of impossible errors, and drop a safety check already handled elsewhere
- add and clarify some comments

v3 -> v4:
- fix a use-after-free ELF data-handling error causing rare CI failures
- move bswap functions for func/line/core-relo records to internal header
- use bswap functions also for info blobs in light skeleton

v2 -> v3: (feedback from Andrii)
- improve some log and commit message formatting
- restructure BTF.ext endianness safety checks and byte-swapping
- use BTF.ext info record definitions for swapping, require BTF v1
- follow BTF API implementation more closely for BTF.ext
- explicitly reject loading non-native endianness program into kernel
- simplify linker output byte-order setting
- drop redundant safety checks during linking
- simplify endianness macro and improve blob setup code for light skel
- no unexpected test failures after cross-compiling x86_64 -> s390x

v1 -> v2:
- fixed a light skeleton bug causing test_progs 'map_ptr' failure
- simplified some BTF.ext related endianness logic
- remove an 'inline' usage related to CI checkpatch failure
- improve some formatting noted by checkpatch warnings
- unexpected 'test_progs' failures drop 3 -> 2 (x86_64 to s390x cross)

Tony Ambardar (8):
libbpf: Improve log message formatting
libbpf: Fix header comment typos for BTF.ext
libbpf: Fix output .symtab byte-order during linking
libbpf: Support BTF.ext loading and output in either endianness
libbpf: Support opening bpf objects of either endianness
libbpf: Support linking bpf objects of either endianness
libbpf: Support creating light skeleton of either endianness selftests/bpf: Support cross-endian building

 tools/lib/bpf/bpf_gen_internal.h     |   1 +
 tools/lib/bpf/btf.c                  | 284 +++++++++++++++++++++------
 tools/lib/bpf/btf.h                  |   3 +
 tools/lib/bpf/btf_dump.c             |   2 +-
 tools/lib/bpf/btf_relocate.c         |   2 +-
 tools/lib/bpf/gen_loader.c           | 187 +++++++++++++-----
 tools/lib/bpf/libbpf.c               |  56 ++++--
 tools/lib/bpf/libbpf.map             |   2 +
 tools/lib/bpf/libbpf_internal.h      |  45 ++++-
 tools/lib/bpf/linker.c               |  80 ++++++--
 tools/lib/bpf/relo_core.c            |   2 +-
 tools/lib/bpf/skel_internal.h        |   3 +-
 tools/testing/selftests/bpf/Makefile |   7 +-
 13 files changed, 527 insertions(+), 147 deletions(-)
Signature · 1 line
2.34.1