Skip to contentSkip to conversation

bpf: Add a generic bits iterator

PATCH Superseded Yafang Shao 5 participants 11 messages Feb 18, 2024 – Feb 27, 2024

Subsystems (3)

v1 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

cover bpf: Add a generic bits iterator

Introducing three new kfuncs, namely bpf_iter_bits_{new,next,destroy}, to support the newly added bits iter functionality. These functions enable seamless iteration of bits from a specified memory area.

- bpf_iter_bits_new
Initializes a new bits iterator for a given memory area. Notably, due to limitations within bpf memalloc, the maximum number of bits that can be iterated over is constrained to (4096 * 8).
- bpf_iter_bits_next
Get the next bit in a bpf_iter_bits
- bpf_iter_bits_destroy
Destroy a bpf_iter_bits

The bits iterator can be used in any context and on any address.

In our specific use case, we leverage the cgroup iterator to traverse percpu data, subsequently exposing it to userspace through a seq file. For detailed usage examples, please refer to the example in patch #2.

Changes:
- bpf: Add bpf_iter_cpumask
https://lwn.net/Articles/961104/
- bpf: Add new bpf helper bpf_for_each_cpu
https://lwn.net/Articles/939939/

Yafang Shao (2):
bpf: Add bits iterator
selftests/bpf: Add selftest for bits iter

 kernel/bpf/helpers.c                          | 100 ++++++++++
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/prog_tests/bits_iter.c      | 180 ++++++++++++++++++
 .../bpf/progs/test_bits_iter_failure.c        |  53 ++++++
 .../bpf/progs/test_bits_iter_success.c        | 146 ++++++++++++++
 5 files changed, 480 insertions(+)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/bits_iter.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_failure.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_success.c
Signature · 1 line
2.39.1
#1 lore raw

PATCH 1/2 bpf: Add bits iterator

Add three new kfuncs for the bits iterator:
- bpf_iter_bits_new
Initialize a new bits iterator for a given memory area. Due to the limitation of bpf memalloc, the max number of bits that can be iterated over is limited to (4096 * 8).
- bpf_iter_bits_next
Get the next bit in a bpf_iter_bits
- bpf_iter_bits_destroy
Destroy a bpf_iter_bits

The bits iterator facilitates the iteration of the bits of a memory area, such as cpumask. It can be used in any context and on any address.

---
 kernel/bpf/helpers.c | 100 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)
kernel/bpf/helpers.c +100 -0
index 93edf730d288..052f63891834 100644
@@ -2542,6 +2542,103 @@ __bpf_kfunc void bpf_throw(u64 cookie)
 	WARN(1, "A call to BPF exception callback should never return\n");
 }
 
+struct bpf_iter_bits {
+	__u64 __opaque[2];
+} __aligned(8);
+
+struct bpf_iter_bits_kern {
+	unsigned long *bits;
+	u32 nr_bits;
+	int bit;
+} __aligned(8);
+
+/**
+ * bpf_iter_bits_new() - Initialize a new bits iterator for a given memory area
+ * @it: The new bpf_iter_bits to be created
+ * @unsafe_ptr__ign: A ponter pointing to a memory area to be iterated over
+ * @nr_bits: The number of bits to be iterated over. Due to the limitation of
+ * memalloc, it can't greater than (4096 * 8).
+ *
+ * This function initializes a new bpf_iter_bits structure for iterating over
+ * a memory area which is specified by the @unsafe_ptr__ign and @nr_bits. It
+ * copy the data of the memory area to the newly created bpf_iter_bits @it for
+ * subsequent iteration operations.
+ *
+ * On success, 0 is returned. On failure, ERR is returned.
+ */
+__bpf_kfunc int
+bpf_iter_bits_new(struct bpf_iter_bits *it, const void *unsafe_ptr__ign, u32 nr_bits)
+{
+	struct bpf_iter_bits_kern *kit = (void *)it;
+	u32 size = BITS_TO_BYTES(nr_bits);
+	int err;
+
+	BUILD_BUG_ON(sizeof(struct bpf_iter_bits_kern) != sizeof(struct bpf_iter_bits));
+	BUILD_BUG_ON(__alignof__(struct bpf_iter_bits_kern) !=
+		     __alignof__(struct bpf_iter_bits));
+
+	if (!unsafe_ptr__ign || !nr_bits) {
+		kit->bits = NULL;
+		return -EINVAL;
+	}
+
+	kit->bits = bpf_mem_alloc(&bpf_global_ma, size);
+	if (!kit->bits)
+		return -ENOMEM;
+
+	err = bpf_probe_read_kernel_common(kit->bits, size, unsafe_ptr__ign);
+	if (err) {
+		bpf_mem_free(&bpf_global_ma, kit->bits);
+		kit->bits = NULL;
+		return err;
+	}
+
+	kit->nr_bits = nr_bits;
+	kit->bit = -1;
+	return 0;
+}
+
+/**
+ * bpf_iter_bits_next() - Get the next bit in a bpf_iter_bits
+ * @it: The bpf_iter_bits to be checked
+ *
+ * This function returns a pointer to a number representing the value of the
+ * next bit in the bits.
+ *
+ * If there are no further bit available, it returns NULL.
+ */
+__bpf_kfunc int *bpf_iter_bits_next(struct bpf_iter_bits *it)
+{
+	struct bpf_iter_bits_kern *kit = (void *)it;
+	const unsigned long *bits = kit->bits;
+	int bit;
+
+	if (!bits)
+		return NULL;
+
+	bit = find_next_bit(bits, kit->nr_bits, kit->bit + 1);
+	if (bit >= kit->nr_bits)
+		return NULL;
+
+	kit->bit = bit;
+	return &kit->bit;
+}
+
+/**
+ * bpf_iter_bits_destroy() - Destroy a bpf_iter_bits
+ * @it: The bpf_iter_bits to be destroyed
+ *
+ * Destroy the resource associated with the bpf_iter_bits.
+ */
+__bpf_kfunc void bpf_iter_bits_destroy(struct bpf_iter_bits *it)
+{
+	struct bpf_iter_bits_kern *kit = (void *)it;
+
+	if (!kit->bits)
+		return;
+	bpf_mem_free(&bpf_global_ma, kit->bits);
+}
+
 __bpf_kfunc_end_defs();
 
 BTF_KFUNCS_START(generic_btf_ids)
@@ -2618,6 +2715,9 @@ BTF_ID_FLAGS(func, bpf_dynptr_is_null)
 BTF_ID_FLAGS(func, bpf_dynptr_is_rdonly)
 BTF_ID_FLAGS(func, bpf_dynptr_size)
 BTF_ID_FLAGS(func, bpf_dynptr_clone)
+BTF_ID_FLAGS(func, bpf_iter_bits_new, KF_ITER_NEW)
+BTF_ID_FLAGS(func, bpf_iter_bits_next, KF_ITER_NEXT | KF_RET_NULL)
+BTF_ID_FLAGS(func, bpf_iter_bits_destroy, KF_ITER_DESTROY)
 BTF_KFUNCS_END(common_btf_ids)
 
 static const struct btf_kfunc_id_set common_kfunc_set = {
Signature · 1 line
2.39.1
#2 lore raw

RE: [PATCH bpf-next 1/2] bpf: Add bits iterator

Quoted 10 lines · Yafang Shao

Add three new kfuncs for the bits iterator:
- bpf_iter_bits_new
Initialize a new bits iterator for a given memory area. Due to the limitation of bpf memalloc, the max number of bits that can be iterated over is limited to (4096 * 8).
- bpf_iter_bits_next
Get the next bit in a bpf_iter_bits
- bpf_iter_bits_destroy
Destroy a bpf_iter_bits

Quoted 2 lines

The bits iterator facilitates the iteration of the bits of a memory area, such as cpumask. It can be used in any context and on any address.

Just curious as I see more and a more kfuncs. Did you try to implement this with existing BPF? The main trick looks to be to get an implementation of FIND_NEXT_BIT? Without trying seems doable with one of the bpf loop iterators?

Also this requires a bpf_iter_bits_new across every iteration of the BPF program or anytime we need to pick up the changes. Any reason we can't just read the memory directly?

Thanks,
John

Quoted 49 lines
---
 kernel/bpf/helpers.c | 100 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)
kernel/bpf/helpers.c +35 -0
index 93edf730d288..052f63891834 100644
@@ -2542,6 +2542,103 @@ __bpf_kfunc void bpf_throw(u64 cookie)
 	WARN(1, "A call to BPF exception callback should never return\n");
 }
 
+struct bpf_iter_bits {
+	__u64 __opaque[2];
+} __aligned(8);
+
+struct bpf_iter_bits_kern {
+	unsigned long *bits;
+	u32 nr_bits;
+	int bit;
+} __aligned(8);
+
+/**
+ * bpf_iter_bits_new() - Initialize a new bits iterator for a given memory area
+ * @it: The new bpf_iter_bits to be created
+ * @unsafe_ptr__ign: A ponter pointing to a memory area to be iterated over
+ * @nr_bits: The number of bits to be iterated over. Due to the limitation of
+ * memalloc, it can't greater than (4096 * 8).
+ *
+ * This function initializes a new bpf_iter_bits structure for iterating over
+ * a memory area which is specified by the @unsafe_ptr__ign and @nr_bits. It
+ * copy the data of the memory area to the newly created bpf_iter_bits @it for
+ * subsequent iteration operations.
+ *
+ * On success, 0 is returned. On failure, ERR is returned.
+ */
+__bpf_kfunc int
+bpf_iter_bits_new(struct bpf_iter_bits *it, const void *unsafe_ptr__ign, u32 nr_bits)
+{
+	struct bpf_iter_bits_kern *kit = (void *)it;
+	u32 size = BITS_TO_BYTES(nr_bits);
+	int err;
+
+	BUILD_BUG_ON(sizeof(struct bpf_iter_bits_kern) != sizeof(struct bpf_iter_bits));
+	BUILD_BUG_ON(__alignof__(struct bpf_iter_bits_kern) !=
+		     __alignof__(struct bpf_iter_bits));
+

kernel/bpf/helpers.c __bpf_kfunc void bpf_throw(u64 cookie) · line 2589

Quoted 10 lines
kernel/bpf/helpers.c +10 -0
+	if (!unsafe_ptr__ign || !nr_bits) {
+		kit->bits = NULL;
+		return -EINVAL;
+	}
+
+	kit->bits = bpf_mem_alloc(&bpf_global_ma, size);
+	if (!kit->bits)
+		return -ENOMEM;
+
+	err = bpf_probe_read_kernel_common(kit->bits, size, unsafe_ptr__ign);

Specifically, this why can't we iterate over unsafe_ptr__ign?

Quoted 20 lines
kernel/bpf/helpers.c +20 -0
+	if (err) {
+		bpf_mem_free(&bpf_global_ma, kit->bits);
+		kit->bits = NULL;
+		return err;
+	}
+
+	kit->nr_bits = nr_bits;
+	kit->bit = -1;
+	return 0;
+}
+
+/**
+ * bpf_iter_bits_next() - Get the next bit in a bpf_iter_bits
+ * @it: The bpf_iter_bits to be checked
+ *
+ * This function returns a pointer to a number representing the value of the
+ * next bit in the bits.
+ *
+ * If there are no further bit available, it returns NULL.
+ */

kernel/bpf/helpers.c __bpf_kfunc void bpf_throw(u64 cookie) · line 2619

Quoted 10 lines
kernel/bpf/helpers.c +10 -0
+__bpf_kfunc int *bpf_iter_bits_next(struct bpf_iter_bits *it)
+{
+	struct bpf_iter_bits_kern *kit = (void *)it;
+	const unsigned long *bits = kit->bits;
+	int bit;
+
+	if (!bits)
+		return NULL;
+
+	bit = find_next_bit(bits, kit->nr_bits, kit->bit + 1);

Seems like this should be ok over unsafe memory as long as find_next_bit is bounded?

kernel/bpf/helpers.c __bpf_kfunc void bpf_throw(u64 cookie) · line 2625

Quoted 6 lines
kernel/bpf/helpers.c +6 -0
+	if (bit >= kit->nr_bits)
+		return NULL;
+
+	kit->bit = bit;
+	return &kit->bit;
+}

Thanks for working on this looks useful to me.

#3 lore raw

Re: [PATCH bpf-next 1/2] bpf: Add bits iterator

Quoted 5 lines · John Fastabend
Quoted 5 lines
kernel/bpf/helpers.c +5 -0
+__bpf_kfunc int *bpf_iter_bits_next(struct bpf_iter_bits *it)
+{
+     struct bpf_iter_bits_kern *kit = (void *)it;
+     const unsigned long *bits = kit->bits;
+     int bit;
Quoted 8 lines

kernel/bpf/helpers.c __bpf_kfunc void bpf_throw(u64 cookie) · line 2619

Quoted 5 lines
kernel/bpf/helpers.c +5 -0
+
+     if (!bits)
+             return NULL;
+
+     bit = find_next_bit(bits, kit->nr_bits, kit->bit + 1);

Seems like this should be ok over unsafe memory as long as find_next_bit is bounded?

Are you proposing to add find_next_bit() as a kfunc instead?

With the bpf_can_loop() proposal these two can be combined and it will probably achieve the same result.
But imo this iterator is small enough to get in now and
delete later when there is a better way.
Ideally we'd need to add new instructions to operate with bits efficiently.

#4 lore raw

Re: [PATCH bpf-next 1/2] bpf: Add bits iterator

Quoted 15 lines · Alexei Starovoitov
Quoted 5 lines · John Fastabend
Quoted 5 lines
kernel/bpf/helpers.c +5 -0
+__bpf_kfunc int *bpf_iter_bits_next(struct bpf_iter_bits *it)
+{
+     struct bpf_iter_bits_kern *kit = (void *)it;
+     const unsigned long *bits = kit->bits;
+     int bit;
Quoted 8 lines

kernel/bpf/helpers.c __bpf_kfunc void bpf_throw(u64 cookie) · line 2619

Quoted 5 lines
kernel/bpf/helpers.c +5 -0
+
+     if (!bits)
+             return NULL;
+
+     bit = find_next_bit(bits, kit->nr_bits, kit->bit + 1);

Seems like this should be ok over unsafe memory as long as find_next_bit is bounded?

Quoted 1 line

Are you proposing to add find_next_bit() as a kfunc instead?

I was suggesting you could likely implement find_next_bit() in BPF directly no need for a kfunc.

Quoted 5 lines

With the bpf_can_loop() proposal these two can be combined and it will probably achieve the same result.
But imo this iterator is small enough to get in now and delete later when there is a better way.

Agree its fine to go in as is IMO. Mostly just curious if anyone tried to implement it in BPF.

Quoted 1 line

Ideally we'd need to add new instructions to operate with bits efficiently.

+1.

#5 lore raw

PATCH 2/2 selftests/bpf: Add selftest for bits iter

In reply to Yafang Shao

Add selftests for the newly added bits iter.
- bits_iter_success
- The number of CPUs should be expected when iterating over a cpumask
- percpu data extracted from the percpu struct should be expected
- RCU lock is not required
- It is fine without calling bpf_iter_cpumask_next()
- It can work as expected when invalid arguments are passed

- bits_iter_failure
- bpf_iter_bits_destroy() is required after calling

    bpf_iter_bits_new()

- bpf_iter_bits_destroy() can only destroy an initialized iter
- bpf_iter_bits_next() must use an initialized iter

---
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/prog_tests/bits_iter.c      | 180 ++++++++++++++++++
 .../bpf/progs/test_bits_iter_failure.c        |  53 ++++++
 .../bpf/progs/test_bits_iter_success.c        | 146 ++++++++++++++
 4 files changed, 380 insertions(+)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/bits_iter.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_failure.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_success.c
tools/testing/selftests/bpf/config +1 -0
index 01f241ea2c67..dd4b0935e35f 100644
@@ -78,6 +78,7 @@ CONFIG_NF_CONNTRACK_MARK=y
 CONFIG_NF_DEFRAG_IPV4=y
 CONFIG_NF_DEFRAG_IPV6=y
 CONFIG_NF_NAT=y
+CONFIG_PSI=y
 CONFIG_RC_CORE=y
 CONFIG_SECURITY=y
 CONFIG_SECURITYFS=y
tools/testing/selftests/bpf/prog_tests/bits_iter.c new file +180 -0

180 lines not on this page · raw message

tools/testing/selftests/bpf/progs/test_bits_iter_failure.c new file +53 -0

53 lines not on this page · raw message

tools/testing/selftests/bpf/progs/test_bits_iter_success.c new file +146 -0

146 lines not on this page · raw message

Signature · 1 line
2.39.1
#6 lore raw

Re: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter

Quoted 101 lines · Yafang Shao

Add selftests for the newly added bits iter.
- bits_iter_success
- The number of CPUs should be expected when iterating over a cpumask
- percpu data extracted from the percpu struct should be expected
- RCU lock is not required
- It is fine without calling bpf_iter_cpumask_next()
- It can work as expected when invalid arguments are passed

- bits_iter_failure
- bpf_iter_bits_destroy() is required after calling

    bpf_iter_bits_new()

- bpf_iter_bits_destroy() can only destroy an initialized iter
- bpf_iter_bits_next() must use an initialized iter

---
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/prog_tests/bits_iter.c      | 180 ++++++++++++++++++
 .../bpf/progs/test_bits_iter_failure.c        |  53 ++++++
 .../bpf/progs/test_bits_iter_success.c        | 146 ++++++++++++++
 4 files changed, 380 insertions(+)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/bits_iter.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_failure.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_success.c
tools/testing/selftests/bpf/config +1 -0
index 01f241ea2c67..dd4b0935e35f 100644
@@ -78,6 +78,7 @@ CONFIG_NF_CONNTRACK_MARK=y
 CONFIG_NF_DEFRAG_IPV4=y
 CONFIG_NF_DEFRAG_IPV6=y
 CONFIG_NF_NAT=y
+CONFIG_PSI=y
 CONFIG_RC_CORE=y
 CONFIG_SECURITY=y
 CONFIG_SECURITYFS=y
tools/testing/selftests/bpf/prog_tests/bits_iter.c new file +57 -0
new file mode 100644
index 000000000000..778a7c942dba
@@ -0,0 +1,180 @@
+// SPDX-License-Identifier: GPL-2.0
+/* Copyright (c) 2024 Yafang Shao <[email protected]> */
+
+#define _GNU_SOURCE
+#include <sched.h>
+
+#include <test_progs.h>
+#include "test_bits_iter_success.skel.h"
+#include "test_bits_iter_failure.skel.h"
+#include "cgroup_helpers.h"
+
+static const char * const positive_testcases[] = {
+       "cpumask_iter",
+};
+
+static const char * const negative_testcases[] = {
+       "null_pointer",
+       "zero_bit",
+       "no_mem",
+       "invalid_bits"
+};
+
+static int read_percpu_data(struct bpf_link *link, int nr_cpu_exp, int nr_running_exp)
+{
+       int iter_fd, len, item, nr_running, psi_running, nr_cpus, err = -1;
+       char buf[128];
+       size_t left;
+       char *p;
+
+       iter_fd = bpf_iter_create(bpf_link__fd(link));
+       if (!ASSERT_GE(iter_fd, 0, "iter_fd"))
+               return -1;
+
+       memset(buf, 0, sizeof(buf));
+       left = ARRAY_SIZE(buf);
+       p = buf;
+       while ((len = read(iter_fd, p, left)) > 0) {
+               p += len;
+               left -= len;
+       }
+
+       item = sscanf(buf, "nr_running %u nr_cpus %u psi_running %u\n",
+                     &nr_running, &nr_cpus, &psi_running);
+       if (!ASSERT_EQ(item, 3, "seq_format"))
+               goto out;
+       if (!ASSERT_EQ(nr_cpus, nr_cpu_exp, "nr_cpus"))
+               goto out;
+       if (!ASSERT_GE(nr_running, nr_running_exp, "nr_running"))
+               goto out;
+       if (!ASSERT_GE(psi_running, nr_running_exp, "psi_running"))
+               goto out;
+
+       err = 0;
+out:
+       close(iter_fd);
+       return err;
+}

..

tools/testing/selftests/bpf/prog_tests/bits_iter.c line 114

Quoted 11 lines
tools/testing/selftests/bpf/prog_tests/bits_iter.c new file +11 -0
+
+       /* Case 1): Enable all possible CPUs */
+       CPU_ZERO(&set);
+       for (i = 0; i < nr_cpus; i++)
+               CPU_SET(i, &set);
+       err = sched_setaffinity(skel->bss->pid, sizeof(set), &set);
+       if (!ASSERT_OK(err, "setaffinity_all_cpus"))
+               goto free_link;
+       err = read_percpu_data(link, nr_cpus, 1);
+       if (!ASSERT_OK(err, "read_percpu_data"))
+               goto free_link;

The patch 1 looks good, but this test fails on s390.

read_percpu_data:FAIL:nr_cpus unexpected nr_cpus: actual 0 != expected 2 verify_iter_success:FAIL:read_percpu_data unexpected error: -1 (errno 95)

Please see CI.

So either add it to DENYLIST.s390x in the same commit or make it work.

pw-bot: cr

#7 lore raw

Re: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter

Quoted 119 lines · Alexei Starovoitov
Quoted 101 lines · Yafang Shao

Add selftests for the newly added bits iter.
- bits_iter_success
- The number of CPUs should be expected when iterating over a cpumask
- percpu data extracted from the percpu struct should be expected
- RCU lock is not required
- It is fine without calling bpf_iter_cpumask_next()
- It can work as expected when invalid arguments are passed

- bits_iter_failure
- bpf_iter_bits_destroy() is required after calling

    bpf_iter_bits_new()

- bpf_iter_bits_destroy() can only destroy an initialized iter
- bpf_iter_bits_next() must use an initialized iter

---
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/prog_tests/bits_iter.c      | 180 ++++++++++++++++++
 .../bpf/progs/test_bits_iter_failure.c        |  53 ++++++
 .../bpf/progs/test_bits_iter_success.c        | 146 ++++++++++++++
 4 files changed, 380 insertions(+)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/bits_iter.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_failure.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_bits_iter_success.c
tools/testing/selftests/bpf/config +1 -0
index 01f241ea2c67..dd4b0935e35f 100644
@@ -78,6 +78,7 @@ CONFIG_NF_CONNTRACK_MARK=y
 CONFIG_NF_DEFRAG_IPV4=y
 CONFIG_NF_DEFRAG_IPV6=y
 CONFIG_NF_NAT=y
+CONFIG_PSI=y
 CONFIG_RC_CORE=y
 CONFIG_SECURITY=y
 CONFIG_SECURITYFS=y
tools/testing/selftests/bpf/prog_tests/bits_iter.c new file +57 -0
new file mode 100644
index 000000000000..778a7c942dba
@@ -0,0 +1,180 @@
+// SPDX-License-Identifier: GPL-2.0
+/* Copyright (c) 2024 Yafang Shao <[email protected]> */
+
+#define _GNU_SOURCE
+#include <sched.h>
+
+#include <test_progs.h>
+#include "test_bits_iter_success.skel.h"
+#include "test_bits_iter_failure.skel.h"
+#include "cgroup_helpers.h"
+
+static const char * const positive_testcases[] = {
+       "cpumask_iter",
+};
+
+static const char * const negative_testcases[] = {
+       "null_pointer",
+       "zero_bit",
+       "no_mem",
+       "invalid_bits"
+};
+
+static int read_percpu_data(struct bpf_link *link, int nr_cpu_exp, int nr_running_exp)
+{
+       int iter_fd, len, item, nr_running, psi_running, nr_cpus, err = -1;
+       char buf[128];
+       size_t left;
+       char *p;
+
+       iter_fd = bpf_iter_create(bpf_link__fd(link));
+       if (!ASSERT_GE(iter_fd, 0, "iter_fd"))
+               return -1;
+
+       memset(buf, 0, sizeof(buf));
+       left = ARRAY_SIZE(buf);
+       p = buf;
+       while ((len = read(iter_fd, p, left)) > 0) {
+               p += len;
+               left -= len;
+       }
+
+       item = sscanf(buf, "nr_running %u nr_cpus %u psi_running %u\n",
+                     &nr_running, &nr_cpus, &psi_running);
+       if (!ASSERT_EQ(item, 3, "seq_format"))
+               goto out;
+       if (!ASSERT_EQ(nr_cpus, nr_cpu_exp, "nr_cpus"))
+               goto out;
+       if (!ASSERT_GE(nr_running, nr_running_exp, "nr_running"))
+               goto out;
+       if (!ASSERT_GE(psi_running, nr_running_exp, "psi_running"))
+               goto out;
+
+       err = 0;
+out:
+       close(iter_fd);
+       return err;
+}

..

tools/testing/selftests/bpf/prog_tests/bits_iter.c line 114

Quoted 11 lines
tools/testing/selftests/bpf/prog_tests/bits_iter.c new file +11 -0
+
+       /* Case 1): Enable all possible CPUs */
+       CPU_ZERO(&set);
+       for (i = 0; i < nr_cpus; i++)
+               CPU_SET(i, &set);
+       err = sched_setaffinity(skel->bss->pid, sizeof(set), &set);
+       if (!ASSERT_OK(err, "setaffinity_all_cpus"))
+               goto free_link;
+       err = read_percpu_data(link, nr_cpus, 1);
+       if (!ASSERT_OK(err, "read_percpu_data"))
+               goto free_link;

The patch 1 looks good, but this test fails on s390.

Quoted 8 lines

read_percpu_data:FAIL:nr_cpus unexpected nr_cpus: actual 0 != expected 2 verify_iter_success:FAIL:read_percpu_data unexpected error: -1 (errno 95)

Please see CI.

So either add it to DENYLIST.s390x in the same commit or make it work.

pw-bot: cr

The reason for the failure on s390x architecture is currently unclear. One plausible explanation is that total_nr_cpus remains 0 when executing the following code:

    bpf_for_each(bits, cpu, p->cpus_ptr, total_nr_cpus)

This is despite setting total_nr_cpus to the value obtained from libbpf_num_possible_cpus():

    skel->bss->total_nr_cpus = libbpf_num_possible_cpus();

A potential workaround could involve using a hardcoded number of CPUs, such as 8192, instead of relying on total_nr_cpus. This approach might mitigate the issue temporarily.

Signature · 2 lines
Regards
Yafang
maintainer
#8 lore raw

Re: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter

On Fri, 2024-02-23 at 10:29 +0800, Yafang Shao wrote:

[...]

Quoted 17 lines
Quoted 10 lines

The patch 1 looks good, but this test fails on s390.

read_percpu_data:FAIL:nr_cpus unexpected nr_cpus: actual 0 != expected 2 verify_iter_success:FAIL:read_percpu_data unexpected error: -1 (errno 95)

Please see CI.

So either add it to DENYLIST.s390x in the same commit or make it work.

pw-bot: cr

The reason for the failure on s390x architecture is currently unclear. One plausible explanation is that total_nr_cpus remains 0 when executing the following code:

    bpf_for_each(bits, cpu, p->cpus_ptr, total_nr_cpus)
Quoted 8 lines

This is despite setting total_nr_cpus to the value obtained from libbpf_num_possible_cpus():

    skel->bss->total_nr_cpus = libbpf_num_possible_cpus();

A potential workaround could involve using a hardcoded number of CPUs, such as 8192, instead of relying on total_nr_cpus. This approach might mitigate the issue temporarily.

I'm sorry, but is it really necessary to deal with total number of CPUs in a test for bit iterator?
Tbh, cpumask_iter / verify_iter_success seem to be over-complicated. Would it be possible to reuse test_loader.c's RUN_TESTS for this feature? It supports __retval(...) annotation, so it should be possible to:
- create a map (even a constant map) with some known data;
- peek a BPF program type that supports BPF_PROG_TEST_RUN syscall command;
- organize test BPF programs so that they create bit iterators for this test data and return some expected quantities (e.g. a sum), verified by __retval.

This should limit the amount of code on prog_tests/*.c side to the bare minimum.

#9 lore raw

Re: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter

Quoted 25 lines · Eduard Zingerman

On Fri, 2024-02-23 at 10:29 +0800, Yafang Shao wrote:

[...]

Quoted 20 lines
Quoted 10 lines

The patch 1 looks good, but this test fails on s390.

read_percpu_data:FAIL:nr_cpus unexpected nr_cpus: actual 0 != expected 2 verify_iter_success:FAIL:read_percpu_data unexpected error: -1 (errno 95)

Please see CI.

So either add it to DENYLIST.s390x in the same commit or make it work.

pw-bot: cr

The reason for the failure on s390x architecture is currently unclear. One plausible explanation is that total_nr_cpus remains 0 when executing the following code:

    bpf_for_each(bits, cpu, p->cpus_ptr, total_nr_cpus)

This is despite setting total_nr_cpus to the value obtained from libbpf_num_possible_cpus():

Quoted 8 lines
Quoted 5 lines
    skel->bss->total_nr_cpus = libbpf_num_possible_cpus();

A potential workaround could involve using a hardcoded number of CPUs, such as 8192, instead of relying on total_nr_cpus. This approach might mitigate the issue temporarily.

I'm sorry, but is it really necessary to deal with total number of CPUs in a test for bit iterator?

The CPU number verification is served to validate the functionality of bpf_iter_bits_next(). However, I believe we can streamline the logic by removing the surrounding code.

Quoted 11 lines

Tbh, cpumask_iter / verify_iter_success seem to be over-complicated. Would it be possible to reuse test_loader.c's RUN_TESTS for this feature? It supports __retval(...) annotation, so it should be possible to:
- create a map (even a constant map) with some known data;
- peek a BPF program type that supports BPF_PROG_TEST_RUN syscall command;
- organize test BPF programs so that they create bit iterators for this test data and return some expected quantities (e.g. a sum), verified by __retval.

This should limit the amount of code on prog_tests/*.c side to the bare minimum.

Thank you for your suggestion. I will consider it carefully.

Signature · 2 lines
Regards
Yafang
#10 lore raw

Re: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter

In reply to Yafang Shao
kernel test robot noticed the following build errors:

Hi Yafang,

kernel test robot noticed the following build errors:

[auto build test ERROR on bpf-next/master]

url:    https://github.com/intel-lab-lkp/linux/commits/Yafang-Shao/bpf-Add-bits-iterator/20240218-195123
base:   https://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf-next.git master
patch link:    https://lore.kernel.org/r/20240218114818.13585-3-laoar.shao%40gmail.com
patch subject: [PATCH bpf-next 2/2] selftests/bpf: Add selftest for bits iter
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240226/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All errors (new ones prefixed by >>):

>> progs/test_bits_iter_success.c:55:27: error: incomplete definition of type 'struct psi_group_cpu'
      55 |                 psi_nr_running += groupc->tasks[NR_RUNNING];
         |                                   ~~~~~~^
   progs/test_bits_iter_success.c:13:21: note: forward declaration of 'struct psi_group_cpu'
      13 | extern const struct psi_group_cpu system_group_pcpu __ksym __weak;
         |                     ^
>> progs/test_bits_iter_success.c:55:35: error: use of undeclared identifier 'NR_RUNNING'; did you mean 'T_RUNNING'?
      55 |                 psi_nr_running += groupc->tasks[NR_RUNNING];
         |                                                 ^~~~~~~~~~
         |                                                 T_RUNNING
   /tools/include/vmlinux.h:48349:3: note: 'T_RUNNING' declared here
    48349 |                 T_RUNNING = 0,
          |                 ^

2 errors generated.

Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki