libbpf: define BTF_KIND_* constants in btf.h to avoid compilation errors
Subsystems (4)
PATCH 1/1 libbpf: define BTF_KIND_* constants in btf.h to avoid compilation errors
The btf.h header included with libbpf contains inline helper functions to check for various BTF kinds. These helpers directly reference the BTF_KIND_* constants defined in the kernel header, and because the header file is included in user applications, this happens in the user application compile units.
This presents a problem if a user application is compiled on a system with older kernel headers because the constants are not available. To avoid this, add #defines of the constants directly in btf.h before using them.
Since the kernel header moved to an enum for BTF_KIND_*, the #defines can shadow the enum values without any errors, so we only need #ifndef guards for the constants that predates the conversion to enum. We group these so there's only one guard for groups of values that were added together.
[0] Closes: https://github.com/libbpf/libbpf/issues/436
--- tools/lib/bpf/btf.h | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-)
tools/lib/bpf/btf.h +21 -1
@@ -375,8 +375,28 @@ btf_dump__dump_type_data(struct btf_dump *d, __u32 id, const struct btf_dump_type_data_opts *opts);/* -* A set of helpers for easier BTF types handling +* A set of helpers for easier BTF types handling. +* +* The inline functions below rely on constants from the kernel headers which +* may not be available for applications including this header file. To avoid +* compilation errors, we define all the constants here that were added after +* the initial introduction of the BTF_KIND* constants. */ +#ifndef BTF_KIND_FUNC +#define BTF_KIND_FUNC 12/* Function */ +#define BTF_KIND_FUNC_PROTO 13/* Function Proto */ +#endif +#ifndef BTF_KIND_VAR +#define BTF_KIND_VAR 14/* Variable */ +#define BTF_KIND_DATASEC 15/* Section */ +#endif +#ifndef BTF_KIND_FLOAT +#define BTF_KIND_FLOAT 16/* Floating point */ +#endif +/* The kernel header switched to enums, so these two were never #defined */ +#define BTF_KIND_DECL_TAG 17/* Decl Tag */ +#define BTF_KIND_TYPE_TAG 18/* Type Tag */ +static inline __u16 btf_kind (const struct btf_type *t) {return BTF_INFO_KIND (t->info);
Signature · 1 line
2.34.1
Em Tue, Jan 18, 2022 at 03:13:27PM +0100, Toke Høiland-Jørgensen escreveu:
Quoted 10 lines
The
btf.hheader included with libbpf contains inline helper functions to check for various BTF kinds. These helpers directly reference the BTF_KIND_* constants defined in the kernel header, and because the header file is included in user applications, this happens in the user application compile units.This presents a problem if a user application is compiled on a system with older kernel headers because the constants are not available. To avoid this, add #defines of the constants directly in
btf.hbefore using them.
Quoted 6 lines
Since the kernel header moved to an enum for BTF_KIND_*, the #defines can shadow the enum values without any errors, so we only need #ifndef guards for the constants that predates the conversion to enum. We group these so there's only one guard for groups of values that were added together.
[0] Closes: https://github.com/libbpf/libbpf/issues/436
The coexistence of enums with the defines (in turn #ifndef guarded) as something I hadn't considered, clever.
Should fix lots of build errors in my test containers :-)
FWIW:
Quoted 43 lines
Fixes 223f903e9c83 ("bpf: Rename BTF_KIND_TAG to BTF_KIND_DECL_TAG")Fixes 5b84bd10363e ("libbpf: Add support for BTF_KIND_TAG")Signed-off-by Toke Høiland-Jørgensen <[email protected]>--- tools/lib/bpf/btf.h | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-)tools/lib/bpf/btf.h +21
-1@@ -375,8 +375,28 @@ btf_dump__dump_type_data(struct btf_dump *d, __u32 id, const struct btf_dump_type_data_opts *opts);/* -* A set of helpers for easier BTF types handling +* A set of helpers for easier BTF types handling. +* +* The inline functions below rely on constants from the kernel headers which +* may not be available for applications including this header file. To avoid +* compilation errors, we define all the constants here that were added after +* the initial introduction of the BTF_KIND* constants. */ +#ifndef BTF_KIND_FUNC +#define BTF_KIND_FUNC 12/* Function */ +#define BTF_KIND_FUNC_PROTO 13/* Function Proto */ +#endif +#ifndef BTF_KIND_VAR +#define BTF_KIND_VAR 14/* Variable */ +#define BTF_KIND_DATASEC 15/* Section */ +#endif +#ifndef BTF_KIND_FLOAT +#define BTF_KIND_FLOAT 16/* Floating point */ +#endif +/* The kernel header switched to enums, so these two were never #defined */ +#define BTF_KIND_DECL_TAG 17/* Decl Tag */ +#define BTF_KIND_TYPE_TAG 18/* Type Tag */ +static inline __u16 btf_kind (const struct btf_type *t) {return BTF_INFO_KIND (t->info);Signature · 1 line
2.34.1
Signature · 1 line
- Arnaldo
Quoted 16 lines · Arnaldo Carvalho de Melo
Em Tue, Jan 18, 2022 at 03:13:27PM +0100, Toke Høiland-Jørgensen escreveu:
Quoted 15 lines
The
btf.hheader included with libbpf contains inline helper functions to check for various BTF kinds. These helpers directly reference the BTF_KIND_* constants defined in the kernel header, and because the header file is included in user applications, this happens in the user application compile units.This presents a problem if a user application is compiled on a system with older kernel headers because the constants are not available. To avoid this, add #defines of the constants directly in
btf.hbefore using them.Since the kernel header moved to an enum for BTF_KIND_*, the #defines can shadow the enum values without any errors, so we only need #ifndef guards for the constants that predates the conversion to enum. We group these so there's only one guard for groups of values that were added together.
Quoted 4 lines
Quoted 1 line
[0] Closes: https://github.com/libbpf/libbpf/issues/436
The coexistence of enums with the defines (in turn #ifndef guarded) as something I hadn't considered, clever.
Me neither - that bit was Andrii's idea :)
Quoted 5 lines
Should fix lots of build errors in my test containers :-)
FWIW:
Thanks!
-Toke
This patch was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Hello:
This patch was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Quoted 11 lines · On Tue, 18 Jan 2022 15:13:27 +0100 you wrote:
The
btf.hheader included with libbpf contains inline helper functions to check for various BTF kinds. These helpers directly reference the BTF_KIND_* constants defined in the kernel header, and because the header file is included in user applications, this happens in the user application compile units.This presents a problem if a user application is compiled on a system with older kernel headers because the constants are not available. To avoid this, add #defines of the constants directly in
btf.hbefore using them.[...]
Here is the summary with links:
- [bpf] libbpf: define BTF_KIND_* constants in btf.h to avoid compilation errors
https://git.kernel.org/bpf/bpf-next/c/eaa266d83a37
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html