selftests/bpf: Replaces CHECK macros and adds malloc failure checks to bpf_iter

As it was pointed out by Yonghong Song [1], in the bpf selftests the use of the ASSERT_* series of macros is preferred over the CHECK macro. This patch replaces all CHECK calls in bpf_iter with the appropriate ASSERT_* macros.

[1] https://lore.kernel.org/lkml/[email protected]

Suggested-by Yonghong Song <[email protected]>

Signed-off-by Yuran Pereira <[email protected]>

As it was pointed out by Yonghong Song [1], in the bpf selftests the use of the ASSERT_* series of macros is preferred over the CHECK macro. This patch replaces all CHECK calls in bpf_iter with the appropriate ASSERT_* macros.

[1] https://lore.kernel.org/lkml/[email protected]

Suggested-by Yonghong Song <[email protected]>

Signed-off-by Yuran Pereira <[email protected]>

---
  .../selftests/bpf/prog_tests/bpf_iter.c       | 79 ++++++++-----------
  1 file changed, 35 insertions(+), 44 deletions(-)

tools/testing/selftests/bpf/prog_tests/bpf_iter.c +35 -44

index 1f02168103dd..123a3502b8f0 100644
@@ -34,8 +34,6 @@
  #include "bpf_iter_ksym.skel.h"
  #include "bpf_iter_sockmap.skel.h"
 
-static int duration;
-
  static void test_btf_id_or_null(void)
  {
  	struct bpf_iter_test_kern3 *skel;

@@ -64,7 +62,7 @@ static void do_dummy_read_opts(struct bpf_program *prog, struct bpf_iter_attach_
  	/* not check contents, but ensure read() ends without error */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	CHECK(len < 0, "read", "read failed: %s\n", strerror(errno));
+	ASSERT_GE(len, 0, "read");
 
  	close(iter_fd);
 

@@ -413,7 +411,7 @@ static int do_btf_read(struct bpf_iter_task_btf *skel)
  		goto free_link;
  	}
 
-	if (CHECK(err < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(err, 0, "read"))
  		goto free_link;
 
  	ASSERT_HAS_SUBSTR(taskbuf, "(struct task_struct)",

@@ -526,11 +524,11 @@ static int do_read_with_fd(int iter_fd, const char *expected,
  	start = 0;
  	while ((len = read(iter_fd, buf + start, read_buf_len)) > 0) {
  		start += len;
-		if (CHECK(start >= 16, "read", "read len %d\n", len))
+		if (!ASSERT_LT(start, 16, "read"))
  			return -1;
  		read_buf_len = read_one_char ? 1 : 16 - start;
  	}
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		return -1;
 
  	if (!ASSERT_STREQ(buf, expected, "read"))

@@ -571,8 +569,7 @@ static int do_read(const char *path, const char *expected)
  	int err, iter_fd;
 
  	iter_fd = open(path, O_RDONLY);
-	if (CHECK(iter_fd < 0, "open", "open %s failed: %s\n",
-		  path, strerror(errno)))
+	if (!ASSERT_GE(iter_fd, 0, "open"))
  		return -1;
 
  	err = do_read_with_fd(iter_fd, expected, false);

@@ -600,7 +597,7 @@ static void test_file_iter(void)
  	unlink(path);
 
  	err = bpf_link__pin(link, path);
-	if (CHECK(err, "pin_iter", "pin_iter to %s failed: %d\n", path, err))
+	if (!ASSERT_OK(err, "pin_iter"))
  		goto free_link;
 
  	err = do_read(path, "abcd");

@@ -651,12 +648,10 @@ static void test_overflow(bool test_e2big_overflow, bool ret1)
  	 * overflow and needs restart.
  	 */
  	map1_fd = bpf_map_create(BPF_MAP_TYPE_ARRAY, NULL, 4, 8, 1, NULL);
-	if (CHECK(map1_fd < 0, "bpf_map_create",
-		  "map_creation failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(map1_fd, 0, "bpf_map_create"))
  		goto out;
  	map2_fd = bpf_map_create(BPF_MAP_TYPE_ARRAY, NULL, 4, 8, 1, NULL);
-	if (CHECK(map2_fd < 0, "bpf_map_create",
-		  "map_creation failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(map2_fd, 0, "bpf_map_create"))
  		goto free_map1;
 
  	/* bpf_seq_printf kernel buffer is 8 pages, so one map

@@ -685,14 +680,12 @@ static void test_overflow(bool test_e2big_overflow, bool ret1)
  	/* setup filtering map_id in bpf program */
  	map_info_len = sizeof(map_info);
  	err = bpf_map_get_info_by_fd(map1_fd, &map_info, &map_info_len);
-	if (CHECK(err, "get_map_info", "get map info failed: %s\n",
-		  strerror(errno)))
+	if (!ASSERT_OK(err, "get_map_info"))
  		goto free_map2;
  	skel->bss->map1_id = map_info.id;
 
  	err = bpf_map_get_info_by_fd(map2_fd, &map_info, &map_info_len);
-	if (CHECK(err, "get_map_info", "get map info failed: %s\n",
-		  strerror(errno)))
+	if (!ASSERT_OK(err, "get_map_info"))
  		goto free_map2;
  	skel->bss->map2_id = map_info.id;
 

@@ -714,16 +707,14 @@ static void test_overflow(bool test_e2big_overflow, bool ret1)
  		while ((len = read(iter_fd, buf, expected_read_len)) > 0)
  			total_read_len += len;
 
-		CHECK(len != -1 || errno != E2BIG, "read",
-		      "expected ret -1, errno E2BIG, but get ret %d, error %s\n",
-			  len, strerror(errno));
+		ASSERT_EQ(len, -1, "read");
+		ASSERT_EQ(errno, E2BIG, "read");
  		goto free_buf;
  	} else if (!ret1) {
  		while ((len = read(iter_fd, buf, expected_read_len)) > 0)
  			total_read_len += len;
 
-		if (CHECK(len < 0, "read", "read failed: %s\n",
-			  strerror(errno)))
+		if (!ASSERT_GE(len, 0, "read"))
  			goto free_buf;
  	} else {
  		do {

@@ -732,8 +723,7 @@ static void test_overflow(bool test_e2big_overflow, bool ret1)
  				total_read_len += len;
  		} while (len > 0 || len == -EAGAIN);
 
-		if (CHECK(len < 0, "read", "read failed: %s\n",
-			  strerror(errno)))
+		if (!ASSERT_GE(len, 0, "read"))
  			goto free_buf;
  	}
 

@@ -836,7 +826,7 @@ static void test_bpf_hash_map(void)
  	/* do some tests */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */

@@ -917,7 +907,7 @@ static void test_bpf_percpu_hash_map(void)
  	/* do some tests */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */

@@ -983,17 +973,14 @@ static void test_bpf_array_map(void)
  	start = 0;
  	while ((len = read(iter_fd, buf + start, sizeof(buf) - start)) > 0)
  		start += len;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */
  	res_first_key = *(__u32 *)buf;
  	res_first_val = *(__u64 *)(buf + sizeof(__u32));
-	if (CHECK(res_first_key != 0 || res_first_val != first_val,
-		  "bpf_seq_write",
-		  "seq_write failure: first key %u vs expected 0, "
-		  " first value %llu vs expected %llu\n",
-		  res_first_key, res_first_val, first_val))
+	if (!ASSERT_EQ(res_first_key, 0, "bpf_seq_write") ||
+			!ASSERT_EQ(res_first_val, first_val, "bpf_seq_write"))
  		goto close_iter;
 
  	if (!ASSERT_EQ(skel->bss->key_sum, expected_key, "key_sum"))

@@ -1092,7 +1079,7 @@ static void test_bpf_percpu_array_map(void)
  	/* do some tests */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */

@@ -1131,6 +1118,7 @@ static void test_bpf_sk_storage_delete(void)
  	sock_fd = socket(AF_INET6, SOCK_STREAM, 0);
  	if (!ASSERT_GE(sock_fd, 0, "socket"))
  		goto out;
+
  	err = bpf_map_update_elem(map_fd, &sock_fd, &val, BPF_NOEXIST);
  	if (!ASSERT_OK(err, "map_update"))
  		goto out;

@@ -1151,14 +1139,19 @@ static void test_bpf_sk_storage_delete(void)
  	/* do some tests */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */
  	err = bpf_map_lookup_elem(map_fd, &sock_fd, &val);
-	if (CHECK(!err || errno != ENOENT, "bpf_map_lookup_elem",
-		  "map value wasn't deleted (err=%d, errno=%d)\n", err, errno))
-		goto close_iter;
+
+	 /* Note: The following assertions serve to ensure
+	  * the value was deleted. It does so by asserting
+	  * that bpf_map_lookup_elem has failed. This might
+	  * seem counterintuitive at first.
+	  */
+	ASSERT_ERR(err, "bpf_map_lookup_elem");
+	ASSERT_EQ(errno, ENOENT, "bpf_map_lookup_elem");
 
  close_iter:
  	close(iter_fd);

@@ -1203,17 +1196,15 @@ static void test_bpf_sk_storage_get(void)
  	do_dummy_read(skel->progs.fill_socket_owner);
 
  	err = bpf_map_lookup_elem(map_fd, &sock_fd, &val);
-	if (CHECK(err || val != getpid(), "bpf_map_lookup_elem",
-	    "map value wasn't set correctly (expected %d, got %d, err=%d)\n",
-	    getpid(), val, err))
+	if (!ASSERT_OK(err, "bpf_map_lookup_elem") ||
+			!ASSERT_EQ(val, getpid(), "bpf_map_lookup_elem"))
  		goto close_socket;
 
  	do_dummy_read(skel->progs.negate_socket_local_storage);
 
  	err = bpf_map_lookup_elem(map_fd, &sock_fd, &val);
-	CHECK(err || val != -getpid(), "bpf_map_lookup_elem",
-	      "map value wasn't set correctly (expected %d, got %d, err=%d)\n",
-	      -getpid(), val, err);
+	ASSERT_OK(err, "bpf_map_lookup_elem");
+	ASSERT_EQ(val, -getpid(), "bpf_map_lookup_elem");
 
  close_socket:
  	close(sock_fd);

@@ -1290,7 +1281,7 @@ static void test_bpf_sk_storage_map(void)
  	/* do some tests */
  	while ((len = read(iter_fd, buf, sizeof(buf))) > 0)
  		;
-	if (CHECK(len < 0, "read", "read failed: %s\n", strerror(errno)))
+	if (!ASSERT_GE(len, 0, "read"))
  		goto close_iter;
 
  	/* test results */

Since some malloc calls in bpf_iter may at times fail, this patch adds the appropriate fail checks, and ensures that any previously allocated resource is appropriately destroyed before returning the function.

Signed-off-by Yuran Pereira <[email protected]>

Since some malloc calls in bpf_iter may at times fail, this patch adds the appropriate fail checks, and ensures that any previously allocated resource is appropriately destroyed before returning the function.

Signed-off-by Yuran Pereira <[email protected]>

---
  tools/testing/selftests/bpf/prog_tests/bpf_iter.c | 6 +++++-
  1 file changed, 5 insertions(+), 1 deletion(-)

tools/testing/selftests/bpf/prog_tests/bpf_iter.c +5 -1

index 123a3502b8f0..1e02d1ba1c18 100644
@@ -698,7 +698,7 @@ static void test_overflow(bool test_e2big_overflow, bool ret1)
  		goto free_link;
 
  	buf = malloc(expected_read_len);
-	if (!buf)
+	if (!ASSERT_OK_PTR(buf, "malloc"))
  		goto close_iter;
 
  	/* do read */

@@ -868,6 +868,8 @@ static void test_bpf_percpu_hash_map(void)
 
  	skel->rodata->num_cpus = bpf_num_possible_cpus();
  	val = malloc(8 * bpf_num_possible_cpus());
+	if (!ASSERT_OK_PTR(val, "malloc"))
+		goto out;
 
  	err = bpf_iter_bpf_percpu_hash_map__load(skel);
  	if (!ASSERT_OK_PTR(skel, "bpf_iter_bpf_percpu_hash_map__load"))

@@ -1044,6 +1046,8 @@ static void test_bpf_percpu_array_map(void)
 
  	skel->rodata->num_cpus = bpf_num_possible_cpus();
  	val = malloc(8 * bpf_num_possible_cpus());
+	if (!ASSERT_OK_PTR(val, "malloc"))
+		goto out;
 
  	err = bpf_iter_bpf_percpu_array_map__load(skel);
  	if (!ASSERT_OK_PTR(skel, "bpf_iter_bpf_percpu_array_map__load"))