diff mbox series

[bpf-next,v3,1/8] libbpf: Introduce bpf_{btf,link,map,prog}_get_info_by_fd()

Message ID 20230214231221.249277-2-iii@linux.ibm.com (mailing list archive)
State Accepted
Commit 55a9ed0e16baf4d025c160d46bc1e3fac0d4cdc4
Delegated to: BPF
Headers show
Series Add Memory Sanitizer support | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for bpf-next, async
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers warning 8 maintainers not CCed: john.fastabend@gmail.com sdf@google.com jolsa@kernel.org song@kernel.org martin.lau@linux.dev haoluo@google.com yhs@fb.com kpsingh@kernel.org
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
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: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 58 lines checked
netdev/kdoc success Errors and warnings before: 8 this patch: 8
netdev/source_inline success Was 0 now: 0
bpf/vmtest-bpf-next-PR success PR summary
bpf/vmtest-bpf-next-VM_Test-1 success Logs for ShellCheck
bpf/vmtest-bpf-next-VM_Test-7 success Logs for llvm-toolchain
bpf/vmtest-bpf-next-VM_Test-8 success Logs for set-matrix
bpf/vmtest-bpf-next-VM_Test-2 success Logs for build for aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-3 success Logs for build for aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-5 success Logs for build for x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-6 success Logs for build for x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-4 success Logs for build for s390x with gcc
bpf/vmtest-bpf-next-VM_Test-9 success Logs for test_maps on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-12 success Logs for test_maps on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-13 success Logs for test_maps on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-14 success Logs for test_progs on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-17 success Logs for test_progs on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-19 success Logs for test_progs_no_alu32 on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-22 success Logs for test_progs_no_alu32 on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-23 success Logs for test_progs_no_alu32 on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-24 success Logs for test_progs_no_alu32_parallel on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-27 success Logs for test_progs_no_alu32_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-32 success Logs for test_progs_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-33 success Logs for test_progs_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-34 success Logs for test_verifier on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-37 success Logs for test_verifier on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-38 success Logs for test_verifier on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-10 success Logs for test_maps on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-15 success Logs for test_progs on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-18 success Logs for test_progs on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-20 success Logs for test_progs_no_alu32 on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-25 success Logs for test_progs_no_alu32_parallel on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-28 success Logs for test_progs_no_alu32_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-29 success Logs for test_progs_parallel on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-30 success Logs for test_progs_parallel on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-35 success Logs for test_verifier on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-16 success Logs for test_progs on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-21 success Logs for test_progs_no_alu32 on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-31 success Logs for test_progs_parallel on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-36 success Logs for test_verifier on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-26 success Logs for test_progs_no_alu32_parallel on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-11 success Logs for test_maps on s390x with gcc

Commit Message

Ilya Leoshkevich Feb. 14, 2023, 11:12 p.m. UTC 
These are type-safe wrappers around bpf_obj_get_info_by_fd(). They
found one problem in selftests, and are also useful for adding
Memory Sanitizer annotations.

Signed-off-by: Ilya Leoshkevich <iii@linux.ibm.com>
---
 tools/lib/bpf/bpf.c      | 24 ++++++++++++++++++++++++
 tools/lib/bpf/bpf.h      | 13 +++++++++++++
 tools/lib/bpf/libbpf.map |  5 +++++
 3 files changed, 42 insertions(+)

Comments

Andrii Nakryiko Feb. 16, 2023, 11:08 p.m. UTC | #1 
On Tue, Feb 14, 2023 at 3:12 PM Ilya Leoshkevich <iii@linux.ibm.com> wrote:
>
> These are type-safe wrappers around bpf_obj_get_info_by_fd(). They
> found one problem in selftests, and are also useful for adding
> Memory Sanitizer annotations.
>
> Signed-off-by: Ilya Leoshkevich <iii@linux.ibm.com>
> ---
>  tools/lib/bpf/bpf.c      | 24 ++++++++++++++++++++++++
>  tools/lib/bpf/bpf.h      | 13 +++++++++++++
>  tools/lib/bpf/libbpf.map |  5 +++++
>  3 files changed, 42 insertions(+)
>
> diff --git a/tools/lib/bpf/bpf.c b/tools/lib/bpf/bpf.c
> index 9aff98f42a3d..b562019271fe 100644
> --- a/tools/lib/bpf/bpf.c
> +++ b/tools/lib/bpf/bpf.c
> @@ -1044,6 +1044,30 @@ int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len)
>         return libbpf_err_errno(err);
>  }
>
> +int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
> +                           __u32 *info_len)
> +{
> +       return bpf_obj_get_info_by_fd(prog_fd, info, info_len);
> +}
> +
> +int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
> +                          __u32 *info_len)
> +{
> +       return bpf_obj_get_info_by_fd(map_fd, info, info_len);
> +}
> +
> +int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
> +                          __u32 *info_len)
> +{
> +       return bpf_obj_get_info_by_fd(btf_fd, info, info_len);
> +}
> +
> +int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
> +                           __u32 *info_len)

fits under 100 characters, please keep on single line

> +{
> +       return bpf_obj_get_info_by_fd(link_fd, info, info_len);
> +}
> +
>  int bpf_raw_tracepoint_open(const char *name, int prog_fd)
>  {
>         const size_t attr_sz = offsetofend(union bpf_attr, raw_tracepoint);
> diff --git a/tools/lib/bpf/bpf.h b/tools/lib/bpf/bpf.h
> index 7468978d3c27..9f698088c9bc 100644
> --- a/tools/lib/bpf/bpf.h
> +++ b/tools/lib/bpf/bpf.h
> @@ -386,6 +386,19 @@ LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
>  LIBBPF_API int bpf_link_get_fd_by_id_opts(__u32 id,
>                                 const struct bpf_get_fd_by_id_opts *opts);
>  LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
> +/* Type-safe variants of bpf_obj_get_info_by_fd(). The callers still needs to
> + * pass info_len, which should normally be
> + * sizeof(struct bpf_{prog,map,btf,link}_info), in order to be compatible with
> + * different libbpf and kernel versions.
> + */

let's add proper doc comments for new APIs, see bpf_map_update_batch
for an example

> +LIBBPF_API int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
> +                                      __u32 *info_len);
> +LIBBPF_API int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
> +                                     __u32 *info_len);
> +LIBBPF_API int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
> +                                     __u32 *info_len);
> +LIBBPF_API int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
> +                                      __u32 *info_len);
>

ditto, single lines are the best

>  struct bpf_prog_query_opts {
>         size_t sz; /* size of this struct for forward/backward compatibility */
> diff --git a/tools/lib/bpf/libbpf.map b/tools/lib/bpf/libbpf.map
> index 11c36a3c1a9f..50dde1f6521e 100644
> --- a/tools/lib/bpf/libbpf.map
> +++ b/tools/lib/bpf/libbpf.map
> @@ -384,4 +384,9 @@ LIBBPF_1.1.0 {
>  } LIBBPF_1.0.0;
>
>  LIBBPF_1.2.0 {
> +       global:
> +               bpf_btf_get_info_by_fd;
> +               bpf_link_get_info_by_fd;
> +               bpf_map_get_info_by_fd;
> +               bpf_prog_get_info_by_fd;
>  } LIBBPF_1.1.0;
> --
> 2.39.1
>
Andrii Nakryiko Feb. 16, 2023, 11:37 p.m. UTC | #2 
On Thu, Feb 16, 2023 at 3:08 PM Andrii Nakryiko
<andrii.nakryiko@gmail.com> wrote:
>
> On Tue, Feb 14, 2023 at 3:12 PM Ilya Leoshkevich <iii@linux.ibm.com> wrote:
> >
> > These are type-safe wrappers around bpf_obj_get_info_by_fd(). They
> > found one problem in selftests, and are also useful for adding
> > Memory Sanitizer annotations.
> >
> > Signed-off-by: Ilya Leoshkevich <iii@linux.ibm.com>
> > ---
> >  tools/lib/bpf/bpf.c      | 24 ++++++++++++++++++++++++
> >  tools/lib/bpf/bpf.h      | 13 +++++++++++++
> >  tools/lib/bpf/libbpf.map |  5 +++++
> >  3 files changed, 42 insertions(+)
> >
> > diff --git a/tools/lib/bpf/bpf.c b/tools/lib/bpf/bpf.c
> > index 9aff98f42a3d..b562019271fe 100644
> > --- a/tools/lib/bpf/bpf.c
> > +++ b/tools/lib/bpf/bpf.c
> > @@ -1044,6 +1044,30 @@ int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len)
> >         return libbpf_err_errno(err);
> >  }
> >
> > +int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
> > +                           __u32 *info_len)
> > +{
> > +       return bpf_obj_get_info_by_fd(prog_fd, info, info_len);
> > +}
> > +
> > +int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
> > +                          __u32 *info_len)
> > +{
> > +       return bpf_obj_get_info_by_fd(map_fd, info, info_len);
> > +}
> > +
> > +int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
> > +                          __u32 *info_len)
> > +{
> > +       return bpf_obj_get_info_by_fd(btf_fd, info, info_len);
> > +}
> > +
> > +int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
> > +                           __u32 *info_len)
>
> fits under 100 characters, please keep on single line
>
> > +{
> > +       return bpf_obj_get_info_by_fd(link_fd, info, info_len);
> > +}
> > +
> >  int bpf_raw_tracepoint_open(const char *name, int prog_fd)
> >  {
> >         const size_t attr_sz = offsetofend(union bpf_attr, raw_tracepoint);
> > diff --git a/tools/lib/bpf/bpf.h b/tools/lib/bpf/bpf.h
> > index 7468978d3c27..9f698088c9bc 100644
> > --- a/tools/lib/bpf/bpf.h
> > +++ b/tools/lib/bpf/bpf.h
> > @@ -386,6 +386,19 @@ LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
> >  LIBBPF_API int bpf_link_get_fd_by_id_opts(__u32 id,
> >                                 const struct bpf_get_fd_by_id_opts *opts);
> >  LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
> > +/* Type-safe variants of bpf_obj_get_info_by_fd(). The callers still needs to
> > + * pass info_len, which should normally be
> > + * sizeof(struct bpf_{prog,map,btf,link}_info), in order to be compatible with
> > + * different libbpf and kernel versions.
> > + */
>
> let's add proper doc comments for new APIs, see bpf_map_update_batch
> for an example
>

It was sad to require you to respin first 5 patches because of this
doc comment issue, so I unwrapped lines and landed first 5 patches as
is. Please do follow up with doc comments, and let's figure out what
we do about MSan annotations separately. Thanks for clean ups and
improvements!

> > +LIBBPF_API int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
> > +                                      __u32 *info_len);
> > +LIBBPF_API int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
> > +                                     __u32 *info_len);
> > +LIBBPF_API int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
> > +                                     __u32 *info_len);
> > +LIBBPF_API int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
> > +                                      __u32 *info_len);
> >
>
> ditto, single lines are the best
>
> >  struct bpf_prog_query_opts {
> >         size_t sz; /* size of this struct for forward/backward compatibility */
> > diff --git a/tools/lib/bpf/libbpf.map b/tools/lib/bpf/libbpf.map
> > index 11c36a3c1a9f..50dde1f6521e 100644
> > --- a/tools/lib/bpf/libbpf.map
> > +++ b/tools/lib/bpf/libbpf.map
> > @@ -384,4 +384,9 @@ LIBBPF_1.1.0 {
> >  } LIBBPF_1.0.0;
> >
> >  LIBBPF_1.2.0 {
> > +       global:
> > +               bpf_btf_get_info_by_fd;
> > +               bpf_link_get_info_by_fd;
> > +               bpf_map_get_info_by_fd;
> > +               bpf_prog_get_info_by_fd;
> >  } LIBBPF_1.1.0;
> > --
> > 2.39.1
> >
diff mbox series

Patch

diff --git a/tools/lib/bpf/bpf.c b/tools/lib/bpf/bpf.c
index 9aff98f42a3d..b562019271fe 100644
--- a/tools/lib/bpf/bpf.c
+++ b/tools/lib/bpf/bpf.c
@@ -1044,6 +1044,30 @@  int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len)
 	return libbpf_err_errno(err);
 }
 
+int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
+			    __u32 *info_len)
+{
+	return bpf_obj_get_info_by_fd(prog_fd, info, info_len);
+}
+
+int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
+			   __u32 *info_len)
+{
+	return bpf_obj_get_info_by_fd(map_fd, info, info_len);
+}
+
+int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
+			   __u32 *info_len)
+{
+	return bpf_obj_get_info_by_fd(btf_fd, info, info_len);
+}
+
+int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
+			    __u32 *info_len)
+{
+	return bpf_obj_get_info_by_fd(link_fd, info, info_len);
+}
+
 int bpf_raw_tracepoint_open(const char *name, int prog_fd)
 {
 	const size_t attr_sz = offsetofend(union bpf_attr, raw_tracepoint);
diff --git a/tools/lib/bpf/bpf.h b/tools/lib/bpf/bpf.h
index 7468978d3c27..9f698088c9bc 100644
--- a/tools/lib/bpf/bpf.h
+++ b/tools/lib/bpf/bpf.h
@@ -386,6 +386,19 @@  LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
 LIBBPF_API int bpf_link_get_fd_by_id_opts(__u32 id,
 				const struct bpf_get_fd_by_id_opts *opts);
 LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
+/* Type-safe variants of bpf_obj_get_info_by_fd(). The callers still needs to
+ * pass info_len, which should normally be
+ * sizeof(struct bpf_{prog,map,btf,link}_info), in order to be compatible with
+ * different libbpf and kernel versions.
+ */
+LIBBPF_API int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info,
+				       __u32 *info_len);
+LIBBPF_API int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info,
+				      __u32 *info_len);
+LIBBPF_API int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info,
+				      __u32 *info_len);
+LIBBPF_API int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info,
+				       __u32 *info_len);
 
 struct bpf_prog_query_opts {
 	size_t sz; /* size of this struct for forward/backward compatibility */
diff --git a/tools/lib/bpf/libbpf.map b/tools/lib/bpf/libbpf.map
index 11c36a3c1a9f..50dde1f6521e 100644
--- a/tools/lib/bpf/libbpf.map
+++ b/tools/lib/bpf/libbpf.map
@@ -384,4 +384,9 @@  LIBBPF_1.1.0 {
 } LIBBPF_1.0.0;
 
 LIBBPF_1.2.0 {
+	global:
+		bpf_btf_get_info_by_fd;
+		bpf_link_get_info_by_fd;
+		bpf_map_get_info_by_fd;
+		bpf_prog_get_info_by_fd;
 } LIBBPF_1.1.0;