Make BPF CGROUP_STORAGE map usable by different programs at once
Subsystems (5)
cover Make BPF CGROUP_STORAGE map usable by different programs at once
From: YiFei Zhu <[email protected]>
To access the storage in a CGROUP_STORAGE map, one uses bpf_get_local_storage helper, which is extremely fast due to its use of per-CPU variables. However, its whole code is built on the assumption that one map can only be used by one program at any time, and this prohibits any sharing of data between multiple programs using these maps, eliminating a lot of use cases, such as some per-cgroup configuration storage, written to by a setsockopt program and read by a cg_sock_addr program.
Why not use other map types? The great part of CGROUP_STORAGE map is that it is isolated by different cgroups its attached to. When one program uses bpf_get_local_storage, even on the same map, it gets different storages if it were run as a result of attaching to different cgroups. The kernel manages the storages, simplifying BPF program or userspace. In theory, one could probably use other maps like array or hash to do the same thing, but it would be a major overhead / complexity. Userspace needs to know when a cgroup is being freed in order to free up a space in the replacement map.
This patch set introduces a significant change to the semantics of CGROUP_STORAGE map type. Instead of each storage being tied to one single attachment, it is shared across different attachments to the same cgroup, and persists until either the map or the cgroup attached to is being freed.
How could this break existing users?
* Users that uses detach & reattach / program replacement as a shortcut to zeroing the storage. Since we need sharing between programs, we cannot zero the storage. Users that expect this behavior should either attach a program with a new map, or explicitly zero the map with a syscall.
* Programs that expect isolation from different attach types. In reality, attaching the same program to different attach types, relying on that expected_attach_type not being enforced, should rarely happen, if at all.
Both cases are dependent on undocumented implementation details, so the impact should be very minimal.
Patch 1 introduces a test on the old expected behavior of the map type.
Patch 2 introduces a test showing how two programs cannot share one such map.
Patch 3 implements the change of semantics to the map.
Patch 4 amends the new test such that it yields the behavior we expect from the change.
Patch 5 documents the map type.
Changes since RFC:
* Clarify commit message in patch 3 such that it says the lifetime of the storage is ended at the freeing of the cgroup_bpf, rather than the cgroup itself.
* Restored an -ENOMEM check in __cgroup_bpf_attach.
* Update selftests for recent change in network_helpers API.
YiFei Zhu (5):
selftests/bpf: Add test for CGROUP_STORAGE map on multiple attaches selftests/bpf: Test CGROUP_STORAGE map can't be used by multiple progs
bpf: Make cgroup storages shared across attaches on the same cgroup selftests/bpf: Test CGROUP_STORAGE behavior on shared egress + ingress Documentation/bpf: Document CGROUP_STORAGE map type
Documentation/bpf/index.rst | 9 + Documentation/bpf/map_cgroup_storage.rst | 95 +++++++ include/linux/bpf-cgroup.h | 15 +- include/uapi/linux/bpf.h | 2 +- kernel/bpf/cgroup.c | 42 ++- kernel/bpf/core.c | 12 - kernel/bpf/local_storage.c | 77 +++--- tools/include/uapi/linux/bpf.h | 2 +- .../bpf/prog_tests/cg_storage_multi.c | 242 ++++++++++++++++++ .../selftests/bpf/progs/cg_storage_multi.h | 13 + .../progs/cg_storage_multi_egress_ingress.c | 45 ++++ .../bpf/progs/cg_storage_multi_egress_only.c | 33 +++ 12 files changed, 497 insertions(+), 90 deletions(-) create mode 100644 Documentation/bpf/map_cgroup_storage.rst create mode 100644 tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi.h create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi_egress_ingress.c create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi_egress_only.c
Signature · 1 line
2.27.0
PATCH 1/5 selftests/bpf: Add test for CGROUP_STORAGE map on multiple attaches
From: YiFei Zhu <[email protected]>
This test creates a parent cgroup, and a child of that cgroup. It attaches a cgroup_skb/egress program that simply counts packets, to a global variable (ARRAY map), and to a CGROUP_STORAGE map. The program is first attached to the parent cgroup only, then to parent and child.
The test cases sends a message within the child cgroup, and because the program is inherited across parent / child cgroups, it will trigger the egress program for both the parent and child, if they exist. The program, when looking up a CGROUP_STORAGE map, uses the cgroup and attach type of the attachment parameters; therefore, both attaches uses different cgroup storages.
We assert that all packet counts returns what we expects.
--- .../bpf/prog_tests/cg_storage_multi.c | 154 ++++++++++++++++++ .../bpf/progs/cg_storage_multi_egress_only.c | 30 ++++ 2 files changed, 184 insertions(+) create mode 100644 tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi_egress_only.c
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +154 -0
@@ -0,0 +1,154 @@ +// SPDX-License-Identifier: GPL-2.0-only + +/* +* Copyright 2020 Google LLC. +*/ + +#include <test_progs.h> +#include <cgroup_helpers.h> +#include <network_helpers.h> + +#include "cg_storage_multi_egress_only.skel.h" + +#define PARENT_CGROUP "/cgroup_storage" +#define CHILD_CGROUP "/cgroup_storage/child" + +static bool assert_storage (struct bpf_map *map,const char *cgroup_path, +__u32 expected) +{ +struct bpf_cgroup_storage_key key = {0 }; +__u32 value; +int map_fd; + + map_fd =bpf_map__fd (map); + + key.cgroup_inode_id =get_cgroup_id (cgroup_path); + key.attach_type =BPF_CGROUP_INET_EGRESS ; +if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) <0 )) +return true; +if (CHECK_FAIL (value != expected)) +return true; + +return false; +} + +static bool assert_storage_noexist (struct bpf_map *map,const char *cgroup_path) +{ +struct bpf_cgroup_storage_key key = {0 }; +__u32 value; +int map_fd; + + map_fd =bpf_map__fd (map); + + key.cgroup_inode_id =get_cgroup_id (cgroup_path); + key.attach_type =BPF_CGROUP_INET_EGRESS ; +if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) ==0 )) +return true; +if (CHECK_FAIL (errno !=ENOENT )) +return true; + +return false; +} + +static bool connect_send (const char *cgroup_path) +{ +bool res = true; +int server_fd =-1 , client_fd =-1 ; + +if (join_cgroup (cgroup_path)) + goto out_clean; + + server_fd =start_server (AF_INET ,SOCK_DGRAM ,NULL ,0 ,0 ); +if (server_fd <0 ) + goto out_clean; + + client_fd =connect_to_fd (server_fd,0 ); +if (client_fd <0 ) + goto out_clean; + +if (send (client_fd,"message" ,strlen ("message" ),0 ) <0 ) + goto out_clean; + + res = false; + +out_clean: +close (client_fd); +close (server_fd); +return res; +} + +static void test_egress_only (int parent_cgroup_fd,int child_cgroup_fd) +{ +struct cg_storage_multi_egress_only *obj; +int err; + +if (!test__start_subtest ("egress_only" )) +return ; + + obj =cg_storage_multi_egress_only__open_and_load (); +if (CHECK_FAIL (!obj)) +return ; + +/* Attach to parent cgroup, trigger packet from child. +* Assert that there is only one run and in that run the storage is +* parent cgroup's storage. +* Also assert that child cgroup's storage does not exist +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + parent_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + err =connect_send (CHILD_CGROUP ); +if (CHECK_FAIL (err)) + goto close_bpf_object; +if (CHECK_FAIL (obj->bss->invocations !=1 )) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +PARENT_CGROUP ,1 ))) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage_noexist (obj->maps.cgroup_storage, +CHILD_CGROUP ))) + goto close_bpf_object; + +/* Attach to parent and child cgroup, trigger packet from child. +* Assert that there are two additional runs, one that run with parent +* cgroup's storage and one with child cgroup's storage. +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + child_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + + err =connect_send (CHILD_CGROUP ); +if (CHECK_FAIL (err)) + goto close_bpf_object; +if (CHECK_FAIL (obj->bss->invocations !=3 )) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +PARENT_CGROUP ,2 ))) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +CHILD_CGROUP ,1 ))) + goto close_bpf_object; + +close_bpf_object: +cg_storage_multi_egress_only__destroy (obj); +} + +void test_cg_storage_multi (void ) +{ +int parent_cgroup_fd, child_cgroup_fd; + + parent_cgroup_fd =test__join_cgroup (PARENT_CGROUP ); + child_cgroup_fd =create_and_get_cgroup (CHILD_CGROUP ); +if (CHECK_FAIL (parent_cgroup_fd <0 || child_cgroup_fd <0 )) + goto close_cgroup_fd; + +test_egress_only (parent_cgroup_fd, child_cgroup_fd); + +close_cgroup_fd: +close (child_cgroup_fd); +close (parent_cgroup_fd); +}
tools/testing/selftests/bpf/progs/cg_storage_multi_egress_only.c new file +30 -0
@@ -0,0 +1,30 @@ +// SPDX-License-Identifier: GPL-2.0-only + +/* +* Copyright 2020 Google LLC. +*/ + +#include <errno.h> +#include <linux/bpf.h> +#include <linux/ip.h> +#include <linux/udp.h> +#include <bpf/bpf_helpers.h> + +struct { + __uint(type, BPF_MAP_TYPE_CGROUP_STORAGE); + __type(key, struct bpf_cgroup_storage_key); + __type(value, __u32); +} cgroup_storage SEC(".maps"); + +__u32 invocations =0 ; + +SEC("cgroup_skb/egress") +int egress (struct __sk_buff *skb) +{ +__u32 *ptr_cg_storage =bpf_get_local_storage (&cgroup_storage,0 ); + +__sync_fetch_and_add (ptr_cg_storage,1 ); +__sync_fetch_and_add (&invocations,1 ); + +return 1 ; +}
Signature · 1 line
2.27.0
PATCH 2/5 selftests/bpf: Test CGROUP_STORAGE map can't be used by multiple progs
In reply to YiFei ZhuFrom: YiFei Zhu <[email protected]>
The current assumption is that the lifetime of a cgroup storage is tied to the program's attachment. The storage is created in cgroup_bpf_attach, and released upon cgroup_bpf_detach and cgroup_bpf_release.
Because the current semantics is that each attachment gets a completely independent cgroup storage, and you can have multiple programs attached to the same (cgroup, attach type) pair, the key of the CGROUP_STORAGE map, looking up the map with this pair could yield multiple storages, and that is not permitted. Therefore, the kernel verifier checks that two programs cannot share the same CGROUP_STORAGE map, even if they have different expected attach types, considering that the actual attach type does not always have to be equal to the expected attach type.
The test creates a CGROUP_STORAGE map and make it shared across two different programs, one cgroup_skb/egress and one /ingress. It asserts that the two programs cannot be both loaded, due to verifier failure from the above reason.
--- .../bpf/prog_tests/cg_storage_multi.c | 37 ++++++++++++--- .../selftests/bpf/progs/cg_storage_multi.h | 13 ++++++ .../progs/cg_storage_multi_egress_ingress.c | 45 +++++++++++++++++++ .../bpf/progs/cg_storage_multi_egress_only.c | 9 ++-- 4 files changed, 94 insertions(+), 10 deletions(-) create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi.h create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi_egress_ingress.c
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c +30 -7
@@ -8,16 +8,19 @@#include <cgroup_helpers.h> #include <network_helpers.h> +#include "progs/cg_storage_multi.h" +#include "cg_storage_multi_egress_only.skel.h" +#include "cg_storage_multi_egress_ingress.skel.h" #define PARENT_CGROUP "/cgroup_storage"#define CHILD_CGROUP "/cgroup_storage/child"static bool assert_storage (struct bpf_map *map,const char *cgroup_path, -__u32 expected) +struct cgroup_value *expected) {struct bpf_cgroup_storage_key key = {0 }; -__u32 value; +struct cgroup_value value;int map_fd; map_fd =bpf_map__fd (map);
@@ -26,7 +29,7 @@ static bool assert_storage(struct bpf_map *map, const char *cgroup_path, key.attach_type =BPF_CGROUP_INET_EGRESS ;if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) <0 ))return true; -if (CHECK_FAIL (value != expected)) +if (CHECK_FAIL (memcmp (&value, expected,sizeof (struct cgroup_value ))))return true;return false;
@@ -35,7 +38,7 @@ static bool assert_storage(struct bpf_map *map, const char *cgroup_path,static bool assert_storage_noexist (struct bpf_map *map,const char *cgroup_path) {struct bpf_cgroup_storage_key key = {0 }; -__u32 value; +struct cgroup_value value;int map_fd; map_fd =bpf_map__fd (map);
@@ -80,6 +83,7 @@ static bool connect_send(const char *cgroup_path)static void test_egress_only (int parent_cgroup_fd,int child_cgroup_fd) {struct cg_storage_multi_egress_only *obj; +struct cgroup_value expected_cgroup_value;int err;if (!test__start_subtest ("egress_only" ))
@@ -104,8 +108,9 @@ static void test_egress_only(int parent_cgroup_fd, int child_cgroup_fd) goto close_bpf_object;if (CHECK_FAIL (obj->bss->invocations !=1 )) goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { .egress_pkts =1 };if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, -PARENT_CGROUP ,1 ))) +PARENT_CGROUP , &expected_cgroup_value))) goto close_bpf_object;if (CHECK_FAIL (assert_storage_noexist (obj->maps.cgroup_storage,CHILD_CGROUP )))
@@ -126,17 +131,34 @@ static void test_egress_only(int parent_cgroup_fd, int child_cgroup_fd) goto close_bpf_object;if (CHECK_FAIL (obj->bss->invocations !=3 )) goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { .egress_pkts =2 };if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, -PARENT_CGROUP ,2 ))) +PARENT_CGROUP , &expected_cgroup_value))) goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { .egress_pkts =1 };if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, -CHILD_CGROUP ,1 ))) +CHILD_CGROUP , &expected_cgroup_value))) goto close_bpf_object; close_bpf_object:cg_storage_multi_egress_only__destroy (obj); } +static void test_egress_ingress (int parent_cgroup_fd,int child_cgroup_fd) +{ +struct cg_storage_multi_egress_ingress *obj; + +if (!test__start_subtest ("egress_ingress" )) +return ; + +/* Cannot load both programs due to verifier failure: +* "only one cgroup storage of each type is allowed" +*/ + obj =cg_storage_multi_egress_ingress__open_and_load (); +if (CHECK_FAIL (obj || errno !=EBUSY )) +return ; +} +void test_cg_storage_multi (void ) {int parent_cgroup_fd, child_cgroup_fd;
@@ -147,6 +169,7 @@ void test_cg_storage_multi(void) goto close_cgroup_fd;test_egress_only (parent_cgroup_fd, child_cgroup_fd); +test_egress_ingress (parent_cgroup_fd, child_cgroup_fd); close_cgroup_fd:close (child_cgroup_fd);
tools/testing/selftests/bpf/progs/cg_storage_multi.h new file +13 -0
@@ -0,0 +1,13 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ + +#ifndef __PROGS_CG_STORAGE_MULTI_H +#define __PROGS_CG_STORAGE_MULTI_H + +#include <asm/types.h> + +struct cgroup_value { +__u32 egress_pkts; +__u32 ingress_pkts; +}; + +#endif
tools/testing/selftests/bpf/progs/cg_storage_multi_egress_ingress.c new file +45 -0
45 lines not on this page · raw message
tools/testing/selftests/bpf/progs/cg_storage_multi_egress_only.c +6 -3
@@ -10,10 +10,12 @@#include <linux/udp.h> #include <bpf/bpf_helpers.h> +#include "progs/cg_storage_multi.h" +struct { __uint(type, BPF_MAP_TYPE_CGROUP_STORAGE); __type(key, struct bpf_cgroup_storage_key); - __type(value, __u32); + __type(value, struct cgroup_value); } cgroup_storage SEC(".maps");__u32 invocations =0 ;
@@ -21,9 +23,10 @@ __u32 invocations = 0; SEC("cgroup_skb/egress")int egress (struct __sk_buff *skb) { -__u32 *ptr_cg_storage =bpf_get_local_storage (&cgroup_storage,0 ); +struct cgroup_value *ptr_cg_storage = +bpf_get_local_storage (&cgroup_storage,0 ); -__sync_fetch_and_add (ptr_cg_storage,1 ); +__sync_fetch_and_add (&ptr_cg_storage->egress_pkts,1 );__sync_fetch_and_add (&invocations,1 );return 1 ;
Signature · 1 line
2.27.0
PATCH 3/5 bpf: Make cgroup storages shared across attaches on the same cgroup
In reply to YiFei ZhuFrom: YiFei Zhu <[email protected]>
This change comes in several parts:
One, the restriction that the CGROUP_STORAGE map can only be used by one program is removed. This results in the removal of the field 'aux' in struct bpf_cgroup_storage_map, and removal of relevant code associated with the field, and removal of now-noop functions bpf_free_cgroup_storage and bpf_cgroup_storage_release.
Second, because there could be multiple attach types to the same cgroup, the attach type is completely ignored on comparison in the map key. Newly added keys have it zeroed. The only value in the key that still matters is the cgroup inode.
Third, because the storages are now shared, the storages cannot be unconditionally freed on program detach. There could be two ways to solve this issue:
* A. Reference count the usage of the storages, and free when the last program is detached.
* B. Free only when the storage is impossible to be referred to again, i.e. when either the cgroup_bpf it is attached to, or the map itself, is freed.
Option A has the side effect that, when the user detach and reattach a program, whether the program gets a fresh storage depends on whether there is another program attached using that storage. This could trigger races if the user is multi-threaded, and since nondeterminism in data races is evil, go with option B.
The both the map and the cgroup_bpf now tracks their associated storages, and the storage unlink and free are removed from cgroup_bpf_detach and added to cgroup_bpf_release and cgroup_storage_map_free. Storages are now always individually unlinked so the function bpf_cgroup_storages_unlink is now unused and removed.
Fourth, on attach, we reuse the old storage if the key already exists in the map. Because the rbtree traversal holds the spinlock of the map, during which we can't allocate a new storage if we don't find an old storage, instead we preallocate the storage unconditionally, and free the preallocated storage if we find an old storage in the map. This results in a change of semantics in bpf_cgroup_storage{,s}_link, and rename cgroup_storage_insert to cgroup_storage_lookup_insert that does both lookup and conditionally insert or free.
--- include/linux/bpf-cgroup.h | 15 +++---- include/uapi/linux/bpf.h | 2 +- kernel/bpf/cgroup.c | 42 ++++++++----------- kernel/bpf/core.c | 12 ------ kernel/bpf/local_storage.c | 77 +++++++++++++++------------------- tools/include/uapi/linux/bpf.h | 2 +- 6 files changed, 60 insertions(+), 90 deletions(-)
include/linux/bpf-cgroup.h +8 -7
@@ -46,7 +46,8 @@ struct bpf_cgroup_storage { };struct bpf_cgroup_storage_map *map;struct bpf_cgroup_storage_key key; -struct list_head list; +struct list_head list_map; +struct list_head list_cg;struct rb_node node;struct rcu_head rcu; };
@@ -78,6 +79,9 @@ struct cgroup_bpf {struct list_head progs[MAX_BPF_ATTACH_TYPE ];u32 flags[MAX_BPF_ATTACH_TYPE ]; +/* list of cgroup shared storages */ +struct list_head storages; +/* temp storage for effective prog array used by prog_attach/detach */ struct bpf_prog_array *inactive;
@@ -164,12 +168,11 @@ static inline void bpf_cgroup_storage_set(struct bpf_cgroup_storagestruct bpf_cgroup_storage *bpf_cgroup_storage_alloc (struct bpf_prog *prog,enum bpf_cgroup_storage_type stype);void bpf_cgroup_storage_free (struct bpf_cgroup_storage *storage); -void bpf_cgroup_storage_link (struct bpf_cgroup_storage *storage, -struct cgroup *cgroup, -enum bpf_attach_type type); +struct bpf_cgroup_storage * +bpf_cgroup_storage_link (struct bpf_cgroup_storage *new_storage, +struct cgroup *cgroup);void bpf_cgroup_storage_unlink (struct bpf_cgroup_storage *storage);int bpf_cgroup_storage_assign (struct bpf_prog_aux *aux,struct bpf_map *map); -void bpf_cgroup_storage_release (struct bpf_prog_aux *aux,struct bpf_map *map);int bpf_percpu_cgroup_storage_copy (struct bpf_map *map,void *key,void *value); int bpf_percpu_cgroup_storage_update(struct bpf_map *map, void *key,
@@ -380,8 +383,6 @@ static inline void bpf_cgroup_storage_set( struct bpf_cgroup_storage *storage[MAX_BPF_CGROUP_STORAGE_TYPE]) {}static inline int bpf_cgroup_storage_assign (struct bpf_prog_aux *aux,struct bpf_map *map) {return 0 ; } -static inline void bpf_cgroup_storage_release (struct bpf_prog_aux *aux, -struct bpf_map *map) {}static inline struct bpf_cgroup_storage *bpf_cgroup_storage_alloc (struct bpf_prog *prog,enum bpf_cgroup_storage_type stype) {return NULL ; } static inline void bpf_cgroup_storage_free(
include/uapi/linux/bpf.h +1 -1
@@ -78,7 +78,7 @@ struct bpf_lpm_trie_key {struct bpf_cgroup_storage_key {__u64 cgroup_inode_id;/* cgroup inode id */ -__u32 attach_type;/* program attach type */ +__u32 attach_type;/* program attach type, unused */ };/* BPF syscall commands, see bpf(2) man-page for details. */
kernel/bpf/cgroup.c +17 -25
118 lines not on this page · raw message
kernel/bpf/core.c +0 -12
@@ -2042,24 +2042,12 @@ int bpf_prog_array_copy_info(struct bpf_prog_array *array, : 0; } -static void bpf_free_cgroup_storage (struct bpf_prog_aux *aux) -{ -enum bpf_cgroup_storage_type stype; - -for_each_cgroup_storage_type (stype) { -if (!aux->cgroup_storage[stype]) -continue ; -bpf_cgroup_storage_release (aux, aux->cgroup_storage[stype]); - } -} -void __bpf_free_used_maps (struct bpf_prog_aux *aux,struct bpf_map **used_maps,u32 len) {struct bpf_map *map;u32 i; -bpf_free_cgroup_storage (aux);for (i =0 ; i < len; i++) { map = used_maps[i];if (map->ops->map_poke_untrack)
kernel/bpf/local_storage.c +33 -44
168 lines not on this page · raw message
tools/include/uapi/linux/bpf.h +1 -1
@@ -78,7 +78,7 @@ struct bpf_lpm_trie_key {struct bpf_cgroup_storage_key {__u64 cgroup_inode_id;/* cgroup inode id */ -__u32 attach_type;/* program attach type */ +__u32 attach_type;/* program attach type, unused */ };/* BPF syscall commands, see bpf(2) man-page for details. */
Signature · 1 line
2.27.0
PATCH 4/5 selftests/bpf: Test CGROUP_STORAGE behavior on shared egress + ingress
In reply to YiFei ZhuFrom: YiFei Zhu <[email protected]>
This mirrors the original egress-only test. The cgroup_storage is now extended to have two packet counters, one for egress and one for ingress. The behavior of the counters are exactly the same as the original egress-only test, only that the total number of invocations doubles from having both egress and ingress being counted.
The field attach_type in the map key is ignored in the kernel; however, keeping it is pointless here and we are demonstrating the expected usage of the map, so it is removed. That said, keeping the field will not fail the test, for backwards compatibility reasons. In other words, the original egress-only test is not affected by the change in CGROUP_STORAGE behavior and will pass in both cases.
--- .../bpf/prog_tests/cg_storage_multi.c | 77 +++++++++++++++++-- 1 file changed, 71 insertions(+), 6 deletions(-)
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c +71 -6
@@ -26,7 +26,6 @@ static bool assert_storage(struct bpf_map *map, const char *cgroup_path, map_fd =bpf_map__fd (map); key.cgroup_inode_id =get_cgroup_id (cgroup_path); - key.attach_type =BPF_CGROUP_INET_EGRESS ;if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) <0 ))return true;if (CHECK_FAIL (memcmp (&value, expected,sizeof (struct cgroup_value ))))
@@ -44,7 +43,6 @@ static bool assert_storage_noexist(struct bpf_map *map, const char *cgroup_path) map_fd =bpf_map__fd (map); key.cgroup_inode_id =get_cgroup_id (cgroup_path); - key.attach_type =BPF_CGROUP_INET_EGRESS ;if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) ==0 ))return true;if (CHECK_FAIL (errno !=ENOENT ))
@@ -147,16 +145,83 @@ static void test_egress_only(int parent_cgroup_fd, int child_cgroup_fd)static void test_egress_ingress (int parent_cgroup_fd,int child_cgroup_fd) {struct cg_storage_multi_egress_ingress *obj; +struct cgroup_value expected_cgroup_value; +int err;if (!test__start_subtest ("egress_ingress" ))return ; -/* Cannot load both programs due to verifier failure: -* "only one cgroup storage of each type is allowed" -*/ obj =cg_storage_multi_egress_ingress__open_and_load (); -if (CHECK_FAIL (obj || errno !=EBUSY )) +if (CHECK_FAIL (!obj))return ; + +/* Attach to parent cgroup, trigger packet from child. +* Assert that there is two runs, one with parent cgroup egress and +* one with parent cgroup ingress. +* Also assert that child cgroup's storage does not exist +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + parent_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + err =bpf_prog_attach (bpf_program__fd (obj->progs.ingress), + parent_cgroup_fd, +BPF_CGROUP_INET_INGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + err =connect_send (CHILD_CGROUP ); +if (CHECK_FAIL (err)) + goto close_bpf_object; +if (CHECK_FAIL (obj->bss->invocations !=2 )) + goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { + .egress_pkts =1 , + .ingress_pkts =1 , + }; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +PARENT_CGROUP , &expected_cgroup_value))) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage_noexist (obj->maps.cgroup_storage, +CHILD_CGROUP ))) + goto close_bpf_object; + +/* Attach to parent and child cgroup, trigger packet from child. +* Assert that there is four additional runs, parent cgroup egress and +* ingress, child cgroup egress and ingress. +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + child_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + err =bpf_prog_attach (bpf_program__fd (obj->progs.ingress), + child_cgroup_fd, +BPF_CGROUP_INET_INGRESS ,BPF_F_ALLOW_MULTI ); +if (CHECK_FAIL (err)) + goto close_bpf_object; + err =connect_send (CHILD_CGROUP ); +if (CHECK_FAIL (err)) + goto close_bpf_object; +if (CHECK_FAIL (obj->bss->invocations !=6 )) + goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { + .egress_pkts =2 , + .ingress_pkts =2 , + }; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +PARENT_CGROUP , &expected_cgroup_value))) + goto close_bpf_object; + expected_cgroup_value = (struct cgroup_value ) { + .egress_pkts =1 , + .ingress_pkts =1 , + }; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +CHILD_CGROUP , &expected_cgroup_value))) + goto close_bpf_object; + +close_bpf_object: +cg_storage_multi_egress_ingress__destroy (obj); }void test_cg_storage_multi (void )
Signature · 1 line
2.27.0
PATCH 5/5 Documentation/bpf: Document CGROUP_STORAGE map type
In reply to YiFei ZhuFrom: YiFei Zhu <[email protected]>
The machanics and usage are not very straightforward. Given the changes it's better to document how it works and how to use it, rather than having to rely on the examples and implementation to infer what is going on.
--- Documentation/bpf/index.rst | 9 +++ Documentation/bpf/map_cgroup_storage.rst | 95 ++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 Documentation/bpf/map_cgroup_storage.rst
Documentation/bpf/index.rst +9 -0
@@ -48,6 +48,15 @@ Program types bpf_lsm +Map types +========= + +.. toctree:: + :maxdepth: 1 + + map_cgroup_storage + + Testing and debugging BPF =========================
Documentation/bpf/map_cgroup_storage.rst new file +95 -0
95 lines not on this page · raw message
Signature · 1 line
2.27.0
Re: [PATCH bpf-next 1/5] selftests/bpf: Add test for CGROUP_STORAGE map on multiple attaches
In reply to YiFei ZhuQuoted 26 lines · YiFei Zhu
From: YiFei Zhu <[email protected]>
This test creates a parent cgroup, and a child of that cgroup. It attaches a cgroup_skb/egress program that simply counts packets, to a global variable (ARRAY map), and to a
CGROUP_STORAGEmap. The program is first attached to the parent cgroup only, then to parent and child.The test cases sends a message within the child cgroup, and because the program is inherited across parent / child cgroups, it will trigger the egress program for both the parent and child, if they exist. The program, when looking up a
CGROUP_STORAGEmap, uses the cgroup and attach type of the attachment parameters; therefore, both attaches uses different cgroup storages.We assert that all packet counts returns what we expects.
Signed-off-by YiFei Zhu <[email protected]>--- .../bpf/prog_tests/cg_storage_multi.c | 154 ++++++++++++++++++ .../bpf/progs/cg_storage_multi_egress_only.c | 30 ++++ 2 files changed, 184 insertions(+) create mode 100644 tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c create mode 100644 tools/testing/selftests/bpf/progs/cg_storage_multi_egress_only.c
[...]
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c line 27
Quoted 13 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +13
-0+ +static bool assert_storage (struct bpf_map *map,const char *cgroup_path, +__u32 expected) +{ +struct bpf_cgroup_storage_key key = {0 }; +__u32 value; +int map_fd; + + map_fd =bpf_map__fd (map); + + key.cgroup_inode_id =get_cgroup_id (cgroup_path); + key.attach_type =BPF_CGROUP_INET_EGRESS ; +if (CHECK_FAIL (bpf_map_lookup_elem (map_fd, &key, &value) <0 ))
please don't use CHECK_FAIL, use CHECK instead
Quoted 7 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +7
-0+return true; +if (CHECK_FAIL (value != expected)) +return true; + +return false; +} +
[...]
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c line 86
Quoted 8 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +8
-0+ +static void test_egress_only (int parent_cgroup_fd,int child_cgroup_fd) +{ +struct cg_storage_multi_egress_only *obj; +int err; + +if (!test__start_subtest ("egress_only" )) +return ;
subtest check should be done in test_cg_storage_multi, otherwise it's not even clear that this test has subtests
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c line 99
Quoted 13 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +13
-0+ + obj =cg_storage_multi_egress_only__open_and_load (); +if (CHECK_FAIL (!obj)) +return ; + +/* Attach to parent cgroup, trigger packet from child. +* Assert that there is only one run and in that run the storage is +* parent cgroup's storage. +* Also assert that child cgroup's storage does not exist +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + parent_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI );
please use bpf_program__attach_cgroup() instead
Quoted 11 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +11
-0+if (CHECK_FAIL (err)) + goto close_bpf_object; + err =connect_send (CHILD_CGROUP ); +if (CHECK_FAIL (err)) + goto close_bpf_object; +if (CHECK_FAIL (obj->bss->invocations !=1 )) + goto close_bpf_object; +if (CHECK_FAIL (assert_storage (obj->maps.cgroup_storage, +PARENT_CGROUP ,1 ))) + goto close_bpf_object; + if (CHECK_FAIL(assert_storage_noexist(obj->maps.cgroup_storage,
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c line 120
Quoted 10 lines
tools/testing/selftests/bpf/prog_tests/cg_storage_multi.c new file +10
-0+ CHILD_CGROUP))) + goto close_bpf_object; + +/* Attach to parent and child cgroup, trigger packet from child. +* Assert that there are two additional runs, one that run with parent +* cgroup's storage and one with child cgroup's storage. +*/ + err =bpf_prog_attach (bpf_program__fd (obj->progs.egress), + child_cgroup_fd, +BPF_CGROUP_INET_EGRESS ,BPF_F_ALLOW_MULTI );
Here as well.
[...]