Skip to contentSkip to conversation

selftests/bpf: validate eliminated global subprog is not freplaceable

PATCH Superseded Andrii Nakryiko 3 participants 6 messages Dec 1, 2023

Subsystems (3)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Andrii Nakryiko

author maintainer
#0 lore raw

PATCH 1/1 selftests/bpf: validate eliminated global subprog is not freplaceable

Add selftest that establishes dead code-eliminated valid global subprog (global_dead) and makes sure that it's not possible to freplace it, as it's effectively not there. This test will fail with unexpected success before 2afae08c9dcb ("bpf: Validate global subprogs lazily").

---
 .../bpf/prog_tests/global_func_dead_code.c    | 60 +++++++++++++++++++
 .../bpf/progs/freplace_dead_global_func.c     | 11 ++++
 .../bpf/progs/verifier_global_subprogs.c      | 32 ++++++----
 3 files changed, 92 insertions(+), 11 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c
 create mode 100644 tools/testing/selftests/bpf/progs/freplace_dead_global_func.c
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c new file +60 -0
new file mode 100644
index 000000000000..2716f6ccfe22
@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: GPL-2.0
+/* Copyright (c) 2023 Meta Platforms, Inc. and affiliates. */
+
+#include <test_progs.h>
+#include "verifier_global_subprogs.skel.h"
+#include "freplace_dead_global_func.skel.h"
+
+void test_global_func_dead_code(void)
+{
+	struct verifier_global_subprogs *tgt_skel = NULL;
+	struct freplace_dead_global_func *skel = NULL;
+	char log_buf[4096];
+	int err, tgt_fd;
+
+	/* first, try to load target with good global subprog */
+	tgt_skel = verifier_global_subprogs__open();
+	if (!ASSERT_OK_PTR(tgt_skel, "tgt_skel_good_open"))
+		return;
+
+	bpf_program__set_autoload(tgt_skel->progs.chained_global_func_calls_success, true);
+
+	err = verifier_global_subprogs__load(tgt_skel);
+	if (!ASSERT_OK(err, "tgt_skel_good_load"))
+		goto out;
+
+	tgt_fd = bpf_program__fd(tgt_skel->progs.chained_global_func_calls_success);
+
+	/* Attach to good non-eliminated subprog */
+	skel = freplace_dead_global_func__open();
+	if (!ASSERT_OK_PTR(skel, "skel_good_open"))
+		goto out;
+
+	bpf_program__set_attach_target(skel->progs.freplace_prog, tgt_fd, "global_good");
+	ASSERT_OK(err, "attach_target_good");
+	
+	err = freplace_dead_global_func__load(skel);
+	if (!ASSERT_OK(err, "skel_good_load"))
+		goto out;
+
+	freplace_dead_global_func__destroy(skel);
+
+	/* Try attaching to dead code-eliminated subprog */
+	skel = freplace_dead_global_func__open();
+	if (!ASSERT_OK_PTR(skel, "skel_dead_open"))
+		goto out;
+
+	bpf_program__set_log_buf(skel->progs.freplace_prog, log_buf, sizeof(log_buf));
+	err = bpf_program__set_attach_target(skel->progs.freplace_prog, tgt_fd, "global_dead");
+	ASSERT_OK(err, "attach_target_dead");
+	
+	err = freplace_dead_global_func__load(skel);
+	if (!ASSERT_ERR(err, "skel_dead_load"))
+		goto out;
+
+	ASSERT_HAS_SUBSTR(log_buf, "Subprog global_dead doesn't exist", "dead_subprog_missing_msg");
+
+out:
+	verifier_global_subprogs__destroy(tgt_skel);
+	freplace_dead_global_func__destroy(skel);
+}
tools/testing/selftests/bpf/progs/freplace_dead_global_func.c new file +11 -0
new file mode 100644
index 000000000000..808738eac578
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: GPL-2.0
+#include <linux/bpf.h>
+#include <bpf/bpf_helpers.h>
+
+SEC("freplace")
+int freplace_prog(int x)
+{
+	return 0;
+}
+
+char _license[] SEC("license") = "GPL";
tools/testing/selftests/bpf/progs/verifier_global_subprogs.c +21 -11
index a0a5efd1caa1..7f9b21a1c5a7 100644
@@ -10,25 +10,31 @@
 
 int arr[1];
 int unkn_idx;
+const volatile bool call_dead_subprog = false;
 
-__noinline long global_bad(void)
+__noinline long global_bad(int x)
 {
-	return arr[unkn_idx]; /* BOOM */
+	return arr[unkn_idx] + x; /* BOOM */
 }
 
-__noinline long global_good(void)
+__noinline long global_good(int x)
 {
-	return arr[0];
+	return arr[0] + x;
 }
 
-__noinline long global_calls_bad(void)
+__noinline long global_calls_bad(int x)
 {
-	return global_good() + global_bad() /* does BOOM indirectly */;
+	return global_good(x) + global_bad(x) /* does BOOM indirectly */;
 }
 
-__noinline long global_calls_good_only(void)
+__noinline long global_calls_good_only(int x)
 {
-	return global_good();
+	return global_good(x);
+}
+
+__noinline long global_dead(int x)
+{
+	return x * 2;
 }
 
 SEC("?raw_tp")
@@ -41,19 +47,23 @@ __msg("Validating global_good() func")
 __msg("('global_good') is safe for any args that match its prototype")
 int chained_global_func_calls_success(void)
 {
-	return global_calls_good_only();
+	int sum = 0;
+
+	if (call_dead_subprog)
+		sum += global_dead(42);
+	return global_calls_good_only(42) + sum;
 }
 
 SEC("?raw_tp")
 __failure __log_level(2)
 /* main prog validated successfully first */
-__msg("1: (95) exit")
+__msg("2: (95) exit")
 /* eventually we validate global_bad() and fail */
 __msg("Validating global_bad() func")
 __msg("math between map_value pointer and register") /* BOOM */
 int chained_global_func_calls_bad(void)
 {
-	return global_calls_bad();
+	return global_calls_bad(13);
 }
 
 /* do out of bounds access forcing verifier to fail verification if this
Signature · 1 line
2.34.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Andrii Nakryiko

Add selftest that establishes dead code-eliminated valid global subprog (global_dead) and makes sure that it's not possible to freplace it, as it's effectively not there. This test will fail with unexpected success before 2afae08c9dcb ("bpf: Validate global subprogs lazily").

---

[...]

Quoted 1 line
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c +0 -0

[...]

Quoted 2 lines
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c +2 -0
+void test_global_func_dead_code(void)
+{

[...]

tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c line 55

Quoted 1 line
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c +1 -0
+	ASSERT_HAS_SUBSTR(log_buf, "Subprog global_dead doesn't exist", "dead_subprog_missing_msg");

Nit: the log is not printed if verbose tests execution is requested.

[...]

Quoted 5 lines

index a0a5efd1caa1..7f9b21a1c5a7 100644

tools/testing/selftests/bpf/progs/verifier_global_subprogs.c +0 -0
@@ -10,25 +10,31 @@
 

tools/testing/selftests/bpf/progs/verifier_global_subprogs.c line 18

Quoted 10 lines
tools/testing/selftests/bpf/progs/verifier_global_subprogs.c +3 -2
 int arr[1];
 int unkn_idx;
+const volatile bool call_dead_subprog = false;
 
-__noinline long global_bad(void)
+__noinline long global_bad(int x)
 {
-	return arr[unkn_idx]; /* BOOM */
+	return arr[unkn_idx] + x; /* BOOM */
 }

Nit/question:
Why change prototype from (void) to (int) here and elsewhere? Does not seem necessary for test logic.

[...]

#2 lore raw
Quoted 7 lines · Eduard Zingerman
Quoted 5 lines · Andrii Nakryiko

Add selftest that establishes dead code-eliminated valid global subprog (global_dead) and makes sure that it's not possible to freplace it, as it's effectively not there. This test will fail with unexpected success before 2afae08c9dcb ("bpf: Validate global subprogs lazily").

Quoted 5 lines
Quoted 3 lines

---

Oops, didn't see your reply before sending v2. But there will be v3 anyway :)

Quoted 10 lines

[...]

Quoted 1 line
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c +0 -0

[...]

Quoted 2 lines
tools/testing/selftests/bpf/prog_tests/global_func_dead_code.c +2 -0
+void test_global_func_dead_code(void)
+{

[...]

Quoted 1 line

+ ASSERT_HAS_SUBSTR(log_buf, "Subprog global_dead doesn't exist", "dead_subprog_missing_msg");

Nit: the log is not printed if verbose tests execution is requested.

I'm not sure I understand. What do you expect to happen that's not happening in verbose mode?

Quoted 12 lines

[...]

Quoted 9 lines

index a0a5efd1caa1..7f9b21a1c5a7 100644

tools/testing/selftests/bpf/progs/verifier_global_subprogs.c +1 -0
@@ -10,25 +10,31 @@
 
 int arr[1];
 int unkn_idx;
+const volatile bool call_dead_subprog = false;
 
Quoted 10 lines

tools/testing/selftests/bpf/progs/verifier_global_subprogs.c line 18

Quoted 6 lines
tools/testing/selftests/bpf/progs/verifier_global_subprogs.c +2 -2
-__noinline long global_bad(void)
+__noinline long global_bad(int x)
 {
-     return arr[unkn_idx]; /* BOOM */
+     return arr[unkn_idx] + x; /* BOOM */
 }

Nit/question:
Why change prototype from (void) to (int) here and elsewhere? Does not seem necessary for test logic.

I had some troubles attaching freplace initially, but my freplace skills were rusty :) I can try undoing this and leaving it as is.

Quoted 2 lines

[...]

maintainer
#3 lore raw

On Fri, 2023-12-01 at 11:17 -0800, Andrii Nakryiko wrote:
[...]

Quoted 3 lines
Quoted 1 line

Oops, didn't see your reply before sending v2. But there will be v3 anyway :)

np

[...]

Quoted 4 lines
Quoted 1 line

Nit: the log is not printed if verbose tests execution is requested.

I'm not sure I understand. What do you expect to happen that's not happening in verbose mode?

I tried running this test -vvv and it did not print verification log (admittedly this is the case with many tests in prog_tests/*.c).

[...]

Quoted 6 lines
Quoted 3 lines

Nit/question:
Why change prototype from (void) to (int) here and elsewhere? Does not seem necessary for test logic.

I had some troubles attaching freplace initially, but my freplace skills were rusty :) I can try undoing this and leaving it as is.

No strong opinion, just curious.

#4 lore raw
Quoted 9 lines · Eduard Zingerman

On Fri, 2023-12-01 at 11:17 -0800, Andrii Nakryiko wrote:
[...]

Quoted 3 lines
Quoted 1 line

Oops, didn't see your reply before sending v2. But there will be v3 anyway :)

np

Quoted 8 lines

[...]

Quoted 4 lines
Quoted 1 line

Nit: the log is not printed if verbose tests execution is requested.

I'm not sure I understand. What do you expect to happen that's not happening in verbose mode?

I tried running this test -vvv and it did not print verification log (admittedly this is the case with many tests in prog_tests/*.c).

I think that's the test_loader.c feature, plus maybe some other tests support this. This is not expected to magically work for all tests. But also in this case we explicitly intercept the log, so it would be too much trouble to both intercept and print it at the same time, IMO. But if this assertion fails, we'll see the log, which is the most important part. Also one can use veristat to get the log.

Quoted 11 lines

[...]

Quoted 6 lines
Quoted 3 lines

Nit/question:
Why change prototype from (void) to (int) here and elsewhere? Does not seem necessary for test logic.

I had some troubles attaching freplace initially, but my freplace skills were rusty :) I can try undoing this and leaving it as is.

No strong opinion, just curious.

I undid it, it all works now. As I said, I had freplace troubles and was poking around with different aspects.

maintainer
#5 lore raw
Quoted 9 lines · Andrii Nakryiko
Quoted 8 lines

[...]

Quoted 4 lines
Quoted 1 line

Nit: the log is not printed if verbose tests execution is requested.

I'm not sure I understand. What do you expect to happen that's not happening in verbose mode?

I tried running this test -vvv and it did not print verification log (admittedly this is the case with many tests in prog_tests/*.c).

Quoted 6 lines

I think that's the test_loader.c feature, plus maybe some other tests support this. This is not expected to magically work for all tests. But also in this case we explicitly intercept the log, so it would be too much trouble to both intercept and print it at the same time, IMO. But if this assertion fails, we'll see the log, which is the most important part. Also one can use veristat to get the log.

Well, yes, that was the point of my rumbling.
When it's necessary to debug some such test one needs to modify it to use *_opts() load variant etc. Veristat makes sense, however, so not an issue.

Quoted 11 lines
Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

Nit/question:
Why change prototype from (void) to (int) here and elsewhere? Does not seem necessary for test logic.

I had some troubles attaching freplace initially, but my freplace skills were rusty :) I can try undoing this and leaving it as is.

No strong opinion, just curious.

I undid it, it all works now. As I said, I had freplace troubles and was poking around with different aspects.

Thank you.