On 1/6/22 1:50 PM, Hao Luo wrote:
Bpffs is a pseudo file system that persists bpf objects. Previously
bpf objects can only be pinned in bpffs, this patchset extends pinning
to allow bpf objects to be pinned (or exposed) to other file systems.
In particular, this patchset allows pinning bpf objects in kernfs. This
creates a new file entry in the kernfs file system and the created file
is able to reference the bpf object. By doing so, bpf can be used to
customize the file's operations, such as seq_show.
As a concrete usecase of this feature, this patchset introduces a
simple new program type called 'bpf_view', which can be used to format
a seq file by a kernel object's state. By pinning a bpf_view program
into a cgroup directory, userspace is able to read the cgroup's state
from file in a format defined by the bpf program.
Different from bpffs, kernfs doesn't have a callback when a kernfs node
is freed, which is problem if we allow the kernfs node to hold an extra
reference of the bpf object, because there is no chance to dec the
object's refcnt. Therefore the kernfs node created by pinning doesn't
hold reference of the bpf object. The lifetime of the kernfs node
depends on the lifetime of the bpf object. Rather than "pinning in
kernfs", it is "exposing to kernfs". We require the bpf object to be
pinned in bpffs first before it can be pinned in kernfs. When the
object is unpinned from bpffs, their kernfs nodes will be removed
automatically. This somehow treats a pinned bpf object as a persistent
"device".
During our initial discussion for bpf_iter, we even proposed to
put cat-able files under /proc/ system. But there are some concerns
that /proc/ system holds stable APIs so people can rely on its format
etc. Not sure kernfs here has such requirement or not.
I understand directly put files in respective target directories
(e.g., cgroup) helps. But you can also create directory hierarchy
in bpffs. This can make a bunch of cgroup-stat-dumping bpf programs
better organized.
Also regarding new program type bpf_view, I think we can reuse
bpf_iter infrastructure. E.g., we already can customize bpf_iter
for a particular map. We can certainly customize bpf_iter targeting
a particular cgroup.
We rely on fsnotify to monitor the inode events in bpffs. A new function
bpf_watch_inode() is introduced. It allows registering a callback
function at inode destruction. For the kernfs case, a callback that
removes kernfs node is registered at the destruction of bpffs inodes.
For other file systems such as sockfs, bpf_watch_inode() can monitor the
destruction of sockfs inodes and the created file entry can hold the bpf
object's reference. In this case, it is truly "pinning".
File operations other than seq_show can also be implemented using bpf.
For example, bpf may be of help for .poll and .mmap in kernfs.
Patch organization:
- patch 1/8 and 2/8 are preparations. 1/8 implements bpf_watch_inode();
2/8 records bpffs inode in bpf object.
- patch 3/8 and 4/8 implement generic logic for creating bpf backed
kernfs file.
- patch 5/8 and 6/8 add a new program type for formatting output.
- patch 7/8 implements cgroup seq_show operation using bpf.
- patch 8/8 adds selftest.
Hao Luo (8):
bpf: Support pinning in non-bpf file system.
bpf: Record back pointer to the inode in bpffs
bpf: Expose bpf object in kernfs
bpf: Support removing kernfs entries
bpf: Introduce a new program type bpf_view.
libbpf: Support of bpf_view prog type.
bpf: Add seq_show operation for bpf in cgroupfs
selftests/bpf: Test exposing bpf objects in kernfs
include/linux/bpf.h | 9 +-
include/uapi/linux/bpf.h | 2 +
kernel/bpf/Makefile | 2 +-
kernel/bpf/bpf_view.c | 190 ++++++++++++++
kernel/bpf/bpf_view.h | 25 ++
kernel/bpf/inode.c | 219 ++++++++++++++--
kernel/bpf/inode.h | 54 ++++
kernel/bpf/kernfs_node.c | 165 ++++++++++++
kernel/bpf/syscall.c | 3 +
kernel/bpf/verifier.c | 6 +
kernel/trace/bpf_trace.c | 12 +-
tools/include/uapi/linux/bpf.h | 2 +
tools/lib/bpf/libbpf.c | 21 ++
.../selftests/bpf/prog_tests/pinning_kernfs.c | 245 ++++++++++++++++++
.../selftests/bpf/progs/pinning_kernfs.c | 72 +++++
15 files changed, 995 insertions(+), 32 deletions(-)
create mode 100644 kernel/bpf/bpf_view.c
create mode 100644 kernel/bpf/bpf_view.h
create mode 100644 kernel/bpf/inode.h
create mode 100644 kernel/bpf/kernfs_node.c
create mode 100644 tools/testing/selftests/bpf/prog_tests/pinning_kernfs.c
create mode 100644 tools/testing/selftests/bpf/progs/pinning_kernfs.c
