bpf: selftests: A few changes to network_helpers and netns-reset
Subsystems (5)
v2 cover bpf: selftests: A few changes to network_helpers and netns-reset
This set is separated out from the bpf tcp header option series [1] since I think it is in general useful for other network related tests. e.g. enforce socket-fd related timeout and restore netns after each test.
[1]: https://lore.kernel.org/netdev/[email protected]/
v2:
- Mention non-NULL addr use case in commit message. (Yonghong)
- Add prefix "__" to variables used in macro. (Yonghong)
Martin KaFai Lau (2):
bpf: selftests: A few improvements to network_helpers.c
bpf: selftests: Restore netns after each test
tools/testing/selftests/bpf/network_helpers.c | 157 +++++++++++------- tools/testing/selftests/bpf/network_helpers.h | 9 +- .../bpf/prog_tests/cgroup_skb_sk_lookup.c | 12 +- .../bpf/prog_tests/connect_force_port.c | 10 +- .../bpf/prog_tests/load_bytes_relative.c | 4 +- .../selftests/bpf/prog_tests/tcp_rtt.c | 4 +- tools/testing/selftests/bpf/test_progs.c | 23 ++- tools/testing/selftests/bpf/test_progs.h | 2 + 8 files changed, 133 insertions(+), 88 deletions(-)
Signature · 1 line
2.24.1
PATCH v2 1/2 bpf: selftests: A few improvements to network_helpers.c
This patch makes a few changes to the network_helpers.c
1) Enforce SO_RCVTIMEO and SO_SNDTIMEO
This patch enforces timeout to the network fds through setsockopt SO_RCVTIMEO and SO_SNDTIMEO.
It will remove the need for SOCK_NONBLOCK that requires a more demanding timeout logic with epoll/select, e.g. epoll_create, epoll_ctrl, and then epoll_wait for timeout.
That removes the need for connect_wait() from the cgroup_skb_sk_lookup.c. The needed change is made in cgroup_skb_sk_lookup.c.
2) start_server():
Add optional addr_str and port to start_server().
That removes the need of the start_server_with_port(). The caller can pass addr_str==NULL and/or port==0.
I have a future tcp-hdr-opt test that will pass a non-NULL addr_str and it is in general useful for other future tests.
"int timeout_ms" is also added to control the timeout on the "accept(listen_fd)".
3) connect_to_fd(): Fully use the server_fd.
The server sock address has already been obtained from getsockname(server_fd). The sockaddr includes the family, so the "int family" arg is redundant.
Since the server address is obtained from server_fd, there is little reason not to get the server's socket type from the server_fd also. getsockopt(server_fd) can be used to do that, so "int type" arg is also removed.
"int timeout_ms" is added.
4) connect_fd_to_fd():
"int timeout_ms" is added.
Some code is also refactored to connect_fd_to_addr() which is shared with connect_to_fd().
5) Preserve errno:
Some callers need to check errno, e.g. cgroup_skb_sk_lookup.c. Make changes to do it more consistently in save_errno_close() and log_err().
--- tools/testing/selftests/bpf/network_helpers.c | 157 +++++++++++------- tools/testing/selftests/bpf/network_helpers.h | 9 +- .../bpf/prog_tests/cgroup_skb_sk_lookup.c | 12 +- .../bpf/prog_tests/connect_force_port.c | 10 +- .../bpf/prog_tests/load_bytes_relative.c | 4 +- .../selftests/bpf/prog_tests/tcp_rtt.c | 4 +- 6 files changed, 110 insertions(+), 86 deletions(-)
tools/testing/selftests/bpf/network_helpers.c +93 -64
@@ -7,8 +7,6 @@#include <arpa/inet.h> -#include <sys/epoll.h> -#include <linux/err.h> #include <linux/in.h> #include <linux/in6.h>
@@ -17,8 +15,13 @@#include "network_helpers.h" #define clean_errno () (errno == 0 ? "None" : strerror(errno)) -#define log_err (MSG , ...) fprintf(stderr, "(%s:%d: errno: %s) " MSG "\n", \ - __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__) +#define log_err (MSG , ...) ({ \ + int __save = errno; \ + fprintf(stderr, "(%s:%d: errno: %s) " MSG "\n", \ + __FILE__, __LINE__, clean_errno(), \ + ##__VA_ARGS__); \ + errno = __save; \ +})struct ipv4_packet pkt_v4 = { .eth.h_proto =__bpf_constant_htons (ETH_P_IP ),
@@ -37,7 +40,34 @@ struct ipv6_packet pkt_v6 = { .tcp.doff = 5, }; -int start_server_with_port (int family,int type,__u16 port) +static int settimeo (int fd,int timeout_ms) +{ +struct timeval timeout = { .tv_sec =3 }; + +if (timeout_ms >0 ) { + timeout.tv_sec = timeout_ms /1000 ; + timeout.tv_usec = (timeout_ms %1000 ) *1000 ; + } + +if (setsockopt (fd,SOL_SOCKET ,SO_RCVTIMEO , &timeout, +sizeof (timeout))) { +log_err ("Failed to set SO_RCVTIMEO" ); +return -1 ; + } + +if (setsockopt (fd,SOL_SOCKET ,SO_SNDTIMEO , &timeout, +sizeof (timeout))) { +log_err ("Failed to set SO_SNDTIMEO" ); +return -1 ; + } + +return 0 ; +} + +#define save_errno_close (fd) ({ int __save = errno; close(fd); errno = __save; }) + +int start_server (int family,int type,const char *addr_str,__u16 port, +int timeout_ms) {struct sockaddr_storage addr = {};socklen_t len;
@@ -48,120 +78,119 @@ int start_server_with_port(int family, int type, __u16 port) sin->sin_family =AF_INET ; sin->sin_port =htons (port); +if (addr_str && +inet_pton (AF_INET , addr_str, &sin->sin_addr) !=1 ) { +log_err ("inet_pton(AF_INET, %s)" , addr_str); +return -1 ; + } len =sizeof (*sin); }else {struct sockaddr_in6 *sin6 = (void *)&addr; sin6->sin6_family =AF_INET6 ; sin6->sin6_port =htons (port); +if (addr_str && +inet_pton (AF_INET6 , addr_str, &sin6->sin6_addr) !=1 ) { +log_err ("inet_pton(AF_INET6, %s)" , addr_str); +return -1 ; + } len =sizeof (*sin6); } - fd =socket (family, type |SOCK_NONBLOCK ,0 ); + fd =socket (family, type,0 );if (fd <0 ) {log_err ("Failed to create server socket" );return -1 ; } +if (settimeo (fd, timeout_ms)) + goto error_close; +if (bind (fd, (const struct sockaddr *)&addr, len) <0 ) {log_err ("Failed to bind socket" ); -close (fd); -return -1 ; + goto error_close; }if (type ==SOCK_STREAM ) {if (listen (fd,1 ) <0 ) {log_err ("Failed to listed on socket" ); -close (fd); -return -1 ; + goto error_close; } }return fd; -} -int start_server (int family,int type) -{ -return start_server_with_port (family, type,0 ); +error_close: +save_errno_close (fd); +return -1 ; } -static const struct timeval timeo_sec = { .tv_sec =3 }; -static const size_t timeo_optlen =sizeof (timeo_sec); - -int connect_to_fd (int family,int type,int server_fd) +static int connect_fd_to_addr (int fd, +const struct sockaddr_storage *addr, +socklen_t addrlen) { -int fd, save_errno; - - fd =socket (family, type,0 ); -if (fd <0 ) { -log_err ("Failed to create client socket" ); +if (connect (fd, (const struct sockaddr *)addr, addrlen)) { +log_err ("Failed to connect to server" );return -1 ; } -if (connect_fd_to_fd (fd, server_fd) <0 && errno !=EINPROGRESS ) { - save_errno = errno; -close (fd); - errno = save_errno; -return -1 ; - } - -return fd; +return 0 ; } -int connect_fd_to_fd (int client_fd,int server_fd) +int connect_to_fd (int server_fd,int timeout_ms) {struct sockaddr_storage addr; -socklen_t len =sizeof (addr); -int save_errno; +struct sockaddr_in *addr_in; +socklen_t addrlen, optlen; +int fd, type; -if (setsockopt (client_fd,SOL_SOCKET ,SO_RCVTIMEO , &timeo_sec, - timeo_optlen)) { -log_err ("Failed to set SO_RCVTIMEO" ); + optlen =sizeof (type); +if (getsockopt (server_fd,SOL_SOCKET ,SO_TYPE , &type, &optlen)) { +log_err ("getsockopt(SOL_TYPE)" );return -1 ; } -if (getsockname (server_fd, (struct sockaddr *)&addr, &len)) { + addrlen =sizeof (addr); +if (getsockname (server_fd, (struct sockaddr *)&addr, &addrlen)) {log_err ("Failed to get server addr" );return -1 ; } -if (connect (client_fd, (const struct sockaddr *)&addr, len) <0 ) { -if (errno !=EINPROGRESS ) { - save_errno = errno; -log_err ("Failed to connect to server" ); - errno = save_errno; - } + addr_in = (struct sockaddr_in *)&addr; + fd =socket (addr_in->sin_family, type,0 ); +if (fd <0 ) { +log_err ("Failed to create client socket" );return -1 ; } -return 0 ; +if (settimeo (fd, timeout_ms)) + goto error_close; + +if (connect_fd_to_addr (fd, &addr, addrlen)) + goto error_close; + +return fd; + +error_close: +save_errno_close (fd); +return -1 ; } -int connect_wait (int fd) +int connect_fd_to_fd (int client_fd,int server_fd,int timeout_ms) { -struct epoll_event ev = {}, events[2 ]; -int timeout_ms =1000 ; -int efd, nfd; +struct sockaddr_storage addr; +socklen_t len =sizeof (addr); - efd =epoll_create1 (EPOLL_CLOEXEC ); -if (efd <0 ) { -log_err ("Failed to open epoll fd" ); +if (settimeo (client_fd, timeout_ms))return -1 ; - } - - ev.events =EPOLLRDHUP |EPOLLOUT ; - ev.data.fd = fd; -if (epoll_ctl (efd,EPOLL_CTL_ADD , fd, &ev) <0 ) { -log_err ("Failed to register fd=%d on epoll fd=%d" , fd, efd); -close (efd); +if (getsockname (server_fd, (struct sockaddr *)&addr, &len)) { +log_err ("Failed to get server addr" );return -1 ; } - nfd =epoll_wait (efd, events,ARRAY_SIZE (events), timeout_ms); -if (nfd <0 ) -log_err ("Failed to wait for I/O event on epoll fd=%d" , efd); +if (connect_fd_to_addr (client_fd, &addr, len)) +return -1 ; -close (efd); -return nfd; +return 0 ; }
tools/testing/selftests/bpf/network_helpers.h +4 -5
@@ -33,10 +33,9 @@ struct ipv6_packet { } __packed;extern struct ipv6_packet pkt_v6; -int start_server (int family,int type); -int start_server_with_port (int family,int type,__u16 port); -int connect_to_fd (int family,int type,int server_fd); -int connect_fd_to_fd (int client_fd,int server_fd); -int connect_wait (int client_fd); +int start_server (int family,int type,const char *addr,__u16 port, +int timeout_ms); +int connect_to_fd (int server_fd,int timeout_ms); +int connect_fd_to_fd (int client_fd,int server_fd,int timeout_ms);#endif
tools/testing/selftests/bpf/prog_tests/cgroup_skb_sk_lookup.c +4 -8
@@ -13,7 +13,7 @@ static void run_lookup_test(__u16 *g_serv_port, int out_sk)socklen_t addr_len =sizeof (addr);__u32 duration =0 ; - serv_sk =start_server (AF_INET6 ,SOCK_STREAM ); + serv_sk =start_server (AF_INET6 ,SOCK_STREAM ,NULL ,0 ,0 );if (CHECK (serv_sk <0 ,"start_server" ,"failed to start server\n" ))return ;
@@ -24,17 +24,13 @@ static void run_lookup_test(__u16 *g_serv_port, int out_sk) *g_serv_port = addr.sin6_port;/* Client outside of test cgroup should fail to connect by timeout. */ - err =connect_fd_to_fd (out_sk, serv_sk); + err =connect_fd_to_fd (out_sk, serv_sk,1000 );if (CHECK (!err || errno !=EINPROGRESS ,"connect_fd_to_fd" ,"unexpected result err %d errno %d\n" , err, errno)) goto cleanup; - err =connect_wait (out_sk); -if (CHECK (err,"connect_wait" ,"unexpected result %d\n" , err)) - goto cleanup; -/* Client inside test cgroup should connect just fine. */ - in_sk =connect_to_fd (AF_INET6 ,SOCK_STREAM , serv_sk); + in_sk =connect_to_fd (serv_sk,0 );if (CHECK (in_sk <0 ,"connect_to_fd" ,"errno %d\n" , errno)) goto cleanup;
@@ -85,7 +81,7 @@ void test_cgroup_skb_sk_lookup(void)* differs from that of testing cgroup. Moving selftests process to * testing cgroup won't change cgroup id of an already created socket. */ - out_sk =socket (AF_INET6 ,SOCK_STREAM |SOCK_NONBLOCK ,0 ); + out_sk =socket (AF_INET6 ,SOCK_STREAM ,0 );if (CHECK_FAIL (out_sk <0 ))return ;
tools/testing/selftests/bpf/prog_tests/connect_force_port.c +5 -5
@@ -114,7 +114,7 @@ static int run_test(int cgroup_fd, int server_fd, int family, int type) goto close_bpf_object; } - fd =connect_to_fd (family, type, server_fd); + fd =connect_to_fd (server_fd,0 );if (fd <0 ) { err =-1 ; goto close_bpf_object;
@@ -137,25 +137,25 @@ void test_connect_force_port(void)if (CHECK_FAIL (cgroup_fd <0 ))return ; - server_fd =start_server_with_port (AF_INET ,SOCK_STREAM ,60123 ); + server_fd =start_server (AF_INET ,SOCK_STREAM ,NULL ,60123 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;CHECK_FAIL (run_test (cgroup_fd, server_fd,AF_INET ,SOCK_STREAM ));close (server_fd); - server_fd =start_server_with_port (AF_INET6 ,SOCK_STREAM ,60124 ); + server_fd =start_server (AF_INET6 ,SOCK_STREAM ,NULL ,60124 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;CHECK_FAIL (run_test (cgroup_fd, server_fd,AF_INET6 ,SOCK_STREAM ));close (server_fd); - server_fd =start_server_with_port (AF_INET ,SOCK_DGRAM ,60123 ); + server_fd =start_server (AF_INET ,SOCK_DGRAM ,NULL ,60123 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;CHECK_FAIL (run_test (cgroup_fd, server_fd,AF_INET ,SOCK_DGRAM ));close (server_fd); - server_fd =start_server_with_port (AF_INET6 ,SOCK_DGRAM ,60124 ); + server_fd =start_server (AF_INET6 ,SOCK_DGRAM ,NULL ,60124 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;CHECK_FAIL (run_test (cgroup_fd, server_fd,AF_INET6 ,SOCK_DGRAM ));
tools/testing/selftests/bpf/prog_tests/load_bytes_relative.c +2 -2
@@ -23,7 +23,7 @@ void test_load_bytes_relative(void)if (CHECK_FAIL (cgroup_fd <0 ))return ; - server_fd =start_server (AF_INET ,SOCK_STREAM ); + server_fd =start_server (AF_INET ,SOCK_STREAM ,NULL ,0 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;
@@ -49,7 +49,7 @@ void test_load_bytes_relative(void)if (CHECK_FAIL (err)) goto close_bpf_object; - client_fd =connect_to_fd (AF_INET ,SOCK_STREAM , server_fd); + client_fd =connect_to_fd (server_fd,0 );if (CHECK_FAIL (client_fd <0 )) goto close_bpf_object;close (client_fd);
tools/testing/selftests/bpf/prog_tests/tcp_rtt.c +2 -2
@@ -118,7 +118,7 @@ static int run_test(int cgroup_fd, int server_fd) goto close_bpf_object; } - client_fd =connect_to_fd (AF_INET ,SOCK_STREAM , server_fd); + client_fd =connect_to_fd (server_fd,0 );if (client_fd <0 ) { err =-1 ; goto close_bpf_object;
@@ -161,7 +161,7 @@ void test_tcp_rtt(void)if (CHECK_FAIL (cgroup_fd <0 ))return ; - server_fd =start_server (AF_INET ,SOCK_STREAM ); + server_fd =start_server (AF_INET ,SOCK_STREAM ,NULL ,0 ,0 );if (CHECK_FAIL (server_fd <0 )) goto close_cgroup_fd;
Signature · 1 line
2.24.1
PATCH v2 2/2 bpf: selftests: Restore netns after each test
In reply to Martin KaFai LauIt is common for networking tests creating its netns and making its own setting under this new netns (e.g. changing tcp sysctl). If the test forgot to restore to the original netns, it would affect the result of other tests.
This patch saves the original netns at the beginning and then restores it after every test. Since the restore "setns()" is not expensive, it does it on all tests without tracking if a test has created a new netns or not.
The new restore_netns() could also be done in test__end_subtest() such that each subtest will get an automatic netns reset. However, the individual test would lose flexibility to have total control on netns for its own subtests. In some cases, forcing a test to do unnecessary netns re-configure for each subtest is time consuming. e.g. In my vm, forcing netns re-configure on each subtest in sk_assign.c increased the runtime from 1s to 8s. On top of that, test_progs.c is also doing per-test (instead of per-subtest) cleanup for cgroup. Thus, this patch also does per-test restore_netns(). The only existing per-subtest cleanup is reset_affinity() and no test is depending on this. Thus, it is removed from test__end_subtest() to give a consistent expectation to the individual tests. test_progs.c only ensures any affinity/netns/cgroup change made by an earlier test does not affect the following tests.
--- tools/testing/selftests/bpf/test_progs.c | 23 +++++++++++++++++++++-- tools/testing/selftests/bpf/test_progs.h | 2 ++ 2 files changed, 23 insertions(+), 2 deletions(-)
tools/testing/selftests/bpf/test_progs.c +21 -2
@@ -121,6 +121,24 @@ static void reset_affinity() { } } +static void save_netns (void ) +{ + env.saved_netns_fd =open ("/proc/self/ns/net" ,O_RDONLY ); +if (env.saved_netns_fd ==-1 ) { +perror ("open(/proc/self/ns/net)" ); +exit (-1 ); + } +} + +static void restore_netns (void ) +{ +if (setns (env.saved_netns_fd,CLONE_NEWNET ) ==-1 ) { +stdio_restore (); +perror ("setns(CLONE_NEWNS)" ); +exit (-1 ); + } +} +void test__end_subtest () {struct prog_test_def *test = env.test;
@@ -138,8 +156,6 @@ void test__end_subtest() test->test_num, test->subtest_num, test->subtest_name, sub_error_cnt ? "FAIL" : "OK"); -reset_affinity (); -free (test->subtest_name); test->subtest_name =NULL ; }
@@ -643,6 +659,7 @@ int main(int argc, char **argv)return -1 ; } +save_netns ();stdio_hijack ();for (i =0 ; i < prog_test_cnt; i++) {struct prog_test_def *test = &prog_test_defs[i];
@@ -673,6 +690,7 @@ int main(int argc, char **argv) test->error_cnt ? "FAIL" : "OK");reset_affinity (); +restore_netns ();if (test->need_cgroup_cleanup)cleanup_cgroup_environment (); }
@@ -686,6 +704,7 @@ int main(int argc, char **argv)free_str_set (&env.subtest_selector.blacklist);free_str_set (&env.subtest_selector.whitelist);free (env.subtest_selector.num_set); +close (env.saved_netns_fd);return env.fail_cnt ?EXIT_FAILURE :EXIT_SUCCESS ; }
tools/testing/selftests/bpf/test_progs.h +2 -0
@@ -78,6 +78,8 @@ struct test_env {int sub_succ_cnt;/* successful sub-tests */ int fail_cnt;/* total failed tests + sub-tests */ int skip_cnt;/* skipped tests */ + +int saved_netns_fd; };extern struct test_env env;
Signature · 1 line
2.24.1
Quoted 14 lines · Martin KaFai Lau
This set is separated out from the bpf tcp header option series [1] since I think it is in general useful for other network related tests. e.g. enforce socket-fd related timeout and restore netns after each test.
[1]: https://lore.kernel.org/netdev/[email protected]/
v2:
- Mention non-NULL addr use case in commit message. (Yonghong)
- Add prefix "__" to variables used in macro. (Yonghong)Martin KaFai Lau (2):
bpf: selftests: A few improvements tonetwork_helpers.c
bpf: selftests: Restore netns after each test
Quoted 10 lines
tools/testing/selftests/bpf/network_helpers.c | 157 +++++++++++------- tools/testing/selftests/bpf/network_helpers.h | 9 +- .../bpf/prog_tests/cgroup_skb_sk_lookup.c | 12 +- .../bpf/prog_tests/connect_force_port.c | 10 +- .../bpf/prog_tests/load_bytes_relative.c | 4 +- .../selftests/bpf/prog_tests/tcp_rtt.c | 4 +- tools/testing/selftests/bpf/test_progs.c | 23 ++- tools/testing/selftests/bpf/test_progs.h | 2 + 8 files changed, 133 insertions(+), 88 deletions(-)
Applied, thanks!