feat: Add binary packing functions for tox events.

.circleci/config.yml

@@ -32,6 +32,7 @@ jobs:
             git
             libconfig-dev
             libgtest-dev
+            libmsgpack-dev
             libopus-dev
             libsodium-dev
             libvpx-dev
@@ -79,7 +80,7 @@ jobs:
           toxcore/*/*.c
           toxencryptsave/*.c
           -lpthread
-          $(pkg-config --cflags --libs libsodium opus vpx)
+          $(pkg-config --cflags --libs libsodium msgpack opus vpx)
 
   static-analysis:
     working_directory: ~/work

.github/scripts/cmake-linux

@@ -4,7 +4,12 @@ set -eu
 
 NPROC=$(nproc)
 
-sudo apt-get install -y --no-install-recommends libopus-dev libsodium-dev libvpx-dev ninja-build
+sudo apt-get install -y --no-install-recommends \
+  libmsgpack-dev \
+  libopus-dev \
+  libsodium-dev \
+  libvpx-dev \
+  ninja-build
 
 . ".github/scripts/flags-$CC.sh"
 

.github/scripts/cmake-osx

@@ -7,7 +7,12 @@ NPROC=$(sysctl -n hw.physicalcpu)
 # Workaround for bug in Homebrew where it only finds an old Ruby version.
 brew update
 
-brew install libconfig libsodium libvpx opus
+brew install \
+  libconfig \
+  libsodium \
+  libvpx \
+  msgpack \
+  opus
 
 . ".github/scripts/flags-clang.sh"
 

.github/scripts/cmake-win32

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 i686=true
 x86_64=false

.github/scripts/cmake-win64

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 i686=false
 x86_64=true

.github/scripts/cmake-windows.sh

@@ -7,14 +7,12 @@ set -eu
 NPROC=$(nproc)
 
 ci_install() {
-  cd other/docker/windows
-
   docker build \
     --build-arg SUPPORT_ARCH_i686="$i686" \
     --build-arg SUPPORT_ARCH_x86_64="$x86_64" \
     --build-arg SUPPORT_TEST=true \
     -t toxcore-"$WINDOWS_ARCH" \
-    .
+    other/docker/windows
 }
 
 ci_script() {

.github/scripts/sonar-prepare

@@ -2,7 +2,13 @@
 
 set -eu
 
-sudo apt-get install -y --no-install-recommends libconfig-dev libopus-dev libsodium-dev libvpx-dev ninja-build
+sudo apt-get install -y --no-install-recommends \
+  libconfig-dev \
+  libmsgpack-dev \
+  libopus-dev \
+  libsodium-dev \
+  libvpx-dev \
+  ninja-build
 
 . ".github/scripts/flags-gcc.sh"
 

.github/workflows/ci.yml

@@ -95,12 +95,14 @@ jobs:
           sudo apt-get install -y --no-install-recommends
             tcc
             libconfig-dev
+            libmsgpack-dev
             libopus-dev
             libsodium-dev
             libvpx-dev
       - name: Build with TCC
         run:
           tcc
+            -Dinline=static
             -o send_message_test
             -Wall -Werror
             -bench -g
@@ -111,7 +113,7 @@ jobs:
             toxcore/*.c
             toxcore/*/*.c
             toxencryptsave/*.c
-            $(pkg-config --cflags --libs libsodium opus vpx)
+            $(pkg-config --cflags --libs libsodium msgpack opus vpx)
       - name: Run the test
         run: "./send_message_test | grep 'tox clients connected'"
       - name: Build amalgamation file with TCC
@@ -124,7 +126,7 @@ jobs:
             -o send_message_test
             -Wall -Werror
             -bench -g
-            $(pkg-config --cflags --libs libsodium opus vpx)
+            $(pkg-config --cflags --libs libsodium msgpack opus vpx)
       - name: Run the test again
         run: "./send_message_test | grep 'tox clients connected'"
 
@@ -149,8 +151,8 @@ jobs:
             toxcore/*.c
             toxcore/*/*.c
             toxencryptsave/*.c
-            -D__COMPCERT__ -DDISABLE_VLA
-            -lpthread $(pkg-config --cflags --libs libsodium opus vpx)
+            -D__COMPCERT__ -DDISABLE_VLA -Dinline=
+            -lpthread $(pkg-config --cflags --libs libsodium msgpack opus vpx)
       - name: Run the test
         run: "./send_message_test | grep 'tox clients connected'"
 

CMakeLists.txt

@@ -274,6 +274,8 @@ set(toxcore_SOURCES ${toxcore_SOURCES}
   toxcore/tox_events.c
   toxcore/tox_events.h)
 set(toxcore_API_HEADERS ${toxcore_API_HEADERS} ${toxcore_SOURCE_DIR}/toxcore/tox_events.h^tox)
+set(toxcore_LINK_MODULES ${toxcore_LINK_MODULES} ${MSGPACK_LIBRARIES})
+set(toxcore_PKGCONFIG_REQUIRES ${toxcore_PKGCONFIG_REQUIRES} msgpack)
 
 # LAYER 10: Dispatch recorded events to callbacks.
 # -------------------

auto_tests/Makefile.inc

@@ -34,6 +34,8 @@ TESTS = \
 	set_name_test \
 	set_status_message_test \
 	TCP_test \
+	tox_events_test \
+	tox_dispatch_test \
 	tox_many_tcp_test \
 	tox_many_test \
 	tox_one_test \
@@ -49,16 +51,19 @@ endif
 
 AUTOTEST_CFLAGS = \
 	$(LIBSODIUM_CFLAGS) \
+	$(MSGPACK_CFLAGS) \
 	$(NACL_CFLAGS)
 
 AUTOTEST_LDADD = \
 	$(LIBSODIUM_LDFLAGS) \
+	$(MSGPACK_LDFLAGS) \
 	$(NACL_LDFLAGS) \
 	libmisc_tools.la \
 	libauto_test_support.la \
 	libtoxcore.la \
 	libtoxencryptsave.la \
 	$(LIBSODIUM_LIBS) \
+	$(MSGPACK_LIBS) \
 	$(NACL_OBJECTS) \
 	$(NACL_LIBS)
 
@@ -198,6 +203,14 @@ TCP_test_SOURCES = ../auto_tests/TCP_test.c
 TCP_test_CFLAGS = $(AUTOTEST_CFLAGS)
 TCP_test_LDADD = $(AUTOTEST_LDADD)
 
+tox_events_test_SOURCES = ../auto_tests/tox_events_test.c
+tox_events_test_CFLAGS = $(AUTOTEST_CFLAGS)
+tox_events_test_LDADD = $(AUTOTEST_LDADD)
+
+tox_dispatch_test_SOURCES = ../auto_tests/tox_dispatch_test.c
+tox_dispatch_test_CFLAGS = $(AUTOTEST_CFLAGS)
+tox_dispatch_test_LDADD = $(AUTOTEST_LDADD)
+
 tox_many_tcp_test_SOURCES = ../auto_tests/tox_many_tcp_test.c
 tox_many_tcp_test_CFLAGS = $(AUTOTEST_CFLAGS)
 tox_many_tcp_test_LDADD = $(AUTOTEST_LDADD)

auto_tests/tox_dispatch_test.c

@@ -12,6 +12,9 @@
 #include "../toxcore/tox_events.h"
 #include "check_compat.h"
 
+// Set to true to produce an msgpack file at /tmp/test.mp.
+static const bool want_dump_events = false;
+
 static void handle_events_friend_message(Tox *tox, const Tox_Event_Friend_Message *event, void *user_data)
 {
     bool *success = (bool *)user_data;
@@ -24,17 +27,43 @@ static void handle_events_friend_message(Tox *tox, const Tox_Event_Friend_Messag
     *success = true;
 }
 
+static void dump_events(const char *path, const Tox_Events *events)
+{
+    if (want_dump_events) {
+        FILE *fh = fopen(path, "w");
+        ck_assert(fh != nullptr);
+        const uint32_t len = tox_events_bytes_size(events);
+        uint8_t *buf = (uint8_t *)malloc(len);
+        ck_assert(buf != nullptr);
+        tox_events_get_bytes(events, buf);
+        fwrite(buf, 1, len, fh);
+        free(buf);
+        fclose(fh);
+    }
+}
+
+static void print_events(Tox_Events *events)
+{
+    if (tox_events_bytes_size(events) > 24) {
+        tox_events_print(events);
+    }
+
+    tox_events_free(events);
+}
+
 static bool await_message(Tox **toxes, const Tox_Dispatch *dispatch)
 {
     for (uint32_t i = 0; i < 100; ++i) {
         // Ignore events on tox 1.
-        tox_events_free(tox_events_iterate(toxes[0], nullptr));
+        print_events(tox_events_iterate(toxes[0], nullptr));
         // Check if tox 2 got the message from tox 1.
         Tox_Events *events = tox_events_iterate(toxes[1], nullptr);
 
+        dump_events("/tmp/test.mp", events);
+
         bool success = false;
         tox_dispatch_invoke(dispatch, events, toxes[1], &success);
-        tox_events_free(events);
+        print_events(events);
 
         if (success) {
             return true;
@@ -81,8 +110,8 @@ static void test_tox_events(void)
     while (tox_self_get_connection_status(toxes[0]) == TOX_CONNECTION_NONE ||
             tox_self_get_connection_status(toxes[1]) == TOX_CONNECTION_NONE) {
         // Ignore connection events for now.
-        tox_events_free(tox_events_iterate(toxes[0], nullptr));
-        tox_events_free(tox_events_iterate(toxes[1], nullptr));
+        print_events(tox_events_iterate(toxes[0], nullptr));
+        print_events(tox_events_iterate(toxes[1], nullptr));
 
         c_sleep(tox_iteration_interval(toxes[0]));
     }
@@ -92,8 +121,8 @@ static void test_tox_events(void)
     while (tox_friend_get_connection_status(toxes[0], 0, nullptr) == TOX_CONNECTION_NONE ||
             tox_friend_get_connection_status(toxes[1], 0, nullptr) == TOX_CONNECTION_NONE) {
         // Ignore connection events for now.
-        tox_events_free(tox_events_iterate(toxes[0], nullptr));
-        tox_events_free(tox_events_iterate(toxes[1], nullptr));
+        print_events(tox_events_iterate(toxes[0], nullptr));
+        print_events(tox_events_iterate(toxes[1], nullptr));
 
         c_sleep(tox_iteration_interval(toxes[0]));
     }

cmake/Dependencies.cmake

@@ -14,17 +14,15 @@ find_library(SOCKET_LIBRARIES       socket       )
 
 # For toxcore.
 pkg_use_module(LIBSODIUM            libsodium    )
+pkg_use_module(MSGPACK              msgpack      )
 
 # For toxav.
-pkg_use_module(OPUS                 "opus;Opus"    )
-pkg_use_module(VPX                  "vpx;libvpx"   )
+pkg_use_module(OPUS                 "opus;Opus"  )
+pkg_use_module(VPX                  "vpx;libvpx" )
 
 # For tox-bootstrapd.
 pkg_use_module(LIBCONFIG            libconfig    )
 
-# For tox-spectest.
-pkg_use_module(MSGPACK              msgpack      )
-
 ###############################################################################
 #
 # :: For MSVC Windows builds.

configure.ac

@@ -302,6 +302,14 @@ PKG_CHECK_MODULES([LIBSODIUM], [libsodium],
         LIBSODIUM_FOUND="no"
     ])
 
+PKG_CHECK_MODULES([MSGPACK], [msgpack],
+    [
+        MSGPACK_FOUND="yes"
+    ],
+    [
+        MSGPACK_FOUND="no"
+    ])
+
 if test "x$WANT_NACL" = "xyes"; then
     NACL_LIBS=
     NACL_LDFLAGS=

other/analysis/check_includes

@@ -10,6 +10,8 @@ ALLOWLIST: Tuple[str, ...] = (
     "stdbool.h",
     "stddef.h",
     "stdint.h",
+    # msgpack, currently not abstracted away
+    "msgpack.h",
     # toxav stuff, maybe not worth abstracting away
     "opus.h",
     "vpx/vp8cx.h",

other/bootstrap_daemon/docker/Dockerfile

@@ -8,6 +8,7 @@ RUN ["apk", "--no-cache", "add",\
  "linux-headers",\
  "libconfig-dev",\
  "libconfig-static",\
+ "msgpack-c-dev",\
  "libsodium-dev",\
  "libsodium-static",\
  "ninja",\

other/docker/autotools/Dockerfile

@@ -8,6 +8,7 @@ RUN apt-get update && apt-get install --no-install-recommends -y \
  ca-certificates \
  curl \
  libconfig-dev \
+ libmsgpack-dev \
  libopus-dev \
  libtool \
  libvpx-dev \

other/docker/circleci/Dockerfile

@@ -7,6 +7,7 @@ RUN apt-get update && \
  clang \
  cmake \
  libconfig-dev \
+ libmsgpack-dev \
  libopus-dev \
  libsodium-dev \
  libvpx-dev \

other/docker/tcc/Dockerfile

@@ -0,0 +1,46 @@
+FROM ubuntu:20.04
+
+RUN apt-get update && \
+ DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
+ libc-dev \
+ libmsgpack-dev \
+ libopus-dev \
+ libsodium-dev \
+ libvpx-dev \
+ pkg-config \
+ tcc \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /work
+COPY auto_tests/ /work/auto_tests/
+COPY testing/ /work/testing/
+COPY toxav/ /work/toxav/
+COPY toxcore/ /work/toxcore/
+COPY toxencryptsave/ /work/toxencryptsave/
+
+RUN tcc \
+ -Dinline=static \
+ -o send_message_test \
+ -Wall -Werror \
+ -bench -g \
+ auto_tests/auto_test_support.c \
+ auto_tests/send_message_test.c \
+ testing/misc_tools.c \
+ toxav/*.c \
+ toxcore/*.c \
+ toxcore/*/*.c \
+ toxencryptsave/*.c \
+ $(pkg-config --cflags --libs libsodium msgpack opus vpx)
+
+COPY other/make_single_file /work/other/
+RUN \
+ other/make_single_file \
+   auto_tests/auto_test_support.c \
+   auto_tests/send_message_test.c \
+   testing/misc_tools.c | \
+ tcc - \
+   -o send_message_test \
+   -Wall -Werror \
+   -bench -g \
+   $(pkg-config --cflags --libs libsodium msgpack opus vpx)

other/docker/tcc/run

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -eux
+
+docker build -t toxchat/c-toxcore:tcc -f other/docker/tcc/Dockerfile .