fixes #3118 (Update toxcore to 0.2.18)

1 files changed, 112 insertions, 31 deletions

diff --git a/protocols/Tox/libtox/src/toxcore/TCP_connection.h b/protocols/Tox/libtox/src/toxcore/TCP_connection.h
index 84890b98d7..65ead4d87f 100644
--- a/protocols/Tox/libtox/src/toxcore/TCP_connection.h
+++ b/protocols/Tox/libtox/src/toxcore/TCP_connection.h
@@ -9,12 +9,12 @@
 #ifndef C_TOXCORE_TOXCORE_TCP_CONNECTION_H
 #define C_TOXCORE_TOXCORE_TCP_CONNECTION_H
 
+#include <stdbool.h>
+
 #include "DHT.h"  // for Node_format
 #include "TCP_client.h"
 #include "TCP_common.h"
 
-#include <stdbool.h>
-
 #define TCP_CONN_NONE 0
 #define TCP_CONN_VALID 1
 
@@ -33,8 +33,9 @@
 /** Time until connection to friend gets killed (if it doesn't get locked within that time) */
 #define TCP_CONNECTION_ANNOUNCE_TIMEOUT TCP_CONNECTION_TIMEOUT
 
-/** The amount of recommended connections for each friend
- * NOTE: Must be at most (MAX_FRIEND_TCP_CONNECTIONS / 2) */
+/** @brief The amount of recommended connections for each friend
+ * NOTE: Must be at most (MAX_FRIEND_TCP_CONNECTIONS / 2)
+ */
 #define RECOMMENDED_FRIEND_TCP_CONNECTIONS (MAX_FRIEND_TCP_CONNECTIONS / 2)
 
 /** Number of TCP connections used for onion purposes. */
@@ -71,22 +72,26 @@ typedef struct TCP_con {
 
 typedef struct TCP_Connections TCP_Connections;
 
+non_null()
 const uint8_t *tcp_connections_public_key(const TCP_Connections *tcp_c);
 
+non_null()
 uint32_t tcp_connections_count(const TCP_Connections *tcp_c);
 
 /** Returns the number of connected TCP relays */
+non_null()
 uint32_t tcp_connected_relays_count(const TCP_Connections *tcp_c);
 
-/** Send a packet to the TCP connection.
+/** @brief Send a packet to the TCP connection.
  *
  * return -1 on failure.
  * return 0 on success.
  */
+non_null()
 int send_packet_tcp_connection(const TCP_Connections *tcp_c, int connections_number, const uint8_t *packet,
                                uint16_t length);
 
-/** Return a random TCP connection number for use in send_tcp_onion_request.
+/** @brief Return a TCP connection number for use in send_tcp_onion_request.
  *
  * TODO(irungentoo): This number is just the index of an array that the elements
  * can change without warning.
@@ -94,72 +99,123 @@ int send_packet_tcp_connection(const TCP_Connections *tcp_c, int connections_num
  * return TCP connection number on success.
  * return -1 on failure.
  */
+non_null()
 int get_random_tcp_onion_conn_number(const TCP_Connections *tcp_c);
 
-/** Send an onion packet via the TCP relay corresponding to tcp_connections_number.
+/** @brief Put IP_Port of a random onion TCP connection in ip_port.
+ *
+ * return true on success.
+ * return false on failure.
+ */
+non_null()
+bool tcp_get_random_conn_ip_port(const TCP_Connections *tcp_c, IP_Port *ip_port);
+
+/** @brief Send an onion packet via the TCP relay corresponding to tcp_connections_number.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int tcp_send_onion_request(TCP_Connections *tcp_c, unsigned int tcp_connections_number, const uint8_t *data,
                            uint16_t length);
 
-/** Set if we want TCP_connection to allocate some connection for onion use.
+/** @brief Set if we want TCP_connection to allocate some connection for onion use.
  *
  * If status is 1, allocate some connections. if status is 0, don't.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int set_tcp_onion_status(TCP_Connections *tcp_c, bool status);
 
-/** Send an oob packet via the TCP relay corresponding to tcp_connections_number.
+/**
+ * Send a forward request to the TCP relay with IP_Port tcp_forwarder,
+ * requesting to forward data via a chain of dht nodes starting with dht_node.
+ * A chain_length of 0 means that dht_node is the final destination of data.
+ *
+ * return 0 on success.
+ * return -1 on failure.
+ */
+non_null()
+int tcp_send_forward_request(const Logger *logger, TCP_Connections *tcp_c, const IP_Port *tcp_forwarder,
+                             const IP_Port *dht_node,
+                             const uint8_t *chain_keys, uint16_t chain_length,
+                             const uint8_t *data, uint16_t data_length);
+
+/** @brief Send an oob packet via the TCP relay corresponding to tcp_connections_number.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int tcp_send_oob_packet(const TCP_Connections *tcp_c, unsigned int tcp_connections_number, const uint8_t *public_key,
                         const uint8_t *packet, uint16_t length);
 
 typedef int tcp_data_cb(void *object, int id, const uint8_t *data, uint16_t length, void *userdata);
 
+non_null()
 int tcp_send_oob_packet_using_relay(const TCP_Connections *tcp_c, const uint8_t *relay_pk, const uint8_t *public_key,
                                     const uint8_t *packet, uint16_t length);
 
-/** Set the callback for TCP data packets.
- */
+/** @brief Set the callback for TCP data packets. */
+non_null()
 void set_packet_tcp_connection_callback(TCP_Connections *tcp_c, tcp_data_cb *tcp_data_callback, void *object);
 
 typedef int tcp_onion_cb(void *object, const uint8_t *data, uint16_t length, void *userdata);
 
-/** Set the callback for TCP onion packets.
- */
+/** @brief Set the callback for TCP onion packets. */
+non_null(1) nullable(2, 3)
 void set_onion_packet_tcp_connection_callback(TCP_Connections *tcp_c, tcp_onion_cb *tcp_onion_callback, void *object);
 
+/** @brief Set the callback for TCP forwarding packets. */
+non_null(1) nullable(2, 3)
+void set_forwarding_packet_tcp_connection_callback(TCP_Connections *tcp_c,
+        forwarded_response_cb *tcp_forwarded_response_callback,
+        void *object);
+
+
 typedef int tcp_oob_cb(void *object, const uint8_t *public_key, unsigned int tcp_connections_number,
                        const uint8_t *data, uint16_t length, void *userdata);
 
-/** Set the callback for TCP oob data packets.
- */
+/** @brief Set the callback for TCP oob data packets. */
+non_null()
 void set_oob_packet_tcp_connection_callback(TCP_Connections *tcp_c, tcp_oob_cb *tcp_oob_callback, void *object);
 
-/** Create a new TCP connection to public_key.
+/** @brief Encode tcp_connections_number as a custom ip_port.
  *
- * public_key must be the counterpart to the secret key that the other peer used with new_tcp_connections().
+ * return ip_port.
+ */
+IP_Port tcp_connections_number_to_ip_port(unsigned int tcp_connections_number);
+
+/** @brief Decode ip_port created by tcp_connections_number_to_ip_port to tcp_connections_number.
+ *
+ * return true on success.
+ * return false if ip_port is invalid.
+ */
+non_null()
+bool ip_port_to_tcp_connections_number(const IP_Port *ip_port, unsigned int *tcp_connections_number);
+
+/** @brief Create a new TCP connection to public_key.
+ *
+ * public_key must be the counterpart to the secret key that the other peer used with `new_tcp_connections()`.
  *
  * id is the id in the callbacks for that connection.
  *
  * return connections_number on success.
  * return -1 on failure.
  */
+non_null()
 int new_tcp_connection_to(TCP_Connections *tcp_c, const uint8_t *public_key, int id);
 
-/** return 0 on success.
- * return -1 on failure.
+/**
+ * @retval 0 on success.
+ * @retval -1 on failure.
  */
+non_null()
 int kill_tcp_connection_to(TCP_Connections *tcp_c, int connections_number);
 
-/** Set connection status.
+/** @brief Set connection status.
  *
  * status of 1 means we are using the connection.
  * status of 0 means we are not using it.
@@ -169,61 +225,86 @@ int kill_tcp_connection_to(TCP_Connections *tcp_c, int connections_number);
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int set_tcp_connection_to_status(const TCP_Connections *tcp_c, int connections_number, bool status);
 
-/** return number of online tcp relays tied to the connection on success.
- * return 0 on failure.
+/**
+ * @return number of online tcp relays tied to the connection on success.
+ * @retval 0 on failure.
  */
-unsigned int tcp_connection_to_online_tcp_relays(const TCP_Connections *tcp_c, int connections_number);
+non_null()
+uint32_t tcp_connection_to_online_tcp_relays(const TCP_Connections *tcp_c, int connections_number);
 
-/** Add a TCP relay tied to a connection.
+/** @brief Add a TCP relay tied to a connection.
  *
  * NOTE: This can only be used during the tcp_oob_callback.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int add_tcp_number_relay_connection(const TCP_Connections *tcp_c, int connections_number,
                                     unsigned int tcp_connections_number);
 
-/** Add a TCP relay tied to a connection.
+/** @brief Add a TCP relay tied to a connection.
  *
  * This should be called with the same relay by two peers who want to create a TCP connection with each other.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int add_tcp_relay_connection(TCP_Connections *tcp_c, int connections_number, const IP_Port *ip_port,
                              const uint8_t *relay_pk);
 
-/** Add a TCP relay to the TCP_Connections instance.
+/** @brief Add a TCP relay to the TCP_Connections instance.
  *
  * return 0 on success.
  * return -1 on failure.
  */
+non_null()
 int add_tcp_relay_global(TCP_Connections *tcp_c, const IP_Port *ip_port, const uint8_t *relay_pk);
 
-/** Copy a maximum of max_num TCP relays we are connected to to tcp_relays.
+/** @brief Copy a maximum of max_num TCP relays we are connected to to tcp_relays.
+ *
  * NOTE that the family of the copied ip ports will be set to TCP_INET or TCP_INET6.
  *
  * return number of relays copied to tcp_relays on success.
  * return 0 on failure.
  */
+non_null()
 uint32_t tcp_copy_connected_relays(const TCP_Connections *tcp_c, Node_format *tcp_relays, uint16_t max_num);
 
-/** Returns a new TCP_Connections object associated with the secret_key.
+/** @brief Copy a maximum of `max_num` TCP relays we are connected to starting at idx.
+ *
+ * @param idx is the index in the TCP relay array for `tcp_c` designated.
+ *   If idx is greater than the array length a modulo operation is performed.
+ *
+ * Returns the number of relays successfully copied.
+ */
+non_null()
+uint32_t tcp_copy_connected_relays_index(const TCP_Connections *tcp_c, Node_format *tcp_relays, uint16_t max_num,
+        uint32_t idx);
+
+/** @brief Returns a new TCP_Connections object associated with the secret_key.
  *
- * In order for others to connect to this instance new_tcp_connection_to() must be called with the
+ * In order for others to connect to this instance `new_tcp_connection_to()` must be called with the
  * public_key associated with secret_key.
  *
  * Returns NULL on failure.
  */
-TCP_Connections *new_tcp_connections(const Logger *logger, Mono_Time *mono_time, const uint8_t *secret_key,
-                                     const TCP_Proxy_Info *proxy_info);
+non_null()
+TCP_Connections *new_tcp_connections(
+        const Logger *logger, const Random *rng, const Network *ns, Mono_Time *mono_time,
+        const uint8_t *secret_key, const TCP_Proxy_Info *proxy_info);
 
+non_null()
 int kill_tcp_relay_connection(TCP_Connections *tcp_c, int tcp_connections_number);
 
+non_null(1, 2) nullable(3)
 void do_tcp_connections(const Logger *logger, TCP_Connections *tcp_c, void *userdata);
+
+nullable(1)
 void kill_tcp_connections(TCP_Connections *tcp_c);
 
 #endif