From cc0c4a5fe1f686bb5c70a6786f4a7237b42799d8 Mon Sep 17 00:00:00 2001 From: iphydf Date: Wed, 30 Mar 2022 18:47:20 +0000 Subject: [PATCH] cleanup: Move definitions of tox_private.h functions to tox_private.c. Also moved lock/unlock to tox_private so they can be used across these 2 tox/tox_private translation units. --- CMakeLists.txt | 1 + toxcore/BUILD.bazel | 1 + toxcore/Makefile.inc | 1 + toxcore/tox.c | 434 +++++++++++++++--------------------------- toxcore/tox_private.c | 138 ++++++++++++++ toxcore/tox_private.h | 10 +- 6 files changed, 302 insertions(+), 283 deletions(-) create mode 100644 toxcore/tox_private.c diff --git a/CMakeLists.txt b/CMakeLists.txt index e7d377a9..6c51e36f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -284,6 +284,7 @@ set(toxcore_SOURCES ${toxcore_SOURCES} toxcore/tox_api.c toxcore/tox.c toxcore/tox.h + toxcore/tox_private.c toxcore/tox_private.h) set(toxcore_API_HEADERS ${toxcore_API_HEADERS} ${toxcore_SOURCE_DIR}/toxcore/tox.h^tox) diff --git a/toxcore/BUILD.bazel b/toxcore/BUILD.bazel index 1aafae20..09030255 100644 --- a/toxcore/BUILD.bazel +++ b/toxcore/BUILD.bazel @@ -569,6 +569,7 @@ cc_library( srcs = [ "tox.c", "tox_api.c", + "tox_private.c", ], hdrs = [ "tox.h", diff --git a/toxcore/Makefile.inc b/toxcore/Makefile.inc index 2aff28b8..513b4c49 100644 --- a/toxcore/Makefile.inc +++ b/toxcore/Makefile.inc @@ -69,6 +69,7 @@ libtoxcore_la_SOURCES = ../third_party/cmp/cmp.c \ ../toxcore/tox_events.c \ ../toxcore/tox_unpack.h \ ../toxcore/tox_unpack.c \ + ../toxcore/tox_private.c \ ../toxcore/tox_private.h \ ../toxcore/tox_struct.h \ ../toxcore/tox_api.c \ diff --git a/toxcore/tox.c b/toxcore/tox.c index 65485edb..d5a4ae99 100644 --- a/toxcore/tox.c +++ b/toxcore/tox.c @@ -55,22 +55,6 @@ static_assert(TOX_MAX_NAME_LENGTH == MAX_NAME_LENGTH, static_assert(TOX_MAX_STATUS_MESSAGE_LENGTH == MAX_STATUSMESSAGE_LENGTH, "TOX_MAX_STATUS_MESSAGE_LENGTH is assumed to be equal to MAX_STATUSMESSAGE_LENGTH"); -non_null() -static void lock(const Tox *tox) -{ - if (tox->mutex != nullptr) { - pthread_mutex_lock(tox->mutex); - } -} - -non_null() -static void unlock(const Tox *tox) -{ - if (tox->mutex != nullptr) { - pthread_mutex_unlock(tox->mutex); - } -} - struct Tox_Userdata { Tox *tox; void *user_data; @@ -593,7 +577,7 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error) tox->mutex = nullptr; } - lock(tox); + tox_lock(tox); Messenger_Error m_error; tox->m = new_messenger(tox->mono_time, &tox->ns, &m_options, &m_error); @@ -609,7 +593,7 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error) mono_time_free(tox->mono_time); tox_options_free(default_options); - unlock(tox); + tox_unlock(tox); if (tox->mutex != nullptr) { pthread_mutex_destroy(tox->mutex); @@ -625,7 +609,7 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error) mono_time_free(tox->mono_time); tox_options_free(default_options); - unlock(tox); + tox_unlock(tox); if (tox->mutex != nullptr) { pthread_mutex_destroy(tox->mutex); @@ -673,7 +657,7 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error) tox_options_free(default_options); - unlock(tox); + tox_unlock(tox); return tox; } @@ -683,12 +667,12 @@ void tox_kill(Tox *tox) return; } - lock(tox); + tox_lock(tox); LOGGER_ASSERT(tox->m->log, tox->m->msi_packet == nullptr, "Attempted to kill tox while toxav is still alive"); kill_groupchats(tox->m->conferences_object); kill_messenger(tox->m); mono_time_free(tox->mono_time); - unlock(tox); + tox_unlock(tox); if (tox->mutex != nullptr) { pthread_mutex_destroy(tox->mutex); @@ -712,12 +696,12 @@ static void end_save(uint8_t *data) size_t tox_get_savedata_size(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t ret = 2 * sizeof(uint32_t) + messenger_size(tox->m) + conferences_size(tox->m->conferences_object) + end_size(); - unlock(tox); + tox_unlock(tox); return ret; } @@ -731,7 +715,7 @@ void tox_get_savedata(const Tox *tox, uint8_t *savedata) memset(savedata, 0, tox_get_savedata_size(tox)); - lock(tox); + tox_lock(tox); const uint32_t size32 = sizeof(uint32_t); @@ -745,7 +729,7 @@ void tox_get_savedata(const Tox *tox, uint8_t *savedata) savedata = conferences_save(tox->m->conferences_object, savedata); end_save(savedata); - unlock(tox); + tox_unlock(tox); } non_null(5) nullable(1, 2, 4, 6) @@ -786,7 +770,7 @@ bool tox_bootstrap(Tox *tox, const char *host, uint16_t port, const uint8_t *pub return false; } - lock(tox); + tox_lock(tox); assert(count >= 0); bool onion_success = false; // UDP bootstrap is default success if it's disabled (because we don't even try). @@ -810,7 +794,7 @@ bool tox_bootstrap(Tox *tox, const char *host, uint16_t port, const uint8_t *pub } } - unlock(tox); + tox_unlock(tox); net_freeipport(root); @@ -838,7 +822,7 @@ bool tox_add_tcp_relay(Tox *tox, const char *host, uint16_t port, const uint8_t return false; } - lock(tox); + tox_lock(tox); assert(count >= 0); for (int32_t i = 0; i < count; ++i) { @@ -847,7 +831,7 @@ bool tox_add_tcp_relay(Tox *tox, const char *host, uint16_t port, const uint8_t add_tcp_relay(tox->m->net_crypto, &root[i], public_key); } - unlock(tox); + tox_unlock(tox); net_freeipport(root); @@ -863,9 +847,9 @@ bool tox_add_tcp_relay(Tox *tox, const char *host, uint16_t port, const uint8_t Tox_Connection tox_self_get_connection_status(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const Onion_Connection_Status ret = onion_connection_status(tox->m->onion_c); - unlock(tox); + tox_unlock(tox); switch (ret) { case ONION_CONNECTION_STATUS_NONE: @@ -891,21 +875,21 @@ void tox_callback_self_connection_status(Tox *tox, tox_self_connection_status_cb uint32_t tox_iteration_interval(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); uint32_t ret = messenger_run_interval(tox->m); if (m_is_receiving_file(tox->m)) { ret = 1; } - unlock(tox); + tox_unlock(tox); return ret; } void tox_iterate(Tox *tox, void *user_data) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); mono_time_update(tox->mono_time); @@ -913,7 +897,7 @@ void tox_iterate(Tox *tox, void *user_data) do_messenger(tox->m, &tox_data); do_groupchats(tox->m->conferences_object, &tox_data); - unlock(tox); + tox_unlock(tox); } void tox_self_get_address(const Tox *tox, uint8_t *address) @@ -921,26 +905,26 @@ void tox_self_get_address(const Tox *tox, uint8_t *address) assert(tox != nullptr); if (address != nullptr) { - lock(tox); + tox_lock(tox); getaddress(tox->m, address); - unlock(tox); + tox_unlock(tox); } } void tox_self_set_nospam(Tox *tox, uint32_t nospam) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); set_nospam(tox->m->fr, net_htonl(nospam)); - unlock(tox); + tox_unlock(tox); } uint32_t tox_self_get_nospam(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const uint32_t ret = net_ntohl(get_nospam(tox->m->fr)); - unlock(tox); + tox_unlock(tox); return ret; } @@ -949,9 +933,9 @@ void tox_self_get_public_key(const Tox *tox, uint8_t *public_key) assert(tox != nullptr); if (public_key != nullptr) { - lock(tox); + tox_lock(tox); memcpy(public_key, nc_get_self_public_key(tox->m->net_crypto), CRYPTO_PUBLIC_KEY_SIZE); - unlock(tox); + tox_unlock(tox); } } @@ -960,9 +944,9 @@ void tox_self_get_secret_key(const Tox *tox, uint8_t *secret_key) assert(tox != nullptr); if (secret_key != nullptr) { - lock(tox); + tox_lock(tox); memcpy(secret_key, nc_get_self_secret_key(tox->m->net_crypto), CRYPTO_SECRET_KEY_SIZE); - unlock(tox); + tox_unlock(tox); } } @@ -975,27 +959,27 @@ bool tox_self_set_name(Tox *tox, const uint8_t *name, size_t length, Tox_Err_Set return false; } - lock(tox); + tox_lock(tox); if (setname(tox->m, name, length) == 0) { // TODO(irungentoo): function to set different per group names? send_name_all_groups(tox->m->conferences_object); SET_ERROR_PARAMETER(error, TOX_ERR_SET_INFO_OK); - unlock(tox); + tox_unlock(tox); return true; } SET_ERROR_PARAMETER(error, TOX_ERR_SET_INFO_TOO_LONG); - unlock(tox); + tox_unlock(tox); return false; } size_t tox_self_get_name_size(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t ret = m_get_self_name_size(tox->m); - unlock(tox); + tox_unlock(tox); return ret; } @@ -1004,9 +988,9 @@ void tox_self_get_name(const Tox *tox, uint8_t *name) assert(tox != nullptr); if (name != nullptr) { - lock(tox); + tox_lock(tox); getself_name(tox->m, name); - unlock(tox); + tox_unlock(tox); } } @@ -1019,25 +1003,25 @@ bool tox_self_set_status_message(Tox *tox, const uint8_t *status_message, size_t return false; } - lock(tox); + tox_lock(tox); if (m_set_statusmessage(tox->m, status_message, length) == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_SET_INFO_OK); - unlock(tox); + tox_unlock(tox); return true; } SET_ERROR_PARAMETER(error, TOX_ERR_SET_INFO_TOO_LONG); - unlock(tox); + tox_unlock(tox); return false; } size_t tox_self_get_status_message_size(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t ret = m_get_self_statusmessage_size(tox->m); - unlock(tox); + tox_unlock(tox); return ret; } @@ -1046,26 +1030,26 @@ void tox_self_get_status_message(const Tox *tox, uint8_t *status_message) assert(tox != nullptr); if (status_message != nullptr) { - lock(tox); + tox_lock(tox); m_copy_self_statusmessage(tox->m, status_message); - unlock(tox); + tox_unlock(tox); } } void tox_self_set_status(Tox *tox, Tox_User_Status status) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); m_set_userstatus(tox->m, status); - unlock(tox); + tox_unlock(tox); } Tox_User_Status tox_self_get_status(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const uint8_t status = m_get_self_userstatus(tox->m); - unlock(tox); + tox_unlock(tox); return (Tox_User_Status)status; } @@ -1126,17 +1110,17 @@ uint32_t tox_friend_add(Tox *tox, const uint8_t *address, const uint8_t *message return UINT32_MAX; } - lock(tox); + tox_lock(tox); const int32_t ret = m_addfriend(tox->m, address, message, length); if (ret >= 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_ADD_OK); - unlock(tox); + tox_unlock(tox); return ret; } set_friend_error(tox->m->log, ret, error); - unlock(tox); + tox_unlock(tox); return UINT32_MAX; } @@ -1149,26 +1133,26 @@ uint32_t tox_friend_add_norequest(Tox *tox, const uint8_t *public_key, Tox_Err_F return UINT32_MAX; } - lock(tox); + tox_lock(tox); const int32_t ret = m_addfriend_norequest(tox->m, public_key); if (ret >= 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_ADD_OK); - unlock(tox); + tox_unlock(tox); return ret; } set_friend_error(tox->m->log, ret, error); - unlock(tox); + tox_unlock(tox); return UINT32_MAX; } bool tox_friend_delete(Tox *tox, uint32_t friend_number, Tox_Err_Friend_Delete *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_delfriend(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); // TODO(irungentoo): handle if realloc fails? if (ret == -1) { @@ -1189,9 +1173,9 @@ uint32_t tox_friend_by_public_key(const Tox *tox, const uint8_t *public_key, Tox return UINT32_MAX; } - lock(tox); + tox_lock(tox); const int32_t ret = getfriend_id(tox->m, public_key); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_BY_PUBLIC_KEY_NOT_FOUND); @@ -1211,34 +1195,34 @@ bool tox_friend_get_public_key(const Tox *tox, uint32_t friend_number, uint8_t * return false; } - lock(tox); + tox_lock(tox); if (get_real_pk(tox->m, friend_number, public_key) == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_GET_PUBLIC_KEY_FRIEND_NOT_FOUND); - unlock(tox); + tox_unlock(tox); return false; } SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_GET_PUBLIC_KEY_OK); - unlock(tox); + tox_unlock(tox); return true; } bool tox_friend_exists(const Tox *tox, uint32_t friend_number) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const bool ret = m_friend_exists(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); return ret; } uint64_t tox_friend_get_last_online(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Get_Last_Online *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const uint64_t timestamp = m_get_last_online(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (timestamp == UINT64_MAX) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_GET_LAST_ONLINE_FRIEND_NOT_FOUND); @@ -1252,9 +1236,9 @@ uint64_t tox_friend_get_last_online(const Tox *tox, uint32_t friend_number, Tox_ size_t tox_self_get_friend_list_size(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t ret = count_friendlist(tox->m); - unlock(tox); + tox_unlock(tox); return ret; } @@ -1263,19 +1247,19 @@ void tox_self_get_friend_list(const Tox *tox, uint32_t *friend_list) assert(tox != nullptr); if (friend_list != nullptr) { - lock(tox); + tox_lock(tox); // TODO(irungentoo): size parameter? copy_friendlist(tox->m, friend_list, count_friendlist(tox->m)); - unlock(tox); + tox_unlock(tox); } } size_t tox_friend_get_name_size(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_get_name_size(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1295,9 +1279,9 @@ bool tox_friend_get_name(const Tox *tox, uint32_t friend_number, uint8_t *name, return false; } - lock(tox); + tox_lock(tox); const int ret = getname(tox->m, friend_number, name); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1317,9 +1301,9 @@ void tox_callback_friend_name(Tox *tox, tox_friend_name_cb *callback) size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_get_statusmessage_size(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1340,12 +1324,12 @@ bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8 return false; } - lock(tox); + tox_lock(tox); const int size = m_get_statusmessage_size(tox->m, friend_number); if (size == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); - unlock(tox); + tox_unlock(tox); return false; } @@ -1353,7 +1337,7 @@ bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8 LOGGER_ASSERT(tox->m->log, ret == size, "concurrency problem: friend status message changed"); SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_OK); - unlock(tox); + tox_unlock(tox); return ret == size; } @@ -1366,9 +1350,9 @@ void tox_callback_friend_status_message(Tox *tox, tox_friend_status_message_cb * Tox_User_Status tox_friend_get_status(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_get_userstatus(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (ret == USERSTATUS_INVALID) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1388,9 +1372,9 @@ void tox_callback_friend_status(Tox *tox, tox_friend_status_cb *callback) Tox_Connection tox_friend_get_connection_status(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_get_friend_connectionstatus(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1410,9 +1394,9 @@ void tox_callback_friend_connection_status(Tox *tox, tox_friend_connection_statu bool tox_friend_get_typing(const Tox *tox, uint32_t friend_number, Tox_Err_Friend_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = m_get_istyping(tox->m, friend_number); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_FRIEND_QUERY_FRIEND_NOT_FOUND); @@ -1432,16 +1416,16 @@ void tox_callback_friend_typing(Tox *tox, tox_friend_typing_cb *callback) bool tox_self_set_typing(Tox *tox, uint32_t friend_number, bool typing, Tox_Err_Set_Typing *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); if (m_set_usertyping(tox->m, friend_number, typing) == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_SET_TYPING_FRIEND_NOT_FOUND); - unlock(tox); + tox_unlock(tox); return false; } SET_ERROR_PARAMETER(error, TOX_ERR_SET_TYPING_OK); - unlock(tox); + tox_unlock(tox); return true; } @@ -1503,10 +1487,10 @@ uint32_t tox_friend_send_message(Tox *tox, uint32_t friend_number, Tox_Message_T } uint32_t message_id = 0; - lock(tox); + tox_lock(tox); set_message_error(tox->m->log, m_send_message_generic(tox->m, friend_number, type, message, length, &message_id), error); - unlock(tox); + tox_unlock(tox); return message_id; } @@ -1542,9 +1526,9 @@ bool tox_file_control(Tox *tox, uint32_t friend_number, uint32_t file_number, To Tox_Err_File_Control *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = file_control(tox->m, friend_number, file_number, control); - unlock(tox); + tox_unlock(tox); if (ret == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FILE_CONTROL_OK); @@ -1604,9 +1588,9 @@ bool tox_file_seek(Tox *tox, uint32_t friend_number, uint32_t file_number, uint6 Tox_Err_File_Seek *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = file_seek(tox->m, friend_number, file_number, position); - unlock(tox); + tox_unlock(tox); if (ret == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FILE_SEEK_OK); @@ -1668,9 +1652,9 @@ bool tox_file_get_file_id(const Tox *tox, uint32_t friend_number, uint32_t file_ return false; } - lock(tox); + tox_lock(tox); const int ret = file_get_id(tox->m, friend_number, file_number, file_id); - unlock(tox); + tox_unlock(tox); if (ret == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FILE_GET_OK); @@ -1704,9 +1688,9 @@ uint32_t tox_file_send(Tox *tox, uint32_t friend_number, uint32_t kind, uint64_t file_id = f_id; } - lock(tox); + tox_lock(tox); const long int file_num = new_filesender(tox->m, friend_number, kind, file_size, file_id, filename, filename_length); - unlock(tox); + tox_unlock(tox); if (file_num >= 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FILE_SEND_OK); @@ -1745,9 +1729,9 @@ bool tox_file_send_chunk(Tox *tox, uint32_t friend_number, uint32_t file_number, size_t length, Tox_Err_File_Send_Chunk *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = send_file_data(tox->m, friend_number, file_number, position, data, length); - unlock(tox); + tox_unlock(tox); if (ret == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_FILE_SEND_CHUNK_OK); @@ -1854,9 +1838,9 @@ void tox_callback_conference_peer_list_changed(Tox *tox, tox_conference_peer_lis uint32_t tox_conference_new(Tox *tox, Tox_Err_Conference_New *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = add_groupchat(tox->m->conferences_object, GROUPCHAT_TYPE_TEXT); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_NEW_INIT); @@ -1870,9 +1854,9 @@ uint32_t tox_conference_new(Tox *tox, Tox_Err_Conference_New *error) bool tox_conference_delete(Tox *tox, uint32_t conference_number, Tox_Err_Conference_Delete *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const bool ret = del_groupchat(tox->m->conferences_object, conference_number, true); - unlock(tox); + tox_unlock(tox); if (!ret) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_DELETE_CONFERENCE_NOT_FOUND); @@ -1886,9 +1870,9 @@ bool tox_conference_delete(Tox *tox, uint32_t conference_number, Tox_Err_Confere uint32_t tox_conference_peer_count(const Tox *tox, uint32_t conference_number, Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_number_peers(tox->m->conferences_object, conference_number, false); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_PEER_QUERY_CONFERENCE_NOT_FOUND); @@ -1903,9 +1887,9 @@ size_t tox_conference_peer_get_name_size(const Tox *tox, uint32_t conference_num Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peername_size(tox->m->conferences_object, conference_number, peer_number, false); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -1927,9 +1911,9 @@ bool tox_conference_peer_get_name(const Tox *tox, uint32_t conference_number, ui Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peername(tox->m->conferences_object, conference_number, peer_number, name, false); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -1951,9 +1935,9 @@ bool tox_conference_peer_get_public_key(const Tox *tox, uint32_t conference_numb uint8_t *public_key, Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peer_pubkey(tox->m->conferences_object, conference_number, peer_number, public_key, false); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -1975,9 +1959,9 @@ bool tox_conference_peer_number_is_ours(const Tox *tox, uint32_t conference_numb Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peernumber_is_ours(tox->m->conferences_object, conference_number, peer_number); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2004,9 +1988,9 @@ uint32_t tox_conference_offline_peer_count(const Tox *tox, uint32_t conference_n Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_number_peers(tox->m->conferences_object, conference_number, true); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_PEER_QUERY_CONFERENCE_NOT_FOUND); @@ -2022,9 +2006,9 @@ size_t tox_conference_offline_peer_get_name_size(const Tox *tox, uint32_t confer Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peername_size(tox->m->conferences_object, conference_number, offline_peer_number, true); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2047,9 +2031,9 @@ bool tox_conference_offline_peer_get_name(const Tox *tox, uint32_t conference_nu Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peername(tox->m->conferences_object, conference_number, offline_peer_number, name, true); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2072,9 +2056,9 @@ bool tox_conference_offline_peer_get_public_key(const Tox *tox, uint32_t confere uint8_t *public_key, Tox_Err_Conference_Peer_Query *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_peer_pubkey(tox->m->conferences_object, conference_number, offline_peer_number, public_key, true); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2098,10 +2082,10 @@ uint64_t tox_conference_offline_peer_get_last_active(const Tox *tox, uint32_t co { assert(tox != nullptr); uint64_t last_active = UINT64_MAX; - lock(tox); + tox_lock(tox); const int ret = group_frozen_last_active(tox->m->conferences_object, conference_number, offline_peer_number, &last_active); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2124,9 +2108,9 @@ bool tox_conference_set_max_offline(Tox *tox, uint32_t conference_number, Tox_Err_Conference_Set_Max_Offline *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_set_max_frozen(tox->m->conferences_object, conference_number, max_offline_peers); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_SET_MAX_OFFLINE_CONFERENCE_NOT_FOUND); @@ -2141,9 +2125,9 @@ bool tox_conference_invite(Tox *tox, uint32_t friend_number, uint32_t conference Tox_Err_Conference_Invite *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = invite_friend(tox->m->conferences_object, friend_number, conference_number); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2170,9 +2154,9 @@ uint32_t tox_conference_join(Tox *tox, uint32_t friend_number, const uint8_t *co Tox_Err_Conference_Join *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = join_groupchat(tox->m->conferences_object, friend_number, GROUPCHAT_TYPE_TEXT, cookie, length); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2214,7 +2198,7 @@ bool tox_conference_send_message(Tox *tox, uint32_t conference_number, Tox_Messa size_t length, Tox_Err_Conference_Send_Message *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); int ret = 0; if (type == TOX_MESSAGE_TYPE_NORMAL) { @@ -2223,7 +2207,7 @@ bool tox_conference_send_message(Tox *tox, uint32_t conference_number, Tox_Messa ret = group_action_send(tox->m->conferences_object, conference_number, message, length); } - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2254,9 +2238,9 @@ bool tox_conference_send_message(Tox *tox, uint32_t conference_number, Tox_Messa size_t tox_conference_get_title_size(const Tox *tox, uint32_t conference_number, Tox_Err_Conference_Title *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_title_get_size(tox->m->conferences_object, conference_number); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2278,9 +2262,9 @@ bool tox_conference_get_title(const Tox *tox, uint32_t conference_number, uint8_ Tox_Err_Conference_Title *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_title_get(tox->m->conferences_object, conference_number, title); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2302,9 +2286,9 @@ bool tox_conference_set_title(Tox *tox, uint32_t conference_number, const uint8_ Tox_Err_Conference_Title *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_title_send(tox->m->conferences_object, conference_number, title, length); - unlock(tox); + tox_unlock(tox); switch (ret) { case -1: { @@ -2330,28 +2314,28 @@ bool tox_conference_set_title(Tox *tox, uint32_t conference_number, const uint8_ size_t tox_conference_get_chatlist_size(const Tox *tox) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t ret = count_chatlist(tox->m->conferences_object); - unlock(tox); + tox_unlock(tox); return ret; } void tox_conference_get_chatlist(const Tox *tox, uint32_t *chatlist) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const size_t list_size = count_chatlist(tox->m->conferences_object); copy_chatlist(tox->m->conferences_object, chatlist, list_size); - unlock(tox); + tox_unlock(tox); } Tox_Conference_Type tox_conference_get_type(const Tox *tox, uint32_t conference_number, Tox_Err_Conference_Get_Type *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const int ret = group_get_type(tox->m->conferences_object, conference_number); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_GET_TYPE_CONFERENCE_NOT_FOUND); @@ -2365,9 +2349,9 @@ Tox_Conference_Type tox_conference_get_type(const Tox *tox, uint32_t conference_ bool tox_conference_get_id(const Tox *tox, uint32_t conference_number, uint8_t *id) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const bool ret = conference_get_id(tox->m->conferences_object, conference_number, id); - unlock(tox); + tox_unlock(tox); return ret; } @@ -2387,9 +2371,9 @@ uint32_t tox_conference_by_id(const Tox *tox, const uint8_t *id, Tox_Err_Confere return UINT32_MAX; } - lock(tox); + tox_lock(tox); const int32_t ret = conference_by_id(tox->m->conferences_object, id); - unlock(tox); + tox_unlock(tox); if (ret == -1) { SET_ERROR_PARAMETER(error, TOX_ERR_CONFERENCE_BY_ID_NOT_FOUND); @@ -2483,9 +2467,9 @@ bool tox_friend_send_lossy_packet(Tox *tox, uint32_t friend_number, const uint8_ return false; } - lock(tox); + tox_lock(tox); const int ret = m_send_custom_lossy_packet(tox->m, friend_number, data, length); - unlock(tox); + tox_unlock(tox); set_custom_packet_error(ret, error); @@ -2502,15 +2486,6 @@ void tox_callback_friend_lossy_packet(Tox *tox, tox_friend_lossy_packet_cb *call } } -void tox_callback_friend_lossy_packet_per_pktid(Tox *tox, tox_friend_lossy_packet_cb *callback, uint8_t pktid) -{ - assert(tox != nullptr); - - if (pktid >= PACKET_ID_RANGE_LOSSY_START && pktid <= PACKET_ID_RANGE_LOSSY_END) { - tox->friend_lossy_packet_callback_per_pktid[pktid] = callback; - } -} - bool tox_friend_send_lossless_packet(Tox *tox, uint32_t friend_number, const uint8_t *data, size_t length, Tox_Err_Friend_Custom_Packet *error) { @@ -2526,9 +2501,9 @@ bool tox_friend_send_lossless_packet(Tox *tox, uint32_t friend_number, const uin return false; } - lock(tox); + tox_lock(tox); const int ret = send_custom_lossless_packet(tox->m, friend_number, data, length); - unlock(tox); + tox_unlock(tox); set_custom_packet_error(ret, error); @@ -2544,50 +2519,23 @@ void tox_callback_friend_lossless_packet(Tox *tox, tox_friend_lossless_packet_cb } } -void tox_callback_friend_lossless_packet_per_pktid(Tox *tox, tox_friend_lossless_packet_cb *callback, uint8_t pktid) -{ - assert(tox != nullptr); - - if ((pktid >= PACKET_ID_RANGE_LOSSLESS_CUSTOM_START && pktid <= PACKET_ID_RANGE_LOSSLESS_CUSTOM_END) - || pktid == PACKET_ID_MSI) { - tox->friend_lossless_packet_callback_per_pktid[pktid] = callback; - } -} - void tox_self_get_dht_id(const Tox *tox, uint8_t *dht_id) { assert(tox != nullptr); if (dht_id != nullptr) { - lock(tox); + tox_lock(tox); memcpy(dht_id, dht_get_self_public_key(tox->m->dht), CRYPTO_PUBLIC_KEY_SIZE); - unlock(tox); + tox_unlock(tox); } } -void tox_set_av_object(Tox *tox, void *object) -{ - assert(tox != nullptr); - lock(tox); - tox->toxav_object = object; - unlock(tox); -} - -void *tox_get_av_object(const Tox *tox) -{ - assert(tox != nullptr); - lock(tox); - void *object = tox->toxav_object; - unlock(tox); - return object; -} - uint16_t tox_self_get_udp_port(const Tox *tox, Tox_Err_Get_Port *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); const uint16_t port = net_htons(net_port(tox->m->net)); - unlock(tox); + tox_unlock(tox); if (port == 0) { SET_ERROR_PARAMETER(error, TOX_ERR_GET_PORT_NOT_BOUND); @@ -2601,86 +2549,20 @@ uint16_t tox_self_get_udp_port(const Tox *tox, Tox_Err_Get_Port *error) uint16_t tox_self_get_tcp_port(const Tox *tox, Tox_Err_Get_Port *error) { assert(tox != nullptr); - lock(tox); + tox_lock(tox); if (tox->m->tcp_server != nullptr) { SET_ERROR_PARAMETER(error, TOX_ERR_GET_PORT_OK); const uint16_t ret = tox->m->options.tcp_server_port; - unlock(tox); + tox_unlock(tox); return ret; } SET_ERROR_PARAMETER(error, TOX_ERR_GET_PORT_NOT_BOUND); - unlock(tox); + tox_unlock(tox); return 0; } -void tox_callback_dht_get_nodes_response(Tox *tox, tox_dht_get_nodes_response_cb *callback) -{ - assert(tox != nullptr); - tox->dht_get_nodes_response_callback = callback; -} - -bool tox_dht_get_nodes(const Tox *tox, const uint8_t *public_key, const char *ip, uint16_t port, - const uint8_t *target_public_key, Tox_Err_Dht_Get_Nodes *error) -{ - assert(tox != nullptr); - - lock(tox); - - if (tox->m->options.udp_disabled) { - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_UDP_DISABLED); - unlock(tox); - return false; - } - - if (public_key == nullptr || ip == nullptr || target_public_key == nullptr) { - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_NULL); - unlock(tox); - return false; - } - - if (port == 0) { - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_BAD_PORT); - unlock(tox); - return false; - } - - IP_Port *root; - - const int32_t count = net_getipport(ip, &root, TOX_SOCK_DGRAM); - - if (count < 1) { - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_BAD_IP); - net_freeipport(root); - unlock(tox); - return false; - } - - bool success = false; - - for (int32_t i = 0; i < count; ++i) { - root[i].port = net_htons(port); - - if (dht_getnodes(tox->m->dht, &root[i], public_key, target_public_key)) { - success = true; - } - } - - unlock(tox); - - net_freeipport(root); - - if (!success) { - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_FAIL); - return false; - } - - SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_OK); - - return true; -} - void tox_set_network(Tox *tox, const Network *ns) { assert(tox != nullptr); diff --git a/toxcore/tox_private.c b/toxcore/tox_private.c new file mode 100644 index 00000000..cc171f1c --- /dev/null +++ b/toxcore/tox_private.c @@ -0,0 +1,138 @@ +/* SPDX-License-Identifier: GPL-3.0-or-later + * Copyright © 2016-2022 The TokTok team. + * Copyright © 2013 Tox project. + */ + +/** + * The Tox private API (for tests). + */ +#include "tox_private.h" + +#include + +#include "ccompat.h" +#include "network.h" +#include "tox_struct.h" + +#define SET_ERROR_PARAMETER(param, x) \ + do { \ + if (param != nullptr) { \ + *param = x; \ + } \ + } while (0) + +void tox_lock(const Tox *tox) +{ + if (tox->mutex != nullptr) { + pthread_mutex_lock(tox->mutex); + } +} + +void tox_unlock(const Tox *tox) +{ + if (tox->mutex != nullptr) { + pthread_mutex_unlock(tox->mutex); + } +} + +void tox_callback_friend_lossy_packet_per_pktid(Tox *tox, tox_friend_lossy_packet_cb *callback, uint8_t pktid) +{ + assert(tox != nullptr); + + if (pktid >= PACKET_ID_RANGE_LOSSY_START && pktid <= PACKET_ID_RANGE_LOSSY_END) { + tox->friend_lossy_packet_callback_per_pktid[pktid] = callback; + } +} + +void tox_callback_friend_lossless_packet_per_pktid(Tox *tox, tox_friend_lossless_packet_cb *callback, uint8_t pktid) +{ + assert(tox != nullptr); + + if ((pktid >= PACKET_ID_RANGE_LOSSLESS_CUSTOM_START && pktid <= PACKET_ID_RANGE_LOSSLESS_CUSTOM_END) + || pktid == PACKET_ID_MSI) { + tox->friend_lossless_packet_callback_per_pktid[pktid] = callback; + } +} + +void tox_set_av_object(Tox *tox, void *object) +{ + assert(tox != nullptr); + tox_lock(tox); + tox->toxav_object = object; + tox_unlock(tox); +} + +void *tox_get_av_object(const Tox *tox) +{ + assert(tox != nullptr); + tox_lock(tox); + void *object = tox->toxav_object; + tox_unlock(tox); + return object; +} + +void tox_callback_dht_get_nodes_response(Tox *tox, tox_dht_get_nodes_response_cb *callback) +{ + assert(tox != nullptr); + tox->dht_get_nodes_response_callback = callback; +} + +bool tox_dht_get_nodes(const Tox *tox, const uint8_t *public_key, const char *ip, uint16_t port, + const uint8_t *target_public_key, Tox_Err_Dht_Get_Nodes *error) +{ + assert(tox != nullptr); + + tox_lock(tox); + + if (tox->m->options.udp_disabled) { + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_UDP_DISABLED); + tox_unlock(tox); + return false; + } + + if (public_key == nullptr || ip == nullptr || target_public_key == nullptr) { + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_NULL); + tox_unlock(tox); + return false; + } + + if (port == 0) { + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_BAD_PORT); + tox_unlock(tox); + return false; + } + + IP_Port *root; + + const int32_t count = net_getipport(ip, &root, TOX_SOCK_DGRAM); + + if (count < 1) { + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_BAD_IP); + net_freeipport(root); + tox_unlock(tox); + return false; + } + + bool success = false; + + for (int32_t i = 0; i < count; ++i) { + root[i].port = net_htons(port); + + if (dht_getnodes(tox->m->dht, &root[i], public_key, target_public_key)) { + success = true; + } + } + + tox_unlock(tox); + + net_freeipport(root); + + if (!success) { + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_FAIL); + return false; + } + + SET_ERROR_PARAMETER(error, TOX_ERR_DHT_GET_NODES_OK); + + return true; +} diff --git a/toxcore/tox_private.h b/toxcore/tox_private.h index e6dffd9e..714a6a3c 100644 --- a/toxcore/tox_private.h +++ b/toxcore/tox_private.h @@ -18,6 +18,9 @@ extern "C" { #endif +void tox_lock(const Tox *tox); +void tox_unlock(const Tox *tox); + /** * Set the callback for the `friend_lossy_packet` event for a specific packet ID. * Pass NULL to unset. @@ -48,26 +51,19 @@ void *tox_get_av_object(const Tox *tox); * ******************************************************************************/ - - - /** * The minimum size of an IP string buffer in bytes. */ #define TOX_DHT_NODE_IP_STRING_SIZE 96 -//!TOKSTYLE- uint32_t tox_dht_node_ip_string_size(void); -//!TOKSTYLE+ /** * The size of a DHT node public key in bytes. */ #define TOX_DHT_NODE_PUBLIC_KEY_SIZE 32 -//!TOKSTYLE- uint32_t tox_dht_node_public_key_size(void); -//!TOKSTYLE+ /** * @param public_key The node's public key.