diff mbox series

[bpf-next,1/2] libbpf: Deprecate bpf_{map,program}__{prev,next} APIs

Message ID 20210906165456.325999-1-hengqi.chen@gmail.com (mailing list archive)
State Changes Requested
Delegated to: BPF
Headers show
Series [bpf-next,1/2] libbpf: Deprecate bpf_{map,program}__{prev,next} APIs | expand

Checks

Context Check Description
netdev/cover_letter success Link
netdev/fixes_present success Link
netdev/patch_count success Link
netdev/tree_selection success Clearly marked for bpf-next
netdev/subject_prefix success Link
netdev/cc_maintainers warning 4 maintainers not CCed: songliubraving@fb.com kpsingh@kernel.org kafai@fb.com netdev@vger.kernel.org
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Link
netdev/module_param success Was 0 now: 0
netdev/build_32bit fail Errors and warnings before: 821 this patch: 949
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/verify_fixes success Link
netdev/checkpatch warning CHECK: Alignment should match open parenthesis WARNING: Prefer __alias("bpf_object__next_map") over __attribute__((alias("bpf_object__next_map"))) WARNING: Prefer __alias("bpf_object__next_program") over __attribute__((alias("bpf_object__next_program"))) WARNING: Prefer __alias("bpf_object__prev_map") over __attribute__((alias("bpf_object__prev_map"))) WARNING: Prefer __alias("bpf_object__prev_program") over __attribute__((alias("bpf_object__prev_program"))) WARNING: line length of 105 exceeds 80 columns WARNING: line length of 81 exceeds 80 columns WARNING: line length of 86 exceeds 80 columns WARNING: line length of 87 exceeds 80 columns WARNING: line length of 88 exceeds 80 columns WARNING: line length of 94 exceeds 80 columns WARNING: line length of 97 exceeds 80 columns
netdev/build_allmodconfig_warn fail Errors and warnings before: 1549 this patch: 670
netdev/header_inline success Link
bpf/vmtest-bpf-next-PR success PR summary
bpf/vmtest-bpf-next success VM_Test

Commit Message

Hengqi Chen Sept. 6, 2021, 4:54 p.m. UTC 
Deprecate bpf_{map,program}__{prev,next} APIs. Replace them with
a new set of APIs named bpf_object__{prev,next}_{program,map} which
follow the libbpf API naming convention. No functionality changes.

Closes: https://github.com/libbpf/libbpf/issues/296
Signed-off-by: Hengqi Chen <hengqi.chen@gmail.com>
---
 tools/lib/bpf/libbpf.c   | 24 ++++++++++++++++++------
 tools/lib/bpf/libbpf.h   | 30 ++++++++++++++++++++----------
 tools/lib/bpf/libbpf.map |  4 ++++
 3 files changed, 42 insertions(+), 16 deletions(-)

--
2.30.2

Comments

Andrii Nakryiko Sept. 9, 2021, 4:44 a.m. UTC | #1 
On Mon, Sep 6, 2021 at 9:55 AM Hengqi Chen <hengqi.chen@gmail.com> wrote:
>
> Deprecate bpf_{map,program}__{prev,next} APIs. Replace them with
> a new set of APIs named bpf_object__{prev,next}_{program,map} which
> follow the libbpf API naming convention. No functionality changes.
>
> Closes: https://github.com/libbpf/libbpf/issues/296

I'm hesitant about using Closes: as if it was a proper Linux tag.
Let's stick to using it in a reference:

   [0] Closes: ...


> Signed-off-by: Hengqi Chen <hengqi.chen@gmail.com>
> ---
>  tools/lib/bpf/libbpf.c   | 24 ++++++++++++++++++------
>  tools/lib/bpf/libbpf.h   | 30 ++++++++++++++++++++----------
>  tools/lib/bpf/libbpf.map |  4 ++++
>  3 files changed, 42 insertions(+), 16 deletions(-)
>
> diff --git a/tools/lib/bpf/libbpf.c b/tools/lib/bpf/libbpf.c
> index 88d8825fc6f6..8d82853fb4a0 100644
> --- a/tools/lib/bpf/libbpf.c
> +++ b/tools/lib/bpf/libbpf.c
> @@ -7347,7 +7347,7 @@ int bpf_object__pin_maps(struct bpf_object *obj, const char *path)
>         return 0;
>
>  err_unpin_maps:
> -       while ((map = bpf_map__prev(map, obj))) {
> +       while ((map = bpf_object__prev_map(map, obj))) {
>                 if (!map->pin_path)
>                         continue;
>
> @@ -7427,7 +7427,7 @@ int bpf_object__pin_programs(struct bpf_object *obj, const char *path)
>         return 0;
>
>  err_unpin_programs:
> -       while ((prog = bpf_program__prev(prog, obj))) {
> +       while ((prog = bpf_object__prev_program(prog, obj))) {
>                 char buf[PATH_MAX];
>                 int len;
>
> @@ -7666,8 +7666,11 @@ __bpf_program__iter(const struct bpf_program *p, const struct bpf_object *obj,
>         return &obj->programs[idx];
>  }
>
> +__attribute__((alias("bpf_object__next_program")))
> +struct bpf_program *bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj);
> +
>  struct bpf_program *
> -bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj)
> +bpf_object__next_program(struct bpf_program *prev, const struct bpf_object *obj)

I think for bpf_object__next_program it makes more sense to have obj
as the first argument (it's a "method" of bpf_object, after all). So
you can't have bpf_program__next aliased to bpf_object__next_program,
you have to add a small wrapper function. Same for other new APIs.

>  {
>         struct bpf_program *prog = prev;
>
> @@ -7678,8 +7681,11 @@ bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj)
>         return prog;
>  }
>

[...]

> diff --git a/tools/lib/bpf/libbpf.h b/tools/lib/bpf/libbpf.h
> index f177d897c5f7..e6aab4cd263b 100644
> --- a/tools/lib/bpf/libbpf.h
> +++ b/tools/lib/bpf/libbpf.h
> @@ -186,16 +186,22 @@ LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name,
>
>  /* Accessors of bpf_program */
>  struct bpf_program;
> -LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog,
> +LIBBPF_API LIBBPF_DEPRECATED("bpf_program__next() is deprecated, use bpf_object__next_program() instead")

We shouldn't deprecate API until the replacement API was already
released as part of an official libbpf release. I suggest to wait
until the LIBBPF_DEPRECATE_SINCE ([0]) patch lands first, and then
using that here to deprecate those APIs starting from 0.7 (because we
are now developing 0.6 libbpf).

  [0] https://patchwork.kernel.org/project/netdevbpf/patch/20210908213226.1871016-1-andrii@kernel.org/

> +struct bpf_program *bpf_program__next(struct bpf_program *prog,
>                                                  const struct bpf_object *obj);
> +LIBBPF_API struct bpf_program *bpf_object__next_program(struct bpf_program *prog,
> +                                                       const struct bpf_object *obj);
>

[...]

>  /* get/set map FD */
>  LIBBPF_API int bpf_map__fd(const struct bpf_map *map);
> diff --git a/tools/lib/bpf/libbpf.map b/tools/lib/bpf/libbpf.map
> index bbc53bb25f68..0c6d510e7747 100644
> --- a/tools/lib/bpf/libbpf.map
> +++ b/tools/lib/bpf/libbpf.map
> @@ -378,6 +378,10 @@ LIBBPF_0.5.0 {
>                 bpf_program__attach_tracepoint_opts;
>                 bpf_program__attach_uprobe_opts;
>                 bpf_object__gen_loader;
> +               bpf_object__next_map;
> +               bpf_object__next_program;
> +               bpf_object__prev_map;
> +               bpf_object__prev_program;

For next revision, please add the LIBBPF_0.6.0 section, libbpf 0.5 was
just released today, so we are now moving into the v0.6 development
cycle. Thanks!

>                 btf__load_from_kernel_by_id;
>                 btf__load_from_kernel_by_id_split;
>                 btf__load_into_kernel;
> --
> 2.30.2
diff mbox series

Patch

diff --git a/tools/lib/bpf/libbpf.c b/tools/lib/bpf/libbpf.c
index 88d8825fc6f6..8d82853fb4a0 100644
--- a/tools/lib/bpf/libbpf.c
+++ b/tools/lib/bpf/libbpf.c
@@ -7347,7 +7347,7 @@  int bpf_object__pin_maps(struct bpf_object *obj, const char *path)
 	return 0;

 err_unpin_maps:
-	while ((map = bpf_map__prev(map, obj))) {
+	while ((map = bpf_object__prev_map(map, obj))) {
 		if (!map->pin_path)
 			continue;

@@ -7427,7 +7427,7 @@  int bpf_object__pin_programs(struct bpf_object *obj, const char *path)
 	return 0;

 err_unpin_programs:
-	while ((prog = bpf_program__prev(prog, obj))) {
+	while ((prog = bpf_object__prev_program(prog, obj))) {
 		char buf[PATH_MAX];
 		int len;

@@ -7666,8 +7666,11 @@  __bpf_program__iter(const struct bpf_program *p, const struct bpf_object *obj,
 	return &obj->programs[idx];
 }

+__attribute__((alias("bpf_object__next_program")))
+struct bpf_program *bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj);
+
 struct bpf_program *
-bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj)
+bpf_object__next_program(struct bpf_program *prev, const struct bpf_object *obj)
 {
 	struct bpf_program *prog = prev;

@@ -7678,8 +7681,11 @@  bpf_program__next(struct bpf_program *prev, const struct bpf_object *obj)
 	return prog;
 }

+__attribute__((alias("bpf_object__prev_program")))
+struct bpf_program *bpf_program__prev(struct bpf_program *next, const struct bpf_object *obj);
+
 struct bpf_program *
-bpf_program__prev(struct bpf_program *next, const struct bpf_object *obj)
+bpf_object__prev_program(struct bpf_program *next, const struct bpf_object *obj)
 {
 	struct bpf_program *prog = next;

@@ -8698,8 +8704,11 @@  __bpf_map__iter(const struct bpf_map *m, const struct bpf_object *obj, int i)
 	return &obj->maps[idx];
 }

+__attribute__((alias("bpf_object__next_map")))
+struct bpf_map *bpf_map__next(const struct bpf_map *prev, const struct bpf_object *obj);
+
 struct bpf_map *
-bpf_map__next(const struct bpf_map *prev, const struct bpf_object *obj)
+bpf_object__next_map(const struct bpf_map *prev, const struct bpf_object *obj)
 {
 	if (prev == NULL)
 		return obj->maps;
@@ -8707,8 +8716,11 @@  bpf_map__next(const struct bpf_map *prev, const struct bpf_object *obj)
 	return __bpf_map__iter(prev, obj, 1);
 }

+__attribute__((alias("bpf_object__prev_map")))
+struct bpf_map *bpf_map__prev(const struct bpf_map *next, const struct bpf_object *obj);
+
 struct bpf_map *
-bpf_map__prev(const struct bpf_map *next, const struct bpf_object *obj)
+bpf_object__prev_map(const struct bpf_map *next, const struct bpf_object *obj)
 {
 	if (next == NULL) {
 		if (!obj->nr_maps)
diff --git a/tools/lib/bpf/libbpf.h b/tools/lib/bpf/libbpf.h
index f177d897c5f7..e6aab4cd263b 100644
--- a/tools/lib/bpf/libbpf.h
+++ b/tools/lib/bpf/libbpf.h
@@ -186,16 +186,22 @@  LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name,

 /* Accessors of bpf_program */
 struct bpf_program;
-LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog,
+LIBBPF_API LIBBPF_DEPRECATED("bpf_program__next() is deprecated, use bpf_object__next_program() instead")
+struct bpf_program *bpf_program__next(struct bpf_program *prog,
 						 const struct bpf_object *obj);
+LIBBPF_API struct bpf_program *bpf_object__next_program(struct bpf_program *prog,
+							const struct bpf_object *obj);

-#define bpf_object__for_each_program(pos, obj)		\
-	for ((pos) = bpf_program__next(NULL, (obj));	\
-	     (pos) != NULL;				\
-	     (pos) = bpf_program__next((pos), (obj)))
+#define bpf_object__for_each_program(pos, obj)			\
+	for ((pos) = bpf_object__next_program(NULL, (obj));	\
+	     (pos) != NULL;					\
+	     (pos) = bpf_object__next_program((pos), (obj)))

-LIBBPF_API struct bpf_program *bpf_program__prev(struct bpf_program *prog,
+LIBBPF_API LIBBPF_DEPRECATED("bpf_program__prev() is deprecated, use bpf_object__prev_program() instead")
+struct bpf_program *bpf_program__prev(struct bpf_program *prog,
 						 const struct bpf_object *obj);
+LIBBPF_API struct bpf_program *bpf_object__prev_program(struct bpf_program *prog,
+							const struct bpf_object *obj);

 typedef void (*bpf_program_clear_priv_t)(struct bpf_program *, void *);

@@ -495,16 +501,20 @@  bpf_object__find_map_fd_by_name(const struct bpf_object *obj, const char *name);
 LIBBPF_API struct bpf_map *
 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset);

+LIBBPF_API LIBBPF_DEPRECATED("bpf_map__next() is deprecated, use bpf_object__next_map() instead")
+struct bpf_map *bpf_map__next(const struct bpf_map *map, const struct bpf_object *obj);
 LIBBPF_API struct bpf_map *
-bpf_map__next(const struct bpf_map *map, const struct bpf_object *obj);
+bpf_object__next_map(const struct bpf_map *map, const struct bpf_object *obj);
 #define bpf_object__for_each_map(pos, obj)		\
-	for ((pos) = bpf_map__next(NULL, (obj));	\
+	for ((pos) = bpf_object__next_map(NULL, (obj));	\
 	     (pos) != NULL;				\
-	     (pos) = bpf_map__next((pos), (obj)))
+	     (pos) = bpf_object__next_map((pos), (obj)))
 #define bpf_map__for_each bpf_object__for_each_map

+LIBBPF_API LIBBPF_DEPRECATED("bpf_map__prev() is deprecated, use bpf_object__prev_map() instead")
+struct bpf_map *bpf_map__prev(const struct bpf_map *map, const struct bpf_object *obj);
 LIBBPF_API struct bpf_map *
-bpf_map__prev(const struct bpf_map *map, const struct bpf_object *obj);
+bpf_object__prev_map(const struct bpf_map *map, const struct bpf_object *obj);

 /* get/set map FD */
 LIBBPF_API int bpf_map__fd(const struct bpf_map *map);
diff --git a/tools/lib/bpf/libbpf.map b/tools/lib/bpf/libbpf.map
index bbc53bb25f68..0c6d510e7747 100644
--- a/tools/lib/bpf/libbpf.map
+++ b/tools/lib/bpf/libbpf.map
@@ -378,6 +378,10 @@  LIBBPF_0.5.0 {
 		bpf_program__attach_tracepoint_opts;
 		bpf_program__attach_uprobe_opts;
 		bpf_object__gen_loader;
+		bpf_object__next_map;
+		bpf_object__next_program;
+		bpf_object__prev_map;
+		bpf_object__prev_program;
 		btf__load_from_kernel_by_id;
 		btf__load_from_kernel_by_id_split;
 		btf__load_into_kernel;