Split tox_unpack into two smaller libs

tox_unpack is for unpacking Tox types, and bin_unpack is for
unpacking ints and binary data. This prevents us from creating
dependency cycles due to tox_unpack depending on tox.h

CMakeLists.txt

@@ -279,6 +279,8 @@ set(toxcore_SOURCES ${toxcore_SOURCES}
   toxcore/events/events_alloc.c
   toxcore/events/events_alloc.h
   toxcore/events/self_connection_status.c
+  toxcore/bin_unpack.c
+  toxcore/bin_unpack.h
   toxcore/tox_events.c
   toxcore/tox_events.h
   toxcore/tox_unpack.c

toxcore/BUILD.bazel

@@ -14,6 +14,17 @@ cc_library(
     visibility = ["//c-toxcore:__subpackages__"],
 )
 
+cc_library(
+    name = "bin_unpack",
+    srcs = ["bin_unpack.c"],
+    hdrs = ["bin_unpack.h"],
+    visibility = ["//c-toxcore:__subpackages__"],
+    deps = [
+        ":ccompat",
+        "@msgpack-c",
+    ],
+)
+
 cc_library(
     name = "ccompat",
     srcs = ["ccompat.c"],
@@ -490,6 +501,7 @@ cc_library(
     hdrs = ["tox_events.h"],
     visibility = ["//c-toxcore:__subpackages__"],
     deps = [
+        ":bin_unpack",
         ":ccompat",
         ":tox_unpack",
         ":toxcore",

toxcore/Makefile.inc

@@ -6,6 +6,8 @@ libtoxcore_la_include_HEADERS = \
 libtoxcore_la_includedir = $(includedir)/tox
 
 libtoxcore_la_SOURCES = ../toxcore/attributes.h \
+                        ../toxcore/bin_unpack.c \
+                        ../toxcore/bin_unpack.h \
                         ../toxcore/ccompat.c \
                         ../toxcore/ccompat.h \
                         ../toxcore/events/conference_connected.c \

toxcore/bin_unpack.c

@@ -0,0 +1,80 @@
+/* SPDX-License-Identifier: GPL-3.0-or-later
+ * Copyright © 2022 The TokTok team.
+ */
+
+#include "bin_unpack.h"
+
+#include <msgpack.h>
+
+#include "ccompat.h"
+
+bool bin_unpack_bool(bool *val, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_BOOLEAN) {
+        return false;
+    }
+
+    *val = obj->via.boolean;
+    return true;
+}
+
+bool bin_unpack_u16(uint16_t *val, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_POSITIVE_INTEGER || obj->via.u64 > UINT16_MAX) {
+        return false;
+    }
+
+    *val = (uint16_t)obj->via.u64;
+    return true;
+}
+
+bool bin_unpack_u32(uint32_t *val, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_POSITIVE_INTEGER || obj->via.u64 > UINT32_MAX) {
+        return false;
+    }
+
+    *val = (uint32_t)obj->via.u64;
+    return true;
+}
+
+bool bin_unpack_u64(uint64_t *val, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_POSITIVE_INTEGER) {
+        return false;
+    }
+
+    *val = obj->via.u64;
+    return true;
+}
+
+bool bin_unpack_bytes(uint8_t **data_ptr, size_t *data_length_ptr, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_BIN) {
+        return false;
+    }
+
+    const uint32_t data_length = obj->via.bin.size;
+    uint8_t *const data = (uint8_t *)malloc(data_length);
+
+    if (data == nullptr) {
+        return false;
+    }
+
+    memcpy(data, obj->via.bin.ptr, data_length);
+
+    *data_ptr = data;
+    *data_length_ptr = data_length;
+    return true;
+}
+
+bool bin_unpack_bytes_fixed(uint8_t *data, uint32_t data_length, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_BIN || obj->via.bin.size != data_length) {
+        return false;
+    }
+
+    memcpy(data, obj->via.bin.ptr, data_length);
+
+    return true;
+}

toxcore/bin_unpack.h

@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-3.0-or-later
+ * Copyright © 2022 The TokTok team.
+ */
+
+#ifndef C_TOXCORE_TOXCORE_BIN_UNPACK_H
+#define C_TOXCORE_TOXCORE_BIN_UNPACK_H
+
+#include <msgpack.h>
+#include <stdint.h>
+
+#include "attributes.h"
+
+non_null() bool bin_unpack_bool(bool *val, const msgpack_object *obj);
+non_null() bool bin_unpack_u16(uint16_t *val, const msgpack_object *obj);
+non_null() bool bin_unpack_u32(uint32_t *val, const msgpack_object *obj);
+non_null() bool bin_unpack_u64(uint64_t *val, const msgpack_object *obj);
+non_null() bool bin_unpack_bytes(uint8_t **data, size_t *data_length, const msgpack_object *obj);
+non_null() bool bin_unpack_bytes_fixed(uint8_t *data, uint32_t data_length, const msgpack_object *obj);
+
+#endif  // C_TOXCORE_TOXCORE_BIN_UNPACK_H

toxcore/events/conference_connected.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -71,7 +71,7 @@ static bool tox_event_conference_connected_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0]);
+    return bin_unpack_u32(&event->conference_number, &obj->via.array.ptr[0]);
 }
 
 

toxcore/events/conference_invite.c

@@ -8,6 +8,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
@@ -122,9 +123,9 @@ static bool tox_event_conference_invite_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
            && tox_unpack_conference_type(&event->type, &obj->via.array.ptr[1])
-           && tox_unpack_bin(&event->cookie, &event->cookie_length, &obj->via.array.ptr[2]);
+           && bin_unpack_bytes(&event->cookie, &event->cookie_length, &obj->via.array.ptr[2]);
 }
 
 

toxcore/events/conference_message.c

@@ -8,6 +8,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
@@ -137,10 +138,10 @@ static bool tox_event_conference_message_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
+    return bin_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
            && tox_unpack_message_type(&event->type, &obj->via.array.ptr[2])
-           && tox_unpack_bin(&event->message, &event->message_length, &obj->via.array.ptr[3]);
+           && bin_unpack_bytes(&event->message, &event->message_length, &obj->via.array.ptr[3]);
 }
 
 

toxcore/events/conference_peer_list_changed.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -73,7 +73,7 @@ static bool tox_event_conference_peer_list_changed_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0]);
+    return bin_unpack_u32(&event->conference_number, &obj->via.array.ptr[0]);
 }
 
 

toxcore/events/conference_peer_name.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -123,9 +123,9 @@ static bool tox_event_conference_peer_name_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
-           && tox_unpack_bin(&event->name, &event->name_length, &obj->via.array.ptr[2]);
+    return bin_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
+           && bin_unpack_bytes(&event->name, &event->name_length, &obj->via.array.ptr[2]);
 }
 
 

toxcore/events/conference_title.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -122,9 +122,9 @@ static bool tox_event_conference_title_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
-           && tox_unpack_bin(&event->title, &event->title_length, &obj->via.array.ptr[2]);
+    return bin_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
+           && bin_unpack_bytes(&event->title, &event->title_length, &obj->via.array.ptr[2]);
 }
 
 

toxcore/events/file_chunk_request.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -114,10 +114,10 @@ static bool tox_event_file_chunk_request_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
-           && tox_unpack_u64(&event->position, &obj->via.array.ptr[2])
-           && tox_unpack_u16(&event->length, &obj->via.array.ptr[3]);
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
+           && bin_unpack_u64(&event->position, &obj->via.array.ptr[2])
+           && bin_unpack_u16(&event->length, &obj->via.array.ptr[3]);
 }
 
 

toxcore/events/file_recv.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -152,11 +152,11 @@ static bool tox_event_file_recv_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
-           && tox_unpack_u32(&event->kind, &obj->via.array.ptr[2])
-           && tox_unpack_u64(&event->file_size, &obj->via.array.ptr[3])
-           && tox_unpack_bin(&event->filename, &event->filename_length, &obj->via.array.ptr[4]);
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
+           && bin_unpack_u32(&event->kind, &obj->via.array.ptr[2])
+           && bin_unpack_u64(&event->file_size, &obj->via.array.ptr[3])
+           && bin_unpack_bytes(&event->filename, &event->filename_length, &obj->via.array.ptr[4]);
 }
 
 

toxcore/events/file_recv_chunk.c

@@ -8,10 +8,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
-#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -137,10 +137,10 @@ static bool tox_event_file_recv_chunk_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
-           && tox_unpack_u64(&event->position, &obj->via.array.ptr[2])
-           && tox_unpack_bin(&event->data, &event->data_length, &obj->via.array.ptr[3]);
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
+           && bin_unpack_u64(&event->position, &obj->via.array.ptr[2])
+           && bin_unpack_bytes(&event->data, &event->data_length, &obj->via.array.ptr[3]);
 }
 
 

toxcore/events/file_recv_control.c

@@ -8,6 +8,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
@@ -100,8 +101,8 @@ static bool tox_event_file_recv_control_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
-           && tox_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+           && bin_unpack_u32(&event->file_number, &obj->via.array.ptr[1])
            && tox_unpack_file_control(&event->control, &obj->via.array.ptr[2]);
 }
 

toxcore/events/friend_connection_status.c

@@ -8,6 +8,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "../bin_unpack.h"
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
@@ -87,7 +88,7 @@ static bool tox_event_friend_connection_status_unpack(
         return false;
     }
 
-    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+    return bin_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
            && tox_unpack_connection(&event->connection_status, &obj->via.array.ptr[1]);
 }