selftests/bpf: move sockopt tests under test_progs
Subsystems (5)
v2 cover selftests/bpf: move sockopt tests under test_progs
Now that test_progs is shaping into more generic test framework, let's convert sockopt tests to it. This requires adding a helper to create and join a cgroup first (test__join_cgroup). Since we already hijack stdout/stderr that shouldn't be a problem (cgroup helpers log to stderr).
The rest of the patches just move sockopt tests files under prog_tests/ and do the required small adjustments.
v2:
* don't create a subtest per sockopt test, too verbose (Alexei Starovoitov)
Stanislav Fomichev (6):
selftests/bpf: test_progs: add test__join_cgroup helper selftests/bpf: test_progs: convert test_sockopt selftests/bpf: test_progs: convert test_sockopt_sk selftests/bpf: test_progs: convert test_sockopt_multi selftests/bpf: test_progs: convert test_sockopt_inherit selftests/bpf: test_progs: convert test_tcp_rtt
tools/testing/selftests/bpf/.gitignore | 5 -
tools/testing/selftests/bpf/Makefile | 12 +--
.../{test_sockopt.c => prog_tests/sockopt.c} | 50 ++-------
.../sockopt_inherit.c} | 102 ++++++++----------
.../sockopt_multi.c} | 62 ++---------
.../sockopt_sk.c} | 60 +++--------
.../{test_tcp_rtt.c => prog_tests/tcp_rtt.c} | 83 +++++---------
tools/testing/selftests/bpf/test_progs.c | 38 +++++++
tools/testing/selftests/bpf/test_progs.h | 4 +-
9 files changed, 142 insertions(+), 274 deletions(-)
rename tools/testing/selftests/bpf/{test_sockopt.c => prog_tests/sockopt.c} (96%)
rename tools/testing/selftests/bpf/{test_sockopt_inherit.c => prog_tests/sockopt_inherit.c} (72%)
rename tools/testing/selftests/bpf/{test_sockopt_multi.c => prog_tests/sockopt_multi.c} (83%)
rename tools/testing/selftests/bpf/{test_sockopt_sk.c => prog_tests/sockopt_sk.c} (79%)
rename tools/testing/selftests/bpf/{test_tcp_rtt.c => prog_tests/tcp_rtt.c} (76%)Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 1/6 selftests/bpf: test_progs: add test__join_cgroup helper
test__join_cgroup() combines the following operations that usually go hand in hand and returns cgroup fd:
* setup cgroup environment (make sure cgroupfs is mounted)
* mkdir cgroup
* join cgroup
It also marks a test as a "cgroup cleanup needed" and removes cgroup state after the test is done.
--- tools/testing/selftests/bpf/Makefile | 4 +-- tools/testing/selftests/bpf/test_progs.c | 38 ++++++++++++++++++++++++ tools/testing/selftests/bpf/test_progs.h | 1 + 3 files changed, 41 insertions(+), 2 deletions(-)
tools/testing/selftests/bpf/Makefile +2 -2
@@ -102,7 +102,7 @@ $(OUTPUT)/test_socket_cookie: cgroup_helpers.c $(OUTPUT)/test_sockmap: cgroup_helpers.c $(OUTPUT)/test_tcpbpf_user: cgroup_helpers.c $(OUTPUT)/test_tcpnotify_user: cgroup_helpers.c trace_helpers.c -$(OUTPUT)/test_progs: trace_helpers.c +$(OUTPUT)/test_progs: cgroup_helpers.c trace_helpers.c $(OUTPUT)/get_cgroup_id_user: cgroup_helpers.c $(OUTPUT)/test_cgroup_storage: cgroup_helpers.c $(OUTPUT)/test_netcnt: cgroup_helpers.c
@@ -196,7 +196,7 @@ $(ALU32_BUILD_DIR)/test_progs_32: test_progs.c $(OUTPUT)/libbpf.a\ | $(ALU32_BUILD_DIR) $(CC) $(TEST_PROGS_CFLAGS) $(CFLAGS) \ -o $(ALU32_BUILD_DIR)/test_progs_32 \ - test_progs.c test_stub.c trace_helpers.c prog_tests/*.c \ + test_progs.c test_stub.c cgroup_helpers.c trace_helpers.c prog_tests/*.c \ $(OUTPUT)/libbpf.a $(LDLIBS) $(ALU32_BUILD_DIR)/test_progs_32: $(PROG_TESTS_H)
tools/testing/selftests/bpf/test_progs.c +38 -0
@@ -2,6 +2,7 @@/* Copyright (c) 2017 Facebook */ #include "test_progs.h" +#include "cgroup_helpers.h" #include "bpf_rlimit.h" #include <argp.h> #include <string.h>
@@ -17,6 +18,7 @@ struct prog_test_def {int error_cnt;int skip_cnt;bool tested; +bool need_cgroup_cleanup;const char *subtest_name;int subtest_num;
@@ -122,6 +124,39 @@ void test__fail(void) env.test->error_cnt++; } +int test__join_cgroup (const char *path) +{ +int fd; + +if (!env.test->need_cgroup_cleanup) { +if (setup_cgroup_environment ()) { +fprintf (stderr, +"#%d %s: Failed to setup cgroup environment\n" , + env.test->test_num, env.test->test_name); +return -1 ; + } + + env.test->need_cgroup_cleanup = true; + } + + fd =create_and_get_cgroup (path); +if (fd <0 ) { +fprintf (stderr, +"#%d %s: Failed to create cgroup '%s' (errno=%d)\n" , + env.test->test_num, env.test->test_name, path, errno); +return fd; + } + +if (join_cgroup (path)) { +fprintf (stderr, +"#%d %s: Failed to join cgroup '%s' (errno=%d)\n" , + env.test->test_num, env.test->test_name, path, errno); +return -1 ; + } + +return fd; +} +struct ipv4_packet pkt_v4 = { .eth.h_proto =__bpf_constant_htons (ETH_P_IP ), .iph.ihl =5 ,
@@ -530,6 +565,9 @@ int main(int argc, char **argv)fprintf (env.stdout,"#%d %s:%s\n" , test->test_num, test->test_name, test->error_cnt ?"FAIL" :"OK" ); + +if (test->need_cgroup_cleanup) +cleanup_cgroup_environment (); }stdio_restore (); printf("Summary: %d/%d PASSED, %d SKIPPED, %d FAILED\n",
tools/testing/selftests/bpf/test_progs.h +1 -0
@@ -71,6 +71,7 @@ extern void test__force_log();extern bool test__start_subtest (const char *name);extern void test__skip (void );extern void test__fail (void ); +extern int test__join_cgroup (const char *path);#define MAGIC_BYTES 123
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 2/6 selftests/bpf: test_progs: convert test_sockopt
In reply to Stanislav FomichevMove the files, adjust includes, remove entry from Makefile & .gitignore
---
tools/testing/selftests/bpf/.gitignore | 1 -
tools/testing/selftests/bpf/Makefile | 3 +-
.../{test_sockopt.c => prog_tests/sockopt.c} | 50 +++----------------
3 files changed, 8 insertions(+), 46 deletions(-)
rename tools/testing/selftests/bpf/{test_sockopt.c => prog_tests/sockopt.c} (96%)tools/testing/selftests/bpf/.gitignore +0 -1
@@ -39,7 +39,6 @@ libbpf.so.* test_hashmap test_btf_dump xdping -test_sockopt test_sockopt_sk test_sockopt_multi test_sockopt_inherit
tools/testing/selftests/bpf/Makefile +1 -2
@@ -28,7 +28,7 @@ TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test test_sock test_btf test_sockmap get_cgroup_id_user test_socket_cookie \ test_cgroup_storage test_select_reuseport test_section_names \ test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \ - test_btf_dump test_cgroup_attach xdping test_sockopt test_sockopt_sk \ + test_btf_dump test_cgroup_attach xdping test_sockopt_sk \ test_sockopt_multi test_sockopt_inherit test_tcp_rtt BPF_OBJ_FILES = $(patsubst %.c,%.o, $(notdir $(wildcard progs/*.c)))
@@ -109,7 +109,6 @@ $(OUTPUT)/test_netcnt: cgroup_helpers.c $(OUTPUT)/test_sock_fields: cgroup_helpers.c $(OUTPUT)/test_sysctl: cgroup_helpers.c $(OUTPUT)/test_cgroup_attach: cgroup_helpers.c -$(OUTPUT)/test_sockopt: cgroup_helpers.c $(OUTPUT)/test_sockopt_sk: cgroup_helpers.c $(OUTPUT)/test_sockopt_multi: cgroup_helpers.c $(OUTPUT)/test_sockopt_inherit: cgroup_helpers.c
tools/testing/selftests/bpf/prog_tests/sockopt.c renamed from tools/testing/selftests/bpf/test_sockopt.c +7 -43
68 lines not on this page · raw message
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 3/6 selftests/bpf: test_progs: convert test_sockopt_sk
In reply to Stanislav FomichevMove the files, adjust includes, remove entry from Makefile & .gitignore
---
tools/testing/selftests/bpf/.gitignore | 1 -
tools/testing/selftests/bpf/Makefile | 3 +-
.../sockopt_sk.c} | 60 ++++---------------
tools/testing/selftests/bpf/test_progs.h | 3 +-
4 files changed, 15 insertions(+), 52 deletions(-)
rename tools/testing/selftests/bpf/{test_sockopt_sk.c => prog_tests/sockopt_sk.c} (79%)tools/testing/selftests/bpf/.gitignore +0 -1
@@ -39,7 +39,6 @@ libbpf.so.* test_hashmap test_btf_dump xdping -test_sockopt_sk test_sockopt_multi test_sockopt_inherit test_tcp_rtt
tools/testing/selftests/bpf/Makefile +1 -2
@@ -28,7 +28,7 @@ TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test test_sock test_btf test_sockmap get_cgroup_id_user test_socket_cookie \ test_cgroup_storage test_select_reuseport test_section_names \ test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \ - test_btf_dump test_cgroup_attach xdping test_sockopt_sk \ + test_btf_dump test_cgroup_attach xdping \ test_sockopt_multi test_sockopt_inherit test_tcp_rtt BPF_OBJ_FILES = $(patsubst %.c,%.o, $(notdir $(wildcard progs/*.c)))
@@ -109,7 +109,6 @@ $(OUTPUT)/test_netcnt: cgroup_helpers.c $(OUTPUT)/test_sock_fields: cgroup_helpers.c $(OUTPUT)/test_sysctl: cgroup_helpers.c $(OUTPUT)/test_cgroup_attach: cgroup_helpers.c -$(OUTPUT)/test_sockopt_sk: cgroup_helpers.c $(OUTPUT)/test_sockopt_multi: cgroup_helpers.c $(OUTPUT)/test_sockopt_inherit: cgroup_helpers.c $(OUTPUT)/test_tcp_rtt: cgroup_helpers.c
tools/testing/selftests/bpf/prog_tests/sockopt_sk.c renamed from tools/testing/selftests/bpf/test_sockopt_sk.c +12 -48
93 lines not on this page · raw message
tools/testing/selftests/bpf/test_progs.h +2 -1
@@ -16,9 +16,10 @@ typedef __u16 __sum16;#include <linux/if_packet.h> #include <linux/ip.h> #include <linux/ipv6.h> -#include <linux/tcp.h> +#include <netinet/tcp.h> #include <linux/filter.h> #include <linux/perf_event.h> +#include <linux/socket.h> #include <linux/unistd.h> #include <sys/ioctl.h>
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 4/6 selftests/bpf: test_progs: convert test_sockopt_multi
In reply to Stanislav FomichevMove the files, adjust includes, remove entry from Makefile & .gitignore
---
tools/testing/selftests/bpf/.gitignore | 1 -
tools/testing/selftests/bpf/Makefile | 3 +-
.../sockopt_multi.c} | 62 +++----------------
3 files changed, 11 insertions(+), 55 deletions(-)
rename tools/testing/selftests/bpf/{test_sockopt_multi.c => prog_tests/sockopt_multi.c} (83%)tools/testing/selftests/bpf/.gitignore +0 -1
@@ -39,6 +39,5 @@ libbpf.so.* test_hashmap test_btf_dump xdping -test_sockopt_multi test_sockopt_inherit test_tcp_rtt
tools/testing/selftests/bpf/Makefile +1 -2
@@ -29,7 +29,7 @@ TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test test_cgroup_storage test_select_reuseport test_section_names \ test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \ test_btf_dump test_cgroup_attach xdping \ - test_sockopt_multi test_sockopt_inherit test_tcp_rtt + test_sockopt_inherit test_tcp_rtt BPF_OBJ_FILES = $(patsubst %.c,%.o, $(notdir $(wildcard progs/*.c))) TEST_GEN_FILES = $(BPF_OBJ_FILES)
@@ -109,7 +109,6 @@ $(OUTPUT)/test_netcnt: cgroup_helpers.c $(OUTPUT)/test_sock_fields: cgroup_helpers.c $(OUTPUT)/test_sysctl: cgroup_helpers.c $(OUTPUT)/test_cgroup_attach: cgroup_helpers.c -$(OUTPUT)/test_sockopt_multi: cgroup_helpers.c $(OUTPUT)/test_sockopt_inherit: cgroup_helpers.c $(OUTPUT)/test_tcp_rtt: cgroup_helpers.c
tools/testing/selftests/bpf/prog_tests/sockopt_multi.c renamed from tools/testing/selftests/bpf/test_sockopt_multi.c +10 -52
92 lines not on this page · raw message
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 5/6 selftests/bpf: test_progs: convert test_sockopt_inherit
In reply to Stanislav FomichevMove the files, adjust includes, remove entry from Makefile & .gitignore
I also added pthread_cond_wait for the server thread startup. We don't want to connect to the server that's not yet up (for some reason this existing race is now more prominent with test_progs).
---
tools/testing/selftests/bpf/.gitignore | 1 -
tools/testing/selftests/bpf/Makefile | 4 +-
.../sockopt_inherit.c} | 102 ++++++++----------
3 files changed, 43 insertions(+), 64 deletions(-)
rename tools/testing/selftests/bpf/{test_sockopt_inherit.c => prog_tests/sockopt_inherit.c} (72%)tools/testing/selftests/bpf/.gitignore +0 -1
@@ -39,5 +39,4 @@ libbpf.so.* test_hashmap test_btf_dump xdping -test_sockopt_inherit test_tcp_rtt
tools/testing/selftests/bpf/Makefile +1 -3
@@ -28,8 +28,7 @@ TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test test_sock test_btf test_sockmap get_cgroup_id_user test_socket_cookie \ test_cgroup_storage test_select_reuseport test_section_names \ test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \ - test_btf_dump test_cgroup_attach xdping \ - test_sockopt_inherit test_tcp_rtt + test_btf_dump test_cgroup_attach xdping test_tcp_rtt BPF_OBJ_FILES = $(patsubst %.c,%.o, $(notdir $(wildcard progs/*.c))) TEST_GEN_FILES = $(BPF_OBJ_FILES)
@@ -109,7 +108,6 @@ $(OUTPUT)/test_netcnt: cgroup_helpers.c $(OUTPUT)/test_sock_fields: cgroup_helpers.c $(OUTPUT)/test_sysctl: cgroup_helpers.c $(OUTPUT)/test_cgroup_attach: cgroup_helpers.c -$(OUTPUT)/test_sockopt_inherit: cgroup_helpers.c $(OUTPUT)/test_tcp_rtt: cgroup_helpers.c .PHONY: force
tools/testing/selftests/bpf/prog_tests/sockopt_inherit.c renamed from tools/testing/selftests/bpf/test_sockopt_inherit.c +42 -60
166 lines not on this page · raw message
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
PATCH v2 6/6 selftests/bpf: test_progs: convert test_tcp_rtt
In reply to Stanislav FomichevMove the files, adjust includes, remove entry from Makefile & .gitignore
---
tools/testing/selftests/bpf/.gitignore | 1 -
tools/testing/selftests/bpf/Makefile | 3 +-
.../{test_tcp_rtt.c => prog_tests/tcp_rtt.c} | 83 ++++++-------------
3 files changed, 28 insertions(+), 59 deletions(-)
rename tools/testing/selftests/bpf/{test_tcp_rtt.c => prog_tests/tcp_rtt.c} (76%)tools/testing/selftests/bpf/.gitignore +0 -1
@@ -39,4 +39,3 @@ libbpf.so.* test_hashmap test_btf_dump xdping -test_tcp_rtt
tools/testing/selftests/bpf/Makefile +1 -2
@@ -28,7 +28,7 @@ TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test test_sock test_btf test_sockmap get_cgroup_id_user test_socket_cookie \ test_cgroup_storage test_select_reuseport test_section_names \ test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \ - test_btf_dump test_cgroup_attach xdping test_tcp_rtt + test_btf_dump test_cgroup_attach xdping BPF_OBJ_FILES = $(patsubst %.c,%.o, $(notdir $(wildcard progs/*.c))) TEST_GEN_FILES = $(BPF_OBJ_FILES)
@@ -108,7 +108,6 @@ $(OUTPUT)/test_netcnt: cgroup_helpers.c $(OUTPUT)/test_sock_fields: cgroup_helpers.c $(OUTPUT)/test_sysctl: cgroup_helpers.c $(OUTPUT)/test_cgroup_attach: cgroup_helpers.c -$(OUTPUT)/test_tcp_rtt: cgroup_helpers.c .PHONY: force
tools/testing/selftests/bpf/prog_tests/tcp_rtt.c renamed from tools/testing/selftests/bpf/test_tcp_rtt.c +27 -56
128 lines not on this page · raw message
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
Re: [PATCH bpf-next v2 1/6] selftests/bpf: test_progs: add test__join_cgroup helper
In reply to Stanislav FomichevQuoted 8 lines · Stanislav Fomichev
test__join_cgroup()combines the following operations that usually go hand in hand and returns cgroup fd:* setup cgroup environment (make sure cgroupfs is mounted)
* mkdir cgroup
* join cgroup
Quoted 5 lines
It also marks a test as a "cgroup cleanup needed" and removes cgroup state after the test is done.
Signed-off-by Stanislav Fomichev <[email protected]>---
First of all, thanks a lot for all these improvements to test_progs and converting existing tests to test_progs tests, it's great to see this consolidation!
[...]
tools/testing/selftests/bpf/test_progs.c void test__fail(void) · line 127
Quoted 13 lines
tools/testing/selftests/bpf/test_progs.c +2
-0@@ -17,6 +18,7 @@ struct prog_test_def {int error_cnt;int skip_cnt;bool tested; +bool need_cgroup_cleanup;const char *subtest_name;int subtest_num;@@ -122,6 +124,39 @@ void test__fail(void) env.test->error_cnt++; } +int test__join_cgroup (const char *path)
This doesn't seem to be testing-specific functionality, tbh. It's certainly useful helper, but I don't think it warrants test__ prefix.
As for test->need_cgroup_cleanup field, this approach won't scale if we need other types of custom/optional clean up after test ends. Generic test framework code will need to know about every possible custom setup to be able to cleanup/undo it.
I wonder if generalizing it to be able to add custom clean up code (some test frameworks have "teardown" overrides for this) would be cleaner and more maintainable solution.
Something like:
typedef void (* test_teardown_fn)(struct test *test, void *ctx);
/* somewhere at the beginning of test: */ test__schedule_teardown(test_teardown_fn cb, void *ctx);
[...]
tools/testing/selftests/bpf/test_progs.c int main(int argc, char **argv) · line 570
Quoted 3 lines
tools/testing/selftests/bpf/test_progs.c +3
-0+ +if (test->need_cgroup_cleanup) +cleanup_cgroup_environment ();
Then in generic framework we'll just process a list of callbacks and call each one with stored ctx per each callback (in case we need some custom data to be stored, of course).
Thoughts?
[...]
Re: [PATCH bpf-next v2 1/6] selftests/bpf: test_progs: add test__join_cgroup helper
Quoted 33 lines · Andrii Nakryiko
Quoted 8 lines · Stanislav Fomichev
test__join_cgroup()combines the following operations that usually go hand in hand and returns cgroup fd:* setup cgroup environment (make sure cgroupfs is mounted)
* mkdir cgroup
* join cgroupQuoted 5 lines
It also marks a test as a "cgroup cleanup needed" and removes cgroup state after the test is done.
Signed-off-by Stanislav Fomichev <[email protected]>---
First of all, thanks a lot for all these improvements to
test_progsand converting existing tests totest_progstests, it's great to see this consolidation![...]
Quoted 12 lines
tools/testing/selftests/bpf/test_progs.c +1
-0@@ -17,6 +18,7 @@ struct prog_test_def {int error_cnt;int skip_cnt;bool tested; +bool need_cgroup_cleanup;const char *subtest_name;int subtest_num;@@ -122,6 +124,39 @@ void test__fail(void) env.test->error_cnt++; }
Quoted 4 lines
tools/testing/selftests/bpf/test_progs.c void test__fail(void) · line 127
Quoted 1 line
tools/testing/selftests/bpf/test_progs.c +1
-0+int test__join_cgroup (const char *path)This doesn't seem to be testing-specific functionality, tbh. It's certainly useful helper, but I don't think it warrants
test__prefix.
I didn't like the mess we used to have:
if (setup_cgroup_environment()) goto cleanup_obj; cgroup_fd = create_and_get_cgroup(CG_PATH); if (cgroup_fd < 0) goto cleanup_cgroup_env; if (join_cgroup(CG_PATH)) goto cleanup_cgroup; ... do the test cleanup_cgroup_environment();
All I really want to do in several tests is to create a temporary cgroup and join it (I don't even really care about the name most of the time). We can rename and move this test__join_cgroup into cgroup_helpers.h if you prefer, I don't really mind. I just want to avoid repeating those 10 lines over and over in each test that just wants to run in a cgroup.
Quoted 22 lines
As for
test->need_cgroup_cleanupfield, this approach won't scale if we need other types of custom/optional clean up after test ends. Generic test framework code will need to know about every possible custom setup to be able to cleanup/undo it.I wonder if generalizing it to be able to add custom clean up code (some test frameworks have "teardown" overrides for this) would be cleaner and more maintainable solution.
Something like:
typedef void (* test_teardown_fn)(struct test *test, void *ctx);
/* somewhere at the beginning of test: */
test__schedule_teardown(test_teardown_fn cb, void *ctx);[...]
tools/testing/selftests/bpf/test_progs.c int main(int argc, char **argv) · line 570
Quoted 3 lines
tools/testing/selftests/bpf/test_progs.c +3
-0+ +if (test->need_cgroup_cleanup) +cleanup_cgroup_environment ();
Quoted 5 lines
Then in generic framework we'll just process a list of callbacks and call each one with stored ctx per each callback (in case we need some custom data to be stored, of course).
Thoughts?
Idk, I don't see the need to be too generic since we control both the tests and the framework. So putting something like test__join_cgroup and doing automatic cleanup looks fine to me if this is shared between several tests. If, at some point, it becomes unmanageable, we can think about refactoring; but until then, I'd not bother tbh.