diff mbox series

[v3,3/3] btf: Avoid weak external references

Message ID 20240415075837.2349766-8-ardb+git@google.com (mailing list archive)
State Superseded
Delegated to: BPF
Headers show
Series kbuild: Avoid weak external linkage where possible | expand

Checks

Context Check Description
bpf/vmtest-bpf-next-PR success PR summary
bpf/vmtest-bpf-next-VM_Test-0 success Logs for Lint
bpf/vmtest-bpf-next-VM_Test-3 success Logs for Validate matrix.py
bpf/vmtest-bpf-next-VM_Test-1 success Logs for ShellCheck
bpf/vmtest-bpf-next-VM_Test-2 success Logs for Unittests
bpf/vmtest-bpf-next-VM_Test-5 success Logs for aarch64-gcc / build-release
bpf/vmtest-bpf-next-VM_Test-4 success Logs for aarch64-gcc / build / build for aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-9 success Logs for aarch64-gcc / test (test_verifier, false, 360) / test_verifier on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-10 success Logs for aarch64-gcc / veristat
bpf/vmtest-bpf-next-VM_Test-11 success Logs for s390x-gcc / build / build for s390x with gcc
bpf/vmtest-bpf-next-VM_Test-12 success Logs for s390x-gcc / build-release
bpf/vmtest-bpf-next-VM_Test-16 success Logs for s390x-gcc / test (test_verifier, false, 360) / test_verifier on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-17 success Logs for s390x-gcc / veristat
bpf/vmtest-bpf-next-VM_Test-18 success Logs for set-matrix
bpf/vmtest-bpf-next-VM_Test-20 success Logs for x86_64-gcc / build-release
bpf/vmtest-bpf-next-VM_Test-19 success Logs for x86_64-gcc / build / build for x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-21 success Logs for x86_64-gcc / test (test_maps, false, 360) / test_maps on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-29 success Logs for x86_64-llvm-17 / build-release / build for x86_64 with llvm-17 and -O2 optimization
bpf/vmtest-bpf-next-VM_Test-28 success Logs for x86_64-llvm-17 / build / build for x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-26 success Logs for x86_64-gcc / test (test_verifier, false, 360) / test_verifier on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-34 success Logs for x86_64-llvm-17 / veristat
bpf/vmtest-bpf-next-VM_Test-37 success Logs for x86_64-llvm-18 / test (test_maps, false, 360) / test_maps on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-33 success Logs for x86_64-llvm-17 / test (test_verifier, false, 360) / test_verifier on x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-36 success Logs for x86_64-llvm-18 / build-release / build for x86_64 with llvm-18 and -O2 optimization
bpf/vmtest-bpf-next-VM_Test-35 success Logs for x86_64-llvm-18 / build / build for x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-42 success Logs for x86_64-llvm-18 / veristat
bpf/vmtest-bpf-next-VM_Test-41 success Logs for x86_64-llvm-18 / test (test_verifier, false, 360) / test_verifier on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-6 success Logs for aarch64-gcc / test (test_maps, false, 360) / test_maps on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-7 success Logs for aarch64-gcc / test (test_progs, false, 360) / test_progs on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-8 success Logs for aarch64-gcc / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-13 success Logs for s390x-gcc / test (test_maps, false, 360) / test_maps on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-22 success Logs for x86_64-gcc / test (test_progs, false, 360) / test_progs on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-27 success Logs for x86_64-gcc / veristat / veristat on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-23 success Logs for x86_64-gcc / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-24 success Logs for x86_64-gcc / test (test_progs_no_alu32_parallel, true, 30) / test_progs_no_alu32_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-25 success Logs for x86_64-gcc / test (test_progs_parallel, true, 30) / test_progs_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-30 success Logs for x86_64-llvm-17 / test (test_maps, false, 360) / test_maps on x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-31 success Logs for x86_64-llvm-17 / test (test_progs, false, 360) / test_progs on x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-38 success Logs for x86_64-llvm-18 / test (test_progs, false, 360) / test_progs on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-39 success Logs for x86_64-llvm-18 / test (test_progs_cpuv4, false, 360) / test_progs_cpuv4 on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-32 success Logs for x86_64-llvm-17 / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-40 success Logs for x86_64-llvm-18 / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-14 success Logs for s390x-gcc / test (test_progs, false, 360) / test_progs on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-15 success Logs for s390x-gcc / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on s390x with gcc
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 932 this patch: 932
netdev/build_tools success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers warning 15 maintainers not CCed: yonghong.song@linux.dev john.fastabend@gmail.com jolsa@kernel.org ndesaulniers@google.com kpsingh@kernel.org morbo@google.com sdf@google.com nathan@kernel.org daniel@iogearbox.net ast@kernel.org justinstitt@google.com haoluo@google.com eddyz87@gmail.com llvm@lists.linux.dev song@kernel.org
netdev/build_clang success Errors and warnings before: 938 this patch: 938
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 943 this patch: 943
netdev/checkpatch warning WARNING: externs should be avoided in .c files
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Ard Biesheuvel April 15, 2024, 7:58 a.m. UTC
From: Ard Biesheuvel <ardb@kernel.org>

If the BTF code is enabled in the build configuration, the start/stop
BTF markers are guaranteed to exist in the final link but not during the
first linker pass.

Avoid GOT based relocations to these markers in the final executable by
providing preliminary definitions that will be used by the first linker
pass, and superseded by the actual definitions in the subsequent ones.

Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
that inadvertent references to this section will trigger a link failure
if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.

Note that Clang will notice that taking the address of__start_BTF cannot
yield NULL any longer, so testing for that condition is no longer
needed.

Acked-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
---
 include/asm-generic/vmlinux.lds.h | 9 +++++++++
 kernel/bpf/btf.c                  | 7 +++++--
 kernel/bpf/sysfs_btf.c            | 6 +++---
 3 files changed, 17 insertions(+), 5 deletions(-)

Comments

Jiri Olsa April 15, 2024, 11:22 a.m. UTC | #1
On Mon, Apr 15, 2024 at 09:58:41AM +0200, Ard Biesheuvel wrote:
> From: Ard Biesheuvel <ardb@kernel.org>
> 
> If the BTF code is enabled in the build configuration, the start/stop
> BTF markers are guaranteed to exist in the final link but not during the
> first linker pass.
> 
> Avoid GOT based relocations to these markers in the final executable by
> providing preliminary definitions that will be used by the first linker
> pass, and superseded by the actual definitions in the subsequent ones.
> 
> Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
> that inadvertent references to this section will trigger a link failure
> if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.
> 
> Note that Clang will notice that taking the address of__start_BTF cannot
> yield NULL any longer, so testing for that condition is no longer
> needed.
> 
> Acked-by: Andrii Nakryiko <andrii@kernel.org>
> Acked-by: Arnd Bergmann <arnd@arndb.de>

Acked-by: Jiri Olsa <jolsa@kernel.org>

jirka


> Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> ---
>  include/asm-generic/vmlinux.lds.h | 9 +++++++++
>  kernel/bpf/btf.c                  | 7 +++++--
>  kernel/bpf/sysfs_btf.c            | 6 +++---
>  3 files changed, 17 insertions(+), 5 deletions(-)
> 
> diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
> index e8449be62058..4cb3d88449e5 100644
> --- a/include/asm-generic/vmlinux.lds.h
> +++ b/include/asm-generic/vmlinux.lds.h
> @@ -456,6 +456,7 @@
>   * independent code.
>   */
>  #define PRELIMINARY_SYMBOL_DEFINITIONS					\
> +	PRELIMINARY_BTF_DEFINITIONS					\
>  	PROVIDE(kallsyms_addresses = .);				\
>  	PROVIDE(kallsyms_offsets = .);					\
>  	PROVIDE(kallsyms_names = .);					\
> @@ -466,6 +467,14 @@
>  	PROVIDE(kallsyms_markers = .);					\
>  	PROVIDE(kallsyms_seqs_of_names = .);
>  
> +#ifdef CONFIG_DEBUG_INFO_BTF
> +#define PRELIMINARY_BTF_DEFINITIONS					\
> +	PROVIDE(__start_BTF = .);					\
> +	PROVIDE(__stop_BTF = .);
> +#else
> +#define PRELIMINARY_BTF_DEFINITIONS
> +#endif
> +
>  /*
>   * Read only Data
>   */
> diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> index 90c4a32d89ff..6d46cee47ae3 100644
> --- a/kernel/bpf/btf.c
> +++ b/kernel/bpf/btf.c
> @@ -5642,8 +5642,8 @@ static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr, u32 uat
>  	return ERR_PTR(err);
>  }
>  
> -extern char __weak __start_BTF[];
> -extern char __weak __stop_BTF[];
> +extern char __start_BTF[];
> +extern char __stop_BTF[];
>  extern struct btf *btf_vmlinux;
>  
>  #define BPF_MAP_TYPE(_id, _ops)
> @@ -5971,6 +5971,9 @@ struct btf *btf_parse_vmlinux(void)
>  	struct btf *btf = NULL;
>  	int err;
>  
> +	if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
> +		return ERR_PTR(-ENOENT);
> +
>  	env = kzalloc(sizeof(*env), GFP_KERNEL | __GFP_NOWARN);
>  	if (!env)
>  		return ERR_PTR(-ENOMEM);
> diff --git a/kernel/bpf/sysfs_btf.c b/kernel/bpf/sysfs_btf.c
> index ef6911aee3bb..fedb54c94cdb 100644
> --- a/kernel/bpf/sysfs_btf.c
> +++ b/kernel/bpf/sysfs_btf.c
> @@ -9,8 +9,8 @@
>  #include <linux/sysfs.h>
>  
>  /* See scripts/link-vmlinux.sh, gen_btf() func for details */
> -extern char __weak __start_BTF[];
> -extern char __weak __stop_BTF[];
> +extern char __start_BTF[];
> +extern char __stop_BTF[];
>  
>  static ssize_t
>  btf_vmlinux_read(struct file *file, struct kobject *kobj,
> @@ -32,7 +32,7 @@ static int __init btf_vmlinux_init(void)
>  {
>  	bin_attr_btf_vmlinux.size = __stop_BTF - __start_BTF;
>  
> -	if (!__start_BTF || bin_attr_btf_vmlinux.size == 0)
> +	if (bin_attr_btf_vmlinux.size == 0)
>  		return 0;
>  
>  	btf_kobj = kobject_create_and_add("btf", kernel_kobj);
> -- 
> 2.44.0.683.g7961c838ac-goog
>
Masahiro Yamada April 15, 2024, 2:54 p.m. UTC | #2
On Mon, Apr 15, 2024 at 4:58 PM Ard Biesheuvel <ardb+git@google.com> wrote:
>
> From: Ard Biesheuvel <ardb@kernel.org>
>
> If the BTF code is enabled in the build configuration, the start/stop
> BTF markers are guaranteed to exist in the final link but not during the
> first linker pass.
>
> Avoid GOT based relocations to these markers in the final executable by
> providing preliminary definitions that will be used by the first linker
> pass, and superseded by the actual definitions in the subsequent ones.
>
> Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
> that inadvertent references to this section will trigger a link failure
> if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.
>
> Note that Clang will notice that taking the address of__start_BTF cannot
> yield NULL any longer, so testing for that condition is no longer
> needed.
>
> Acked-by: Andrii Nakryiko <andrii@kernel.org>
> Acked-by: Arnd Bergmann <arnd@arndb.de>
> Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> ---
>  include/asm-generic/vmlinux.lds.h | 9 +++++++++
>  kernel/bpf/btf.c                  | 7 +++++--
>  kernel/bpf/sysfs_btf.c            | 6 +++---
>  3 files changed, 17 insertions(+), 5 deletions(-)
>
> diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
> index e8449be62058..4cb3d88449e5 100644
> --- a/include/asm-generic/vmlinux.lds.h
> +++ b/include/asm-generic/vmlinux.lds.h
> @@ -456,6 +456,7 @@
>   * independent code.
>   */
>  #define PRELIMINARY_SYMBOL_DEFINITIONS                                 \
> +       PRELIMINARY_BTF_DEFINITIONS                                     \
>         PROVIDE(kallsyms_addresses = .);                                \
>         PROVIDE(kallsyms_offsets = .);                                  \
>         PROVIDE(kallsyms_names = .);                                    \
> @@ -466,6 +467,14 @@
>         PROVIDE(kallsyms_markers = .);                                  \
>         PROVIDE(kallsyms_seqs_of_names = .);
>
> +#ifdef CONFIG_DEBUG_INFO_BTF
> +#define PRELIMINARY_BTF_DEFINITIONS                                    \
> +       PROVIDE(__start_BTF = .);                                       \
> +       PROVIDE(__stop_BTF = .);
> +#else
> +#define PRELIMINARY_BTF_DEFINITIONS
> +#endif
> +



Is this necessary?



The following code (BOUNDED_SECTION_BY)
produces __start_BTF and __stop_BTF symbols
under the same condition.



/*
 * .BTF
 */
#ifdef CONFIG_DEBUG_INFO_BTF
#define BTF                                                                \
        .BTF : AT(ADDR(.BTF) - LOAD_OFFSET) {                                \
                BOUNDED_SECTION_BY(.BTF, _BTF)                                \
        }                                                                \
        . = ALIGN(4);                                                        \
        .BTF_ids : AT(ADDR(.BTF_ids) - LOAD_OFFSET) {                        \
                *(.BTF_ids)                                                \
        }
#else
#define BTF
#endif











>  /*
>   * Read only Data
>   */
> diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> index 90c4a32d89ff..6d46cee47ae3 100644
> --- a/kernel/bpf/btf.c
> +++ b/kernel/bpf/btf.c
> @@ -5642,8 +5642,8 @@ static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr, u32 uat
>         return ERR_PTR(err);
>  }
>
> -extern char __weak __start_BTF[];
> -extern char __weak __stop_BTF[];
> +extern char __start_BTF[];
> +extern char __stop_BTF[];
>  extern struct btf *btf_vmlinux;
>
>  #define BPF_MAP_TYPE(_id, _ops)
> @@ -5971,6 +5971,9 @@ struct btf *btf_parse_vmlinux(void)
>         struct btf *btf = NULL;
>         int err;
>
> +       if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
> +               return ERR_PTR(-ENOENT);
> +
>         env = kzalloc(sizeof(*env), GFP_KERNEL | __GFP_NOWARN);
>         if (!env)
>                 return ERR_PTR(-ENOMEM);
> diff --git a/kernel/bpf/sysfs_btf.c b/kernel/bpf/sysfs_btf.c
> index ef6911aee3bb..fedb54c94cdb 100644
> --- a/kernel/bpf/sysfs_btf.c
> +++ b/kernel/bpf/sysfs_btf.c
> @@ -9,8 +9,8 @@
>  #include <linux/sysfs.h>
>
>  /* See scripts/link-vmlinux.sh, gen_btf() func for details */
> -extern char __weak __start_BTF[];
> -extern char __weak __stop_BTF[];
> +extern char __start_BTF[];
> +extern char __stop_BTF[];
>
>  static ssize_t
>  btf_vmlinux_read(struct file *file, struct kobject *kobj,
> @@ -32,7 +32,7 @@ static int __init btf_vmlinux_init(void)
>  {
>         bin_attr_btf_vmlinux.size = __stop_BTF - __start_BTF;
>
> -       if (!__start_BTF || bin_attr_btf_vmlinux.size == 0)
> +       if (bin_attr_btf_vmlinux.size == 0)
>                 return 0;
>
>         btf_kobj = kobject_create_and_add("btf", kernel_kobj);
> --
> 2.44.0.683.g7961c838ac-goog
>
Ard Biesheuvel April 15, 2024, 2:59 p.m. UTC | #3
On Mon, 15 Apr 2024 at 16:55, Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Mon, Apr 15, 2024 at 4:58 PM Ard Biesheuvel <ardb+git@google.com> wrote:
> >
> > From: Ard Biesheuvel <ardb@kernel.org>
> >
> > If the BTF code is enabled in the build configuration, the start/stop
> > BTF markers are guaranteed to exist in the final link but not during the
> > first linker pass.
> >
> > Avoid GOT based relocations to these markers in the final executable by
> > providing preliminary definitions that will be used by the first linker
> > pass, and superseded by the actual definitions in the subsequent ones.
> >
> > Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
> > that inadvertent references to this section will trigger a link failure
> > if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.
> >
> > Note that Clang will notice that taking the address of__start_BTF cannot
> > yield NULL any longer, so testing for that condition is no longer
> > needed.
> >
> > Acked-by: Andrii Nakryiko <andrii@kernel.org>
> > Acked-by: Arnd Bergmann <arnd@arndb.de>
> > Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> > ---
> >  include/asm-generic/vmlinux.lds.h | 9 +++++++++
> >  kernel/bpf/btf.c                  | 7 +++++--
> >  kernel/bpf/sysfs_btf.c            | 6 +++---
> >  3 files changed, 17 insertions(+), 5 deletions(-)
> >
> > diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
> > index e8449be62058..4cb3d88449e5 100644
> > --- a/include/asm-generic/vmlinux.lds.h
> > +++ b/include/asm-generic/vmlinux.lds.h
> > @@ -456,6 +456,7 @@
> >   * independent code.
> >   */
> >  #define PRELIMINARY_SYMBOL_DEFINITIONS                                 \
> > +       PRELIMINARY_BTF_DEFINITIONS                                     \
> >         PROVIDE(kallsyms_addresses = .);                                \
> >         PROVIDE(kallsyms_offsets = .);                                  \
> >         PROVIDE(kallsyms_names = .);                                    \
> > @@ -466,6 +467,14 @@
> >         PROVIDE(kallsyms_markers = .);                                  \
> >         PROVIDE(kallsyms_seqs_of_names = .);
> >
> > +#ifdef CONFIG_DEBUG_INFO_BTF
> > +#define PRELIMINARY_BTF_DEFINITIONS                                    \
> > +       PROVIDE(__start_BTF = .);                                       \
> > +       PROVIDE(__stop_BTF = .);
> > +#else
> > +#define PRELIMINARY_BTF_DEFINITIONS
> > +#endif
> > +
>
>
>
> Is this necessary?
>

I think so.

This actually resulted in Jiri's build failure with v2, and the
realization that there was dead code in btf_parse_vmlinux() that
happily tried to load the contents of the BTF section if
CONFIG_DEBUG_INFO_BTF was not enabled to begin with.

So this is another pitfall with weak references: the symbol may
unexpectedly be missing altogether rather than only during the first
linker pass.


>
>
> The following code (BOUNDED_SECTION_BY)
> produces __start_BTF and __stop_BTF symbols
> under the same condition.
>

Indeed. So if CONFIG_DEBUG_INFO_BTF=n, code can still link to
__start_BTF and __stop_BTF even though BTF is not enabled.

>
>
> /*
>  * .BTF
>  */
> #ifdef CONFIG_DEBUG_INFO_BTF
> #define BTF                                                                \
>         .BTF : AT(ADDR(.BTF) - LOAD_OFFSET) {                                \
>                 BOUNDED_SECTION_BY(.BTF, _BTF)                                \
>         }                                                                \
>         . = ALIGN(4);                                                        \
>         .BTF_ids : AT(ADDR(.BTF_ids) - LOAD_OFFSET) {                        \
>                 *(.BTF_ids)                                                \
>         }
> #else
> #define BTF
> #endif
>
>
>
>
>
>
>
>
>
>
>
> >  /*
> >   * Read only Data
> >   */
> > diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> > index 90c4a32d89ff..6d46cee47ae3 100644
> > --- a/kernel/bpf/btf.c
> > +++ b/kernel/bpf/btf.c
> > @@ -5642,8 +5642,8 @@ static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr, u32 uat
> >         return ERR_PTR(err);
> >  }
> >
> > -extern char __weak __start_BTF[];
> > -extern char __weak __stop_BTF[];
> > +extern char __start_BTF[];
> > +extern char __stop_BTF[];
> >  extern struct btf *btf_vmlinux;
> >
> >  #define BPF_MAP_TYPE(_id, _ops)
> > @@ -5971,6 +5971,9 @@ struct btf *btf_parse_vmlinux(void)
> >         struct btf *btf = NULL;
> >         int err;
> >
> > +       if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
> > +               return ERR_PTR(-ENOENT);
> > +
> >         env = kzalloc(sizeof(*env), GFP_KERNEL | __GFP_NOWARN);
> >         if (!env)
> >                 return ERR_PTR(-ENOMEM);
> > diff --git a/kernel/bpf/sysfs_btf.c b/kernel/bpf/sysfs_btf.c
> > index ef6911aee3bb..fedb54c94cdb 100644
> > --- a/kernel/bpf/sysfs_btf.c
> > +++ b/kernel/bpf/sysfs_btf.c
> > @@ -9,8 +9,8 @@
> >  #include <linux/sysfs.h>
> >
> >  /* See scripts/link-vmlinux.sh, gen_btf() func for details */
> > -extern char __weak __start_BTF[];
> > -extern char __weak __stop_BTF[];
> > +extern char __start_BTF[];
> > +extern char __stop_BTF[];
> >
> >  static ssize_t
> >  btf_vmlinux_read(struct file *file, struct kobject *kobj,
> > @@ -32,7 +32,7 @@ static int __init btf_vmlinux_init(void)
> >  {
> >         bin_attr_btf_vmlinux.size = __stop_BTF - __start_BTF;
> >
> > -       if (!__start_BTF || bin_attr_btf_vmlinux.size == 0)
> > +       if (bin_attr_btf_vmlinux.size == 0)
> >                 return 0;
> >
> >         btf_kobj = kobject_create_and_add("btf", kernel_kobj);
> > --
> > 2.44.0.683.g7961c838ac-goog
> >
>
>
> --
> Best Regards
> Masahiro Yamada
Masahiro Yamada April 15, 2024, 3:31 p.m. UTC | #4
On Mon, Apr 15, 2024 at 11:59 PM Ard Biesheuvel <ardb@kernel.org> wrote:
>
> On Mon, 15 Apr 2024 at 16:55, Masahiro Yamada <masahiroy@kernel.org> wrote:
> >
> > On Mon, Apr 15, 2024 at 4:58 PM Ard Biesheuvel <ardb+git@google.com> wrote:
> > >
> > > From: Ard Biesheuvel <ardb@kernel.org>
> > >
> > > If the BTF code is enabled in the build configuration, the start/stop
> > > BTF markers are guaranteed to exist in the final link but not during the
> > > first linker pass.
> > >
> > > Avoid GOT based relocations to these markers in the final executable by
> > > providing preliminary definitions that will be used by the first linker
> > > pass, and superseded by the actual definitions in the subsequent ones.
> > >
> > > Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
> > > that inadvertent references to this section will trigger a link failure
> > > if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.
> > >
> > > Note that Clang will notice that taking the address of__start_BTF cannot
> > > yield NULL any longer, so testing for that condition is no longer
> > > needed.
> > >
> > > Acked-by: Andrii Nakryiko <andrii@kernel.org>
> > > Acked-by: Arnd Bergmann <arnd@arndb.de>
> > > Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> > > ---
> > >  include/asm-generic/vmlinux.lds.h | 9 +++++++++
> > >  kernel/bpf/btf.c                  | 7 +++++--
> > >  kernel/bpf/sysfs_btf.c            | 6 +++---
> > >  3 files changed, 17 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
> > > index e8449be62058..4cb3d88449e5 100644
> > > --- a/include/asm-generic/vmlinux.lds.h
> > > +++ b/include/asm-generic/vmlinux.lds.h
> > > @@ -456,6 +456,7 @@
> > >   * independent code.
> > >   */
> > >  #define PRELIMINARY_SYMBOL_DEFINITIONS                                 \
> > > +       PRELIMINARY_BTF_DEFINITIONS                                     \
> > >         PROVIDE(kallsyms_addresses = .);                                \
> > >         PROVIDE(kallsyms_offsets = .);                                  \
> > >         PROVIDE(kallsyms_names = .);                                    \
> > > @@ -466,6 +467,14 @@
> > >         PROVIDE(kallsyms_markers = .);                                  \
> > >         PROVIDE(kallsyms_seqs_of_names = .);
> > >
> > > +#ifdef CONFIG_DEBUG_INFO_BTF
> > > +#define PRELIMINARY_BTF_DEFINITIONS                                    \
> > > +       PROVIDE(__start_BTF = .);                                       \
> > > +       PROVIDE(__stop_BTF = .);
> > > +#else
> > > +#define PRELIMINARY_BTF_DEFINITIONS
> > > +#endif
> > > +
> >
> >
> >
> > Is this necessary?
> >
>
> I think so.
>
> This actually resulted in Jiri's build failure with v2, and the
> realization that there was dead code in btf_parse_vmlinux() that
> happily tried to load the contents of the BTF section if
> CONFIG_DEBUG_INFO_BTF was not enabled to begin with.
>
> So this is another pitfall with weak references: the symbol may
> unexpectedly be missing altogether rather than only during the first
> linker pass.
>
> >
> >
> > The following code (BOUNDED_SECTION_BY)
> > produces __start_BTF and __stop_BTF symbols
> > under the same condition.
> >
>
> Indeed. So if CONFIG_DEBUG_INFO_BTF=n, code can still link to
> __start_BTF and __stop_BTF even though BTF is not enabled.



I am talking about the case for CONFIG_DEBUG_INFO_BTF=y.

PROVIDE() is meaningless because __start_BTF and __stop_BTF
are produced by the existing code.

(The code was a bit clearer before commit
9b351be25360c5cedfb98b88d6dfd89327849e52)



So, v4 of this patch will look like 2/3, right?


Just drop __weak attribute.

You still need

if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
             return ERR_PTR(-ENOENT);

But, you do not need to modify vmlinux.lds.h







--
Best Regards
Masahiro Yamada
Ard Biesheuvel April 15, 2024, 3:54 p.m. UTC | #5
On Mon, 15 Apr 2024 at 17:32, Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Mon, Apr 15, 2024 at 11:59 PM Ard Biesheuvel <ardb@kernel.org> wrote:
> >
> > On Mon, 15 Apr 2024 at 16:55, Masahiro Yamada <masahiroy@kernel.org> wrote:
> > >
> > > On Mon, Apr 15, 2024 at 4:58 PM Ard Biesheuvel <ardb+git@google.com> wrote:
> > > >
> > > > From: Ard Biesheuvel <ardb@kernel.org>
> > > >
> > > > If the BTF code is enabled in the build configuration, the start/stop
> > > > BTF markers are guaranteed to exist in the final link but not during the
> > > > first linker pass.
> > > >
> > > > Avoid GOT based relocations to these markers in the final executable by
> > > > providing preliminary definitions that will be used by the first linker
> > > > pass, and superseded by the actual definitions in the subsequent ones.
> > > >
> > > > Make the preliminary definitions dependent on CONFIG_DEBUG_INFO_BTF so
> > > > that inadvertent references to this section will trigger a link failure
> > > > if they occur in code that does not honour CONFIG_DEBUG_INFO_BTF.
> > > >
> > > > Note that Clang will notice that taking the address of__start_BTF cannot
> > > > yield NULL any longer, so testing for that condition is no longer
> > > > needed.
> > > >
> > > > Acked-by: Andrii Nakryiko <andrii@kernel.org>
> > > > Acked-by: Arnd Bergmann <arnd@arndb.de>
> > > > Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
> > > > ---
> > > >  include/asm-generic/vmlinux.lds.h | 9 +++++++++
> > > >  kernel/bpf/btf.c                  | 7 +++++--
> > > >  kernel/bpf/sysfs_btf.c            | 6 +++---
> > > >  3 files changed, 17 insertions(+), 5 deletions(-)
> > > >
> > > > diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
> > > > index e8449be62058..4cb3d88449e5 100644
> > > > --- a/include/asm-generic/vmlinux.lds.h
> > > > +++ b/include/asm-generic/vmlinux.lds.h
> > > > @@ -456,6 +456,7 @@
> > > >   * independent code.
> > > >   */
> > > >  #define PRELIMINARY_SYMBOL_DEFINITIONS                                 \
> > > > +       PRELIMINARY_BTF_DEFINITIONS                                     \
> > > >         PROVIDE(kallsyms_addresses = .);                                \
> > > >         PROVIDE(kallsyms_offsets = .);                                  \
> > > >         PROVIDE(kallsyms_names = .);                                    \
> > > > @@ -466,6 +467,14 @@
> > > >         PROVIDE(kallsyms_markers = .);                                  \
> > > >         PROVIDE(kallsyms_seqs_of_names = .);
> > > >
> > > > +#ifdef CONFIG_DEBUG_INFO_BTF
> > > > +#define PRELIMINARY_BTF_DEFINITIONS                                    \
> > > > +       PROVIDE(__start_BTF = .);                                       \
> > > > +       PROVIDE(__stop_BTF = .);
> > > > +#else
> > > > +#define PRELIMINARY_BTF_DEFINITIONS
> > > > +#endif
> > > > +
> > >
> > >
> > >
> > > Is this necessary?
> > >
> >
> > I think so.
> >
> > This actually resulted in Jiri's build failure with v2, and the
> > realization that there was dead code in btf_parse_vmlinux() that
> > happily tried to load the contents of the BTF section if
> > CONFIG_DEBUG_INFO_BTF was not enabled to begin with.
> >
> > So this is another pitfall with weak references: the symbol may
> > unexpectedly be missing altogether rather than only during the first
> > linker pass.
> >
> > >
> > >
> > > The following code (BOUNDED_SECTION_BY)
> > > produces __start_BTF and __stop_BTF symbols
> > > under the same condition.
> > >
> >
> > Indeed. So if CONFIG_DEBUG_INFO_BTF=n, code can still link to
> > __start_BTF and __stop_BTF even though BTF is not enabled.
>
>
>
> I am talking about the case for CONFIG_DEBUG_INFO_BTF=y.
>
> PROVIDE() is meaningless because __start_BTF and __stop_BTF
> are produced by the existing code.
>
> (The code was a bit clearer before commit
> 9b351be25360c5cedfb98b88d6dfd89327849e52)
>
>
>
> So, v4 of this patch will look like 2/3, right?
>
>
> Just drop __weak attribute.
>
> You still need
>
> if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
>              return ERR_PTR(-ENOENT);
>
> But, you do not need to modify vmlinux.lds.h
>

OK, I see what you mean now.

The PROVIDE() is indeed unnecessary - I'll drop that bit in v4.
diff mbox series

Patch

diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
index e8449be62058..4cb3d88449e5 100644
--- a/include/asm-generic/vmlinux.lds.h
+++ b/include/asm-generic/vmlinux.lds.h
@@ -456,6 +456,7 @@ 
  * independent code.
  */
 #define PRELIMINARY_SYMBOL_DEFINITIONS					\
+	PRELIMINARY_BTF_DEFINITIONS					\
 	PROVIDE(kallsyms_addresses = .);				\
 	PROVIDE(kallsyms_offsets = .);					\
 	PROVIDE(kallsyms_names = .);					\
@@ -466,6 +467,14 @@ 
 	PROVIDE(kallsyms_markers = .);					\
 	PROVIDE(kallsyms_seqs_of_names = .);
 
+#ifdef CONFIG_DEBUG_INFO_BTF
+#define PRELIMINARY_BTF_DEFINITIONS					\
+	PROVIDE(__start_BTF = .);					\
+	PROVIDE(__stop_BTF = .);
+#else
+#define PRELIMINARY_BTF_DEFINITIONS
+#endif
+
 /*
  * Read only Data
  */
diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
index 90c4a32d89ff..6d46cee47ae3 100644
--- a/kernel/bpf/btf.c
+++ b/kernel/bpf/btf.c
@@ -5642,8 +5642,8 @@  static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr, u32 uat
 	return ERR_PTR(err);
 }
 
-extern char __weak __start_BTF[];
-extern char __weak __stop_BTF[];
+extern char __start_BTF[];
+extern char __stop_BTF[];
 extern struct btf *btf_vmlinux;
 
 #define BPF_MAP_TYPE(_id, _ops)
@@ -5971,6 +5971,9 @@  struct btf *btf_parse_vmlinux(void)
 	struct btf *btf = NULL;
 	int err;
 
+	if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
+		return ERR_PTR(-ENOENT);
+
 	env = kzalloc(sizeof(*env), GFP_KERNEL | __GFP_NOWARN);
 	if (!env)
 		return ERR_PTR(-ENOMEM);
diff --git a/kernel/bpf/sysfs_btf.c b/kernel/bpf/sysfs_btf.c
index ef6911aee3bb..fedb54c94cdb 100644
--- a/kernel/bpf/sysfs_btf.c
+++ b/kernel/bpf/sysfs_btf.c
@@ -9,8 +9,8 @@ 
 #include <linux/sysfs.h>
 
 /* See scripts/link-vmlinux.sh, gen_btf() func for details */
-extern char __weak __start_BTF[];
-extern char __weak __stop_BTF[];
+extern char __start_BTF[];
+extern char __stop_BTF[];
 
 static ssize_t
 btf_vmlinux_read(struct file *file, struct kobject *kobj,
@@ -32,7 +32,7 @@  static int __init btf_vmlinux_init(void)
 {
 	bin_attr_btf_vmlinux.size = __stop_BTF - __start_BTF;
 
-	if (!__start_BTF || bin_attr_btf_vmlinux.size == 0)
+	if (bin_attr_btf_vmlinux.size == 0)
 		return 0;
 
 	btf_kobj = kobject_create_and_add("btf", kernel_kobj);