Skip to content

Commit c063c83

Browse files
laoarKernel Patches Daemon
authored andcommitted
bpf, doc: Add document for cpumask iter
This patch adds the document for the newly added cpumask iterator kfuncs. Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
1 parent a086a2e commit c063c83

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

Documentation/bpf/cpumasks.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,23 @@ used.
372372
.. _tools/testing/selftests/bpf/progs/cpumask_success.c:
373373
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/tools/testing/selftests/bpf/progs/cpumask_success.c
374374

375+
3.3 cpumask iterator
376+
--------------------
377+
378+
The cpumask iterator enables the iteration of percpu data, such as runqueues,
379+
system_group_pcpu, and more.
380+
381+
.. kernel-doc:: kernel/bpf/cpumask.c
382+
:identifiers: bpf_iter_cpumask_new bpf_iter_cpumask_next
383+
bpf_iter_cpumask_destroy
384+
385+
----
386+
387+
Some example usages of the cpumask iterator can be found in
388+
`tools/testing/selftests/bpf/progs/test_cpumask_iter.c`_.
389+
390+
.. _tools/testing/selftests/bpf/progs/test_cpumask_iter.c:
391+
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/tools/testing/selftests/bpf/progs/test_cpumask_iter.c
375392

376393
4. Adding BPF cpumask kfuncs
377394
============================

0 commit comments

Comments
 (0)