There already exists a local storage implementation for cgroup-attached
bpf programs. See map type BPF_MAP_TYPE_CGROUP_STORAGE and helper
bpf_get_local_storage(). But there are use cases such that non-cgroup
attached bpf progs wants to access cgroup local storage data. For example,
tc egress prog has access to sk and cgroup. It is possible to use
sk local storage to emulate cgroup local storage by storing data in socket.
But this is a waste as it could be lots of sockets belonging to a particular
cgroup. Alternatively, a separate map can be created with cgroup id as the key.
But this will introduce additional overhead to manipulate the new map.
A cgroup local storage, similar to existing sk/inode/task storage,
should help for this use case.
This patch implemented new cgroup local storage available to
non-cgroup-attached bpf programs. In the patch series, Patches 1 and 2
are preparation patches. Patch 3 implemented new cgroup local storage
kernel support. Patches 4 and 5 implemented libbpf and bpftool support.
Patches 6-8 fixed one existing test and added four new tests to validate
kernel/libbpf implementations. Patch 9 added documentation for new
BPF_MAP_TYPE_CGRP_STORAGE map type and comparison of the old and new
cgroup local storage maps.
Changelogs:
v5 -> v6:
. fix selftest test_libbpf_str/bpf_map_type_str due to marking
BPF_MAP_TYPE_CGROUP_STORAGE as deprecated.
. add cgrp_local_storage test in s390x denylist since the test
has some fentry/fexit programs.
v4 -> v5:
. additional refactoring in patch 2
. fix the call site for bpf_cgrp_storage_free() in kernel/cgroup/cgroup.c.
. add a test for progs attaching to cgroups
. add a negative test (the helper key is a task instead of expected cgroup)
. some spelling fixes
v3 -> v4:
. fix a config guarding problem in kernel/cgroup/cgroup.c when
cgrp_storage is deleted (CONFIG_CGROUP_BPF => CONFIG_BPF_SYSCALL).
. rename selftest from cgroup_local_storage.c to cgrp_local_storage.c
so the name can better align with map name.
. fix a few misspellings.
v2 -> v3:
. fix a config caused kernel test complaint.
. better description/comments in uapi bpf.h and bpf_cgrp_storage.c.
. factor code for better resue for map_alloc/map_free.
. improved explanation in map documentation.
v1 -> v2:
. change map name from BPF_MAP_TYPE_CGROUP_LOCAL_STORAGE to
BPF_MAP_TYPE_CGRP_STORAGE.
. removed support of sleepable programs.
. changed the place of freeing cgrp local storage from put_css_set_locked()
to css_free_rwork_fn().
. added map documentation.
Yonghong Song (9):
bpf: Make struct cgroup btf id global
bpf: Refactor some inode/task/sk storage functions for reuse
bpf: Implement cgroup storage available to non-cgroup-attached bpf
progs
libbpf: Support new cgroup local storage
bpftool: Support new cgroup local storage
selftests/bpf: Fix test test_libbpf_str/bpf_map_type_str
selftests/bpf: Add selftests for new cgroup local storage
selftests/bpf: Add test cgrp_local_storage to DENYLIST.s390x
docs/bpf: Add documentation for new cgroup local storage
Documentation/bpf/map_cgrp_storage.rst | 109 ++++++++
include/linux/bpf.h | 7 +
include/linux/bpf_local_storage.h | 17 +-
include/linux/bpf_types.h | 1 +
include/linux/btf_ids.h | 1 +
include/linux/cgroup-defs.h | 4 +
include/uapi/linux/bpf.h | 50 +++-
kernel/bpf/Makefile | 2 +-
kernel/bpf/bpf_cgrp_storage.c | 247 ++++++++++++++++++
kernel/bpf/bpf_inode_storage.c | 38 +--
kernel/bpf/bpf_local_storage.c | 190 +++++++++-----
kernel/bpf/bpf_task_storage.c | 38 +--
kernel/bpf/cgroup_iter.c | 2 +-
kernel/bpf/helpers.c | 6 +
kernel/bpf/syscall.c | 3 +-
kernel/bpf/verifier.c | 13 +-
kernel/cgroup/cgroup.c | 1 +
kernel/trace/bpf_trace.c | 4 +
net/core/bpf_sk_storage.c | 35 +--
scripts/bpf_doc.py | 2 +
.../bpf/bpftool/Documentation/bpftool-map.rst | 2 +-
tools/bpf/bpftool/map.c | 2 +-
tools/include/uapi/linux/bpf.h | 50 +++-
tools/lib/bpf/libbpf.c | 1 +
tools/lib/bpf/libbpf_probes.c | 1 +
tools/testing/selftests/bpf/DENYLIST.s390x | 1 +
.../bpf/prog_tests/cgrp_local_storage.c | 171 ++++++++++++
.../selftests/bpf/prog_tests/libbpf_str.c | 8 +
.../bpf/progs/cgrp_ls_attach_cgroup.c | 101 +++++++
.../selftests/bpf/progs/cgrp_ls_negative.c | 26 ++
.../selftests/bpf/progs/cgrp_ls_recursion.c | 70 +++++
.../selftests/bpf/progs/cgrp_ls_tp_btf.c | 88 +++++++
32 files changed, 1102 insertions(+), 189 deletions(-)
create mode 100644 Documentation/bpf/map_cgrp_storage.rst
create mode 100644 kernel/bpf/bpf_cgrp_storage.c
create mode 100644 tools/testing/selftests/bpf/prog_tests/cgrp_local_storage.c
create mode 100644 tools/testing/selftests/bpf/progs/cgrp_ls_attach_cgroup.c
create mode 100644 tools/testing/selftests/bpf/progs/cgrp_ls_negative.c
create mode 100644 tools/testing/selftests/bpf/progs/cgrp_ls_recursion.c
create mode 100644 tools/testing/selftests/bpf/progs/cgrp_ls_tp_btf.c
--
2.30.2
