diff mbox series

[v4,bpf-next,1/7] bpf: add a __btf_get_by_fd helper

Message ID 20241203135052.3380721-2-aspsk@isovalent.com (mailing list archive)
State Changes Requested
Delegated to: BPF
Headers show
Series Add fd_array_cnt attribute for BPF_PROG_LOAD | expand

Checks

Context Check Description
bpf/vmtest-bpf-next-PR success PR summary
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for bpf-next, async
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: 194 this patch: 194
netdev/build_tools success Errors and warnings before: 0 (+0) this patch: 0 (+0)
netdev/cc_maintainers fail 12 maintainers not CCed: sdf@fomichev.me haoluo@google.com eddyz87@gmail.com kpsingh@kernel.org john.fastabend@gmail.com andrii@kernel.org martin.lau@linux.dev jolsa@kernel.org yonghong.song@linux.dev song@kernel.org daniel@iogearbox.net ast@kernel.org
netdev/build_clang success Errors and warnings before: 225 this patch: 225
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: 6967 this patch: 6967
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 64 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 6 this patch: 6
netdev/source_inline success Was 0 now: 0
bpf/vmtest-bpf-next-VM_Test-0 success Logs for Lint
bpf/vmtest-bpf-next-VM_Test-2 success Logs for Unittests
bpf/vmtest-bpf-next-VM_Test-3 success Logs for Validate matrix.py
bpf/vmtest-bpf-next-VM_Test-5 success Logs for aarch64-gcc / build-release
bpf/vmtest-bpf-next-VM_Test-1 success Logs for ShellCheck
bpf/vmtest-bpf-next-VM_Test-11 success Logs for aarch64-gcc / veristat
bpf/vmtest-bpf-next-VM_Test-7 success Logs for aarch64-gcc / test (test_maps, false, 360) / test_maps on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-12 success Logs for s390x-gcc / build / build for s390x with gcc
bpf/vmtest-bpf-next-VM_Test-4 success Logs for aarch64-gcc / build / build for aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-10 success Logs for aarch64-gcc / test (test_verifier, false, 360) / test_verifier on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-6 success Logs for aarch64-gcc / test (sched_ext, false, 360) / sched_ext on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-13 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-19 success Logs for x86_64-gcc / build / build for x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-20 success Logs for x86_64-gcc / build-release
bpf/vmtest-bpf-next-VM_Test-21 success Logs for x86_64-gcc / test (sched_ext, false, 360) / sched_ext on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-22 success Logs for x86_64-gcc / test (test_maps, false, 360) / test_maps on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-25 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-26 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-27 success Logs for x86_64-gcc / test (test_verifier, false, 360) / test_verifier on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-28 success Logs for x86_64-gcc / veristat / veristat on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-29 success Logs for x86_64-llvm-17 / build / build for x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-30 success Logs for x86_64-llvm-17 / build-release / build for x86_64 with llvm-17-O2
bpf/vmtest-bpf-next-VM_Test-31 success Logs for x86_64-llvm-17 / test (sched_ext, false, 360) / sched_ext on x86_64 with llvm-17
bpf/vmtest-bpf-next-VM_Test-32 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-33 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-35 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-17 / veristat
bpf/vmtest-bpf-next-VM_Test-37 success Logs for x86_64-llvm-18 / build / build for x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-38 success Logs for x86_64-llvm-18 / build-release / build for x86_64 with llvm-18-O2
bpf/vmtest-bpf-next-VM_Test-39 success Logs for x86_64-llvm-18 / test (sched_ext, false, 360) / sched_ext on x86_64 with llvm-18
bpf/vmtest-bpf-next-VM_Test-40 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-44 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-45 success Logs for x86_64-llvm-18 / veristat
bpf/vmtest-bpf-next-VM_Test-9 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-8 success Logs for aarch64-gcc / test (test_progs, false, 360) / test_progs on aarch64 with gcc
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
bpf/vmtest-bpf-next-VM_Test-23 success Logs for x86_64-gcc / test (test_progs, false, 360) / test_progs on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-24 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-34 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-41 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-42 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-43 success Logs for x86_64-llvm-18 / test (test_progs_no_alu32, false, 360) / test_progs_no_alu32 on x86_64 with llvm-18

Commit Message

Anton Protopopov Dec. 3, 2024, 1:50 p.m. UTC
Add a new helper to get a pointer to a struct btf from a file
descriptor. This helper doesn't increase a refcnt. Add a comment
explaining this and pointing to a corresponding function which
does take a reference.

Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
---
 include/linux/bpf.h | 17 +++++++++++++++++
 include/linux/btf.h |  2 ++
 kernel/bpf/btf.c    | 13 ++++---------
 3 files changed, 23 insertions(+), 9 deletions(-)

Comments

Andrii Nakryiko Dec. 3, 2024, 9:25 p.m. UTC | #1
On Tue, Dec 3, 2024 at 5:48 AM Anton Protopopov <aspsk@isovalent.com> wrote:
>
> Add a new helper to get a pointer to a struct btf from a file
> descriptor. This helper doesn't increase a refcnt. Add a comment
> explaining this and pointing to a corresponding function which
> does take a reference.
>
> Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
> ---
>  include/linux/bpf.h | 17 +++++++++++++++++
>  include/linux/btf.h |  2 ++
>  kernel/bpf/btf.c    | 13 ++++---------
>  3 files changed, 23 insertions(+), 9 deletions(-)
>

Minor (but unexplained and/or unnecessary) things I pointed out below,
but overall looks good

Acked-by: Andrii Nakryiko <andrii@kernel.org>

> diff --git a/include/linux/bpf.h b/include/linux/bpf.h
> index eaee2a819f4c..ac44b857b2f9 100644
> --- a/include/linux/bpf.h
> +++ b/include/linux/bpf.h
> @@ -2301,6 +2301,14 @@ void __bpf_obj_drop_impl(void *p, const struct btf_record *rec, bool percpu);
>  struct bpf_map *bpf_map_get(u32 ufd);
>  struct bpf_map *bpf_map_get_with_uref(u32 ufd);
>
> +/*
> + * The __bpf_map_get() and __btf_get_by_fd() functions parse a file
> + * descriptor and return a corresponding map or btf object.
> + * Their names are double underscored to emphasize the fact that they
> + * do not increase refcnt. To also increase refcnt use corresponding
> + * bpf_map_get() and btf_get_by_fd() functions.
> + */
> +
>  static inline struct bpf_map *__bpf_map_get(struct fd f)
>  {
>         if (fd_empty(f))
> @@ -2310,6 +2318,15 @@ static inline struct bpf_map *__bpf_map_get(struct fd f)
>         return fd_file(f)->private_data;
>  }
>
> +static inline struct btf *__btf_get_by_fd(struct fd f)
> +{
> +       if (fd_empty(f))
> +               return ERR_PTR(-EBADF);
> +       if (unlikely(fd_file(f)->f_op != &btf_fops))
> +               return ERR_PTR(-EINVAL);
> +       return fd_file(f)->private_data;
> +}
> +
>  void bpf_map_inc(struct bpf_map *map);
>  void bpf_map_inc_with_uref(struct bpf_map *map);
>  struct bpf_map *__bpf_map_inc_not_zero(struct bpf_map *map, bool uref);
> diff --git a/include/linux/btf.h b/include/linux/btf.h
> index 4214e76c9168..69159e649675 100644
> --- a/include/linux/btf.h
> +++ b/include/linux/btf.h
> @@ -4,6 +4,7 @@
>  #ifndef _LINUX_BTF_H
>  #define _LINUX_BTF_H 1
>
> +#include <linux/file.h>

do we need this in linux/btf.h header?

>  #include <linux/types.h>
>  #include <linux/bpfptr.h>
>  #include <linux/bsearch.h>
> @@ -143,6 +144,7 @@ void btf_get(struct btf *btf);
>  void btf_put(struct btf *btf);
>  const struct btf_header *btf_header(const struct btf *btf);
>  int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz);
> +

?

>  struct btf *btf_get_by_fd(int fd);
>  int btf_get_info_by_fd(const struct btf *btf,
>                        const union bpf_attr *attr,
> diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> index e7a59e6462a9..ad5310fa1d3b 100644
> --- a/kernel/bpf/btf.c
> +++ b/kernel/bpf/btf.c
> @@ -7743,17 +7743,12 @@ int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_size)
>
>  struct btf *btf_get_by_fd(int fd)
>  {
> -       struct btf *btf;
>         CLASS(fd, f)(fd);
> +       struct btf *btf;

nit: no need to just move this around



>
> -       if (fd_empty(f))
> -               return ERR_PTR(-EBADF);
> -
> -       if (fd_file(f)->f_op != &btf_fops)
> -               return ERR_PTR(-EINVAL);
> -
> -       btf = fd_file(f)->private_data;
> -       refcount_inc(&btf->refcnt);
> +       btf = __btf_get_by_fd(f);
> +       if (!IS_ERR(btf))
> +               refcount_inc(&btf->refcnt);
>
>         return btf;
>  }
> --
> 2.34.1
>
>
Anton Protopopov Dec. 4, 2024, 10:42 a.m. UTC | #2
On 24/12/03 01:25PM, Andrii Nakryiko wrote:
> On Tue, Dec 3, 2024 at 5:48 AM Anton Protopopov <aspsk@isovalent.com> wrote:
> >
> > Add a new helper to get a pointer to a struct btf from a file
> > descriptor. This helper doesn't increase a refcnt. Add a comment
> > explaining this and pointing to a corresponding function which
> > does take a reference.
> >
> > Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
> > ---
> >  include/linux/bpf.h | 17 +++++++++++++++++
> >  include/linux/btf.h |  2 ++
> >  kernel/bpf/btf.c    | 13 ++++---------
> >  3 files changed, 23 insertions(+), 9 deletions(-)
> >
> 
> Minor (but unexplained and/or unnecessary) things I pointed out below,
> but overall looks good
> 
> Acked-by: Andrii Nakryiko <andrii@kernel.org>
> 
> > diff --git a/include/linux/bpf.h b/include/linux/bpf.h
> > index eaee2a819f4c..ac44b857b2f9 100644
> > --- a/include/linux/bpf.h
> > +++ b/include/linux/bpf.h
> > @@ -2301,6 +2301,14 @@ void __bpf_obj_drop_impl(void *p, const struct btf_record *rec, bool percpu);
> >  struct bpf_map *bpf_map_get(u32 ufd);
> >  struct bpf_map *bpf_map_get_with_uref(u32 ufd);
> >
> > +/*
> > + * The __bpf_map_get() and __btf_get_by_fd() functions parse a file
> > + * descriptor and return a corresponding map or btf object.
> > + * Their names are double underscored to emphasize the fact that they
> > + * do not increase refcnt. To also increase refcnt use corresponding
> > + * bpf_map_get() and btf_get_by_fd() functions.
> > + */
> > +
> >  static inline struct bpf_map *__bpf_map_get(struct fd f)
> >  {
> >         if (fd_empty(f))
> > @@ -2310,6 +2318,15 @@ static inline struct bpf_map *__bpf_map_get(struct fd f)
> >         return fd_file(f)->private_data;
> >  }
> >
> > +static inline struct btf *__btf_get_by_fd(struct fd f)
> > +{
> > +       if (fd_empty(f))
> > +               return ERR_PTR(-EBADF);
> > +       if (unlikely(fd_file(f)->f_op != &btf_fops))
> > +               return ERR_PTR(-EINVAL);
> > +       return fd_file(f)->private_data;
> > +}
> > +
> >  void bpf_map_inc(struct bpf_map *map);
> >  void bpf_map_inc_with_uref(struct bpf_map *map);
> >  struct bpf_map *__bpf_map_inc_not_zero(struct bpf_map *map, bool uref);
> > diff --git a/include/linux/btf.h b/include/linux/btf.h
> > index 4214e76c9168..69159e649675 100644
> > --- a/include/linux/btf.h
> > +++ b/include/linux/btf.h
> > @@ -4,6 +4,7 @@
> >  #ifndef _LINUX_BTF_H
> >  #define _LINUX_BTF_H 1
> >
> > +#include <linux/file.h>
> 
> do we need this in linux/btf.h header?

Thanks, removed.

> >  #include <linux/types.h>
> >  #include <linux/bpfptr.h>
> >  #include <linux/bsearch.h>
> > @@ -143,6 +144,7 @@ void btf_get(struct btf *btf);
> >  void btf_put(struct btf *btf);
> >  const struct btf_header *btf_header(const struct btf *btf);
> >  int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz);
> > +
> 
> ?

Thanks, removed.

> >  struct btf *btf_get_by_fd(int fd);
> >  int btf_get_info_by_fd(const struct btf *btf,
> >                        const union bpf_attr *attr,
> > diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> > index e7a59e6462a9..ad5310fa1d3b 100644
> > --- a/kernel/bpf/btf.c
> > +++ b/kernel/bpf/btf.c
> > @@ -7743,17 +7743,12 @@ int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_size)
> >
> >  struct btf *btf_get_by_fd(int fd)
> >  {
> > -       struct btf *btf;
> >         CLASS(fd, f)(fd);
> > +       struct btf *btf;
> 
> nit: no need to just move this around

Ok, I can remove it. I moved it to form a reverse xmas tree,
as I was already editing this function.

> 
> 
> >
> > -       if (fd_empty(f))
> > -               return ERR_PTR(-EBADF);
> > -
> > -       if (fd_file(f)->f_op != &btf_fops)
> > -               return ERR_PTR(-EINVAL);
> > -
> > -       btf = fd_file(f)->private_data;
> > -       refcount_inc(&btf->refcnt);
> > +       btf = __btf_get_by_fd(f);
> > +       if (!IS_ERR(btf))
> > +               refcount_inc(&btf->refcnt);
> >
> >         return btf;
> >  }
> > --
> > 2.34.1
> >
> >
Andrii Nakryiko Dec. 4, 2024, 5:58 p.m. UTC | #3
On Wed, Dec 4, 2024 at 2:39 AM Anton Protopopov <aspsk@isovalent.com> wrote:
>
> On 24/12/03 01:25PM, Andrii Nakryiko wrote:
> > On Tue, Dec 3, 2024 at 5:48 AM Anton Protopopov <aspsk@isovalent.com> wrote:
> > >
> > > Add a new helper to get a pointer to a struct btf from a file
> > > descriptor. This helper doesn't increase a refcnt. Add a comment
> > > explaining this and pointing to a corresponding function which
> > > does take a reference.
> > >
> > > Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
> > > ---
> > >  include/linux/bpf.h | 17 +++++++++++++++++
> > >  include/linux/btf.h |  2 ++
> > >  kernel/bpf/btf.c    | 13 ++++---------
> > >  3 files changed, 23 insertions(+), 9 deletions(-)
> > >
> >
> > Minor (but unexplained and/or unnecessary) things I pointed out below,
> > but overall looks good
> >
> > Acked-by: Andrii Nakryiko <andrii@kernel.org>
> >
> > > diff --git a/include/linux/bpf.h b/include/linux/bpf.h
> > > index eaee2a819f4c..ac44b857b2f9 100644
> > > --- a/include/linux/bpf.h
> > > +++ b/include/linux/bpf.h
> > > @@ -2301,6 +2301,14 @@ void __bpf_obj_drop_impl(void *p, const struct btf_record *rec, bool percpu);
> > >  struct bpf_map *bpf_map_get(u32 ufd);
> > >  struct bpf_map *bpf_map_get_with_uref(u32 ufd);
> > >
> > > +/*
> > > + * The __bpf_map_get() and __btf_get_by_fd() functions parse a file
> > > + * descriptor and return a corresponding map or btf object.
> > > + * Their names are double underscored to emphasize the fact that they
> > > + * do not increase refcnt. To also increase refcnt use corresponding
> > > + * bpf_map_get() and btf_get_by_fd() functions.
> > > + */
> > > +
> > >  static inline struct bpf_map *__bpf_map_get(struct fd f)
> > >  {
> > >         if (fd_empty(f))
> > > @@ -2310,6 +2318,15 @@ static inline struct bpf_map *__bpf_map_get(struct fd f)
> > >         return fd_file(f)->private_data;
> > >  }
> > >
> > > +static inline struct btf *__btf_get_by_fd(struct fd f)
> > > +{
> > > +       if (fd_empty(f))
> > > +               return ERR_PTR(-EBADF);
> > > +       if (unlikely(fd_file(f)->f_op != &btf_fops))
> > > +               return ERR_PTR(-EINVAL);
> > > +       return fd_file(f)->private_data;
> > > +}
> > > +
> > >  void bpf_map_inc(struct bpf_map *map);
> > >  void bpf_map_inc_with_uref(struct bpf_map *map);
> > >  struct bpf_map *__bpf_map_inc_not_zero(struct bpf_map *map, bool uref);
> > > diff --git a/include/linux/btf.h b/include/linux/btf.h
> > > index 4214e76c9168..69159e649675 100644
> > > --- a/include/linux/btf.h
> > > +++ b/include/linux/btf.h
> > > @@ -4,6 +4,7 @@
> > >  #ifndef _LINUX_BTF_H
> > >  #define _LINUX_BTF_H 1
> > >
> > > +#include <linux/file.h>
> >
> > do we need this in linux/btf.h header?
>
> Thanks, removed.
>
> > >  #include <linux/types.h>
> > >  #include <linux/bpfptr.h>
> > >  #include <linux/bsearch.h>
> > > @@ -143,6 +144,7 @@ void btf_get(struct btf *btf);
> > >  void btf_put(struct btf *btf);
> > >  const struct btf_header *btf_header(const struct btf *btf);
> > >  int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz);
> > > +
> >
> > ?
>
> Thanks, removed.
>
> > >  struct btf *btf_get_by_fd(int fd);
> > >  int btf_get_info_by_fd(const struct btf *btf,
> > >                        const union bpf_attr *attr,
> > > diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> > > index e7a59e6462a9..ad5310fa1d3b 100644
> > > --- a/kernel/bpf/btf.c
> > > +++ b/kernel/bpf/btf.c
> > > @@ -7743,17 +7743,12 @@ int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_size)
> > >
> > >  struct btf *btf_get_by_fd(int fd)
> > >  {
> > > -       struct btf *btf;
> > >         CLASS(fd, f)(fd);
> > > +       struct btf *btf;
> >
> > nit: no need to just move this around
>
> Ok, I can remove it. I moved it to form a reverse xmas tree,
> as I was already editing this function.

we don't enforce the, or adjust to, reverse xmas tree styling, so please don't

>
> >
> >
> > >
> > > -       if (fd_empty(f))
> > > -               return ERR_PTR(-EBADF);
> > > -
> > > -       if (fd_file(f)->f_op != &btf_fops)
> > > -               return ERR_PTR(-EINVAL);
> > > -
> > > -       btf = fd_file(f)->private_data;
> > > -       refcount_inc(&btf->refcnt);
> > > +       btf = __btf_get_by_fd(f);
> > > +       if (!IS_ERR(btf))
> > > +               refcount_inc(&btf->refcnt);
> > >
> > >         return btf;
> > >  }
> > > --
> > > 2.34.1
> > >
> > >
Anton Protopopov Dec. 5, 2024, 8:33 a.m. UTC | #4
On 24/12/04 09:58AM, Andrii Nakryiko wrote:
> On Wed, Dec 4, 2024 at 2:39 AM Anton Protopopov <aspsk@isovalent.com> wrote:
> >
> > On 24/12/03 01:25PM, Andrii Nakryiko wrote:
> > > On Tue, Dec 3, 2024 at 5:48 AM Anton Protopopov <aspsk@isovalent.com> wrote:
> > > >
> > > > Add a new helper to get a pointer to a struct btf from a file
> > > > descriptor. This helper doesn't increase a refcnt. Add a comment
> > > > explaining this and pointing to a corresponding function which
> > > > does take a reference.
> > > >
> > > > Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
> > > > ---
> > > >  include/linux/bpf.h | 17 +++++++++++++++++
> > > >  include/linux/btf.h |  2 ++
> > > >  kernel/bpf/btf.c    | 13 ++++---------
> > > >  3 files changed, 23 insertions(+), 9 deletions(-)
> > > >
> > >
> > > Minor (but unexplained and/or unnecessary) things I pointed out below,
> > > but overall looks good
> > >
> > > Acked-by: Andrii Nakryiko <andrii@kernel.org>
> > >
> > > > diff --git a/include/linux/bpf.h b/include/linux/bpf.h
> > > > index eaee2a819f4c..ac44b857b2f9 100644
> > > > --- a/include/linux/bpf.h
> > > > +++ b/include/linux/bpf.h
> > > > @@ -2301,6 +2301,14 @@ void __bpf_obj_drop_impl(void *p, const struct btf_record *rec, bool percpu);
> > > >  struct bpf_map *bpf_map_get(u32 ufd);
> > > >  struct bpf_map *bpf_map_get_with_uref(u32 ufd);
> > > >
> > > > +/*
> > > > + * The __bpf_map_get() and __btf_get_by_fd() functions parse a file
> > > > + * descriptor and return a corresponding map or btf object.
> > > > + * Their names are double underscored to emphasize the fact that they
> > > > + * do not increase refcnt. To also increase refcnt use corresponding
> > > > + * bpf_map_get() and btf_get_by_fd() functions.
> > > > + */
> > > > +
> > > >  static inline struct bpf_map *__bpf_map_get(struct fd f)
> > > >  {
> > > >         if (fd_empty(f))
> > > > @@ -2310,6 +2318,15 @@ static inline struct bpf_map *__bpf_map_get(struct fd f)
> > > >         return fd_file(f)->private_data;
> > > >  }
> > > >
> > > > +static inline struct btf *__btf_get_by_fd(struct fd f)
> > > > +{
> > > > +       if (fd_empty(f))
> > > > +               return ERR_PTR(-EBADF);
> > > > +       if (unlikely(fd_file(f)->f_op != &btf_fops))
> > > > +               return ERR_PTR(-EINVAL);
> > > > +       return fd_file(f)->private_data;
> > > > +}
> > > > +
> > > >  void bpf_map_inc(struct bpf_map *map);
> > > >  void bpf_map_inc_with_uref(struct bpf_map *map);
> > > >  struct bpf_map *__bpf_map_inc_not_zero(struct bpf_map *map, bool uref);
> > > > diff --git a/include/linux/btf.h b/include/linux/btf.h
> > > > index 4214e76c9168..69159e649675 100644
> > > > --- a/include/linux/btf.h
> > > > +++ b/include/linux/btf.h
> > > > @@ -4,6 +4,7 @@
> > > >  #ifndef _LINUX_BTF_H
> > > >  #define _LINUX_BTF_H 1
> > > >
> > > > +#include <linux/file.h>
> > >
> > > do we need this in linux/btf.h header?
> >
> > Thanks, removed.
> >
> > > >  #include <linux/types.h>
> > > >  #include <linux/bpfptr.h>
> > > >  #include <linux/bsearch.h>
> > > > @@ -143,6 +144,7 @@ void btf_get(struct btf *btf);
> > > >  void btf_put(struct btf *btf);
> > > >  const struct btf_header *btf_header(const struct btf *btf);
> > > >  int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz);
> > > > +
> > >
> > > ?
> >
> > Thanks, removed.
> >
> > > >  struct btf *btf_get_by_fd(int fd);
> > > >  int btf_get_info_by_fd(const struct btf *btf,
> > > >                        const union bpf_attr *attr,
> > > > diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
> > > > index e7a59e6462a9..ad5310fa1d3b 100644
> > > > --- a/kernel/bpf/btf.c
> > > > +++ b/kernel/bpf/btf.c
> > > > @@ -7743,17 +7743,12 @@ int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_size)
> > > >
> > > >  struct btf *btf_get_by_fd(int fd)
> > > >  {
> > > > -       struct btf *btf;
> > > >         CLASS(fd, f)(fd);
> > > > +       struct btf *btf;
> > >
> > > nit: no need to just move this around
> >
> > Ok, I can remove it. I moved it to form a reverse xmas tree,
> > as I was already editing this function.
> 
> we don't enforce the, or adjust to, reverse xmas tree styling, so please don't

Ok, thanks, good to know. I've removed this diff.

> >
> > >
> > >
> > > >
> > > > -       if (fd_empty(f))
> > > > -               return ERR_PTR(-EBADF);
> > > > -
> > > > -       if (fd_file(f)->f_op != &btf_fops)
> > > > -               return ERR_PTR(-EINVAL);
> > > > -
> > > > -       btf = fd_file(f)->private_data;
> > > > -       refcount_inc(&btf->refcnt);
> > > > +       btf = __btf_get_by_fd(f);
> > > > +       if (!IS_ERR(btf))
> > > > +               refcount_inc(&btf->refcnt);
> > > >
> > > >         return btf;
> > > >  }
> > > > --
> > > > 2.34.1
> > > >
> > > >
diff mbox series

Patch

diff --git a/include/linux/bpf.h b/include/linux/bpf.h
index eaee2a819f4c..ac44b857b2f9 100644
--- a/include/linux/bpf.h
+++ b/include/linux/bpf.h
@@ -2301,6 +2301,14 @@  void __bpf_obj_drop_impl(void *p, const struct btf_record *rec, bool percpu);
 struct bpf_map *bpf_map_get(u32 ufd);
 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
 
+/*
+ * The __bpf_map_get() and __btf_get_by_fd() functions parse a file
+ * descriptor and return a corresponding map or btf object.
+ * Their names are double underscored to emphasize the fact that they
+ * do not increase refcnt. To also increase refcnt use corresponding
+ * bpf_map_get() and btf_get_by_fd() functions.
+ */
+
 static inline struct bpf_map *__bpf_map_get(struct fd f)
 {
 	if (fd_empty(f))
@@ -2310,6 +2318,15 @@  static inline struct bpf_map *__bpf_map_get(struct fd f)
 	return fd_file(f)->private_data;
 }
 
+static inline struct btf *__btf_get_by_fd(struct fd f)
+{
+	if (fd_empty(f))
+		return ERR_PTR(-EBADF);
+	if (unlikely(fd_file(f)->f_op != &btf_fops))
+		return ERR_PTR(-EINVAL);
+	return fd_file(f)->private_data;
+}
+
 void bpf_map_inc(struct bpf_map *map);
 void bpf_map_inc_with_uref(struct bpf_map *map);
 struct bpf_map *__bpf_map_inc_not_zero(struct bpf_map *map, bool uref);
diff --git a/include/linux/btf.h b/include/linux/btf.h
index 4214e76c9168..69159e649675 100644
--- a/include/linux/btf.h
+++ b/include/linux/btf.h
@@ -4,6 +4,7 @@ 
 #ifndef _LINUX_BTF_H
 #define _LINUX_BTF_H 1
 
+#include <linux/file.h>
 #include <linux/types.h>
 #include <linux/bpfptr.h>
 #include <linux/bsearch.h>
@@ -143,6 +144,7 @@  void btf_get(struct btf *btf);
 void btf_put(struct btf *btf);
 const struct btf_header *btf_header(const struct btf *btf);
 int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz);
+
 struct btf *btf_get_by_fd(int fd);
 int btf_get_info_by_fd(const struct btf *btf,
 		       const union bpf_attr *attr,
diff --git a/kernel/bpf/btf.c b/kernel/bpf/btf.c
index e7a59e6462a9..ad5310fa1d3b 100644
--- a/kernel/bpf/btf.c
+++ b/kernel/bpf/btf.c
@@ -7743,17 +7743,12 @@  int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_size)
 
 struct btf *btf_get_by_fd(int fd)
 {
-	struct btf *btf;
 	CLASS(fd, f)(fd);
+	struct btf *btf;
 
-	if (fd_empty(f))
-		return ERR_PTR(-EBADF);
-
-	if (fd_file(f)->f_op != &btf_fops)
-		return ERR_PTR(-EINVAL);
-
-	btf = fd_file(f)->private_data;
-	refcount_inc(&btf->refcnt);
+	btf = __btf_get_by_fd(f);
+	if (!IS_ERR(btf))
+		refcount_inc(&btf->refcnt);
 
 	return btf;
 }