Skip to contentSkip to conversation

libbpf: rename bpf_prog_attach_xattr to bpf_prog_attach_opts

PATCH Superseded Christy Lee 2 participants 2 messages Dec 30, 2021 – Jan 5, 2022

Subsystems (4)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libbpf: rename bpf_prog_attach_xattr to bpf_prog_attach_opts

All xattr APIs are being dropped, let's converge to the convention used in high-level APIs and rename bpf_prog_attach_xattr to bpf_prog_attach_opts.

[0] Closes: https://github.com/libbpf/libbpf/issues/285

---
 tools/lib/bpf/bpf.c                                  | 11 +++++++++--
 tools/lib/bpf/bpf.h                                  |  4 ++++
 tools/lib/bpf/libbpf.map                             |  1 +
 .../selftests/bpf/prog_tests/cgroup_attach_multi.c   | 12 ++++++------
 4 files changed, 20 insertions(+), 8 deletions(-)
tools/lib/bpf/bpf.c +9 -2
index 9b64eed2b003..19741cfcaf11 100644
@@ -754,10 +754,10 @@ int bpf_prog_attach(int prog_fd, int target_fd, enum bpf_attach_type type,
 		.flags = flags,
 	);
 
-	return bpf_prog_attach_xattr(prog_fd, target_fd, type, &opts);
+	return bpf_prog_attach_opts(prog_fd, target_fd, type, &opts);
 }
 
-int bpf_prog_attach_xattr(int prog_fd, int target_fd,
+int bpf_prog_attach_opts(int prog_fd, int target_fd,
 			  enum bpf_attach_type type,
 			  const struct bpf_prog_attach_opts *opts)
 {
@@ -778,6 +778,13 @@ int bpf_prog_attach_xattr(int prog_fd, int target_fd,
 	return libbpf_err_errno(ret);
 }
 
+int bpf_prog_attach_xattr(int prog_fd, int target_fd,
+			  enum bpf_attach_type type,
+			  const struct bpf_prog_attach_opts *opts)
+{
+	return bpf_prog_attach_opts(prog_fd, target_fd, type, opts);
+}
+
 int bpf_prog_detach(int target_fd, enum bpf_attach_type type)
 {
 	union bpf_attr attr;
tools/lib/bpf/bpf.h +4 -0
index 00619f64a040..5dc9fefe73f3 100644
@@ -280,6 +280,10 @@ struct bpf_prog_attach_opts {
 
 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
 			       enum bpf_attach_type type, unsigned int flags);
+LIBBPF_API int bpf_prog_attach_opts(int prog_fd, int attachable_fd,
+				     enum bpf_attach_type type,
+				     const struct bpf_prog_attach_opts *opts);
+LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_prog_attach_opts() instead")
 LIBBPF_API int bpf_prog_attach_xattr(int prog_fd, int attachable_fd,
 				     enum bpf_attach_type type,
 				     const struct bpf_prog_attach_opts *opts);
tools/lib/bpf/libbpf.map +1 -0
index 529783967793..be2bb69d1a12 100644
@@ -246,6 +246,7 @@ LIBBPF_0.0.8 {
 		bpf_link__update_program;
 		bpf_link_create;
 		bpf_link_update;
+		bpf_prog_attach_opts;
 		bpf_map__set_initial_value;
 		bpf_program__attach_cgroup;
 		bpf_program__attach_lsm;
tools/testing/selftests/bpf/prog_tests/cgroup_attach_multi.c +6 -6
index d3e8f729c623..38b3c47293da 100644
@@ -194,14 +194,14 @@ void serial_test_cgroup_attach_multi(void)
 
 	attach_opts.flags = BPF_F_ALLOW_OVERRIDE | BPF_F_REPLACE;
 	attach_opts.replace_prog_fd = allow_prog[0];
-	if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
 					 BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "fail_prog_replace_override", "unexpected success\n"))
 		goto err;
 	CHECK_FAIL(errno != EINVAL);
 
 	attach_opts.flags = BPF_F_REPLACE;
-	if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
 					 BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "fail_prog_replace_no_multi", "unexpected success\n"))
 		goto err;
@@ -209,7 +209,7 @@ void serial_test_cgroup_attach_multi(void)
 
 	attach_opts.flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE;
 	attach_opts.replace_prog_fd = -1;
-	if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
 					 BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "fail_prog_replace_bad_fd", "unexpected success\n"))
 		goto err;
@@ -217,7 +217,7 @@ void serial_test_cgroup_attach_multi(void)
 
 	/* replacing a program that is not attached to cgroup should fail  */
 	attach_opts.replace_prog_fd = allow_prog[3];
-	if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
 					 BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "fail_prog_replace_no_ent", "unexpected success\n"))
 		goto err;
@@ -225,14 +225,14 @@ void serial_test_cgroup_attach_multi(void)
 
 	/* replace 1st from the top program */
 	attach_opts.replace_prog_fd = allow_prog[0];
-	if (CHECK(bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(bpf_prog_attach_opts(allow_prog[6], cg1,
 					BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "prog_replace", "errno=%d\n", errno))
 		goto err;
 
 	/* replace program with itself */
 	attach_opts.replace_prog_fd = allow_prog[6];
-	if (CHECK(bpf_prog_attach_xattr(allow_prog[6], cg1,
+	if (CHECK(bpf_prog_attach_opts(allow_prog[6], cg1,
 					BPF_CGROUP_INET_EGRESS, &attach_opts),
 		  "prog_replace", "errno=%d\n", errno))
 		goto err;
Signature · 1 line
2.30.2
#1 lore raw
Quoted 5 lines · Christy Lee

All xattr APIs are being dropped, let's converge to the convention used in high-level APIs and rename bpf_prog_attach_xattr to bpf_prog_attach_opts.

[0] Closes: https://github.com/libbpf/libbpf/issues/285

nit: please add two spaces in front of [0]

Quoted 27 lines
---
 tools/lib/bpf/bpf.c                                  | 11 +++++++++--
 tools/lib/bpf/bpf.h                                  |  4 ++++
 tools/lib/bpf/libbpf.map                             |  1 +
 .../selftests/bpf/prog_tests/cgroup_attach_multi.c   | 12 ++++++------
 4 files changed, 20 insertions(+), 8 deletions(-)
tools/lib/bpf/bpf.c +2 -2
index 9b64eed2b003..19741cfcaf11 100644
@@ -754,10 +754,10 @@ int bpf_prog_attach(int prog_fd, int target_fd, enum bpf_attach_type type,
                .flags = flags,
        );
 
-       return bpf_prog_attach_xattr(prog_fd, target_fd, type, &opts);
+       return bpf_prog_attach_opts(prog_fd, target_fd, type, &opts);
 }
 
-int bpf_prog_attach_xattr(int prog_fd, int target_fd,
+int bpf_prog_attach_opts(int prog_fd, int target_fd,
                          enum bpf_attach_type type,
                          const struct bpf_prog_attach_opts *opts)
 {

tools/lib/bpf/bpf.c int bpf_prog_attach_xattr(int prog_fd, int target_fd, · line 786

Quoted 9 lines
tools/lib/bpf/bpf.c +6 -0
@@ -778,6 +778,13 @@ int bpf_prog_attach_xattr(int prog_fd, int target_fd,
        return libbpf_err_errno(ret);
 }
 
+int bpf_prog_attach_xattr(int prog_fd, int target_fd,
+                         enum bpf_attach_type type,
+                         const struct bpf_prog_attach_opts *opts)
+{
+       return bpf_prog_attach_opts(prog_fd, target_fd, type, opts);
+}

let's use alias instead

Quoted 24 lines
tools/lib/bpf/bpf.c +1 -0
+
 int bpf_prog_detach(int target_fd, enum bpf_attach_type type)
 {
        union bpf_attr attr;
tools/lib/bpf/bpf.h +4 -0
index 00619f64a040..5dc9fefe73f3 100644
@@ -280,6 +280,10 @@ struct bpf_prog_attach_opts {
 
 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
                               enum bpf_attach_type type, unsigned int flags);
+LIBBPF_API int bpf_prog_attach_opts(int prog_fd, int attachable_fd,
+                                    enum bpf_attach_type type,
+                                    const struct bpf_prog_attach_opts *opts);
+LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_prog_attach_opts() instead")
 LIBBPF_API int bpf_prog_attach_xattr(int prog_fd, int attachable_fd,
                                     enum bpf_attach_type type,
                                     const struct bpf_prog_attach_opts *opts);
tools/lib/bpf/libbpf.map +0 -0
index 529783967793..be2bb69d1a12 100644

tools/lib/bpf/libbpf.map LIBBPF_0.0.8 { · line 249

Quoted 4 lines
tools/lib/bpf/libbpf.map +1 -0
@@ -246,6 +246,7 @@ LIBBPF_0.0.8 {
                bpf_link__update_program;
                bpf_link_create;
                bpf_link_update;
+               bpf_prog_attach_opts;

keep the list sorted

Quoted 49 lines
tools/lib/bpf/libbpf.map +0 -0
                bpf_map__set_initial_value;
                bpf_program__attach_cgroup;
                bpf_program__attach_lsm;
tools/testing/selftests/bpf/prog_tests/cgroup_attach_multi.c +5 -5
index d3e8f729c623..38b3c47293da 100644
@@ -194,14 +194,14 @@ void serial_test_cgroup_attach_multi(void)
 
        attach_opts.flags = BPF_F_ALLOW_OVERRIDE | BPF_F_REPLACE;
        attach_opts.replace_prog_fd = allow_prog[0];
-       if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
                                         BPF_CGROUP_INET_EGRESS, &attach_opts),
                  "fail_prog_replace_override", "unexpected success\n"))
                goto err;
        CHECK_FAIL(errno != EINVAL);
 
        attach_opts.flags = BPF_F_REPLACE;
-       if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
                                         BPF_CGROUP_INET_EGRESS, &attach_opts),
                  "fail_prog_replace_no_multi", "unexpected success\n"))
                goto err;
@@ -209,7 +209,7 @@ void serial_test_cgroup_attach_multi(void)
 
        attach_opts.flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE;
        attach_opts.replace_prog_fd = -1;
-       if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
                                         BPF_CGROUP_INET_EGRESS, &attach_opts),
                  "fail_prog_replace_bad_fd", "unexpected success\n"))
                goto err;
@@ -217,7 +217,7 @@ void serial_test_cgroup_attach_multi(void)
 
        /* replacing a program that is not attached to cgroup should fail  */
        attach_opts.replace_prog_fd = allow_prog[3];
-       if (CHECK(!bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(!bpf_prog_attach_opts(allow_prog[6], cg1,
                                         BPF_CGROUP_INET_EGRESS, &attach_opts),
                  "fail_prog_replace_no_ent", "unexpected success\n"))
                goto err;
@@ -225,14 +225,14 @@ void serial_test_cgroup_attach_multi(void)
 
        /* replace 1st from the top program */
        attach_opts.replace_prog_fd = allow_prog[0];
-       if (CHECK(bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(bpf_prog_attach_opts(allow_prog[6], cg1,
                                        BPF_CGROUP_INET_EGRESS, &attach_opts),

tools/testing/selftests/bpf/prog_tests/cgroup_attach_multi.c void serial_test_cgroup_attach_multi(void) · line 238

Quoted 10 lines
tools/testing/selftests/bpf/prog_tests/cgroup_attach_multi.c +1 -1
                  "prog_replace", "errno=%d\n", errno))
                goto err;
 
        /* replace program with itself */
        attach_opts.replace_prog_fd = allow_prog[6];
-       if (CHECK(bpf_prog_attach_xattr(allow_prog[6], cg1,
+       if (CHECK(bpf_prog_attach_opts(allow_prog[6], cg1,
                                        BPF_CGROUP_INET_EGRESS, &attach_opts),
                  "prog_replace", "errno=%d\n", errno))
                goto err;

please split out selftests changes into a separate patch, doing this after libbpf change doesn't break the build nor generates compilation warnings (because deprecation is deferred), so it's ok to have it in a separate patch

Quoted 3 lines

--
2.30.2