| Message ID | 20220523230428.3077108-1-deso@posteo.net (mailing list archive) |
|---|---|
| Headers | show |
| Series | libbpf: Textual representation of enums | expand |
Hello: This series was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <andrii@kernel.org>: On Mon, 23 May 2022 23:04:16 +0000 you wrote: > This patch set introduces the means for querying a textual representation of > the following BPF related enum types: > - enum bpf_map_type > - enum bpf_prog_type > - enum bpf_attach_type > - enum bpf_link_type > > [...] Here is the summary with links: - [bpf-next,v4,01/12] libbpf: Introduce libbpf_bpf_prog_type_str https://git.kernel.org/bpf/bpf-next/c/36f21676bad3 - [bpf-next,v4,02/12] selftests/bpf: Add test for libbpf_bpf_prog_type_str https://git.kernel.org/bpf/bpf-next/c/9bb1be5c6eed - [bpf-next,v4,03/12] bpftool: Use libbpf_bpf_prog_type_str https://git.kernel.org/bpf/bpf-next/c/13259b23955f - [bpf-next,v4,04/12] libbpf: Introduce libbpf_bpf_map_type_str https://git.kernel.org/bpf/bpf-next/c/1be3ac58c1f7 - [bpf-next,v4,05/12] selftests/bpf: Add test for libbpf_bpf_map_type_str https://git.kernel.org/bpf/bpf-next/c/4714649a9af8 - [bpf-next,v4,06/12] bpftool: Use libbpf_bpf_map_type_str https://git.kernel.org/bpf/bpf-next/c/889f4cba4bdb - [bpf-next,v4,07/12] libbpf: Introduce libbpf_bpf_attach_type_str https://git.kernel.org/bpf/bpf-next/c/58342919a189 - [bpf-next,v4,08/12] selftests/bpf: Add test for libbpf_bpf_attach_type_str https://git.kernel.org/bpf/bpf-next/c/98e0e5eb4412 - [bpf-next,v4,09/12] bpftool: Use libbpf_bpf_attach_type_str https://git.kernel.org/bpf/bpf-next/c/2a5ada03fcb3 - [bpf-next,v4,10/12] libbpf: Introduce libbpf_bpf_link_type_str https://git.kernel.org/bpf/bpf-next/c/19b4ce1e29ff - [bpf-next,v4,11/12] selftests/bpf: Add test for libbpf_bpf_link_type_str https://git.kernel.org/bpf/bpf-next/c/8ff2d074f953 - [bpf-next,v4,12/12] bpftool: Use libbpf_bpf_link_type_str https://git.kernel.org/bpf/bpf-next/c/9522b20b46c3 You are awesome, thank you!
This patch set introduces the means for querying a textual representation of the following BPF related enum types: - enum bpf_map_type - enum bpf_prog_type - enum bpf_attach_type - enum bpf_link_type To make that possible, we introduce a new public function for each of the types: libbpf_bpf_<type>_type_str. Having a way to query a textual representation has been asked for in the past (by systemd, among others). Such representations can generally be useful in tracing and logging contexts, among others. At this point, at least one client, bpftool, maintains such a mapping manually, which is prone to get out of date as new enum variants are introduced. libbpf is arguably best situated to keep this list complete and up-to-date. This patch series adds BTF based tests to ensure that exhaustiveness is upheld moving forward. The libbpf provided textual representation can be inferred from the corresponding enum variant name by removing the prefix and lowercasing the remainder. E.g., BPF_PROG_TYPE_SOCKET_FILTER -> socket_filter. Unfortunately, bpftool does not use such a programmatic approach for some of the bpf_attach_type variants. We decided in favor of changing its behavior to work with libbpf representations. However, for user inputs, specifically, we do maintain support for the traditionally used names around (please see patch "bpftool: Use libbpf_bpf_attach_type_str"). The patch series is structured as follows: - for each enumeration type in {bpf_prog_type, bpf_map_type, bpf_attach_type, bpf_link_type}: - we first introduce the corresponding public libbpf API function - we then add BTF based self-tests - we lastly adjust bpftool to use the libbpf provided functionality Signed-off-by: Daniel Müller <deso@posteo.net> Cc: Quentin Monnet <quentin@isovalent.com> --- Changelog: v3 -> v4: - use full string comparison for newly added attach types - switched away from erroneously used kdoc-style comments - removed unused prog_types variable and containing section from test_bpftool_synctypes.py - adjusted wording in documentation of get_types_from_array function - split various test_bpftool_synctypes.py changes into commits where they are required to eliminate temporary failures of this test v2 -> v3: - use LIBBPF_1.0.0 section in libbpf.map for newly added exports v1 -> v2: - adjusted bpftool to work with algorithmically determined attach types as libbpf now uses (just removed prefix from enum name and lowercased the rest) - adjusted tests, man page, and completion script to work with the new names - renamed bpf_attach_type_str -> bpf_attach_type_input_str - for input: added special cases that accept the traditionally used strings as well - changed 'char const *' -> 'const char *' Daniel Müller (12): libbpf: Introduce libbpf_bpf_prog_type_str selftests/bpf: Add test for libbpf_bpf_prog_type_str bpftool: Use libbpf_bpf_prog_type_str libbpf: Introduce libbpf_bpf_map_type_str selftests/bpf: Add test for libbpf_bpf_map_type_str bpftool: Use libbpf_bpf_map_type_str libbpf: Introduce libbpf_bpf_attach_type_str selftests/bpf: Add test for libbpf_bpf_attach_type_str bpftool: Use libbpf_bpf_attach_type_str libbpf: Introduce libbpf_bpf_link_type_str selftests/bpf: Add test for libbpf_bpf_link_type_str bpftool: Use libbpf_bpf_link_type_str .../bpftool/Documentation/bpftool-cgroup.rst | 16 +- .../bpftool/Documentation/bpftool-prog.rst | 5 +- tools/bpf/bpftool/bash-completion/bpftool | 18 +- tools/bpf/bpftool/cgroup.c | 53 +++-- tools/bpf/bpftool/common.c | 82 +++---- tools/bpf/bpftool/feature.c | 87 +++++--- tools/bpf/bpftool/link.c | 61 +++--- tools/bpf/bpftool/main.h | 20 +- tools/bpf/bpftool/map.c | 82 +++---- tools/bpf/bpftool/prog.c | 77 +++---- tools/lib/bpf/libbpf.c | 160 ++++++++++++++ tools/lib/bpf/libbpf.h | 36 +++ tools/lib/bpf/libbpf.map | 6 + .../selftests/bpf/prog_tests/libbpf_str.c | 207 ++++++++++++++++++ .../selftests/bpf/test_bpftool_synctypes.py | 166 ++++++-------- 15 files changed, 738 insertions(+), 338 deletions(-) create mode 100644 tools/testing/selftests/bpf/prog_tests/libbpf_str.c