feat: Add an option to wait for events in tox_iterate.

Author: iphydf

.clang-tidy

@@ -42,7 +42,7 @@ CheckOptions:
   - key:             concurrency-mt-unsafe.FunctionSet
     value:           posix
   - key:             readability-function-cognitive-complexity.Threshold
-    value:           159  # TODO(iphydf): Decrease. tox_new_system is the highest at the moment.
+    value:           167  # TODO(iphydf): Decrease. tox_new_system is the highest at the moment.
   - key:             cppcoreguidelines-avoid-do-while.IgnoreMacros
     value:           true
   - key:             readability-simplify-boolean-expr.SimplifyDeMorgan

.github/workflows/docker.yml

@@ -138,7 +138,7 @@ jobs:
       - name: Build and store to local Docker daemon
         uses: docker/build-push-action@v5
         with:
-          context: other/docker/windows
+          file: other/docker/windows/windows.Dockerfile
           load: true
           tags: toxchat/windows:win${{ matrix.bits }}
           cache-from: type=registry,ref=toxchat/windows:win${{ matrix.bits }}
@@ -150,7 +150,7 @@ jobs:
         if: ${{ github.event_name == 'push' }}
         uses: docker/build-push-action@v5
         with:
-          context: other/docker/windows
+          file: other/docker/windows/windows.Dockerfile
           push: ${{ github.event_name == 'push' }}
           tags: toxchat/windows:win${{ matrix.bits }}
           build-args: |

CMakeLists.txt

@@ -29,7 +29,8 @@ endif()
 
 set_source_files_properties(
   toxcore/mono_time.c
-  toxcore/network.c
+  toxcore/os_event.c
+  toxcore/os_network.c
   toxcore/tox.c
   toxcore/util.c
   PROPERTIES SKIP_UNITY_BUILD_INCLUSION TRUE)
@@ -233,6 +234,8 @@ set(toxcore_SOURCES
   toxcore/crypto_core_pack.h
   toxcore/DHT.c
   toxcore/DHT.h
+  toxcore/ev.c
+  toxcore/ev.h
   toxcore/events/conference_connected.c
   toxcore/events/conference_invite.c
   toxcore/events/conference_message.c
@@ -324,6 +327,8 @@ set(toxcore_SOURCES
   toxcore/onion_client.c
   toxcore/onion_client.h
   toxcore/onion.h
+  toxcore/os_event.c
+  toxcore/os_event.h
   toxcore/os_memory.c
   toxcore/os_memory.h
   toxcore/os_network.c
@@ -571,6 +576,9 @@ function(unit_test subdir target)
   elseif(TARGET Threads::Threads)
     target_link_libraries(unit_${target}_test PRIVATE Threads::Threads)
   endif()
+  if(WIN32)
+    target_link_libraries(unit_${target}_test PRIVATE ws2_32)
+  endif()
   target_link_libraries(unit_${target}_test PRIVATE GTest::gtest GTest::gtest_main GTest::gmock)
   set_target_properties(unit_${target}_test PROPERTIES COMPILE_FLAGS "${TEST_CXX_FLAGS}")
   add_test(NAME ${target} COMMAND unit_${target}_test)
@@ -604,6 +612,7 @@ if(UNITTEST AND TARGET GTest::gtest AND TARGET GTest::gmock)
   unit_test(toxcore DHT)
   unit_test(toxcore bin_pack)
   unit_test(toxcore crypto_core)
+  unit_test(toxcore ev)
   unit_test(toxcore group_announce)
   unit_test(toxcore group_moderation)
   unit_test(toxcore list)

INSTALL.md

@@ -286,7 +286,7 @@ requirements are that you have Docker version of >= 1.9.0 and you are running
 64-bit system.
 
 The cross-compilation is fully automated by a parameterized
-[Dockerfile](/other/docker/windows/Dockerfile).
+[Dockerfile](/other/docker/windows/windows.Dockerfile).
 
 Install Docker
 
@@ -313,10 +313,10 @@ available to customize the building of the container image.
 Example of building a container image with options
 
 ```sh
-cd other/docker/windows
 docker build \
   --build-arg SUPPORT_TEST=true \
   -t toxcore \
+  -f other/docker/windows/windows.Dockerfile \
   .
 ```
 

auto_tests/BUILD.bazel

@@ -17,8 +17,11 @@ cc_library(
         "//c-toxcore/testing:misc_tools",
         "//c-toxcore/toxcore:DHT",
         "//c-toxcore/toxcore:Messenger",
+        "//c-toxcore/toxcore:ev",
         "//c-toxcore/toxcore:mono_time",
         "//c-toxcore/toxcore:net_crypto",
+        "//c-toxcore/toxcore:network",
+        "//c-toxcore/toxcore:os_event",
         "//c-toxcore/toxcore:tox",
         "//c-toxcore/toxcore:tox_dispatch",
         "//c-toxcore/toxcore:tox_events",
@@ -66,6 +69,7 @@ extra_data = {
         "//c-toxcore/toxcore:announce",
         "//c-toxcore/toxcore:ccompat",
         "//c-toxcore/toxcore:crypto_core",
+        "//c-toxcore/toxcore:ev",
         "//c-toxcore/toxcore:forwarding",
         "//c-toxcore/toxcore:friend_connection",
         "//c-toxcore/toxcore:logger",
@@ -76,6 +80,7 @@ extra_data = {
         "//c-toxcore/toxcore:onion",
         "//c-toxcore/toxcore:onion_announce",
         "//c-toxcore/toxcore:onion_client",
+        "//c-toxcore/toxcore:os_event",
         "//c-toxcore/toxcore:os_memory",
         "//c-toxcore/toxcore:os_random",
         "//c-toxcore/toxcore:tox",

auto_tests/TCP_test.c

@@ -2,7 +2,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include "../testing/misc_tools.h"
+#include "../toxcore/os_event.h"
 #include "../toxcore/TCP_client.h"
 #include "../toxcore/TCP_common.h"
 #include "../toxcore/TCP_server.h"
@@ -59,11 +59,14 @@ static void test_basic(void)
     Logger *logger = logger_new(mem);
     logger_callback_log(logger, print_debug_logger, nullptr, nullptr);
 
+    Ev *ev = os_event_new(mem, logger);
+    ck_assert(ev != nullptr);
+
     // Attempt to create a new TCP_Server instance.
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE];
     uint8_t self_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
+    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, ev, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
     ck_assert_msg(tcp_s != nullptr, "Failed to create a TCP relay server.");
     ck_assert_msg(tcp_server_listen_count(tcp_s) == NUM_PORTS,
                   "Failed to bind a TCP relay server to all %d attempted ports.", NUM_PORTS);
@@ -196,6 +199,7 @@ static void test_basic(void)
     // Closing connections.
     kill_sock(ns, sock);
     kill_tcp_server(tcp_s);
+    ev_kill(ev);
 
     logger_kill(logger);
     mono_time_free(mem, mono_time);
@@ -325,10 +329,13 @@ static void test_some(void)
     Mono_Time *mono_time = mono_time_new(mem, nullptr, nullptr);
     Logger *logger = logger_new(mem);
 
+    Ev *ev = os_event_new(mem, logger);
+    ck_assert(ev != nullptr);
+
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE];
     uint8_t self_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
+    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, ev, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
     ck_assert_msg(tcp_s != nullptr, "Failed to create TCP relay server");
     ck_assert_msg(tcp_server_listen_count(tcp_s) == NUM_PORTS, "Failed to bind to all ports.");
 
@@ -422,6 +429,7 @@ static void test_some(void)
 
     // Kill off the connections
     kill_tcp_server(tcp_s);
+    ev_kill(ev);
     kill_tcp_con(con1);
     kill_tcp_con(con2);
     kill_tcp_con(con3);
@@ -522,11 +530,12 @@ static void test_client(void)
 
     Logger *logger = logger_new(mem);
     Mono_Time *mono_time = mono_time_new(mem, nullptr, nullptr);
+    Ev *ev = os_event_new(mem, logger);
 
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE];
     uint8_t self_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
+    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, ev, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
     ck_assert_msg(tcp_s != nullptr, "Failed to create a TCP relay server.");
     ck_assert_msg(tcp_server_listen_count(tcp_s) == NUM_PORTS, "Failed to bind the relay server to all ports.");
 
@@ -538,7 +547,7 @@ static void test_client(void)
     ip_port_tcp_s.port = net_htons(ports[random_u32(rng) % NUM_PORTS]);
     ip_port_tcp_s.ip = get_loopback();
 
-    TCP_Client_Connection *conn = new_tcp_connection(logger, mem, mono_time, rng, ns, &ip_port_tcp_s, self_public_key, f_public_key, f_secret_key, nullptr, nullptr);
+    TCP_Client_Connection *conn = new_tcp_connection(logger, mem, mono_time, rng, ns, ev, &ip_port_tcp_s, self_public_key, f_public_key, f_secret_key, nullptr, nullptr);
     ck_assert_msg(conn != nullptr, "Failed to create a TCP client connection.");
     // TCP sockets might need a moment before they can be written to.
     c_sleep(50);
@@ -574,7 +583,7 @@ static void test_client(void)
     uint8_t f2_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, f2_public_key, f2_secret_key);
     ip_port_tcp_s.port = net_htons(ports[random_u32(rng) % NUM_PORTS]);
-    TCP_Client_Connection *conn2 = new_tcp_connection(logger, mem, mono_time, rng, ns, &ip_port_tcp_s, self_public_key, f2_public_key,
+    TCP_Client_Connection *conn2 = new_tcp_connection(logger, mem, mono_time, rng, ns, ev, &ip_port_tcp_s, self_public_key, f2_public_key,
                                    f2_secret_key, nullptr, nullptr);
     ck_assert_msg(conn2 != nullptr, "Failed to create a second TCP client connection.");
     c_sleep(50);
@@ -645,6 +654,7 @@ static void test_client(void)
     kill_tcp_connection(conn2);
 
     logger_kill(logger);
+    ev_kill(ev);
     mono_time_free(mem, mono_time);
 }
 
@@ -672,7 +682,8 @@ static void test_client_invalid(void)
 
     ip_port_tcp_s.port = net_htons(ports[random_u32(rng) % NUM_PORTS]);
     ip_port_tcp_s.ip = get_loopback();
-    TCP_Client_Connection *conn = new_tcp_connection(logger, mem, mono_time, rng, ns, &ip_port_tcp_s,
+    Ev *ev = os_event_new(mem, logger);
+    TCP_Client_Connection *conn = new_tcp_connection(logger, mem, mono_time, rng, ns, ev, &ip_port_tcp_s,
                                   self_public_key, f_public_key, f_secret_key, nullptr, nullptr);
     ck_assert_msg(conn != nullptr, "Failed to create a TCP client connection.");
 
@@ -700,6 +711,7 @@ static void test_client_invalid(void)
     kill_tcp_connection(conn);
 
     logger_kill(logger);
+    ev_kill(ev);
     mono_time_free(mem, mono_time);
 }
 
@@ -747,18 +759,22 @@ static void test_tcp_connection(void)
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE];
     uint8_t self_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
+
+    Ev *ev = os_event_new(mem, logger);
+    ck_assert(ev != nullptr);
+
+    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, ev, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
     ck_assert_msg(pk_equal(tcp_server_public_key(tcp_s), self_public_key), "Wrong public key");
 
     TCP_Proxy_Info proxy_info;
     proxy_info.proxy_type = TCP_PROXY_NONE;
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Connections *tc_1 = new_tcp_connections(logger, mem, rng, ns, mono_time, self_secret_key, &proxy_info, tcp_np);
+    TCP_Connections *tc_1 = new_tcp_connections(logger, mem, rng, ns, mono_time, ev, self_secret_key, &proxy_info, tcp_np);
     ck_assert_msg(tc_1 != nullptr, "Failed to create TCP connections");
     ck_assert_msg(pk_equal(tcp_connections_public_key(tc_1), self_public_key), "Wrong public key");
 
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Connections *tc_2 = new_tcp_connections(logger, mem, rng, ns, mono_time, self_secret_key, &proxy_info, tcp_np);
+    TCP_Connections *tc_2 = new_tcp_connections(logger, mem, rng, ns, mono_time, ev, self_secret_key, &proxy_info, tcp_np);
     ck_assert_msg(tc_2 != nullptr, "Failed to create TCP connections");
     ck_assert_msg(pk_equal(tcp_connections_public_key(tc_2), self_public_key), "Wrong public key");
 
@@ -824,6 +840,7 @@ static void test_tcp_connection(void)
     netprof_kill(mem, tcp_np);
 
     logger_kill(logger);
+    ev_kill(ev);
     mono_time_free(mem, mono_time);
 }
 
@@ -869,18 +886,22 @@ static void test_tcp_connection2(void)
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE];
     uint8_t self_secret_key[CRYPTO_SECRET_KEY_SIZE];
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
+
+    Ev *ev = os_event_new(mem, logger);
+    ck_assert(ev != nullptr);
+
+    TCP_Server *tcp_s = new_tcp_server(logger, mem, rng, ns, ev, USE_IPV6, NUM_PORTS, ports, self_secret_key, nullptr, nullptr);
     ck_assert_msg(pk_equal(tcp_server_public_key(tcp_s), self_public_key), "Wrong public key");
 
     TCP_Proxy_Info proxy_info;
     proxy_info.proxy_type = TCP_PROXY_NONE;
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Connections *tc_1 = new_tcp_connections(logger, mem, rng, ns, mono_time, self_secret_key, &proxy_info, tcp_np);
+    TCP_Connections *tc_1 = new_tcp_connections(logger, mem, rng, ns, mono_time, ev, self_secret_key, &proxy_info, tcp_np);
     ck_assert_msg(tc_1 != nullptr, "Failed to create TCP connections");
     ck_assert_msg(pk_equal(tcp_connections_public_key(tc_1), self_public_key), "Wrong public key");
 
     crypto_new_keypair(rng, self_public_key, self_secret_key);
-    TCP_Connections *tc_2 = new_tcp_connections(logger, mem, rng, ns, mono_time, self_secret_key, &proxy_info, tcp_np);
+    TCP_Connections *tc_2 = new_tcp_connections(logger, mem, rng, ns, mono_time, ev, self_secret_key, &proxy_info, tcp_np);
     ck_assert_msg(tc_2 != nullptr, "Failed to create TCP connections");
     ck_assert_msg(pk_equal(tcp_connections_public_key(tc_2), self_public_key), "Wrong public key");
 
@@ -939,6 +960,7 @@ static void test_tcp_connection2(void)
     kill_tcp_connections(tc_2);
 
     logger_kill(logger);
+    ev_kill(ev);
     mono_time_free(mem, mono_time);
 }
 

auto_tests/announce_test.c

@@ -6,6 +6,7 @@
 #include "../toxcore/forwarding.h"
 #include "../toxcore/os_memory.h"
 #include "../toxcore/os_random.h"
+#include "../toxcore/os_event.h"
 #include "auto_test_support.h"
 #include "check_compat.h"
 
@@ -60,7 +61,9 @@ static void test_store_data(void)
     logger_callback_log(log, print_debug_logger, nullptr, nullptr);
     Mono_Time *mono_time = mono_time_new(mem, nullptr, nullptr);
     ck_assert(mono_time != nullptr);
-    Networking_Core *net = new_networking_no_udp(log, mem, ns);
+    Ev *ev = os_event_new(mem, log);
+    ck_assert(ev != nullptr);
+    Networking_Core *net = new_networking_no_udp(log, mem, ns, ev);
     ck_assert(net != nullptr);
     DHT *dht = new_dht(log, mem, rng, ns, mono_time, net, true, true);
     ck_assert(dht != nullptr);
@@ -108,6 +111,7 @@ static void test_store_data(void)
     kill_forwarding(forwarding);
     kill_dht(dht);
     kill_networking(net);
+    ev_kill(ev);
     mono_time_free(mem, mono_time);
     logger_kill(log);
 }

auto_tests/forwarding_test.c

@@ -10,6 +10,7 @@
 #include "../toxcore/net_crypto.h"
 #include "../toxcore/os_memory.h"
 #include "../toxcore/os_random.h"
+#include "../toxcore/os_event.h"
 #include "auto_test_support.h"
 #include "check_compat.h"
 
@@ -96,6 +97,7 @@ static bool all_returned(Test_Data *test_data)
 typedef struct Forwarding_Subtox {
     Logger *log;
     Mono_Time *mono_time;
+    Ev *ev;
     Networking_Core *net;
     Net_Profile *tcp_np;
     DHT *dht;
@@ -118,12 +120,13 @@ static Forwarding_Subtox *new_forwarding_subtox(const Memory *mem, bool no_udp,
     ck_assert(subtox->log != nullptr);
     logger_callback_log(subtox->log, print_debug_logger, nullptr, index);
     subtox->mono_time = mono_time_new(mem, nullptr, nullptr);
+    subtox->ev = os_event_new(mem, subtox->log);
 
     if (no_udp) {
-        subtox->net = new_networking_no_udp(subtox->log, mem, ns);
+        subtox->net = new_networking_no_udp(subtox->log, mem, ns, subtox->ev);
     } else {
         const IP ip = get_loopback();
-        subtox->net = new_networking_ex(subtox->log, mem, ns, &ip, port, port, nullptr);
+        subtox->net = new_networking_ex(subtox->log, mem, ns, subtox->ev, &ip, port, port, nullptr);
     }
 
     subtox->dht = new_dht(subtox->log, mem, rng, ns, subtox->mono_time, subtox->net, true, true);
@@ -132,7 +135,7 @@ static Forwarding_Subtox *new_forwarding_subtox(const Memory *mem, bool no_udp,
     ck_assert(subtox->tcp_np != nullptr);
 
     const TCP_Proxy_Info inf = {{{{0}}}};
-    subtox->c = new_net_crypto(subtox->log, mem, rng, ns, subtox->mono_time, subtox->net, subtox->dht, &auto_test_dht_funcs, &inf, subtox->tcp_np);
+    subtox->c = new_net_crypto(subtox->log, mem, rng, ns, subtox->mono_time, subtox->ev, subtox->net, subtox->dht, &auto_test_dht_funcs, &inf, subtox->tcp_np);
 
     subtox->forwarding = new_forwarding(subtox->log, mem, rng, subtox->mono_time, subtox->dht, subtox->net);
     ck_assert(subtox->forwarding != nullptr);
@@ -151,6 +154,7 @@ static void kill_forwarding_subtox(const Memory *mem, Forwarding_Subtox *subtox)
     netprof_kill(mem, subtox->tcp_np);
     kill_dht(subtox->dht);
     kill_networking(subtox->net);
+    ev_kill(subtox->ev);
     mono_time_free(mem, subtox->mono_time);
     logger_kill(subtox->log);
     free(subtox);