feat: Add back the tox_loop implementation for low latency.

Copied code from #335.

CMakeLists.txt

@@ -437,6 +437,7 @@ auto_test(send_message)
 auto_test(set_name)
 auto_test(set_status_message)
 auto_test(skeleton)
+auto_test(tox_loop)
 auto_test(tox_many)
 auto_test(tox_many_tcp)
 auto_test(tox_one)

auto_tests/tox_loop_test.c

@@ -0,0 +1,104 @@
+#include <pthread.h>
+#include <stdlib.h>
+#include <time.h>
+#include <unistd.h>
+
+#include "../toxcore/tox.h"
+
+#include "check_compat.h"
+
+#define TCP_RELAY_PORT 33448
+/* The Travis-CI container responds poorly to ::1 as a localhost address
+ * You're encouraged to -D FORCE_TESTS_IPV6 on a local test  */
+#ifdef FORCE_TESTS_IPV6
+#define TOX_LOCALHOST "::1"
+#else
+#define TOX_LOCALHOST "127.0.0.1"
+#endif
+
+typedef struct {
+    int start_count, stop_count;
+    pthread_mutex_t mutex;
+    Tox *tox;
+} loop_test;
+
+static void tox_loop_cb_start(Tox *tox, void *user_data)
+{
+    loop_test *userdata = (loop_test *) user_data;
+    pthread_mutex_lock(&userdata->mutex);
+    userdata->start_count++;
+}
+
+static void tox_loop_cb_stop(Tox *tox, void *user_data)
+{
+    loop_test *userdata = (loop_test *) user_data;
+    userdata->stop_count++;
+    pthread_mutex_unlock(&userdata->mutex);
+}
+
+static void *tox_loop_worker(void *data)
+{
+    loop_test *userdata = (loop_test *) data;
+    tox_loop(userdata->tox, data, NULL);
+    return NULL;
+}
+
+static void test_tox_loop(void)
+{
+    pthread_t worker, worker_tcp;
+    struct Tox_Options *opts = tox_options_new(NULL);
+    loop_test userdata;
+    uint8_t dpk[TOX_PUBLIC_KEY_SIZE];
+    int retval;
+
+    userdata.start_count = 0;
+    userdata.stop_count = 0;
+    pthread_mutex_init(&userdata.mutex, NULL);
+
+    tox_options_set_tcp_port(opts, TCP_RELAY_PORT);
+    userdata.tox = tox_new(opts, NULL);
+    tox_callback_loop_begin(userdata.tox, tox_loop_cb_start);
+    tox_callback_loop_end(userdata.tox, tox_loop_cb_stop);
+    pthread_create(&worker, NULL, tox_loop_worker, &userdata);
+
+    tox_self_get_dht_id(userdata.tox, dpk);
+
+    tox_options_default(opts);
+    loop_test userdata_tcp;
+    userdata_tcp.start_count = 0;
+    userdata_tcp.stop_count = 0;
+    pthread_mutex_init(&userdata_tcp.mutex, NULL);
+    userdata_tcp.tox = tox_new(opts, NULL);
+    tox_callback_loop_begin(userdata_tcp.tox, tox_loop_cb_start);
+    tox_callback_loop_end(userdata_tcp.tox, tox_loop_cb_stop);
+    pthread_create(&worker_tcp, NULL, tox_loop_worker, &userdata_tcp);
+
+    pthread_mutex_lock(&userdata_tcp.mutex);
+    TOX_ERR_BOOTSTRAP error;
+    ck_assert_msg(tox_add_tcp_relay(userdata_tcp.tox, TOX_LOCALHOST, TCP_RELAY_PORT, dpk, &error), "Add relay error, %i",
+                  error);
+    ck_assert_msg(tox_bootstrap(userdata_tcp.tox, TOX_LOCALHOST, 33445, dpk, &error), "Bootstrap error, %i", error);
+    pthread_mutex_unlock(&userdata_tcp.mutex);
+
+    sleep(10);
+
+    tox_loop_stop(userdata.tox);
+    pthread_join(worker, (void **)(void *)&retval);
+    ck_assert_msg(retval == 0, "tox_loop didn't return 0");
+
+    tox_kill(userdata.tox);
+    ck_assert_msg(userdata.start_count == userdata.stop_count, "start and stop must match");
+
+    tox_loop_stop(userdata_tcp.tox);
+    pthread_join(worker_tcp, (void **)(void *)&retval);
+    ck_assert_msg(retval == 0, "tox_loop didn't return 0");
+
+    tox_kill(userdata_tcp.tox);
+    ck_assert_msg(userdata_tcp.start_count == userdata_tcp.stop_count, "start and stop must match");
+}
+
+int main(int argc, char *argv[])
+{
+    test_tox_loop();
+    return 0;
+}

toxcore/Messenger.c

@@ -1892,6 +1892,29 @@ Messenger *new_messenger(Mono_Time *mono_time, Messenger_Options *options, unsig
         return nullptr;
     }
 
+
+#ifdef HAVE_LIBEV
+    m->dispatcher = ev_loop_new(0);
+#elif defined(HAVE_LIBEVENT)
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__)
+    evthread_use_windows_threads();
+#else
+    evthread_use_pthreads();
+#endif /* WIN32 || _WIN32 || __WIN32__ */
+    m->dispatcher = event_base_new();
+#else
+    m->loop_run = false;
+#endif /* HAVE_LIBEV */
+
+#if defined(HAVE_LIBEV) || defined(HAVE_LIBEVENT)
+
+    if (!m->dispatcher) {
+        free(m);
+        return NULL;
+    }
+
+#endif /* HAVE_LIBEV || HAVE_LIBEVENT */
+
     m->mono_time = mono_time;
 
     m->fr = friendreq_new();
@@ -2044,6 +2067,12 @@ void kill_messenger(Messenger *m)
         clear_receipts(m, i);
     }
 
+#ifdef HAVE_LIBEV
+    ev_loop_destroy(m->dispatcher);
+#elif defined(HAVE_LIBEVENT)
+    event_base_free(m->dispatcher);
+#endif
+
     logger_kill(m->log);
     free(m->friendlist);
     friendreq_kill(m->fr);

toxcore/Messenger.h

@@ -16,6 +16,13 @@
 #include "net_crypto.h"
 #include "state.h"
 
+#ifdef HAVE_LIBEV
+#include <ev.h>
+#elif defined(HAVE_LIBEVENT)
+#include <event2/event.h>
+#include <event2/thread.h>
+#endif
+
 #define MAX_NAME_LENGTH 128
 /* TODO(irungentoo): this must depend on other variable. */
 #define MAX_STATUSMESSAGE_LENGTH 1007
@@ -291,6 +298,15 @@ struct Messenger {
     m_self_connection_status_cb *core_connection_change;
     unsigned int last_connection_status;
 
+#ifdef HAVE_LIBEV
+    struct ev_loop *dispatcher;
+    ev_async stop_loop;
+#elif defined(HAVE_LIBEVENT)
+    struct event_base *dispatcher;
+#else
+    bool loop_run;
+#endif
+
     Messenger_Options options;
 };
 

toxcore/TCP_client.c

@@ -12,6 +12,12 @@
 #include <stdlib.h>
 #include <string.h>
 
+#ifdef HAVE_LIBEV
+#include <ev.h>
+#elif defined(HAVE_LIBEVENT)
+#include <event2/event.h>
+#endif
+
 #include "mono_time.h"
 #include "util.h"
 
@@ -25,6 +31,14 @@ typedef struct TCP_Client_Conn {
 struct TCP_Client_Connection {
     TCP_Client_Status status;
     Socket sock;
+#ifdef HAVE_LIBEV
+    struct {
+        ev_io listener;
+        struct ev_loop *dispatcher;
+    } sock_listener;
+#elif defined(HAVE_LIBEVENT)
+    struct event *sock_listener;
+#endif
     uint8_t self_public_key[CRYPTO_PUBLIC_KEY_SIZE]; /* our public key */
     uint8_t public_key[CRYPTO_PUBLIC_KEY_SIZE]; /* public key of the server */
     IP_Port ip_port; /* The ip and port of the server */
@@ -79,6 +93,11 @@ IP_Port tcp_con_ip_port(const TCP_Client_Connection *con)
     return con->ip_port;
 }
 
+Socket tcp_con_sock(const TCP_Client_Connection *con)
+{
+    return con->sock;
+}
+
 TCP_Client_Status tcp_con_status(const TCP_Client_Connection *con)
 {
     return con->status;
@@ -1052,6 +1071,17 @@ void kill_TCP_connection(TCP_Client_Connection *tcp_connection)
 
     wipe_priority_list(tcp_connection->priority_queue_start);
     kill_sock(tcp_connection->sock);
+
+#ifdef HAVE_LIBEV
+    ev_io_stop(TCP_connection->sock_listener.dispatcher, &TCP_connection->sock_listener.listener);
+#elif defined(HAVE_LIBEVENT)
+
+    if (TCP_connection->sock_listener) {
+        event_free(TCP_connection->sock_listener);
+    }
+
+#endif
+
     crypto_memzero(tcp_connection, sizeof(TCP_Client_Connection));
     free(tcp_connection);
 }

toxcore/TCP_client.h

@@ -40,6 +40,7 @@ typedef struct TCP_Client_Connection TCP_Client_Connection;
 
 const uint8_t *tcp_con_public_key(const TCP_Client_Connection *con);
 IP_Port tcp_con_ip_port(const TCP_Client_Connection *con);
+Socket tcp_con_sock(const TCP_Client_Connection *con);
 TCP_Client_Status tcp_con_status(const TCP_Client_Connection *con);
 
 void *tcp_con_custom_object(const TCP_Client_Connection *con);

toxcore/TCP_connection.c

@@ -56,6 +56,38 @@ uint32_t tcp_connections_count(const TCP_Connections *tcp_c)
     return tcp_c->tcp_connections_length;
 }
 
+
+/**
+ * Return number of elements of TCP connection array.
+ *
+ * @param tcp_c struct containing TCP_con array
+ *
+ * @return number of elements of TCP connection array
+ */
+uint32_t tcp_connections_length(const TCP_Connections *tcp_c)
+{
+    return tcp_c->tcp_connections_length;
+}
+
+
+/**
+ * Return TCP connection stored at "idx" position.
+ *
+ * @param tcp_c struct containing TCP_con array
+ * @param idx   index of TCP connection to return (values from 0 to tcp_connections_length() - 1)
+ *
+ * @return TCP connection stored at "idx" position, or NULL if errors occurred
+ */
+const TCP_con *tcp_connections_connection_at(const TCP_Connections *tcp_c, uint32_t idx)
+{
+    if (idx >= tcp_c->tcp_connections_length) {
+        return NULL;
+    }
+
+    return &tcp_c->tcp_connections[idx];
+}
+
+
 /** Set the size of the array to num.
  *
  *  return -1 if realloc fails.

toxcore/TCP_connection.h

@@ -70,6 +70,10 @@ typedef struct TCP_Connections TCP_Connections;
 
 const uint8_t *tcp_connections_public_key(const TCP_Connections *tcp_c);
 
+uint32_t tcp_connections_length(const TCP_Connections *tcp_c);
+
+const TCP_con *tcp_connections_connection_at(const TCP_Connections *tcp_c, uint32_t idx);
+
 uint32_t tcp_connections_count(const TCP_Connections *tcp_c);
 
 /** Returns the number of connected TCP relays */

toxcore/network.c

@@ -86,6 +86,12 @@
 #include <stdlib.h>
 #include <string.h>
 
+#ifdef HAVE_LIBEV
+#include <ev.h>
+#elif defined(HAVE_LIBEVENT)
+#include <event2/event.h>
+#endif
+
 #ifndef VANILLA_NACL
 // Used for sodium_init()
 #include <sodium.h>
@@ -490,6 +496,14 @@ struct Networking_Core {
     uint16_t port;
     /* Our UDP socket. */
     Socket sock;
+#ifdef HAVE_LIBEV
+    struct {
+        ev_io listener;
+        struct ev_loop *dispatcher;
+    } sock_listener;
+#elif defined(HAVE_LIBEVENT)
+    struct event *sock_listener;
+#endif
 };
 
 Family net_family(const Networking_Core *net)
@@ -502,6 +516,11 @@ uint16_t net_port(const Networking_Core *net)
     return net->port;
 }
 
+Socket net_sock(const Networking_Core *net)
+{
+    return net->sock;
+}
+
 /* Basic network functions:
  */
 
@@ -1003,6 +1022,17 @@ void kill_networking(Networking_Core *net)
         kill_sock(net->sock);
     }
 
+
+#ifdef HAVE_LIBEV
+    ev_io_stop(net->sock_listener.dispatcher, &net->sock_listener.listener);
+#elif defined(HAVE_LIBEVENT)
+
+    if (net->sock_listener) {
+        event_free(net->sock_listener);
+    }
+
+#endif
+
     free(net);
 }
 

toxcore/network.h

@@ -322,6 +322,7 @@ typedef struct Networking_Core Networking_Core;
 
 Family net_family(const Networking_Core *net);
 uint16_t net_port(const Networking_Core *net);
+Socket net_sock(const Networking_Core *net);
 
 /** Run this before creating sockets.
  *